Update-AzActionGroup

  • リファレンス
モジュール:
Az.Monitor

新しいアクション グループを更新するか、既存のアクション グループを更新します。

構文

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[]>]
      [-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[]>]
      [-LogicAppReceiver <ILogicAppReceiver[]>]
      [-SmsReceiver <ISmsReceiver[]>]
      [-Tag <Hashtable>]
      [-VoiceReceiver <IVoiceReceiver[]>]
      [-WebhookReceiver <IWebhookReceiver[]>]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

新しいアクション グループを更新するか、既存のアクション グループを更新します。

例

例 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 ロールであり、組み込みロールのみがサポートされています。

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

-AutomationRunbookReceiver

このアクション グループの一部である AutomationRunbook レシーバーの一覧。

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

-AzureAppPushReceiver

このアクション グループの一部である AzureAppPush レシーバーの一覧。

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

-AzureFunctionReceiver

このアクション グループの一部である Azure 関数レシーバーの一覧。

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

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

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

-DefaultProfile

DefaultProfile パラメーターは機能しません。 別のサブスクリプションに対してコマンドレットを実行する場合は、使用可能な場合は SubscriptionId パラメーターを使用します。

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

-EmailReceiver

このアクション グループの一部である電子メール 受信者の一覧。

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

このアクション グループの一部であるイベント ハブ レシーバーの一覧。

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

-GroupShortName

アクション グループの短い名前。 これは SMS メッセージで使用されます。

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

-InputObject

IDENTITY パラメーター

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

-ItsmReceiver

このアクション グループの一部である ITSM レシーバーの一覧。

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

-LogicAppReceiver

このアクション グループの一部であるロジック アプリレシーバーの一覧。

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 レシーバーの一覧。

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

-SubscriptionId

ターゲット サブスクリプションの ID。

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

このアクション グループの一部である音声レシーバーの一覧。

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

-WebhookReceiver

このアクション グループの一部である Webhook レシーバーの一覧。

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

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

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

入力

IActionGroupIdentity

出力

IActionGroupResource