Freigeben über

Server DevOps Audit Settings - Create Or Update

  • Referenz
Dienst:
SQL Database
API-Version:
2023-08-01

Erstellt oder aktualisiert die DevOps-Überwachungseinstellungen eines Servers.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
devOpsAuditingSettingsName
 path True

DevOpsAuditingSettingsName

resourceGroupName
 path True

string

Der Name der Ressourcengruppe, die die Ressource enthält. Sie können diesen Wert aus der Azure Resource Manager-API oder dem Portal abrufen.
serverName
 path True

string

Der Name des Servers.
subscriptionId
 path True

string

Die Abonnement-ID, die ein Azure-Abonnement identifiziert.
api-version
 query True

string

Die 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.

Bei Verwendung der REST-API zum Konfigurieren der DevOps-Überwachung sollten auch Diagnoseeinstellungen mit der Diagnoseprotokollkategorie "DevOpsOperationsAudit" in der Masterdatenbank erstellt werden.

URI-Format der 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.isManagedIdentityInUse

boolean

Gibt an, ob verwaltete Identität für den Zugriff auf BLOB-Speicher verwendet wird.
properties.storageAccountAccessKey

string

Gibt den Bezeichnerschlüssel des Überwachungsspeicherkontos an. Wenn der Status aktiviert ist und "storageEndpoint" angegeben ist, verwendet "storageAccountAccessKey" nicht die vom Sql Server zugewiesene verwaltete Identität für den Zugriff auf den Speicher. Voraussetzungen für die Verwendung der verwalteten Identitätsauthentifizierung:

  1. Weisen Sie SQL Server einer vom System zugewiesenen verwalteten Identität in Azure Active Directory (AAD) zu.
  2. 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 Überwachung des Speichers mit verwalteter Identitätsauthentifizierung
properties.storageAccountSubscriptionId

string (uuid)

Gibt die BLOB-Speicherabonnement-ID an.
properties.storageEndpoint

string

Gibt den BLOB-Speicherendpunkt 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

Das Aktualisieren der DevOps-Überwachungseinstellungen wird ausgeführt.

Header

Location: string
Other Status Codes

ErrorResponse

Fehlerantworten: ***

  • 400 ManagedInstanceStoppingOrStopped – Konfliktierender Vorgang, der während der Instanz beendet/beendet wird

  • 400 ManagedInstanceStarting – Konfliktierender Vorgang, der während der Instanz im Startzustand liegt

  • 400 InvalidServerDevOpsAuditSettingsCreateRequest – Die Create Server DevOps-Überwachungsrichtlinienanforderung ist nicht vorhanden oder weist kein Eigenschaftenobjekt auf.

  • 400 DataSecurityInvalidUserSuppliedParameter – Ein ungültiger Parameterwert wurde vom Client bereitgestellt.

  • 400 InvalidServerDevOpsAuditSettingsName – Ungültiger DevOps-Richtlinienname des Servers.

  • 400 DevOpsAuditInvalidStorageAccountCredentials – Das bereitgestellte Speicherkonto oder der zugriffsschlüssel ist ungültig.

  • 404 ServerNotInSubscriptionResourceGroup – Der angegebene Server ist in der angegebenen Ressourcengruppe und dem angegebenen Abonnement nicht vorhanden.

  • 404 SubscriptionDoesNotHaveServer – Der angeforderte Server wurde nicht gefunden.

  • 404 OperationIdNotFound – Der Vorgang mit der ID ist nicht vorhanden.

  • 409 ServerDevOpsAuditSettingsInProgress – Die DevOps-Überwachung des Servers wird bereits ausgeführt.

  • 409 CannotCancelOperation – Der Verwaltungsvorgang befindet sich in einem Zustand, der nicht abgebrochen werden kann.

  • 409 OperationCancelled – Der Vorgang wurde vom Benutzer abgebrochen.

  • 409 OperationInterrupted – Der Vorgang für die Ressource konnte nicht abgeschlossen werden, weil er durch einen anderen Vorgang in derselben Ressource unterbrochen wurde.

  • 429 SubscriptionTooManyCreateUpdateRequests – Anforderungen über max. Anforderungen hinaus, die von verfügbaren Ressourcen verarbeitet werden können.

  • 429 SubscriptionTooManyRequests – Anforderungen über max. Anforderungen hinaus, die von verfügbaren Ressourcen verarbeitet werden können.

  • 500 OperationTimedOut – Timeout des Vorgangs und automatisches Zurücksetzen. Versuchen Sie den Vorgang erneut.

  • 503 TooManyRequests – Anforderungen über max. Anforderungen hinaus, die von verfügbaren Ressourcen verarbeitet werden können.

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

Beispielanforderung

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
  }
}

Beispiel für eine Antwort

Statuscode:
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
  }
}
Statuscode:
202

Update a server's DevOps audit settings with minimal input

Beispielanforderung

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"
  }
}

Beispiel für eine Antwort

Statuscode:
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"
  }
}
Statuscode:
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.
DevOpsAuditingSettingsName
ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail

Das Fehlerdetails.
ErrorResponse

Fehlerantwort
ServerDevOpsAuditingSettings

Eine DevOps-Serverüberwachungseinstellungen.
systemData

Metadaten zur Erstellung und letzten Änderung der Ressource.

BlobAuditingPolicyState

Enumeration

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

Wert Beschreibung
Disabled
Enabled

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert Beschreibung
Application
Key
ManagedIdentity
User

DevOpsAuditingSettingsName

Enumeration
Wert Beschreibung
Default

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name Typ Beschreibung
info

object

Die zusätzlichen Informationen.
type

string

Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Informationen des Fehlers.
code

string

Der Fehlercode.
details

ErrorDetail[]

Die Fehlerdetails.
message

string

Die Fehlermeldung.
target

string

Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name Typ Beschreibung
error

ErrorDetail

Das Fehlerobjekt.

ServerDevOpsAuditingSettings

Objekt

Eine DevOps-Serverüberwachungseinstellungen.

Name Typ Beschreibung
id

string

Ressourcen-ID.
name

string

Ressourcenname.
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.

Bei Verwendung der REST-API zum Konfigurieren der DevOps-Überwachung sollten auch Diagnoseeinstellungen mit der Diagnoseprotokollkategorie "DevOpsOperationsAudit" in der Masterdatenbank erstellt werden.

URI-Format der 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.isManagedIdentityInUse

boolean

Gibt an, ob verwaltete Identität für den Zugriff auf BLOB-Speicher verwendet wird.
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 ist und "storageEndpoint" angegeben ist, verwendet "storageAccountAccessKey" nicht die vom Sql Server zugewiesene verwaltete Identität für den Zugriff auf den Speicher. Voraussetzungen für die Verwendung der verwalteten Identitätsauthentifizierung:

  1. Weisen Sie SQL Server einer vom System zugewiesenen verwalteten Identität in Azure Active Directory (AAD) zu.
  2. 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 Überwachung des Speichers mit verwalteter Identitätsauthentifizierung
properties.storageAccountSubscriptionId

string (uuid)

Gibt die BLOB-Speicherabonnement-ID an.
properties.storageEndpoint

string

Gibt den BLOB-Speicherendpunkt an (z. B. https://MyAccount.blob.core.windows.net). Wenn der Status aktiviert ist, ist "storageEndpoint" oder "isAzureMonitorTargetEnabled" erforderlich.
systemData

systemData

SystemData von ServerDevOpsAuditSettingsResource.
type

string

Ressourcentyp.

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name Typ Beschreibung
createdAt

string (date-time)

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 (date-time)

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.