你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.Sql servers/databases/auditingSettings 2023-02-01-preview
- 最新
- 2024-05-01-preview
- 2023-08-01-preview
- 2023-05-01-preview
- 2023-02-01-preview
- 2022-11-01-preview
- 2022-08-01-preview
- 2022-05-01-preview
- 2022-02-01-preview
- 2021-11-01
- 2021-11-01-preview
- 2021-08-01-preview
- 2021-05-01-preview
- 2021-02-01-preview
- 2020-11-01-preview
- 2020-08-01-preview
- 2020-02-02-preview
- 2017-03-01-preview
- 2015-05-01-preview
Bicep 资源定义
可以使用目标操作部署 servers/databases/auditingSettings 资源类型：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.Sql/servers/databases/auditingSettings 资源，请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.Sql/servers/databases/auditingSettings@2023-02-01-preview' = {
parent: resourceSymbolicName
name: 'default'
properties: {
auditActionsAndGroups: [
'string'
]
isAzureMonitorTargetEnabled: bool
isManagedIdentityInUse: bool
isStorageSecondaryKeyInUse: bool
queueDelayMs: int
retentionDays: int
state: 'string'
storageAccountAccessKey: 'string'
storageAccountSubscriptionId: 'string'
storageEndpoint: 'string'
}
}
属性值
DatabaseBlobAuditingPolicyProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| auditActionsAndGroups | 指定要审核的 Actions-Groups 和操作。 建议使用的操作组集是以下组合 - 这将审核针对数据库执行的所有查询和存储过程，以及成功和失败的登录： BATCH_COMPLETED_GROUP， SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP， FAILED_DATABASE_AUTHENTICATION_GROUP。 上述组合也是从 Azure 门户启用审核时默认配置的集。 要审核的受支持操作组（注意：仅选择涵盖审核需求的特定组。使用不必要的组可能会导致大量审核记录）： APPLICATION_ROLE_CHANGE_PASSWORD_GROUP BACKUP_RESTORE_GROUP DATABASE_LOGOUT_GROUP DATABASE_OBJECT_CHANGE_GROUP DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP DATABASE_OBJECT_PERMISSION_CHANGE_GROUP DATABASE_OPERATION_GROUP DATABASE_PERMISSION_CHANGE_GROUP DATABASE_PRINCIPAL_CHANGE_GROUP DATABASE_PRINCIPAL_IMPERSONATION_GROUP DATABASE_ROLE_MEMBER_CHANGE_GROUP FAILED_DATABASE_AUTHENTICATION_GROUP SCHEMA_OBJECT_ACCESS_GROUP SCHEMA_OBJECT_CHANGE_GROUP SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP USER_CHANGE_PASSWORD_GROUP BATCH_STARTED_GROUP BATCH_COMPLETED_GROUP DBCC_GROUP DATABASE_OWNERSHIP_CHANGE_GROUP DATABASE_CHANGE_GROUP LEDGER_OPERATION_GROUP 这些组涵盖针对数据库执行的所有 sql 语句和存储过程，不应与其他组结合使用，因为这将导致重复的审核日志。 有关详细信息，请参阅 Database-Level 审核操作组。 对于数据库审核策略，还可以指定特定操作（请注意，不能为服务器审核策略指定操作）。 要审核的受支持操作包括： 选择 更新 插入 删除 执行 收到 引用 定义要审核的操作的一般形式是： {action}ON {object} BY {principal} 请注意，采用上述格式的 <对象> 可以引用表、视图或存储过程或整个数据库或架构等对象。 对于后一种情况，将分别使用 FORMS DATABASE：：{db_name} 和 SCHEMA：：{schema_name}。 例如： SELECT on dbo.myTable by public SELECT on DATABASE：：myDatabase by public SELECT on SCHEMA：：mySchema by public 有关详细信息，请参阅 Database-Level 审核操作 |
string[] |
| isAzureMonitorTargetEnabled | 指定是否将审核事件发送到 Azure Monitor。 若要将事件发送到 Azure Monitor，请将“State”指定为“Enabled”，将“IsAzureMonitorTargetEnabled”指定为 true。 使用 REST API 配置审核时，还应在数据库上创建具有“SQLSecurityAuditEvents”诊断日志类别的诊断设置。 请注意，对于服务器级别审核，应使用“master”数据库作为 {databaseName}。 诊断设置 URI 格式： PUT 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 有关详细信息，请参阅 诊断设置 REST API 或 诊断设置 PowerShell |
bool |
| isManagedIdentityInUse | 指定是否使用托管标识访问 Blob 存储 | bool |
| isStorageSecondaryKeyInUse | 指定 storageAccountAccessKey 值是否为存储的辅助密钥。 | bool |
| queueDelayMs | 指定在强制处理审核操作之前可以经过的时间（以毫秒为单位）。 默认值为 1000（1 秒）。 最大值为 2,147,483,647。 |
int |
| retentionDays | 指定要保留在存储帐户中的审核日志中的天数。 | int |
| 州 | 指定审核的状态。 如果状态为“已启用”，则需要 storageEndpoint 或 isAzureMonitorTargetEnabled。 | “Disabled” “Enabled”（必需） |
| storageAccountAccessKey | 指定审核存储帐户的标识符密钥。 如果状态为 Enabled 且 storageEndpoint 已指定，则不指定 storageAccountAccessKey 将使用 SQL Server 系统分配的托管标识来访问存储。 使用托管标识身份验证的先决条件： 1.在 Azure Active Directory（AAD）中为 SQL Server 分配系统分配的托管标识。 2. 通过将“存储 Blob 数据参与者”RBAC 角色添加到服务器标识，授予 SQL Server 标识对存储帐户的访问权限。 有关详细信息，请参阅 使用托管标识身份验证对存储的审核 |
字符串 约束： 敏感值。 以安全参数的形式传入。 |
| storageAccountSubscriptionId | 指定 Blob 存储订阅 ID。 | 字符串 约束： 最小长度 = 36 最大长度 = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| storageEndpoint | 指定 blob 存储终结点（例如 https://MyAccount.blob.core.windows.net）。 如果状态为“已启用”，则需要 storageEndpoint 或 isAzureMonitorTargetEnabled。 | 字符串 |
Microsoft.Sql/servers/databases/auditingSettings
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 资源名称 | “default”（必需） |
| 父母 | 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。 有关详细信息，请参阅 父资源外部的子资源。 |
类型资源的符号名称：服务器/数据库 |
| 性能 | 资源属性。 | DatabaseBlobAuditingPolicyProperties |
ARM 模板资源定义
可以使用目标操作部署 servers/databases/auditingSettings 资源类型：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.Sql/servers/databases/auditingSettings 资源，请将以下 JSON 添加到模板。
{
"type": "Microsoft.Sql/servers/databases/auditingSettings",
"apiVersion": "2023-02-01-preview",
"name": "string",
"properties": {
"auditActionsAndGroups": [ "string" ],
"isAzureMonitorTargetEnabled": "bool",
"isManagedIdentityInUse": "bool",
"isStorageSecondaryKeyInUse": "bool",
"queueDelayMs": "int",
"retentionDays": "int",
"state": "string",
"storageAccountAccessKey": "string",
"storageAccountSubscriptionId": "string",
"storageEndpoint": "string"
}
}
属性值
DatabaseBlobAuditingPolicyProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| auditActionsAndGroups | 指定要审核的 Actions-Groups 和操作。 建议使用的操作组集是以下组合 - 这将审核针对数据库执行的所有查询和存储过程，以及成功和失败的登录： BATCH_COMPLETED_GROUP， SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP， FAILED_DATABASE_AUTHENTICATION_GROUP。 上述组合也是从 Azure 门户启用审核时默认配置的集。 要审核的受支持操作组（注意：仅选择涵盖审核需求的特定组。使用不必要的组可能会导致大量审核记录）： APPLICATION_ROLE_CHANGE_PASSWORD_GROUP BACKUP_RESTORE_GROUP DATABASE_LOGOUT_GROUP DATABASE_OBJECT_CHANGE_GROUP DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP DATABASE_OBJECT_PERMISSION_CHANGE_GROUP DATABASE_OPERATION_GROUP DATABASE_PERMISSION_CHANGE_GROUP DATABASE_PRINCIPAL_CHANGE_GROUP DATABASE_PRINCIPAL_IMPERSONATION_GROUP DATABASE_ROLE_MEMBER_CHANGE_GROUP FAILED_DATABASE_AUTHENTICATION_GROUP SCHEMA_OBJECT_ACCESS_GROUP SCHEMA_OBJECT_CHANGE_GROUP SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP USER_CHANGE_PASSWORD_GROUP BATCH_STARTED_GROUP BATCH_COMPLETED_GROUP DBCC_GROUP DATABASE_OWNERSHIP_CHANGE_GROUP DATABASE_CHANGE_GROUP LEDGER_OPERATION_GROUP 这些组涵盖针对数据库执行的所有 sql 语句和存储过程，不应与其他组结合使用，因为这将导致重复的审核日志。 有关详细信息，请参阅 Database-Level 审核操作组。 对于数据库审核策略，还可以指定特定操作（请注意，不能为服务器审核策略指定操作）。 要审核的受支持操作包括： 选择 更新 插入 删除 执行 收到 引用 定义要审核的操作的一般形式是： {action}ON {object} BY {principal} 请注意，采用上述格式的 <对象> 可以引用表、视图或存储过程或整个数据库或架构等对象。 对于后一种情况，将分别使用 FORMS DATABASE：：{db_name} 和 SCHEMA：：{schema_name}。 例如： SELECT on dbo.myTable by public SELECT on DATABASE：：myDatabase by public SELECT on SCHEMA：：mySchema by public 有关详细信息，请参阅 Database-Level 审核操作 |
string[] |
| isAzureMonitorTargetEnabled | 指定是否将审核事件发送到 Azure Monitor。 若要将事件发送到 Azure Monitor，请将“State”指定为“Enabled”，将“IsAzureMonitorTargetEnabled”指定为 true。 使用 REST API 配置审核时，还应在数据库上创建具有“SQLSecurityAuditEvents”诊断日志类别的诊断设置。 请注意，对于服务器级别审核，应使用“master”数据库作为 {databaseName}。 诊断设置 URI 格式： PUT 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 有关详细信息，请参阅 诊断设置 REST API 或 诊断设置 PowerShell |
bool |
| isManagedIdentityInUse | 指定是否使用托管标识访问 Blob 存储 | bool |
| isStorageSecondaryKeyInUse | 指定 storageAccountAccessKey 值是否为存储的辅助密钥。 | bool |
| queueDelayMs | 指定在强制处理审核操作之前可以经过的时间（以毫秒为单位）。 默认值为 1000（1 秒）。 最大值为 2,147,483,647。 |
int |
| retentionDays | 指定要保留在存储帐户中的审核日志中的天数。 | int |
| 州 | 指定审核的状态。 如果状态为“已启用”，则需要 storageEndpoint 或 isAzureMonitorTargetEnabled。 | “Disabled” “Enabled”（必需） |
| storageAccountAccessKey | 指定审核存储帐户的标识符密钥。 如果状态为 Enabled 且 storageEndpoint 已指定，则不指定 storageAccountAccessKey 将使用 SQL Server 系统分配的托管标识来访问存储。 使用托管标识身份验证的先决条件： 1.在 Azure Active Directory（AAD）中为 SQL Server 分配系统分配的托管标识。 2. 通过将“存储 Blob 数据参与者”RBAC 角色添加到服务器标识，授予 SQL Server 标识对存储帐户的访问权限。 有关详细信息，请参阅 使用托管标识身份验证对存储的审核 |
字符串 约束： 敏感值。 以安全参数的形式传入。 |
| storageAccountSubscriptionId | 指定 Blob 存储订阅 ID。 | 字符串 约束： 最小长度 = 36 最大长度 = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| storageEndpoint | 指定 blob 存储终结点（例如 https://MyAccount.blob.core.windows.net）。 如果状态为“已启用”，则需要 storageEndpoint 或 isAzureMonitorTargetEnabled。 | 字符串 |
Microsoft.Sql/servers/databases/auditingSettings
| 名字 | 描述 | 价值 |
|---|---|---|
| apiVersion | API 版本 | '2023-02-01-preview' |
| 名字 | 资源名称 | “default”（必需） |
| 性能 | 资源属性。 | DatabaseBlobAuditingPolicyProperties |
| 类型 | 资源类型 | “Microsoft.Sql/servers/databases/auditingSettings” |
Terraform （AzAPI 提供程序）资源定义
可以使用目标操作部署 servers/databases/auditingSettings 资源类型：
- 资源组
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.Sql/servers/databases/auditingSettings 资源，请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Sql/servers/databases/auditingSettings@2023-02-01-preview"
name = "string"
body = jsonencode({
properties = {
auditActionsAndGroups = [
"string"
]
isAzureMonitorTargetEnabled = bool
isManagedIdentityInUse = bool
isStorageSecondaryKeyInUse = bool
queueDelayMs = int
retentionDays = int
state = "string"
storageAccountAccessKey = "string"
storageAccountSubscriptionId = "string"
storageEndpoint = "string"
}
})
}
属性值
DatabaseBlobAuditingPolicyProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| auditActionsAndGroups | 指定要审核的 Actions-Groups 和操作。 建议使用的操作组集是以下组合 - 这将审核针对数据库执行的所有查询和存储过程，以及成功和失败的登录： BATCH_COMPLETED_GROUP， SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP， FAILED_DATABASE_AUTHENTICATION_GROUP。 上述组合也是从 Azure 门户启用审核时默认配置的集。 要审核的受支持操作组（注意：仅选择涵盖审核需求的特定组。使用不必要的组可能会导致大量审核记录）： APPLICATION_ROLE_CHANGE_PASSWORD_GROUP BACKUP_RESTORE_GROUP DATABASE_LOGOUT_GROUP DATABASE_OBJECT_CHANGE_GROUP DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP DATABASE_OBJECT_PERMISSION_CHANGE_GROUP DATABASE_OPERATION_GROUP DATABASE_PERMISSION_CHANGE_GROUP DATABASE_PRINCIPAL_CHANGE_GROUP DATABASE_PRINCIPAL_IMPERSONATION_GROUP DATABASE_ROLE_MEMBER_CHANGE_GROUP FAILED_DATABASE_AUTHENTICATION_GROUP SCHEMA_OBJECT_ACCESS_GROUP SCHEMA_OBJECT_CHANGE_GROUP SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP USER_CHANGE_PASSWORD_GROUP BATCH_STARTED_GROUP BATCH_COMPLETED_GROUP DBCC_GROUP DATABASE_OWNERSHIP_CHANGE_GROUP DATABASE_CHANGE_GROUP LEDGER_OPERATION_GROUP 这些组涵盖针对数据库执行的所有 sql 语句和存储过程，不应与其他组结合使用，因为这将导致重复的审核日志。 有关详细信息，请参阅 Database-Level 审核操作组。 对于数据库审核策略，还可以指定特定操作（请注意，不能为服务器审核策略指定操作）。 要审核的受支持操作包括： 选择 更新 插入 删除 执行 收到 引用 定义要审核的操作的一般形式是： {action}ON {object} BY {principal} 请注意，采用上述格式的 <对象> 可以引用表、视图或存储过程或整个数据库或架构等对象。 对于后一种情况，将分别使用 FORMS DATABASE：：{db_name} 和 SCHEMA：：{schema_name}。 例如： SELECT on dbo.myTable by public SELECT on DATABASE：：myDatabase by public SELECT on SCHEMA：：mySchema by public 有关详细信息，请参阅 Database-Level 审核操作 |
string[] |
| isAzureMonitorTargetEnabled | 指定是否将审核事件发送到 Azure Monitor。 若要将事件发送到 Azure Monitor，请将“State”指定为“Enabled”，将“IsAzureMonitorTargetEnabled”指定为 true。 使用 REST API 配置审核时，还应在数据库上创建具有“SQLSecurityAuditEvents”诊断日志类别的诊断设置。 请注意，对于服务器级别审核，应使用“master”数据库作为 {databaseName}。 诊断设置 URI 格式： PUT 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 有关详细信息，请参阅 诊断设置 REST API 或 诊断设置 PowerShell |
bool |
| isManagedIdentityInUse | 指定是否使用托管标识访问 Blob 存储 | bool |
| isStorageSecondaryKeyInUse | 指定 storageAccountAccessKey 值是否为存储的辅助密钥。 | bool |
| queueDelayMs | 指定在强制处理审核操作之前可以经过的时间（以毫秒为单位）。 默认值为 1000（1 秒）。 最大值为 2,147,483,647。 |
int |
| retentionDays | 指定要保留在存储帐户中的审核日志中的天数。 | int |
| 州 | 指定审核的状态。 如果状态为“已启用”，则需要 storageEndpoint 或 isAzureMonitorTargetEnabled。 | “Disabled” “Enabled”（必需） |
| storageAccountAccessKey | 指定审核存储帐户的标识符密钥。 如果状态为 Enabled 且 storageEndpoint 已指定，则不指定 storageAccountAccessKey 将使用 SQL Server 系统分配的托管标识来访问存储。 使用托管标识身份验证的先决条件： 1.在 Azure Active Directory（AAD）中为 SQL Server 分配系统分配的托管标识。 2. 通过将“存储 Blob 数据参与者”RBAC 角色添加到服务器标识，授予 SQL Server 标识对存储帐户的访问权限。 有关详细信息，请参阅 使用托管标识身份验证对存储的审核 |
字符串 约束： 敏感值。 以安全参数的形式传入。 |
| storageAccountSubscriptionId | 指定 Blob 存储订阅 ID。 | 字符串 约束： 最小长度 = 36 最大长度 = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| storageEndpoint | 指定 blob 存储终结点（例如 https://MyAccount.blob.core.windows.net）。 如果状态为“已启用”，则需要 storageEndpoint 或 isAzureMonitorTargetEnabled。 | 字符串 |
Microsoft.Sql/servers/databases/auditingSettings
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 资源名称 | “default”（必需） |
| parent_id | 此资源的父资源的 ID。 | 类型资源的 ID：服务器/数据库 |
| 性能 | 资源属性。 | DatabaseBlobAuditingPolicyProperties |
| 类型 | 资源类型 | “Microsoft.Sql/servers/databases/auditingSettings@2023-02-01-preview” |