你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

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 cmdlet 创建新的或设置现有活动日志警报。 对于标记、条件和作,必须提前创建对象,并作为参数在此调用中作为逗号分隔传递(请参阅以下示例)。 此 cmdlet 实现 ShouldProcess 模式,即在实际创建/修改资源之前,它可能会请求用户确认。 注意:此 cmdlet 及其相关 cmdlet 取代了已弃用的 (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

前四个命令创建叶条件和作组。 最后一个命令使用条件和作组创建活动日志警报。

示例 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

前四个命令创建叶条件和作组。 最后一个命令使用条件和作组创建活动日志警报,但它创建已禁用的警报。

示例 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
不显示:False

参数集

SetByNameAndResourceGroup
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-Condition

活动日志警报的条件列表。 注意:在条件列表中,必须至少有一个字段等于“Category”。 如果此条件不存在,则后端将响应 400 (BadRequest)。

参数属性

类型:

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

默认值:None
支持通配符:False
不显示:False

参数集

SetByNameAndResourceGroup
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-Confirm

在运行 cmdlet 之前,提示你进行确认。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False
别名:cf

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-DefaultProfile

用于与 azure 通信的凭据、帐户、租户和订阅

参数属性

类型:IAzureContextContainer
默认值:None
支持通配符:False
不显示:False
别名:AzContext, AzureRmContext, AzureCredential

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Description

警报资源的说明。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

SetByNameAndResourceGroup
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False
SetByResourceId
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-DisableAlert

允许用户创建禁用的活动日志警报。 如果未提供警报,则启用警报。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

SetByNameAndResourceGroup
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False
SetByResourceId
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-InputObject

设置调用的 InputObject tags 属性,以提取所需的名称和资源组名称属性。

参数属性

类型:PSActivityLogAlertResource
默认值:None
支持通配符:False
不显示:False

参数集

SetByInputObject
Position:Named
必需:True
来自管道的值:True
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Location

活动日志警报所在的位置。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

SetByNameAndResourceGroup
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-Name

活动日志警报的名称。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

SetByNameAndResourceGroup
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-ResourceGroupName

警报资源所在的资源组的名称。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

SetByNameAndResourceGroup
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-ResourceId

设置调用的 ResourceId tags 属性,以提取所需的名称、资源组名称属性。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

SetByResourceId
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-Scope

活动日志警报的范围列表。

参数属性

类型:

List<T>[String]

默认值:None
支持通配符:False
不显示:False

参数集

SetByNameAndResourceGroup
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-Tag

设置活动日志警报资源的 tags 属性。

参数属性

类型:

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

默认值:None
支持通配符:False
不显示:False

参数集

SetByNameAndResourceGroup
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False
SetByResourceId
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-WhatIf

显示 cmdlet 运行时会发生什么情况。 命令脚本未运行。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False
别名:无线

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

CommonParameters

此 cmdlet 支持通用参数:-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