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

Action Groups - Get

参考

服务:: Monitor

API 版本:: 2021-09-01

获取操作组。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/actionGroups/{actionGroupName}?api-version=2021-09-01

URI 参数

名称	在	必需	类型	说明
actionGroupName	path	True	string	操作组的名称。
resourceGroupName	path	True	string	资源组的名称。此名称不区分大小写。
subscriptionId	path	True	string	目标订阅的 ID。
api-version	query	True	string	要用于此操作的 API 版本。

响应

名称	类型	说明
200 OK	ActionGroupResource	请求成功。
Other Status Codes	ErrorResponse	发生错误，无法检索操作组。 404：操作组不存在。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Get an action group

GET https://management.azure.com/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/Default-NotificationRules/providers/Microsoft.Insights/actionGroups/SampleActionGroup?api-version=2021-09-01

package armmonitor_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/monitor/armmonitor"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-09-01/examples/getActionGroup.json
func ExampleActionGroupsClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armmonitor.NewActionGroupsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<action-group-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:: 200

{
  "id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/Default-NotificationRules/providers/microsoft.insights/actionGroups/SampleActionGroup",
  "type": "Microsoft.Insights/ActionGroups",
  "name": "SampleActionGroup",
  "location": "Global",
  "tags": {},
  "properties": {
    "groupShortName": "sample",
    "enabled": true,
    "emailReceivers": [
      {
        "name": "John Doe's email",
        "emailAddress": "johndoe@email.com",
        "status": "Enabled",
        "useCommonAlertSchema": true
      },
      {
        "name": "Jane Smith's email",
        "emailAddress": "janesmith@email.com",
        "status": "Disabled",
        "useCommonAlertSchema": true
      }
    ],
    "smsReceivers": [
      {
        "name": "John Doe's mobile",
        "countryCode": "1",
        "phoneNumber": "1234567890",
        "status": "Disabled"
      },
      {
        "name": "Jane Smith's mobile",
        "countryCode": "1",
        "phoneNumber": "0987654321",
        "status": "Enabled"
      }
    ],
    "webhookReceivers": [
      {
        "name": "Sample webhook",
        "serviceUri": "http://www.example.com/webhook",
        "useCommonAlertSchema": false
      },
      {
        "name": "Sample webhook 2",
        "serviceUri": "http://www.example.com/webhook2",
        "useCommonAlertSchema": true,
        "useAadAuth": true,
        "objectId": "d3bb868c-fe44-452c-aa26-769a6538c808",
        "identifierUri": "http://someidentifier/d7811ba3-7996-4a93-99b6-6b2f3f355f8a",
        "tenantId": "68a4459a-ccb8-493c-b9da-dd30457d1b84"
      }
    ],
    "itsmReceivers": [],
    "azureAppPushReceivers": [],
    "automationRunbookReceivers": [],
    "voiceReceivers": [],
    "logicAppReceivers": [],
    "azureFunctionReceivers": [],
    "armRoleReceivers": [],
    "eventHubReceivers": []
  }
}

定义

名称	说明
ActionGroupResource	操作组资源。
ArmRoleReceiver	一个 arm 角色接收器。
AutomationRunbookReceiver	Azure 自动化 Runbook 通知接收器。
AzureAppPushReceiver	Azure 移动应用推送通知接收器。
AzureFunctionReceiver	Azure 函数接收器。
EmailReceiver	电子邮件接收者。
ErrorResponse	描述错误响应的格式。
EventHubReceiver	事件中心接收器。
ItsmReceiver	Itsm 接收器。
LogicAppReceiver	逻辑应用接收器。
ReceiverStatus	指示接收方的状态。未启用的接收方将不会接收任何通信。
SmsReceiver	短信接收方。
VoiceReceiver	语音接收器。
WebhookReceiver	Webhook 接收器。

ActionGroupResource

操作组资源。

名称	类型	默认值	说明
id	string		Azure 资源 ID
location	string		资源位置
name	string		Azure 资源名称
properties.armRoleReceivers	ArmRoleReceiver[]		属于此操作组的 ARM 角色接收器的列表。角色是 Azure RBAC 角色，仅支持内置角色。
properties.automationRunbookReceivers	AutomationRunbookReceiver[]		属于此操作组的 AutomationRunbook 接收器的列表。
properties.azureAppPushReceivers	AzureAppPushReceiver[]		属于此操作组的 AzureAppPush 接收器的列表。
properties.azureFunctionReceivers	AzureFunctionReceiver[]		属于此操作组的 Azure 函数接收器的列表。
properties.emailReceivers	EmailReceiver[]		属于此操作组的电子邮件收件人的列表。
properties.enabled	boolean	True	指示是否启用此操作组。如果未启用操作组，则其任何接收方都不会接收通信。
properties.eventHubReceivers	EventHubReceiver[]		属于此操作组的事件中心接收器的列表。
properties.groupShortName	string		操作组的短名称。这将在短信中使用。
properties.itsmReceivers	ItsmReceiver[]		属于此操作组的 ITSM 接收器的列表。
properties.logicAppReceivers	LogicAppReceiver[]		属于此操作组的逻辑应用接收器的列表。
properties.smsReceivers	SmsReceiver[]		属于此操作组的短信接收方列表。
properties.voiceReceivers	VoiceReceiver[]		属于此操作组的语音接收器列表。
properties.webhookReceivers	WebhookReceiver[]		属于此操作组的 Webhook 接收器的列表。
tags	object		资源标记
type	string		Azure 资源类型

ArmRoleReceiver

一个 arm 角色接收器。

名称	类型	默认值	说明
name	string		arm 角色接收器的名称。名称在操作组内的所有接收方中必须是唯一的。
roleId	string		arm 角色 ID。
useCommonAlertSchema	boolean	False	指示是否使用通用警报架构。

AutomationRunbookReceiver

Azure 自动化 Runbook 通知接收器。

名称	类型	默认值	说明
automationAccountId	string		保存此 Runbook 并验证 Azure 资源的 Azure 自动化帐户 ID。
isGlobalRunbook	boolean		指示此实例是否为全局 Runbook。
name	string		指示 Webhook 的名称。
runbookName	string		此 Runbook 的名称。
serviceUri	string		应在其中发送 Webhook 的 URI。
useCommonAlertSchema	boolean	False	指示是否使用通用警报架构。
webhookResourceId	string		链接到此 Runbook 的 Webhook 的资源 ID。

AzureAppPushReceiver

Azure 移动应用推送通知接收器。

名称	类型	说明
emailAddress	string	为 Azure 移动应用注册的电子邮件地址。
name	string	Azure 移动应用推送接收器的名称。名称在操作组内的所有接收方中必须是唯一的。

AzureFunctionReceiver

Azure 函数接收器。

名称	类型	默认值	说明
functionAppResourceId	string		函数应用的 azure 资源 ID。
functionName	string		函数应用中的函数名称。
httpTriggerUrl	string		http 请求发送到的 http 触发器 URL。
name	string		azure 函数接收器的名称。名称在操作组内的所有接收方中必须是唯一的。
useCommonAlertSchema	boolean	False	指示是否使用通用警报架构。

EmailReceiver

电子邮件接收者。

名称	类型	默认值	说明
emailAddress	string		此接收方的电子邮件地址。
name	string		电子邮件接收方的名称。名称在操作组内的所有接收方中必须是唯一的。
status	ReceiverStatus		电子邮件的接收方状态。
useCommonAlertSchema	boolean	False	指示是否使用通用警报架构。

ErrorResponse

描述错误响应的格式。

名称	类型	说明
code	string	错误代码
message	string	指示操作失败原因的错误消息。

EventHubReceiver

事件中心接收器。

名称	类型	默认值	说明
eventHubName	string		特定事件中心队列的名称
eventHubNameSpace	string		事件中心命名空间
name	string		事件中心接收器的名称。名称在操作组内的所有接收方中必须是唯一的。
subscriptionId	string		包含此事件中心的订阅的 ID
tenantId	string		包含此事件中心的订阅的租户 ID
useCommonAlertSchema	boolean	False	指示是否使用通用警报架构。

ItsmReceiver

Itsm 接收器。

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

LogicAppReceiver

逻辑应用接收器。

名称	类型	默认值	说明
callbackUrl	string		http 请求发送到的回调 URL。
name	string		逻辑应用接收器的名称。名称在操作组内的所有接收方中必须是唯一的。
resourceId	string		逻辑应用接收器的 azure 资源 ID。
useCommonAlertSchema	boolean	False	指示是否使用通用警报架构。

ReceiverStatus

指示接收方的状态。未启用的接收方将不会接收任何通信。

名称	类型	说明
Disabled	string
Enabled	string
NotSpecified	string

SmsReceiver

短信接收方。

名称	类型	说明
countryCode	string	短信接收方的国家/地区代码。
name	string	短信接收方的名称。名称在操作组内的所有接收方中必须是唯一的。
phoneNumber	string	短信接收方的电话号码。
status	ReceiverStatus	接收方的状态。

VoiceReceiver

语音接收器。

名称	类型	说明
countryCode	string	语音接收器的国家/地区代码。
name	string	语音接收器的名称。名称在操作组内的所有接收方中必须是唯一的。
phoneNumber	string	语音接收器的电话号码。

WebhookReceiver

Webhook 接收器。

名称	类型	默认值	说明
identifierUri	string		指示 aad 身份验证的标识符 URI。
name	string		Webhook 接收器的名称。名称在操作组内的所有接收方中必须是唯一的。
objectId	string		指示 aad 身份验证的 Webhook 应用对象 ID。
serviceUri	string		应在其中发送 Webhook 的 URI。
tenantId	string		指示 aad 身份验证的租户 ID。
useAadAuth	boolean	False	指示是否使用 AAD 身份验证。
useCommonAlertSchema	boolean	False	指示是否使用通用警报架构。

通过