Edit

Share via

Disable-AzActivityLogAlert

  • Reference
Module:
Az.Monitor

Disables an activity log alert and sets its tags.

Syntax

PowerShell 
Disable-AzActivityLogAlert
       -Name <String>
       -ResourceGroupName <String>
       [-DefaultProfile <IAzureContextContainer>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
PowerShell 
Disable-AzActivityLogAlert
       -InputObject <PSActivityLogAlertResource>
       [-DefaultProfile <IAzureContextContainer>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
PowerShell 
Disable-AzActivityLogAlert
       -ResourceId <String>
       [-DefaultProfile <IAzureContextContainer>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Description

The Disable-AzActivityLogAlert cmdlet disables and activity log alert and allows setting its tags. This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually patching the resource.

Examples

Example 1: Disable an activity log alert

PowerShell 
PS C:\>Disable-AzActivityLogAlert -Name "alert1" -ResourceGroupName "Default-ActivityLogsAlerts"

This command disables the activity log alert called alert1 in the resource group Default-ActivityLogsAlerts. This command changes the tags property of the activity log alert called alert1 and disables it.

Example 2: Disable an activity log alert using a PSActivityLogAlertResource object as input

PowerShell 
PS C:\>$obj = Get-AzActivityLogAlert -ResourceGroup "Default-activityLogAlerts" -Name "alert1"
PS C:\>Disable-AzActivityLogAlert -InputObject $obj

This command disables an activity log alert called alert1. For this it uses a PSActivityLogAlertResource object as input argument.

Example 3: Disable the ActivityLogAlert using the ResourceId parameter

PowerShell 
PS C:\>Get-AzResource -ResourceGroupName "myResourceGroup" -Name "myLogAlert" | Disable-AzActivityLogAlert

This command disables the ActivityLogAlert using the ResourceId parameter from the pipe.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure

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

-InputObject

Sets the InputObject tags property of the call to extract the required name, resource group name, and the optional tag properties.

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

-Name

The name of the activity log alert.

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

-ResourceGroupName

The name of the resource group where the alert resource is going to exist.

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

-ResourceId

Sets the ResourceId tags property of the call to extract the required name, resource group name properties.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

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

Inputs

Outputs