Server DevOps Audit Settings - Create Or Update

Référence

Service:: SQL Database

API Version:: 2021-11-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/{devOpsAuditingSettingsName}?api-version=2021-11-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
devOpsAuditingSettingsName	path	True	string	Nom des paramètres d’audit devops. Il doit toujours s’agir de « default ».
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	Le nom du serveur
subscriptionId	path	True	string	L’ID d’abonnement d’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.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é, le fait de ne pas spécifier 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 : Attribuer SQL Server une identité managée affectée par le système dans Azure Active Directory (AAD). Accordez SQL Server accès à l’identité 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 dans le stockage à l’aide de l’authentification d’identité managée.
properties.storageAccountSubscriptionId		string	Spécifie l’ID d’abonnement au 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.
Other Status Codes		Réponses d’erreur : *** 400 InvalidServerDevOpsAuditSettingsCreateRequest : la demande de stratégie d’audit DevOps de création de 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 la 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 SubscriptionDoesNotHaveServer : le serveur demandé est introuvable 404 ServerNotInSubscriptionResourceGroup : le serveur spécifié n’existe pas dans le groupe de ressources et l’abonnement spécifiés. 409 ServerDevOpsAuditSettingsInProgress - Définir l’audit DevOps du serveur est déjà en cours.

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.

Other Status Codes

Réponses d’erreur : ***

400 InvalidServerDevOpsAuditSettingsCreateRequest : la demande de stratégie d’audit DevOps de création de 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 la 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 SubscriptionDoesNotHaveServer : le serveur demandé est introuvable
404 ServerNotInSubscriptionResourceGroup : le serveur spécifié n’existe pas dans le groupe de ressources et l’abonnement spécifiés.
409 ServerDevOpsAuditSettingsInProgress - Définir l’audit DevOps du serveur est déjà en cours.

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=2021-11-01

{
  "properties": {
    "state": "Enabled",
    "storageAccountAccessKey": "sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD==",
    "storageEndpoint": "https://mystorage.blob.core.windows.net",
    "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000",
    "isAzureMonitorTargetEnabled": true
  }
}


import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.ServerDevOpsAuditingSettingsInner;
import com.azure.resourcemanager.sql.models.BlobAuditingPolicyState;
import java.util.UUID;

/** Samples for ServerDevOpsAuditSettings CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ServerDevOpsAuditCreateMax.json
     */
    /**
     * Sample code: Update a server's DevOps audit settings with all params.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        updateAServerSDevOpsAuditSettingsWithAllParams(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServerDevOpsAuditSettings().createOrUpdate("devAuditTestRG",
            "devOpsAuditTestSvr", "default",
            new ServerDevOpsAuditingSettingsInner().withIsAzureMonitorTargetEnabled(true)
                .withState(BlobAuditingPolicyState.ENABLED)
                .withStorageEndpoint("https://mystorage.blob.core.windows.net")
                .withStorageAccountAccessKey("fakeTokenPlaceholder").withStorageAccountSubscriptionId(
                    UUID.fromString("00000000-1234-0000-5678-000000000000")),
            Context.NONE);
    }
}

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

Sample Response

Status code:: 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
  }
}

Status code:: 202

Update a server's DevOps audit settings with minimal input

Sample Request

HTTP
Java

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

{
  "properties": {
    "state": "Enabled",
    "storageAccountAccessKey": "sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD==",
    "storageEndpoint": "https://mystorage.blob.core.windows.net"
  }
}


import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.ServerDevOpsAuditingSettingsInner;
import com.azure.resourcemanager.sql.models.BlobAuditingPolicyState;

/** Samples for ServerDevOpsAuditSettings CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ServerDevOpsAuditCreateMin.json
     */
    /**
     * Sample code: Update a server's DevOps audit settings with minimal input.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        updateAServerSDevOpsAuditSettingsWithMinimalInput(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServerDevOpsAuditSettings().createOrUpdate("devAuditTestRG",
            "devOpsAuditTestSvr", "default",
            new ServerDevOpsAuditingSettingsInner().withState(BlobAuditingPolicyState.ENABLED)
                .withStorageEndpoint("https://mystorage.blob.core.windows.net")
                .withStorageAccountAccessKey("fakeTokenPlaceholder"),
            Context.NONE);
    }
}

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

Sample Response

Status code:: 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"
  }
}

Status code:: 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.
ServerDevOpsAuditingSettings	Paramètres d’audit DevOps d’un serveur.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

BlobAuditingPolicyState

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

Nom	Type	Description
Disabled	string
Enabled	string

createdByType

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

Nom	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ServerDevOpsAuditingSettings

Paramètres d’audit DevOps d’un serveur.

Nom	Type	Description
id	string	ID de la 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.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é, le fait de ne pas spécifier 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 : Attribuer SQL Server une identité managée affectée par le système dans Azure Active Directory (AAD). Accordez SQL Server accès à l’identité 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 dans le stockage à l’aide de l’authentification d’identité managée.
properties.storageAccountSubscriptionId	string	Spécifie l’ID d’abonnement au 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

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

Nom	Type	Description
createdAt	string	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	Horodatage de la dernière modification de la 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.

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

Sample Request

Sample Response

Update a server's DevOps audit settings with minimal input

Sample Request

Sample Response

Définitions

BlobAuditingPolicyState

createdByType

ServerDevOpsAuditingSettings

systemData

Ressources supplémentaires