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	Идентификатор целевой подписки.
api-version	query	True	string	Версия API, используемая для данной операции.

Ответы

Имя	Тип	Описание
200 OK	ActionGroupResource	Запрос выполнен успешно.
Other Status Codes	ErrorResponse	Произошла ошибка, и не удалось получить группу действий. 404: группа действий не существует.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Тип: oauth2
Flow: 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": "[email protected]",
        "status": "Enabled",
        "useCommonAlertSchema": true
      },
      {
        "name": "Jane Smith's email",
        "emailAddress": "[email protected]",
        "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	Получатель роли руки.
AutomationRunbookReceiver	Приемник уведомлений Runbook служба автоматизации Azure.
AzureAppPushReceiver	Приемник push-уведомлений мобильного приложения Azure.
AzureFunctionReceiver	Приемник функции Azure.
EmailReceiver	Получатель электронной почты.
ErrorResponse	Описывает формат ответа об ошибке.
EventHubReceiver	Приемник концентратора событий.
ItsmReceiver	Приемник Itsm.
LogicAppReceiver	Приемник приложения логики.
ReceiverStatus	Указывает состояние получателя. Получатели, которые не включены, не будут получать никаких сообщений.
SmsReceiver	Получатель SMS.
VoiceReceiver	Голосовой приемник.
WebhookReceiver	Приемник веб-перехватчика.

ActionGroupResource

Ресурс группы действий.

Имя	Тип	Default value	Описание
id	string		Идентификатор ресурса Azure
location	string		Расположение ресурса
name	string		Имя ресурса Azure
properties.armRoleReceivers	ArmRoleReceiver[]		Список получателей ролей ARM, входящих в эту группу действий. Роли — это роли RBAC Azure, и поддерживаются только встроенные роли.
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		Короткое имя группы действий. Он будет использоваться в SMS-сообщениях.
properties.itsmReceivers	ItsmReceiver[]		Список получателей ITSM, входящих в эту группу действий.
properties.logicAppReceivers	LogicAppReceiver[]		Список получателей приложений логики, входящих в эту группу действий.
properties.smsReceivers	SmsReceiver[]		Список получателей SMS, входящих в эту группу действий.
properties.voiceReceivers	VoiceReceiver[]		Список голосовых приемников, входящих в эту группу действий.
properties.webhookReceivers	WebhookReceiver[]		Список приемников веб-перехватчиков, входящих в эту группу действий.
tags	object		Теги ресурсов
type	string		Тип ресурса Azure

ArmRoleReceiver

Получатель роли руки.

Имя	Тип	Default value	Описание
name	string		Имя получателя роли руки. Имена должны быть уникальными для всех получателей в группе действий.
roleId	string		Идентификатор роли руки.
useCommonAlertSchema	boolean	False	Указывает, следует ли использовать общую схему оповещений.

AutomationRunbookReceiver

Приемник уведомлений Runbook служба автоматизации Azure.

Имя	Тип	Default value	Описание
automationAccountId	string		Идентификатор учетной записи службы автоматизации Azure, в которой хранится этот модуль Runbook, и выполняется проверка подлинности в ресурсе Azure.
isGlobalRunbook	boolean		Указывает, является ли этот экземпляр глобальным runbook.
name	string		Указывает имя веб-перехватчика.
runbookName	string		Имя этого модуля Runbook.
serviceUri	string		Универсальный код ресурса (URI), по которому должны отправляться веб-перехватчики.
useCommonAlertSchema	boolean	False	Указывает, следует ли использовать общую схему оповещений.
webhookResourceId	string		Идентификатор ресурса для веб-перехватчика, связанного с этим модулю Runbook.

AzureAppPushReceiver

Приемник push-уведомлений мобильного приложения Azure.

Имя	Тип	Описание
emailAddress	string	Адрес электронной почты, зарегистрированный для мобильного приложения Azure.
name	string	Имя получателя push-уведомлений мобильного приложения Azure. Имена должны быть уникальными для всех получателей в группе действий.

AzureFunctionReceiver

Приемник функции Azure.

Имя	Тип	Default value	Описание
functionAppResourceId	string		Идентификатор ресурса Azure приложения-функции.
functionName	string		Имя функции в приложении-функции.
httpTriggerUrl	string		URL-адрес триггера HTTP, куда отправляется HTTP-запрос.
name	string		Имя приемника функции Azure. Имена должны быть уникальными для всех получателей в группе действий.
useCommonAlertSchema	boolean	False	Указывает, следует ли использовать общую схему оповещений.

EmailReceiver

Получатель электронной почты.

Имя	Тип	Default value	Описание
emailAddress	string		Адрес электронной почты этого получателя.
name	string		Имя получателя электронной почты. Имена должны быть уникальными для всех получателей в группе действий.
status	ReceiverStatus		Состояние получателя сообщения электронной почты.
useCommonAlertSchema	boolean	False	Указывает, следует ли использовать общую схему оповещений.

ErrorResponse

Описывает формат ответа об ошибке.

Имя	Тип	Описание
code	string	Код ошибки
message	string	Сообщение об ошибке, указывающее, почему операция завершилась сбоем.

EventHubReceiver

Приемник концентратора событий.

Имя	Тип	Default value	Описание
eventHubName	string		Имя конкретной очереди концентратора событий
eventHubNameSpace	string		Пространство имен концентратора событий
name	string		Имя приемника концентратора событий. Имена должны быть уникальными для всех получателей в группе действий.
subscriptionId	string		Идентификатор подписки, содержащей этот концентратор событий.
tenantId	string		Идентификатор клиента для подписки, содержащей этот концентратор событий.
useCommonAlertSchema	boolean	False	Указывает, следует ли использовать общую схему оповещений.

ItsmReceiver

Приемник Itsm.

Имя	Тип	Описание
connectionId	string	Уникальная идентификация подключения ITSM между несколькими элементами, определенными в приведенной выше рабочей области.
name	string	Имя приемника Itsm. Имена должны быть уникальными для всех получателей в группе действий.
region	string	Регион, в котором находится рабочая область. Поддерживаемые значения:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope'
ticketConfiguration	string	Большой двоичный объект JSON для конфигураций действия ITSM. Параметр CreateMultipleWorkItems также будет частью этого большого двоичного объекта.
workspaceId	string	Идентификатор экземпляра OMS LA.

LogicAppReceiver

Приемник приложения логики.

Имя	Тип	Default value	Описание
callbackUrl	string		URL-адрес обратного вызова, куда отправляется HTTP-запрос.
name	string		Имя получателя приложения логики. Имена должны быть уникальными для всех получателей в группе действий.
resourceId	string		Идентификатор ресурса Azure получателя приложения логики.
useCommonAlertSchema	boolean	False	Указывает, следует ли использовать общую схему оповещений.

ReceiverStatus

Указывает состояние получателя. Получатели, которые не включены, не будут получать никаких сообщений.

Имя	Тип	Описание
Disabled	string
Enabled	string
NotSpecified	string

SmsReceiver

Получатель SMS.

Имя	Тип	Описание
countryCode	string	Код страны получателя SMS.
name	string	Имя получателя SMS. Имена должны быть уникальными для всех получателей в группе действий.
phoneNumber	string	Номер телефона получателя SMS.
status	ReceiverStatus	Состояние получателя.

VoiceReceiver

Голосовой приемник.

Имя	Тип	Описание
countryCode	string	Код страны голосового приемника.
name	string	Имя голосового приемника. Имена должны быть уникальными для всех получателей в группе действий.
phoneNumber	string	Номер телефона голосового приемника.

WebhookReceiver

Приемник веб-перехватчика.

Имя	Тип	Default value	Описание
identifierUri	string		Указывает URI идентификатора для проверки подлинности aad.
name	string		Имя получателя веб-перехватчика. Имена должны быть уникальными для всех получателей в группе действий.
objectId	string		Указывает идентификатор объекта приложения веб-перехватчика для проверки подлинности aad.
serviceUri	string		Универсальный код ресурса (URI), по которому должны отправляться веб-перехватчики.
tenantId	string		Указывает идентификатор клиента для проверки подлинности aad.
useAadAuth	boolean	False	Указывает, используется ли проверка подлинности AAD.
useCommonAlertSchema	boolean	False	Указывает, следует ли использовать общую схему оповещений.

Поделиться через