Server DevOps Audit Settings - Create Or Update

Referencia

Servicio:: SQL Database

Versión de la API:: 2023-08-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/Default?api-version=2023-08-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
devOpsAuditingSettingsName	path	True	DevOpsAuditingSettingsName
resourceGroupName	path	True	string	Nombre del grupo de recursos que contiene el recurso. Puede obtener este valor desde la API de Azure Resource Manager o el portal.
serverName	path	True	string	Nombre del servidor.
subscriptionId	path	True	string	Identificador de suscripción que identifica una suscripción de Azure.
api-version	query	True	string	Versión de la API que se va a 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 Habilitado, se requieren storageEndpoint o isAzureMonitorTargetEnabled.
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 DE API REST o Configuración de diagnóstico de PowerShell
properties.isManagedIdentityInUse		boolean	Especifica si la identidad administrada se usa para acceder al almacenamiento de blobs.
properties.storageAccountAccessKey		string	Especifica la clave de identificador de la cuenta de almacenamiento de auditoría. Si se especifica state is Enabled and storageEndpoint, not specifying the storageAccountAccessKey will use SQL Server system-assigned managed identity to access the storage. Requisitos previos para usar la autenticación de identidad administrada: Asigne a SQL Server una identidad administrada asignada por el sistema en Azure Active Directory (AAD). Conceda a la identidad de SQL Server acceso a la cuenta de almacenamiento agregando el rol RBAC "Colaborador de datos de blobs de almacenamiento" a la identidad del servidor. Para obtener más información, consulte Auditoría en el almacenamiento mediante la autenticación de identidad administrada
properties.storageAccountSubscriptionId		string (uuid)	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 ha actualizado 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. Encabezados Location: string
Other Status Codes	ErrorResponse	Respuestas de error: *** 400 ManagedInstanceStoppingOrStopped: operación en conflicto enviada mientras la instancia está en estado de detención o detención 400 ManagedInstanceStarting: operación en conflicto enviada mientras la instancia está en estado de inicio 400 InvalidServerDevOpsAuditSettingsCreateRequest: la solicitud de directiva de auditoría create server DevOps 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 de servidor no válido. 400 DevOpsAuditInvalidStorageAccountCredentials: la cuenta de almacenamiento o la clave de acceso proporcionadas no son válidas. 404 ServerNotInSubscriptionResourceGroup: el servidor especificado no existe en el grupo de recursos y la suscripción especificados. 404 SubscriptionDoesNotHaveServer: no se encontró el servidor solicitado. 404 OperationIdNotFound: la operación con id. no existe. 409 ServerDevOpsAuditSettingsInProgress: la auditoría de DevOps del servidor ya está en curso. 409 CannotCancelOperation: la operación de administración está en un estado que no se puede cancelar. 409 OperationCancelled: el usuario canceló la operación. 409 OperationInterrupted: no se pudo completar la operación en el recurso porque se interrumpió otra operación en el mismo recurso. 429 SubscriptionTooManyCreateUpdateRequests: solicitudes más allá de las solicitudes máximas que pueden procesar los recursos disponibles. 429 SubscriptionTooManyRequests: solicitudes más allá de las solicitudes máximas que los recursos disponibles pueden procesar. 500 OperationTimedOut: la operación agota el tiempo de espera y se revierte automáticamente. Vuelva a intentar la operación. 503 TooManyRequests: solicitudes más allá de las solicitudes máximas que pueden procesar los recursos disponibles.

Nombre

Tipo

Description

200 OK

ServerDevOpsAuditingSettings

Se ha actualizado 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.

Encabezados

Location: string

Other Status Codes

ErrorResponse

Respuestas de error: ***

400 ManagedInstanceStoppingOrStopped: operación en conflicto enviada mientras la instancia está en estado de detención o detención
400 ManagedInstanceStarting: operación en conflicto enviada mientras la instancia está en estado de inicio
400 InvalidServerDevOpsAuditSettingsCreateRequest: la solicitud de directiva de auditoría create server DevOps 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 de servidor no válido.
400 DevOpsAuditInvalidStorageAccountCredentials: la cuenta de almacenamiento o la clave de acceso proporcionadas no son válidas.
404 ServerNotInSubscriptionResourceGroup: el servidor especificado no existe en el grupo de recursos y la suscripción especificados.
404 SubscriptionDoesNotHaveServer: no se encontró el servidor solicitado.
404 OperationIdNotFound: la operación con id. no existe.
409 ServerDevOpsAuditSettingsInProgress: la auditoría de DevOps del servidor ya está en curso.
409 CannotCancelOperation: la operación de administración está en un estado que no se puede cancelar.
409 OperationCancelled: el usuario canceló la operación.
409 OperationInterrupted: no se pudo completar la operación en el recurso porque se interrumpió otra operación en el mismo recurso.
429 SubscriptionTooManyCreateUpdateRequests: solicitudes más allá de las solicitudes máximas que pueden procesar los recursos disponibles.
429 SubscriptionTooManyRequests: solicitudes más allá de las solicitudes máximas que los recursos disponibles pueden procesar.
500 OperationTimedOut: la operación agota el tiempo de espera y se revierte automáticamente. Vuelva a intentar la operación.
503 TooManyRequests: solicitudes más allá de las solicitudes máximas que pueden procesar los recursos disponibles.

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

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

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

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

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 Habilitado, se requieren storageEndpoint o isAzureMonitorTargetEnabled.
createdByType	Tipo de identidad que creó el recurso.
DevOpsAuditingSettingsName
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
ServerDevOpsAuditingSettings	Configuración de auditoría de DevOps del servidor.
systemData	Metadatos relativos a la creación y última modificación del recurso.

BlobAuditingPolicyState

Enumeración

Especifica el estado de la auditoría. Si el estado es Habilitado, se requieren storageEndpoint o isAzureMonitorTargetEnabled.

Valor	Description
Disabled
Enabled

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
Application
Key
ManagedIdentity
User

DevOpsAuditingSettingsName

Enumeración

Valor	Description
Default

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

ServerDevOpsAuditingSettings

Object

Configuración de auditoría de DevOps del servidor.

Nombre	Tipo	Description
id	string	Identificador de 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 DE API REST o Configuración de diagnóstico de PowerShell
properties.isManagedIdentityInUse	boolean	Especifica si la identidad administrada se usa para acceder al almacenamiento de blobs.
properties.state	BlobAuditingPolicyState	Especifica el estado de la auditoría. Si el estado es Habilitado, se requieren storageEndpoint o isAzureMonitorTargetEnabled.
properties.storageAccountAccessKey	string	Especifica la clave de identificador de la cuenta de almacenamiento de auditoría. Si se especifica state is Enabled and storageEndpoint, not specifying the storageAccountAccessKey will use SQL Server system-assigned managed identity to access the storage. Requisitos previos para usar la autenticación de identidad administrada: Asigne a SQL Server una identidad administrada asignada por el sistema en Azure Active Directory (AAD). Conceda a la identidad de SQL Server acceso a la cuenta de almacenamiento agregando el rol RBAC "Colaborador de datos de blobs de almacenamiento" a la identidad del servidor. Para obtener más información, consulte Auditoría en el almacenamiento mediante la autenticación de identidad administrada
properties.storageAccountSubscriptionId	string (uuid)	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

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	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 (date-time)	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.

Compartir a través de

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

Solicitud de ejemplo

Respuesta de muestra

Update a server's DevOps audit settings with minimal input

Solicitud de ejemplo

Respuesta de muestra

Definiciones

BlobAuditingPolicyState

createdByType

DevOpsAuditingSettingsName

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ServerDevOpsAuditingSettings

systemData

Recursos adicionales