Set-AzActivityLogAlert

  • Référence
Module:
Az.Monitor

Crée une alerte de journal d’activité existante ou définit une alerte de journal d’activité existante.

Syntax

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

Description

L’applet de commande Set-AzActivityLogAlert crée une alerte de journal d’activité existante ou définit une alerte de journal d’activité existante. Pour les balises, les conditions et les actions que les objets doivent être créés à l’avance et transmis en tant que paramètres dans cet appel en tant que virgule séparée (voir l’exemple ci-dessous). Cette applet de commande implémente le modèle ShouldProcess, c’est-à-dire qu’il peut demander la confirmation de l’utilisateur avant de créer/modifier la ressource. REMARQUE : cette applet de commande et ses éléments connexes remplacent le add-AzLogAlertRule déconseillé (novembre 2017).

Exemples

Exemple 1 : Créer une alerte de journal d’activité

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

Les quatre premières commandes créent une condition feuille et un groupe d’actions. La commande finale crée une alerte de journal d’activité à l’aide de la condition et du groupe d’actions.

Exemple 2 : Créer une alerte de journal d’activité désactivée

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

Les quatre premières commandes créent une condition feuille et un groupe d’actions. La commande finale crée une alerte de journal d’activité à l’aide de la condition et du groupe d’actions, mais elle crée l’alerte désactivée.

Exemple 3 : Définir une alerte de journal d’activité basée sur une valeur à partir du canal ou du paramètre 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

La première commande est similaire à un nop, elle définit l’alerte avec les mêmes valeurs qu’elle contenait déjà Le reste des commandes récupère la règle d’alerte, modifiez la description et désactivez-la, puis utilisez le paramètre InputObject pour conserver ces modifications.

Exemple 4 : Définir une alerte de journal d’activité basée sur la valeur ResourceId à partir du canal

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

Si la règle d’alerte de journal donnée existe, cette commande la désactive.

Paramètres

-Action

Liste des groupes d’actions pour l’alerte du journal d’activité.

Type:List<T>[ActivityLogAlertActionGroup]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Condition

Liste des conditions de l’alerte de journal d’activité. REMARQUE : Dans la liste des conditions, il doit y avoir au moins un champ égal à « Catégorie ». Le serveur principal répond avec 400 (BadRequest) si cette condition n’est pas présente.

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

Vous demande une confirmation avant d’exécuter l’applet de commande.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

Description de la ressource d’alerte.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-DisableAlert

Permet à l’utilisateur de créer une alerte de journal d’activité désactivée. Si ce n’est pas le cas, les alertes sont créées.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Définit la propriété de balises InputObject de l’appel pour extraire le nom requis et les propriétés de nom du groupe de ressources.

Type:PSActivityLogAlertResource
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Location

Emplacement où l’alerte de journal d’activité existe.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

Nom de l’alerte du journal d’activité.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceGroupName

Nom du groupe de ressources où la ressource d’alerte va exister.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceId

Définit la propriété des balises ResourceId de l’appel pour extraire le nom requis, les propriétés du nom du groupe de ressources.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Scope

Liste des étendues de l’alerte de journal d’activité.

Type:List<T>[String]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Tag

Définit la propriété balises de la ressource d’alerte du journal d’activité.

Type:Dictionary<TKey,TValue>[System.String,System.String]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Montre ce qui se passe en cas d’exécution de l’applet de commande. L’applet de commande n’est pas exécutée.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Entrées

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

Sorties

PSActivityLogAlertResource