你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
microsoft.insights actionGroups 2019-03-01
Bicep 资源定义
actionGroups 资源类型可以通过针对以下操作进行部署:
有关每个 API 版本中更改的属性的列表,请参阅 更改日志。
有关部署监视解决方案的指南,请参阅 使用 Bicep 创建监视资源。
若要创建 microsoft.insights/actionGroups 资源,请将以下 Bicep 添加到模板。
resource symbolicname 'microsoft.insights/actionGroups@2019-03-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
properties: {
armRoleReceivers: [
{
name: 'string'
roleId: 'string'
useCommonAlertSchema: bool
}
]
automationRunbookReceivers: [
{
automationAccountId: 'string'
isGlobalRunbook: bool
name: 'string'
runbookName: 'string'
serviceUri: 'string'
useCommonAlertSchema: bool
webhookResourceId: 'string'
}
]
azureAppPushReceivers: [
{
emailAddress: 'string'
name: 'string'
}
]
azureFunctionReceivers: [
{
functionAppResourceId: 'string'
functionName: 'string'
httpTriggerUrl: 'string'
name: 'string'
useCommonAlertSchema: bool
}
]
emailReceivers: [
{
emailAddress: 'string'
name: 'string'
useCommonAlertSchema: bool
}
]
enabled: bool
groupShortName: 'string'
itsmReceivers: [
{
connectionId: 'string'
name: 'string'
region: 'string'
ticketConfiguration: 'string'
workspaceId: 'string'
}
]
logicAppReceivers: [
{
callbackUrl: 'string'
name: 'string'
resourceId: 'string'
useCommonAlertSchema: bool
}
]
smsReceivers: [
{
countryCode: 'string'
name: 'string'
phoneNumber: 'string'
}
]
voiceReceivers: [
{
countryCode: 'string'
name: 'string'
phoneNumber: 'string'
}
]
webhookReceivers: [
{
name: 'string'
serviceUri: 'string'
useCommonAlertSchema: bool
}
]
}
}
属性值
actionGroups
名称 |
说明 |
值 |
name |
资源名称 |
字符串 (必需)
字符限制:1-260
有效字符: 不得使用:
:<>+/&%\? 或控制字符
不得以空格或句点结尾。 |
location |
资源位置 |
字符串 (必需) |
标记 |
资源标记 |
标记名称和值的字典。 请参阅 模板中的标记 |
properties |
操作对资源的属性进行分组。 |
ActionGroup |
ActionGroup
ArmRoleReceiver
名称 |
说明 |
值 |
name |
arm 角色接收器的名称。 名称在操作组内的所有接收器中必须是唯一的。 |
字符串 (必需) |
roleId |
arm 角色 ID。 |
字符串 (必需) |
useCommonAlertSchema |
指示是否使用通用警报架构。 |
bool |
AutomationRunbookReceiver
名称 |
说明 |
值 |
automationAccountId |
保存此 Runbook 并验证 Azure 资源的 Azure 自动化帐户 ID。 |
字符串 (必需) |
isGlobalRunbook |
指示此实例是否为全局 Runbook。 |
需要 bool () |
name |
指示 Webhook 的名称。 |
string |
runbookName |
此 Runbook 的名称。 |
字符串 (必需) |
serviceUri |
应在其中发送 Webhook 的 URI。 |
字符串 |
useCommonAlertSchema |
指示是否使用通用警报架构。 |
bool |
webhookResourceId |
链接到此 Runbook 的 Webhook 的资源 ID。 |
字符串 (必需) |
AzureAppPushReceiver
名称 |
说明 |
值 |
emailAddress |
为 Azure 移动应用注册的电子邮件地址。 |
字符串 (必需) |
name |
Azure 移动应用推送接收器的名称。 名称在操作组内的所有接收方中必须是唯一的。 |
字符串 (必需) |
AzureFunctionReceiver
名称 |
说明 |
值 |
functionAppResourceId |
函数应用的 azure 资源 ID。 |
字符串 (必需) |
functionName |
函数应用中的函数名称。 |
字符串 (必需) |
httpTriggerUrl |
http 请求发送到的 http 触发器 URL。 |
字符串 (必需) |
name |
azure 函数接收器的名称。 名称在操作组内的所有接收方中必须是唯一的。 |
字符串 (必需) |
useCommonAlertSchema |
指示是否使用通用警报架构。 |
bool |
EmailReceiver
名称 |
说明 |
值 |
emailAddress |
此接收方的电子邮件地址。 |
字符串 (必需) |
name |
电子邮件接收方的名称。 名称在操作组内的所有接收方中必须是唯一的。 |
字符串 (必需) |
useCommonAlertSchema |
指示是否使用通用警报架构。 |
bool |
ItsmReceiver
名称 |
说明 |
值 |
connectionId |
在上述工作区中定义的多个之间唯一标识 ITSM 连接。 |
字符串 (必需) |
name |
Itsm 接收器的名称。 名称在操作组内的所有接收方中必须是唯一的。 |
字符串 (必需) |
region |
工作区所在的区域。 支持的值:'centralindia'、'japaneast'、'southeastasia'、'australiasoutheast'、'uksouth'、'westcentralus'、'canadacentral'、'eastus'、'westeurope' |
字符串 (必需) |
ticketConfiguration |
ITSM 操作配置的 JSON Blob。 CreateMultipleWorkItems 选项也将是此 Blob 的一部分。 |
字符串 (必需) |
workspaceId |
OMS LA 实例标识符。 |
字符串 (必需) |
LogicAppReceiver
名称 |
说明 |
值 |
callbackUrl |
http 请求发送到的回调 URL。 |
字符串 (必需) |
name |
逻辑应用接收器的名称。 名称在操作组内的所有接收器中必须是唯一的。 |
字符串 (必需) |
ResourceId |
逻辑应用接收器的 azure 资源 ID。 |
字符串 (必需) |
useCommonAlertSchema |
指示是否使用通用警报架构。 |
bool |
SmsReceiver
名称 |
说明 |
值 |
countryCode |
短信接收方的国家/地区代码。 |
字符串 (必需) |
name |
短信接收方的名称。 名称在操作组内的所有接收器中必须是唯一的。 |
字符串 (必需) |
phoneNumber |
短信接收方的电话号码。 |
字符串 (必需) |
VoiceReceiver
名称 |
说明 |
值 |
countryCode |
语音接收器的国家/地区代码。 |
字符串 (必需) |
name |
语音接收器的名称。 名称在操作组内的所有接收器中必须是唯一的。 |
字符串 (必需) |
phoneNumber |
语音接收器的电话号码。 |
字符串 (必需) |
WebhookReceiver
名称 |
说明 |
值 |
name |
Webhook 接收器的名称。 名称在操作组内的所有接收器中必须是唯一的。 |
字符串 (必需) |
serviceUri |
应在其中发送 Webhook 的 URI。 |
字符串 (必需) |
useCommonAlertSchema |
指示是否使用通用警报架构。 |
bool |
快速入门模板
以下快速入门模板部署此资源类型。
ARM 模板资源定义
actionGroups 资源类型可以通过针对以下操作进行部署:
有关每个 API 版本中更改的属性的列表,请参阅 更改日志。
有关部署监视解决方案的指南,请参阅 使用 Bicep 创建监视资源。
若要创建 microsoft.insights/actionGroups 资源,请将以下 JSON 添加到模板。
{
"type": "microsoft.insights/actionGroups",
"apiVersion": "2019-03-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"armRoleReceivers": [
{
"name": "string",
"roleId": "string",
"useCommonAlertSchema": "bool"
}
],
"automationRunbookReceivers": [
{
"automationAccountId": "string",
"isGlobalRunbook": "bool",
"name": "string",
"runbookName": "string",
"serviceUri": "string",
"useCommonAlertSchema": "bool",
"webhookResourceId": "string"
}
],
"azureAppPushReceivers": [
{
"emailAddress": "string",
"name": "string"
}
],
"azureFunctionReceivers": [
{
"functionAppResourceId": "string",
"functionName": "string",
"httpTriggerUrl": "string",
"name": "string",
"useCommonAlertSchema": "bool"
}
],
"emailReceivers": [
{
"emailAddress": "string",
"name": "string",
"useCommonAlertSchema": "bool"
}
],
"enabled": "bool",
"groupShortName": "string",
"itsmReceivers": [
{
"connectionId": "string",
"name": "string",
"region": "string",
"ticketConfiguration": "string",
"workspaceId": "string"
}
],
"logicAppReceivers": [
{
"callbackUrl": "string",
"name": "string",
"resourceId": "string",
"useCommonAlertSchema": "bool"
}
],
"smsReceivers": [
{
"countryCode": "string",
"name": "string",
"phoneNumber": "string"
}
],
"voiceReceivers": [
{
"countryCode": "string",
"name": "string",
"phoneNumber": "string"
}
],
"webhookReceivers": [
{
"name": "string",
"serviceUri": "string",
"useCommonAlertSchema": "bool"
}
]
}
}
属性值
actionGroups
名称 |
说明 |
Value |
type |
资源类型 |
'microsoft.insights/actionGroups' |
apiVersion |
资源 API 版本 |
'2019-03-01' |
name |
资源名称 |
字符串 (必需)
字符限制:1-260
有效字符: 不得使用:
:<>+/&%\? 或控制字符
不得以空格或句点结尾。 |
location |
资源位置 |
字符串 (必需) |
标记 |
资源标记 |
标记名称和值的字典。 请参阅 模板中的标记 |
properties |
操作对资源的属性进行分组。 |
ActionGroup |
ActionGroup
ArmRoleReceiver
名称 |
说明 |
值 |
name |
arm 角色接收器的名称。 名称在操作组内的所有接收器中必须是唯一的。 |
字符串 (必需) |
roleId |
arm 角色 ID。 |
字符串 (必需) |
useCommonAlertSchema |
指示是否使用通用警报架构。 |
bool |
AutomationRunbookReceiver
名称 |
说明 |
值 |
automationAccountId |
保存此 Runbook 并向 Azure 资源进行身份验证的 Azure 自动化帐户 ID。 |
字符串 (必需) |
isGlobalRunbook |
指示此实例是否为全局 Runbook。 |
bool (必需) |
name |
指示 Webhook 的名称。 |
字符串 |
RunbookName |
此 Runbook 的名称。 |
字符串 (必需) |
serviceUri |
应在其中发送 Webhook 的 URI。 |
string |
useCommonAlertSchema |
指示是否使用通用警报架构。 |
bool |
webhookResourceId |
链接到此 Runbook 的 Webhook 的资源 ID。 |
字符串 (必需) |
AzureAppPushReceiver
名称 |
说明 |
值 |
emailAddress |
为 Azure 移动应用注册的电子邮件地址。 |
字符串 (必需) |
name |
Azure 移动应用推送接收器的名称。 名称在操作组内的所有接收器中必须是唯一的。 |
字符串 (必需) |
AzureFunctionReceiver
名称 |
说明 |
值 |
functionAppResourceId |
函数应用的 azure 资源 ID。 |
字符串 (必需) |
functionName |
函数应用中的函数名称。 |
字符串 (必需) |
httpTriggerUrl |
http 请求发送到的 http 触发器 URL。 |
字符串 (必需) |
name |
azure 函数接收器的名称。 名称在操作组内的所有接收器中必须是唯一的。 |
字符串 (必需) |
useCommonAlertSchema |
指示是否使用通用警报架构。 |
bool |
EmailReceiver
名称 |
说明 |
值 |
emailAddress |
此接收方的电子邮件地址。 |
字符串 (必需) |
name |
电子邮件接收方的名称。 名称在操作组内的所有接收器中必须是唯一的。 |
字符串 (必需) |
useCommonAlertSchema |
指示是否使用通用警报架构。 |
bool |
ItsmReceiver
名称 |
说明 |
值 |
connectionId |
在上述工作区中定义的多个之间唯一标识 ITSM 连接。 |
字符串 (必需) |
name |
Itsm 接收器的名称。 名称在操作组内的所有接收器中必须是唯一的。 |
字符串 (必需) |
region |
工作区所在的区域。 支持的值:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope' |
字符串 (必需) |
ticketConfiguration |
用于 ITSM 操作配置的 JSON Blob。 CreateMultipleWorkItems 选项也将是此 Blob 的一部分。 |
字符串 (必需) |
workspaceId |
OMS LA 实例标识符。 |
字符串 (必需) |
LogicAppReceiver
名称 |
说明 |
值 |
callbackUrl |
http 请求发送到的回调 URL。 |
字符串 (必需) |
name |
逻辑应用接收器的名称。 名称在操作组内的所有接收器中必须是唯一的。 |
字符串 (必需) |
ResourceId |
逻辑应用接收器的 azure 资源 ID。 |
字符串 (必需) |
useCommonAlertSchema |
指示是否使用通用警报架构。 |
bool |
SmsReceiver
名称 |
说明 |
值 |
countryCode |
短信接收方的国家/地区代码。 |
字符串 (必需) |
name |
短信接收方的名称。 名称在操作组内的所有接收方中必须是唯一的。 |
字符串 (必需) |
phoneNumber |
短信接收方的电话号码。 |
字符串 (必需) |
VoiceReceiver
名称 |
说明 |
值 |
countryCode |
语音接收器的国家/地区代码。 |
字符串 (必需) |
name |
语音接收器的名称。 名称在操作组内的所有接收方中必须是唯一的。 |
字符串 (必需) |
phoneNumber |
语音接收器的电话号码。 |
字符串 (必需) |
WebhookReceiver
名称 |
说明 |
值 |
name |
Webhook 接收器的名称。 名称在操作组内的所有接收方中必须是唯一的。 |
字符串 (必需) |
serviceUri |
应在其中发送 Webhook 的 URI。 |
字符串 (必需) |
useCommonAlertSchema |
指示是否使用通用警报架构。 |
bool |
快速入门模板
以下快速入门模板部署此资源类型。
actionGroups 资源类型可以使用面向以下对象的操作进行部署:
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
若要创建 microsoft.insights/actionGroups 资源,请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "microsoft.insights/actionGroups@2019-03-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
armRoleReceivers = [
{
name = "string"
roleId = "string"
useCommonAlertSchema = bool
}
]
automationRunbookReceivers = [
{
automationAccountId = "string"
isGlobalRunbook = bool
name = "string"
runbookName = "string"
serviceUri = "string"
useCommonAlertSchema = bool
webhookResourceId = "string"
}
]
azureAppPushReceivers = [
{
emailAddress = "string"
name = "string"
}
]
azureFunctionReceivers = [
{
functionAppResourceId = "string"
functionName = "string"
httpTriggerUrl = "string"
name = "string"
useCommonAlertSchema = bool
}
]
emailReceivers = [
{
emailAddress = "string"
name = "string"
useCommonAlertSchema = bool
}
]
enabled = bool
groupShortName = "string"
itsmReceivers = [
{
connectionId = "string"
name = "string"
region = "string"
ticketConfiguration = "string"
workspaceId = "string"
}
]
logicAppReceivers = [
{
callbackUrl = "string"
name = "string"
resourceId = "string"
useCommonAlertSchema = bool
}
]
smsReceivers = [
{
countryCode = "string"
name = "string"
phoneNumber = "string"
}
]
voiceReceivers = [
{
countryCode = "string"
name = "string"
phoneNumber = "string"
}
]
webhookReceivers = [
{
name = "string"
serviceUri = "string"
useCommonAlertSchema = bool
}
]
}
})
}
属性值
actionGroups
名称 |
说明 |
Value |
type |
资源类型 |
“microsoft.insights/actionGroups@2019-03-01” |
name |
资源名称 |
字符串 (必需)
字符限制:1-260
有效字符: 不得使用:
:<>+/&%\? 或控制字符
不得以空格或句点结尾。 |
location |
资源位置 |
字符串 (必需) |
parent_id |
若要部署到资源组,请使用该资源组的 ID。 |
字符串 (必需) |
标记 |
资源标记 |
标记名称和值的字典。 |
properties |
操作对资源的属性进行分组。 |
ActionGroup |
ActionGroup
ArmRoleReceiver
名称 |
说明 |
值 |
name |
arm 角色接收器的名称。 名称在操作组内的所有接收器中必须是唯一的。 |
字符串 (必需) |
roleId |
arm 角色 ID。 |
字符串 (必需) |
useCommonAlertSchema |
指示是否使用通用警报架构。 |
bool |
AutomationRunbookReceiver
名称 |
说明 |
值 |
automationAccountId |
保存此 Runbook 并向 Azure 资源进行身份验证的 Azure 自动化帐户 ID。 |
字符串 (必需) |
isGlobalRunbook |
指示此实例是否为全局 Runbook。 |
bool (必需) |
name |
指示 Webhook 的名称。 |
字符串 |
RunbookName |
此 Runbook 的名称。 |
字符串 (必需) |
serviceUri |
应在其中发送 Webhook 的 URI。 |
string |
useCommonAlertSchema |
指示是否使用通用警报架构。 |
bool |
webhookResourceId |
链接到此 Runbook 的 Webhook 的资源 ID。 |
字符串 (必需) |
AzureAppPushReceiver
名称 |
说明 |
值 |
emailAddress |
为 Azure 移动应用注册的电子邮件地址。 |
字符串 (必需) |
name |
Azure 移动应用推送接收器的名称。 名称在操作组内的所有接收器中必须是唯一的。 |
字符串 (必需) |
AzureFunctionReceiver
名称 |
说明 |
值 |
functionAppResourceId |
函数应用的 azure 资源 ID。 |
字符串 (必需) |
functionName |
函数应用中的函数名称。 |
字符串 (必需) |
httpTriggerUrl |
http 请求发送到的 http 触发器 URL。 |
字符串 (必需) |
name |
azure 函数接收器的名称。 名称在操作组内的所有接收器中必须是唯一的。 |
字符串 (必需) |
useCommonAlertSchema |
指示是否使用通用警报架构。 |
bool |
EmailReceiver
名称 |
说明 |
值 |
emailAddress |
此接收方的电子邮件地址。 |
字符串 (必需) |
name |
电子邮件接收方的名称。 名称在操作组内的所有接收器中必须是唯一的。 |
字符串 (必需) |
useCommonAlertSchema |
指示是否使用通用警报架构。 |
bool |
ItsmReceiver
名称 |
说明 |
值 |
connectionId |
在上述工作区中定义的多个之间唯一标识 ITSM 连接。 |
字符串 (必需) |
name |
Itsm 接收器的名称。 名称在操作组内的所有接收器中必须是唯一的。 |
字符串 (必需) |
region |
工作区所在的区域。 支持的值:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope' |
字符串 (必需) |
ticketConfiguration |
用于 ITSM 操作配置的 JSON Blob。 CreateMultipleWorkItems 选项也将是此 Blob 的一部分。 |
字符串 (必需) |
workspaceId |
OMS LA 实例标识符。 |
字符串 (必需) |
LogicAppReceiver
名称 |
说明 |
值 |
callbackUrl |
http 请求发送到的回调 URL。 |
字符串 (必需) |
name |
逻辑应用接收器的名称。 名称在操作组内的所有接收器中必须是唯一的。 |
字符串 (必需) |
ResourceId |
逻辑应用接收器的 azure 资源 ID。 |
字符串 (必需) |
useCommonAlertSchema |
指示是否使用通用警报架构。 |
bool |
SmsReceiver
名称 |
说明 |
值 |
countryCode |
短信接收方的国家/地区代码。 |
字符串 (必需) |
name |
短信接收方的名称。 名称在操作组内的所有接收器中必须是唯一的。 |
字符串 (必需) |
phoneNumber |
短信接收方的电话号码。 |
字符串 (必需) |
VoiceReceiver
名称 |
说明 |
值 |
countryCode |
语音接收器的国家/地区代码。 |
字符串 (必需) |
name |
语音接收器的名称。 名称在操作组内的所有接收器中必须是唯一的。 |
字符串 (必需) |
phoneNumber |
语音接收器的电话号码。 |
字符串 (必需) |
WebhookReceiver
名称 |
说明 |
值 |
name |
Webhook 接收器的名称。 名称在操作组内的所有接收器中必须是唯一的。 |
字符串 (必需) |
serviceUri |
应在其中发送 Webhook 的 URI。 |
字符串 (必需) |
useCommonAlertSchema |
指示是否使用通用警报架构。 |
bool |