Action Groups - List By Subscription Id

Referensi

Service:: Monitor

API Version:: 2021-09-01

Dapatkan daftar semua grup tindakan dalam langganan.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
subscriptionId	path	True	string	ID langganan target.
api-version	query	True	string	Versi API yang digunakan untuk operasi ini.

Respons

Nama	Jenis	Deskripsi
200 OK	ActionGroupList	Permintaan berhasil.
Other Status Codes	ErrorResponse	Terjadi kesalahan dan daftar grup tindakan tidak dapat diambil.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

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

Scopes

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

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

Definisi

Nama	Deskripsi
ActionGroupList	Daftar grup tindakan.
ActionGroupResource	Sumber daya grup tindakan.
ArmRoleReceiver	Penerima peran lengan.
AutomationRunbookReceiver	Penerima pemberitahuan Azure Automation Runbook.
AzureAppPushReceiver	Penerima pemberitahuan push Aplikasi seluler Azure.
AzureFunctionReceiver	Penerima fungsi azure.
EmailReceiver	Penerima email.
ErrorResponse	Menjelaskan format respons Kesalahan.
EventHubReceiver	Penerima pusat aktivitas.
ItsmReceiver	Penerima Itsm.
LogicAppReceiver	Penerima aplikasi logika.
ReceiverStatus	Menunjukkan status penerima. Penerima yang tidak Diaktifkan tidak akan menerima komunikasi apa pun.
SmsReceiver	Penerima SMS.
VoiceReceiver	Penerima suara.
WebhookReceiver	Penerima webhook.

ActionGroupList

Daftar grup tindakan.

Nama	Jenis	Deskripsi
nextLink	string	Menyediakan tautan untuk mengambil set elemen berikutnya.
value	ActionGroupResource[]	Daftar grup tindakan.

ActionGroupResource

Sumber daya grup tindakan.

Nama	Jenis	Nilai Default	Deskripsi
id	string		Id sumber daya Azure
location	string		Lokasi sumber daya
name	string		Nama sumber daya Azure
properties.armRoleReceivers	ArmRoleReceiver[]		Daftar penerima peran ARM yang merupakan bagian dari grup tindakan ini. Peran adalah peran Azure RBAC dan hanya peran bawaan yang didukung.
properties.automationRunbookReceivers	AutomationRunbookReceiver[]		Daftar penerima AutomationRunbook yang merupakan bagian dari grup tindakan ini.
properties.azureAppPushReceivers	AzureAppPushReceiver[]		Daftar penerima AzureAppPush yang merupakan bagian dari grup tindakan ini.
properties.azureFunctionReceivers	AzureFunctionReceiver[]		Daftar penerima fungsi azure yang merupakan bagian dari grup tindakan ini.
properties.emailReceivers	EmailReceiver[]		Daftar penerima email yang merupakan bagian dari grup tindakan ini.
properties.enabled	boolean	True	Menunjukkan apakah grup tindakan ini diaktifkan. Jika grup tindakan tidak diaktifkan, maka tidak ada penerimanya yang akan menerima komunikasi.
properties.eventHubReceivers	EventHubReceiver[]		Daftar penerima pusat aktivitas yang merupakan bagian dari grup tindakan ini.
properties.groupShortName	string		Nama pendek grup tindakan. Ini akan digunakan dalam pesan SMS.
properties.itsmReceivers	ItsmReceiver[]		Daftar penerima ITSM yang merupakan bagian dari grup tindakan ini.
properties.logicAppReceivers	LogicAppReceiver[]		Daftar penerima aplikasi logika yang merupakan bagian dari grup tindakan ini.
properties.smsReceivers	SmsReceiver[]		Daftar penerima SMS yang merupakan bagian dari grup tindakan ini.
properties.voiceReceivers	VoiceReceiver[]		Daftar penerima suara yang merupakan bagian dari grup tindakan ini.
properties.webhookReceivers	WebhookReceiver[]		Daftar penerima webhook yang merupakan bagian dari grup tindakan ini.
tags	object		Tag sumber daya
type	string		Jenis sumber daya Azure

ArmRoleReceiver

Penerima peran lengan.

Nama	Jenis	Nilai Default	Deskripsi
name	string		Nama penerima peran lengan. Nama harus unik di semua penerima dalam grup tindakan.
roleId	string		Id peran lengan.
useCommonAlertSchema	boolean	False	Menunjukkan apakah akan menggunakan skema pemberitahuan umum.

AutomationRunbookReceiver

Penerima pemberitahuan Azure Automation Runbook.

Nama	Jenis	Nilai Default	Deskripsi
automationAccountId	string		Id akun azure automation yang menyimpan runbook ini dan mengautentikasi ke sumber daya Azure.
isGlobalRunbook	boolean		Menunjukkan apakah instans ini adalah runbook global.
name	string		Menunjukkan nama webhook.
runbookName	string		Nama untuk runbook ini.
serviceUri	string		URI tempat webhook harus dikirim.
useCommonAlertSchema	boolean	False	Menunjukkan apakah akan menggunakan skema pemberitahuan umum.
webhookResourceId	string		Id sumber daya untuk webhook yang ditautkan ke runbook ini.

AzureAppPushReceiver

Penerima pemberitahuan push Aplikasi seluler Azure.

Nama	Jenis	Deskripsi
emailAddress	string	Alamat email yang terdaftar untuk aplikasi seluler Azure.
name	string	Nama penerima push aplikasi seluler Azure. Nama harus unik di semua penerima dalam grup tindakan.

AzureFunctionReceiver

Penerima fungsi azure.

Nama	Jenis	Nilai Default	Deskripsi
functionAppResourceId	string		Id sumber daya azure dari aplikasi fungsi.
functionName	string		Nama fungsi di aplikasi fungsi.
httpTriggerUrl	string		Url pemicu http tempat permintaan http dikirim.
name	string		Nama penerima fungsi azure. Nama harus unik di semua penerima dalam grup tindakan.
useCommonAlertSchema	boolean	False	Menunjukkan apakah akan menggunakan skema pemberitahuan umum.

EmailReceiver

Penerima email.

Nama	Jenis	Nilai Default	Deskripsi
emailAddress	string		Alamat email penerima ini.
name	string		Nama penerima email. Nama harus unik di semua penerima dalam grup tindakan.
status	ReceiverStatus		Status penerima email.
useCommonAlertSchema	boolean	False	Menunjukkan apakah akan menggunakan skema pemberitahuan umum.

ErrorResponse

Menjelaskan format respons Kesalahan.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan
message	string	Pesan kesalahan yang menunjukkan mengapa operasi gagal.

EventHubReceiver

Penerima pusat aktivitas.

Nama	Jenis	Nilai Default	Deskripsi
eventHubName	string		Nama antrean Pusat Aktivitas tertentu
eventHubNameSpace	string		Namespace layanan Pusat Aktivitas
name	string		Nama penerima Event hub. Nama harus unik di semua penerima dalam grup tindakan.
subscriptionId	string		Id untuk langganan yang berisi pusat aktivitas ini
tenantId	string		Id penyewa untuk langganan yang berisi hub kejadian ini
useCommonAlertSchema	boolean	False	Menunjukkan apakah akan menggunakan skema pemberitahuan umum.

ItsmReceiver

Penerima Itsm.

Nama	Jenis	Deskripsi
connectionId	string	Identifikasi unik koneksi ITSM di antara beberapa yang ditentukan di ruang kerja di atas.
name	string	Nama penerima Itsm. Nama harus unik di semua penerima dalam grup tindakan.
region	string	Wilayah tempat ruang kerja berada. Nilai yang didukung:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope'
ticketConfiguration	string	Blob JSON untuk konfigurasi tindakan ITSM. Opsi CreateMultipleWorkItems juga akan menjadi bagian dari blob ini.
workspaceId	string	Pengidentifikasi instans OMS LA.

LogicAppReceiver

Penerima aplikasi logika.

Nama	Jenis	Nilai Default	Deskripsi
callbackUrl	string		Url panggilan balik tempat permintaan http dikirim.
name	string		Nama penerima aplikasi logika. Nama harus unik di semua penerima dalam grup tindakan.
resourceId	string		Id sumber daya azure penerima aplikasi logika.
useCommonAlertSchema	boolean	False	Menunjukkan apakah akan menggunakan skema pemberitahuan umum.

ReceiverStatus

Menunjukkan status penerima. Penerima yang tidak Diaktifkan tidak akan menerima komunikasi apa pun.

Nama	Jenis	Deskripsi
Disabled	string
Enabled	string
NotSpecified	string

SmsReceiver

Penerima SMS.

Nama	Jenis	Deskripsi
countryCode	string	Kode negara penerima SMS.
name	string	Nama penerima SMS. Nama harus unik di semua penerima dalam grup tindakan.
phoneNumber	string	Nomor telepon penerima SMS.
status	ReceiverStatus	Status penerima.

VoiceReceiver

Penerima suara.

Nama	Jenis	Deskripsi
countryCode	string	Kode negara penerima suara.
name	string	Nama penerima suara. Nama harus unik di semua penerima dalam grup tindakan.
phoneNumber	string	Nomor telepon penerima suara.

WebhookReceiver

Penerima webhook.

Nama	Jenis	Nilai Default	Deskripsi
identifierUri	string		Menunjukkan uri pengidentifikasi untuk autentikasi aad.
name	string		Nama penerima webhook. Nama harus unik di semua penerima dalam grup tindakan.
objectId	string		Menunjukkan Id objek aplikasi webhook untuk autentikasi aad.
serviceUri	string		URI tempat webhook harus dikirim.
tenantId	string		Menunjukkan id penyewa untuk autentikasi aad.
useAadAuth	boolean	False	Menunjukkan apakah menggunakan autentikasi AAD atau tidak.
useCommonAlertSchema	boolean	False	Menunjukkan apakah akan menggunakan skema pemberitahuan umum.