Server DevOps Audit Settings - Create Or Update

Service:: SQL Database

Version d'API:: 2025-01-01

Crée ou met à jour les paramètres d’audit DevOps d’un serveur.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/devOpsAuditingSettings/Default?api-version=2025-01-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
devOpsAuditingSettingsName	path	True	DevOpsAuditingSettingsName
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
serverName	path	True	string	Le nom du serveur
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Obligatoire	Type	Description
properties.state	True	BlobAuditingPolicyState	Spécifie l’état de l’audit. Si l’état est Activé, storageEndpoint ou isAzureMonitorTargetEnabled sont requis.
properties.isAzureMonitorTargetEnabled		boolean	Précise si les événements d’audit DevOps sont envoyés à Azure Monitor. Pour envoyer les événements à Azure Monitor, spécifiez « State » comme « Enabled » et « IsAzureMonitorTargetEnabled » comme vrais. Lorsque vous utilisez l’API REST pour configurer l’audit DevOps, les paramètres de diagnostic avec la catégorie de journaux de diagnostic « DevOpsOperationsAudit » sur la base de données master doivent également être créés. Paramètres de diagnostic Format URI : PUT `https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview` Pour plus d’informations, consultez 'API REST des paramètres de diagnostic ou Paramètres de diagnostic PowerShell
properties.isManagedIdentityInUse		boolean	Spécifie si l’identité managée est utilisée pour accéder au stockage d’objets blob
properties.storageAccountAccessKey		string (password)	Spécifie la clé d’identificateur du compte de stockage d’audit. Si l’état est Activé et que storageEndpoint est spécifié, il n’est pas spécifié que storageAccountAccessKey utilise l’identité managée affectée par le système SQL Server pour accéder au stockage. Conditions préalables à l’utilisation de l’authentification d’identité managée : Attribuez à SQL Server une identité managée assignée par le système dans Azure Active Directory (AAD). Accordez l'identité SQL Server au compte de stockage en ajoutant le rôle RBAC « Storage Blob Data Contributor » à l'identité serveur. Pour plus d’informations, consultez Audit sur le stockage à l’aide de l’authentification d’identité managée
properties.storageAccountSubscriptionId		string (uuid)	Spécifie l’ID d’abonnement de stockage d’objets blob.
properties.storageEndpoint		string	Spécifie le point de terminaison de stockage d’objets blob (par exemple, `https://MyAccount.blob.core.windows.net`). Si l’état est Activé, storageEndpoint ou isAzureMonitorTargetEnabled est requis.

Réponses

Nom	Type	Description
200 OK	ServerDevOpsAuditingSettings	L’opération de mise à jour de la ressource 'ServerDevOpsAuditingSettings' a réussi
202 Accepted		Exploitation des ressources acceptée. En-têtes Azure-AsyncOperation: string Location: string
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Nom

Type

Description

200 OK

ServerDevOpsAuditingSettings

L’opération de mise à jour de la ressource 'ServerDevOpsAuditingSettings' a réussi

202 Accepted

Exploitation des ressources acceptée.

En-têtes

Azure-AsyncOperation: string
Location: string

Other Status Codes

ErrorResponse

Réponse d’erreur inattendue.

Sécurité

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

Update a server's DevOps audit settings with all params

Update a server's DevOps audit settings with minimal input

Update a server's DevOps audit settings with all params

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/devAuditTestRG/providers/Microsoft.Sql/servers/devOpsAuditTestSvr/devOpsAuditingSettings/Default?api-version=2025-01-01

{
  "properties": {
    "isAzureMonitorTargetEnabled": true,
    "state": "Enabled",
    "storageAccountAccessKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000",
    "storageEndpoint": "https://mystorage.blob.core.windows.net"
  }
}

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/SQL/stable/2025-01-01/examples/ServerDevOpsAuditCreateMax.json
// this example is just showing the usage of "ServerDevOpsAuditSettings_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlServerResource created on azure
// for more information of creating SqlServerResource, please refer to the document of SqlServerResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "devAuditTestRG";
string serverName = "devOpsAuditTestSvr";
ResourceIdentifier sqlServerResourceId = SqlServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
SqlServerResource sqlServer = client.GetSqlServerResource(sqlServerResourceId);

// get the collection of this SqlServerDevOpsAuditingSettingResource
SqlServerDevOpsAuditingSettingCollection collection = sqlServer.GetSqlServerDevOpsAuditingSettings();

// invoke the operation
string devOpsAuditingSettingsName = "Default";
SqlServerDevOpsAuditingSettingData data = new SqlServerDevOpsAuditingSettingData
{
    IsAzureMonitorTargetEnabled = true,
    State = BlobAuditingPolicyState.Enabled,
    StorageEndpoint = "https://mystorage.blob.core.windows.net",
    StorageAccountAccessKey = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    StorageAccountSubscriptionId = Guid.Parse("00000000-1234-0000-5678-000000000000"),
};
ArmOperation<SqlServerDevOpsAuditingSettingResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, devOpsAuditingSettingsName, data);
SqlServerDevOpsAuditingSettingResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SqlServerDevOpsAuditingSettingData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Exemple de réponse

Code d’état:: 200

{
  "name": "Default",
  "type": "Microsoft.Sql/servers/devOpsAuditingSettings",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/devAuditTestRG/providers/Microsoft.Sql/servers/devOpsAuditTestSvr/devOpsAuditingSettings/default",
  "properties": {
    "isAzureMonitorTargetEnabled": true,
    "state": "Enabled",
    "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000",
    "storageEndpoint": "https://mystorage.blob.core.windows.net"
  }
}

Code d’état:: 202

Update a server's DevOps audit settings with minimal input

Exemple de requête

HTTP
dotnet

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/devAuditTestRG/providers/Microsoft.Sql/servers/devOpsAuditTestSvr/devOpsAuditingSettings/Default?api-version=2025-01-01

{
  "properties": {
    "state": "Enabled",
    "storageAccountAccessKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "storageEndpoint": "https://mystorage.blob.core.windows.net"
  }
}

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/SQL/stable/2025-01-01/examples/ServerDevOpsAuditCreateMin.json
// this example is just showing the usage of "ServerDevOpsAuditSettings_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlServerResource created on azure
// for more information of creating SqlServerResource, please refer to the document of SqlServerResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "devAuditTestRG";
string serverName = "devOpsAuditTestSvr";
ResourceIdentifier sqlServerResourceId = SqlServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
SqlServerResource sqlServer = client.GetSqlServerResource(sqlServerResourceId);

// get the collection of this SqlServerDevOpsAuditingSettingResource
SqlServerDevOpsAuditingSettingCollection collection = sqlServer.GetSqlServerDevOpsAuditingSettings();

// invoke the operation
string devOpsAuditingSettingsName = "Default";
SqlServerDevOpsAuditingSettingData data = new SqlServerDevOpsAuditingSettingData
{
    State = BlobAuditingPolicyState.Enabled,
    StorageEndpoint = "https://mystorage.blob.core.windows.net",
    StorageAccountAccessKey = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
};
ArmOperation<SqlServerDevOpsAuditingSettingResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, devOpsAuditingSettingsName, data);
SqlServerDevOpsAuditingSettingResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SqlServerDevOpsAuditingSettingData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Exemple de réponse

Code d’état:: 200

{
  "name": "Default",
  "type": "Microsoft.Sql/servers/devOpsAuditingSettings",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/devAuditTestRG/providers/Microsoft.Sql/servers/devOpsAuditTestSvr/devOpsAuditingSettings/default",
  "properties": {
    "state": "Enabled",
    "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000",
    "storageEndpoint": "https://mystorage.blob.core.windows.net"
  }
}

Code d’état:: 202

Définitions

Nom	Description
BlobAuditingPolicyState	Spécifie l’état de l’audit. Si l’état est Activé, storageEndpoint ou isAzureMonitorTargetEnabled sont requis.
createdByType	Type d’identité qui a créé la ressource.
DevOpsAuditingSettingsName
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
ServerDevOpsAuditingSettings	Paramètres d’audit DevOps du serveur.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

BlobAuditingPolicyState

Énumération

Spécifie l’état de l’audit. Si l’état est Activé, storageEndpoint ou isAzureMonitorTargetEnabled sont requis.

Valeur	Description
Enabled	Activé
Disabled	Désactivé

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
User
Application
ManagedIdentity
Key

DevOpsAuditingSettingsName

Énumération

Valeur	Description
Default	Par défaut

ErrorAdditionalInfo

Objet

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Objet

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Objet

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

ServerDevOpsAuditingSettings

Objet

Paramètres d’audit DevOps du serveur.

Nom	Type	Description
id	string (arm-id)	ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
name	string	Nom de la ressource
properties.isAzureMonitorTargetEnabled	boolean	Précise si les événements d’audit DevOps sont envoyés à Azure Monitor. Pour envoyer les événements à Azure Monitor, spécifiez « State » comme « Enabled » et « IsAzureMonitorTargetEnabled » comme vrais. Lorsque vous utilisez l’API REST pour configurer l’audit DevOps, les paramètres de diagnostic avec la catégorie de journaux de diagnostic « DevOpsOperationsAudit » sur la base de données master doivent également être créés. Paramètres de diagnostic Format URI : PUT `https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview` Pour plus d’informations, consultez 'API REST des paramètres de diagnostic ou Paramètres de diagnostic PowerShell
properties.isManagedIdentityInUse	boolean	Spécifie si l’identité managée est utilisée pour accéder au stockage d’objets blob
properties.state	BlobAuditingPolicyState	Spécifie l’état de l’audit. Si l’état est Activé, storageEndpoint ou isAzureMonitorTargetEnabled sont requis.
properties.storageAccountAccessKey	string (password)	Spécifie la clé d’identificateur du compte de stockage d’audit. Si l’état est Activé et que storageEndpoint est spécifié, il n’est pas spécifié que storageAccountAccessKey utilise l’identité managée affectée par le système SQL Server pour accéder au stockage. Conditions préalables à l’utilisation de l’authentification d’identité managée : Attribuez à SQL Server une identité managée assignée par le système dans Azure Active Directory (AAD). Accordez l'identité SQL Server au compte de stockage en ajoutant le rôle RBAC « Storage Blob Data Contributor » à l'identité serveur. Pour plus d’informations, consultez Audit sur le stockage à l’aide de l’authentification d’identité managée
properties.storageAccountSubscriptionId	string (uuid)	Spécifie l’ID d’abonnement de stockage d’objets blob.
properties.storageEndpoint	string	Spécifie le point de terminaison de stockage d’objets blob (par exemple, `https://MyAccount.blob.core.windows.net`). Si l’état est Activé, storageEndpoint ou isAzureMonitorTargetEnabled est requis.
systemData	systemData	Azure Resource Manager : métadonnées contenant des informations createdBy et modifiedBy.
type	string	Type de la ressource. Par exemple : « Microsoft. Calcul/virtualMachines » ou « Microsoft. StorageAccounts"

systemData

Objet

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.