Action Groups - Update

Reference

Služba:: Monitor

Verze rozhraní API:: 2021-09-01

Aktualizace značky existující skupiny akcí. Pokud chcete aktualizovat další pole, použijte metodu CreateOrUpdate.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
actionGroupName	path	True	string	Název skupiny akcí.
resourceGroupName	path	True	string	Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
subscriptionId	path	True	string	ID cílového předplatného.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Typ	Description
properties.enabled	boolean	Určuje, jestli je tato skupina akcí povolená. Pokud skupina akcí není povolená, žádná z jejích akcí se neaktivuje.
tags	object	Značky prostředků

Odpovědi

Name	Typ	Description
200 OK	ActionGroupResource	Existující skupina akcí se úspěšně aktualizovala.
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Patch an action group

PATCH https://management.azure.com/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/Default-NotificationRules/providers/Microsoft.Insights/actionGroups/SampleActionGroup?api-version=2021-09-01

{
  "tags": {
    "key1": "value1",
    "key2": "value2"
  },
  "properties": {
    "enabled": false
  }
}

package armmonitor_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"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/patchActionGroup.json
func ExampleActionGroupsClient_Update() {
	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.Update(ctx,
		"<resource-group-name>",
		"<action-group-name>",
		armmonitor.ActionGroupPatchBody{
			Properties: &armmonitor.ActionGroupPatch{
				Enabled: to.Ptr(false),
			},
			Tags: map[string]*string{
				"key1": to.Ptr("value1"),
				"key2": to.Ptr("value2"),
			},
		},
		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

Ukázková odpověď

Stavový kód:: 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": {
    "key1": "value1",
    "key2": "value2"
  },
  "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": "Enabled",
        "useCommonAlertSchema": true
      }
    ],
    "smsReceivers": [
      {
        "name": "John Doe's mobile",
        "countryCode": "1",
        "phoneNumber": "1234567890",
        "status": "Enabled"
      },
      {
        "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": []
  }
}

Definice

Name	Description
ActionGroupPatchBody	Objekt skupiny akcí pro tělo operací oprav.
ActionGroupResource	Prostředek skupiny akcí.
ArmRoleReceiver	Příjemce role ARM.
AutomationRunbookReceiver	Příjemce oznámení runbooku Azure Automation.
AzureAppPushReceiver	Příjemce nabízených oznámení mobilní aplikace Azure
AzureFunctionReceiver	Přijímač funkce Azure.
EmailReceiver	Příjemce e-mailu.
ErrorResponse	Popisuje formát chybové odpovědi.
EventHubReceiver	Příjemce centra událostí.
ItsmReceiver	Přijímač itsm.
LogicAppReceiver	Příjemce aplikace logiky.
ReceiverStatus	Označuje stav příjemce. Příjemci, kteří nejsou povoleni, nebudou dostávat žádnou komunikaci.
SmsReceiver	Příjemce SMS.
VoiceReceiver	Přijímač hlasu.
WebhookReceiver	Příjemce webhooku.

ActionGroupPatchBody

Objekt skupiny akcí pro tělo operací oprav.

Name	Typ	Default value	Description
properties.enabled	boolean	True	Určuje, jestli je tato skupina akcí povolená. Pokud skupina akcí není povolená, žádná z jejích akcí se neaktivuje.
tags	object		Značky prostředků

ActionGroupResource

Prostředek skupiny akcí.

Name	Typ	Default value	Description
id	string		ID prostředku Azure
location	string		Umístění prostředku
name	string		Název prostředku Azure
properties.armRoleReceivers	ArmRoleReceiver[]		Seznam příjemců rolí ARM, kteří jsou součástí této skupiny akcí. Role jsou role Azure RBAC a podporují se pouze předdefinované role.
properties.automationRunbookReceivers	AutomationRunbookReceiver[]		Seznam příjemců AutomationRunbook, kteří jsou součástí této skupiny akcí.
properties.azureAppPushReceivers	AzureAppPushReceiver[]		Seznam příjemců AzureAppPush, kteří jsou součástí této skupiny akcí.
properties.azureFunctionReceivers	AzureFunctionReceiver[]		Seznam příjemců funkcí Azure, kteří jsou součástí této skupiny akcí.
properties.emailReceivers	EmailReceiver[]		Seznam příjemců e-mailů, kteří jsou součástí této skupiny akcí.
properties.enabled	boolean	True	Určuje, jestli je tato skupina akcí povolená. Pokud skupina akcí není povolená, žádný z jejích příjemců nebude dostávat komunikaci.
properties.eventHubReceivers	EventHubReceiver[]		Seznam příjemců centra událostí, kteří jsou součástí této skupiny akcí.
properties.groupShortName	string		Krátký název skupiny akcí. Použije se v SMS zprávách.
properties.itsmReceivers	ItsmReceiver[]		Seznam příjemců ITSM, kteří jsou součástí této skupiny akcí.
properties.logicAppReceivers	LogicAppReceiver[]		Seznam příjemců aplikace logiky, kteří jsou součástí této skupiny akcí.
properties.smsReceivers	SmsReceiver[]		Seznam příjemců SMS, kteří jsou součástí této skupiny akcí.
properties.voiceReceivers	VoiceReceiver[]		Seznam hlasových přijímačů, kteří jsou součástí této skupiny akcí.
properties.webhookReceivers	WebhookReceiver[]		Seznam příjemců webhooků, kteří jsou součástí této skupiny akcí.
tags	object		Značky prostředků
type	string		Typ prostředku Azure

ArmRoleReceiver

Příjemce role ARM.

Name	Typ	Default value	Description
name	string		Název příjemce role ARM. Názvy musí být jedinečné pro všechny příjemce v rámci skupiny akcí.
roleId	string		ID role arm.
useCommonAlertSchema	boolean	False	Určuje, jestli se má použít běžné schéma upozornění.

AutomationRunbookReceiver

Příjemce oznámení runbooku Azure Automation.

Name	Typ	Default value	Description
automationAccountId	string		ID účtu Azure Automation, který obsahuje tento runbook a ověření pro prostředek Azure.
isGlobalRunbook	boolean		Určuje, jestli je tato instance globální runbook.
name	string		Označuje název webhooku.
runbookName	string		Název tohoto runbooku.
serviceUri	string		Identifikátor URI, kam se mají webhooky odesílat.
useCommonAlertSchema	boolean	False	Určuje, jestli se má použít běžné schéma upozornění.
webhookResourceId	string		ID prostředku webhooku propojeného s tímto runbookem

AzureAppPushReceiver

Příjemce nabízených oznámení mobilní aplikace Azure

Name	Typ	Description
emailAddress	string	E-mailová adresa zaregistrovaná pro mobilní aplikaci Azure.
name	string	Název přijímače nabízených oznámení mobilní aplikace Azure. Názvy musí být jedinečné pro všechny příjemce v rámci skupiny akcí.

AzureFunctionReceiver

Přijímač funkce Azure.

Name	Typ	Default value	Description
functionAppResourceId	string		ID prostředku Azure aplikace funkcí.
functionName	string		Název funkce v aplikaci funkcí.
httpTriggerUrl	string		Adresa URL triggeru HTTP, kam se odeslal požadavek HTTP.
name	string		Název příjemce funkce Azure. Názvy musí být jedinečné pro všechny příjemce v rámci skupiny akcí.
useCommonAlertSchema	boolean	False	Určuje, jestli se má použít běžné schéma upozornění.

EmailReceiver

Příjemce e-mailu.

Name	Typ	Default value	Description
emailAddress	string		E-mailová adresa tohoto příjemce.
name	string		Jméno příjemce e-mailu. Názvy musí být jedinečné pro všechny příjemce v rámci skupiny akcí.
status	ReceiverStatus		Stav příjemce e-mailu.
useCommonAlertSchema	boolean	False	Určuje, jestli se má použít běžné schéma upozornění.

ErrorResponse

Popisuje formát chybové odpovědi.

Name	Typ	Description
code	string	Kód chyby
message	string	Chybová zpráva s informacemi o tom, proč operace selhala.

EventHubReceiver

Příjemce centra událostí.

Name	Typ	Default value	Description
eventHubName	string		Název konkrétní fronty centra událostí
eventHubNameSpace	string		Obor názvů centra událostí
name	string		Název příjemce centra událostí. Názvy musí být jedinečné pro všechny příjemce v rámci skupiny akcí.
subscriptionId	string		ID předplatného obsahujícího toto centrum událostí
tenantId	string		ID tenanta pro předplatné obsahující toto centrum událostí
useCommonAlertSchema	boolean	False	Určuje, jestli se má použít běžné schéma upozornění.

ItsmReceiver

Přijímač itsm.

Name	Typ	Description
connectionId	string	Jedinečná identifikace připojení ITSM mezi několika definovanými ve výše uvedeném pracovním prostoru.
name	string	Název přijímače Itsm. Názvy musí být jedinečné pro všechny příjemce v rámci skupiny akcí.
region	string	Oblast, ve které se nachází pracovní prostor. Podporované hodnoty:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope'
ticketConfiguration	string	Objekt blob JSON pro konfiguraci akce ITSM. Součástí tohoto objektu blob bude také možnost CreateMultipleWorkItems.
workspaceId	string	Identifikátor instance OMS LA.

LogicAppReceiver

Příjemce aplikace logiky.

Name	Typ	Default value	Description
callbackUrl	string		Adresa URL zpětného volání, kam se požadavek HTTP odeslal.
name	string		Název příjemce aplikace logiky. Názvy musí být jedinečné pro všechny příjemce v rámci skupiny akcí.
resourceId	string		ID prostředku Azure příjemce aplikace logiky.
useCommonAlertSchema	boolean	False	Určuje, jestli se má použít běžné schéma upozornění.

ReceiverStatus

Označuje stav příjemce. Příjemci, kteří nejsou povoleni, nebudou dostávat žádnou komunikaci.

Name	Typ	Description
Disabled	string
Enabled	string
NotSpecified	string

SmsReceiver

Příjemce SMS.

Name	Typ	Description
countryCode	string	Kód země příjemce SMS.
name	string	Název příjemce SMS. Názvy musí být jedinečné pro všechny příjemce v rámci skupiny akcí.
phoneNumber	string	Telefonní číslo příjemce SMS.
status	ReceiverStatus	Stav příjemce.

VoiceReceiver

Přijímač hlasu.

Name	Typ	Description
countryCode	string	Kód země přijímače hlasu.
name	string	Název přijímače hlasu. Názvy musí být jedinečné pro všechny příjemce v rámci skupiny akcí.
phoneNumber	string	Telefonní číslo hlasového přijímače.

WebhookReceiver

Příjemce webhooku.

Name	Typ	Default value	Description
identifierUri	string		Označuje identifikátor URI pro ověřování aad.
name	string		Název příjemce webhooku. Názvy musí být jedinečné pro všechny příjemce v rámci skupiny akcí.
objectId	string		Označuje ID objektu aplikace webhooku pro ověřování aad.
serviceUri	string		Identifikátor URI, kam se mají webhooky odesílat.
tenantId	string		Označuje ID tenanta pro ověřování aad.
useAadAuth	boolean	False	Určuje, jestli se používá ověřování AAD.
useCommonAlertSchema	boolean	False	Určuje, jestli se má použít běžné schéma upozornění.

Sdílet prostřednictvím