microsoft.insights actionGroups 2019-06-01
如需部署監視解決方案的指引,請參閱 使用 Bicep建立監視資源。
Bicep 資源定義
actionGroups 資源類型可以使用目標作業來部署:
如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。
若要建立 microsoft.insights/actionGroups 資源,請將下列 Bicep 新增至範本。
resource symbolicname 'microsoft.insights/actionGroups@2019-06-01' = {
location: 'string'
name: 'string'
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: [
{
identifierUri: 'string'
name: 'string'
objectId: 'string'
serviceUri: 'string'
tenantId: 'string'
useAadAuth: bool
useCommonAlertSchema: bool
}
]
}
tags: {
{customized property}: 'string'
}
}
屬性值
ActionGroup
ArmRoleReceiver
名字 |
描述 |
價值 |
名字 |
arm 角色接收器的名稱。 名稱在動作群組內的所有接收者中必須是唯一的。 |
字串 (必要) |
roleId |
arm 角色標識碼。 |
字串 (必要) |
useCommonAlertSchema |
指出是否要使用一般警示架構。 |
bool |
AutomationRunbookReceiver
名字 |
描述 |
價值 |
automationAccountId |
保留此 Runbook 並向 Azure 資源驗證的 Azure 自動化帳戶標識碼。 |
字串 (必要) |
isGlobalRunbook |
指出這個實例是否為全域 Runbook。 |
布林 (必要) |
名字 |
指出 Webhook 的名稱。 |
字串 |
RunbookName |
此 Runbook 的名稱。 |
字串 (必要) |
serviceUri |
應該傳送 Webhook 的 URI。 |
字串 |
useCommonAlertSchema |
指出是否要使用一般警示架構。 |
bool |
webhookResourceId |
連結至此 Runbook 之 Webhook 的資源識別碼。 |
字串 (必要) |
AzureAppPushReceiver
名字 |
描述 |
價值 |
emailAddress |
為 Azure 行動應用程式註冊的電子郵件位址。 |
字串 (必要) |
名字 |
Azure 行動應用程式推送接收者的名稱。 名稱在動作群組內的所有接收者中必須是唯一的。 |
字串 (必要) |
AzureFunctionReceiver
名字 |
描述 |
價值 |
functionAppResourceId |
函式應用程式的 Azure 資源識別碼。 |
字串 (必要) |
functionName |
函式應用程式中的函式名稱。 |
字串 (必要) |
httpTriggerUrl |
HTTP 觸發程式 URL,其中 HTTP 要求傳送至 。 |
字串 (必要) |
名字 |
azure 函式接收者的名稱。 名稱在動作群組內的所有接收者中必須是唯一的。 |
字串 (必要) |
useCommonAlertSchema |
指出是否要使用一般警示架構。 |
bool |
EmailReceiver
名字 |
描述 |
價值 |
emailAddress |
此接收者的電子郵件位址。 |
字串 (必要) |
名字 |
電子郵件接收者的名稱。 名稱在動作群組內的所有接收者中必須是唯一的。 |
字串 (必要) |
useCommonAlertSchema |
指出是否要使用一般警示架構。 |
bool |
ItsmReceiver
名字 |
描述 |
價值 |
connectionId |
在上述工作區中定義之多個之間的 ITSM 連線的唯一識別。 |
字串 (必要) |
名字 |
Itsm 接收者的名稱。 名稱在動作群組內的所有接收者中必須是唯一的。 |
字串 (必要) |
地區 |
工作區所在的區域。 支援的值:'centralindia'、'japaneast'、'southeastasia'、'australiasoutheast'、'uksouth'、'westcentralus'、'canadacentral'、'eastus'、'westeurope' |
字串 (必要) |
ticketConfiguration |
ITSM 動作組態的 JSON Blob。 CreateMultipleWorkItems 選項也會是此 Blob 的一部分。 |
字串 (必要) |
workspaceId |
OMS LA 實例標識碼。 |
字串 (必要) |
LogicAppReceiver
名字 |
描述 |
價值 |
callbackUrl |
HTTP 要求傳送至其中的回呼 URL。 |
字串 (必要) |
名字 |
邏輯應用程式接收者的名稱。 名稱在動作群組內的所有接收者中必須是唯一的。 |
字串 (必要) |
resourceId |
邏輯應用程式接收者的 Azure 資源識別碼。 |
字串 (必要) |
useCommonAlertSchema |
指出是否要使用一般警示架構。 |
bool |
microsoft.insights/actionGroups
名字 |
描述 |
價值 |
位置 |
資源位置 |
字串 (必要) |
名字 |
資源名稱 |
字串 (必要) |
性能 |
動作會群組資源的屬性。 |
ActionGroup |
標籤 |
資源標籤 |
標記名稱和值的字典。 請參閱範本中的 標籤 |
SmsReceiver
名字 |
描述 |
價值 |
countryCode |
SMS 接收者的國家/地區代碼。 |
字串 (必要) |
名字 |
SMS 接收者的名稱。 名稱在動作群組內的所有接收者中必須是唯一的。 |
字串 (必要) |
phoneNumber |
SMS 接收者的電話號碼。 |
字串 (必要) |
VoiceReceiver
名字 |
描述 |
價值 |
countryCode |
語音接收器的國家/地區代碼。 |
字串 (必要) |
名字 |
語音接收器的名稱。 名稱在動作群組內的所有接收者中必須是唯一的。 |
字串 (必要) |
phoneNumber |
語音接收器的電話號碼。 |
字串 (必要) |
WebhookReceiver
名字 |
描述 |
價值 |
identifierUri |
指出 aad 驗證的識別碼 URI。 |
字串 |
名字 |
Webhook 接收者的名稱。 名稱在動作群組內的所有接收者中必須是唯一的。 |
字串 (必要) |
objectId |
指出 aad 驗證的 Webhook 應用程式物件識別碼。 |
字串 |
serviceUri |
應該傳送 Webhook 的 URI。 |
字串 (必要) |
tenantId |
指出 aad 驗證的租用戶標識碼。 |
字串 |
useAadAuth |
指出是否使用 AAD 驗證。 |
bool |
useCommonAlertSchema |
指出是否要使用一般警示架構。 |
bool |
快速入門範例
下列快速入門範例會部署此資源類型。
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": "2019-06-01",
"name": "string",
"location": "string",
"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": [
{
"identifierUri": "string",
"name": "string",
"objectId": "string",
"serviceUri": "string",
"tenantId": "string",
"useAadAuth": "bool",
"useCommonAlertSchema": "bool"
}
]
},
"tags": {
"{customized property}": "string"
}
}
屬性值
ActionGroup
ArmRoleReceiver
名字 |
描述 |
價值 |
名字 |
arm 角色接收器的名稱。 名稱在動作群組內的所有接收者中必須是唯一的。 |
字串 (必要) |
roleId |
arm 角色標識碼。 |
字串 (必要) |
useCommonAlertSchema |
指出是否要使用一般警示架構。 |
bool |
AutomationRunbookReceiver
名字 |
描述 |
價值 |
automationAccountId |
保留此 Runbook 並向 Azure 資源驗證的 Azure 自動化帳戶標識碼。 |
字串 (必要) |
isGlobalRunbook |
指出這個實例是否為全域 Runbook。 |
布林 (必要) |
名字 |
指出 Webhook 的名稱。 |
字串 |
RunbookName |
此 Runbook 的名稱。 |
字串 (必要) |
serviceUri |
應該傳送 Webhook 的 URI。 |
字串 |
useCommonAlertSchema |
指出是否要使用一般警示架構。 |
bool |
webhookResourceId |
連結至此 Runbook 之 Webhook 的資源識別碼。 |
字串 (必要) |
AzureAppPushReceiver
名字 |
描述 |
價值 |
emailAddress |
為 Azure 行動應用程式註冊的電子郵件位址。 |
字串 (必要) |
名字 |
Azure 行動應用程式推送接收者的名稱。 名稱在動作群組內的所有接收者中必須是唯一的。 |
字串 (必要) |
AzureFunctionReceiver
名字 |
描述 |
價值 |
functionAppResourceId |
函式應用程式的 Azure 資源識別碼。 |
字串 (必要) |
functionName |
函式應用程式中的函式名稱。 |
字串 (必要) |
httpTriggerUrl |
HTTP 觸發程式 URL,其中 HTTP 要求傳送至 。 |
字串 (必要) |
名字 |
azure 函式接收者的名稱。 名稱在動作群組內的所有接收者中必須是唯一的。 |
字串 (必要) |
useCommonAlertSchema |
指出是否要使用一般警示架構。 |
bool |
EmailReceiver
名字 |
描述 |
價值 |
emailAddress |
此接收者的電子郵件位址。 |
字串 (必要) |
名字 |
電子郵件接收者的名稱。 名稱在動作群組內的所有接收者中必須是唯一的。 |
字串 (必要) |
useCommonAlertSchema |
指出是否要使用一般警示架構。 |
bool |
ItsmReceiver
名字 |
描述 |
價值 |
connectionId |
在上述工作區中定義之多個之間的 ITSM 連線的唯一識別。 |
字串 (必要) |
名字 |
Itsm 接收者的名稱。 名稱在動作群組內的所有接收者中必須是唯一的。 |
字串 (必要) |
地區 |
工作區所在的區域。 支援的值:'centralindia'、'japaneast'、'southeastasia'、'australiasoutheast'、'uksouth'、'westcentralus'、'canadacentral'、'eastus'、'westeurope' |
字串 (必要) |
ticketConfiguration |
ITSM 動作組態的 JSON Blob。 CreateMultipleWorkItems 選項也會是此 Blob 的一部分。 |
字串 (必要) |
workspaceId |
OMS LA 實例標識碼。 |
字串 (必要) |
LogicAppReceiver
名字 |
描述 |
價值 |
callbackUrl |
HTTP 要求傳送至其中的回呼 URL。 |
字串 (必要) |
名字 |
邏輯應用程式接收者的名稱。 名稱在動作群組內的所有接收者中必須是唯一的。 |
字串 (必要) |
resourceId |
邏輯應用程式接收者的 Azure 資源識別碼。 |
字串 (必要) |
useCommonAlertSchema |
指出是否要使用一般警示架構。 |
bool |
microsoft.insights/actionGroups
名字 |
描述 |
價值 |
apiVersion |
API 版本 |
'2019-06-01' |
位置 |
資源位置 |
字串 (必要) |
名字 |
資源名稱 |
字串 (必要) |
性能 |
動作會群組資源的屬性。 |
ActionGroup |
標籤 |
資源標籤 |
標記名稱和值的字典。 請參閱範本中的 標籤 |
類型 |
資源類型 |
'microsoft.insights/actionGroups' |
SmsReceiver
名字 |
描述 |
價值 |
countryCode |
SMS 接收者的國家/地區代碼。 |
字串 (必要) |
名字 |
SMS 接收者的名稱。 名稱在動作群組內的所有接收者中必須是唯一的。 |
字串 (必要) |
phoneNumber |
SMS 接收者的電話號碼。 |
字串 (必要) |
VoiceReceiver
名字 |
描述 |
價值 |
countryCode |
語音接收器的國家/地區代碼。 |
字串 (必要) |
名字 |
語音接收器的名稱。 名稱在動作群組內的所有接收者中必須是唯一的。 |
字串 (必要) |
phoneNumber |
語音接收器的電話號碼。 |
字串 (必要) |
WebhookReceiver
名字 |
描述 |
價值 |
identifierUri |
指出 aad 驗證的識別碼 URI。 |
字串 |
名字 |
Webhook 接收者的名稱。 名稱在動作群組內的所有接收者中必須是唯一的。 |
字串 (必要) |
objectId |
指出 aad 驗證的 Webhook 應用程式物件識別碼。 |
字串 |
serviceUri |
應該傳送 Webhook 的 URI。 |
字串 (必要) |
tenantId |
指出 aad 驗證的租用戶標識碼。 |
字串 |
useAadAuth |
指出是否使用 AAD 驗證。 |
bool |
useCommonAlertSchema |
指出是否要使用一般警示架構。 |
bool |
快速入門範本
下列快速入門範本會部署此資源類型。
actionGroups 資源類型可以使用目標作業來部署:
如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。
若要建立 microsoft.insights/actionGroups 資源,請將下列 Terraform 新增至您的範本。
resource "azapi_resource" "symbolicname" {
type = "microsoft.insights/actionGroups@2019-06-01"
name = "string"
location = "string"
tags = {
{customized property} = "string"
}
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 = [
{
identifierUri = "string"
name = "string"
objectId = "string"
serviceUri = "string"
tenantId = "string"
useAadAuth = bool
useCommonAlertSchema = bool
}
]
}
})
}
屬性值
ActionGroup
ArmRoleReceiver
名字 |
描述 |
價值 |
名字 |
arm 角色接收器的名稱。 名稱在動作群組內的所有接收者中必須是唯一的。 |
字串 (必要) |
roleId |
arm 角色標識碼。 |
字串 (必要) |
useCommonAlertSchema |
指出是否要使用一般警示架構。 |
bool |
AutomationRunbookReceiver
名字 |
描述 |
價值 |
automationAccountId |
保留此 Runbook 並向 Azure 資源驗證的 Azure 自動化帳戶標識碼。 |
字串 (必要) |
isGlobalRunbook |
指出這個實例是否為全域 Runbook。 |
布林 (必要) |
名字 |
指出 Webhook 的名稱。 |
字串 |
RunbookName |
此 Runbook 的名稱。 |
字串 (必要) |
serviceUri |
應該傳送 Webhook 的 URI。 |
字串 |
useCommonAlertSchema |
指出是否要使用一般警示架構。 |
bool |
webhookResourceId |
連結至此 Runbook 之 Webhook 的資源識別碼。 |
字串 (必要) |
AzureAppPushReceiver
名字 |
描述 |
價值 |
emailAddress |
為 Azure 行動應用程式註冊的電子郵件位址。 |
字串 (必要) |
名字 |
Azure 行動應用程式推送接收者的名稱。 名稱在動作群組內的所有接收者中必須是唯一的。 |
字串 (必要) |
AzureFunctionReceiver
名字 |
描述 |
價值 |
functionAppResourceId |
函式應用程式的 Azure 資源識別碼。 |
字串 (必要) |
functionName |
函式應用程式中的函式名稱。 |
字串 (必要) |
httpTriggerUrl |
HTTP 觸發程式 URL,其中 HTTP 要求傳送至 。 |
字串 (必要) |
名字 |
azure 函式接收者的名稱。 名稱在動作群組內的所有接收者中必須是唯一的。 |
字串 (必要) |
useCommonAlertSchema |
指出是否要使用一般警示架構。 |
bool |
EmailReceiver
名字 |
描述 |
價值 |
emailAddress |
此接收者的電子郵件位址。 |
字串 (必要) |
名字 |
電子郵件接收者的名稱。 名稱在動作群組內的所有接收者中必須是唯一的。 |
字串 (必要) |
useCommonAlertSchema |
指出是否要使用一般警示架構。 |
bool |
ItsmReceiver
名字 |
描述 |
價值 |
connectionId |
在上述工作區中定義之多個之間的 ITSM 連線的唯一識別。 |
字串 (必要) |
名字 |
Itsm 接收者的名稱。 名稱在動作群組內的所有接收者中必須是唯一的。 |
字串 (必要) |
地區 |
工作區所在的區域。 支援的值:'centralindia'、'japaneast'、'southeastasia'、'australiasoutheast'、'uksouth'、'westcentralus'、'canadacentral'、'eastus'、'westeurope' |
字串 (必要) |
ticketConfiguration |
ITSM 動作組態的 JSON Blob。 CreateMultipleWorkItems 選項也會是此 Blob 的一部分。 |
字串 (必要) |
workspaceId |
OMS LA 實例標識碼。 |
字串 (必要) |
LogicAppReceiver
名字 |
描述 |
價值 |
callbackUrl |
HTTP 要求傳送至其中的回呼 URL。 |
字串 (必要) |
名字 |
邏輯應用程式接收者的名稱。 名稱在動作群組內的所有接收者中必須是唯一的。 |
字串 (必要) |
resourceId |
邏輯應用程式接收者的 Azure 資源識別碼。 |
字串 (必要) |
useCommonAlertSchema |
指出是否要使用一般警示架構。 |
bool |
microsoft.insights/actionGroups
名字 |
描述 |
價值 |
位置 |
資源位置 |
字串 (必要) |
名字 |
資源名稱 |
字串 (必要) |
性能 |
動作會群組資源的屬性。 |
ActionGroup |
標籤 |
資源標籤 |
標記名稱和值的字典。 |
類型 |
資源類型 |
“microsoft.insights/actionGroups@2019-06-01” |
SmsReceiver
名字 |
描述 |
價值 |
countryCode |
SMS 接收者的國家/地區代碼。 |
字串 (必要) |
名字 |
SMS 接收者的名稱。 名稱在動作群組內的所有接收者中必須是唯一的。 |
字串 (必要) |
phoneNumber |
SMS 接收者的電話號碼。 |
字串 (必要) |
VoiceReceiver
名字 |
描述 |
價值 |
countryCode |
語音接收器的國家/地區代碼。 |
字串 (必要) |
名字 |
語音接收器的名稱。 名稱在動作群組內的所有接收者中必須是唯一的。 |
字串 (必要) |
phoneNumber |
語音接收器的電話號碼。 |
字串 (必要) |
WebhookReceiver
名字 |
描述 |
價值 |
identifierUri |
指出 aad 驗證的識別碼 URI。 |
字串 |
名字 |
Webhook 接收者的名稱。 名稱在動作群組內的所有接收者中必須是唯一的。 |
字串 (必要) |
objectId |
指出 aad 驗證的 Webhook 應用程式物件識別碼。 |
字串 |
serviceUri |
應該傳送 Webhook 的 URI。 |
字串 (必要) |
tenantId |
指出 aad 驗證的租用戶標識碼。 |
字串 |
useAadAuth |
指出是否使用 AAD 驗證。 |
bool |
useCommonAlertSchema |
指出是否要使用一般警示架構。 |
bool |