Condividi tramite


Server DevOps Audit Settings - Create Or Update

Crea o aggiorna le impostazioni di controllo DevOps di un server.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
devOpsAuditingSettingsName
path True

DevOpsAuditingSettingsName

resourceGroupName
path True

string

Nome del gruppo di risorse che contiene la risorsa. È possibile ottenere questo valore dall'API di Azure Resource Manager o dal portale.

serverName
path True

string

Nome del server.

subscriptionId
path True

string

ID sottoscrizione che identifica una sottoscrizione di Azure.

api-version
query True

string

Versione dell'API da usare per la richiesta.

Corpo della richiesta

Nome Necessario Tipo Descrizione
properties.state True

BlobAuditingPolicyState

Specifica lo stato del controllo. Se lo stato è Abilitato, sono necessari storageEndpoint o isAzureMonitorTargetEnabled.

properties.isAzureMonitorTargetEnabled

boolean

Specifica se gli eventi di controllo DevOps vengono inviati a Monitoraggio di Azure. Per inviare gli eventi a Monitoraggio di Azure, specificare 'State' come 'Enabled' e 'IsAzureMonitorTargetEnabled' come true.

Quando si usa l'API REST per configurare il controllo DevOps, è necessario creare anche le impostazioni di diagnostica con la categoria dei log di diagnostica "DevOpsOperationsAudit" nel database master.

Formato URI impostazioni di diagnostica: 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

Per altre informazioni, vedere 'API REST delle impostazioni di diagnostica o Impostazioni di diagnostica di PowerShell

properties.isManagedIdentityInUse

boolean

Specifica se l'identità gestita viene usata per accedere all'archiviazione BLOB

properties.storageAccountAccessKey

string

Specifica la chiave di identificatore dell'account di archiviazione di controllo. Se lo stato è Abilitato e viene specificato storageEndpoint, non specificando storageAccountAccessKey verrà usata l'identità gestita assegnata dal sistema di SQL Server per accedere all'archiviazione. Prerequisiti per l'uso dell'autenticazione dell'identità gestita:

  1. Assegnare a SQL Server un'identità gestita assegnata dal sistema in Azure Active Directory (AAD).
  2. Concedere all'identità di SQL Server l'accesso all'account di archiviazione aggiungendo il ruolo controllo degli accessi in base al ruolo "Collaboratore ai dati dei BLOB di archiviazione" all'identità del server. Per altre informazioni, vedere Auditing to storage using Managed Identity Authentication
properties.storageAccountSubscriptionId

string (uuid)

Specifica l'ID sottoscrizione dell'archiviazione BLOB.

properties.storageEndpoint

string

Specifica l'endpoint di archiviazione BLOB , ad esempio https://MyAccount.blob.core.windows.net. Se lo stato è Abilitato, è necessario storageEndpoint o isAzureMonitorTargetEnabled.

Risposte

Nome Tipo Descrizione
200 OK

ServerDevOpsAuditingSettings

Sono state aggiornate correttamente le impostazioni di controllo devOps.

202 Accepted

L'aggiornamento delle impostazioni devOps di controllo è in corso.

Intestazioni

Location: string

Other Status Codes

ErrorResponse

Risposte di errore:

  • 400 ManagedInstanceStoppingOrStopped - Operazione in conflitto inviata mentre l'istanza è in stato di arresto/arresto

  • 400 ManagedInstanceStarting - Operazione in conflitto inviata mentre l'istanza è in stato di avvio

  • 400 InvalidServerDevOpsAuditSettingsCreateRequest: la richiesta di criteri di controllo DevOps create server non esiste o non ha alcun oggetto proprietà.

  • 400 DataSecurityInvalidUserSuppliedParameter - Il client ha fornito un valore di parametro non valido.

  • 400 InvalidServerDevOpsAuditSettingsName - Nome criterio DevOps server non valido.

  • 400 DevOpsAuditInvalidStorageAccountCredentials: l'account di archiviazione o la chiave di accesso forniti non è valido.

  • 404 ServerNotInSubscriptionResourceGroup - Il server specificato non esiste nel gruppo di risorse e nella sottoscrizione specificati.

  • 404 SubscriptionDoesNotHaveServer - Il server richiesto non è stato trovato

  • 404 OperationIdNotFound - L'operazione con ID non esiste.

  • 409 ServerDevOpsAuditSettingsInProgress - Impostare il controllo DevOps del server è già in corso.

  • 409 CannotCancelOperation: l'operazione di gestione si trova in uno stato che non può essere annullato.

  • 409 OperationCancelled - L'operazione è stata annullata dall'utente.

  • 409 OperationInterrupted - Impossibile completare l'operazione sulla risorsa perché è stata interrotta da un'altra operazione sulla stessa risorsa.

  • 429 SubscriptionTooManyCreateUpdateRequests - Richieste oltre il numero massimo di richieste che possono essere elaborate dalle risorse disponibili.

  • 429 SubscriptionTooManyRequests - Richieste oltre il numero massimo di richieste che possono essere elaborate dalle risorse disponibili.

  • 500 OperationTimedOut: timeout dell'operazione e rollback automatico. Ripetere l'operazione.

  • 503 TooManyRequests - Richieste oltre il numero massimo di richieste che possono essere elaborate dalle risorse disponibili.

Esempio

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

Esempio di richiesta

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

Risposta di esempio

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

Update a server's DevOps audit settings with minimal input

Esempio di richiesta

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

Risposta di esempio

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

Definizioni

Nome Descrizione
BlobAuditingPolicyState

Specifica lo stato del controllo. Se lo stato è Abilitato, sono necessari storageEndpoint o isAzureMonitorTargetEnabled.

createdByType

Tipo di identità che ha creato la risorsa.

DevOpsAuditingSettingsName
ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

ErrorDetail

Dettagli dell'errore.

ErrorResponse

Risposta di errore

ServerDevOpsAuditingSettings

Impostazioni di controllo DevOps del server.

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

BlobAuditingPolicyState

Specifica lo stato del controllo. Se lo stato è Abilitato, sono necessari storageEndpoint o isAzureMonitorTargetEnabled.

Valore Descrizione
Disabled
Enabled

createdByType

Tipo di identità che ha creato la risorsa.

Valore Descrizione
Application
Key
ManagedIdentity
User

DevOpsAuditingSettingsName

Valore Descrizione
Default

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome Tipo Descrizione
info

object

Informazioni aggiuntive.

type

string

Tipo di informazioni aggiuntive.

ErrorDetail

Dettagli dell'errore.

Nome Tipo Descrizione
additionalInfo

ErrorAdditionalInfo[]

Informazioni aggiuntive sull'errore.

code

string

Codice di errore.

details

ErrorDetail[]

Dettagli dell'errore.

message

string

Messaggio di errore.

target

string

Destinazione dell'errore.

ErrorResponse

Risposta di errore

Nome Tipo Descrizione
error

ErrorDetail

Oggetto error.

ServerDevOpsAuditingSettings

Impostazioni di controllo DevOps del server.

Nome Tipo Descrizione
id

string

ID risorsa.

name

string

Nome risorsa.

properties.isAzureMonitorTargetEnabled

boolean

Specifica se gli eventi di controllo DevOps vengono inviati a Monitoraggio di Azure. Per inviare gli eventi a Monitoraggio di Azure, specificare 'State' come 'Enabled' e 'IsAzureMonitorTargetEnabled' come true.

Quando si usa l'API REST per configurare il controllo DevOps, è necessario creare anche le impostazioni di diagnostica con la categoria dei log di diagnostica "DevOpsOperationsAudit" nel database master.

Formato URI impostazioni di diagnostica: 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

Per altre informazioni, vedere 'API REST delle impostazioni di diagnostica o Impostazioni di diagnostica di PowerShell

properties.isManagedIdentityInUse

boolean

Specifica se l'identità gestita viene usata per accedere all'archiviazione BLOB

properties.state

BlobAuditingPolicyState

Specifica lo stato del controllo. Se lo stato è Abilitato, sono necessari storageEndpoint o isAzureMonitorTargetEnabled.

properties.storageAccountAccessKey

string

Specifica la chiave di identificatore dell'account di archiviazione di controllo. Se lo stato è Abilitato e viene specificato storageEndpoint, non specificando storageAccountAccessKey verrà usata l'identità gestita assegnata dal sistema di SQL Server per accedere all'archiviazione. Prerequisiti per l'uso dell'autenticazione dell'identità gestita:

  1. Assegnare a SQL Server un'identità gestita assegnata dal sistema in Azure Active Directory (AAD).
  2. Concedere all'identità di SQL Server l'accesso all'account di archiviazione aggiungendo il ruolo controllo degli accessi in base al ruolo "Collaboratore ai dati dei BLOB di archiviazione" all'identità del server. Per altre informazioni, vedere Auditing to storage using Managed Identity Authentication
properties.storageAccountSubscriptionId

string (uuid)

Specifica l'ID sottoscrizione dell'archiviazione BLOB.

properties.storageEndpoint

string

Specifica l'endpoint di archiviazione BLOB , ad esempio https://MyAccount.blob.core.windows.net. Se lo stato è Abilitato, è necessario storageEndpoint o isAzureMonitorTargetEnabled.

systemData

systemData

SystemData di ServerDevOpsAuditSettingsResource.

type

string

Tipo di risorsa.

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome Tipo Descrizione
createdAt

string (date-time)

Timestamp della creazione della risorsa (UTC).

createdBy

string

Identità che ha creato la risorsa.

createdByType

createdByType

Tipo di identità che ha creato la risorsa.

lastModifiedAt

string (date-time)

Timestamp dell'ultima modifica della risorsa (UTC)

lastModifiedBy

string

Identità che ha modificato l'ultima volta la risorsa.

lastModifiedByType

createdByType

Tipo di identità che ha modificato l'ultima volta la risorsa.