Server DevOps Audit Settings - Create Or Update

Riferimento

Service:: SQL Database

API Version:: 2021-11-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/{devOpsAuditingSettingsName}?api-version=2021-11-01

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
devOpsAuditingSettingsName	path	True	string	Nome delle impostazioni di controllo devops. Questa operazione deve essere sempre "predefinita".
resourceGroupName	path	True	string	Nome del gruppo di risorse contenente la risorsa. È possibile ottenere questo valore dall'API di Gestione risorse di Azure 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, è necessario 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 di 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 impostazioni di diagnostica o Impostazioni di diagnostica PowerShell
properties.storageAccountAccessKey		string	Specifica la chiave identificatore dell'account di archiviazione di controllo. Se lo stato è Abilitato e storageEndpoint viene specificato, non specificando storageAccountAccessKey userà l'identità gestita assegnata dal sistema di SQL Server per accedere all'archiviazione. Prerequisiti per l'uso dell'autenticazione di identità gestita: Assegnare SQL Server un'identità gestita assegnata dal sistema in Azure Active Directory (AAD). Concedere SQL Server l'accesso all'identità all'account di archiviazione aggiungendo il ruolo di controllo degli accessi in base al ruolo "Collaboratore dati BLOB di archiviazione" all'identità del server. Per altre informazioni, vedere Controllo dell'archiviazione tramite l'autenticazione di identità gestita
properties.storageAccountSubscriptionId		string	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	È stato aggiornato correttamente le impostazioni di controllo DevOps.
202 Accepted		L'aggiornamento delle impostazioni devOps di controllo è in corso.
Other Status Codes		Risposte agli errori: ** 400 InvalidServerDevOpsAuditSettingsCreateRequest - La richiesta dei criteri di controllo DevOps del server di creazione non esiste o non ha alcun oggetto proprietà. 400 DataSecurityInvalidUserSuppliedParameter - Un valore di parametro non valido è stato fornito dal client. 400 InvalidServerDevOpsAuditSettingsName - Nome criterio DevOps server non valido. 400 DevOpsAuditInvalidStorageAccountCredentials: l'account di archiviazione o la chiave di accesso forniti non è valida. 404 SubscriptionDoesNotHaveServer - Il server richiesto non è stato trovato 404 ServerNotInSubscriptionResourceGroup - Il server specificato non esiste nel gruppo di risorse e nella sottoscrizione specificati. 409 ServerDevOpsAuditSettingsInProgress - Impostare il controllo DevOps del server è già in corso.

Nome

Tipo

Descrizione

200 OK

ServerDevOpsAuditingSettings

È stato aggiornato correttamente le impostazioni di controllo DevOps.

202 Accepted

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

Other Status Codes

Risposte agli errori: **

400 InvalidServerDevOpsAuditSettingsCreateRequest - La richiesta dei criteri di controllo DevOps del server di creazione non esiste o non ha alcun oggetto proprietà.
400 DataSecurityInvalidUserSuppliedParameter - Un valore di parametro non valido è stato fornito dal client.
400 InvalidServerDevOpsAuditSettingsName - Nome criterio DevOps server non valido.
400 DevOpsAuditInvalidStorageAccountCredentials: l'account di archiviazione o la chiave di accesso forniti non è valida.
404 SubscriptionDoesNotHaveServer - Il server richiesto non è stato trovato
404 ServerNotInSubscriptionResourceGroup - Il server specificato non esiste nel gruppo di risorse e nella sottoscrizione specificati.
409 ServerDevOpsAuditSettingsInProgress - Impostare il controllo DevOps del server è già in corso.

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

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/devAuditTestRG/providers/Microsoft.Sql/servers/devOpsAuditTestSvr/devOpsAuditingSettings/default?api-version=2021-11-01

{
  "properties": {
    "state": "Enabled",
    "storageAccountAccessKey": "sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD==",
    "storageEndpoint": "https://mystorage.blob.core.windows.net",
    "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000",
    "isAzureMonitorTargetEnabled": true
  }
}


import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.ServerDevOpsAuditingSettingsInner;
import com.azure.resourcemanager.sql.models.BlobAuditingPolicyState;
import java.util.UUID;

/** Samples for ServerDevOpsAuditSettings CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ServerDevOpsAuditCreateMax.json
     */
    /**
     * Sample code: Update a server's DevOps audit settings with all params.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        updateAServerSDevOpsAuditSettingsWithAllParams(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServerDevOpsAuditSettings().createOrUpdate("devAuditTestRG",
            "devOpsAuditTestSvr", "default",
            new ServerDevOpsAuditingSettingsInner().withIsAzureMonitorTargetEnabled(true)
                .withState(BlobAuditingPolicyState.ENABLED)
                .withStorageEndpoint("https://mystorage.blob.core.windows.net")
                .withStorageAccountAccessKey("fakeTokenPlaceholder").withStorageAccountSubscriptionId(
                    UUID.fromString("00000000-1234-0000-5678-000000000000")),
            Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 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
  }
}

Status code:: 202

Update a server's DevOps audit settings with minimal input

Sample Request

HTTP
Java

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/devAuditTestRG/providers/Microsoft.Sql/servers/devOpsAuditTestSvr/devOpsAuditingSettings/default?api-version=2021-11-01

{
  "properties": {
    "state": "Enabled",
    "storageAccountAccessKey": "sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD==",
    "storageEndpoint": "https://mystorage.blob.core.windows.net"
  }
}


import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.ServerDevOpsAuditingSettingsInner;
import com.azure.resourcemanager.sql.models.BlobAuditingPolicyState;

/** Samples for ServerDevOpsAuditSettings CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ServerDevOpsAuditCreateMin.json
     */
    /**
     * Sample code: Update a server's DevOps audit settings with minimal input.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        updateAServerSDevOpsAuditSettingsWithMinimalInput(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServerDevOpsAuditSettings().createOrUpdate("devAuditTestRG",
            "devOpsAuditTestSvr", "default",
            new ServerDevOpsAuditingSettingsInner().withState(BlobAuditingPolicyState.ENABLED)
                .withStorageEndpoint("https://mystorage.blob.core.windows.net")
                .withStorageAccountAccessKey("fakeTokenPlaceholder"),
            Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 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"
  }
}

Status code:: 202

Definizioni

Nome	Descrizione
BlobAuditingPolicyState	Specifica lo stato del controllo. Se lo stato è Abilitato, è necessario storageEndpoint o isAzureMonitorTargetEnabled.
createdByType	Tipo di identità che ha creato la risorsa.
ServerDevOpsAuditingSettings	Impostazioni di controllo DevOps server.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.

BlobAuditingPolicyState

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

Nome	Tipo	Descrizione
Disabled	string
Enabled	string

createdByType

Tipo di identità che ha creato la risorsa.

Nome	Tipo	Descrizione
Application	string
Key	string
ManagedIdentity	string
User	string

ServerDevOpsAuditingSettings

Impostazioni di controllo DevOps 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 di 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 impostazioni di diagnostica o Impostazioni di diagnostica PowerShell
properties.state	BlobAuditingPolicyState	Specifica lo stato del controllo. Se lo stato è Abilitato, è necessario storageEndpoint o isAzureMonitorTargetEnabled.
properties.storageAccountAccessKey	string	Specifica la chiave identificatore dell'account di archiviazione di controllo. Se lo stato è Abilitato e storageEndpoint viene specificato, non specificando storageAccountAccessKey userà l'identità gestita assegnata dal sistema di SQL Server per accedere all'archiviazione. Prerequisiti per l'uso dell'autenticazione di identità gestita: Assegnare SQL Server un'identità gestita assegnata dal sistema in Azure Active Directory (AAD). Concedere SQL Server l'accesso all'identità all'account di archiviazione aggiungendo il ruolo di controllo degli accessi in base al ruolo "Collaboratore dati BLOB di archiviazione" all'identità del server. Per altre informazioni, vedere Controllo dell'archiviazione tramite l'autenticazione di identità gestita
properties.storageAccountSubscriptionId	string	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	Timestamp della creazione di risorse (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima risorsa.

Server DevOps Audit Settings - Create Or Update

Parametri dell'URI

Corpo della richiesta

Risposte

Esempio

Update a server's DevOps audit settings with all params

Sample Request

Sample Response

Update a server's DevOps audit settings with minimal input

Sample Request

Sample Response

Definizioni

BlobAuditingPolicyState

createdByType

ServerDevOpsAuditingSettings

systemData

Risorse aggiuntive