Action Groups - Update

Serviço:: Monitor

Versão da API:: 2021-09-01

Atualiza as marcas de um grupo de ações existentes. Para atualizar outros campos, use o 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 URI

Nome	Em	Obrigatório	Tipo	Description
actionGroupName	path	True	string	O nome do grupo de ações.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	A ID da assinatura de destino.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Tipo	Description
properties.enabled	boolean	Indica se esse grupo de ações está habilitado. Se um grupo de ações não estiver habilitado, nenhuma de suas ações será ativada.
tags	object	Etiquetas de recursos

Respostas

Nome	Tipo	Description
200 OK	ActionGroupResource	Um grupo de ações existente foi atualizado com êxito.
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

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

Resposta de exemplo

Código de status:: 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": []
  }
}

Definições

Nome	Description
ActionGroupPatchBody	Um objeto de grupo de ações para o corpo das operações de patch.
ActionGroupResource	Um recurso de grupo de ações.
ArmRoleReceiver	Um receptor de função de braço.
AutomationRunbookReceiver	O receptor de notificação do Runbook de Automação do Azure.
AzureAppPushReceiver	O receptor de notificação por push do aplicativo móvel do Azure.
AzureFunctionReceiver	Um receptor de função do Azure.
EmailReceiver	Um receptor de email.
ErrorResponse	Descreve o formato da resposta de erro.
EventHubReceiver	Um receptor do Hub de Eventos.
ItsmReceiver	Um receptor Itsm.
LogicAppReceiver	Um receptor de aplicativo lógico.
ReceiverStatus	Indica o status do receptor. Os receptores que não estão habilitados não receberão nenhuma comunicação.
SmsReceiver	Um receptor SMS.
VoiceReceiver	Um receptor de voz.
WebhookReceiver	Um receptor de webhook.

ActionGroupPatchBody

Objeto

Um objeto de grupo de ações para o corpo das operações de patch.

Nome	Tipo	Valor padrão	Description
properties.enabled	boolean	True	Indica se esse grupo de ações está habilitado. Se um grupo de ações não estiver habilitado, nenhuma de suas ações será ativada.
tags	object		Etiquetas de recursos

ActionGroupResource

Objeto

Um recurso de grupo de ações.

Nome	Tipo	Valor padrão	Description
id	string		ID de recurso do Azure
location	string		Local do recurso
name	string		Nome do recurso do Azure
properties.armRoleReceivers	ArmRoleReceiver[]		A lista de receptores de função ARM que fazem parte desse grupo de ações. As funções são funções RBAC do Azure e há suporte apenas para funções internas.
properties.automationRunbookReceivers	AutomationRunbookReceiver[]		A lista de receptores AutomationRunbook que fazem parte desse grupo de ações.
properties.azureAppPushReceivers	AzureAppPushReceiver[]		A lista de receptores AzureAppPush que fazem parte desse grupo de ações.
properties.azureFunctionReceivers	AzureFunctionReceiver[]		A lista de receptores de funções do Azure que fazem parte desse grupo de ações.
properties.emailReceivers	EmailReceiver[]		A lista de receptores de email que fazem parte desse grupo de ações.
properties.enabled	boolean	True	Indica se esse grupo de ações está habilitado. Se um grupo de ações não estiver habilitado, nenhum de seus receptores receberá comunicações.
properties.eventHubReceivers	EventHubReceiver[]		A lista de receptores do hub de eventos que fazem parte desse grupo de ações.
properties.groupShortName	string maxLength: 12		O nome curto do grupo de ações. Isso será usado em mensagens SMS.
properties.itsmReceivers	ItsmReceiver[]		A lista de receptores ITSM que fazem parte desse grupo de ações.
properties.logicAppReceivers	LogicAppReceiver[]		A lista de receptores de aplicativo lógico que fazem parte desse grupo de ações.
properties.smsReceivers	SmsReceiver[]		A lista de receptores SMS que fazem parte desse grupo de ações.
properties.voiceReceivers	VoiceReceiver[]		A lista de receptores de voz que fazem parte desse grupo de ações.
properties.webhookReceivers	WebhookReceiver[]		A lista de receptores de webhook que fazem parte desse grupo de ações.
tags	object		Etiquetas de recursos
type	string		Tipo de recurso do Azure

ArmRoleReceiver

Objeto

Um receptor de função de braço.

Nome	Tipo	Valor padrão	Description
name	string		O nome do receptor da função de braço. Os nomes devem ser exclusivos em todos os receptores dentro de um grupo de ações.
roleId	string		A ID da função de braço.
useCommonAlertSchema	boolean	False	Indica se o esquema de alerta comum deve ser usado.

AutomationRunbookReceiver

Objeto

O receptor de notificação do Runbook de Automação do Azure.

Nome	Tipo	Valor padrão	Description
automationAccountId	string		A ID da conta de automação do Azure que contém esse runbook e se autentica no recurso do Azure.
isGlobalRunbook	boolean		Indica se essa instância é um runbook global.
name	string		Indica o nome do webhook.
runbookName	string		O nome deste runbook.
serviceUri	string		O URI para onde os webhooks devem ser enviados.
useCommonAlertSchema	boolean	False	Indica se o esquema de alerta comum deve ser usado.
webhookResourceId	string		A ID do recurso para webhook vinculada a este runbook.

AzureAppPushReceiver

Objeto

O receptor de notificação por push do aplicativo móvel do Azure.

Nome	Tipo	Description
emailAddress	string	O endereço de email registrado para o aplicativo móvel do Azure.
name	string	O nome do receptor de push do aplicativo móvel do Azure. Os nomes devem ser exclusivos em todos os receptores dentro de um grupo de ações.

AzureFunctionReceiver

Objeto

Um receptor de função do Azure.

Nome	Tipo	Valor padrão	Description
functionAppResourceId	string		A ID do recurso do azure do aplicativo de funções.
functionName	string		O nome da função no aplicativo de funções.
httpTriggerUrl	string		A URL do gatilho http para a qual a solicitação http foi enviada.
name	string		O nome do receptor de função do azure. Os nomes devem ser exclusivos em todos os receptores dentro de um grupo de ações.
useCommonAlertSchema	boolean	False	Indica se o esquema de alerta comum deve ser usado.

EmailReceiver

Objeto

Um receptor de email.

Nome	Tipo	Valor padrão	Description
emailAddress	string		O endereço de email desse receptor.
name	string		O nome do receptor de email. Os nomes devem ser exclusivos em todos os receptores dentro de um grupo de ações.
status	ReceiverStatus		O status do receptor do email.
useCommonAlertSchema	boolean	False	Indica se o esquema de alerta comum deve ser usado.

ErrorResponse

Objeto

Descreve o formato da resposta de erro.

Nome	Tipo	Description
code	string	Código de erro
message	string	Mensagem de erro indicando por que a operação falhou.

EventHubReceiver

Objeto

Um receptor do Hub de Eventos.

Nome	Tipo	Valor padrão	Description
eventHubName	string		O nome da fila específica do Hub de Eventos
eventHubNameSpace	string		O namespace do Hub de Eventos
name	string		O nome do receptor do hub de eventos. Os nomes devem ser exclusivos em todos os receptores dentro de um grupo de ações.
subscriptionId	string		A ID da assinatura que contém esse hub de eventos
tenantId	string		A ID do locatário da assinatura que contém esse hub de eventos
useCommonAlertSchema	boolean	False	Indica se o esquema de alerta comum deve ser usado.

ItsmReceiver

Objeto

Um receptor Itsm.

Nome	Tipo	Description
connectionId	string	Identificação exclusiva da conexão ITSM entre vários definidos no workspace acima.
name	string	O nome do receptor Itsm. Os nomes devem ser exclusivos em todos os receptores dentro de um grupo de ações.
region	string	Região na qual o workspace reside. Valores com suporte:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope'
ticketConfiguration	string	Blob JSON para as configurações da ação ITSM. A opção CreateMultipleWorkItems também fará parte desse blob.
workspaceId	string	Identificador de instância do OMS LA.

LogicAppReceiver

Objeto

Um receptor de aplicativo lógico.

Nome	Tipo	Valor padrão	Description
callbackUrl	string		A URL de retorno de chamada para a qual a solicitação http foi enviada.
name	string		O nome do receptor do aplicativo lógico. Os nomes devem ser exclusivos em todos os receptores dentro de um grupo de ações.
resourceId	string		A ID do recurso do azure do receptor do aplicativo lógico.
useCommonAlertSchema	boolean	False	Indica se o esquema de alerta comum deve ser usado.

ReceiverStatus

Enumeração

Indica o status do receptor. Os receptores que não estão habilitados não receberão nenhuma comunicação.

Valor	Description
NotSpecified
Enabled
Disabled

SmsReceiver

Objeto

Um receptor SMS.

Nome	Tipo	Description
countryCode	string	O código do país do receptor SMS.
name	string	O nome do receptor SMS. Os nomes devem ser exclusivos em todos os receptores dentro de um grupo de ações.
phoneNumber	string	O número de telefone do receptor sms.
status	ReceiverStatus	O status do receptor.

VoiceReceiver

Objeto

Um receptor de voz.

Nome	Tipo	Description
countryCode	string	O código do país do receptor de voz.
name	string	O nome do receptor de voz. Os nomes devem ser exclusivos em todos os receptores dentro de um grupo de ações.
phoneNumber	string	O número de telefone do receptor de voz.

WebhookReceiver

Objeto

Um receptor de webhook.

Nome	Tipo	Valor padrão	Description
identifierUri	string		Indica o uri do identificador para autenticação de aad.
name	string		O nome do receptor do webhook. Os nomes devem ser exclusivos em todos os receptores dentro de um grupo de ações.
objectId	string		Indica a ID do objeto do aplicativo webhook para autenticação de aad.
serviceUri	string		O URI para onde os webhooks devem ser enviados.
tenantId	string		Indica a ID do locatário para autenticação de aad.
useAadAuth	boolean	False	Indica se a autenticação do AAD deve ou não ser usada.
useCommonAlertSchema	boolean	False	Indica se o esquema de alerta comum deve ser usado.

Compartilhar via

Action Groups - Update

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

azure_auth

Escopos

Exemplos

Patch an action group

Solicitação de exemplo

Resposta de exemplo

Definições

ActionGroupPatchBody

ActionGroupResource

ArmRoleReceiver

AutomationRunbookReceiver

AzureAppPushReceiver

AzureFunctionReceiver

EmailReceiver

ErrorResponse

EventHubReceiver

ItsmReceiver

LogicAppReceiver

ReceiverStatus

SmsReceiver

VoiceReceiver

WebhookReceiver