microsoft.insights/actionGroups 2018-03-01 - Bicep, ARM template & Terraform AzAPI reference

Bicep 资源定义

可以使用目标操作部署 actionGroups 资源类型：

资源组 - 请参阅资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅更改日志。

资源格式

若要创建 microsoft.insights/actionGroups 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'microsoft.insights/actionGroups@2018-03-01' = {
  location: 'string'
  name: 'string'
  properties: {
    automationRunbookReceivers: [
      {
        automationAccountId: 'string'
        isGlobalRunbook: bool
        name: 'string'
        runbookName: 'string'
        serviceUri: 'string'
        webhookResourceId: 'string'
      }
    ]
    azureAppPushReceivers: [
      {
        emailAddress: 'string'
        name: 'string'
      }
    ]
    azureFunctionReceivers: [
      {
        functionAppResourceId: 'string'
        functionName: 'string'
        httpTriggerUrl: 'string'
        name: 'string'
      }
    ]
    emailReceivers: [
      {
        emailAddress: 'string'
        name: 'string'
      }
    ]
    enabled: bool
    groupShortName: 'string'
    itsmReceivers: [
      {
        connectionId: 'string'
        name: 'string'
        region: 'string'
        ticketConfiguration: 'string'
        workspaceId: 'string'
      }
    ]
    logicAppReceivers: [
      {
        callbackUrl: 'string'
        name: 'string'
        resourceId: 'string'
      }
    ]
    smsReceivers: [
      {
        countryCode: 'string'
        name: 'string'
        phoneNumber: 'string'
      }
    ]
    voiceReceivers: [
      {
        countryCode: 'string'
        name: 'string'
        phoneNumber: 'string'
      }
    ]
    webhookReceivers: [
      {
        name: 'string'
        serviceUri: 'string'
      }
    ]
  }
  tags: {
    {customized property}: 'string'
  }
}

属性值

ActionGroup

名字	描述	价值
automationRunbookReceivers	属于此操作组的 AutomationRunbook 接收器的列表。	AutomationRunbookReceiver[]
azureAppPushReceivers	属于此操作组的 AzureAppPush 接收器列表。	AzureAppPushReceiver[]
azureFunctionReceivers	属于此操作组的 Azure 函数接收器的列表。	AzureFunctionReceiver[]
emailReceivers	属于此操作组的电子邮件接收方列表。	EmailReceiver[]
启用	指示是否启用此操作组。如果未启用操作组，则其接收方不会接收通信。	bool （必需）
groupShortName	操作组的短名称。这将在短信中使用。	字符串约束：最大长度 = 12 （必需）
itsmReceivers	属于此操作组的 ITSM 接收器的列表。	ItsmReceiver[]
logicAppReceivers	属于此操作组的逻辑应用接收器列表。	LogicAppReceiver[]
smsReceivers	属于此操作组的 SMS 接收器列表。	SmsReceiver[]
voiceReceivers	属于此操作组的语音接收器列表。	VoiceReceiver[]
webhookReceivers	属于此操作组的 Webhook 接收器列表。	WebhookReceiver[]

AutomationRunbookReceiver

名字	描述	价值
automationAccountId	保存此 Runbook 并向 Azure 资源进行身份验证的 Azure 自动化帐户 ID。	string （必需）
isGlobalRunbook	指示此实例是否为全局 Runbook。	bool （必需）
名字	指示 Webhook 的名称。	字符串
runbookName	此 Runbook 的名称。	string （必需）
serviceUri	应在其中发送 Webhook 的 URI。	字符串
webhookResourceId	链接到此 Runbook 的 Webhook 的资源 ID。	string （必需）

AzureAppPushReceiver

名字	描述	价值
emailAddress	为 Azure 移动应用注册的电子邮件地址。	string （必需）
名字	Azure 移动应用推送接收器的名称。名称在操作组内的所有接收方中必须是唯一的。	string （必需）

AzureFunctionReceiver

名字	描述	价值
functionAppResourceId	函数应用的 Azure 资源 ID。	string （必需）
functionName	函数应用中的函数名称。	string （必需）
httpTriggerUrl	HTTP 请求发送到的 http 触发器 URL。	string （必需）
名字	Azure 函数接收器的名称。名称在操作组内的所有接收方中必须是唯一的。	string （必需）

EmailReceiver

名字	描述	价值
emailAddress	此接收方的电子邮件地址。	string （必需）
名字	电子邮件接收方的名称。名称在操作组内的所有接收方中必须是唯一的。	string （必需）

ItsmReceiver

名字	描述	价值
connectionId	在上述工作区中定义的多个项中唯一标识 ITSM 连接。	string （必需）
名字	Itsm 接收器的名称。名称在操作组内的所有接收方中必须是唯一的。	string （必需）
地区	工作区所在的区域。支持的值：'centralindia'、'japaneast'、'southeastasia'、'australiasoutheast'、'uksouth'、'westcentralus'、'canadacentral'、'eastus'、'westeurope'	string （必需）
ticketConfiguration	ITSM 操作配置的 JSON Blob。 CreateMultipleWorkItems 选项也将是此 Blob 的一部分。	string （必需）
workspaceId	OMS LA 实例标识符。	string （必需）

LogicAppReceiver

名字	描述	价值
callbackUrl	http 请求发送到的回调 URL。	string （必需）
名字	逻辑应用接收器的名称。名称在操作组内的所有接收方中必须是唯一的。	string （必需）
resourceId	逻辑应用接收器的 Azure 资源 ID。	string （必需）

microsoft.insights/actionGroups

名字	描述	价值
位置	资源位置	string （必需）
名字	资源名称	string （必需）
性能	操作对资源的属性进行分组。	ActionGroup
标签	资源标记	标记名称和值的字典。请参阅模板中的标记

ResourceTags

名字	描述	价值

SmsReceiver

名字	描述	价值
countryCode	短信接收方的国家/地区代码。	string （必需）
名字	短信接收方的名称。名称在操作组内的所有接收方中必须是唯一的。	string （必需）
phoneNumber	SMS 接收器的电话号码。	string （必需）

VoiceReceiver

名字	描述	价值
countryCode	语音接收器的国家/地区代码。	string （必需）
名字	语音接收器的名称。名称在操作组内的所有接收方中必须是唯一的。	string （必需）
phoneNumber	语音接收器的电话号码。	string （必需）

WebhookReceiver

名字	描述	价值
名字	Webhook 接收器的名称。名称在操作组内的所有接收方中必须是唯一的。	string （必需）
serviceUri	应在其中发送 Webhook 的 URI。	string （必需）

快速入门示例

以下快速入门示例部署此资源类型。

Bicep 文件	描述
使用 NAT 网关和应用程序网关 AKS 群集	此示例演示如何使用 NAT 网关部署 AKS 群集进行出站连接，以及如何为入站连接部署应用程序网关。
使用应用程序网关入口控制器 AKS 群集	此示例演示如何使用应用程序网关、应用程序网关入口控制器、Azure 容器注册表、Log Analytics 和 Key Vault 部署 AKS 群集
在 Azure 上创建新的操作组	此模板在 Azure 上创建新的操作组，然后可以使用此操作组在 Azure 上配置警报。
创建 Azure 服务警报	此模板创建一个 Azure 服务运行状况警报，该警报可以选择在发生 Azure 服务中断时向服务管理员和指定电子邮件地址发送电子邮件。
部署 Application Insight 并在其中创建警报	使用此模板可以部署 Application Insight 并在其中创建警报
使用 Azure Monitor 为备份警报设置通知	通过此模板，可以使用 Azure Monitor 为恢复服务保管库设置电子邮件通知，方法是部署警报处理规则和操作组

ARM 模板资源定义

可以使用目标操作部署 actionGroups 资源类型：

资源组 - 请参阅资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅更改日志。

资源格式

若要创建 microsoft.insights/actionGroups 资源，请将以下 JSON 添加到模板。

{
  "type": "microsoft.insights/actionGroups",
  "apiVersion": "2018-03-01",
  "name": "string",
  "location": "string",
  "properties": {
    "automationRunbookReceivers": [
      {
        "automationAccountId": "string",
        "isGlobalRunbook": "bool",
        "name": "string",
        "runbookName": "string",
        "serviceUri": "string",
        "webhookResourceId": "string"
      }
    ],
    "azureAppPushReceivers": [
      {
        "emailAddress": "string",
        "name": "string"
      }
    ],
    "azureFunctionReceivers": [
      {
        "functionAppResourceId": "string",
        "functionName": "string",
        "httpTriggerUrl": "string",
        "name": "string"
      }
    ],
    "emailReceivers": [
      {
        "emailAddress": "string",
        "name": "string"
      }
    ],
    "enabled": "bool",
    "groupShortName": "string",
    "itsmReceivers": [
      {
        "connectionId": "string",
        "name": "string",
        "region": "string",
        "ticketConfiguration": "string",
        "workspaceId": "string"
      }
    ],
    "logicAppReceivers": [
      {
        "callbackUrl": "string",
        "name": "string",
        "resourceId": "string"
      }
    ],
    "smsReceivers": [
      {
        "countryCode": "string",
        "name": "string",
        "phoneNumber": "string"
      }
    ],
    "voiceReceivers": [
      {
        "countryCode": "string",
        "name": "string",
        "phoneNumber": "string"
      }
    ],
    "webhookReceivers": [
      {
        "name": "string",
        "serviceUri": "string"
      }
    ]
  },
  "tags": {
    "{customized property}": "string"
  }
}

属性值

ActionGroup

名字	描述	价值
automationRunbookReceivers	属于此操作组的 AutomationRunbook 接收器的列表。	AutomationRunbookReceiver[]
azureAppPushReceivers	属于此操作组的 AzureAppPush 接收器列表。	AzureAppPushReceiver[]
azureFunctionReceivers	属于此操作组的 Azure 函数接收器的列表。	AzureFunctionReceiver[]
emailReceivers	属于此操作组的电子邮件接收方列表。	EmailReceiver[]
启用	指示是否启用此操作组。如果未启用操作组，则其接收方不会接收通信。	bool （必需）
groupShortName	操作组的短名称。这将在短信中使用。	字符串约束：最大长度 = 12 （必需）
itsmReceivers	属于此操作组的 ITSM 接收器的列表。	ItsmReceiver[]
logicAppReceivers	属于此操作组的逻辑应用接收器列表。	LogicAppReceiver[]
smsReceivers	属于此操作组的 SMS 接收器列表。	SmsReceiver[]
voiceReceivers	属于此操作组的语音接收器列表。	VoiceReceiver[]
webhookReceivers	属于此操作组的 Webhook 接收器列表。	WebhookReceiver[]

AutomationRunbookReceiver

名字	描述	价值
automationAccountId	保存此 Runbook 并向 Azure 资源进行身份验证的 Azure 自动化帐户 ID。	string （必需）
isGlobalRunbook	指示此实例是否为全局 Runbook。	bool （必需）
名字	指示 Webhook 的名称。	字符串
runbookName	此 Runbook 的名称。	string （必需）
serviceUri	应在其中发送 Webhook 的 URI。	字符串
webhookResourceId	链接到此 Runbook 的 Webhook 的资源 ID。	string （必需）

AzureAppPushReceiver

名字	描述	价值
emailAddress	为 Azure 移动应用注册的电子邮件地址。	string （必需）
名字	Azure 移动应用推送接收器的名称。名称在操作组内的所有接收方中必须是唯一的。	string （必需）

AzureFunctionReceiver

名字	描述	价值
functionAppResourceId	函数应用的 Azure 资源 ID。	string （必需）
functionName	函数应用中的函数名称。	string （必需）
httpTriggerUrl	HTTP 请求发送到的 http 触发器 URL。	string （必需）
名字	Azure 函数接收器的名称。名称在操作组内的所有接收方中必须是唯一的。	string （必需）

EmailReceiver

名字	描述	价值
emailAddress	此接收方的电子邮件地址。	string （必需）
名字	电子邮件接收方的名称。名称在操作组内的所有接收方中必须是唯一的。	string （必需）

ItsmReceiver

名字	描述	价值
connectionId	在上述工作区中定义的多个项中唯一标识 ITSM 连接。	string （必需）
名字	Itsm 接收器的名称。名称在操作组内的所有接收方中必须是唯一的。	string （必需）
地区	工作区所在的区域。支持的值：'centralindia'、'japaneast'、'southeastasia'、'australiasoutheast'、'uksouth'、'westcentralus'、'canadacentral'、'eastus'、'westeurope'	string （必需）
ticketConfiguration	ITSM 操作配置的 JSON Blob。 CreateMultipleWorkItems 选项也将是此 Blob 的一部分。	string （必需）
workspaceId	OMS LA 实例标识符。	string （必需）

LogicAppReceiver

名字	描述	价值
callbackUrl	http 请求发送到的回调 URL。	string （必需）
名字	逻辑应用接收器的名称。名称在操作组内的所有接收方中必须是唯一的。	string （必需）
resourceId	逻辑应用接收器的 Azure 资源 ID。	string （必需）

microsoft.insights/actionGroups

名字	描述	价值
apiVersion	API 版本	'2018-03-01'
位置	资源位置	string （必需）
名字	资源名称	string （必需）
性能	操作对资源的属性进行分组。	ActionGroup
标签	资源标记	标记名称和值的字典。请参阅模板中的标记
类型	资源类型	“microsoft.insights/actionGroups”

ResourceTags

名字	描述	价值

SmsReceiver

名字	描述	价值
countryCode	短信接收方的国家/地区代码。	string （必需）
名字	短信接收方的名称。名称在操作组内的所有接收方中必须是唯一的。	string （必需）
phoneNumber	SMS 接收器的电话号码。	string （必需）

VoiceReceiver

名字	描述	价值
countryCode	语音接收器的国家/地区代码。	string （必需）
名字	语音接收器的名称。名称在操作组内的所有接收方中必须是唯一的。	string （必需）
phoneNumber	语音接收器的电话号码。	string （必需）

WebhookReceiver

名字	描述	价值
名字	Webhook 接收器的名称。名称在操作组内的所有接收方中必须是唯一的。	string （必需）
serviceUri	应在其中发送 Webhook 的 URI。	string （必需）

快速入门模板

以下快速入门模板部署此资源类型。

模板	描述
使用 NAT 网关和应用程序网关 AKS 群集	此示例演示如何使用 NAT 网关部署 AKS 群集进行出站连接，以及如何为入站连接部署应用程序网关。
使用应用程序网关入口控制器 AKS 群集	此示例演示如何使用应用程序网关、应用程序网关入口控制器、Azure 容器注册表、Log Analytics 和 Key Vault 部署 AKS 群集
BrowserBox Azure Edition	此模板在 Azure Ubuntu Server 22.04 LTS、Debian 11 或 RHEL 8.7 LVM VM 上部署 BrowserBox。
在 Azure 上创建新的操作组	此模板在 Azure 上创建新的操作组，然后可以使用此操作组在 Azure 上配置警报。
创建 Azure 服务警报	此模板创建一个 Azure 服务运行状况警报，该警报可以选择在发生 Azure 服务中断时向服务管理员和指定电子邮件地址发送电子邮件。
部署服务运行状况警报	使用此模板可以部署一个简单的警报，该警报使用操作组向 Azure 活动日志中的任何服务运行状况记录发送电子邮件通知
部署自动缩放活动日志警报	使用此模板可以部署一个简单的警报，该警报使用操作组向 Azure 活动日志中的任何自动缩放记录发送电子邮件通知
部署自动缩放失败的活动日志警报	使用此模板可以部署一个简单的警报，该警报使用操作组向 Azure 活动日志中任何失败的自动缩放记录发送电子邮件通知
部署 Application Insight 并在其中创建警报	使用此模板可以部署 Application Insight 并在其中创建警报
动态 Web 测试创建	创建任意数量的 App Insights Web （ping）测试。
Enterprise Governance-AppService、SQL DB、AD、OMS、Runbook	企业（小型或大型）的云采用需要负责任的高效治理模型才能从其云部署中派生价值。 CloudWise（解决方案的代码名称）是 Azure 合作伙伴快速入门中提供的复合解决方案，是客户、系统集成商和合作伙伴的采用启用器，它提供可自助、自动化的治理和运营解决方案，侧重于优化成本、提高应用程序的可靠性、降低业务风险。该解决方案重点介绍了可见性和控制的核心治理支柱。
可缩放的 Umbraco CMS Web 应用	此模板提供了在 Azure 应用服务 Web 应用上部署 umbraco CMS Web 应用的简单方法。
使用 Azure Monitor 为备份警报设置通知	通过此模板，可以使用 Azure Monitor 为恢复服务保管库设置电子邮件通知，方法是部署警报处理规则和操作组

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署 actionGroups 资源类型：

资源组

有关每个 API 版本中已更改属性的列表，请参阅更改日志。

资源格式

若要创建 microsoft.insights/actionGroups 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "microsoft.insights/actionGroups@2018-03-01"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      automationRunbookReceivers = [
        {
          automationAccountId = "string"
          isGlobalRunbook = bool
          name = "string"
          runbookName = "string"
          serviceUri = "string"
          webhookResourceId = "string"
        }
      ]
      azureAppPushReceivers = [
        {
          emailAddress = "string"
          name = "string"
        }
      ]
      azureFunctionReceivers = [
        {
          functionAppResourceId = "string"
          functionName = "string"
          httpTriggerUrl = "string"
          name = "string"
        }
      ]
      emailReceivers = [
        {
          emailAddress = "string"
          name = "string"
        }
      ]
      enabled = bool
      groupShortName = "string"
      itsmReceivers = [
        {
          connectionId = "string"
          name = "string"
          region = "string"
          ticketConfiguration = "string"
          workspaceId = "string"
        }
      ]
      logicAppReceivers = [
        {
          callbackUrl = "string"
          name = "string"
          resourceId = "string"
        }
      ]
      smsReceivers = [
        {
          countryCode = "string"
          name = "string"
          phoneNumber = "string"
        }
      ]
      voiceReceivers = [
        {
          countryCode = "string"
          name = "string"
          phoneNumber = "string"
        }
      ]
      webhookReceivers = [
        {
          name = "string"
          serviceUri = "string"
        }
      ]
    }
  })
}

属性值

ActionGroup

名字	描述	价值
automationRunbookReceivers	属于此操作组的 AutomationRunbook 接收器的列表。	AutomationRunbookReceiver[]
azureAppPushReceivers	属于此操作组的 AzureAppPush 接收器列表。	AzureAppPushReceiver[]
azureFunctionReceivers	属于此操作组的 Azure 函数接收器的列表。	AzureFunctionReceiver[]
emailReceivers	属于此操作组的电子邮件接收方列表。	EmailReceiver[]
启用	指示是否启用此操作组。如果未启用操作组，则其接收方不会接收通信。	bool （必需）
groupShortName	操作组的短名称。这将在短信中使用。	字符串约束：最大长度 = 12 （必需）
itsmReceivers	属于此操作组的 ITSM 接收器的列表。	ItsmReceiver[]
logicAppReceivers	属于此操作组的逻辑应用接收器列表。	LogicAppReceiver[]
smsReceivers	属于此操作组的 SMS 接收器列表。	SmsReceiver[]
voiceReceivers	属于此操作组的语音接收器列表。	VoiceReceiver[]
webhookReceivers	属于此操作组的 Webhook 接收器列表。	WebhookReceiver[]

AutomationRunbookReceiver

名字	描述	价值
automationAccountId	保存此 Runbook 并向 Azure 资源进行身份验证的 Azure 自动化帐户 ID。	string （必需）
isGlobalRunbook	指示此实例是否为全局 Runbook。	bool （必需）
名字	指示 Webhook 的名称。	字符串
runbookName	此 Runbook 的名称。	string （必需）
serviceUri	应在其中发送 Webhook 的 URI。	字符串
webhookResourceId	链接到此 Runbook 的 Webhook 的资源 ID。	string （必需）

AzureAppPushReceiver

名字	描述	价值
emailAddress	为 Azure 移动应用注册的电子邮件地址。	string （必需）
名字	Azure 移动应用推送接收器的名称。名称在操作组内的所有接收方中必须是唯一的。	string （必需）

AzureFunctionReceiver

名字	描述	价值
functionAppResourceId	函数应用的 Azure 资源 ID。	string （必需）
functionName	函数应用中的函数名称。	string （必需）
httpTriggerUrl	HTTP 请求发送到的 http 触发器 URL。	string （必需）
名字	Azure 函数接收器的名称。名称在操作组内的所有接收方中必须是唯一的。	string （必需）

EmailReceiver

名字	描述	价值
emailAddress	此接收方的电子邮件地址。	string （必需）
名字	电子邮件接收方的名称。名称在操作组内的所有接收方中必须是唯一的。	string （必需）

ItsmReceiver

名字	描述	价值
connectionId	在上述工作区中定义的多个项中唯一标识 ITSM 连接。	string （必需）
名字	Itsm 接收器的名称。名称在操作组内的所有接收方中必须是唯一的。	string （必需）
地区	工作区所在的区域。支持的值：'centralindia'、'japaneast'、'southeastasia'、'australiasoutheast'、'uksouth'、'westcentralus'、'canadacentral'、'eastus'、'westeurope'	string （必需）
ticketConfiguration	ITSM 操作配置的 JSON Blob。 CreateMultipleWorkItems 选项也将是此 Blob 的一部分。	string （必需）
workspaceId	OMS LA 实例标识符。	string （必需）

LogicAppReceiver

名字	描述	价值
callbackUrl	http 请求发送到的回调 URL。	string （必需）
名字	逻辑应用接收器的名称。名称在操作组内的所有接收方中必须是唯一的。	string （必需）
resourceId	逻辑应用接收器的 Azure 资源 ID。	string （必需）

microsoft.insights/actionGroups

名字	描述	价值
位置	资源位置	string （必需）
名字	资源名称	string （必需）
性能	操作对资源的属性进行分组。	ActionGroup
标签	资源标记	标记名称和值的字典。
类型	资源类型	“microsoft.insights/actionGroups@2018-03-01”

ResourceTags

名字	描述	价值

SmsReceiver

名字	描述	价值
countryCode	短信接收方的国家/地区代码。	string （必需）
名字	短信接收方的名称。名称在操作组内的所有接收方中必须是唯一的。	string （必需）
phoneNumber	SMS 接收器的电话号码。	string （必需）

VoiceReceiver

名字	描述	价值
countryCode	语音接收器的国家/地区代码。	string （必需）
名字	语音接收器的名称。名称在操作组内的所有接收方中必须是唯一的。	string （必需）
phoneNumber	语音接收器的电话号码。	string （必需）

WebhookReceiver

名字	描述	价值
名字	Webhook 接收器的名称。名称在操作组内的所有接收方中必须是唯一的。	string （必需）
serviceUri	应在其中发送 Webhook 的 URI。	string （必需）

通过

microsoft.insights actionGroups 2018-03-01

言论

Bicep 资源定义

资源格式

属性值

ActionGroup

AutomationRunbookReceiver

AzureAppPushReceiver

AzureFunctionReceiver

EmailReceiver

ItsmReceiver

LogicAppReceiver

microsoft.insights/actionGroups

ResourceTags

SmsReceiver

VoiceReceiver

WebhookReceiver

快速入门示例

ARM 模板资源定义

资源格式

属性值

ActionGroup

AutomationRunbookReceiver

AzureAppPushReceiver

AzureFunctionReceiver

EmailReceiver

ItsmReceiver

LogicAppReceiver

microsoft.insights/actionGroups

ResourceTags

SmsReceiver

VoiceReceiver

WebhookReceiver

快速入门模板

Terraform （AzAPI 提供程序）资源定义

资源格式

属性值

ActionGroup

AutomationRunbookReceiver

AzureAppPushReceiver

AzureFunctionReceiver

EmailReceiver

ItsmReceiver

LogicAppReceiver

microsoft.insights/actionGroups

ResourceTags

SmsReceiver

VoiceReceiver

WebhookReceiver

反馈

其他资源