Áreas de trabajo de Microsoft.Synapse/sqlPools/auditingSettings

Definición de recursos de Bicep

El tipo de recurso workspaces/sqlPools/auditingSettings se puede implementar con operaciones destinadas a:

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.Synapse/workspaces/sqlPools/auditingSettings, agregue el siguiente bicep a la plantilla.

resource symbolicname 'Microsoft.Synapse/workspaces/sqlPools/auditingSettings@2021-06-01' = {
  parent: resourceSymbolicName
  name: 'default'
  properties: {
    auditActionsAndGroups: [
      'string'
    ]
    isAzureMonitorTargetEnabled: bool
    isStorageSecondaryKeyInUse: bool
    retentionDays: int
    state: 'string'
    storageAccountAccessKey: 'string'
    storageAccountSubscriptionId: 'string'
    storageEndpoint: 'string'
  }
}

Valores de propiedad

Microsoft.Synapse/workspaces/sqlPools/auditingSettings

Nombre Descripción Valor
nombre El nombre del recurso 'default' (obligatorio)
padre En Bicep, puede especificar el recurso primario para un recurso secundario. Solo tiene que agregar esta propiedad cuando el recurso secundario se declara fuera del recurso primario.

Para obtener más información, consulte recurso secundario fuera del recurso primario.
Nombre simbólico del recurso de tipo: workspaces/sqlPools
Propiedades Propiedades de recursos. SqlPoolBlobAuditingPolicyProperties

SqlPoolBlobAuditingPolicyProperties

Nombre Descripción Valor
auditActionsAndGroups Especifica el Actions-Groups y las acciones que se van a auditar.

El conjunto recomendado de grupos de acciones que se van a usar es la siguiente combinación: esto auditará todas las consultas y procedimientos almacenados ejecutados en la base de datos, así como inicios de sesión correctos y con errores:

BATCH_COMPLETED_GROUP,
SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP,
FAILED_DATABASE_AUTHENTICATION_GROUP.

Esta combinación anterior también es el conjunto que se configura de forma predeterminada al habilitar la auditoría desde Azure Portal.

Los grupos de acciones admitidos que se van a auditar son (nota: elija solo grupos específicos que cubran las necesidades de auditoría. El uso de grupos innecesarios podría dar lugar a grandes cantidades de registros de auditoría):

ROL_DE_APLICACIÓN_CAMBIAR_CONTRASEÑA_GRUPO
GRUPO_DE_RESPALDO_RESTAURACIÓN
GRUPO_DE_CIERRE_DE_SESIÓN_DE_BASE_DE_DATOS
GRUPO_DE_CAMBIO_DE_OBJETO_BASE_DE_DATOS
BASE_DE_DATOS_OBJETO_CAMBIO_DE_PROPIEDAD_GRUPO
GRUPO_DE_CAMBIO_DE_PERMISO_DEL_OBJETO_DE_BASE_DE_DATOS
GRUPO_DE_OPERACIONES_DE_BASE_DE_DATOS
CAMBIO_DE_PERMISOS_DE_BASE_DE_DATOS
GRUPO_CAMBIO_PRINCIPAL_BASE_DE_DATOS
GRUPO DE SUPLANTACIÓN DE PRINCIPAL DE BASE DE DATOS
GRUPO_CAMBIO_MIEMBRO_ROL_BASE_DE_DATOS
GRUPO_DE_AUTENTICACIÓN_DE_BASE_DE_DATOS_FALLIDA
Grupo de Acceso a Objetos de Esquema
SCHEMA_OBJECT_CHANGE_GROUP
Cambio de Propiedad de Objeto de Esquema (Grupo SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP)
Grupo_de_Cambio_de_Permiso_de_Objeto_de_Esquema
GRUPO_DE_AUTENTICACIÓN_EXITOSA_DE_BASES_DE_DATOS
USUARIO_CAMBIAR_CONTRASEÑA_GRUPO
BATCH_STARTED_GROUP
BATCH_COMPLETED_GROUP

Estos son grupos que cubren todas las instrucciones SQL y los procedimientos almacenados ejecutados en la base de datos y no deben usarse en combinación con otros grupos, ya que esto dará lugar a registros de auditoría duplicados.

Para obtener más información, consulte Database-Level Auditar grupos de acciones.

Para la directiva de auditoría de base de datos, también se pueden especificar acciones específicas (tenga en cuenta que las acciones no se pueden especificar para la directiva de auditoría del servidor). Las acciones admitidas para auditar son:
ESCOGER
ACTUALIZAR
INSERTAR
BORRAR
EJECUTAR
RECIBIR
REFERENCIAS

El formulario general para definir una acción que se va a auditar es:
{acción} ON {object} BY {principal}

Tenga en cuenta que <objeto> en el formato anterior puede hacer referencia a un objeto como una tabla, una vista o un procedimiento almacenado, o a una base de datos o esquema completo. En los últimos casos, se usan los formularios DATABASE::{db_name} y SCHEMA::{schema_name}, respectivamente.

Por ejemplo:
SELECT en dbo.myTable por public
SELECT en DATABASE::myDatabase por public
SELECT en SCHEMA::mySchema por public

Para obtener más información, consulte Database-Level Acciones de auditoría.
string[]
isAzureMonitorTargetEnabled Especifica si los eventos de auditoría 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, también se debe crear la categoría de registros de diagnóstico "SQLSecurityAuditEvents" en la base de datos.
Tenga en cuenta que para la auditoría de nivel de servidor debe usar la base de datos "master" como {databaseName}.

Formato de URI de configuración de diagnóstico:
PONER https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/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
Bool
isStorageSecondaryKeyInUse Especifica si el valor storageAccountAccessKey es la clave secundaria del almacenamiento. Bool
retentionDays Especifica el número de días que se mantendrán en los registros de auditoría de la cuenta de almacenamiento. Int
estado Especifica el estado de la directiva. Si el estado es Habilitado, se requieren storageEndpoint o isAzureMonitorTargetEnabled. 'Deshabilitado'
'Habilitado' (obligatorio)
storageAccountAccessKey Especifica la clave de identificador de la cuenta de almacenamiento de auditoría. Si se especifica el estado Enabled y storageEndpoint, se requiere storageAccountAccessKey. cuerda
storageAccountSubscriptionId Especifica el identificador de suscripción de Blob Storage. cuerda

Restricciones:
Longitud mínima = 36
Longitud máxima = 36
Patrón = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
storageEndpoint Especifica el punto de conexión de Blob Storage (por ejemplo, https://MyAccount.blob.core.windows.net). Si el estado es Habilitado, se requiere storageEndpoint. cuerda

Definición de recursos de plantilla de ARM

El tipo de recurso workspaces/sqlPools/auditingSettings se puede implementar con operaciones destinadas a:

Ejemplos de uso

Formato de recurso

Para crear un recurso Microsoft.Synapse/workspaces/sqlPools/auditingSettings, agregue el siguiente JSON a la plantilla.

{
  "type": "Microsoft.Synapse/workspaces/sqlPools/auditingSettings",
  "apiVersion": "2021-06-01",
  "name": "string",
  "properties": {
    "auditActionsAndGroups": [ "string" ],
    "isAzureMonitorTargetEnabled": "bool",
    "isStorageSecondaryKeyInUse": "bool",
    "retentionDays": "int",
    "state": "string",
    "storageAccountAccessKey": "string",
    "storageAccountSubscriptionId": "string",
    "storageEndpoint": "string"
  }
}

Valores de propiedad

Microsoft.Synapse/workspaces/sqlPools/auditingSettings

Nombre Descripción Valor
apiVersion La versión de api '2021-06-01'
nombre El nombre del recurso 'default' (obligatorio)
Propiedades Propiedades de recursos. SqlPoolBlobAuditingPolicyProperties
tipo El tipo de recurso "Microsoft.Synapse/workspaces/sqlPools/auditingSettings"

SqlPoolBlobAuditingPolicyProperties

Nombre Descripción Valor
auditActionsAndGroups Especifica el Actions-Groups y las acciones que se van a auditar.

El conjunto recomendado de grupos de acciones que se van a usar es la siguiente combinación: esto auditará todas las consultas y procedimientos almacenados ejecutados en la base de datos, así como inicios de sesión correctos y con errores:

BATCH_COMPLETED_GROUP,
SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP,
FAILED_DATABASE_AUTHENTICATION_GROUP.

Esta combinación anterior también es el conjunto que se configura de forma predeterminada al habilitar la auditoría desde Azure Portal.

Los grupos de acciones admitidos que se van a auditar son (nota: elija solo grupos específicos que cubran las necesidades de auditoría. El uso de grupos innecesarios podría dar lugar a grandes cantidades de registros de auditoría):

ROL_DE_APLICACIÓN_CAMBIAR_CONTRASEÑA_GRUPO
GRUPO_DE_RESPALDO_RESTAURACIÓN
GRUPO_DE_CIERRE_DE_SESIÓN_DE_BASE_DE_DATOS
GRUPO_DE_CAMBIO_DE_OBJETO_BASE_DE_DATOS
BASE_DE_DATOS_OBJETO_CAMBIO_DE_PROPIEDAD_GRUPO
GRUPO_DE_CAMBIO_DE_PERMISO_DEL_OBJETO_DE_BASE_DE_DATOS
GRUPO_DE_OPERACIONES_DE_BASE_DE_DATOS
CAMBIO_DE_PERMISOS_DE_BASE_DE_DATOS
GRUPO_CAMBIO_PRINCIPAL_BASE_DE_DATOS
GRUPO DE SUPLANTACIÓN DE PRINCIPAL DE BASE DE DATOS
GRUPO_CAMBIO_MIEMBRO_ROL_BASE_DE_DATOS
GRUPO_DE_AUTENTICACIÓN_DE_BASE_DE_DATOS_FALLIDA
Grupo de Acceso a Objetos de Esquema
SCHEMA_OBJECT_CHANGE_GROUP
Cambio de Propiedad de Objeto de Esquema (Grupo SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP)
Grupo_de_Cambio_de_Permiso_de_Objeto_de_Esquema
GRUPO_DE_AUTENTICACIÓN_EXITOSA_DE_BASES_DE_DATOS
USUARIO_CAMBIAR_CONTRASEÑA_GRUPO
BATCH_STARTED_GROUP
BATCH_COMPLETED_GROUP

Estos son grupos que cubren todas las instrucciones SQL y los procedimientos almacenados ejecutados en la base de datos y no deben usarse en combinación con otros grupos, ya que esto dará lugar a registros de auditoría duplicados.

Para obtener más información, consulte Database-Level Auditar grupos de acciones.

Para la directiva de auditoría de base de datos, también se pueden especificar acciones específicas (tenga en cuenta que las acciones no se pueden especificar para la directiva de auditoría del servidor). Las acciones admitidas para auditar son:
ESCOGER
ACTUALIZAR
INSERTAR
BORRAR
EJECUTAR
RECIBIR
REFERENCIAS

El formulario general para definir una acción que se va a auditar es:
{acción} ON {object} BY {principal}

Tenga en cuenta que <objeto> en el formato anterior puede hacer referencia a un objeto como una tabla, una vista o un procedimiento almacenado, o a una base de datos o esquema completo. En los últimos casos, se usan los formularios DATABASE::{db_name} y SCHEMA::{schema_name}, respectivamente.

Por ejemplo:
SELECT en dbo.myTable por public
SELECT en DATABASE::myDatabase por public
SELECT en SCHEMA::mySchema por public

Para obtener más información, consulte Database-Level Acciones de auditoría.
string[]
isAzureMonitorTargetEnabled Especifica si los eventos de auditoría 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, también se debe crear la categoría de registros de diagnóstico "SQLSecurityAuditEvents" en la base de datos.
Tenga en cuenta que para la auditoría de nivel de servidor debe usar la base de datos "master" como {databaseName}.

Formato de URI de configuración de diagnóstico:
PONER https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/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
Bool
isStorageSecondaryKeyInUse Especifica si el valor storageAccountAccessKey es la clave secundaria del almacenamiento. Bool
retentionDays Especifica el número de días que se mantendrán en los registros de auditoría de la cuenta de almacenamiento. Int
estado Especifica el estado de la directiva. Si el estado es Habilitado, se requieren storageEndpoint o isAzureMonitorTargetEnabled. 'Deshabilitado'
'Habilitado' (obligatorio)
storageAccountAccessKey Especifica la clave de identificador de la cuenta de almacenamiento de auditoría. Si se especifica el estado Enabled y storageEndpoint, se requiere storageAccountAccessKey. cuerda
storageAccountSubscriptionId Especifica el identificador de suscripción de Blob Storage. cuerda

Restricciones:
Longitud mínima = 36
Longitud máxima = 36
Patrón = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
storageEndpoint Especifica el punto de conexión de Blob Storage (por ejemplo, https://MyAccount.blob.core.windows.net). Si el estado es Habilitado, se requiere storageEndpoint. cuerda

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso workspaces/sqlPools/auditingSettings se puede implementar con operaciones destinadas a:

  • Grupos de recursos Para una lista de propiedades modificadas en cada versión de la API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.Synapse/workspaces/sqlPools/auditingSettings, agregue el siguiente terraform a la plantilla.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Synapse/workspaces/sqlPools/auditingSettings@2021-06-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      auditActionsAndGroups = [
        "string"
      ]
      isAzureMonitorTargetEnabled = bool
      isStorageSecondaryKeyInUse = bool
      retentionDays = int
      state = "string"
      storageAccountAccessKey = "string"
      storageAccountSubscriptionId = "string"
      storageEndpoint = "string"
    }
  }
}

Valores de propiedad

Microsoft.Synapse/workspaces/sqlPools/auditingSettings

Nombre Descripción Valor
nombre El nombre del recurso 'default' (obligatorio)
parent_id Identificador del recurso que es el elemento primario de este recurso. Identificador del recurso de tipo: workspaces/sqlPools
Propiedades Propiedades de recursos. SqlPoolBlobAuditingPolicyProperties
tipo El tipo de recurso "Microsoft.Synapse/workspaces/sqlPools/auditingSettings@2021-06-01"

SqlPoolBlobAuditingPolicyProperties

Nombre Descripción Valor
auditActionsAndGroups Especifica el Actions-Groups y las acciones que se van a auditar.

El conjunto recomendado de grupos de acciones que se van a usar es la siguiente combinación: esto auditará todas las consultas y procedimientos almacenados ejecutados en la base de datos, así como inicios de sesión correctos y con errores:

BATCH_COMPLETED_GROUP,
SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP,
FAILED_DATABASE_AUTHENTICATION_GROUP.

Esta combinación anterior también es el conjunto que se configura de forma predeterminada al habilitar la auditoría desde Azure Portal.

Los grupos de acciones admitidos que se van a auditar son (nota: elija solo grupos específicos que cubran las necesidades de auditoría. El uso de grupos innecesarios podría dar lugar a grandes cantidades de registros de auditoría):

ROL_DE_APLICACIÓN_CAMBIAR_CONTRASEÑA_GRUPO
GRUPO_DE_RESPALDO_RESTAURACIÓN
GRUPO_DE_CIERRE_DE_SESIÓN_DE_BASE_DE_DATOS
GRUPO_DE_CAMBIO_DE_OBJETO_BASE_DE_DATOS
BASE_DE_DATOS_OBJETO_CAMBIO_DE_PROPIEDAD_GRUPO
GRUPO_DE_CAMBIO_DE_PERMISO_DEL_OBJETO_DE_BASE_DE_DATOS
GRUPO_DE_OPERACIONES_DE_BASE_DE_DATOS
CAMBIO_DE_PERMISOS_DE_BASE_DE_DATOS
GRUPO_CAMBIO_PRINCIPAL_BASE_DE_DATOS
GRUPO DE SUPLANTACIÓN DE PRINCIPAL DE BASE DE DATOS
GRUPO_CAMBIO_MIEMBRO_ROL_BASE_DE_DATOS
GRUPO_DE_AUTENTICACIÓN_DE_BASE_DE_DATOS_FALLIDA
Grupo de Acceso a Objetos de Esquema
SCHEMA_OBJECT_CHANGE_GROUP
Cambio de Propiedad de Objeto de Esquema (Grupo SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP)
Grupo_de_Cambio_de_Permiso_de_Objeto_de_Esquema
GRUPO_DE_AUTENTICACIÓN_EXITOSA_DE_BASES_DE_DATOS
USUARIO_CAMBIAR_CONTRASEÑA_GRUPO
BATCH_STARTED_GROUP
BATCH_COMPLETED_GROUP

Estos son grupos que cubren todas las instrucciones SQL y los procedimientos almacenados ejecutados en la base de datos y no deben usarse en combinación con otros grupos, ya que esto dará lugar a registros de auditoría duplicados.

Para obtener más información, consulte Database-Level Auditar grupos de acciones.

Para la directiva de auditoría de base de datos, también se pueden especificar acciones específicas (tenga en cuenta que las acciones no se pueden especificar para la directiva de auditoría del servidor). Las acciones admitidas para auditar son:
ESCOGER
ACTUALIZAR
INSERTAR
BORRAR
EJECUTAR
RECIBIR
REFERENCIAS

El formulario general para definir una acción que se va a auditar es:
{acción} ON {object} BY {principal}

Tenga en cuenta que <objeto> en el formato anterior puede hacer referencia a un objeto como una tabla, una vista o un procedimiento almacenado, o a una base de datos o esquema completo. En los últimos casos, se usan los formularios DATABASE::{db_name} y SCHEMA::{schema_name}, respectivamente.

Por ejemplo:
SELECT en dbo.myTable por public
SELECT en DATABASE::myDatabase por public
SELECT en SCHEMA::mySchema por public

Para obtener más información, consulte Database-Level Acciones de auditoría.
string[]
isAzureMonitorTargetEnabled Especifica si los eventos de auditoría 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, también se debe crear la categoría de registros de diagnóstico "SQLSecurityAuditEvents" en la base de datos.
Tenga en cuenta que para la auditoría de nivel de servidor debe usar la base de datos "master" como {databaseName}.

Formato de URI de configuración de diagnóstico:
PONER https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/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
Bool
isStorageSecondaryKeyInUse Especifica si el valor storageAccountAccessKey es la clave secundaria del almacenamiento. Bool
retentionDays Especifica el número de días que se mantendrán en los registros de auditoría de la cuenta de almacenamiento. Int
estado Especifica el estado de la directiva. Si el estado es Habilitado, se requieren storageEndpoint o isAzureMonitorTargetEnabled. 'Deshabilitado'
'Habilitado' (obligatorio)
storageAccountAccessKey Especifica la clave de identificador de la cuenta de almacenamiento de auditoría. Si se especifica el estado Enabled y storageEndpoint, se requiere storageAccountAccessKey. cuerda
storageAccountSubscriptionId Especifica el identificador de suscripción de Blob Storage. cuerda

Restricciones:
Longitud mínima = 36
Longitud máxima = 36
Patrón = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
storageEndpoint Especifica el punto de conexión de Blob Storage (por ejemplo, https://MyAccount.blob.core.windows.net). Si el estado es Habilitado, se requiere storageEndpoint. cuerda