Server DevOps Audit Settings - Create Or Update

Referência

Service:: SQL Database

API Version:: 2021-11-01

Cria ou atualiza as definições de auditoria de DevOps de um servidor.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
devOpsAuditingSettingsName	path	True	string	O nome das definições de auditoria devops. Deve ser sempre "predefinição".
resourceGroupName	path	True	string	O nome do grupo de recursos que contém o recurso. Pode obter este valor a partir da API do Azure Resource Manager ou do portal.
serverName	path	True	string	O nome do servidor.
subscriptionId	path	True	string	O ID da subscrição que identifica uma subscrição do Azure.
api-version	query	True	string	A versão da API a utilizar para o pedido.

Corpo do Pedido

Name	Necessário	Tipo	Description
properties.state	True	BlobAuditingPolicyState	Especifica o estado da auditoria. Se o estado estiver Ativado, storageEndpoint ou forAzureMonitorTargetEnabled são necessários.
properties.isAzureMonitorTargetEnabled		boolean	Especifica se os eventos de auditoria do DevOps são enviados para o Azure Monitor. Para enviar os eventos para o Azure Monitor, especifique "Estado" como "Ativado" e "IsAzureMonitorTargetEnabled" como verdadeiros. Ao utilizar a API REST para configurar a auditoria do DevOps, as Definições de Diagnóstico com a categoria de registos de diagnóstico "DevOpsOperationsAudit" na base de dados mestra também devem ser criadas. Formato URI das Definições de Diagnóstico: 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 Para obter mais informações, veja API REST de Definições de Diagnóstico ou Definições de Diagnóstico do PowerShell
properties.storageAccountAccessKey		string	Especifica a chave de identificador da conta de armazenamento de auditoria. Se o estado estiver Ativado e storageEndpoint for especificado, não especificar o storageAccountAccessKey utilizará a identidade gerida atribuída pelo sistema do SQL Server para aceder ao armazenamento. Pré-requisitos para utilizar a autenticação de identidade gerida: Atribua SQL Server uma identidade gerida atribuída pelo sistema no Azure Active Directory (AAD). Conceda SQL Server acesso de identidade à conta de armazenamento ao adicionar a função RBAC "Contribuidor de Dados de Blobs de Armazenamento" à identidade do servidor. Para obter mais informações, veja Auditing to storage using Managed Identity authentication (Auditoria ao armazenamento com autenticação de Identidade Gerida)
properties.storageAccountSubscriptionId		string	Especifica o ID da subscrição do armazenamento de blobs.
properties.storageEndpoint		string	Especifica o ponto final de armazenamento de blobs (por exemplo, https://MyAccount.blob.core.windows.net). Se o estado estiver Ativado, storageEndpoint ou forAzureMonitorTargetEnabled é necessário.

Respostas

Name	Tipo	Description
200 OK	ServerDevOpsAuditingSettings	As definições de auditoria do DevOps foram atualizadas com êxito.
202 Accepted		A atualização das definições do DevOps de auditoria está em curso.
Other Status Codes		Respostas de Erro: *** 400 InvalidServerDevOpsAuditSettingsCreateRequest – o pedido de política de auditoria de DevOps do servidor de criação não existe ou não tem nenhum objeto de propriedades. 400 DataSecurityInvalidUserSuppliedParameter – foi fornecido um valor de parâmetro inválido pelo cliente. 400 InvalidServerDevOpsAuditSettingsName – nome de política de Servidor InvOps inválido. 400 DevOpsAuditInvalidStorageAccountCredentials - A conta de armazenamento ou chave de acesso fornecida não é válida. 404 SubscriptionDoesNotHaveServer – O servidor pedido não foi encontrado 404 ServerNotInSubscriptionResourceGroup - O servidor especificado não existe no grupo de recursos e subscrição especificados. 409 ServerDevOpsAuditSettingsInProgress - Set server DevOps audit já está em curso.

Name

Tipo

Description

200 OK

ServerDevOpsAuditingSettings

As definições de auditoria do DevOps foram atualizadas com êxito.

202 Accepted

A atualização das definições do DevOps de auditoria está em curso.

Other Status Codes

Respostas de Erro: ***

400 InvalidServerDevOpsAuditSettingsCreateRequest – o pedido de política de auditoria de DevOps do servidor de criação não existe ou não tem nenhum objeto de propriedades.
400 DataSecurityInvalidUserSuppliedParameter – foi fornecido um valor de parâmetro inválido pelo cliente.
400 InvalidServerDevOpsAuditSettingsName – nome de política de Servidor InvOps inválido.
400 DevOpsAuditInvalidStorageAccountCredentials - A conta de armazenamento ou chave de acesso fornecida não é válida.
404 SubscriptionDoesNotHaveServer – O servidor pedido não foi encontrado
404 ServerNotInSubscriptionResourceGroup - O servidor especificado não existe no grupo de recursos e subscrição especificados.
409 ServerDevOpsAuditSettingsInProgress - Set server DevOps audit já está em curso.

Exemplos

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

Definições

Name	Description
BlobAuditingPolicyState	Especifica o estado da auditoria. Se o estado estiver Ativado, storageEndpoint ou forAzureMonitorTargetEnabled são necessários.
createdByType	O tipo de identidade que criou o recurso.
ServerDevOpsAuditingSettings	Definições de auditoria do DevOps do servidor.
systemData	Metadados relativos à criação e última modificação do recurso.

BlobAuditingPolicyState

Especifica o estado da auditoria. Se o estado estiver Ativado, storageEndpoint ou forAzureMonitorTargetEnabled são necessários.

Name	Tipo	Description
Disabled	string
Enabled	string

createdByType

O tipo de identidade que criou o recurso.

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ServerDevOpsAuditingSettings

Definições de auditoria do DevOps do servidor.

Name	Tipo	Description
id	string	ID do Recurso.
name	string	Nome do recurso.
properties.isAzureMonitorTargetEnabled	boolean	Especifica se os eventos de auditoria do DevOps são enviados para o Azure Monitor. Para enviar os eventos para o Azure Monitor, especifique "Estado" como "Ativado" e "IsAzureMonitorTargetEnabled" como verdadeiros. Ao utilizar a API REST para configurar a auditoria do DevOps, as Definições de Diagnóstico com a categoria de registos de diagnóstico "DevOpsOperationsAudit" na base de dados mestra também devem ser criadas. Formato URI das Definições de Diagnóstico: 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 Para obter mais informações, veja API REST de Definições de Diagnóstico ou Definições de Diagnóstico do PowerShell
properties.state	BlobAuditingPolicyState	Especifica o estado da auditoria. Se o estado estiver Ativado, storageEndpoint ou forAzureMonitorTargetEnabled são necessários.
properties.storageAccountAccessKey	string	Especifica a chave de identificador da conta de armazenamento de auditoria. Se o estado estiver Ativado e storageEndpoint for especificado, não especificar o storageAccountAccessKey utilizará a identidade gerida atribuída pelo sistema do SQL Server para aceder ao armazenamento. Pré-requisitos para utilizar a autenticação de identidade gerida: Atribua SQL Server uma identidade gerida atribuída pelo sistema no Azure Active Directory (AAD). Conceda SQL Server acesso de identidade à conta de armazenamento ao adicionar a função RBAC "Contribuidor de Dados de Blobs de Armazenamento" à identidade do servidor. Para obter mais informações, veja Auditing to storage using Managed Identity authentication (Auditoria ao armazenamento com autenticação de Identidade Gerida)
properties.storageAccountSubscriptionId	string	Especifica o ID da subscrição do armazenamento de blobs.
properties.storageEndpoint	string	Especifica o ponto final de armazenamento de blobs (por exemplo, https://MyAccount.blob.core.windows.net). Se o estado estiver Ativado, storageEndpoint ou forAzureMonitorTargetEnabled é necessário.
systemData	systemData	SystemData de ServerDevOpsAuditSettingsResource.
type	string	Tipo de recurso.

systemData

Metadados relativos à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Server DevOps Audit Settings - Create Or Update

Parâmetros do URI

Corpo do Pedido

Respostas

Exemplos

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

Definições

BlobAuditingPolicyState

createdByType

ServerDevOpsAuditingSettings

systemData

Recursos adicionais