Condividi tramite

Server DevOps Audit Settings - Create Or Update

Servizio:
SQL Database
Versione API:
2025-01-01

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=2025-01-01

Parametri dell'URI

Nome In Necessario Tipo Descrizione
devOpsAuditingSettingsName
 path True

DevOpsAuditingSettingsName

resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
serverName
 path True

string

Il nome del server.
subscriptionId
 path True

string (uuid)

ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
api-version
 query True

string

minLength: 1

Versione dell'API da usare per questa operazione.

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 audit DevOps vengono inviati ad Monitoraggio di Azure. Per inviare gli eventi a Monitoraggio di Azure, specifica 'State' come 'Enabled' e 'IsAzureMonitorTargetEnabled' come veri.

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.

Impostazioni diagnostiche formato URI: 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 (password)

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. Assegna a SQL Server un'identità gestita assegnata dal sistema in Azure Active Directory (AAD).
  2. Concedere l'identità di SQL Server accesso all'account di archiviazione aggiungendo il ruolo RBAC 'Storage Blob Data Contributor' 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

Risorsa 'ServerDevOpsAuditingSettings' operativo di aggiornamento riuscito
202 Accepted

Operazione sulle risorse accettata.

Intestazioni

  • Azure-AsyncOperation: string
  • Location: string
Other Status Codes

ErrorResponse

Risposta di errore imprevista.

Sicurezza

azure_auth

Azure Active Directory OAuth2 Flow.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation rappresentare l'account utente

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=2025-01-01

{
  "properties": {
    "isAzureMonitorTargetEnabled": true,
    "state": "Enabled",
    "storageAccountAccessKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000",
    "storageEndpoint": "https://mystorage.blob.core.windows.net"
  }
}

Risposta di esempio

Codice di stato:
200 
{
  "name": "Default",
  "type": "Microsoft.Sql/servers/devOpsAuditingSettings",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/devAuditTestRG/providers/Microsoft.Sql/servers/devOpsAuditTestSvr/devOpsAuditingSettings/default",
  "properties": {
    "isAzureMonitorTargetEnabled": true,
    "state": "Enabled",
    "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000",
    "storageEndpoint": "https://mystorage.blob.core.windows.net"
  }
}
Codice di stato:
202

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=2025-01-01

{
  "properties": {
    "state": "Enabled",
    "storageAccountAccessKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "storageEndpoint": "https://mystorage.blob.core.windows.net"
  }
}

Risposta di esempio

Codice di stato:
200 
{
  "name": "Default",
  "type": "Microsoft.Sql/servers/devOpsAuditingSettings",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/devAuditTestRG/providers/Microsoft.Sql/servers/devOpsAuditTestSvr/devOpsAuditingSettings/default",
  "properties": {
    "state": "Enabled",
    "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000",
    "storageEndpoint": "https://mystorage.blob.core.windows.net"
  }
}
Codice di stato:
202

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

Enumerazione

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

Valore Descrizione
Enabled

Enabled
Disabled

Disattivato

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore Descrizione
User
Application
ManagedIdentity
Key

DevOpsAuditingSettingsName

Enumerazione
Valore Descrizione
Default

Valore predefinito

ErrorAdditionalInfo

Oggetto

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome Tipo Descrizione
info

object

Informazioni aggiuntive.
type

string

Tipo di informazioni aggiuntive.

ErrorDetail

Oggetto

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

Oggetto

Risposta di errore

Nome Tipo Descrizione
error

ErrorDetail

Oggetto error.

ServerDevOpsAuditingSettings

Oggetto

Impostazioni di controllo DevOps del server.

Nome Tipo Descrizione
id

string (arm-id)

ID risorsa completo per la risorsa. Ad esempio, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name

string

Nome della risorsa
properties.isAzureMonitorTargetEnabled

boolean

Specifica se gli eventi di audit DevOps vengono inviati ad Monitoraggio di Azure. Per inviare gli eventi a Monitoraggio di Azure, specifica 'State' come 'Enabled' e 'IsAzureMonitorTargetEnabled' come veri.

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.

Impostazioni diagnostiche formato URI: 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 (password)

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. Assegna a SQL Server un'identità gestita assegnata dal sistema in Azure Active Directory (AAD).
  2. Concedere l'identità di SQL Server accesso all'account di archiviazione aggiungendo il ruolo RBAC 'Storage Blob Data Contributor' 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

Azure Resource Manager metadati contenenti informazioni createBy e modifiedBy.
type

string

Tipo di risorsa. Ad esempio: "Microsoft. Compute/virtualMachines" oppure "Microsoft. Storage/storageAccounts"

systemData

Oggetto

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)

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