Action Groups - Update

참조

서비스:: Monitor

API 버전:: 2021-09-01

기존 작업 그룹의 태그를 업데이트. 다른 필드를 업데이트하려면 CreateOrUpdate 메서드를 사용합니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
actionGroupName	path	True	string	작업 그룹의 이름입니다.
resourceGroupName	path	True	string	리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
subscriptionId	path	True	string	대상 구독의 ID입니다.
api-version	query	True	string	이 작업에 사용할 API 버전입니다.

요청 본문

Name	형식	Description
properties.enabled	boolean	이 작업 그룹을 사용할 수 있는지 여부를 나타냅니다. 작업 그룹을 사용하도록 설정하지 않으면 해당 작업이 활성화되지 않습니다.
tags	object	리소스 태그

응답

Name	형식	Description
200 OK	ActionGroupResource	기존 작업 그룹이 성공적으로 업데이트되었습니다.
Other Status Codes	ErrorResponse	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

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

샘플 응답

상태 코드:: 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": []
  }
}

정의

Name	Description
ActionGroupPatchBody	패치 작업 본문에 대한 작업 그룹 개체입니다.
ActionGroupResource	작업 그룹 리소스입니다.
ArmRoleReceiver	arm 역할 수신기입니다.
AutomationRunbookReceiver	Azure Automation Runbook 알림 수신기입니다.
AzureAppPushReceiver	Azure 모바일 앱 푸시 알림 수신기.
AzureFunctionReceiver	azure 함수 수신기입니다.
EmailReceiver	전자 메일 수신자입니다.
ErrorResponse	오류 응답의 형식을 설명합니다.
EventHubReceiver	이벤트 허브 수신기입니다.
ItsmReceiver	Itsm 수신기입니다.
LogicAppReceiver	논리 앱 수신기입니다.
ReceiverStatus	수신기의 상태 나타냅니다. 사용하도록 설정되지 않은 수신기는 통신을 받지 않습니다.
SmsReceiver	SMS 수신자입니다.
VoiceReceiver	음성 수신기.
WebhookReceiver	웹후크 수신기입니다.

ActionGroupPatchBody

패치 작업 본문에 대한 작업 그룹 개체입니다.

Name	형식	Default value	Description
properties.enabled	boolean	True	이 작업 그룹을 사용할 수 있는지 여부를 나타냅니다. 작업 그룹을 사용하도록 설정하지 않으면 해당 작업이 활성화되지 않습니다.
tags	object		리소스 태그

ActionGroupResource

작업 그룹 리소스입니다.

Name	형식	Default value	Description
id	string		Azure 리소스 ID
location	string		리소스 위치
name	string		Azure 리소스 이름
properties.armRoleReceivers	ArmRoleReceiver[]		이 작업 그룹의 일부인 ARM 역할 수신기 목록입니다. 역할은 Azure RBAC 역할이며 기본 제공 역할만 지원됩니다.
properties.automationRunbookReceivers	AutomationRunbookReceiver[]		이 작업 그룹의 일부인 AutomationRunbook 수신기 목록입니다.
properties.azureAppPushReceivers	AzureAppPushReceiver[]		이 작업 그룹의 일부인 AzureAppPush 수신기 목록입니다.
properties.azureFunctionReceivers	AzureFunctionReceiver[]		이 작업 그룹의 일부인 Azure 함수 수신기 목록입니다.
properties.emailReceivers	EmailReceiver[]		이 작업 그룹의 일부인 이메일 수신자 목록입니다.
properties.enabled	boolean	True	이 작업 그룹을 사용할 수 있는지 여부를 나타냅니다. 작업 그룹을 사용하도록 설정하지 않으면 해당 수신기 중 어느 것도 통신을 받지 않습니다.
properties.eventHubReceivers	EventHubReceiver[]		이 작업 그룹의 일부인 이벤트 허브 수신기 목록입니다.
properties.groupShortName	string		작업 그룹의 짧은 이름입니다. SMS 메시지에 사용됩니다.
properties.itsmReceivers	ItsmReceiver[]		이 작업 그룹의 일부인 ITSM 수신기 목록입니다.
properties.logicAppReceivers	LogicAppReceiver[]		이 작업 그룹의 일부인 논리 앱 수신기 목록입니다.
properties.smsReceivers	SmsReceiver[]		이 작업 그룹의 일부인 SMS 수신자 목록입니다.
properties.voiceReceivers	VoiceReceiver[]		이 작업 그룹의 일부인 음성 수신기 목록입니다.
properties.webhookReceivers	WebhookReceiver[]		이 작업 그룹의 일부인 웹후크 수신기 목록입니다.
tags	object		리소스 태그
type	string		Azure 리소스 종류

ArmRoleReceiver

arm 역할 수신기입니다.

Name	형식	Default value	Description
name	string		arm 역할 수신기의 이름입니다. 이름은 작업 그룹 내의 모든 수신기에서 고유해야 합니다.
roleId	string		arm 역할 ID입니다.
useCommonAlertSchema	boolean	False	일반적인 경고 스키마를 사용할지 여부를 나타냅니다.

AutomationRunbookReceiver

Azure Automation Runbook 알림 수신기입니다.

Name	형식	Default value	Description
automationAccountId	string		이 Runbook을 보유하고 Azure 리소스에 인증하는 Azure Automation 계정 ID입니다.
isGlobalRunbook	boolean		이 instance 전역 Runbook인지 여부를 나타냅니다.
name	string		웹후크의 이름을 나타냅니다.
runbookName	string		이 Runbook의 이름입니다.
serviceUri	string		웹후크를 보내야 하는 URI입니다.
useCommonAlertSchema	boolean	False	일반적인 경고 스키마를 사용할지 여부를 나타냅니다.
webhookResourceId	string		이 Runbook에 연결된 웹후크의 리소스 ID입니다.

AzureAppPushReceiver

Azure 모바일 앱 푸시 알림 수신기.

Name	형식	Description
emailAddress	string	Azure 모바일 앱에 등록된 이메일 주소입니다.
name	string	Azure 모바일 앱 푸시 수신기의 이름입니다. 이름은 작업 그룹 내의 모든 수신기에서 고유해야 합니다.

AzureFunctionReceiver

azure 함수 수신기입니다.

Name	형식	Default value	Description
functionAppResourceId	string		함수 앱의 azure 리소스 ID입니다.
functionName	string		함수 앱의 함수 이름입니다.
httpTriggerUrl	string		http 요청이 전송되는 http 트리거 URL입니다.
name	string		azure 함수 수신기의 이름입니다. 이름은 작업 그룹 내의 모든 수신기에서 고유해야 합니다.
useCommonAlertSchema	boolean	False	일반적인 경고 스키마를 사용할지 여부를 나타냅니다.

EmailReceiver

전자 메일 수신자입니다.

Name	형식	Default value	Description
emailAddress	string		이 수신자의 이메일 주소입니다.
name	string		전자 메일 수신자의 이름입니다. 이름은 작업 그룹 내의 모든 수신기에서 고유해야 합니다.
status	ReceiverStatus		수신자가 전자 메일의 상태.
useCommonAlertSchema	boolean	False	일반적인 경고 스키마를 사용할지 여부를 나타냅니다.

ErrorResponse

오류 응답의 형식을 설명합니다.

Name	형식	Description
code	string	오류 코드
message	string	작업이 실패한 이유를 나타내는 오류 메시지입니다.

EventHubReceiver

이벤트 허브 수신기입니다.

Name	형식	Default value	Description
eventHubName	string		특정 이벤트 허브 큐의 이름
eventHubNameSpace	string		Event Hub 네임스페이스
name	string		이벤트 허브 수신기의 이름입니다. 이름은 작업 그룹 내의 모든 수신기에서 고유해야 합니다.
subscriptionId	string		이 이벤트 허브를 포함하는 구독의 ID
tenantId	string		이 이벤트 허브를 포함하는 구독의 테넌트 ID
useCommonAlertSchema	boolean	False	일반적인 경고 스키마를 사용할지 여부를 나타냅니다.

ItsmReceiver

Itsm 수신기입니다.

Name	형식	Description
connectionId	string	위의 작업 영역에 정의된 여러 항목 간의 ITSM 연결을 고유하게 식별합니다.
name	string	Itsm 수신기의 이름입니다. 이름은 작업 그룹 내의 모든 수신기에서 고유해야 합니다.
region	string	작업 영역이 있는 지역입니다. 지원되는 값:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope'
ticketConfiguration	string	ITSM 작업의 구성에 대한 JSON Blob입니다. CreateMultipleWorkItems 옵션도 이 Blob의 일부가 됩니다.
workspaceId	string	OMS LA instance 식별자입니다.

LogicAppReceiver

논리 앱 수신기입니다.

Name	형식	Default value	Description
callbackUrl	string		http 요청이 전송된 콜백 URL입니다.
name	string		논리 앱 수신기의 이름입니다. 이름은 작업 그룹 내의 모든 수신기에서 고유해야 합니다.
resourceId	string		논리 앱 수신기의 azure 리소스 ID입니다.
useCommonAlertSchema	boolean	False	일반적인 경고 스키마를 사용할지 여부를 나타냅니다.

ReceiverStatus

수신기의 상태 나타냅니다. 사용하도록 설정되지 않은 수신기는 통신을 받지 않습니다.

Name	형식	Description
Disabled	string
Enabled	string
NotSpecified	string

SmsReceiver

SMS 수신자입니다.

Name	형식	Description
countryCode	string	SMS 수신자의 국가 코드입니다.
name	string	SMS 수신자의 이름입니다. 이름은 작업 그룹 내의 모든 수신기에서 고유해야 합니다.
phoneNumber	string	SMS 수신자의 전화 번호입니다.
status	ReceiverStatus	수신기의 상태.

VoiceReceiver

음성 수신기.

Name	형식	Description
countryCode	string	음성 수신기의 국가 코드입니다.
name	string	음성 수신기의 이름입니다. 이름은 작업 그룹 내의 모든 수신기에서 고유해야 합니다.
phoneNumber	string	음성 수신기의 전화 번호입니다.

WebhookReceiver

웹후크 수신기입니다.

Name	형식	Default value	Description
identifierUri	string		aad 인증의 식별자 URI를 나타냅니다.
name	string		웹후크 수신기의 이름입니다. 이름은 작업 그룹 내의 모든 수신기에서 고유해야 합니다.
objectId	string		aad 인증에 대한 웹후크 앱 개체 ID를 나타냅니다.
serviceUri	string		웹후크를 보내야 하는 URI입니다.
tenantId	string		aad 인증에 대한 테넌트 ID를 나타냅니다.
useAadAuth	boolean	False	AAD 인증을 사용할지 여부를 나타냅니다.
useCommonAlertSchema	boolean	False	일반적인 경고 스키마를 사용할지 여부를 나타냅니다.

다음을 통해 공유