Action Groups - List By Subscription Id

Referens

Service:: Monitor

API Version:: 2021-09-01

Hämta en lista över alla åtgärdsgrupper i en prenumeration.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
subscriptionId	path	True	string	ID för målprenumerationen.
api-version	query	True	string	Den API-version som ska användas för den här åtgärden.

Svar

Name	Typ	Description
200 OK	ActionGroupList	Begäran lyckades.
Other Status Codes	ErrorResponse	Ett fel uppstod och listan över åtgärdsgrupper kunde inte hämtas.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

List action groups at subscription level

GET https://management.azure.com/subscriptions/187f412d-1758-44d9-b052-169e2564721d/providers/Microsoft.Insights/actionGroups?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/listActionGroups.json
func ExampleActionGroupsClient_NewListByResourceGroupPager() {
	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
	}
	pager := client.NewListByResourceGroupPager("<resource-group-name>",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
			return
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "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": []
      }
    },
    {
      "id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/Default-NotificationRules/providers/microsoft.insights/actionGroups/SampleActionGroup2",
      "type": "Microsoft.Insights/ActionGroups",
      "name": "SampleActionGroup2",
      "location": "Global",
      "tags": {},
      "properties": {
        "groupShortName": "sample2",
        "enabled": false,
        "emailReceivers": [
          {
            "name": "John Doe's email",
            "emailAddress": "johndoe@email.com",
            "status": "Enabled",
            "useCommonAlertSchema": true
          }
        ],
        "smsReceivers": [
          {
            "name": "Jane Smith's mobile",
            "countryCode": "1",
            "phoneNumber": "0987654321",
            "status": "Enabled"
          }
        ],
        "webhookReceivers": [],
        "itsmReceivers": [],
        "azureAppPushReceivers": [],
        "automationRunbookReceivers": [],
        "voiceReceivers": [],
        "logicAppReceivers": [],
        "azureFunctionReceivers": [],
        "armRoleReceivers": [],
        "eventHubReceivers": []
      }
    }
  ]
}

Definitioner

Name	Description
ActionGroupList	En lista över åtgärdsgrupper.
ActionGroupResource	En åtgärdsgruppsresurs.
ArmRoleReceiver	En armrollsmottagare.
AutomationRunbookReceiver	Azure Automation Runbook-meddelandemottagare.
AzureAppPushReceiver	Push-meddelandemottagaren för Azure Mobile App.
AzureFunctionReceiver	En azure-funktionsmottagare.
EmailReceiver	En e-postmottagare.
ErrorResponse	Beskriver formatet felsvar.
EventHubReceiver	En händelsehubbmottagare.
ItsmReceiver	En Itsm-mottagare.
LogicAppReceiver	En logikappsmottagare.
ReceiverStatus	Anger mottagarens status. Mottagare som inte är aktiverade får ingen kommunikation.
SmsReceiver	En SMS-mottagare.
VoiceReceiver	En röstmottagare.
WebhookReceiver	En webhook-mottagare.

ActionGroupList

En lista över åtgärdsgrupper.

Name	Typ	Description
nextLink	string	Innehåller länken för att hämta nästa uppsättning element.
value	ActionGroupResource[]	Listan över åtgärdsgrupper.

ActionGroupResource

En åtgärdsgruppsresurs.

Name	Typ	Standardvärde	Description
id	string		Azure-resurs-ID
location	string		Resursplats
name	string		Azure-resursnamn
properties.armRoleReceivers	ArmRoleReceiver[]		Listan över ARM-rollmottagare som ingår i den här åtgärdsgruppen. Roller är Azure RBAC-roller och endast inbyggda roller stöds.
properties.automationRunbookReceivers	AutomationRunbookReceiver[]		Listan över AutomationRunbook-mottagare som ingår i den här åtgärdsgruppen.
properties.azureAppPushReceivers	AzureAppPushReceiver[]		Listan över AzureAppPush-mottagare som ingår i den här åtgärdsgruppen.
properties.azureFunctionReceivers	AzureFunctionReceiver[]		Listan över azure-funktionsmottagare som ingår i den här åtgärdsgruppen.
properties.emailReceivers	EmailReceiver[]		Listan över e-postmottagare som ingår i den här åtgärdsgruppen.
properties.enabled	boolean	True	Anger om den här åtgärdsgruppen är aktiverad. Om en åtgärdsgrupp inte är aktiverad får ingen av dess mottagare kommunikation.
properties.eventHubReceivers	EventHubReceiver[]		Listan över event hub-mottagare som ingår i den här åtgärdsgruppen.
properties.groupShortName	string		Åtgärdsgruppens korta namn. Detta kommer att användas i SMS.
properties.itsmReceivers	ItsmReceiver[]		Listan över ITSM-mottagare som ingår i den här åtgärdsgruppen.
properties.logicAppReceivers	LogicAppReceiver[]		Listan över logic app-mottagare som ingår i den här åtgärdsgruppen.
properties.smsReceivers	SmsReceiver[]		Listan över SMS-mottagare som ingår i den här åtgärdsgruppen.
properties.voiceReceivers	VoiceReceiver[]		Listan över röstmottagare som ingår i den här åtgärdsgruppen.
properties.webhookReceivers	WebhookReceiver[]		Listan över webhook-mottagare som ingår i den här åtgärdsgruppen.
tags	object		Resurstaggar
type	string		Azure-resurstyp

ArmRoleReceiver

En armrollsmottagare.

Name	Typ	Standardvärde	Description
name	string		Namnet på armrollmottagaren. Namn måste vara unika för alla mottagare i en åtgärdsgrupp.
roleId	string		Armrolls-ID: t.
useCommonAlertSchema	boolean	False	Anger om du vill använda ett vanligt aviseringsschema.

AutomationRunbookReceiver

Azure Automation Runbook-meddelandemottagare.

Name	Typ	Standardvärde	Description
automationAccountId	string		Azure Automation-konto-ID:t som innehåller den här runbooken och autentiserar till Azure-resursen.
isGlobalRunbook	boolean		Anger om den här instansen är en global runbook.
name	string		Anger namnet på webhooken.
runbookName	string		Namnet på den här runbooken.
serviceUri	string		Den URI där webhooks ska skickas.
useCommonAlertSchema	boolean	False	Anger om du vill använda ett vanligt aviseringsschema.
webhookResourceId	string		Resurs-ID:t för webhook som är länkat till den här runbooken.

AzureAppPushReceiver

Push-meddelandemottagaren för Azure Mobile App.

Name	Typ	Description
emailAddress	string	Den e-postadress som registrerats för Azure-mobilappen.
name	string	Namnet på Azure-mobilappens push-mottagare. Namn måste vara unika för alla mottagare i en åtgärdsgrupp.

AzureFunctionReceiver

En azure-funktionsmottagare.

Name	Typ	Standardvärde	Description
functionAppResourceId	string		Azure-resurs-ID för funktionsappen.
functionName	string		Funktionsnamnet i funktionsappen.
httpTriggerUrl	string		HTTP-utlösarens URL där http-begäran skickades till.
name	string		Namnet på azure-funktionsmottagaren. Namn måste vara unika för alla mottagare i en åtgärdsgrupp.
useCommonAlertSchema	boolean	False	Anger om du vill använda ett vanligt aviseringsschema.

EmailReceiver

En e-postmottagare.

Name	Typ	Standardvärde	Description
emailAddress	string		Mottagarens e-postadress.
name	string		Namnet på e-postmottagaren. Namn måste vara unika för alla mottagare i en åtgärdsgrupp.
status	ReceiverStatus		Mottagarens status för e-postmeddelandet.
useCommonAlertSchema	boolean	False	Anger om du vill använda ett vanligt aviseringsschema.

ErrorResponse

Beskriver formatet felsvar.

Name	Typ	Description
code	string	Felkod
message	string	Felmeddelande som anger varför åtgärden misslyckades.

EventHubReceiver

En händelsehubbmottagare.

Name	Typ	Standardvärde	Description
eventHubName	string		Namnet på den specifika Event Hub-kön
eventHubNameSpace	string		Event Hub-namnområdet
name	string		Namnet på händelsehubbens mottagare. Namn måste vara unika för alla mottagare i en åtgärdsgrupp.
subscriptionId	string		ID:t för prenumerationen som innehåller den här händelsehubben
tenantId	string		Klient-ID:t för prenumerationen som innehåller den här händelsehubben
useCommonAlertSchema	boolean	False	Anger om du vill använda ett vanligt aviseringsschema.

ItsmReceiver

En Itsm-mottagare.

Name	Typ	Description
connectionId	string	Unik identifiering av ITSM-anslutning mellan flera som definierats i ovanstående arbetsyta.
name	string	Namnet på Itsm-mottagaren. Namn måste vara unika för alla mottagare i en åtgärdsgrupp.
region	string	Region där arbetsytan finns. Värden som stöds:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope'
ticketConfiguration	string	JSON-blob för konfigurationerna av ITSM-åtgärden. Alternativet CreateMultipleWorkItems ingår också i den här bloben.
workspaceId	string	OMS LA-instansidentifierare.

LogicAppReceiver

En logikappsmottagare.

Name	Typ	Standardvärde	Description
callbackUrl	string		Återanrops-URL:en som http-begäran skickades till.
name	string		Namnet på logikappmottagaren. Namn måste vara unika för alla mottagare i en åtgärdsgrupp.
resourceId	string		Azure-resurs-ID för logikappmottagaren.
useCommonAlertSchema	boolean	False	Anger om du vill använda ett vanligt aviseringsschema.

ReceiverStatus

Anger mottagarens status. Mottagare som inte är aktiverade får ingen kommunikation.

Name	Typ	Description
Disabled	string
Enabled	string
NotSpecified	string

SmsReceiver

En SMS-mottagare.

Name	Typ	Description
countryCode	string	Landskoden för SMS-mottagaren.
name	string	Namnet på SMS-mottagaren. Namn måste vara unika för alla mottagare i en åtgärdsgrupp.
phoneNumber	string	SMS-mottagarens telefonnummer.
status	ReceiverStatus	Mottagarens status.

VoiceReceiver

En röstmottagare.

Name	Typ	Description
countryCode	string	Landskoden för röstmottagaren.
name	string	Namnet på röstmottagaren. Namn måste vara unika för alla mottagare i en åtgärdsgrupp.
phoneNumber	string	Röstmottagarens telefonnummer.

WebhookReceiver

En webhook-mottagare.

Name	Typ	Standardvärde	Description
identifierUri	string		Anger identifierar-URI för aad-autentisering.
name	string		Namnet på webhookens mottagare. Namn måste vara unika för alla mottagare i en åtgärdsgrupp.
objectId	string		Anger webhooksappens objekt-ID för aad-autentisering.
serviceUri	string		Den URI där webhooks ska skickas.
tenantId	string		Anger klient-ID för aad-autentisering.
useAadAuth	boolean	False	Anger om AAD-autentisering ska användas eller inte.
useCommonAlertSchema	boolean	False	Anger om du vill använda ett vanligt aviseringsschema.