次の方法で共有


Set-AzActivityLogAlert

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

構文

SetByNameAndResourceGroup

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

SetByResourceId

Set-AzActivityLogAlert
    -ResourceId <String>
    [-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]>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetByInputObject

Set-AzActivityLogAlert
    -InputObject <PSActivityLogAlertResource>
    [-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]>]
    [-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]

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

パラメーター セット

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

-Condition

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

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

型:

List<T>[Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertLeafCondition]

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

パラメーター セット

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

-Confirm

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

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

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

パラメーター セット

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

-DefaultProfile

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

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

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

パラメーター セット

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

-Description

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

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

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

パラメーター セット

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

-DisableAlert

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

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

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

パラメーター セット

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

-InputObject

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

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

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

パラメーター セット

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

-Location

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

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

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

パラメーター セット

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

-Name

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

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

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

パラメーター セット

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

-ResourceGroupName

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

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

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

パラメーター セット

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

-ResourceId

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

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

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

パラメーター セット

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

-Scope

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

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

型:

List<T>[String]

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

パラメーター セット

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

-Tag

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

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

型:

Dictionary<TKey,TValue>[System.String,System.String]

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

パラメーター セット

SetByNameAndResourceGroup
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False
SetByResourceId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値: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を参照してください。

入力

String

List<T>

List<T>

List<T>

Dictionary<TKey,TValue>

PSActivityLogAlertResource

出力

PSActivityLogAlertResource