New-AzActionGroupReceiver

Reference

Module:: Az.Monitor

Creates an new action group receiver.

Syntax

New-AzActionGroupReceiver
   -Name <String>
   [-UseCommonAlertSchema]
   [-EmailReceiver]
   -EmailAddress <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

New-AzActionGroupReceiver
   -Name <String>
   [-UseCommonAlertSchema]
   [-SmsReceiver]
   [-CountryCode <String>]
   -PhoneNumber <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

New-AzActionGroupReceiver
   -Name <String>
   [-UseCommonAlertSchema]
   [-WebhookReceiver]
   -ServiceUri <String>
   [-UseAadAuth]
   [-ObjectId <String>]
   [-IdentifierUri <String>]
   [-TenantId <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

New-AzActionGroupReceiver
   -Name <String>
   [-UseCommonAlertSchema]
   [-ItsmReceiver]
   -WorkspaceId <String>
   -ConnectionId <String>
   -TicketConfiguration <String>
   -Region <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

New-AzActionGroupReceiver
   -Name <String>
   [-UseCommonAlertSchema]
   [-VoiceReceiver]
   [-VoiceCountryCode <String>]
   -VoicePhoneNumber <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

New-AzActionGroupReceiver
   -Name <String>
   [-UseCommonAlertSchema]
   [-ArmRoleReceiver]
   -RoleId <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

New-AzActionGroupReceiver
   -Name <String>
   [-UseCommonAlertSchema]
   [-AzureFunctionReceiver]
   -FunctionAppResourceId <String>
   -HttpTriggerUrl <String>
   -FunctionName <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

New-AzActionGroupReceiver
   -Name <String>
   [-UseCommonAlertSchema]
   [-LogicAppReceiver]
   -ResourceId <String>
   -CallbackUrl <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

New-AzActionGroupReceiver
   -Name <String>
   [-UseCommonAlertSchema]
   [-AutomationRunbookReceiver]
   -AutomationAccountId <String>
   -RunbookName <String>
   [-IsGlobalRunbook]
   -AutomationRunbookServiceUri <String>
   -WebhookResourceId <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

New-AzActionGroupReceiver
   -Name <String>
   [-UseCommonAlertSchema]
   [-AzureAppPushReceiver]
   -AzureAppPushEmailAddress <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The New-AzActionGroupReceiver cmdlet creates new action group receiver in memory.

Examples

Example 1: Create a new Email receiver in memory.

PS C:\>$emailReceiver = New-AzActionGroupReceiver -Name 'emailReceiver1' -EmailReceiver -EmailAddress 'user1@example.com'

This command creates a new Email receiver in memory.

Example 2: Create a new SMS receiver in memory.

PS C:\>$smsReceiver = New-AzActionGroupReceiver -Name 'smsReceiver1' -SmsReceiver -CountryCode '1' -PhoneNumber '5555555555'

This command creates a new SMS receiver in memory.

Example 3: Create a new webhook receiver in memory.

PS C:\>$webhookReceiver = New-AzActionGroupReceiver -Name 'webhookReceiver1' -WebhookReceiver -ServiceUri 'http://test.com'

This command creates a new webhook receiver in memory.

Parameters

-ArmRoleReceiver

Create a ArmRoleReceiver

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

-AutomationAccountId

the AutomationAccountId

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

-AutomationRunbookReceiver

Create a AutomationRunbookReceiver

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

-AutomationRunbookServiceUri

the URI where webhooks should be sent

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

-AzureAppPushEmailAddress

the AzureAppPushEmailAddress

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

-AzureAppPushReceiver

Create a AzureAppPushReceiver

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

-AzureFunctionReceiver

Create a ArmRoleReceiver

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

-CallbackUrl

the CallbackUrl

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

-ConnectionId

the itsm connection id of this receiver

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

-CountryCode

Specifies the country code for the SMS receiver.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
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

-EmailAddress

Specifies the address for the Email receiver.

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

-EmailReceiver

Specifies to create an Email receiver

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

-FunctionAppResourceId

the function app resourceId

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

-FunctionName

the functionName

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

-HttpTriggerUrl

the httpTriggerUrl

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

-IdentifierUri

the Identifier uri for aad auth

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

-IsGlobalRunbook

indicating whether this instance is global runbook

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

-ItsmReceiver

Create a ItsmReceiver

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

-LogicAppReceiver

Create a LogicAppReceiver

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

-Name

Specifies the name for the receiver.

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

-ObjectId

the webhook app object Id for aad auth

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

-PhoneNumber

Specifies the phone number for the SMS receiver.

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

-Region

the itsm Region of this receiver

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

-ResourceId

the ResourceId

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

-RoleId

The arm role id of the receiver

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

-RunbookName

the RunbookName

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

-ServiceUri

Specifies the URI for the webhook receiver.

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

-SmsReceiver

Specifies to create a SMS receiver

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

-TenantId

the tenant id for aad auth

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

-TicketConfiguration

the itsm TicketConfiguration of this receiver

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

-UseAadAuth

the flag to use add auth

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

-UseCommonAlertSchema

The flag whether to use common alert schema . This value will be neglectedfor SMS, Azure App push , ITSM and Voice recievers.

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

-VoiceCountryCode

The country code of the voice receiver

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

-VoicePhoneNumber

The phone number of the voice receiver

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

-VoiceReceiver

Create a voice receiver

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

-WebhookReceiver

Specifies to create a webhook receiver

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

-WebhookResourceId

the WebhookResourceId

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

-WorkspaceId

the itsm workspace id of this receiver

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

Inputs

String

SwitchParameter

Outputs

PSActionGroupReceiverBase

Share via