Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

Get-AzActionGroup

Get an action group.

Syntax

List (Default) 

Get-AzActionGroup
 [-SubscriptionId <String[]>]
 [-DefaultProfile <PSObject>]
 [<CommonParameters>]

Get 

Get-AzActionGroup
 -Name <String>
 -ResourceGroupName <String>
 [-SubscriptionId <String[]>]
 [-DefaultProfile <PSObject>]
 [<CommonParameters>]

List1 

Get-AzActionGroup
 -ResourceGroupName <String>
 [-SubscriptionId <String[]>]
 [-DefaultProfile <PSObject>]
 [<CommonParameters>]

GetViaIdentity 

Get-AzActionGroup
 -InputObject <IActionGroupIdentity>
 [-DefaultProfile <PSObject>]
 [<CommonParameters>]

Description

Get an action group.

Examples

Example 1: Get action groups by subscription ID

Get-AzActionGroup -SubscriptionId '{subid}'

Location Name ResourceGroupName
-------- ---- -----------------
northcentralus actiongroup1 Monitor-Action
northcentralus actiongroup2 Monitor-Action

This command gets list of action groups by specified subscription.

Example 2: Get specific action groups with specified resource group

Get-AzActionGroup -Name actiongroup1 -ResourceGroupName monitor-action

ArmRoleReceiver : {}
AutomationRunbookReceiver : {}
AzureAppPushReceiver : {}
AzureFunctionReceiver : {}
EmailReceiver : {}
Enabled : False
EventHubReceiver : {}
GroupShortName : ag1
Id : /subscriptions/{subid}/resourceGroups/Monitor-Action/providers/microsoft.insights/actionGroups/actiongroup1
ItsmReceiver : {}
Location : northcentralus
LogicAppReceiver : {}
Name : actiongroup1
ResourceGroupName : Monitor-Action
SmsReceiver : {}
Tag : {
 }
Type : Microsoft.Insights/ActionGroups
VoiceReceiver : {}
WebhookReceiver : {}

This command gets specific action group with specified resource group.

Parameters

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Parameter properties

Type:PSObject
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzureRMContext, AzureCredential

Parameter sets

-InputObject

Identity Parameter

Parameter properties

Type:IActionGroupIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-Name

The name of the action group.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:ActionGroupName

Parameter sets

-ResourceGroupName

The name of the resource group. The name is case insensitive.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-SubscriptionId

The ID of the target subscription.

Parameter properties

Type:

String[]

Default value:(Get-AzContext).Subscription.Id
Supports wildcards:False
DontShow:False

Parameter sets

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.

Inputs

IActionGroupIdentity

Outputs

IActionGroupResource

Feedback

Was this page helpful?