Edit

Share via

Enable-AzureRmActivityLogAlert

  • Reference
Module:
AzureRM.Insights

Enables an activity log alert and sets its Tags.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

Enable-AzureRmActivityLogAlert
      -Name <String>
      -ResourceGroupName <String>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Enable-AzureRmActivityLogAlert
      -InputObject <PSActivityLogAlertResource>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Enable-AzureRmActivityLogAlert
      -ResourceId <String>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Enable-AzureRmActivityLogAlert cmdlet allows enabling an activity log alert and 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:\>Enable-AzureRmActivityLogAlert -Name "alert1" -ResourceGroupName "Default-ActivityLogsAlerts"

This command enables the activity log alert called alert1 in the resource group Default-ActivityLogsAlerts.

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

PS C:\>$obj = Get-AzureRmActivityLogAlert -ResourceGroup "Default-activityLogAlerts" -Name "alert1"
PS C:\>Enable-AzureRmActivityLogAlert -InputObject $obj

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

Example 3: Enable the ActivityLogAlert using the ResourceId parameter

PS C:\>Find-AzureRmResource -ResourceGroupEquals "myResourceGroup" -ResourceNameEquals "myLogAlert" | Enable-AzureRmActivityLogAlert

This command enables 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: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 tags 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

String

PSActivityLogAlertResource

Parameters: InputObject (ByValue)

Outputs

PSActivityLogAlertResource