Disable-AzActivityLogAlert
Disables an activity log alert and sets its tags.
Syntax
DisableByNameAndResourceGroup
Disable-AzActivityLogAlert
-Name <String>
-ResourceGroupName <String>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Disable-AzActivityLogAlert
-InputObject <PSActivityLogAlertResource>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
DisableByResourceId
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
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.
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
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.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure
Parameter properties
Type: IAzureContextContainer
Default value: None Supports wildcards: False DontShow: False Aliases: AzContext, AzureRmContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Sets the InputObject tags property of the call to extract the required name, resource group name, and the optional tag properties.
DisableByInputObject
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-Name
The name of the activity log alert.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
DisableByNameAndResourceGroup
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-ResourceGroupName
The name of the resource group where the alert resource is going to exist.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
DisableByNameAndResourceGroup
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-ResourceId
Sets the ResourceId tags property of the call to extract the required name, resource group name properties.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
DisableByResourceId
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs