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 參數

名稱	位於	必要	類型	Description
actionGroupName	path	True	string	動作群組的名稱。
resourceGroupName	path	True	string	資源群組的名稱。名稱不區分大小寫。
subscriptionId	path	True	string	目標訂用帳戶的標識碼。
api-version	query	True	string	用於此作業的 API 版本。

要求本文

名稱	類型	Description
properties.enabled	boolean	指出是否啟用此動作群組。如果未啟用動作群組，則不會啟用其任何動作。
tags	object	資源標籤

回應

名稱	類型	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

範圍

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

定義

名稱	Description
ActionGroupPatchBody	修補作業主體的動作群組物件。
ActionGroupResource	動作群組資源。
ArmRoleReceiver	arm 角色接收器。
AutomationRunbookReceiver	Azure 自動化 Runbook 通知接收者。
AzureAppPushReceiver	Azure 行動應用程式推播通知接收者。
AzureFunctionReceiver	azure 函式接收者。
EmailReceiver	電子郵件接收者。
ErrorResponse	描述錯誤回應的格式。
EventHubReceiver	事件中樞接收者。
ItsmReceiver	Itsm 接收者。
LogicAppReceiver	邏輯應用程式接收者。
ReceiverStatus	指出接收者的狀態。未啟用的接收者將不會接收任何通訊。
SmsReceiver	SMS 接收者。
VoiceReceiver	語音接收器。
WebhookReceiver	Webhook 接收者。

ActionGroupPatchBody

修補作業主體的動作群組物件。

名稱	類型	預設值	Description
properties.enabled	boolean	True	指出是否啟用此動作群組。如果未啟用動作群組，則不會啟動其任何動作。
tags	object		資源標籤

ActionGroupResource

動作群組資源。

名稱	類型	預設值	Description
id	string		Azure 資源標識碼
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[]		屬於此動作群組一部分的 Webhook 接收者清單。
tags	object		資源標籤
type	string		Azure 資源類型

ArmRoleReceiver

arm 角色接收器。

名稱	類型	預設值	Description
name	string		arm 角色接收者的名稱。名稱在動作群組內的所有接收者中都必須是唯一的。
roleId	string		arm 角色標識碼。
useCommonAlertSchema	boolean	False	指出是否要使用一般警示架構。

AutomationRunbookReceiver

Azure 自動化 Runbook 通知接收者。

名稱	類型	預設值	Description
automationAccountId	string		保留此 Runbook 並向 Azure 資源驗證的 Azure 自動化帳戶標識碼。
isGlobalRunbook	boolean		指出這個實例是否為全域 Runbook。
name	string		表示 Webhook 的名稱。
runbookName	string		此 Runbook 的名稱。
serviceUri	string		應傳送 Webhook 的 URI。
useCommonAlertSchema	boolean	False	指出是否要使用一般警示架構。
webhookResourceId	string		連結至此 Runbook 之 Webhook 的資源識別碼。

AzureAppPushReceiver

Azure 行動應用程式推播通知接收者。

名稱	類型	Description
emailAddress	string	為 Azure 行動應用程式註冊的電子郵件位址。
name	string	Azure 行動應用程式推播接收者的名稱。名稱在動作群組內的所有接收者中都必須是唯一的。

AzureFunctionReceiver

azure 函式接收者。

名稱	類型	預設值	Description
functionAppResourceId	string		函式應用程式的 Azure 資源識別碼。
functionName	string		函式應用程式中的函式名稱。
httpTriggerUrl	string		HTTP 觸發程式 URL，其中 HTTP 要求傳送到其中。
name	string		azure 函式接收者的名稱。名稱在動作群組內的所有接收者中都必須是唯一的。
useCommonAlertSchema	boolean	False	指出是否要使用一般警示架構。

EmailReceiver

電子郵件接收者。

名稱	類型	預設值	Description
emailAddress	string		此接收者的電子郵件位址。
name	string		電子郵件接收者的名稱。名稱在動作群組內的所有接收者中都必須是唯一的。
status	ReceiverStatus		電子郵件的接收者狀態。
useCommonAlertSchema	boolean	False	指出是否要使用一般警示架構。

ErrorResponse

描述錯誤回應的格式。

名稱	類型	Description
code	string	錯誤碼
message	string	錯誤訊息，指出作業失敗的原因。

EventHubReceiver

事件中樞接收者。

名稱	類型	預設值	Description
eventHubName	string		特定事件中樞佇列的名稱
eventHubNameSpace	string		事件中樞命名空間
name	string		事件中樞接收者的名稱。名稱在動作群組內的所有接收者中都必須是唯一的。
subscriptionId	string		包含此事件中樞的訂用帳戶標識碼
tenantId	string		包含此事件中樞之訂用帳戶的租用戶標識碼
useCommonAlertSchema	boolean	False	指出是否要使用一般警示架構。

ItsmReceiver

Itsm 接收者。

名稱	類型	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 實例標識碼。

LogicAppReceiver

邏輯應用程式接收者。

名稱	類型	預設值	Description
callbackUrl	string		HTTP 要求傳送至其中的回呼 URL。
name	string		邏輯應用程式接收者的名稱。名稱在動作群組內的所有接收者中都必須是唯一的。
resourceId	string		邏輯應用程式接收者的 Azure 資源識別碼。
useCommonAlertSchema	boolean	False	指出是否要使用一般警示架構。

ReceiverStatus

指出接收者的狀態。未啟用的接收者將不會接收任何通訊。

名稱	類型	Description
Disabled	string
Enabled	string
NotSpecified	string

SmsReceiver

SMS 接收者。

名稱	類型	Description
countryCode	string	SMS 接收者的國家/地區代碼。
name	string	SMS 接收者的名稱。名稱在動作群組內的所有接收者中都必須是唯一的。
phoneNumber	string	SMS 接收者的電話號碼。
status	ReceiverStatus	接收者的狀態。

VoiceReceiver

語音接收器。

名稱	類型	Description
countryCode	string	語音接收器的國家/地區代碼。
name	string	語音接收器的名稱。名稱在動作群組內的所有接收者中都必須是唯一的。
phoneNumber	string	語音接收器的電話號碼。

WebhookReceiver

Webhook 接收者。

名稱	類型	預設值	Description
identifierUri	string		指出 aad 驗證的識別碼 URI。
name	string		Webhook 接收者的名稱。名稱在動作群組內的所有接收者中都必須是唯一的。
objectId	string		指出 aad 驗證的 Webhook 應用程式物件識別碼。
serviceUri	string		應傳送 Webhook 的 URI。
tenantId	string		指出 aad 驗證的租用戶標識碼。
useAadAuth	boolean	False	指出是否使用 AAD 驗證。
useCommonAlertSchema	boolean	False	指出是否要使用一般警示架構。

共用方式為