Server DevOps Audit Settings - Create Or Update

Service:: SQL Database

Version d'API:: 2023-08-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=2023-08-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
devOpsAuditingSettingsName	path	True	DevOpsAuditingSettingsName
resourceGroupName	path	True	string	Nom du groupe de ressources qui contient la ressource. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager ou du portail.
serverName	path	True	string	Nom du serveur.
subscriptionId	path	True	string	ID d’abonnement qui identifie un abonnement Azure.
api-version	query	True	string	Version de l’API à utiliser pour la requête.

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	Spécifie 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 true. 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. Format d’URI des paramètres de diagnostic : 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	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 affectée par le système dans Azure Active Directory (AAD). Accordez à l’identité SQL Server l’accès au compte de stockage en ajoutant le rôle RBAC « Contributeur aux données blob de stockage » à l’identité du 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	Mise à jour réussie des paramètres d’audit DevOps.
202 Accepted		La mise à jour des paramètres DevOps d’audit est en cours. En-têtes Location: string
Other Status Codes	ErrorResponse	Réponses d’erreur : *** 400 ManagedInstanceStoppingOrStopped : opération en conflit envoyée pendant l’arrêt/l’état arrêté de l’instance 400 ManagedInstanceStarting - Opération en conflit envoyée pendant que l’instance est à l’état de démarrage 400 InvalidServerDevOpsAuditSettingsCreateRequest : la demande de stratégie d’audit DevOps de création du serveur n’existe pas ou n’a pas d’objet de propriétés. 400 DataSecurityInvalidUserSuppliedParameter : une valeur de paramètre non valide a été fournie par le client. 400 InvalidServerDevOpsAuditSettingsName - Nom de stratégie DevOps du serveur non valide. 400 DevOpsAuditInvalidStorageAccountCredentials : le compte de stockage ou la clé d’accès fourni n’est pas valide. 404 ServerNotInSubscriptionResourceGroup : le serveur spécifié n’existe pas dans le groupe de ressources et l’abonnement spécifiés. 404 SubscriptionDoesNotHaveServer - Le serveur demandé est introuvable 404 OperationIdNotFound : l’opération avec ID n’existe pas. 409 ServerDevOpsAuditSettingsInProgress - Définir l’audit DevOps du serveur est déjà en cours. 409 CannotCancelOperation : l’opération de gestion est dans un état qui ne peut pas être annulé. 409 OperationCancelled : l’opération a été annulée par l’utilisateur. 409 Opération interrompue : l’opération sur la ressource n’a pas pu être terminée, car elle a été interrompue par une autre opération sur la même ressource. 429 SubscriptionTooManyCreateUpdateRequests : demandes au-delà des requêtes maximales pouvant être traitées par les ressources disponibles. 429 SubscriptionTooManyRequests : demandes au-delà des requêtes maximales pouvant être traitées par les ressources disponibles. 500 OperationTimedOut : l’opération a expiré et a été restaurée automatiquement. Réessayez l’opération. 503 TooManyRequests : demandes au-delà des requêtes maximales pouvant être traitées par les ressources disponibles.

Nom

Type

Description

200 OK

ServerDevOpsAuditingSettings

Mise à jour réussie des paramètres d’audit DevOps.

202 Accepted

La mise à jour des paramètres DevOps d’audit est en cours.

En-têtes

Location: string

Other Status Codes

ErrorResponse

Réponses d’erreur : ***

400 ManagedInstanceStoppingOrStopped : opération en conflit envoyée pendant l’arrêt/l’état arrêté de l’instance
400 ManagedInstanceStarting - Opération en conflit envoyée pendant que l’instance est à l’état de démarrage
400 InvalidServerDevOpsAuditSettingsCreateRequest : la demande de stratégie d’audit DevOps de création du serveur n’existe pas ou n’a pas d’objet de propriétés.
400 DataSecurityInvalidUserSuppliedParameter : une valeur de paramètre non valide a été fournie par le client.
400 InvalidServerDevOpsAuditSettingsName - Nom de stratégie DevOps du serveur non valide.
400 DevOpsAuditInvalidStorageAccountCredentials : le compte de stockage ou la clé d’accès fourni n’est pas valide.
404 ServerNotInSubscriptionResourceGroup : le serveur spécifié n’existe pas dans le groupe de ressources et l’abonnement spécifiés.
404 SubscriptionDoesNotHaveServer - Le serveur demandé est introuvable
404 OperationIdNotFound : l’opération avec ID n’existe pas.
409 ServerDevOpsAuditSettingsInProgress - Définir l’audit DevOps du serveur est déjà en cours.
409 CannotCancelOperation : l’opération de gestion est dans un état qui ne peut pas être annulé.
409 OperationCancelled : l’opération a été annulée par l’utilisateur.
409 Opération interrompue : l’opération sur la ressource n’a pas pu être terminée, car elle a été interrompue par une autre opération sur la même ressource.
429 SubscriptionTooManyCreateUpdateRequests : demandes au-delà des requêtes maximales pouvant être traitées par les ressources disponibles.
429 SubscriptionTooManyRequests : demandes au-delà des requêtes maximales pouvant être traitées par les ressources disponibles.
500 OperationTimedOut : l’opération a expiré et a été restaurée automatiquement. Réessayez l’opération.
503 TooManyRequests : demandes au-delà des requêtes maximales pouvant être traitées par les ressources disponibles.

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=2023-08-01

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

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/stable/2023-08-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

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

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=2023-08-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/stable/2023-08-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

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

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
Disabled

createdByType

Énumération

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

Valeur	Description
User
Application
ManagedIdentity
Key

DevOpsAuditingSettingsName

Énumération

Valeur	Description
Default

ErrorAdditionalInfo

Object

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

Object

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

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

ServerDevOpsAuditingSettings

Object

Paramètres d’audit DevOps du serveur.

Nom	Type	Description
id	string	ID de ressource.
name	string	Nom de la ressource.
properties.isAzureMonitorTargetEnabled	boolean	Spécifie 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 true. 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. Format d’URI des paramètres de diagnostic : 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	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 affectée par le système dans Azure Active Directory (AAD). Accordez à l’identité SQL Server l’accès au compte de stockage en ajoutant le rôle RBAC « Contributeur aux données blob de stockage » à l’identité du 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	SystemData de ServerDevOpsAuditSettingsResource.
type	string	Type de ressource.

systemData

Object

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.

Partager via

Server DevOps Audit Settings - Create Or Update

Paramètres URI

Corps de la demande

Réponses

Exemples

Update a server's DevOps audit settings with all params

Exemple de requête

Exemple de réponse

Update a server's DevOps audit settings with minimal input

Exemple de requête

Exemple de réponse

Définitions

BlobAuditingPolicyState

createdByType

DevOpsAuditingSettingsName

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ServerDevOpsAuditingSettings

systemData