Share via


Update-AzActionGroup

建立新的動作群組或更新現有的動作群組。

Syntax

Update-AzActionGroup
      -Name <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      [-ArmRoleReceiver <IArmRoleReceiver[]>]
      [-AutomationRunbookReceiver <IAutomationRunbookReceiver[]>]
      [-AzureAppPushReceiver <IAzureAppPushReceiver[]>]
      [-AzureFunctionReceiver <IAzureFunctionReceiver[]>]
      [-EmailReceiver <IEmailReceiver[]>]
      [-Enabled]
      [-EventHubReceiver <IEventHubReceiver[]>]
      [-GroupShortName <String>]
      [-ItsmReceiver <IItsmReceiver[]>]
      [-Location <String>]
      [-LogicAppReceiver <ILogicAppReceiver[]>]
      [-SmsReceiver <ISmsReceiver[]>]
      [-Tag <Hashtable>]
      [-VoiceReceiver <IVoiceReceiver[]>]
      [-WebhookReceiver <IWebhookReceiver[]>]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzActionGroup
      -InputObject <IActionGroupIdentity>
      [-ArmRoleReceiver <IArmRoleReceiver[]>]
      [-AutomationRunbookReceiver <IAutomationRunbookReceiver[]>]
      [-AzureAppPushReceiver <IAzureAppPushReceiver[]>]
      [-AzureFunctionReceiver <IAzureFunctionReceiver[]>]
      [-EmailReceiver <IEmailReceiver[]>]
      [-Enabled]
      [-EventHubReceiver <IEventHubReceiver[]>]
      [-GroupShortName <String>]
      [-ItsmReceiver <IItsmReceiver[]>]
      [-Location <String>]
      [-LogicAppReceiver <ILogicAppReceiver[]>]
      [-SmsReceiver <ISmsReceiver[]>]
      [-Tag <Hashtable>]
      [-VoiceReceiver <IVoiceReceiver[]>]
      [-WebhookReceiver <IWebhookReceiver[]>]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

建立新的動作群組或更新現有的動作群組。

範例

範例 1:將接收者新增至指定的動作群組

$enventhub = New-AzActionGroupEventHubReceiverObject -EventHubName "testEventHub" -EventHubNameSpace "actiongrouptest" -Name "sample eventhub" -SubscriptionId '{subid}'
Update-AzActionGroup -Name actiongroup1 -ResourceGroupName monitor-action -EventHubReceiver $enventhub

ArmRoleReceiver           : {}
AutomationRunbookReceiver : {}
AzureAppPushReceiver      : {}
AzureFunctionReceiver     : {}
EmailReceiver             : {{
                              "name": "user1",
                              "emailAddress": "{user}@microsoft.com",
                              "useCommonAlertSchema": false,
                              "status": "Enabled"
                            }}
Enabled                   : False
EventHubReceiver          : {{
                              "name": "sample eventhub",
                              "eventHubNameSpace": "actiongrouptest",
                              "eventHubName": "testEventHub",
                              "useCommonAlertSchema": false,
                              "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
                              "subscriptionId": "{subid}"
                            }}
GroupShortName            : ag1
Id                        : /subscriptions/{subid}/resourceGroups/monitor-action/providers/microsoft.insights/actionGroups/actiongroup1
ItsmReceiver              : {}
Location                  : southcentralus
LogicAppReceiver          : {}
Name                      : actiongroup1
ResourceGroupName         : monitor-action
SmsReceiver               : {{
                              "name": "user2",
                              "countryCode": "{code}",
                              "phoneNumber": "{phonenumber}",
                              "status": "Enabled"
                            }}
Tag                       : {
                            }
Type                      : Microsoft.Insights/ActionGroups
VoiceReceiver             : {}
WebhookReceiver           : {}

此命令會使用名稱和群組來更新指定的動作群組。

範例 2:將接收者刪除至指定的動作群組

$ag = Get-AzActionGroup -Name actiongroup1 -ResourceGroupName monitor-action
Update-AzActionGroup -InputObject $ag -EventHubReceiver $null

ArmRoleReceiver           : {}
AutomationRunbookReceiver : {}
AzureAppPushReceiver      : {}
AzureFunctionReceiver     : {}
EmailReceiver             : {{
                              "name": "user1",
                              "emailAddress": "{user}@microsoft.com",
                              "useCommonAlertSchema": false,
                              "status": "Enabled"
                            }}
Enabled                   : False
EventHubReceiver          : {}
GroupShortName            : ag1
Id                        : /subscriptions/{subid}/resourceGroups/Monitor-Action/providers/microsoft.insights/actionGroups/actiongroup1
ItsmReceiver              : {}
Location                  : southcentralus
LogicAppReceiver          : {}
Name                      : actiongroup1
ResourceGroupName         : Monitor-Action
SmsReceiver               : {{
                              "name": "user2",
                              "countryCode": "{code}",
                              "phoneNumber": "{phonenumber}",
                              "status": "Enabled"
                            }}
Tag                       : {
                            }
Type                      : Microsoft.Insights/ActionGroups
VoiceReceiver             : {}
WebhookReceiver           : {}

第一個命令會取得指定的動作群組。 最後一個命令會使用動作群組物件來更新指定的動作群組。

參數

-ArmRoleReceiver

屬於此動作群組一部分的ARM角色接收者清單。 角色是 Azure RBAC 角色,僅支援內建角色。 若要建構,請參閱ARMROLERECEIVER屬性的NOTES區段並建立哈希表。

Type:IArmRoleReceiver[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AutomationRunbookReceiver

屬於此動作群組一部分的 AutomationRunbook 接收者清單。 若要建構,請參閱 AUTOMATIONRUNBOOKRECEIVER 屬性的 NOTES 一節,並建立哈希表。

Type:IAutomationRunbookReceiver[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AzureAppPushReceiver

屬於此動作群組一部分的 AzureAppPush 接收者清單。 若要建構,請參閱 AZUREAPPPUSHRECEIVER 屬性的 NOTES 區段,並建立哈希表。

Type:IAzureAppPushReceiver[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AzureFunctionReceiver

屬於此動作群組一部分的 Azure 函式接收者清單。 若要建構,請參閱 AZUREFUNCTIONRECEIVER 屬性的 NOTES 一節,並建立哈希表。

Type:IAzureFunctionReceiver[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

執行 Cmdlet 之前先提示您確認。

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

DefaultProfile 參數無法運作。 如果針對不同的訂用帳戶執行 Cmdlet,請使用 SubscriptionId 參數。

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EmailReceiver

屬於此動作群組一部分的電子郵件接收者清單。 若要建構,請參閱 EMAILRECEIVER 屬性的 NOTES 區段並建立哈希表。

Type:IEmailReceiver[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Enabled

指出是否啟用此動作群組。 如果未啟用動作群組,則沒有任何接收者會收到通訊。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EventHubReceiver

屬於此動作群組一部分的事件中樞接收者清單。 若要建構,請參閱 EVENTHUBRECEIVER 屬性的 NOTES 區段並建立哈希表。

Type:IEventHubReceiver[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-GroupShortName

動作群組的簡短名稱。 這將會用於簡訊。

Type:String
Aliases:ShortName
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:IActionGroupIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ItsmReceiver

屬於此動作群組一部分的 ITSM 接收者清單。 若要建構,請參閱 ITSMRECEIVER 屬性的 NOTES 區段並建立哈希表。

Type:IItsmReceiver[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Location

資源位置

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LogicAppReceiver

屬於此動作群組一部分的邏輯應用程式接收者清單。 若要建構,請參閱LOGICAPPRECEIVER屬性的NOTES區段並建立哈希表。

Type:ILogicAppReceiver[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

動作群組的名稱。

Type:String
Aliases:ActionGroupName
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

資源群組的名稱。 名稱不區分大小寫。

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-SmsReceiver

屬於此動作群組一部分的SMS接收者清單。 若要建構,請參閱SMSRECEIVER屬性的NOTES區段並建立哈希表。

Type:ISmsReceiver[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SubscriptionId

目標訂用帳戶的標識碼。

Type:String
Position:Named
Default value:(Get-AzContext).Subscription.Id
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Tag

資源標籤

Type:Hashtable
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VoiceReceiver

屬於此動作群組一部分的語音接收器清單。 若要建構,請參閱 VOICERECEIVER 屬性的 NOTES 區段並建立哈希表。

Type:IVoiceReceiver[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WebhookReceiver

屬於此動作群組一部分的 Webhook 接收者清單。 若要建構,請參閱 WEBHOOKRECEIVER 屬性的 NOTES 一節,並建立哈希表。

Type:IWebhookReceiver[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

顯示執行 Cmdlet 後會發生的情況。 未執行 Cmdlet。

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

輸入

IActionGroupIdentity

輸出

IActionGroupResource