Set-AzActivityLogAlert
新しいアクティビティ ログ アラートを作成するか、既存のアクティビティ ログ アラートを設定します。
構文
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
アクティビティ ログ アラートのアクション グループの一覧。
| Type: | List<T>[ActivityLogAlertActionGroup] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Condition
アクティビティ ログ アラートの条件の一覧。 注: 条件の一覧には、フィールドが "Category" と等しい条件が少なくとも 1 つ必要です。 この条件が存在しない場合、バックエンドは 400 (BadRequest) で応答します。
| Type: | List<T>[Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertLeafCondition] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| 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
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション
| Type: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Description
アラート リソースの説明。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DisableAlert
ユーザーがアクティビティ ログ アラートを無効にして作成できるようにします。 指定しない場合は、アラートが有効に作成されます。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
必要な名前とリソース グループ名のプロパティを抽出する呼び出しの InputObject tags プロパティを設定します。
| Type: | PSActivityLogAlertResource |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Location
アクティビティ ログ アラートが存在する場所。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
アクティビティ ログ アラートの名前。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ResourceGroupName
アラート リソースが存在するリソース グループの名前。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ResourceId
必要な名前、リソース グループ名のプロパティを抽出する呼び出しの ResourceId タグ プロパティを設定します。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Scope
アクティビティ ログ アラートのスコープの一覧。
| Type: | List<T>[String] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Tag
アクティビティ ログ アラート リソースの tags プロパティを設定します。
| Type: | Dictionary<TKey,TValue>[System.String,System.String] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
入力
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]]