microsoft.insights/actionGroups 2017-04-01 - Bicep, ARM template & Terraform AzAPI reference

Bicep 資源定義

actionGroups 資源類型可以使用目標作業來部署：

資源群組 - 請參閱資源群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱變更記錄檔。

資源格式

若要建立 microsoft.insights/actionGroups 資源，請將下列 Bicep 新增至範本。

resource symbolicname 'microsoft.insights/actionGroups@2017-04-01' = {
  location: 'string'
  name: 'string'
  properties: {
    automationRunbookReceivers: [
      {
        automationAccountId: 'string'
        isGlobalRunbook: bool
        name: 'string'
        runbookName: 'string'
        serviceUri: 'string'
        webhookResourceId: 'string'
      }
    ]
    azureAppPushReceivers: [
      {
        emailAddress: 'string'
        name: 'string'
      }
    ]
    emailReceivers: [
      {
        emailAddress: 'string'
        name: 'string'
      }
    ]
    enabled: bool
    groupShortName: 'string'
    itsmReceivers: [
      {
        connectionId: 'string'
        name: 'string'
        region: 'string'
        ticketConfiguration: 'string'
        workspaceId: 'string'
      }
    ]
    smsReceivers: [
      {
        countryCode: 'string'
        name: 'string'
        phoneNumber: 'string'
      }
    ]
    webhookReceivers: [
      {
        name: 'string'
        serviceUri: 'string'
      }
    ]
  }
  tags: {
    {customized property}: 'string'
  }
}

屬性值

ActionGroup

名字	描述	價值
automationRunbookReceivers	屬於此動作群組一部分的 AutomationRunbook 接收者清單。	AutomationRunbookReceiver[]
azureAppPushReceivers	屬於此動作群組一部分的 AzureAppPush 接收者清單。	AzureAppPushReceiver[]
emailReceivers	屬於此動作群組一部分的電子郵件接收者清單。	EmailReceiver[]
啟用	指出是否啟用此動作群組。如果未啟用動作群組，則沒有任何接收者會收到通訊。	布林（必要）
groupShortName	動作群組的簡短名稱。這將會用於簡訊。	字串約束：最大長度 = （必要）
itsmReceivers	屬於此動作群組一部分的 ITSM 接收者清單。	ItsmReceiver[]
smsReceivers	屬於此動作群組一部分的SMS接收者清單。	SmsReceiver[]
webhookReceivers	屬於此動作群組一部分的 Webhook 接收者清單。	WebhookReceiver[]

AutomationRunbookReceiver

名字	描述	價值
automationAccountId	保留此 Runbook 並向 Azure 資源驗證的 Azure 自動化帳戶標識碼。	字串（必要）
isGlobalRunbook	指出這個實例是否為全域 Runbook。	布林（必要）
名字	指出 Webhook 的名稱。	字串
RunbookName	此 Runbook 的名稱。	字串（必要）
serviceUri	應該傳送 Webhook 的 URI。	字串
webhookResourceId	連結至此 Runbook 之 Webhook 的資源識別碼。	字串（必要）

AzureAppPushReceiver

名字	描述	價值
emailAddress	為 Azure 行動應用程式註冊的電子郵件位址。	字串（必要）
名字	Azure 行動應用程式推送接收者的名稱。名稱在動作群組內的所有接收者中必須是唯一的。	字串（必要）

EmailReceiver

名字	描述	價值
emailAddress	此接收者的電子郵件位址。	字串（必要）
名字	電子郵件接收者的名稱。名稱在動作群組內的所有接收者中必須是唯一的。	字串（必要）

ItsmReceiver

名字	描述	價值
connectionId	在上述工作區中定義之多個之間的 ITSM 連線的唯一識別。	字串（必要）
名字	Itsm 接收者的名稱。名稱在動作群組內的所有接收者中必須是唯一的。	字串（必要）
地區	工作區所在的區域。支援的值：'centralindia'、'japaneast'、'southeastasia'、'australiasoutheast'、'uksouth'、'westcentralus'、'canadacentral'、'eastus'、'westeurope'	字串（必要）
ticketConfiguration	ITSM 動作組態的 JSON Blob。 CreateMultipleWorkItems 選項也會是此 Blob 的一部分。	字串（必要）
workspaceId	OMS LA 實例標識碼。	字串（必要）

microsoft.insights/actionGroups

名字	描述	價值
位置	資源位置	字串（必要）
名字	資源名稱	字串（必要）
性能	動作會群組資源的屬性。	ActionGroup
標籤	資源標籤	標記名稱和值的字典。請參閱範本中的標籤

ResourceTags

名字	描述	價值

SmsReceiver

名字	描述	價值
countryCode	SMS 接收者的國家/地區代碼。	字串（必要）
名字	SMS 接收者的名稱。名稱在動作群組內的所有接收者中必須是唯一的。	字串（必要）
phoneNumber	SMS 接收者的電話號碼。	字串（必要）

WebhookReceiver

名字	描述	價值
名字	Webhook 接收者的名稱。名稱在動作群組內的所有接收者中必須是唯一的。	字串（必要）
serviceUri	應該傳送 Webhook 的 URI。	字串（必要）

快速入門範例

下列快速入門範例會部署此資源類型。

Bicep 檔案	描述
具有 NAT 閘道和應用程式閘道的 AKS 叢集	此範例示範如何使用 NAT 閘道部署 AKS 叢集以進行輸出連線，以及用於輸入連線的應用程式閘道。
使用應用程式閘道輸入控制器 AKS 叢集	此範例示範如何使用應用程式閘道、應用程式閘道輸入控制器、Azure Container Registry、Log Analytics 和 Key Vault 部署 AKS 叢集
在 Azure 上建立新的動作群組	此範本會在 Azure 上建立新的動作群組，接著可以使用此動作群組在 Azure 上設定警示。
建立 Azure 服務警示	此範本會建立 Azure 服務健康情況警示，選擇性地將電子郵件傳送給服務管理員，並在發生 Azure 服務中斷時指定的電子郵件位址。
部署 Application Insight 並在其中建立警示	此範本可讓您部署Application Insight，並在其中建立警示
使用 Azure 監視器設定備份警示的通知	此範本可讓您使用 Azure 監視器來設定復原服務保存庫的電子郵件通知，方法是部署警示處理規則和動作群組

ARM 樣本資源定義

actionGroups 資源類型可以使用目標作業來部署：

資源群組 - 請參閱資源群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱變更記錄檔。

資源格式

若要建立 microsoft.insights/actionGroups 資源，請將下列 JSON 新增至範本。

{
  "type": "microsoft.insights/actionGroups",
  "apiVersion": "2017-04-01",
  "name": "string",
  "location": "string",
  "properties": {
    "automationRunbookReceivers": [
      {
        "automationAccountId": "string",
        "isGlobalRunbook": "bool",
        "name": "string",
        "runbookName": "string",
        "serviceUri": "string",
        "webhookResourceId": "string"
      }
    ],
    "azureAppPushReceivers": [
      {
        "emailAddress": "string",
        "name": "string"
      }
    ],
    "emailReceivers": [
      {
        "emailAddress": "string",
        "name": "string"
      }
    ],
    "enabled": "bool",
    "groupShortName": "string",
    "itsmReceivers": [
      {
        "connectionId": "string",
        "name": "string",
        "region": "string",
        "ticketConfiguration": "string",
        "workspaceId": "string"
      }
    ],
    "smsReceivers": [
      {
        "countryCode": "string",
        "name": "string",
        "phoneNumber": "string"
      }
    ],
    "webhookReceivers": [
      {
        "name": "string",
        "serviceUri": "string"
      }
    ]
  },
  "tags": {
    "{customized property}": "string"
  }
}

屬性值

ActionGroup

名字	描述	價值
automationRunbookReceivers	屬於此動作群組一部分的 AutomationRunbook 接收者清單。	AutomationRunbookReceiver[]
azureAppPushReceivers	屬於此動作群組一部分的 AzureAppPush 接收者清單。	AzureAppPushReceiver[]
emailReceivers	屬於此動作群組一部分的電子郵件接收者清單。	EmailReceiver[]
啟用	指出是否啟用此動作群組。如果未啟用動作群組，則沒有任何接收者會收到通訊。	布林（必要）
groupShortName	動作群組的簡短名稱。這將會用於簡訊。	字串約束：最大長度 = （必要）
itsmReceivers	屬於此動作群組一部分的 ITSM 接收者清單。	ItsmReceiver[]
smsReceivers	屬於此動作群組一部分的SMS接收者清單。	SmsReceiver[]
webhookReceivers	屬於此動作群組一部分的 Webhook 接收者清單。	WebhookReceiver[]

AutomationRunbookReceiver

名字	描述	價值
automationAccountId	保留此 Runbook 並向 Azure 資源驗證的 Azure 自動化帳戶標識碼。	字串（必要）
isGlobalRunbook	指出這個實例是否為全域 Runbook。	布林（必要）
名字	指出 Webhook 的名稱。	字串
RunbookName	此 Runbook 的名稱。	字串（必要）
serviceUri	應該傳送 Webhook 的 URI。	字串
webhookResourceId	連結至此 Runbook 之 Webhook 的資源識別碼。	字串（必要）

AzureAppPushReceiver

名字	描述	價值
emailAddress	為 Azure 行動應用程式註冊的電子郵件位址。	字串（必要）
名字	Azure 行動應用程式推送接收者的名稱。名稱在動作群組內的所有接收者中必須是唯一的。	字串（必要）

EmailReceiver

名字	描述	價值
emailAddress	此接收者的電子郵件位址。	字串（必要）
名字	電子郵件接收者的名稱。名稱在動作群組內的所有接收者中必須是唯一的。	字串（必要）

ItsmReceiver

名字	描述	價值
connectionId	在上述工作區中定義之多個之間的 ITSM 連線的唯一識別。	字串（必要）
名字	Itsm 接收者的名稱。名稱在動作群組內的所有接收者中必須是唯一的。	字串（必要）
地區	工作區所在的區域。支援的值：'centralindia'、'japaneast'、'southeastasia'、'australiasoutheast'、'uksouth'、'westcentralus'、'canadacentral'、'eastus'、'westeurope'	字串（必要）
ticketConfiguration	ITSM 動作組態的 JSON Blob。 CreateMultipleWorkItems 選項也會是此 Blob 的一部分。	字串（必要）
workspaceId	OMS LA 實例標識碼。	字串（必要）

microsoft.insights/actionGroups

名字	描述	價值
apiVersion	API 版本	'2017-04-01'
位置	資源位置	字串（必要）
名字	資源名稱	字串（必要）
性能	動作會群組資源的屬性。	ActionGroup
標籤	資源標籤	標記名稱和值的字典。請參閱範本中的標籤
類型	資源類型	'microsoft.insights/actionGroups'

ResourceTags

名字	描述	價值

SmsReceiver

名字	描述	價值
countryCode	SMS 接收者的國家/地區代碼。	字串（必要）
名字	SMS 接收者的名稱。名稱在動作群組內的所有接收者中必須是唯一的。	字串（必要）
phoneNumber	SMS 接收者的電話號碼。	字串（必要）

WebhookReceiver

名字	描述	價值
名字	Webhook 接收者的名稱。名稱在動作群組內的所有接收者中必須是唯一的。	字串（必要）
serviceUri	應該傳送 Webhook 的 URI。	字串（必要）

快速入門範本

下列快速入門範本會部署此資源類型。

範本	描述
具有 NAT 閘道和應用程式閘道的 AKS 叢集	此範例示範如何使用 NAT 閘道部署 AKS 叢集以進行輸出連線，以及用於輸入連線的應用程式閘道。
使用應用程式閘道輸入控制器 AKS 叢集	此範例示範如何使用應用程式閘道、應用程式閘道輸入控制器、Azure Container Registry、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 App Service Web Apps 上部署 umbraco CMS Web 應用程式的簡單方式。
使用 Azure 監視器設定備份警示的通知	此範本可讓您使用 Azure 監視器來設定復原服務保存庫的電子郵件通知，方法是部署警示處理規則和動作群組

Terraform （AzAPI 提供者）資源定義

actionGroups 資源類型可以使用目標作業來部署：

資源群組

如需每個 API 版本中已變更屬性的清單，請參閱變更記錄檔。

資源格式

若要建立 microsoft.insights/actionGroups 資源，請將下列 Terraform 新增至您的範本。

resource "azapi_resource" "symbolicname" {
  type = "microsoft.insights/actionGroups@2017-04-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"
        }
      ]
      emailReceivers = [
        {
          emailAddress = "string"
          name = "string"
        }
      ]
      enabled = bool
      groupShortName = "string"
      itsmReceivers = [
        {
          connectionId = "string"
          name = "string"
          region = "string"
          ticketConfiguration = "string"
          workspaceId = "string"
        }
      ]
      smsReceivers = [
        {
          countryCode = "string"
          name = "string"
          phoneNumber = "string"
        }
      ]
      webhookReceivers = [
        {
          name = "string"
          serviceUri = "string"
        }
      ]
    }
  })
}

屬性值

ActionGroup

名字	描述	價值
automationRunbookReceivers	屬於此動作群組一部分的 AutomationRunbook 接收者清單。	AutomationRunbookReceiver[]
azureAppPushReceivers	屬於此動作群組一部分的 AzureAppPush 接收者清單。	AzureAppPushReceiver[]
emailReceivers	屬於此動作群組一部分的電子郵件接收者清單。	EmailReceiver[]
啟用	指出是否啟用此動作群組。如果未啟用動作群組，則沒有任何接收者會收到通訊。	布林（必要）
groupShortName	動作群組的簡短名稱。這將會用於簡訊。	字串約束：最大長度 = （必要）
itsmReceivers	屬於此動作群組一部分的 ITSM 接收者清單。	ItsmReceiver[]
smsReceivers	屬於此動作群組一部分的SMS接收者清單。	SmsReceiver[]
webhookReceivers	屬於此動作群組一部分的 Webhook 接收者清單。	WebhookReceiver[]

AutomationRunbookReceiver

名字	描述	價值
automationAccountId	保留此 Runbook 並向 Azure 資源驗證的 Azure 自動化帳戶標識碼。	字串（必要）
isGlobalRunbook	指出這個實例是否為全域 Runbook。	布林（必要）
名字	指出 Webhook 的名稱。	字串
RunbookName	此 Runbook 的名稱。	字串（必要）
serviceUri	應該傳送 Webhook 的 URI。	字串
webhookResourceId	連結至此 Runbook 之 Webhook 的資源識別碼。	字串（必要）

AzureAppPushReceiver

名字	描述	價值
emailAddress	為 Azure 行動應用程式註冊的電子郵件位址。	字串（必要）
名字	Azure 行動應用程式推送接收者的名稱。名稱在動作群組內的所有接收者中必須是唯一的。	字串（必要）

EmailReceiver

名字	描述	價值
emailAddress	此接收者的電子郵件位址。	字串（必要）
名字	電子郵件接收者的名稱。名稱在動作群組內的所有接收者中必須是唯一的。	字串（必要）

ItsmReceiver

名字	描述	價值
connectionId	在上述工作區中定義之多個之間的 ITSM 連線的唯一識別。	字串（必要）
名字	Itsm 接收者的名稱。名稱在動作群組內的所有接收者中必須是唯一的。	字串（必要）
地區	工作區所在的區域。支援的值：'centralindia'、'japaneast'、'southeastasia'、'australiasoutheast'、'uksouth'、'westcentralus'、'canadacentral'、'eastus'、'westeurope'	字串（必要）
ticketConfiguration	ITSM 動作組態的 JSON Blob。 CreateMultipleWorkItems 選項也會是此 Blob 的一部分。	字串（必要）
workspaceId	OMS LA 實例標識碼。	字串（必要）

microsoft.insights/actionGroups

名字	描述	價值
位置	資源位置	字串（必要）
名字	資源名稱	字串（必要）
性能	動作會群組資源的屬性。	ActionGroup
標籤	資源標籤	標記名稱和值的字典。
類型	資源類型	“microsoft.insights/actionGroups@2017-04-01”

ResourceTags

名字	描述	價值

SmsReceiver

名字	描述	價值
countryCode	SMS 接收者的國家/地區代碼。	字串（必要）
名字	SMS 接收者的名稱。名稱在動作群組內的所有接收者中必須是唯一的。	字串（必要）
phoneNumber	SMS 接收者的電話號碼。	字串（必要）

WebhookReceiver

名字	描述	價值
名字	Webhook 接收者的名稱。名稱在動作群組內的所有接收者中必須是唯一的。	字串（必要）
serviceUri	應該傳送 Webhook 的 URI。	字串（必要）

共用方式為

microsoft.insights actionGroups 2017-04-01

言論

Bicep 資源定義

資源格式

屬性值

ActionGroup

AutomationRunbookReceiver

AzureAppPushReceiver

EmailReceiver

ItsmReceiver

microsoft.insights/actionGroups

ResourceTags

SmsReceiver

WebhookReceiver

快速入門範例

ARM 樣本資源定義

資源格式

屬性值

ActionGroup

AutomationRunbookReceiver

AzureAppPushReceiver

EmailReceiver

ItsmReceiver

microsoft.insights/actionGroups

ResourceTags

SmsReceiver

WebhookReceiver

快速入門範本

Terraform （AzAPI 提供者） 資源定義

資源格式

屬性值

ActionGroup

AutomationRunbookReceiver

AzureAppPushReceiver

EmailReceiver

ItsmReceiver

microsoft.insights/actionGroups

ResourceTags

SmsReceiver

WebhookReceiver

意見反應

其他資源

Terraform （AzAPI 提供者）資源定義