次の方法で共有

Set-AzActivityLogAlert

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

新しいアクティビティ ログ アラートを作成するか、既存のアクティビティ ログ アラートを設定します。

構文

Set-AzActivityLogAlert
   -Location <String>
   -Name <String>
   -ResourceGroupName <String>
   -Scope <System.Collections.Generic.List`1[System.String]>
   -Condition <System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertLeafCondition]>
   -Action <System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertActionGroup]>
   [-DisableAlert]
   [-Description <String>]
   [-Tag <System.Collections.Generic.Dictionary`2[System.String,System.String]>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzActivityLogAlert
   [-Location <String>]
   [-Scope <System.Collections.Generic.List`1[System.String]>]
   [-Condition <System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertLeafCondition]>]
   [-Action <System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertActionGroup]>]
   [-DisableAlert]
   [-Description <String>]
   [-Tag <System.Collections.Generic.Dictionary`2[System.String,System.String]>]
   -ResourceId <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzActivityLogAlert
   [-Scope <System.Collections.Generic.List`1[System.String]>]
   [-Condition <System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertLeafCondition]>]
   [-Action <System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertActionGroup]>]
   [-Description <String>]
   [-Tag <System.Collections.Generic.Dictionary`2[System.String,System.String]>]
   -InputObject <PSActivityLogAlertResource>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

説明

Set-AzActivityLogAlert コマンドレットは、新しいアクティビティ ログ アラートを作成するか、既存のアクティビティ ログ アラートを設定します。 タグ、条件、およびアクションについては、オブジェクトを事前に作成し、この呼び出しでパラメーターとしてコンマ区切りで渡す必要があります (以下の例を参照)。 このコマンドレットは ShouldProcess パターンを実装します。つまり、実際にリソースを作成または変更する前に、ユーザーに確認を要求する場合があります。 注: このコマンドレットとそれに関連するコマンドレットは、非推奨 (2017 年 11 月) Add-AzLogAlertRuleに代わるものになります。

例

例 1: アクティビティ ログ アラートを作成する

PS C:\>$location = 'Global'
PS C:\>$alertName = 'myAlert'
PS C:\>$resourceGroupName = 'theResourceGroupName'
PS C:\>$condition1 = New-AzActivityLogAlertCondition -Field 'field1' -Equal 'equals1'
PS C:\>$condition2 = New-AzActivityLogAlertCondition -Field 'field2' -Equal 'equals2'
PS C:\>$dict = New-Object "System.Collections.Generic.Dictionary``2[System.String,System.String]"
PS C:\>$dict.Add('key1', 'value1')
PS C:\>$actionGrp1 = New-AzActionGroup -ActionGroupId 'actiongr1' -WebhookProperty $dict
PS C:\>Set-AzActivityLogAlert -Location $location -Name $alertName -ResourceGroupName $resourceGroupName -Scope 'scope1','scope2' -Action $actionGrp1 -Condition $condition1, $condition2

最初の 4 つのコマンドは、リーフ条件とアクション グループを作成します。 最後のコマンドは、条件とアクション グループを使用してアクティビティ ログ アラートを作成します。

例 2: アクティビティ ログ アラートを作成する

PS C:\>$location = 'Global'
PS C:\>$alertName = 'myAlert'
PS C:\>$resourceGroupName = 'theResourceGroupName'
PS C:\>$condition1 = New-AzActivityLogAlertCondition -Field 'field1' -Equal 'equals1'
PS C:\>$condition2 = New-AzActivityLogAlertCondition -Field 'field2' -Equal 'equals2'
PS C:\>$dict = New-Object "System.Collections.Generic.Dictionary``2[System.String,System.String]"
PS C:\>$dict.Add('key1', 'value1')
PS C:\>$actionGrp1 = New-AzActionGroup -ActionGroupId 'actiongr1' -WebhookProperty $dict
PS C:\>Set-AzActivityLogAlert -Location $location -Name $alertName -ResourceGroupName $resourceGroupName -Scope 'scope1','scope2' -Action $actionGrp1 -Condition $condition1, $condition2 -DisableAlert

最初の 4 つのコマンドは、リーフ条件とアクション グループを作成します。 最後のコマンドでは、条件とアクション グループを使用してアクティビティ ログ アラートが作成されますが、アラートは無効になります。

例 3: パイプまたは InputObject パラメーターの値を使用して、アクティビティ ログ アラートを設定する

PS C:\>Get-AzActivityLogAlert -Name $alertName -ResourceGroupName $resourceGroupName | Set-AzActivityLogAlert
PS C:\>$alert = Get-AzActivityLogAlert -Name $alertName -ResourceGroupName $resourceGroupName
PS C:\>$alert.Description = 'Changing the description'
PS C:\>$alert.Enabled = $false
PS C:\>Set-AzActivityLogAlert -InputObject $alert

最初のコマンドは nop に似ています。既に含まれているのと同じ値でアラートを設定します。残りのコマンドはアラート ルールを取得し、説明を変更して無効にしてから、InputObject パラメーターを使用してそれらの変更を保持します

例 4: パイプの ResourceId 値を使用して、アクティビティ ログ アラートを設定する

PS C:\>Get-AzResource -ResourceGroupName "myResourceGroup" -Name "myLogAlert" | Set-AzActivityLogAlert -DisableAlert

指定されたログ アラート ルールが存在する場合、このコマンドによって無効になります。

パラメーター

-Action

アクティビティ ログ アラートのアクション グループの一覧。

型:List<T>[ActivityLogAlertActionGroup]
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-Condition

アクティビティ ログ アラートの条件の一覧。 注: 条件の一覧には、フィールドが "Category" と等しい条件が少なくとも 1 つ必要です。 この条件が存在しない場合、バックエンドは 400 (BadRequest) で応答します。

型:List<T>[Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertLeafCondition]
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-Confirm

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

型:SwitchParameter
Aliases:cf
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-DefaultProfile

Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション

型:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Description

アラート リソースの説明。

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-DisableAlert

ユーザーがアクティビティ ログ アラートを無効にして作成できるようにします。 指定しない場合は、アラートが有効に作成されます。

型:SwitchParameter
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-InputObject

必要な名前とリソース グループ名のプロパティを抽出する呼び出しの InputObject tags プロパティを設定します。

型:PSActivityLogAlertResource
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-Location

アクティビティ ログ アラートが存在する場所。

型:String
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-Name

アクティビティ ログ アラートの名前。

型:String
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-ResourceGroupName

アラート リソースが存在するリソース グループの名前。

型:String
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-ResourceId

必要な名前、リソース グループ名のプロパティを抽出する呼び出しの ResourceId タグ プロパティを設定します。

型:String
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-Scope

アクティビティ ログ アラートのスコープの一覧。

型:List<T>[String]
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-Tag

アクティビティ ログ アラート リソースの tags プロパティを設定します。

型:Dictionary<TKey,TValue>[System.String,System.String]
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-WhatIf

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

型:SwitchParameter
Aliases:wi
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

入力

String

List<T>[[System.String, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

List<T>[[Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertLeafCondition, Microsoft.Azure.PowerShell.Cmdlets.Monitor, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

List<T>[[Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertActionGroup, Microsoft.Azure.PowerShell.Cmdlets.Monitor, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

Dictionary<TKey,TValue>[[System.String, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e],[System.String, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

PSActivityLogAlertResource

出力

PSActivityLogAlertResource