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

Server Security Alert Policies - List By Server

服务:: SQL Database

API 版本:: 2023-08-01

获取服务器的威胁检测策略。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/securityAlertPolicies?api-version=2023-08-01

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string	包含资源的资源组的名称。可以从 Azure 资源管理器 API 或门户获取此值。
serverName	path	True	string	服务器的名称。
subscriptionId	path	True	string	标识 Azure 订阅的订阅 ID。
api-version	query	True	string	要用于请求的 API 版本。

响应

名称	类型	说明
200 OK	LogicalServerSecurityAlertPolicyListResult	已成功检索服务器威胁检测策略。
Other Status Codes	ErrorResponse	错误响应： *** 400 SecurityAlertPoliciesInsufficientStorageAccountPermissions - 对提供的存储帐户的读取或写入权限不足。 400 SecurityAlertPoliciesStorageAccountIsDisabled - 已禁用威胁检测策略中提供的存储帐户。 400 SecurityAlertPoliciesInvalidStorageAccountName - 提供的存储帐户无效或不存在。 400 SecurityAlertPoliciesInvalidStorageAccountCredentials - 提供的存储帐户访问密钥无效。 400 SecurityAlertPoliciesInsufficientDiskSpace - 磁盘空间不足，无法节省数据库中的安全警报策略元数据 400 UpdateNotAllowedOnServerContainingPausedDWDatabase - 不允许在具有暂停数据仓库数据库的服务器上设置服务器威胁检测设置 400 InvalidServerSecurityAlertPolicyCreateRequest - 创建服务器威胁检测安全警报策略请求不存在或没有属性对象。 400 DataSecurityInvalidUserSuppliedParameter - 客户端提供了无效的参数值。 400 UpsertServerSecurityAlertPolicyFailed - 保存威胁检测设置时出错，请稍后重试 400 UpsertServerSecurityAlertPolicyFailed - 保存威胁检测设置时出错，请稍后重试 404 SubscriptionDoesNotHaveServer - 找不到请求的服务器 404 UpsertServerSecurityAlertPolicyFailed - 保存威胁检测设置时出错，请稍后重试 409 ServerSecurityAlertPolicyInProgress - 设置服务器安全警报策略正在进行中 409 UpsertServerSecurityAlertPolicyFailed - 保存威胁检测设置时出错，请稍后重试 500 DatabaseIsUnavailable - 加载失败。请稍后重试。 500 UpsertServerSecurityAlertPolicyFailed - 保存威胁检测设置时出错，请稍后重试 500 GetServerSecurityAlertPolicyFailed - 未能获取威胁检测设置

名称

类型

说明

200 OK

LogicalServerSecurityAlertPolicyListResult

已成功检索服务器威胁检测策略。

Other Status Codes

ErrorResponse

错误响应： ***

400 SecurityAlertPoliciesInsufficientStorageAccountPermissions - 对提供的存储帐户的读取或写入权限不足。
400 SecurityAlertPoliciesStorageAccountIsDisabled - 已禁用威胁检测策略中提供的存储帐户。
400 SecurityAlertPoliciesInvalidStorageAccountName - 提供的存储帐户无效或不存在。
400 SecurityAlertPoliciesInvalidStorageAccountCredentials - 提供的存储帐户访问密钥无效。
400 SecurityAlertPoliciesInsufficientDiskSpace - 磁盘空间不足，无法节省数据库中的安全警报策略元数据
400 UpdateNotAllowedOnServerContainingPausedDWDatabase - 不允许在具有暂停数据仓库数据库的服务器上设置服务器威胁检测设置
400 InvalidServerSecurityAlertPolicyCreateRequest - 创建服务器威胁检测安全警报策略请求不存在或没有属性对象。
400 DataSecurityInvalidUserSuppliedParameter - 客户端提供了无效的参数值。
400 UpsertServerSecurityAlertPolicyFailed - 保存威胁检测设置时出错，请稍后重试
400 UpsertServerSecurityAlertPolicyFailed - 保存威胁检测设置时出错，请稍后重试
404 SubscriptionDoesNotHaveServer - 找不到请求的服务器
404 UpsertServerSecurityAlertPolicyFailed - 保存威胁检测设置时出错，请稍后重试
409 ServerSecurityAlertPolicyInProgress - 设置服务器安全警报策略正在进行中
409 UpsertServerSecurityAlertPolicyFailed - 保存威胁检测设置时出错，请稍后重试
500 DatabaseIsUnavailable - 加载失败。请稍后重试。
500 UpsertServerSecurityAlertPolicyFailed - 保存威胁检测设置时出错，请稍后重试
500 GetServerSecurityAlertPolicyFailed - 未能获取威胁检测设置

示例

List the server's threat detection policies

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/ServerSecurityAlertsListByServer.json
// this example is just showing the usage of "ServerSecurityAlertPolicies_ListByServer" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://free.blessedness.top/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlServerResource created on azure
// for more information of creating SqlServerResource, please refer to the document of SqlServerResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "securityalert-4799";
string serverName = "securityalert-6440";
ResourceIdentifier sqlServerResourceId = SqlServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
SqlServerResource sqlServer = client.GetSqlServerResource(sqlServerResourceId);

// get the collection of this SqlServerSecurityAlertPolicyResource
SqlServerSecurityAlertPolicyCollection collection = sqlServer.GetSqlServerSecurityAlertPolicies();

// invoke the operation and iterate over the result
await foreach (SqlServerSecurityAlertPolicyResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    SqlServerSecurityAlertPolicyData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

示例响应

状态代码:: 200

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.Sql/servers/securityalert-6440/securityAlertPolicies",
      "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",
        "creationTime": "2020-04-03T04:41:33.937Z",
        "emailAccountAdmins": true,
        "emailAddresses": [
          "test@consoto.com;user@consoto.com"
        ],
        "disabledAlerts": [
          "Access_Anomaly"
        ],
        "retentionDays": 0,
        "storageAccountAccessKey": "",
        "storageEndpoint": "https://mystorage.blob.core.windows.net"
      }
    }
  ]
}

定义

名称	说明
createdByType	创建资源的标识的类型。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
LogicalServerSecurityAlertPolicyListResult	服务器的安全警报策略列表。
SecurityAlertsPolicyState	指定策略的状态，无论是启用或禁用还是尚未对特定数据库应用策略。
ServerSecurityAlertPolicy	服务器安全警报策略。
systemData	与创建和上次修改资源相关的元数据。

createdByType

枚举

创建资源的标识的类型。

值	说明
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

LogicalServerSecurityAlertPolicyListResult

Object

服务器的安全警报策略列表。

名称	类型	说明
nextLink	string	用于检索下一页结果的链接。
value	ServerSecurityAlertPolicy[]	结果数组。

SecurityAlertsPolicyState

枚举

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

值	说明
Enabled
Disabled

ServerSecurityAlertPolicy

Object

服务器安全警报策略。

名称	类型	说明
id	string	资源 ID。
name	string	资源名称。
properties.creationTime	string (date-time)	指定策略的 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 (int32)	指定要保留在威胁检测审核日志中的天数。
properties.state	SecurityAlertsPolicyState	指定策略的状态，无论是启用或禁用还是尚未对特定数据库应用策略。
properties.storageAccountAccessKey	string	指定威胁检测审核存储帐户的标识符密钥。
properties.storageEndpoint	string	指定 blob 存储终结点（例如 `https://MyAccount.blob.core.windows.net`）。此 Blob 存储将保存所有威胁检测审核日志。
systemData	systemData	SecurityAlertPolicyResource 的 SystemData。
type	string	资源类型。

systemData

Object

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

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

通过

Server Security Alert Policies - List By Server

URI 参数

响应

示例

List the server's threat detection policies

示例请求

示例响应

定义

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

LogicalServerSecurityAlertPolicyListResult

SecurityAlertsPolicyState

ServerSecurityAlertPolicy

systemData