Server DevOps Audit Settings - Create Or Update

Referencia

Service:: SQL Database

API Version:: 2021-11-01

Crea o actualiza la configuración de auditoría de DevOps de un servidor.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
devOpsAuditingSettingsName	path	True	string	Nombre de la configuración de auditoría de devops. Esto siempre debe ser "predeterminado".
resourceGroupName	path	True	string	Nombre del grupo de recursos que contiene el recurso. Puede obtener este valor en la API del Administrador de recursos o el portal de Azure.
serverName	path	True	string	El nombre del servidor.
subscriptionId	path	True	string	El id. de suscripción que identifica una suscripción de Azure.
api-version	query	True	string	La versión de API que se usará para la solicitud.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
properties.state	True	BlobAuditingPolicyState	Especifica el estado de la auditoría. Si el estado es Enabled, storageEndpoint o isAzureMonitorTargetEnabled son necesarios.
properties.isAzureMonitorTargetEnabled		boolean	Especifica si los eventos de auditoría de DevOps se envían a Azure Monitor. Para enviar los eventos a Azure Monitor, especifique "State" como "Enabled" y "IsAzureMonitorTargetEnabled" como true. Al usar la API REST para configurar la auditoría de DevOps, también se debe crear la categoría de registros de diagnóstico "DevOpsOperationsAudit" en la base de datos maestra. Formato de URI de configuración 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 obtener más información, consulte Configuración de diagnóstico API REST o Configuración de diagnóstico de PowerShell.
properties.storageAccountAccessKey		string	Especifica la clave de identificador de la cuenta de almacenamiento de auditoría. Si se especifica state is Enabled y storageEndpoint, no especifica storageAccountAccessKey usará la identidad administrada asignada por el sistema de SQL Server para acceder al almacenamiento. Requisitos previos para usar la autenticación de identidad administrada: Asigne SQL Server una identidad administrada asignada por el sistema en Azure Active Directory (AAD). Conceda a SQL Server acceso de identidad a la cuenta de almacenamiento agregando el rol RBAC "Colaborador de datos de Storage Blob" a la identidad del servidor. Para más información, consulte Auditoría en el almacenamiento mediante la autenticación de identidad administrada.
properties.storageAccountSubscriptionId		string	Especifica el identificador de suscripción de Blob Storage.
properties.storageEndpoint		string	Especifica el punto de conexión de Blob Storage (por ejemplo, https://MyAccount.blob.core.windows.net). Si el estado es Enabled, storageEndpoint o isAzureMonitorTargetEnabled es obligatorio.

Respuestas

Nombre	Tipo	Description
200 OK	ServerDevOpsAuditingSettings	Se actualizó correctamente la configuración de auditoría de DevOps.
202 Accepted		La actualización de la configuración de DevOps de auditoría está en curso.
Other Status Codes		Respuestas de error: *** 400 InvalidServerDevOpsAuditSettingsCreateRequest: la solicitud de directiva de auditoría de DevOps del servidor de creación no existe o no tiene ningún objeto de propiedades. 400 DataSecurityInvalidUserSuppliedParameter: el cliente proporcionó un valor de parámetro no válido. 400 InvalidServerDevOpsAuditSettingsName: nombre de directiva de DevOps del servidor no válido. 400 DevOpsAuditInvalidStorageAccountCredentials: la cuenta de almacenamiento o la clave de acceso proporcionadas no son válidas. 404 SubscriptionDoesNotHaveServer: no se encontró el servidor solicitado 404 ServerNotInSubscriptionResourceGroup: el servidor especificado no existe en el grupo de recursos y la suscripción especificados. 409 ServerDevOpsAuditSettingsInProgress: la auditoría de DevOps del servidor ya está en curso.

Nombre

Tipo

Description

200 OK

ServerDevOpsAuditingSettings

Se actualizó correctamente la configuración de auditoría de DevOps.

202 Accepted

La actualización de la configuración de DevOps de auditoría está en curso.

Other Status Codes

Respuestas de error: ***

400 InvalidServerDevOpsAuditSettingsCreateRequest: la solicitud de directiva de auditoría de DevOps del servidor de creación no existe o no tiene ningún objeto de propiedades.
400 DataSecurityInvalidUserSuppliedParameter: el cliente proporcionó un valor de parámetro no válido.
400 InvalidServerDevOpsAuditSettingsName: nombre de directiva de DevOps del servidor no válido.
400 DevOpsAuditInvalidStorageAccountCredentials: la cuenta de almacenamiento o la clave de acceso proporcionadas no son válidas.
404 SubscriptionDoesNotHaveServer: no se encontró el servidor solicitado
404 ServerNotInSubscriptionResourceGroup: el servidor especificado no existe en el grupo de recursos y la suscripción especificados.
409 ServerDevOpsAuditSettingsInProgress: la auditoría de DevOps del servidor ya está en curso.

Ejemplos

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

Definiciones

Nombre	Description
BlobAuditingPolicyState	Especifica el estado de la auditoría. Si el estado es Enabled, storageEndpoint o isAzureMonitorTargetEnabled son necesarios.
createdByType	Tipo de identidad que creó el recurso.
ServerDevOpsAuditingSettings	Una configuración de auditoría de DevOps de servidor.
systemData	Metadatos relacionados con la creación y la última modificación del recurso.

BlobAuditingPolicyState

Especifica el estado de la auditoría. Si el estado es Enabled, storageEndpoint o isAzureMonitorTargetEnabled son necesarios.

Nombre	Tipo	Description
Disabled	string
Enabled	string

createdByType

Tipo de identidad que creó el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ServerDevOpsAuditingSettings

Una configuración de auditoría de DevOps de servidor.

Nombre	Tipo	Description
id	string	Identificador del recurso.
name	string	Nombre del recurso.
properties.isAzureMonitorTargetEnabled	boolean	Especifica si los eventos de auditoría de DevOps se envían a Azure Monitor. Para enviar los eventos a Azure Monitor, especifique "State" como "Enabled" y "IsAzureMonitorTargetEnabled" como true. Al usar la API REST para configurar la auditoría de DevOps, también se debe crear la categoría de registros de diagnóstico "DevOpsOperationsAudit" en la base de datos maestra. Formato de URI de configuración 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 obtener más información, consulte Configuración de diagnóstico API REST o Configuración de diagnóstico de PowerShell.
properties.state	BlobAuditingPolicyState	Especifica el estado de la auditoría. Si el estado es Enabled, storageEndpoint o isAzureMonitorTargetEnabled son necesarios.
properties.storageAccountAccessKey	string	Especifica la clave de identificador de la cuenta de almacenamiento de auditoría. Si se especifica state is Enabled y storageEndpoint, no especifica storageAccountAccessKey usará la identidad administrada asignada por el sistema de SQL Server para acceder al almacenamiento. Requisitos previos para usar la autenticación de identidad administrada: Asigne SQL Server una identidad administrada asignada por el sistema en Azure Active Directory (AAD). Conceda a SQL Server acceso de identidad a la cuenta de almacenamiento agregando el rol RBAC "Colaborador de datos de Storage Blob" a la identidad del servidor. Para más información, consulte Auditoría en el almacenamiento mediante la autenticación de identidad administrada.
properties.storageAccountSubscriptionId	string	Especifica el identificador de suscripción de Blob Storage.
properties.storageEndpoint	string	Especifica el punto de conexión de Blob Storage (por ejemplo, https://MyAccount.blob.core.windows.net). Si el estado es Enabled, storageEndpoint o isAzureMonitorTargetEnabled es obligatorio.
systemData	systemData	SystemData de ServerDevOpsAuditSettingsResource.
type	string	Tipo de recurso.

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre	Tipo	Description
createdAt	string	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

Server DevOps Audit Settings - Create Or Update

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Ejemplos

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

Definiciones

BlobAuditingPolicyState

createdByType

ServerDevOpsAuditingSettings

systemData

Recursos adicionales