你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Database Security Alert Policies - Create Or Update

创建或更新数据库的安全警报策略。

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

URI 参数

名称 必需 类型 说明
databaseName
path True

string

为其定义了安全警报策略的数据库的名称。

resourceGroupName
path True

string

包含该资源的资源组名称。 可以从 Azure 资源管理器 API 或门户获取此值。

securityAlertPolicyName
path True

SecurityAlertPolicyName

安全警报策略的名称。

serverName
path True

string

服务器的名称。

subscriptionId
path True

string

用于标识 Azure 订阅的订阅 ID。

api-version
query True

string

要用于请求的 API 版本。

请求正文

名称 必需 类型 说明
properties.state True

SecurityAlertsPolicyState

指定策略的状态,无论是启用或禁用策略,还是尚未对特定数据库应用策略。

properties.disabledAlerts

string[]

指定禁用的警报数组。 允许的值为:Sql_Injection、Sql_Injection_Vulnerability、Access_Anomaly、Data_Exfiltration、Unsafe_Action、Brute_Force

properties.emailAccountAdmins

boolean

指定将警报发送给帐户管理员。

properties.emailAddresses

string[]

指定警报要发送到的电子邮件地址数组。

properties.retentionDays

integer

指定要在威胁检测审核日志中保留的天数。

properties.storageAccountAccessKey

string

指定威胁检测审核存储帐户的标识符密钥。

properties.storageEndpoint

string

指定 blob 存储终结点 (例如 https://MyAccount.blob.core.windows.net) 。 此 Blob 存储将保存所有威胁检测审核日志。

响应

名称 类型 说明
200 OK

DatabaseSecurityAlertPolicy

已成功设置数据库安全警报策略。

201 Created

DatabaseSecurityAlertPolicy

已成功创建数据库安全警报策略。

Other Status Codes

错误响应:***

  • 400 UpdateNotAllowedOnPausedDatabase - 用户尝试对暂停的数据库执行更新。

  • 400 SecurityAlertPoliciesInsufficientStorageAccountPermissions - 对提供的存储帐户的读取或写入权限不足。

  • 400 SecurityAlertPoliciesStorageAccountIsDisabled - 威胁检测策略中提供的存储帐户处于禁用状态。

  • 400 SecurityAlertPoliciesInsufficientDiskSpace - 磁盘空间不足,无法保存数据库中的安全警报策略元数据

  • 400 SecurityAlertPoliciesInvalidStorageAccountName - 提供的存储帐户无效或不存在。

  • 400 SecurityAlertPoliciesInvalidStorageAccountCredentials - 提供的存储帐户访问密钥无效。

  • 400 InvalidDatabaseSecurityAlertPolicyCreateRequest - 创建数据库威胁检测安全警报策略请求不存在或没有 properties 对象。

  • 400 DataSecurityInvalidUserSuppliedParameter - 客户端提供的参数值无效。

  • 400 UpsertDatabaseSecurityAlertPolicyFailed - 保存威胁检测设置时出错,请稍后重试

  • 400 UpsertDatabaseSecurityAlertPolicyFailed - 保存威胁检测设置时出错,请稍后重试

  • 404 DatabaseDoesNotExist - 用户已指定此服务器实例上不存在的数据库名称。

  • 404 SubscriptionDoesNotHaveServer - 找不到请求的服务器

  • 404 UpsertDatabaseSecurityAlertPolicyFailed - 保存威胁检测设置时出错,请稍后重试

  • 409 DatabaseSecurityAlertPolicyInProgress - 设置数据库安全警报策略已在进行中

  • 409 UpsertDatabaseSecurityAlertPolicyFailed - 保存威胁检测设置时出错,请稍后重试

  • 500 DatabaseIsUnavailable - 加载失败。 请稍后再试。

  • 500 UpsertDatabaseSecurityAlertPolicyFailed - 保存威胁检测设置时出错,请稍后重试

  • 500 GetDatabaseSecurityAlertPolicyFailed - 无法获取威胁检测设置

示例

Update a database's threat detection policy with all parameters
Update a database's threat detection policy with minimal parameters

Update a database's threat detection policy with all parameters

示例请求

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.Sql/servers/securityalert-6440/databases/testdb/securityAlertPolicies/default?api-version=2021-11-01

{
  "properties": {
    "state": "Enabled",
    "emailAccountAdmins": true,
    "emailAddresses": [
      "test@microsoft.com",
      "user@microsoft.com"
    ],
    "disabledAlerts": [
      "Sql_Injection",
      "Usage_Anomaly"
    ],
    "retentionDays": 6,
    "storageAccountAccessKey": "sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD==",
    "storageEndpoint": "https://mystorage.blob.core.windows.net"
  }
}

示例响应

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.Sql/servers/securityalert-6440/databases/testdb",
  "name": "default",
  "type": "Microsoft.Sql/servers/databases/securityAlertPolicies",
  "systemData": {
    "createdBy": "string",
    "createdByType": "User",
    "createdAt": "2020-04-03T04:41:33.937Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-04-03T04:41:33.937Z"
  },
  "properties": {
    "state": "Enabled",
    "emailAccountAdmins": true,
    "emailAddresses": [
      "test@microsoft.com",
      "user@microsoft.com"
    ],
    "disabledAlerts": [
      "Sql_Injection",
      "Usage_Anomaly"
    ],
    "retentionDays": 6,
    "storageEndpoint": "https://mystorage.blob.core.windows.net"
  }
}
{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.Sql/servers/securityalert-6440/databases/testdb",
  "name": "default",
  "type": "Microsoft.Sql/servers/databases/securityAlertPolicies",
  "systemData": {
    "createdBy": "string",
    "createdByType": "User",
    "createdAt": "2020-04-03T04:41:33.937Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-04-03T04:41:33.937Z"
  },
  "properties": {
    "state": "Enabled",
    "emailAccountAdmins": true,
    "emailAddresses": [
      "test@microsoft.com",
      "user@microsoft.com"
    ],
    "disabledAlerts": [
      "Access_Anomaly",
      "Usage_Anomaly"
    ],
    "retentionDays": 6,
    "storageEndpoint": "https://mystorage.blob.core.windows.net"
  }
}

Update a database's threat detection policy with minimal parameters

示例请求

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.Sql/servers/securityalert-6440/databases/testdb/securityAlertPolicies/default?api-version=2021-11-01

{
  "properties": {
    "state": "Enabled"
  }
}

示例响应

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.Sql/servers/securityalert-6440/databases/testdb",
  "name": "default",
  "type": "Microsoft.Sql/servers/databases/securityAlertPolicies",
  "systemData": {
    "createdBy": "string",
    "createdByType": "User",
    "createdAt": "2020-04-03T04:41:33.937Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-04-03T04:41:33.937Z"
  },
  "properties": {
    "state": "Enabled",
    "emailAccountAdmins": true,
    "emailAddresses": [],
    "disabledAlerts": [],
    "retentionDays": 0,
    "storageEndpoint": ""
  }
}
{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.Sql/servers/securityalert-6440/databases/testdb",
  "name": "default",
  "type": "Microsoft.Sql/servers/databases/securityAlertPolicies",
  "systemData": {
    "createdBy": "string",
    "createdByType": "User",
    "createdAt": "2020-04-03T04:41:33.937Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-04-03T04:41:33.937Z"
  },
  "properties": {
    "state": "Enabled",
    "emailAccountAdmins": true,
    "emailAddresses": [],
    "disabledAlerts": [],
    "retentionDays": 0,
    "storageEndpoint": ""
  }
}

定义

名称 说明
createdByType

创建资源的标识类型。

DatabaseSecurityAlertPolicy

数据库安全警报策略。

SecurityAlertPolicyName

安全警报策略的名称。

SecurityAlertsPolicyState

指定策略的状态,无论是启用或禁用策略,还是尚未对特定数据库应用策略。

systemData

与资源的创建和上次修改相关的元数据。

createdByType

创建资源的标识类型。

名称 类型 说明
Application

string

Key

string

ManagedIdentity

string

User

string

DatabaseSecurityAlertPolicy

数据库安全警报策略。

名称 类型 说明
id

string

资源 ID。

name

string

资源名称。

properties.creationTime

string

指定策略的 UTC 创建时间。

properties.disabledAlerts

string[]

指定禁用的警报数组。 允许的值为:Sql_Injection、Sql_Injection_Vulnerability、Access_Anomaly、Data_Exfiltration、Unsafe_Action、Brute_Force

properties.emailAccountAdmins

boolean

指定将警报发送给帐户管理员。

properties.emailAddresses

string[]

指定警报要发送到的电子邮件地址数组。

properties.retentionDays

integer

指定要在威胁检测审核日志中保留的天数。

properties.state

SecurityAlertsPolicyState

指定策略的状态,无论是启用或禁用策略,还是尚未对特定数据库应用策略。

properties.storageAccountAccessKey

string

指定威胁检测审核存储帐户的标识符密钥。

properties.storageEndpoint

string

指定 blob 存储终结点 (例如 https://MyAccount.blob.core.windows.net) 。 此 Blob 存储将保存所有威胁检测审核日志。

systemData

systemData

SecurityAlertPolicyResource 的 SystemData。

type

string

资源类型。

SecurityAlertPolicyName

安全警报策略的名称。

名称 类型 说明
default

string

SecurityAlertsPolicyState

指定策略的状态,无论是启用或禁用策略,还是尚未对特定数据库应用策略。

名称 类型 说明
Disabled

string

Enabled

string

systemData

与资源的创建和上次修改相关的元数据。

名称 类型 说明
createdAt

string

资源创建时间戳 (UTC) 。

createdBy

string

创建资源的标识。

createdByType

createdByType

创建资源的标识类型。

lastModifiedAt

string

资源上次修改的时间戳 (UTC)

lastModifiedBy

string

上次修改资源的标识。

lastModifiedByType

createdByType

上次修改资源的标识类型。