Server DevOps Audit Settings - Create Or Update

Referenz

Service:: SQL Database

API Version:: 2021-11-01

Erstellt oder aktualisiert die DevOps-Überwachungseinstellungen eines Servers.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
devOpsAuditingSettingsName	path	True	string	Der Name der devops-Überwachungseinstellungen. Dies sollte immer "Standard" sein.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe, die die Ressource enthält. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden.
serverName	path	True	string	Name des Servers
subscriptionId	path	True	string	Abonnement-ID für ein Azure-Abonnement.
api-version	query	True	string	API-Version, die für die Anforderung verwendet werden soll.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
properties.state	True	BlobAuditingPolicyState	Gibt den Status der Überwachung an. Wenn der Status Aktiviert ist, sind storageEndpoint oder isAzureMonitorTargetEnabled erforderlich.
properties.isAzureMonitorTargetEnabled		boolean	Gibt an, ob DevOps-Überwachungsereignisse an Azure Monitor gesendet werden. Um die Ereignisse an Azure Monitor zu senden, geben Sie "State" als "Enabled" und "IsAzureMonitorTargetEnabled" als true an. Wenn Sie die REST-API zum Konfigurieren der DevOps-Überwachung verwenden, sollten auch Diagnoseeinstellungen mit der Diagnoseprotokollkategorie "DevOpsOperationsAudit" auf der master Datenbank erstellt werden. URI-Format für Diagnoseeinstellungen: 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 Weitere Informationen finden Sie unter Rest-API für Diagnoseeinstellungen oder Diagnoseeinstellungen PowerShell.
properties.storageAccountAccessKey		string	Gibt den Bezeichnerschlüssel des Überwachungsspeicherkontos an. Wenn der Status Aktiviert und storageEndpoint angegeben ist, wird die vom SQL Server systemseitig zugewiesene verwaltete Identität für den Zugriff auf den Speicher nicht angegeben. Voraussetzungen für die Verwendung der Authentifizierung mit verwalteter Identität: Weisen Sie SQL Server einer systemseitig zugewiesenen verwalteten Identität in Azure Active Directory (AAD) zu. Gewähren Sie SQL Server Identitätszugriff auf das Speicherkonto, indem Sie der Serveridentität die RBAC-Rolle "Storage Blob Data Contributor" hinzufügen. Weitere Informationen finden Sie unter Überwachen des Speichers mithilfe der Authentifizierung mit verwalteter Identität.
properties.storageAccountSubscriptionId		string	Gibt die Blob Storage-Abonnement-ID an.
properties.storageEndpoint		string	Gibt den Blobspeicherendpunkt an (z. B. https://MyAccount.blob.core.windows.net). Wenn der Status Aktiviert ist, ist storageEndpoint oder isAzureMonitorTargetEnabled erforderlich.

Antworten

Name	Typ	Beschreibung
200 OK	ServerDevOpsAuditingSettings	Die DevOps-Überwachungseinstellungen wurden erfolgreich aktualisiert.
202 Accepted		Die DevOps-Überwachungseinstellungen werden derzeit aktualisiert.
Other Status Codes		Fehlerantworten: *** 400 InvalidServerDevOpsAuditSettingsCreateRequest: Die DevOps-Überwachungsrichtlinienanforderung zum Erstellen des Servers ist nicht vorhanden oder weist kein Eigenschaftenobjekt auf. 400 DataSecurityInvalidUserSuppliedParameter: Vom Client wurde ein ungültiger Parameterwert bereitgestellt. 400 InvalidServerDevOpsAuditSettingsName: Ungültiger DevOps-Richtlinienname des Servers. 400 DevOpsAuditInvalidStorageAccountCredentials: Das angegebene Speicherkonto oder der angegebene Zugriffsschlüssel ist ungültig. 404 SubscriptionDoesNotHaveServer: Der angeforderte Server wurde nicht gefunden 404 ServerNotInSubscriptionResourceGroup: Der angegebene Server ist in der angegebenen Ressourcengruppe und dem angegebenen Abonnement nicht vorhanden. 409 ServerDevOpsAuditSettingsInProgress: Festlegen der DevOps-Überwachung des Servers ist bereits in Bearbeitung.

Name

Typ

Beschreibung

200 OK

ServerDevOpsAuditingSettings

Die DevOps-Überwachungseinstellungen wurden erfolgreich aktualisiert.

202 Accepted

Die DevOps-Überwachungseinstellungen werden derzeit aktualisiert.

Other Status Codes

Fehlerantworten: ***

400 InvalidServerDevOpsAuditSettingsCreateRequest: Die DevOps-Überwachungsrichtlinienanforderung zum Erstellen des Servers ist nicht vorhanden oder weist kein Eigenschaftenobjekt auf.
400 DataSecurityInvalidUserSuppliedParameter: Vom Client wurde ein ungültiger Parameterwert bereitgestellt.
400 InvalidServerDevOpsAuditSettingsName: Ungültiger DevOps-Richtlinienname des Servers.
400 DevOpsAuditInvalidStorageAccountCredentials: Das angegebene Speicherkonto oder der angegebene Zugriffsschlüssel ist ungültig.
404 SubscriptionDoesNotHaveServer: Der angeforderte Server wurde nicht gefunden
404 ServerNotInSubscriptionResourceGroup: Der angegebene Server ist in der angegebenen Ressourcengruppe und dem angegebenen Abonnement nicht vorhanden.
409 ServerDevOpsAuditSettingsInProgress: Festlegen der DevOps-Überwachung des Servers ist bereits in Bearbeitung.

Beispiele

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

Definitionen

Name	Beschreibung
BlobAuditingPolicyState	Gibt den Status der Überwachung an. Wenn der Status Aktiviert ist, sind storageEndpoint oder isAzureMonitorTargetEnabled erforderlich.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ServerDevOpsAuditingSettings	Eine DevOps-Serverüberwachungseinstellungen.
systemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

BlobAuditingPolicyState

Gibt den Status der Überwachung an. Wenn der Status Aktiviert ist, sind storageEndpoint oder isAzureMonitorTargetEnabled erforderlich.

Name	Typ	Beschreibung
Disabled	string
Enabled	string

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

ServerDevOpsAuditingSettings

Eine DevOps-Serverüberwachungseinstellungen.

Name	Typ	Beschreibung
id	string	Ressourcen-ID
name	string	Name der Ressource.
properties.isAzureMonitorTargetEnabled	boolean	Gibt an, ob DevOps-Überwachungsereignisse an Azure Monitor gesendet werden. Um die Ereignisse an Azure Monitor zu senden, geben Sie "State" als "Enabled" und "IsAzureMonitorTargetEnabled" als true an. Wenn Sie die REST-API zum Konfigurieren der DevOps-Überwachung verwenden, sollten auch Diagnoseeinstellungen mit der Diagnoseprotokollkategorie "DevOpsOperationsAudit" auf der master Datenbank erstellt werden. URI-Format für Diagnoseeinstellungen: 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 Weitere Informationen finden Sie unter Rest-API für Diagnoseeinstellungen oder Diagnoseeinstellungen PowerShell.
properties.state	BlobAuditingPolicyState	Gibt den Status der Überwachung an. Wenn der Status Aktiviert ist, sind storageEndpoint oder isAzureMonitorTargetEnabled erforderlich.
properties.storageAccountAccessKey	string	Gibt den Bezeichnerschlüssel des Überwachungsspeicherkontos an. Wenn der Status Aktiviert und storageEndpoint angegeben ist, wird die vom SQL Server systemseitig zugewiesene verwaltete Identität für den Zugriff auf den Speicher nicht angegeben. Voraussetzungen für die Verwendung der Authentifizierung mit verwalteter Identität: Weisen Sie SQL Server einer systemseitig zugewiesenen verwalteten Identität in Azure Active Directory (AAD) zu. Gewähren Sie SQL Server Identitätszugriff auf das Speicherkonto, indem Sie der Serveridentität die RBAC-Rolle "Storage Blob Data Contributor" hinzufügen. Weitere Informationen finden Sie unter Überwachen des Speichers mithilfe der Authentifizierung mit verwalteter Identität.
properties.storageAccountSubscriptionId	string	Gibt die Blob Storage-Abonnement-ID an.
properties.storageEndpoint	string	Gibt den Blobspeicherendpunkt an (z. B. https://MyAccount.blob.core.windows.net). Wenn der Status Aktiviert ist, ist storageEndpoint oder isAzureMonitorTargetEnabled erforderlich.
systemData	systemData	SystemDaten von ServerDevOpsAuditSettingsResource.
type	string	Der Ressourcentyp.

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name	Typ	Beschreibung
createdAt	string	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

Server DevOps Audit Settings - Create Or Update

URI-Parameter

Anforderungstext

Antworten

Beispiele

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

Definitionen

BlobAuditingPolicyState

createdByType

ServerDevOpsAuditingSettings

systemData

Zusätzliche Ressourcen