Server DevOps Audit Settings - Create Or Update

Reference

Služba:: SQL Database

Verze rozhraní API:: 2023-08-01

Vytvoří nebo aktualizuje nastavení auditu DevOps serveru.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
devOpsAuditingSettingsName	path	True	DevOpsAuditingSettingsName
resourceGroupName	path	True	string	Název skupiny prostředků, která obsahuje prostředek. Tuto hodnotu můžete získat z rozhraní API Azure Resource Manageru nebo portálu.
serverName	path	True	string	Název serveru.
subscriptionId	path	True	string	ID předplatného, které identifikuje předplatné Azure.
api-version	query	True	string	Verze rozhraní API, která se má použít pro požadavek.

Text požadavku

Name	Vyžadováno	Typ	Description
properties.state	True	BlobAuditingPolicyState	Určuje stav auditu. Pokud je stav Povoleno, jsou vyžadovány hodnoty storageEndpoint nebo isAzureMonitorTargetEnabled.
properties.isAzureMonitorTargetEnabled		boolean	Určuje, jestli se události auditu DevOps odesílají do služby Azure Monitor. Pokud chcete odesílat události do služby Azure Monitor, jako true zadejte State a IsAzureMonitorTargetEnabled. Při konfiguraci auditování DevOps je potřeba vytvořit také nastavení diagnostiky s kategorií diagnostických protokolů DevOpsOperationsAudit v hlavní databázi. Formát identifikátoru URI nastavení diagnostiky: 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 Další informace najdete v tématu rozhraní REST API pro nastavení diagnostiky nebo nastavení diagnostiky
properties.isManagedIdentityInUse		boolean	Určuje, jestli se spravovaná identita používá pro přístup k úložišti objektů blob.
properties.storageAccountAccessKey		string	Určuje identifikátor klíče účtu úložiště auditování. Pokud je stav Povoleno a parametr storageEndpoint je zadaný, nezadávejte klíč storageAccountAccessKey pro přístup k úložišti spravovanou identitu přiřazenou systémem sql serveru. Předpoklady pro použití ověřování spravované identity: Přiřaďte SQL Serveru spravovanou identitu přiřazenou systémem v Azure Active Directory (AAD). Udělte identitě SQL Serveru přístup k účtu úložiště přidáním role RBAC přispěvatele dat objektů blob úložiště k identitě serveru. Další informace najdete v tématu Auditování úložiště pomocí ověřování spravované identity
properties.storageAccountSubscriptionId		string (uuid)	Určuje ID předplatného úložiště objektů blob.
properties.storageEndpoint		string	Určuje koncový bod úložiště objektů blob (např. https://MyAccount.blob.core.windows.net). Pokud je stav Povoleno, je vyžadována možnost storageEndpoint nebo isAzureMonitorTargetEnabled.

Odpovědi

Name	Typ	Description
200 OK	ServerDevOpsAuditingSettings	Nastavení auditu DevOps bylo úspěšně aktualizováno.
202 Accepted		Probíhá aktualizace nastavení Audit DevOps. Hlavičky Location: string
Other Status Codes	ErrorResponse	Chybové odpovědi: *** 400 ManagedInstanceStoppingOrStopped – Konfliktní operace odeslaná, když je instance v zastaveném nebo zastaveném stavu 400 ManagedInstanceStarting – Konfliktní operace odeslaná při spuštění instance 400 InvalidServerDevOpsAuditSettingsCreateRequest – Požadavek na zásadu auditu DevOps pro vytvoření serveru neexistuje nebo nemá žádný objekt vlastností. 400 DataSecurityInvalidUserSuppliedParameter – klient zadal neplatnou hodnotu parametru. 400 InvalidServerDevOpsAuditSettingsName – Neplatný název zásady DevOps serveru. 400 DevOpsAuditInvalidStorageAccountCredentials – Zadaný účet úložiště nebo přístupový klíč není platný. 404 ServerNotInSubscriptionResourceGroup – Zadaný server neexistuje v zadané skupině prostředků a předplatném. 404 SubscriptionDoesNotHaveServer – Požadovaný server nebyl nalezen. 404 OperationIdNotFound – operace s ID neexistuje. 409 ServerDevOpsAuditSettingsInProgress – Nastavení auditu DevOps serveru už probíhá. 409 CannotCancelOperation – Operace správy je ve stavu, který nelze zrušit. 409 OperationCancelled - Operace byla zrušena uživatelem. 409 OperationInterrupted – operaci s prostředkem nebylo možné dokončit, protože byla přerušena jinou operací na stejném prostředku. 429 SubscriptionTooManyCreateUpdateRequests – Požadavky nad rámec maximálních požadavků, které je možné zpracovat dostupnými prostředky. 429 SubscriptionTooManyRequests – Požadavky nad rámec maximálních požadavků, které je možné zpracovat dostupnými prostředky. 500 OperationTimedOut – Vypršel časový limit operace a automaticky se vrátil zpět. Zkuste operaci zopakovat. 503 TooManyRequests – Požadavky nad rámec maximálních požadavků, které je možné zpracovat dostupnými prostředky.

Name

Typ

Description

200 OK

ServerDevOpsAuditingSettings

Nastavení auditu DevOps bylo úspěšně aktualizováno.

202 Accepted

Probíhá aktualizace nastavení Audit DevOps.

Hlavičky

Location: string

Other Status Codes

ErrorResponse

Chybové odpovědi: ***

400 ManagedInstanceStoppingOrStopped – Konfliktní operace odeslaná, když je instance v zastaveném nebo zastaveném stavu
400 ManagedInstanceStarting – Konfliktní operace odeslaná při spuštění instance
400 InvalidServerDevOpsAuditSettingsCreateRequest – Požadavek na zásadu auditu DevOps pro vytvoření serveru neexistuje nebo nemá žádný objekt vlastností.
400 DataSecurityInvalidUserSuppliedParameter – klient zadal neplatnou hodnotu parametru.
400 InvalidServerDevOpsAuditSettingsName – Neplatný název zásady DevOps serveru.
400 DevOpsAuditInvalidStorageAccountCredentials – Zadaný účet úložiště nebo přístupový klíč není platný.
404 ServerNotInSubscriptionResourceGroup – Zadaný server neexistuje v zadané skupině prostředků a předplatném.
404 SubscriptionDoesNotHaveServer – Požadovaný server nebyl nalezen.
404 OperationIdNotFound – operace s ID neexistuje.
409 ServerDevOpsAuditSettingsInProgress – Nastavení auditu DevOps serveru už probíhá.
409 CannotCancelOperation – Operace správy je ve stavu, který nelze zrušit.
409 OperationCancelled - Operace byla zrušena uživatelem.
409 OperationInterrupted – operaci s prostředkem nebylo možné dokončit, protože byla přerušena jinou operací na stejném prostředku.
429 SubscriptionTooManyCreateUpdateRequests – Požadavky nad rámec maximálních požadavků, které je možné zpracovat dostupnými prostředky.
429 SubscriptionTooManyRequests – Požadavky nad rámec maximálních požadavků, které je možné zpracovat dostupnými prostředky.
500 OperationTimedOut – Vypršel časový limit operace a automaticky se vrátil zpět. Zkuste operaci zopakovat.
503 TooManyRequests – Požadavky nad rámec maximálních požadavků, které je možné zpracovat dostupnými prostředky.

Příklady

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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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
  }
}

Stavový kód:: 202

Update a server's DevOps audit settings with minimal input

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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"
  }
}

Stavový kód:: 202

Definice

Name	Description
BlobAuditingPolicyState	Určuje stav auditu. Pokud je stav Povoleno, jsou vyžadovány hodnoty storageEndpoint nebo isAzureMonitorTargetEnabled.
createdByType	Typ identity, která prostředek vytvořila.
DevOpsAuditingSettingsName
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
ServerDevOpsAuditingSettings	Nastavení auditování DevOps serveru
systemData	Metadata týkající se vytvoření a poslední změny prostředku.

BlobAuditingPolicyState

Výčet

Určuje stav auditu. Pokud je stav Povoleno, jsou vyžadovány hodnoty storageEndpoint nebo isAzureMonitorTargetEnabled.

Hodnota	Description
Disabled
Enabled

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
Application
Key
ManagedIdentity
User

DevOpsAuditingSettingsName

Výčet

Hodnota	Description
Default

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

ServerDevOpsAuditingSettings

Objekt

Nastavení auditování DevOps serveru

Name	Typ	Description
id	string	ID prostředku.
name	string	Název prostředku
properties.isAzureMonitorTargetEnabled	boolean	Určuje, jestli se události auditu DevOps odesílají do služby Azure Monitor. Pokud chcete odesílat události do služby Azure Monitor, jako true zadejte State a IsAzureMonitorTargetEnabled. Při konfiguraci auditování DevOps je potřeba vytvořit také nastavení diagnostiky s kategorií diagnostických protokolů DevOpsOperationsAudit v hlavní databázi. Formát identifikátoru URI nastavení diagnostiky: 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 Další informace najdete v tématu rozhraní REST API pro nastavení diagnostiky nebo nastavení diagnostiky
properties.isManagedIdentityInUse	boolean	Určuje, jestli se spravovaná identita používá pro přístup k úložišti objektů blob.
properties.state	BlobAuditingPolicyState	Určuje stav auditu. Pokud je stav Povoleno, jsou vyžadovány hodnoty storageEndpoint nebo isAzureMonitorTargetEnabled.
properties.storageAccountAccessKey	string	Určuje identifikátor klíče účtu úložiště auditování. Pokud je stav Povoleno a parametr storageEndpoint je zadaný, nezadávejte klíč storageAccountAccessKey pro přístup k úložišti spravovanou identitu přiřazenou systémem sql serveru. Předpoklady pro použití ověřování spravované identity: Přiřaďte SQL Serveru spravovanou identitu přiřazenou systémem v Azure Active Directory (AAD). Udělte identitě SQL Serveru přístup k účtu úložiště přidáním role RBAC přispěvatele dat objektů blob úložiště k identitě serveru. Další informace najdete v tématu Auditování úložiště pomocí ověřování spravované identity
properties.storageAccountSubscriptionId	string (uuid)	Určuje ID předplatného úložiště objektů blob.
properties.storageEndpoint	string	Určuje koncový bod úložiště objektů blob (např. https://MyAccount.blob.core.windows.net). Pokud je stav Povoleno, je vyžadována možnost storageEndpoint nebo isAzureMonitorTargetEnabled.
systemData	systemData	SystemData of ServerDevOpsAuditSettingsResource.
type	string	Typ prostředku.

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

Sdílet prostřednictvím

Server DevOps Audit Settings - Create Or Update

Parametry identifikátoru URI

Text požadavku

Odpovědi

Příklady

Update a server's DevOps audit settings with all params

Ukázkový požadavek

Ukázková odpověď

Update a server's DevOps audit settings with minimal input

Ukázkový požadavek

Ukázková odpověď

Definice

BlobAuditingPolicyState

createdByType

DevOpsAuditingSettingsName

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ServerDevOpsAuditingSettings

systemData

Další materiály