Поделиться через


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 г.) 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]

Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

SetByNameAndResourceGroup
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False

-Condition

Список условий для оповещения журнала действий. ПРИМЕЧАНИЕ. В списке условий должно быть по крайней мере одно с полем, равным "Категория". Серверная часть отвечает с 400 (BadRequest), если это условие отсутствует.

Свойства параметра

Тип:

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

Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

SetByNameAndResourceGroup
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False

-Confirm

Запрашивает подтверждение перед запуском cmdlet.

Свойства параметра

Тип:SwitchParameter
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False
Aliases:cf

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-DefaultProfile

Учетные данные, учетная запись, клиент и подписка, используемые для обмена данными с Azure

Свойства параметра

Тип:IAzureContextContainer
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Description

Описание ресурса оповещения.

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

SetByNameAndResourceGroup
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False
SetByResourceId
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False

-DisableAlert

Позволяет пользователю создать оповещение журнала действий отключено. Если это не задано, создаются оповещения.

Свойства параметра

Тип:SwitchParameter
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

SetByNameAndResourceGroup
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False
SetByResourceId
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-InputObject

Задает свойство InputObject tags вызова для извлечения требуемого имени, а также свойства имени группы ресурсов.

Свойства параметра

Тип:PSActivityLogAlertResource
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

SetByInputObject
Position:Named
Обязательно:True
Значение из конвейера:True
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Location

Расположение, в котором будет существовать оповещение журнала действий.

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

SetByNameAndResourceGroup
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False

-Name

Имя оповещения журнала действий.

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

SetByNameAndResourceGroup
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False

-ResourceGroupName

Имя группы ресурсов, в которой будет существовать ресурс генерации оповещений.

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

SetByNameAndResourceGroup
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False

-ResourceId

Задает свойство ResourceId tags вызова для извлечения необходимого имени, свойств имени группы ресурсов.

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

SetByResourceId
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False

-Scope

Список областей для оповещения журнала действий.

Свойства параметра

Тип:

List<T>[String]

Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

SetByNameAndResourceGroup
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False

-Tag

Задает свойство тегов ресурса оповещения журнала действий.

Свойства параметра

Тип:

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

Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

SetByNameAndResourceGroup
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False
SetByResourceId
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False

-WhatIf

Показывает, что произойдет, если командлет будет запущен. Командлет не запускается.

Свойства параметра

Тип:SwitchParameter
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False
Aliases:wi

Наборы параметров

(All)
Position: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