Action Groups - Update

Référence

Service:: Monitor

Version d'API:: 2021-09-01

Mises à jour les balises d’un groupe d’actions existant. Pour mettre à jour d’autres champs, utilisez la méthode CreateOrUpdate.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
actionGroupName	path	True	string	Nom du groupe d’actions.
resourceGroupName	path	True	string	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string	ID de l’abonnement cible.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Type	Description
properties.enabled	boolean	Indique si ce groupe d’actions est activé. Si un groupe d’actions n’est pas activé, aucune de ses actions n’est activée.
tags	object	Balises de ressource

Réponses

Nom	Type	Description
200 OK	ActionGroupResource	Un groupe d’actions existant a été correctement mis à jour.
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

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

Exemple de réponse

Code d’état:: 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": []
  }
}

Définitions

Nom	Description
ActionGroupPatchBody	Objet de groupe d’actions pour le corps des opérations de correctif.
ActionGroupResource	Ressource de groupe d’actions.
ArmRoleReceiver	Récepteur de rôle arm.
AutomationRunbookReceiver	Récepteur de notification de runbook Azure Automation.
AzureAppPushReceiver	Récepteur de notification Push d’application mobile Azure.
AzureFunctionReceiver	Un récepteur de fonction Azure.
EmailReceiver	Un récepteur de courrier électronique.
ErrorResponse	Décrit le format de la réponse d’erreur.
EventHubReceiver	Un récepteur Event Hub.
ItsmReceiver	Récepteur Itsm.
LogicAppReceiver	Récepteur d’application logique.
ReceiverStatus	Indique la status du récepteur. Les récepteurs qui ne sont pas activés ne recevront aucune communication.
SmsReceiver	Un récepteur SMS.
VoiceReceiver	Un récepteur vocal.
WebhookReceiver	Un récepteur webhook.

ActionGroupPatchBody

Objet de groupe d’actions pour le corps des opérations de correctif.

Nom	Type	Valeur par défaut	Description
properties.enabled	boolean	True	Indique si ce groupe d’actions est activé. Si un groupe d’actions n’est pas activé, aucune de ses actions n’est activée.
tags	object		Balises de ressource

ActionGroupResource

Ressource de groupe d’actions.

Nom	Type	Valeur par défaut	Description
id	string		ID de ressource Azure
location	string		Emplacement de la ressource
name	string		Nom de la ressource Azure
properties.armRoleReceivers	ArmRoleReceiver[]		Liste des récepteurs de rôles ARM qui font partie de ce groupe d’actions. Les rôles sont des rôles RBAC Azure et seuls les rôles intégrés sont pris en charge.
properties.automationRunbookReceivers	AutomationRunbookReceiver[]		Liste des récepteurs AutomationRunbook qui font partie de ce groupe d’actions.
properties.azureAppPushReceivers	AzureAppPushReceiver[]		Liste des récepteurs AzureAppPush qui font partie de ce groupe d’actions.
properties.azureFunctionReceivers	AzureFunctionReceiver[]		Liste des récepteurs de fonction Azure qui font partie de ce groupe d’actions.
properties.emailReceivers	EmailReceiver[]		Liste des destinataires de messagerie qui font partie de ce groupe d’actions.
properties.enabled	boolean	True	Indique si ce groupe d’actions est activé. Si un groupe d’actions n’est pas activé, aucun de ses récepteurs ne recevra de communications.
properties.eventHubReceivers	EventHubReceiver[]		Liste des récepteurs event hub qui font partie de ce groupe d’actions.
properties.groupShortName	string		Nom court du groupe d’actions. Il sera utilisé dans les sms.
properties.itsmReceivers	ItsmReceiver[]		Liste des récepteurs ITSM qui font partie de ce groupe d’actions.
properties.logicAppReceivers	LogicAppReceiver[]		Liste des récepteurs d’application logique qui font partie de ce groupe d’actions.
properties.smsReceivers	SmsReceiver[]		Liste des récepteurs SMS qui font partie de ce groupe d’actions.
properties.voiceReceivers	VoiceReceiver[]		Liste des récepteurs vocaux qui font partie de ce groupe d’actions.
properties.webhookReceivers	WebhookReceiver[]		Liste des récepteurs webhook qui font partie de ce groupe d’actions.
tags	object		Balises de ressource
type	string		Type de ressource Azure

ArmRoleReceiver

Récepteur de rôle arm.

Nom	Type	Valeur par défaut	Description
name	string		Nom du récepteur de rôle arm. Les noms doivent être uniques dans tous les récepteurs au sein d’un groupe d’actions.
roleId	string		ID de rôle arm.
useCommonAlertSchema	boolean	False	Indique s’il faut utiliser le schéma d’alerte commun.

AutomationRunbookReceiver

Récepteur de notification de runbook Azure Automation.

Nom	Type	Valeur par défaut	Description
automationAccountId	string		ID de compte Azure Automation qui contient ce runbook et s’authentifie auprès de la ressource Azure.
isGlobalRunbook	boolean		Indique si ce instance est un runbook global.
name	string		Indique le nom du webhook.
runbookName	string		Nom de ce runbook.
serviceUri	string		URI où les webhooks doivent être envoyés.
useCommonAlertSchema	boolean	False	Indique s’il faut utiliser le schéma d’alerte commun.
webhookResourceId	string		ID de ressource pour le webhook lié à ce runbook.

AzureAppPushReceiver

Récepteur de notification Push d’application mobile Azure.

Nom	Type	Description
emailAddress	string	Adresse e-mail inscrite pour l’application mobile Azure.
name	string	Nom du récepteur Push de l’application mobile Azure. Les noms doivent être uniques dans tous les récepteurs au sein d’un groupe d’actions.

AzureFunctionReceiver

Un récepteur de fonction Azure.

Nom	Type	Valeur par défaut	Description
functionAppResourceId	string		ID de ressource Azure de l’application de fonction.
functionName	string		Nom de la fonction dans l’application de fonction.
httpTriggerUrl	string		URL du déclencheur HTTP à laquelle la requête http a été envoyée.
name	string		Nom du récepteur de fonction Azure. Les noms doivent être uniques dans tous les récepteurs au sein d’un groupe d’actions.
useCommonAlertSchema	boolean	False	Indique s’il faut utiliser le schéma d’alerte commun.

EmailReceiver

Un récepteur de courrier électronique.

Nom	Type	Valeur par défaut	Description
emailAddress	string		Adresse e-mail de ce récepteur.
name	string		Nom du destinataire de l’e-mail. Les noms doivent être uniques dans tous les récepteurs au sein d’un groupe d’actions.
status	ReceiverStatus		Le destinataire status de l’e-mail.
useCommonAlertSchema	boolean	False	Indique s’il faut utiliser le schéma d’alerte commun.

ErrorResponse

Décrit le format de la réponse d’erreur.

Nom	Type	Description
code	string	Code d'erreur
message	string	Message d’erreur indiquant la raison de l’échec de l’opération.

EventHubReceiver

Un récepteur Event Hub.

Nom	Type	Valeur par défaut	Description
eventHubName	string		Nom de la file d’attente Event Hub spécifique
eventHubNameSpace	string		Espace de noms Event Hub
name	string		Nom du récepteur Event Hub. Les noms doivent être uniques dans tous les récepteurs au sein d’un groupe d’actions.
subscriptionId	string		ID de l’abonnement contenant ce hub d’événements
tenantId	string		ID de locataire de l’abonnement contenant ce hub d’événements
useCommonAlertSchema	boolean	False	Indique s’il faut utiliser le schéma d’alerte courant.

ItsmReceiver

Récepteur Itsm.

Nom	Type	Description
connectionId	string	Identification unique de la connexion ITSM parmi les multiples définis dans l’espace de travail ci-dessus.
name	string	Nom du récepteur Itsm. Les noms doivent être uniques dans tous les récepteurs au sein d’un groupe d’actions.
region	string	Région dans laquelle réside l’espace de travail. Valeurs prises en charge :'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope'
ticketConfiguration	string	Objet blob JSON pour les configurations de l’action ITSM. L’option CreateMultipleWorkItems fait également partie de cet objet blob.
workspaceId	string	Identificateur de instance OMS LA.

LogicAppReceiver

Récepteur d’application logique.

Nom	Type	Valeur par défaut	Description
callbackUrl	string		URL de rappel à laquelle la requête http a été envoyée.
name	string		Nom du récepteur d’application logique. Les noms doivent être uniques dans tous les récepteurs au sein d’un groupe d’actions.
resourceId	string		ID de ressource Azure du récepteur d’application logique.
useCommonAlertSchema	boolean	False	Indique s’il faut utiliser le schéma d’alerte commun.

ReceiverStatus

Indique la status du récepteur. Les récepteurs qui ne sont pas activés ne recevront aucune communication.

Nom	Type	Description
Disabled	string
Enabled	string
NotSpecified	string

SmsReceiver

Un récepteur SMS.

Nom	Type	Description
countryCode	string	Code de pays du destinataire SMS.
name	string	Nom du récepteur SMS. Les noms doivent être uniques dans tous les récepteurs au sein d’un groupe d’actions.
phoneNumber	string	Numéro de téléphone du récepteur SMS.
status	ReceiverStatus	Status du récepteur.

VoiceReceiver

Un récepteur vocal.

Nom	Type	Description
countryCode	string	L’indicatif de pays du récepteur vocal.
name	string	Nom du récepteur vocal. Les noms doivent être uniques dans tous les récepteurs au sein d’un groupe d’actions.
phoneNumber	string	Numéro de téléphone du récepteur vocal.

WebhookReceiver

Un récepteur webhook.

Nom	Type	Valeur par défaut	Description
identifierUri	string		Indique l’URI d’identificateur pour l’authentification aad.
name	string		Nom du récepteur de webhook. Les noms doivent être uniques dans tous les récepteurs au sein d’un groupe d’actions.
objectId	string		Indique l’ID d’objet de l’application webhook pour l’authentification aad.
serviceUri	string		URI où les webhooks doivent être envoyés.
tenantId	string		Indique l’ID de locataire pour l’authentification aad.
useAadAuth	boolean	False	Indique si l’authentification AAD est utilisée ou non.
useCommonAlertSchema	boolean	False	Indique s’il faut utiliser le schéma d’alerte commun.

Partager via