New-AzActionGroupReceiver
Creates an new action group receiver.
Syntax
NewEmailReceiver (Default)
New-AzActionGroupReceiver
-Name <String>
-EmailAddress <String>
[-UseCommonAlertSchema]
[-EmailReceiver]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
NewSmsReceiver
New-AzActionGroupReceiver
-Name <String>
-PhoneNumber <String>
[-UseCommonAlertSchema]
[-SmsReceiver]
[-CountryCode <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
NewWebhookReceiver
New-AzActionGroupReceiver
-Name <String>
-ServiceUri <String>
[-UseCommonAlertSchema]
[-WebhookReceiver]
[-UseAadAuth]
[-ObjectId <String>]
[-IdentifierUri <String>]
[-TenantId <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
NewItsmReceiver
New-AzActionGroupReceiver
-Name <String>
-WorkspaceId <String>
-ConnectionId <String>
-TicketConfiguration <String>
-Region <String>
[-UseCommonAlertSchema]
[-ItsmReceiver]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
NewVoiceReceiver
New-AzActionGroupReceiver
-Name <String>
-VoicePhoneNumber <String>
[-UseCommonAlertSchema]
[-VoiceReceiver]
[-VoiceCountryCode <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
NewArmRoleReceiver
New-AzActionGroupReceiver
-Name <String>
-RoleId <String>
[-UseCommonAlertSchema]
[-ArmRoleReceiver]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
NewAzureFunctionReceiver
New-AzActionGroupReceiver
-Name <String>
-FunctionAppResourceId <String>
-HttpTriggerUrl <String>
-FunctionName <String>
[-UseCommonAlertSchema]
[-AzureFunctionReceiver]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
NewLogicAppReceiver
New-AzActionGroupReceiver
-Name <String>
-ResourceId <String>
-CallbackUrl <String>
[-UseCommonAlertSchema]
[-LogicAppReceiver]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
NewAutomationRunbookReceiver
New-AzActionGroupReceiver
-Name <String>
-AutomationAccountId <String>
-RunbookName <String>
-AutomationRunbookServiceUri <String>
-WebhookResourceId <String>
[-UseCommonAlertSchema]
[-AutomationRunbookReceiver]
[-IsGlobalRunbook]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
NewAzureAppPushReceiver
New-AzActionGroupReceiver
-Name <String>
-AzureAppPushEmailAddress <String>
[-UseCommonAlertSchema]
[-AzureAppPushReceiver]
[-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
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
NewArmRoleReceiver
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-AutomationAccountId
the AutomationAccountId
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
NewAutomationRunbookReceiver
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-AutomationRunbookReceiver
Create a AutomationRunbookReceiver
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
NewAutomationRunbookReceiver
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-AutomationRunbookServiceUri
the URI where webhooks should be sent
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
NewAutomationRunbookReceiver
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-AzureAppPushEmailAddress
the AzureAppPushEmailAddress
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
NewAzureAppPushReceiver
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-AzureAppPushReceiver
Create a AzureAppPushReceiver
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
NewAzureAppPushReceiver
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-AzureFunctionReceiver
Create a ArmRoleReceiver
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
NewAzureFunctionReceiver
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-CallbackUrl
the CallbackUrl
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
NewLogicAppReceiver
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-ConnectionId
the itsm connection id of this receiver
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
NewItsmReceiver
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-CountryCode
Specifies the country code for the SMS receiver.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
NewSmsReceiver
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True 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
-EmailAddress
Specifies the address for the Email receiver.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
NewEmailReceiver
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-EmailReceiver
Specifies to create an Email receiver
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
NewEmailReceiver
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-FunctionAppResourceId
the function app resourceId
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
NewAzureFunctionReceiver
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-FunctionName
the functionName
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
NewAzureFunctionReceiver
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-HttpTriggerUrl
the httpTriggerUrl
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
NewAzureFunctionReceiver
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-IdentifierUri
the Identifier uri for aad auth
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
NewWebhookReceiver
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-IsGlobalRunbook
indicating whether this instance is global runbook
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
NewAutomationRunbookReceiver
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-ItsmReceiver
Create a ItsmReceiver
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
NewItsmReceiver
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-LogicAppReceiver
Create a LogicAppReceiver
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
NewLogicAppReceiver
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-Name
Specifies the name for the receiver.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-ObjectId
the webhook app object Id for aad auth
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
NewWebhookReceiver
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-PhoneNumber
Specifies the phone number for the SMS receiver.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
NewSmsReceiver
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-Region
the itsm Region of this receiver
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
NewItsmReceiver
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-ResourceId
the ResourceId
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
NewLogicAppReceiver
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-RoleId
The arm role id of the receiver
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
NewArmRoleReceiver
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-RunbookName
the RunbookName
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
NewAutomationRunbookReceiver
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-ServiceUri
Specifies the URI for the webhook receiver.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
NewWebhookReceiver
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-SmsReceiver
Specifies to create a SMS receiver
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
NewSmsReceiver
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-TenantId
the tenant id for aad auth
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
NewWebhookReceiver
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-TicketConfiguration
the itsm TicketConfiguration of this receiver
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
NewItsmReceiver
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-UseAadAuth
the flag to use add auth
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
NewWebhookReceiver
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-UseCommonAlertSchema
The flag whether to use common alert schema . This value will be neglectedfor SMS, Azure App push , ITSM and Voice recievers.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-VoiceCountryCode
The country code of the voice receiver
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
NewVoiceReceiver
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-VoicePhoneNumber
The phone number of the voice receiver
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
NewVoiceReceiver
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-VoiceReceiver
Create a voice receiver
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
NewVoiceReceiver
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-WebhookReceiver
Specifies to create a webhook receiver
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
NewWebhookReceiver
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-WebhookResourceId
the WebhookResourceId
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
NewAutomationRunbookReceiver
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-WorkspaceId
the itsm workspace id of this receiver
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
NewItsmReceiver
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True 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