次の方法で共有


Update-AzActionGroup

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

構文

UpdateExpanded (既定)

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>]

UpdateViaIdentityExpanded

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

パラメーターのプロパティ

型:

IArmRoleReceiver[]

規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-AutomationRunbookReceiver

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

パラメーターのプロパティ

型:

IAutomationRunbookReceiver[]

規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-AzureAppPushReceiver

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

パラメーターのプロパティ

型:

IAzureAppPushReceiver[]

規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-AzureFunctionReceiver

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

パラメーターのプロパティ

型:

IAzureFunctionReceiver[]

規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Confirm

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

パラメーターのプロパティ

型:SwitchParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:cf

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-DefaultProfile

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

パラメーターのプロパティ

型:PSObject
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:AzureRMContext, AzureCredential

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-EmailReceiver

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

パラメーターのプロパティ

型:

IEmailReceiver[]

規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Enabled

このアクション グループが有効かどうかを示します。 アクション グループが有効になっていない場合、どの受信者も通信を受信しません。

パラメーターのプロパティ

型:SwitchParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-EventHubReceiver

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

パラメーターのプロパティ

型:

IEventHubReceiver[]

規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-GroupShortName

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

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:ShortName

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-InputObject

IDENTITY パラメーター

パラメーターのプロパティ

型:IActionGroupIdentity
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

UpdateViaIdentityExpanded
配置:Named
必須:True
パイプラインからの値:True
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-ItsmReceiver

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

パラメーターのプロパティ

型:

IItsmReceiver[]

規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-LogicAppReceiver

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

パラメーターのプロパティ

型:

ILogicAppReceiver[]

規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Name

アクション グループの名前。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:ActionGroupName

パラメーター セット

UpdateExpanded
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-ResourceGroupName

リソース グループの名前。 名前は大文字と小文字が区別されます。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

UpdateExpanded
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-SmsReceiver

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

パラメーターのプロパティ

型:

ISmsReceiver[]

規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-SubscriptionId

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

パラメーターのプロパティ

型:String
規定値:(Get-AzContext).Subscription.Id
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

UpdateExpanded
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Tag

リソース タグ

パラメーターのプロパティ

型:Hashtable
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-VoiceReceiver

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

パラメーターのプロパティ

型:

IVoiceReceiver[]

規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-WebhookReceiver

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

パラメーターのプロパティ

型:

IWebhookReceiver[]

規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-WhatIf

コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。

パラメーターのプロパティ

型:SwitchParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:ウィスコンシン

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

CommonParameters

このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。

入力

IActionGroupIdentity

出力

IActionGroupResource