Server DevOps Audit Settings - Create Or Update

Odwołanie

Usługa:: SQL Database

Wersja interfejsu API:: 2023-08-01

Tworzy lub aktualizuje ustawienia inspekcji metodyki DevOps serwera.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
devOpsAuditingSettingsName	path	True	DevOpsAuditingSettingsName
resourceGroupName	path	True	string	Nazwa grupy zasobów zawierającej zasób. Tę wartość można uzyskać z interfejsu API usługi Azure Resource Manager lub portalu.
serverName	path	True	string	Nazwa serwera.
subscriptionId	path	True	string	Identyfikator subskrypcji identyfikujący subskrypcję platformy Azure.
api-version	query	True	string	Wersja interfejsu API do użycia dla żądania.

Treść żądania

Nazwa	Wymagane	Typ	Opis
properties.state	True	BlobAuditingPolicyState	Określa stan inspekcji. Jeśli stan jest włączony, wymagany jest parametr storageEndpoint lub isAzureMonitorTargetEnabled.
properties.isAzureMonitorTargetEnabled		boolean	Określa, czy zdarzenia inspekcji metodyki DevOps są wysyłane do usługi Azure Monitor. Aby wysyłać zdarzenia do usługi Azure Monitor, określ wartość "State" jako "Enabled" i "IsAzureMonitorTargetEnabled" jako true. W przypadku konfigurowania inspekcji metodyki DevOps przy użyciu interfejsu API REST należy również utworzyć ustawienia diagnostyczne z kategorią dzienników diagnostycznych "DevOpsOperationsAudit" w bazie danych master. Format identyfikatora URI ustawień diagnostycznych: 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 Aby uzyskać więcej informacji, zobacz Ustawienia diagnostyczne interfejsu API REST lub ustawienia diagnostyczne Programu PowerShell
properties.isManagedIdentityInUse		boolean	Określa, czy tożsamość zarządzana jest używana do uzyskiwania dostępu do magazynu obiektów blob
properties.storageAccountAccessKey		string	Określa klucz identyfikatora konta magazynu inspekcji. Jeśli stan jest włączony, a punkt storageEndpoint jest określony, nie określa wartości storageAccountAccessKey będzie używać przypisanej przez system tożsamości zarządzanej programu SQL Server w celu uzyskania dostępu do magazynu. Wymagania wstępne dotyczące korzystania z uwierzytelniania tożsamości zarządzanej: Przypisz program SQL Server tożsamość zarządzaną przypisaną przez system w usłudze Azure Active Directory (AAD). Udziel tożsamości programu SQL Server dostępu do konta magazynu, dodając rolę RBAC współautora danych obiektu blob usługi Storage do tożsamości serwera. Aby uzyskać więcej informacji, zobacz Inspekcja w magazynie przy użyciu uwierzytelniania tożsamości zarządzanej
properties.storageAccountSubscriptionId		string (uuid)	Określa identyfikator subskrypcji magazynu obiektów blob.
properties.storageEndpoint		string	Określa punkt końcowy magazynu obiektów blob (np. https://MyAccount.blob.core.windows.net). Jeśli stan jest włączony, wymagany jest parametr storageEndpoint lub isAzureMonitorTargetEnabled.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ServerDevOpsAuditingSettings	Pomyślnie zaktualizowano ustawienia inspekcji metodyki DevOps.
202 Accepted		Aktualizowanie ustawień usługi DevOps inspekcji jest w toku. Nagłówki Location: string
Other Status Codes	ErrorResponse	Odpowiedzi na błędy: *** 400 ManagedInstanceStoppingOrStopped — operacja powodująca konflikt przesłana, gdy wystąpienie jest w stanie zatrzymania/zatrzymania 400 ManagedInstanceStarting — operacja powodująca konflikt przesłana, gdy wystąpienie jest w stanie początkowym 400 InvalidServerDevOpsAuditSettingsCreateRequest — żądanie zasad inspekcji metodyki DevOps serwera nie istnieje lub nie ma obiektu właściwości. 400 DataSecurityInvalidUserSuppliedParameter — klient podał nieprawidłową wartość parametru. 400 InvalidServerDevOpsAuditSettingsName — nieprawidłowa nazwa zasad DevOps serwera. 400 DevOpsAuditInvalidStorageAccountCredentials — podane konto magazynu lub klucz dostępu są nieprawidłowe. 404 ServerNotInSubscriptionResourceGroup — określony serwer nie istnieje w określonej grupie zasobów i subskrypcji. 404 SubscriptionDoesNotHaveServer — nie znaleziono żądanego serwera 404 OperationIdNotFound — operacja o identyfikatorze nie istnieje. 409 ServerDevOpsAuditSettingsInProgress — ustawianie inspekcji metodyki DevOps serwera jest już w toku. 409 CannotCancelOperation — operacja zarządzania jest w stanie, którego nie można anulować. 409 OperationCancelled — operacja została anulowana przez użytkownika. 409 Operacja przerwana — nie można ukończyć operacji na zasobie, ponieważ została przerwana przez inną operację na tym samym zasobie. 429 SubscriptionTooManyCreateUpdateRequests — żądania wykraczające poza maksymalne żądania, które mogą być przetwarzane przez dostępne zasoby. 429 SubscriptionTooManyRequests — żądania wykraczające poza maksymalną liczbę żądań, które mogą być przetwarzane przez dostępne zasoby. 500 OperationTimedOut — upłynął limit czasu operacji i automatycznie wycofano. Ponów próbę wykonania operacji. 503 TooManyRequests — żądania wykraczające poza maksymalne żądania, które mogą być przetwarzane przez dostępne zasoby.

Nazwa

Typ

Opis

200 OK

ServerDevOpsAuditingSettings

Pomyślnie zaktualizowano ustawienia inspekcji metodyki DevOps.

202 Accepted

Aktualizowanie ustawień usługi DevOps inspekcji jest w toku.

Nagłówki

Location: string

Other Status Codes

ErrorResponse

Odpowiedzi na błędy: ***

400 ManagedInstanceStoppingOrStopped — operacja powodująca konflikt przesłana, gdy wystąpienie jest w stanie zatrzymania/zatrzymania
400 ManagedInstanceStarting — operacja powodująca konflikt przesłana, gdy wystąpienie jest w stanie początkowym
400 InvalidServerDevOpsAuditSettingsCreateRequest — żądanie zasad inspekcji metodyki DevOps serwera nie istnieje lub nie ma obiektu właściwości.
400 DataSecurityInvalidUserSuppliedParameter — klient podał nieprawidłową wartość parametru.
400 InvalidServerDevOpsAuditSettingsName — nieprawidłowa nazwa zasad DevOps serwera.
400 DevOpsAuditInvalidStorageAccountCredentials — podane konto magazynu lub klucz dostępu są nieprawidłowe.
404 ServerNotInSubscriptionResourceGroup — określony serwer nie istnieje w określonej grupie zasobów i subskrypcji.
404 SubscriptionDoesNotHaveServer — nie znaleziono żądanego serwera
404 OperationIdNotFound — operacja o identyfikatorze nie istnieje.
409 ServerDevOpsAuditSettingsInProgress — ustawianie inspekcji metodyki DevOps serwera jest już w toku.
409 CannotCancelOperation — operacja zarządzania jest w stanie, którego nie można anulować.
409 OperationCancelled — operacja została anulowana przez użytkownika.
409 Operacja przerwana — nie można ukończyć operacji na zasobie, ponieważ została przerwana przez inną operację na tym samym zasobie.
429 SubscriptionTooManyCreateUpdateRequests — żądania wykraczające poza maksymalne żądania, które mogą być przetwarzane przez dostępne zasoby.
429 SubscriptionTooManyRequests — żądania wykraczające poza maksymalną liczbę żądań, które mogą być przetwarzane przez dostępne zasoby.
500 OperationTimedOut — upłynął limit czasu operacji i automatycznie wycofano. Ponów próbę wykonania operacji.
503 TooManyRequests — żądania wykraczające poza maksymalne żądania, które mogą być przetwarzane przez dostępne zasoby.

Przykłady

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

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 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
  }
}

Kod stanu:: 202

Update a server's DevOps audit settings with minimal input

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 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"
  }
}

Kod stanu:: 202

Definicje

Nazwa	Opis
BlobAuditingPolicyState	Określa stan inspekcji. Jeśli stan jest włączony, wymagany jest parametr storageEndpoint lub isAzureMonitorTargetEnabled.
createdByType	Typ tożsamości, która utworzyła zasób.
DevOpsAuditingSettingsName
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
ServerDevOpsAuditingSettings	Ustawienia inspekcji metodyki DevOps serwera.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

BlobAuditingPolicyState

Wyliczanie

Określa stan inspekcji. Jeśli stan jest włączony, wymagany jest parametr storageEndpoint lub isAzureMonitorTargetEnabled.

Wartość	Opis
Disabled
Enabled

createdByType

Wyliczanie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
Application
Key
ManagedIdentity
User

DevOpsAuditingSettingsName

Wyliczanie

Wartość	Opis
Default

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

ServerDevOpsAuditingSettings

Objekt

Ustawienia inspekcji metodyki DevOps serwera.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
name	string	Nazwa zasobu.
properties.isAzureMonitorTargetEnabled	boolean	Określa, czy zdarzenia inspekcji metodyki DevOps są wysyłane do usługi Azure Monitor. Aby wysyłać zdarzenia do usługi Azure Monitor, określ wartość "State" jako "Enabled" i "IsAzureMonitorTargetEnabled" jako true. W przypadku konfigurowania inspekcji metodyki DevOps przy użyciu interfejsu API REST należy również utworzyć ustawienia diagnostyczne z kategorią dzienników diagnostycznych "DevOpsOperationsAudit" w bazie danych master. Format identyfikatora URI ustawień diagnostycznych: 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 Aby uzyskać więcej informacji, zobacz Ustawienia diagnostyczne interfejsu API REST lub ustawienia diagnostyczne Programu PowerShell
properties.isManagedIdentityInUse	boolean	Określa, czy tożsamość zarządzana jest używana do uzyskiwania dostępu do magazynu obiektów blob
properties.state	BlobAuditingPolicyState	Określa stan inspekcji. Jeśli stan jest włączony, wymagany jest parametr storageEndpoint lub isAzureMonitorTargetEnabled.
properties.storageAccountAccessKey	string	Określa klucz identyfikatora konta magazynu inspekcji. Jeśli stan jest włączony, a punkt storageEndpoint jest określony, nie określa wartości storageAccountAccessKey będzie używać przypisanej przez system tożsamości zarządzanej programu SQL Server w celu uzyskania dostępu do magazynu. Wymagania wstępne dotyczące korzystania z uwierzytelniania tożsamości zarządzanej: Przypisz program SQL Server tożsamość zarządzaną przypisaną przez system w usłudze Azure Active Directory (AAD). Udziel tożsamości programu SQL Server dostępu do konta magazynu, dodając rolę RBAC współautora danych obiektu blob usługi Storage do tożsamości serwera. Aby uzyskać więcej informacji, zobacz Inspekcja w magazynie przy użyciu uwierzytelniania tożsamości zarządzanej
properties.storageAccountSubscriptionId	string (uuid)	Określa identyfikator subskrypcji magazynu obiektów blob.
properties.storageEndpoint	string	Określa punkt końcowy magazynu obiektów blob (np. https://MyAccount.blob.core.windows.net). Jeśli stan jest włączony, wymagany jest parametr storageEndpoint lub isAzureMonitorTargetEnabled.
systemData	systemData	SystemData of ServerDevOpsAuditSettingsResource.
type	string	Typ zasobu.

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

Udostępnij za pośrednictwem

Server DevOps Audit Settings - Create Or Update

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Przykłady

Update a server's DevOps audit settings with all params

Przykładowe żądanie

Przykładowa odpowiedź

Update a server's DevOps audit settings with minimal input

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

BlobAuditingPolicyState

createdByType

DevOpsAuditingSettingsName

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ServerDevOpsAuditingSettings

systemData

Dodatkowe zasoby