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

Server Security Alert Policies - Create Or Update

参考

Service:: SQL Database

API Version:: 2021-11-01

创建或更新威胁检测策略。

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

URI 参数

名称	在	必需	类型	说明
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	ServerSecurityAlertPolicy	已成功更新威胁检测策略。
202 Accepted		已创建设置服务器威胁检测策略的请求。
Other Status Codes		错误响应： *** 400 SecurityAlertPoliciesInvalidStorageAccountName - 提供的存储帐户无效或不存在。 400 SecurityAlertPoliciesInvalidStorageAccountCredentials - 提供的存储帐户访问密钥无效。 400 UpdateNotAllowedOnServerContainingPausedDWDatabase - 在具有暂停Data Warehouse数据库的服务器上，不允许设置服务器威胁检测设置 400 SecurityAlertPoliciesInsufficientDiskSpace - 磁盘空间不足，无法保存数据库中的安全警报策略元数据 400 SecurityAlertPoliciesInsufficientStorageAccountPermissions - 对提供的存储帐户的读取或写入权限不足。 400 SecurityAlertPoliciesStorageAccountIsDisabled - 已禁用威胁检测策略中提供的存储帐户。 400 InvalidServerSecurityAlertPolicyCreateRequest - 创建服务器威胁检测安全警报策略请求不存在或没有属性对象。 400 DataSecurityInvalidUserSuppliedParameter - 客户端提供的参数值无效。 400 UpsertServerSecurityAlertPolicyFailed - 保存威胁检测设置时出错，请稍后重试 400 UpsertServerSecurityAlertPolicyFailed - 保存威胁检测设置时出错，请稍后重试 404 SubscriptionDoesNotHaveServer - 找不到请求的服务器 404 UpsertServerSecurityAlertPolicyFailed - 保存威胁检测设置时出错，请稍后重试 404 OperationIdNotFound - ID 为的操作不存在。 409 ServerSecurityAlertPolicyInProgress - 设置服务器安全警报策略已在进行中 409 UpsertServerSecurityAlertPolicyFailed - 保存威胁检测设置时出错，请稍后重试 409 OperationCancelled - 用户已取消该操作。 409 操作中断 - 无法完成对资源的操作，因为它被同一资源上的另一个操作中断。 429 SubscriptionTooManyCreateUpdateRequests - 超出可用资源可处理的最大请求数的请求数。 429 SubscriptionTooManyRequests - 超出可用资源可处理的最大请求数的请求数。 500 DatabaseIsUnavailable - 加载失败。请稍后再试。 500 UpsertServerSecurityAlertPolicyFailed - 保存威胁检测设置时出错，请稍后重试 500 UpsertServerSecurityAlertPolicyFailed - 保存威胁检测设置时出错，请稍后重试 500 OperationTimedOut - 操作超时并自动回滚。请重试该操作。 503 TooManyRequests - 超出可用资源可处理的最大请求数的请求数。

名称

类型

说明

200 OK

ServerSecurityAlertPolicy

已成功更新威胁检测策略。

202 Accepted

已创建设置服务器威胁检测策略的请求。

Other Status Codes

错误响应： ***

400 SecurityAlertPoliciesInvalidStorageAccountName - 提供的存储帐户无效或不存在。
400 SecurityAlertPoliciesInvalidStorageAccountCredentials - 提供的存储帐户访问密钥无效。
400 UpdateNotAllowedOnServerContainingPausedDWDatabase - 在具有暂停Data Warehouse数据库的服务器上，不允许设置服务器威胁检测设置
400 SecurityAlertPoliciesInsufficientDiskSpace - 磁盘空间不足，无法保存数据库中的安全警报策略元数据
400 SecurityAlertPoliciesInsufficientStorageAccountPermissions - 对提供的存储帐户的读取或写入权限不足。
400 SecurityAlertPoliciesStorageAccountIsDisabled - 已禁用威胁检测策略中提供的存储帐户。
400 InvalidServerSecurityAlertPolicyCreateRequest - 创建服务器威胁检测安全警报策略请求不存在或没有属性对象。
400 DataSecurityInvalidUserSuppliedParameter - 客户端提供的参数值无效。
400 UpsertServerSecurityAlertPolicyFailed - 保存威胁检测设置时出错，请稍后重试
400 UpsertServerSecurityAlertPolicyFailed - 保存威胁检测设置时出错，请稍后重试
404 SubscriptionDoesNotHaveServer - 找不到请求的服务器
404 UpsertServerSecurityAlertPolicyFailed - 保存威胁检测设置时出错，请稍后重试
404 OperationIdNotFound - ID 为的操作不存在。
409 ServerSecurityAlertPolicyInProgress - 设置服务器安全警报策略已在进行中
409 UpsertServerSecurityAlertPolicyFailed - 保存威胁检测设置时出错，请稍后重试
409 OperationCancelled - 用户已取消该操作。
409 操作中断 - 无法完成对资源的操作，因为它被同一资源上的另一个操作中断。
429 SubscriptionTooManyCreateUpdateRequests - 超出可用资源可处理的最大请求数的请求数。
429 SubscriptionTooManyRequests - 超出可用资源可处理的最大请求数的请求数。
500 DatabaseIsUnavailable - 加载失败。请稍后再试。
500 UpsertServerSecurityAlertPolicyFailed - 保存威胁检测设置时出错，请稍后重试
500 UpsertServerSecurityAlertPolicyFailed - 保存威胁检测设置时出错，请稍后重试
500 OperationTimedOut - 操作超时并自动回滚。请重试该操作。
503 TooManyRequests - 超出可用资源可处理的最大请求数的请求数。

示例

Update a server's threat detection policy with all parameters

Update a server's threat detection policy with minimal parameters

Update a server'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/securityAlertPolicies/Default?api-version=2021-11-01

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


import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.ServerSecurityAlertPolicyInner;
import com.azure.resourcemanager.sql.models.SecurityAlertPolicyNameAutoGenerated;
import com.azure.resourcemanager.sql.models.SecurityAlertPolicyState;
import java.util.Arrays;

/** Samples for ServerSecurityAlertPolicies CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ServerSecurityAlertsCreateMax.json
     */
    /**
     * Sample code: Update a server's threat detection policy with all parameters.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        updateAServerSThreatDetectionPolicyWithAllParameters(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServerSecurityAlertPolicies().createOrUpdate(
            "securityalert-4799", "securityalert-6440", SecurityAlertPolicyNameAutoGenerated.DEFAULT,
            new ServerSecurityAlertPolicyInner().withState(SecurityAlertPolicyState.ENABLED)
                .withDisabledAlerts(Arrays.asList("Access_Anomaly", "Usage_Anomaly"))
                .withEmailAddresses(Arrays.asList("testSecurityAlert@microsoft.com")).withEmailAccountAdmins(true)
                .withStorageEndpoint("https://mystorage.blob.core.windows.net")
                .withStorageAccountAccessKey("fakeTokenPlaceholder").withRetentionDays(5),
            Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.Sql/servers/securityalert-6440/securityAlertPolicies/default",
  "name": "Default",
  "type": "Microsoft.Sql/servers/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": [
      "testSecurityAlert@microsoft.com"
    ],
    "disabledAlerts": [
      "Access_Anomaly",
      "Usage_Anomaly"
    ],
    "retentionDays": 5,
    "storageEndpoint": "https://mystorage.blob.core.windows.net"
  }
}

Status code:: 202

Update a server's threat detection policy with minimal parameters

Sample Request

HTTP
Java

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

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


import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.ServerSecurityAlertPolicyInner;
import com.azure.resourcemanager.sql.models.SecurityAlertPolicyNameAutoGenerated;
import com.azure.resourcemanager.sql.models.SecurityAlertPolicyState;

/** Samples for ServerSecurityAlertPolicies CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ServerSecurityAlertsCreateMin.json
     */
    /**
     * Sample code: Update a server's threat detection policy with minimal parameters.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        updateAServerSThreatDetectionPolicyWithMinimalParameters(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServerSecurityAlertPolicies().createOrUpdate(
            "securityalert-4799", "securityalert-6440", SecurityAlertPolicyNameAutoGenerated.DEFAULT,
            new ServerSecurityAlertPolicyInner().withState(SecurityAlertPolicyState.ENABLED), Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.Sql/servers/securityalert-6440/securityAlertPolicies/default",
  "name": "Default",
  "type": "Microsoft.Sql/servers/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": false,
    "emailAddresses": [
      ""
    ],
    "disabledAlerts": [
      ""
    ],
    "retentionDays": 0,
    "storageEndpoint": "https://mystorage.blob.core.windows.net"
  }
}

Status code:: 202

定义

名称	说明
createdByType	创建资源的标识类型。
SecurityAlertPolicyName	威胁检测策略的名称。
SecurityAlertsPolicyState	指定策略的状态，无论策略是启用还是禁用，还是尚未对特定数据库应用策略。
ServerSecurityAlertPolicy	服务器安全警报策略。
systemData	与资源的创建和上次修改相关的元数据。

createdByType

创建资源的标识类型。

名称	类型	说明
Application	string
Key	string
ManagedIdentity	string
User	string

SecurityAlertPolicyName

威胁检测策略的名称。

名称	类型	说明
Default	string

SecurityAlertsPolicyState

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

名称	类型	说明
Disabled	string
Enabled	string

ServerSecurityAlertPolicy

服务器安全警报策略。

名称	类型	说明
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	资源类型。

systemData

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

名称	类型	说明
createdAt	string	资源的创建时间戳 (UTC) 。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识类型。
lastModifiedAt	string	资源上次修改的时间戳 (UTC)
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识类型。

Server Security Alert Policies - Create Or Update

URI 参数

请求正文

响应

示例

Update a server's threat detection policy with all parameters

Sample Request

Sample Response

Update a server's threat detection policy with minimal parameters

Sample Request

Sample Response

定义

createdByType

SecurityAlertPolicyName

SecurityAlertsPolicyState

ServerSecurityAlertPolicy

systemData

其他资源