Action Groups - List By Resource Group

Referentie

Service:: Monitor

API Version:: 2021-09-01

Een lijst met alle actiegroepen in een resourcegroep ophalen.

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

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
subscriptionId	path	True	string	De id van het doelabonnement.
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name	Type	Description
200 OK	ActionGroupList	De aanvraag is voltooid.
Other Status Codes	ErrorResponse	Er is een fout opgetreden en de lijst met actiegroepen kan niet worden opgehaald.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

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

Scopes

Name	Description
user_impersonation	uw gebruikersaccount imiteren

Voorbeelden

List action groups at resource group level

GET https://management.azure.com/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/Default-NotificationRules/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": []
      }
    }
  ]
}

Definities

Name	Description
ActionGroupList	Een lijst met actiegroepen.
ActionGroupResource	Een actiegroepresource.
ArmRoleReceiver	Een armrolontvanger.
AutomationRunbookReceiver	De Azure Automation Runbook-meldingsontvanger.
AzureAppPushReceiver	De ontvanger van pushmeldingen voor mobiele Azure-apps.
AzureFunctionReceiver	Een azure-functieontvanger.
EmailReceiver	Een e-mailontvanger.
ErrorResponse	Beschrijft de indeling van foutantwoord.
EventHubReceiver	Een Event Hub-ontvanger.
ItsmReceiver	Een Itsm-ontvanger.
LogicAppReceiver	Een ontvanger van logische apps.
ReceiverStatus	Geeft de status van de ontvanger aan. Ontvangers die niet zijn ingeschakeld, ontvangen geen communicatie.
SmsReceiver	Een sms-ontvanger.
VoiceReceiver	Een spraakontvanger.
WebhookReceiver	Een webhookontvanger.

ActionGroupList

Een lijst met actiegroepen.

Name	Type	Description
nextLink	string	Biedt de koppeling om de volgende set elementen op te halen.
value	ActionGroupResource[]	De lijst met actiegroepen.

ActionGroupResource

Een actiegroepresource.

Name	Type	Standaardwaarde	Description
id	string		Azure-resource-id
location	string		Resourcelocatie
name	string		Azure-resourcenaam
properties.armRoleReceivers	ArmRoleReceiver[]		De lijst met ARM-rolontvangers die deel uitmaken van deze actiegroep. Rollen zijn Azure RBAC-rollen en alleen ingebouwde rollen worden ondersteund.
properties.automationRunbookReceivers	AutomationRunbookReceiver[]		De lijst met AutomationRunbook-ontvangers die deel uitmaken van deze actiegroep.
properties.azureAppPushReceivers	AzureAppPushReceiver[]		De lijst met AzureAppPush-ontvangers die deel uitmaken van deze actiegroep.
properties.azureFunctionReceivers	AzureFunctionReceiver[]		De lijst met ontvangers van azure-functies die deel uitmaken van deze actiegroep.
properties.emailReceivers	EmailReceiver[]		De lijst met e-mailontvangers die deel uitmaken van deze actiegroep.
properties.enabled	boolean	True	Geeft aan of deze actiegroep is ingeschakeld. Als een actiegroep niet is ingeschakeld, ontvangt geen van de ontvangers hiervan communicatie.
properties.eventHubReceivers	EventHubReceiver[]		De lijst met Event Hub-ontvangers die deel uitmaken van deze actiegroep.
properties.groupShortName	string		De korte naam van de actiegroep. Dit wordt gebruikt in sms-berichten.
properties.itsmReceivers	ItsmReceiver[]		De lijst met ITSM-ontvangers die deel uitmaken van deze actiegroep.
properties.logicAppReceivers	LogicAppReceiver[]		De lijst met ontvangers van logische apps die deel uitmaken van deze actiegroep.
properties.smsReceivers	SmsReceiver[]		De lijst met sms-ontvangers die deel uitmaken van deze actiegroep.
properties.voiceReceivers	VoiceReceiver[]		De lijst met spraakontvangers die deel uitmaken van deze actiegroep.
properties.webhookReceivers	WebhookReceiver[]		De lijst met webhook-ontvangers die deel uitmaken van deze actiegroep.
tags	object		Resourcetags
type	string		Azure-resourcetype

ArmRoleReceiver

Een armrolontvanger.

Name	Type	Standaardwaarde	Description
name	string		De naam van de ontvanger van de armrol. Namen moeten uniek zijn voor alle ontvangers binnen een actiegroep.
roleId	string		De arm-rol-id.
useCommonAlertSchema	boolean	False	Hiermee wordt aangegeven of een algemeen waarschuwingsschema moet worden gebruikt.

AutomationRunbookReceiver

De Azure Automation Runbook-meldingsontvanger.

Name	Type	Standaardwaarde	Description
automationAccountId	string		De Azure Automation-account-id die dit runbook bevat en verifieert bij de Azure-resource.
isGlobalRunbook	boolean		Hiermee wordt aangegeven of dit exemplaar een globaal runbook is.
name	string		Geeft de naam van de webhook aan.
runbookName	string		De naam voor dit runbook.
serviceUri	string		De URI waarnaar webhooks moeten worden verzonden.
useCommonAlertSchema	boolean	False	Hiermee wordt aangegeven of een algemeen waarschuwingsschema moet worden gebruikt.
webhookResourceId	string		De resource-id voor webhook die is gekoppeld aan dit runbook.

AzureAppPushReceiver

De ontvanger van pushmeldingen voor mobiele Azure-apps.

Name	Type	Description
emailAddress	string	Het e-mailadres dat is geregistreerd voor de mobiele Azure-app.
name	string	De naam van de pushontvanger van de mobiele Azure-app. Namen moeten uniek zijn voor alle ontvangers binnen een actiegroep.

AzureFunctionReceiver

Een azure-functieontvanger.

Name	Type	Standaardwaarde	Description
functionAppResourceId	string		De Azure-resource-id van de functie-app.
functionName	string		De functienaam in de functie-app.
httpTriggerUrl	string		De HTTP-trigger-URL waarnaar de HTTP-aanvraag wordt verzonden.
name	string		De naam van de ontvanger van de azure-functie. Namen moeten uniek zijn voor alle ontvangers binnen een actiegroep.
useCommonAlertSchema	boolean	False	Hiermee wordt aangegeven of een algemeen waarschuwingsschema moet worden gebruikt.

EmailReceiver

Een e-mailontvanger.

Name	Type	Standaardwaarde	Description
emailAddress	string		Het e-mailadres van deze ontvanger.
name	string		De naam van de e-mailontvanger. Namen moeten uniek zijn voor alle ontvangers binnen een actiegroep.
status	ReceiverStatus		De ontvangststatus van het e-mailbericht.
useCommonAlertSchema	boolean	False	Hiermee wordt aangegeven of een algemeen waarschuwingsschema moet worden gebruikt.

ErrorResponse

Beschrijft de indeling van foutantwoord.

Name	Type	Description
code	string	Foutcode
message	string	Foutbericht waarin wordt aangegeven waarom de bewerking is mislukt.

EventHubReceiver

Een Event Hub-ontvanger.

Name	Type	Standaardwaarde	Description
eventHubName	string		De naam van de specifieke Event Hub-wachtrij
eventHubNameSpace	string		De Event Hub-naamruimte
name	string		De naam van de Event Hub-ontvanger. Namen moeten uniek zijn voor alle ontvangers binnen een actiegroep.
subscriptionId	string		De id voor het abonnement dat deze Event Hub bevat
tenantId	string		De tenant-id voor het abonnement dat deze Event Hub bevat
useCommonAlertSchema	boolean	False	Hiermee wordt aangegeven of een algemeen waarschuwingsschema moet worden gebruikt.

ItsmReceiver

Een Itsm-ontvanger.

Name	Type	Description
connectionId	string	Unieke identificatie van ITSM-verbinding tussen meerdere die in de bovenstaande werkruimte zijn gedefinieerd.
name	string	De naam van de Itsm-ontvanger. Namen moeten uniek zijn voor alle ontvangers binnen een actiegroep.
region	string	Regio waarin de werkruimte zich bevindt. Ondersteunde waarden:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope'
ticketConfiguration	string	JSON-blob voor de configuraties van de ITSM-actie. De optie CreateMultipleWorkItems maakt ook deel uit van deze blob.
workspaceId	string	OMS LA-exemplaar-id.

LogicAppReceiver

Een ontvanger van logische apps.

Name	Type	Standaardwaarde	Description
callbackUrl	string		De callback-URL waarnaar de HTTP-aanvraag wordt verzonden.
name	string		De naam van de ontvanger van de logische app. Namen moeten uniek zijn voor alle ontvangers binnen een actiegroep.
resourceId	string		De Azure-resource-id van de ontvanger van de logische app.
useCommonAlertSchema	boolean	False	Hiermee wordt aangegeven of een algemeen waarschuwingsschema moet worden gebruikt.

ReceiverStatus

Geeft de status van de ontvanger aan. Ontvangers die niet zijn ingeschakeld, ontvangen geen communicatie.

Name	Type	Description
Disabled	string
Enabled	string
NotSpecified	string

SmsReceiver

Een sms-ontvanger.

Name	Type	Description
countryCode	string	De landcode van de sms-ontvanger.
name	string	De naam van de sms-ontvanger. Namen moeten uniek zijn voor alle ontvangers binnen een actiegroep.
phoneNumber	string	Het telefoonnummer van de sms-ontvanger.
status	ReceiverStatus	De status van de ontvanger.

VoiceReceiver

Een spraakontvanger.

Name	Type	Description
countryCode	string	De landcode van de spraakontvanger.
name	string	De naam van de spraakontvanger. Namen moeten uniek zijn voor alle ontvangers binnen een actiegroep.
phoneNumber	string	Het telefoonnummer van de spraakontvanger.

WebhookReceiver

Een webhookontvanger.

Name	Type	Standaardwaarde	Description
identifierUri	string		Geeft de id-URI voor aad-verificatie aan.
name	string		De naam van de webhookontvanger. Namen moeten uniek zijn voor alle ontvangers binnen een actiegroep.
objectId	string		Geeft de object-id van de webhook-app aan voor aad-verificatie.
serviceUri	string		De URI waarnaar webhooks moeten worden verzonden.
tenantId	string		Geeft de tenant-id voor aad-verificatie aan.
useAadAuth	boolean	False	Hiermee wordt aangegeven of AAD-verificatie al dan niet wordt gebruikt.
useCommonAlertSchema	boolean	False	Hiermee wordt aangegeven of een algemeen waarschuwingsschema moet worden gebruikt.