Action Groups - Update

Riferimento

Service:: Monitor

API Version:: 2021-09-01

Aggiornamenti tag di un gruppo di azioni esistente. Per aggiornare altri campi, utilizzare il metodo CreateOrUpdate.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
actionGroupName	path	True	string	Nome del gruppo di azioni.
resourceGroupName	path	True	string	Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
subscriptionId	path	True	string	ID della sottoscrizione di destinazione.
api-version	query	True	string	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Tipo	Descrizione
properties.enabled	boolean	Indica se questo gruppo di azioni è abilitato. Se un gruppo di azioni non è abilitato, nessuna delle azioni verrà attivata.
tags	object	Tag delle risorse

Risposte

Nome	Tipo	Descrizione
200 OK	ActionGroupResource	Un gruppo di azioni esistente è stato aggiornato correttamente.
Other Status Codes	ErrorResponse	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

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

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

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

Sample Response

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

Definizioni

Nome	Descrizione
ActionGroupPatchBody	Oggetto gruppo di azioni per il corpo delle operazioni di patch.
ActionGroupResource	Risorsa del gruppo di azioni.
ArmRoleReceiver	Ricevitore del ruolo arm.
AutomationRunbookReceiver	Ricevitore di notifica del runbook Automazione di Azure.
AzureAppPushReceiver	Ricevitore di notifica push dell'app per dispositivi mobili di Azure.
AzureFunctionReceiver	Ricevitore di funzioni di Azure.
EmailReceiver	Ricevitore di posta elettronica.
ErrorResponse	Descrive il formato della risposta all'errore.
EventHubReceiver	Ricevitore dell'hub eventi.
ItsmReceiver	Ricevitore Itsm.
LogicAppReceiver	Ricevitore dell'app per la logica.
ReceiverStatus	Indica lo stato del ricevitore. I ricevitori che non sono abilitati non riceveranno alcuna comunicazione.
SmsReceiver	Ricevitore SMS.
VoiceReceiver	Ricevitore vocale.
WebhookReceiver	Ricevitore webhook.

ActionGroupPatchBody

Oggetto gruppo di azioni per il corpo delle operazioni di patch.

Nome	Tipo	Valore predefinito	Descrizione
properties.enabled	boolean	True	Indica se questo gruppo di azioni è abilitato. Se un gruppo di azioni non è abilitato, nessuna delle azioni verrà attivata.
tags	object		Tag delle risorse

ActionGroupResource

Risorsa del gruppo di azioni.

Nome	Tipo	Valore predefinito	Descrizione
id	string		ID risorsa di Azure
location	string		Posizione risorsa
name	string		Nome risorsa di Azure
properties.armRoleReceivers	ArmRoleReceiver[]		Elenco dei ricevitori di ruoli ARM che fanno parte di questo gruppo di azioni. I ruoli sono ruoli di Controllo degli accessi in base al ruolo di Azure e sono supportati solo i ruoli predefiniti.
properties.automationRunbookReceivers	AutomationRunbookReceiver[]		Elenco dei ricevitori AutomationRunbook che fanno parte di questo gruppo di azioni.
properties.azureAppPushReceivers	AzureAppPushReceiver[]		Elenco dei ricevitori AzureAppPush che fanno parte di questo gruppo di azioni.
properties.azureFunctionReceivers	AzureFunctionReceiver[]		Elenco dei ricevitori di funzioni di Azure che fanno parte di questo gruppo di azioni.
properties.emailReceivers	EmailReceiver[]		Elenco dei ricevitori di posta elettronica che fanno parte di questo gruppo di azioni.
properties.enabled	boolean	True	Indica se questo gruppo di azioni è abilitato. Se un gruppo di azioni non è abilitato, nessuno dei destinatari riceverà comunicazioni.
properties.eventHubReceivers	EventHubReceiver[]		Elenco dei ricevitori dell'hub eventi che fanno parte di questo gruppo di azioni.
properties.groupShortName	string		Nome breve del gruppo di azioni. Questa operazione verrà usata nei messaggi SMS.
properties.itsmReceivers	ItsmReceiver[]		Elenco dei ricevitori ITSM che fanno parte di questo gruppo di azioni.
properties.logicAppReceivers	LogicAppReceiver[]		Elenco dei ricevitori di app per la logica che fanno parte di questo gruppo di azioni.
properties.smsReceivers	SmsReceiver[]		Elenco dei ricevitori SMS che fanno parte di questo gruppo di azioni.
properties.voiceReceivers	VoiceReceiver[]		Elenco dei ricevitori vocali che fanno parte di questo gruppo di azioni.
properties.webhookReceivers	WebhookReceiver[]		Elenco dei ricevitori webhook che fanno parte di questo gruppo di azioni.
tags	object		Tag delle risorse
type	string		Tipo di risorsa di Azure

ArmRoleReceiver

Ricevitore del ruolo arm.

Nome	Tipo	Valore predefinito	Descrizione
name	string		Nome del ricevitore del ruolo arm. I nomi devono essere univoci in tutti i ricevitori all'interno di un gruppo di azioni.
roleId	string		ID ruolo arm.
useCommonAlertSchema	boolean	False	Indica se usare lo schema di avviso comune.

AutomationRunbookReceiver

Ricevitore di notifica del runbook Automazione di Azure.

Nome	Tipo	Valore predefinito	Descrizione
automationAccountId	string		ID dell'account di automazione di Azure che contiene questo runbook ed eseguire l'autenticazione nella risorsa di Azure.
isGlobalRunbook	boolean		Indica se questa istanza è il runbook globale.
name	string		Indica il nome del webhook.
runbookName	string		Nome per questo runbook.
serviceUri	string		URI in cui devono essere inviati i webhook.
useCommonAlertSchema	boolean	False	Indica se usare lo schema di avviso comune.
webhookResourceId	string		ID risorsa per webhook collegato a questo runbook.

AzureAppPushReceiver

Ricevitore di notifica push dell'app per dispositivi mobili di Azure.

Nome	Tipo	Descrizione
emailAddress	string	Indirizzo di posta elettronica registrato per l'app per dispositivi mobili di Azure.
name	string	Nome del ricevitore push dell'app per dispositivi mobili di Azure. I nomi devono essere univoci in tutti i ricevitori all'interno di un gruppo di azioni.

AzureFunctionReceiver

Ricevitore di funzioni di Azure.

Nome	Tipo	Valore predefinito	Descrizione
functionAppResourceId	string		ID risorsa di Azure dell'app per le funzioni.
functionName	string		Nome della funzione nell'app per le funzioni.
httpTriggerUrl	string		URL del trigger http a cui viene inviata la richiesta http.
name	string		Nome del ricevitore della funzione di Azure. I nomi devono essere univoci in tutti i ricevitori all'interno di un gruppo di azioni.
useCommonAlertSchema	boolean	False	Indica se usare lo schema di avviso comune.

EmailReceiver

Ricevitore di posta elettronica.

Nome	Tipo	Valore predefinito	Descrizione
emailAddress	string		Indirizzo di posta elettronica del ricevitore.
name	string		Nome del ricevitore di posta elettronica. I nomi devono essere univoci in tutti i ricevitori all'interno di un gruppo di azioni.
status	ReceiverStatus		Stato destinatario del messaggio di posta elettronica.
useCommonAlertSchema	boolean	False	Indica se usare lo schema di avviso comune.

ErrorResponse

Descrive il formato della risposta all'errore.

Nome	Tipo	Descrizione
code	string	Codice di errore
message	string	Messaggio di errore che indica perché l'operazione non è riuscita.

EventHubReceiver

Ricevitore dell'hub eventi.

Nome	Tipo	Valore predefinito	Descrizione
eventHubName	string		Nome della coda dell'hub eventi specifica
eventHubNameSpace	string		Spazio dei nomi dell'hub eventi
name	string		Nome del ricevitore dell'hub eventi. I nomi devono essere univoci in tutti i ricevitori all'interno di un gruppo di azioni.
subscriptionId	string		ID per la sottoscrizione contenente questo hub eventi
tenantId	string		ID tenant per la sottoscrizione contenente questo hub eventi
useCommonAlertSchema	boolean	False	Indica se utilizzare lo schema di avviso comune.

ItsmReceiver

Ricevitore Itsm.

Nome	Tipo	Descrizione
connectionId	string	Identificazione univoca della connessione ITSM tra più definite nell'area di lavoro precedente.
name	string	Nome del ricevitore Itsm. I nomi devono essere univoci in tutti i ricevitori all'interno di un gruppo di azioni.
region	string	Area in cui risiede l'area di lavoro. Valori supportati:'centralindia','japaneast','sud-estasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope'
ticketConfiguration	string	BLOB JSON per le configurazioni dell'azione ITSM. Anche l'opzione CreateMultipleWorkItems farà parte di questo BLOB.
workspaceId	string	Identificatore dell'istanza di OMS LA.

LogicAppReceiver

Ricevitore dell'app per la logica.

Nome	Tipo	Valore predefinito	Descrizione
callbackUrl	string		URL di callback a cui viene inviata la richiesta http.
name	string		Nome del ricevitore dell'app per la logica. I nomi devono essere univoci in tutti i ricevitori all'interno di un gruppo di azioni.
resourceId	string		ID risorsa di Azure del ricevitore dell'app per la logica.
useCommonAlertSchema	boolean	False	Indica se usare lo schema di avviso comune.

ReceiverStatus

Indica lo stato del ricevitore. I ricevitori che non sono abilitati non riceveranno alcuna comunicazione.

Nome	Tipo	Descrizione
Disabled	string
Enabled	string
NotSpecified	string

SmsReceiver

Ricevitore SMS.

Nome	Tipo	Descrizione
countryCode	string	Codice paese del ricevitore SMS.
name	string	Nome del ricevitore SMS. I nomi devono essere univoci in tutti i ricevitori all'interno di un gruppo di azioni.
phoneNumber	string	Numero di telefono del ricevitore SMS.
status	ReceiverStatus	Stato del ricevitore.

VoiceReceiver

Ricevitore vocale.

Nome	Tipo	Descrizione
countryCode	string	Codice paese del ricevitore vocale.
name	string	Nome del ricevitore vocale. I nomi devono essere univoci in tutti i ricevitori all'interno di un gruppo di azioni.
phoneNumber	string	Numero di telefono del ricevitore vocale.

WebhookReceiver

Ricevitore webhook.

Nome	Tipo	Valore predefinito	Descrizione
identifierUri	string		Indica l'uri dell'identificatore per l'autenticazione aad.
name	string		Nome del ricevitore webhook. I nomi devono essere univoci in tutti i ricevitori all'interno di un gruppo di azioni.
objectId	string		Indica l'ID dell'oggetto app webhook per l'autenticazione aad.
serviceUri	string		URI in cui devono essere inviati i webhook.
tenantId	string		Indica l'ID tenant per l'autenticazione aad.
useAadAuth	boolean	False	Indica se usare o meno l'autenticazione AAD.
useCommonAlertSchema	boolean	False	Indica se usare lo schema di avviso comune.

Share via