Action Groups - Get

Odwołanie

Usługa:: Monitor

Wersja interfejsu API:: 2021-09-01

Pobierz grupę akcji.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
actionGroupName	path	True	string	Nazwa grupy akcji.
resourceGroupName	path	True	string	Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
subscriptionId	path	True	string	Identyfikator subskrypcji docelowej.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ActionGroupResource	Żądanie zakończyło się pomyślnie.
Other Status Codes	ErrorResponse	Wystąpił błąd i nie można pobrać grupy akcji. 404: Grupa akcji nie istnieje.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

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

Przykładowa odpowiedź

Kod stanu:: 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": []
  }
}

Definicje

Nazwa	Opis
ActionGroupResource	Zasób grupy akcji.
ArmRoleReceiver	Odbiornik roli arm.
AutomationRunbookReceiver	Odbiornik powiadomień elementu Runbook Azure Automation.
AzureAppPushReceiver	Odbiornik powiadomień wypychanych aplikacji mobilnych platformy Azure.
AzureFunctionReceiver	Odbiornik funkcji platformy Azure.
EmailReceiver	Odbiorca wiadomości e-mail.
ErrorResponse	Opisuje format odpowiedzi Błąd.
EventHubReceiver	Odbiornik centrum zdarzeń.
ItsmReceiver	Odbiornik Itsm.
LogicAppReceiver	Odbiornik aplikacji logiki.
ReceiverStatus	Wskazuje stan odbiornika. Odbiorniki, które nie są włączone, nie będą otrzymywać żadnej komunikacji.
SmsReceiver	Odbiornik SMS.
VoiceReceiver	Odbiornik głosowy.
WebhookReceiver	Odbiornik elementu webhook.

ActionGroupResource

Zasób grupy akcji.

Nazwa	Typ	Domyślna wartość	Opis
id	string		Identyfikator zasobu platformy Azure
location	string		Lokalizacja zasobu
name	string		Nazwa zasobu platformy Azure
properties.armRoleReceivers	ArmRoleReceiver[]		Lista odbiorników ról usługi ARM, które są częścią tej grupy akcji. Role to role RBAC platformy Azure i obsługiwane są tylko role wbudowane.
properties.automationRunbookReceivers	AutomationRunbookReceiver[]		Lista odbiorników AutomationRunbook, które są częścią tej grupy akcji.
properties.azureAppPushReceivers	AzureAppPushReceiver[]		Lista odbiorników usługi AzureAppPush, które są częścią tej grupy akcji.
properties.azureFunctionReceivers	AzureFunctionReceiver[]		Lista odbiorników funkcji platformy Azure, które są częścią tej grupy akcji.
properties.emailReceivers	EmailReceiver[]		Lista odbiorców poczty e-mail, które są częścią tej grupy akcji.
properties.enabled	boolean	True	Wskazuje, czy ta grupa akcji jest włączona. Jeśli grupa akcji nie jest włączona, żaden z jej odbiorników nie otrzyma komunikacji.
properties.eventHubReceivers	EventHubReceiver[]		Lista odbiorników centrum zdarzeń, które są częścią tej grupy akcji.
properties.groupShortName	string		Krótka nazwa grupy akcji. Będzie on używany w wiadomościach SMS.
properties.itsmReceivers	ItsmReceiver[]		Lista odbiorników ITSM, które są częścią tej grupy akcji.
properties.logicAppReceivers	LogicAppReceiver[]		Lista odbiorników aplikacji logiki, które są częścią tej grupy akcji.
properties.smsReceivers	SmsReceiver[]		Lista odbiorników programu SMS, które są częścią tej grupy akcji.
properties.voiceReceivers	VoiceReceiver[]		Lista odbiorników głosowych, które są częścią tej grupy akcji.
properties.webhookReceivers	WebhookReceiver[]		Lista odbiorników elementów webhook, które są częścią tej grupy akcji.
tags	object		Tagi zasobów
type	string		Typ zasobu platformy Azure

ArmRoleReceiver

Odbiornik roli arm.

Nazwa	Typ	Domyślna wartość	Opis
name	string		Nazwa odbiornika roli arm. Nazwy muszą być unikatowe we wszystkich odbiornikach w grupie akcji.
roleId	string		Identyfikator roli arm.
useCommonAlertSchema	boolean	False	Wskazuje, czy używać wspólnego schematu alertów.

AutomationRunbookReceiver

Odbiornik powiadomień elementu Runbook Azure Automation.

Nazwa	Typ	Domyślna wartość	Opis
automationAccountId	string		Identyfikator konta usługi Azure Automation, który przechowuje ten element Runbook i uwierzytelnia się w zasobie platformy Azure.
isGlobalRunbook	boolean		Wskazuje, czy to wystąpienie jest globalnym elementem Runbook.
name	string		Wskazuje nazwę elementu webhook.
runbookName	string		Nazwa tego elementu Runbook.
serviceUri	string		Identyfikator URI, w którym powinny być wysyłane elementy webhook.
useCommonAlertSchema	boolean	False	Wskazuje, czy używać wspólnego schematu alertów.
webhookResourceId	string		Identyfikator zasobu elementu webhook połączony z tym elementem Runbook.

AzureAppPushReceiver

Odbiornik powiadomień wypychanych aplikacji mobilnych platformy Azure.

Nazwa	Typ	Opis
emailAddress	string	Adres e-mail zarejestrowany dla aplikacji mobilnej platformy Azure.
name	string	Nazwa odbiornika wypychania aplikacji mobilnej platformy Azure. Nazwy muszą być unikatowe we wszystkich odbiornikach w grupie akcji.

AzureFunctionReceiver

Odbiornik funkcji platformy Azure.

Nazwa	Typ	Domyślna wartość	Opis
functionAppResourceId	string		Identyfikator zasobu platformy Azure aplikacji funkcji.
functionName	string		Nazwa funkcji w aplikacji funkcji.
httpTriggerUrl	string		Adres URL wyzwalacza HTTP, do którego wysłano żądanie HTTP.
name	string		Nazwa odbiornika funkcji platformy Azure. Nazwy muszą być unikatowe we wszystkich odbiornikach w grupie akcji.
useCommonAlertSchema	boolean	False	Wskazuje, czy używać wspólnego schematu alertów.

EmailReceiver

Odbiorca wiadomości e-mail.

Nazwa	Typ	Domyślna wartość	Opis
emailAddress	string		Adres e-mail tego odbiorcy.
name	string		Nazwa odbiorcy poczty e-mail. Nazwy muszą być unikatowe we wszystkich odbiornikach w grupie akcji.
status	ReceiverStatus		Stan odbiorcy wiadomości e-mail.
useCommonAlertSchema	boolean	False	Wskazuje, czy używać wspólnego schematu alertów.

ErrorResponse

Opisuje format odpowiedzi Błąd.

Nazwa	Typ	Opis
code	string	Kod błędu
message	string	Komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się.

EventHubReceiver

Odbiornik centrum zdarzeń.

Nazwa	Typ	Domyślna wartość	Opis
eventHubName	string		Nazwa określonej kolejki centrum zdarzeń
eventHubNameSpace	string		Przestrzeń nazw centrum zdarzeń
name	string		Nazwa odbiorcy centrum zdarzeń. Nazwy muszą być unikatowe we wszystkich odbiornikach w grupie akcji.
subscriptionId	string		Identyfikator subskrypcji zawierającej to centrum zdarzeń
tenantId	string		Identyfikator dzierżawy subskrypcji zawierającej to centrum zdarzeń
useCommonAlertSchema	boolean	False	Wskazuje, czy używać wspólnego schematu alertów.

ItsmReceiver

Odbiornik Itsm.

Nazwa	Typ	Opis
connectionId	string	Unikatowa identyfikacja połączenia ITSM między wieloma zdefiniowanymi w powyższym obszarze roboczym.
name	string	Nazwa odbiornika Itsm. Nazwy muszą być unikatowe we wszystkich odbiornikach w grupie akcji.
region	string	Region, w którym znajduje się obszar roboczy. Obsługiwane wartości:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope'
ticketConfiguration	string	Obiekt blob JSON dla konfiguracji akcji ITSM. Opcja CreateMultipleWorkItems będzie również częścią tego obiektu blob.
workspaceId	string	Identyfikator wystąpienia usługi OMS LA.

LogicAppReceiver

Odbiornik aplikacji logiki.

Nazwa	Typ	Domyślna wartość	Opis
callbackUrl	string		Adres URL wywołania zwrotnego, do którego wysłano żądanie HTTP.
name	string		Nazwa odbiornika aplikacji logiki. Nazwy muszą być unikatowe we wszystkich odbiornikach w grupie akcji.
resourceId	string		Identyfikator zasobu platformy Azure odbiorcy aplikacji logiki.
useCommonAlertSchema	boolean	False	Wskazuje, czy używać wspólnego schematu alertów.

ReceiverStatus

Wskazuje stan odbiornika. Odbiorniki, które nie są włączone, nie będą otrzymywać żadnej komunikacji.

Nazwa	Typ	Opis
Disabled	string
Enabled	string
NotSpecified	string

SmsReceiver

Odbiornik SMS.

Nazwa	Typ	Opis
countryCode	string	Kod kraju odbiorcy wiadomości SMS.
name	string	Nazwa odbiornika programu SMS. Nazwy muszą być unikatowe we wszystkich odbiornikach w grupie akcji.
phoneNumber	string	Numer telefonu odbiorcy wiadomości SMS.
status	ReceiverStatus	Stan odbiornika.

VoiceReceiver

Odbiornik głosowy.

Nazwa	Typ	Opis
countryCode	string	Kod kraju odbiornika głosowego.
name	string	Nazwa odbiornika głosowego. Nazwy muszą być unikatowe we wszystkich odbiornikach w grupie akcji.
phoneNumber	string	Numer telefonu odbiornika głosowego.

WebhookReceiver

Odbiornik elementu webhook.

Nazwa	Typ	Domyślna wartość	Opis
identifierUri	string		Wskazuje identyfikator URI dla uwierzytelniania usługi aad.
name	string		Nazwa odbiornika elementu webhook. Nazwy muszą być unikatowe we wszystkich odbiornikach w grupie akcji.
objectId	string		Wskazuje identyfikator obiektu aplikacji elementu webhook dla uwierzytelniania usługi aad.
serviceUri	string		Identyfikator URI, w którym powinny być wysyłane elementy webhook.
tenantId	string		Wskazuje identyfikator dzierżawy dla uwierzytelniania usługi aad.
useAadAuth	boolean	False	Wskazuje, czy używać uwierzytelniania usługi AAD.
useCommonAlertSchema	boolean	False	Wskazuje, czy używać wspólnego schematu alertów.

Udostępnij za pośrednictwem