Set-AzureRmActionGroup

NAME Set-AzureRmActionGroup



SYNOPSIS

Creates a new or updates an existing action group.





SYNTAX

Set-AzureRmActionGroup [-DefaultProfile <IAzureContextContainer>] [-DisableGroup] -Name <String> -Receiver

<System.Collections.Generic.List`1[Microsoft.Azure.Commands.Insights.OutputClasses.PSActionGroupReceiverBase]> -ResourceGroupName <String>

-ShortName <String> [-Tag <System.Collections.Generic.IDictionary`2[System.String,System.String]>] [-Confirm] [-WhatIf] [<CommonParameters>]



Set-AzureRmActionGroup [-DefaultProfile <IAzureContextContainer>] [-DisableGroup] -Receiver

<System.Collections.Generic.List`1[Microsoft.Azure.Commands.Insights.OutputClasses.PSActionGroupReceiverBase]> -ResourceId <String> -ShortName

<String> [-Tag <System.Collections.Generic.IDictionary`2[System.String,System.String]>] [-Confirm] [-WhatIf] [<CommonParameters>]



Set-AzureRmActionGroup [-DefaultProfile <IAzureContextContainer>] [-DisableGroup] -InputObject <PSActionGroupResource> [-ShortName <String>] [-Tag

<System.Collections.Generic.IDictionary`2[System.String,System.String]>] [-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

The Set-AzureRmActionGroup cmdlet creates a new or updates an existing action group





PARAMETERS

-DefaultProfile <IAzureContextContainer>

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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-DisableGroup [<SwitchParameter>]

Disables the action group.



Required? false

Position? named

Default value False

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-InputObject <PSActionGroupResource>

The action group resourc



Required? true

Position? named

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-Name <String>

The name of the action group.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Receiver <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Insights.OutputClasses.PSActionGroupReceiverBase]>

The list of receivers of the action group.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ResourceGroupName <String>

The resource group nam



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ResourceId <String>

The resource i



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ShortName <String>

The short name of the action group.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Tag <System.Collections.Generic.IDictionary`2[System.String,System.String]>

The tags of the action group resourc



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

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



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

None

This cmdlet does not accept any input.





OUTPUTS

Microsoft.Azure.Commands.Insights.OutputClasses.PSActionGroupResource







NOTES









Example 1: Create an Action Group



PS C:\\>$email1 = New-AzureRmActionGroupReceiver -Name 'user1' -EmailReceiver -EmailAddress 'user1@example.com'

PS C:\\>$sms1 = New-AzureRmActionGroupReceiver -Name 'user2' -SmsReceiver -CountryCode '1' -PhoneNumber '5555555555'

PS C:\\>Set-AzureRmActionGroup -Name $actionGroupName -ResourceGroup $resourceGroupName -ShortName $shortName -Receiver $email1,$sms1



The first two commands create two receivers. The final command creates an Action Group including the two receivers.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... ctiongroup

Get-AzureRmActionGroup

Remove-AzureRmActionGroup

New-AzureRmActionGroupReceiver