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

Security Contacts - Create

Create订阅的安全联系人配置

PUT https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Security/securityContacts/default?api-version=2023-12-01-preview

URI 参数

名称 必需 类型 说明
securityContactName
path True

securityContactName

安全联系人对象的名称

Regex pattern: ^(default)$

subscriptionId
path True

string

Azure 订阅 ID

Regex pattern: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$

api-version
query True

string

操作的 API 版本

请求正文

名称 类型 说明
properties.emails

string

将按此安全联系人中定义的配置从 Microsoft Defender for Cloud 接收通知的电子邮件地址列表。

properties.isEnabled

boolean

指示是否启用安全联系人。

properties.notificationsByRole

NotificationsByRole

定义是否将电子邮件通知从 Microsoft Defender for Cloud 发送给订阅中具有特定 RBAC 角色的人员。

properties.notificationsSources NotificationsSource[]:

评估电子邮件通知的源类型的集合。

properties.phone

string

安全联系人的电话号码

响应

名称 类型 说明
200 OK

SecurityContact

确定

201 Created

SecurityContact

创建

Other Status Codes

CloudError

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名称 说明
user_impersonation 模拟用户帐户

示例

Create security contact data

Sample Request

PUT https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/default?api-version=2023-12-01-preview

{
  "properties": {
    "notificationsByRole": {
      "state": "On",
      "roles": [
        "Owner"
      ]
    },
    "isEnabled": true,
    "emails": "john@contoso.com;jane@contoso.com",
    "phone": "(214)275-4038",
    "notificationsSources": [
      {
        "sourceType": "AttackPath",
        "minimalRiskLevel": "Critical"
      },
      {
        "sourceType": "Alert",
        "minimalSeverity": "Medium"
      }
    ]
  }
}

Sample Response

{
  "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/default",
  "name": "default",
  "type": "Microsoft.Security/securityContact",
  "properties": {
    "notificationsByRole": {
      "roles": [
        "Owner"
      ]
    },
    "isEnabled": true,
    "emails": "john@microsoft.com;jane@microsoft.com",
    "phone": "(214)275-4038",
    "notificationsSources": [
      {
        "sourceType": "AttackPath",
        "minimalRiskLevel": "Critical"
      },
      {
        "sourceType": "Alert",
        "minimalSeverity": "Medium"
      }
    ]
  }
}
{
  "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/default",
  "name": "default",
  "type": "Microsoft.Security/securityContact",
  "properties": {
    "notificationsByRole": {
      "state": "On",
      "roles": [
        "Owner"
      ]
    },
    "isEnabled": true,
    "emails": "john@microsoft.com;jane@microsoft.com",
    "phone": "(214)275-4038",
    "notificationsSources": [
      {
        "sourceType": "AttackPath",
        "minimalRiskLevel": "Critical"
      },
      {
        "sourceType": "Alert",
        "minimalSeverity": "Medium"
      }
    ]
  }
}

定义

名称 说明
CloudError

对所有 Azure 资源管理器 API 的常见错误响应,可返回失败操作的错误详细信息。 (这也遵循 OData 错误响应格式.) 。

CloudErrorBody

错误详细信息。

ErrorAdditionalInfo

资源管理错误附加信息。

minimalRiskLevel

定义将作为电子邮件通知发送的最小附加路径风险级别

minimalSeverity
NotificationsByRole

定义是否将电子邮件通知从 Microsoft Defender for Cloud 发送给订阅中具有特定 RBAC 角色的人员。

NotificationsSourceAlert

警报通知源

NotificationsSourceAttackPath

攻击路径通知源

SecurityContact

来自 Microsoft Defender for Cloud 的通知的联系人详细信息和配置。

securityContactName

安全联系人对象的名称

securityContactRole

定义将从 Microsoft Defender for Cloud 获取电子邮件通知的 RBAC 角色。 允许的 RBAC 角色列表:

state

定义是否将 AMicrosoft Defender for Cloud 中的电子邮件通知发送给订阅中具有特定 RBAC 角色的人员。

CloudError

对所有 Azure 资源管理器 API 的常见错误响应,可返回失败操作的错误详细信息。 (这也遵循 OData 错误响应格式.) 。

名称 类型 说明
error.additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

error.code

string

错误代码。

error.details

CloudErrorBody[]

错误详细信息。

error.message

string

错误消息。

error.target

string

错误目标。

CloudErrorBody

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

CloudErrorBody[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。

type

string

其他信息类型。

minimalRiskLevel

定义将作为电子邮件通知发送的最小附加路径风险级别

名称 类型 说明
Critical

string

获取有关具有严重风险级别的新攻击路径的通知

High

string

获取有关具有“高”或“严重”风险级别的新攻击路径的通知

Low

string

获取有关具有低、中、高或严重风险级别的新附加路径的通知

Medium

string

获取有关具有中等、高或严重风险级别的新附加路径的通知

minimalSeverity

名称 类型 说明
High

string

获取有关高严重性的新警报的通知

Low

string

获取有关严重性为“低”、“中”或“高”的新警报的通知

Medium

string

获取有关严重性为“中”或“高”的新警报的通知

NotificationsByRole

定义是否将电子邮件通知从 Microsoft Defender for Cloud 发送给订阅中具有特定 RBAC 角色的人员。

名称 类型 说明
roles

securityContactRole[]

定义将从 Microsoft Defender for Cloud 获取电子邮件通知的 RBAC 角色。 允许的 RBAC 角色列表:

state

state

定义是否将 AMicrosoft Defender for Cloud 中的电子邮件通知发送给订阅中具有特定 RBAC 角色的人员。

NotificationsSourceAlert

警报通知源

名称 类型 说明
minimalSeverity

minimalSeverity

sourceType string:

Alert

将触发通知的源类型

NotificationsSourceAttackPath

攻击路径通知源

名称 类型 说明
minimalRiskLevel

minimalRiskLevel

定义将作为电子邮件通知发送的最小附加路径风险级别

sourceType string:

AttackPath

将触发通知的源类型

SecurityContact

来自 Microsoft Defender for Cloud 的通知的联系人详细信息和配置。

名称 类型 说明
id

string

资源 ID

name

string

资源名称

properties.emails

string

将按此安全联系人中定义的配置从 Microsoft Defender for Cloud 接收通知的电子邮件地址列表。

properties.isEnabled

boolean

指示是否启用安全联系人。

properties.notificationsByRole

NotificationsByRole

定义是否将电子邮件通知从 Microsoft Defender for Cloud 发送给订阅中具有特定 RBAC 角色的人员。

properties.notificationsSources NotificationsSource[]:

评估电子邮件通知的源类型的集合。

properties.phone

string

安全联系人的电话号码

type

string

资源类型

securityContactName

安全联系人对象的名称

名称 类型 说明
default

string

安全联系人对象的单个适用名称

securityContactRole

定义将从 Microsoft Defender for Cloud 获取电子邮件通知的 RBAC 角色。 允许的 RBAC 角色列表:

名称 类型 说明
AccountAdmin

string

如果启用,则向帐户管理员发送有关新警报的通知

Contributor

string

如果启用,则向订阅参与者发送有关新警报的通知

Owner

string

如果启用,则向订阅所有者发送有关新警报的通知

ServiceAdmin

string

如果启用,请向服务管理员发送有关新警报的通知

state

定义是否将 AMicrosoft Defender for Cloud 中的电子邮件通知发送给订阅中具有特定 RBAC 角色的人员。

名称 类型 说明
Off

string

不要向订阅的管理员发送有关新警报的通知

On

string

向订阅的管理员发送有关新警报的通知