Compartir a través de

Server DevOps Audit Settings - Create Or Update

Servicio:
SQL Database
Versión de la API:
2025-01-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=2025-01-01

Parámetros de identificador URI

Nombre En Requerido Tipo Description
devOpsAuditingSettingsName
 path True

DevOpsAuditingSettingsName

resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
serverName
 path True

string

El nombre del servidor.
subscriptionId
 path True

string (uuid)

Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version
 query True

string

minLength: 1

La versión de API que se va a utilizar para esta operación.

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, especifica 'State' como 'Enabled' y 'IsAzureMonitorTargetEnabled' como verdadero.

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.

Configuración de diagnóstico 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

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 (password)

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:

  1. Asigna a SQL Server una identidad gestionada asignada por el sistema en Azure Active Directory (AAD).
  2. Concede acceso a la identidad de SQL Server a la cuenta de almacenamiento añadiendo el rol RBAC 'Storage Blob Data Contributor' 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

La operación de actualización del recurso 'ServerDevOpsAuditingSettings' ha tenido éxito
202 Accepted

Operación de recursos aceptada.

Encabezados

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

ErrorResponse

Una respuesta de error inesperada.

Seguridad

azure_auth

Azure Active Directory OAuth2 Flow.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre Description
user_impersonation suplantar la cuenta de usuario

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

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

Respuesta de muestra

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

Update a server's DevOps audit settings with minimal input

Solicitud de ejemplo

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

Respuesta de muestra

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

Habilitado
Disabled

Deshabilitado

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor Description
User
Application
ManagedIdentity
Key

DevOpsAuditingSettingsName

Enumeración
Valor Description
Default

Predeterminado

ErrorAdditionalInfo

Objeto

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

Objeto

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

El mensaje de error.
target

string

Destino del error.

ErrorResponse

Objeto

Respuesta de error

Nombre Tipo Description
error

ErrorDetail

Objeto de error.

ServerDevOpsAuditingSettings

Objeto

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

Nombre Tipo Description
id

string (arm-id)

Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
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, especifica 'State' como 'Enabled' y 'IsAzureMonitorTargetEnabled' como verdadero.

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.

Configuración de diagnóstico 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

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 (password)

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:

  1. Asigna a SQL Server una identidad gestionada asignada por el sistema en Azure Active Directory (AAD).
  2. Concede acceso a la identidad de SQL Server a la cuenta de almacenamiento añadiendo el rol RBAC 'Storage Blob Data Contributor' 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

Azure Resource Manager metadatos que contienen información createdBy y modifiedBy.
type

string

Tipo de recurso. Por ejemplo, "Microsoft. Compute/virtualMachines" o "Microsoft. CuentasAlmacenamiento/Almacenamiento"

systemData

Objeto

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)

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