Action Groups - Update

Referencia

Servicio:: Monitor

Versión de la API:: 2021-09-01

Novedades las etiquetas de un grupo de acciones existente. Para actualizar otros campos, use el método CreateOrUpdate.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
actionGroupName	path	True	string	Nombre del grupo de acciones.
resourceGroupName	path	True	string	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
subscriptionId	path	True	string	Identificador de la suscripción de destino.
api-version	query	True	string	Versión de API que se usará para la operación.

Cuerpo de la solicitud

Nombre	Tipo	Description
properties.enabled	boolean	Indica si este grupo de acciones está habilitado. Si un grupo de acciones no está habilitado, no se activará ninguna de sus acciones.
tags	object	Etiquetas del recurso

Respuestas

Nombre	Tipo	Description
200 OK	ActionGroupResource	Se actualizó correctamente un grupo de acciones existente.
Other Status Codes	ErrorResponse	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

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

Respuesta de muestra

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

Definiciones

Nombre	Description
ActionGroupPatchBody	Objeto de grupo de acciones para el cuerpo de las operaciones de revisión.
ActionGroupResource	Un recurso de grupo de acciones.
ArmRoleReceiver	Receptor de roles de brazo.
AutomationRunbookReceiver	Receptor de notificaciones de runbook Azure Automation.
AzureAppPushReceiver	Receptor de notificaciones push de aplicación móvil de Azure.
AzureFunctionReceiver	Receptor de funciones de Azure.
EmailReceiver	Un receptor de correo electrónico.
ErrorResponse	Describe el formato de respuesta de error.
EventHubReceiver	Un receptor del centro de eventos.
ItsmReceiver	Un receptor Itsm.
LogicAppReceiver	Un receptor de aplicación lógica.
ReceiverStatus	Indica el estado del receptor. Los receptores que no están habilitados no recibirán ninguna comunicación.
SmsReceiver	Un receptor sms.
VoiceReceiver	Un receptor de voz.
WebhookReceiver	Un receptor de webhook.

ActionGroupPatchBody

Objeto de grupo de acciones para el cuerpo de las operaciones de revisión.

Nombre	Tipo	Valor predeterminado	Description
properties.enabled	boolean	True	Indica si este grupo de acciones está habilitado. Si un grupo de acciones no está habilitado, no se activará ninguna de sus acciones.
tags	object		Etiquetas del recurso

ActionGroupResource

Un recurso de grupo de acciones.

Nombre	Tipo	Valor predeterminado	Description
id	string		Identificador de recurso de Azure
location	string		Ubicación de los recursos
name	string		Nombre de recurso de Azure
properties.armRoleReceivers	ArmRoleReceiver[]		Lista de receptores de roles arm que forman parte de este grupo de acciones. Los roles son roles RBAC de Azure y solo se admiten los roles integrados.
properties.automationRunbookReceivers	AutomationRunbookReceiver[]		La lista de receptores AutomationRunbook que forman parte de este grupo de acciones.
properties.azureAppPushReceivers	AzureAppPushReceiver[]		La lista de receptores de AzureAppPush que forman parte de este grupo de acciones.
properties.azureFunctionReceivers	AzureFunctionReceiver[]		La lista de receptores de funciones de Azure que forman parte de este grupo de acciones.
properties.emailReceivers	EmailReceiver[]		Lista de receptores de correo electrónico que forman parte de este grupo de acciones.
properties.enabled	boolean	True	Indica si este grupo de acciones está habilitado. Si un grupo de acciones no está habilitado, ninguno de sus receptores recibirá comunicaciones.
properties.eventHubReceivers	EventHubReceiver[]		Lista de receptores de centro de eventos que forman parte de este grupo de acciones.
properties.groupShortName	string		Nombre corto del grupo de acciones. Se usará en mensajes SMS.
properties.itsmReceivers	ItsmReceiver[]		Lista de receptores itsm que forman parte de este grupo de acciones.
properties.logicAppReceivers	LogicAppReceiver[]		Lista de receptores de aplicaciones lógicas que forman parte de este grupo de acciones.
properties.smsReceivers	SmsReceiver[]		Lista de receptores de SMS que forman parte de este grupo de acciones.
properties.voiceReceivers	VoiceReceiver[]		Lista de receptores de voz que forman parte de este grupo de acciones.
properties.webhookReceivers	WebhookReceiver[]		Lista de receptores de webhook que forman parte de este grupo de acciones.
tags	object		Etiquetas del recurso
type	string		Tipo de recurso de Azure

ArmRoleReceiver

Receptor de roles de brazo.

Nombre	Tipo	Valor predeterminado	Description
name	string		Nombre del receptor del rol de brazo. Los nombres deben ser únicos en todos los receptores de un grupo de acciones.
roleId	string		Identificador del rol de brazo.
useCommonAlertSchema	boolean	False	Indica si se debe usar el esquema de alertas común.

AutomationRunbookReceiver

Receptor de notificaciones de runbook Azure Automation.

Nombre	Tipo	Valor predeterminado	Description
automationAccountId	string		El identificador de la cuenta de Azure Automation que contiene este runbook y se autentica en el recurso de Azure.
isGlobalRunbook	boolean		Indica si esta instancia es un runbook global.
name	string		Indica el nombre del webhook.
runbookName	string		Nombre de este runbook.
serviceUri	string		URI donde se deben enviar webhooks.
useCommonAlertSchema	boolean	False	Indica si se debe usar el esquema de alertas común.
webhookResourceId	string		Identificador de recurso del webhook vinculado a este runbook.

AzureAppPushReceiver

Receptor de notificaciones push de aplicación móvil de Azure.

Nombre	Tipo	Description
emailAddress	string	La dirección de correo electrónico registrada para la aplicación móvil de Azure.
name	string	Nombre del receptor de inserción de la aplicación móvil de Azure. Los nombres deben ser únicos en todos los receptores de un grupo de acciones.

AzureFunctionReceiver

Receptor de funciones de Azure.

Nombre	Tipo	Valor predeterminado	Description
functionAppResourceId	string		Identificador de recurso de Azure de la aplicación de funciones.
functionName	string		El nombre de la función en la aplicación de funciones.
httpTriggerUrl	string		Dirección URL del desencadenador http a la que se envió la solicitud http.
name	string		Nombre del receptor de la función de Azure. Los nombres deben ser únicos en todos los receptores de un grupo de acciones.
useCommonAlertSchema	boolean	False	Indica si se debe usar el esquema de alertas común.

EmailReceiver

Un receptor de correo electrónico.

Nombre	Tipo	Valor predeterminado	Description
emailAddress	string		Dirección de correo electrónico de este receptor.
name	string		Nombre del receptor de correo electrónico. Los nombres deben ser únicos en todos los receptores de un grupo de acciones.
status	ReceiverStatus		Estado del receptor del correo electrónico.
useCommonAlertSchema	boolean	False	Indica si se debe usar el esquema de alertas común.

ErrorResponse

Describe el formato de respuesta de error.

Nombre	Tipo	Description
code	string	Código de error
message	string	Mensaje de error que indica por qué se produjo un error en la operación.

EventHubReceiver

Un receptor del centro de eventos.

Nombre	Tipo	Valor predeterminado	Description
eventHubName	string		Nombre de la cola específica del centro de eventos
eventHubNameSpace	string		El espacio de nombres del centro de eventos
name	string		Nombre del receptor del centro de eventos. Los nombres deben ser únicos en todos los receptores de un grupo de acciones.
subscriptionId	string		Identificador de la suscripción que contiene este centro de eventos
tenantId	string		Identificador de inquilino de la suscripción que contiene este centro de eventos
useCommonAlertSchema	boolean	False	Indica si se va a usar el esquema de alerta común.

ItsmReceiver

Un receptor Itsm.

Nombre	Tipo	Description
connectionId	string	Identificación única de la conexión itsm entre varias definidas en el área de trabajo anterior.
name	string	Nombre del receptor itsm. Los nombres deben ser únicos en todos los receptores de un grupo de acciones.
region	string	Región en la que reside el área de trabajo. Valores admitidos:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope'
ticketConfiguration	string	Blob JSON para las configuraciones de la acción ITSM. La opción CreateMultipleWorkItems también formará parte de este blob.
workspaceId	string	Identificador de instancia de OMS LA.

LogicAppReceiver

Un receptor de aplicación lógica.

Nombre	Tipo	Valor predeterminado	Description
callbackUrl	string		Dirección URL de devolución de llamada a la que se envió la solicitud http.
name	string		Nombre del receptor de la aplicación lógica. Los nombres deben ser únicos en todos los receptores de un grupo de acciones.
resourceId	string		Identificador de recurso de Azure del receptor de la aplicación lógica.
useCommonAlertSchema	boolean	False	Indica si se debe usar el esquema de alertas común.

ReceiverStatus

Indica el estado del receptor. Los receptores que no están habilitados no recibirán ninguna comunicación.

Nombre	Tipo	Description
Disabled	string
Enabled	string
NotSpecified	string

SmsReceiver

Un receptor sms.

Nombre	Tipo	Description
countryCode	string	Código de país del receptor sms.
name	string	Nombre del receptor de SMS. Los nombres deben ser únicos en todos los receptores de un grupo de acciones.
phoneNumber	string	Número de teléfono del receptor de SMS.
status	ReceiverStatus	Estado del receptor.

VoiceReceiver

Un receptor de voz.

Nombre	Tipo	Description
countryCode	string	Código de país del receptor de voz.
name	string	Nombre del receptor de voz. Los nombres deben ser únicos en todos los receptores de un grupo de acciones.
phoneNumber	string	Número de teléfono del receptor de voz.

WebhookReceiver

Un receptor de webhook.

Nombre	Tipo	Valor predeterminado	Description
identifierUri	string		Indica el identificador URI de la autenticación de aad.
name	string		Nombre del receptor de webhook. Los nombres deben ser únicos en todos los receptores de un grupo de acciones.
objectId	string		Indica el identificador de objeto de aplicación de webhook para la autenticación de aad.
serviceUri	string		URI donde se deben enviar webhooks.
tenantId	string		Indica el identificador de inquilino para la autenticación de aad.
useAadAuth	boolean	False	Indica si se usa o no la autenticación de AAD.
useCommonAlertSchema	boolean	False	Indica si se debe usar el esquema de alertas común.

Compartir a través de