Edit

Share via


New-AzActionGroupWebhookReceiverObject

Create an in-memory object for WebhookReceiver.

Syntax

Default (Default)

New-AzActionGroupWebhookReceiverObject
    -Name <String>
    -ServiceUri <String>
    [-IdentifierUri <String>]
    [-ObjectId <String>]
    [-TenantId <String>]
    [-UseAadAuth <Boolean>]
    [-UseCommonAlertSchema <Boolean>]
    [<CommonParameters>]

Description

Create an in-memory object for WebhookReceiver.

Examples

Example 1: create action group webhook receiver with aad auth

New-AzActionGroupWebhookReceiverObject -Name "sample webhook" -ServiceUri "http://www.example.com/webhook1" -IdentifierUri "http://someidentifier/d7811ba3-7996-4a93-99b6-6b2f3f355f8a" -ObjectId "d3bb868c-fe44-452c-aa26-769a6538c808" -TenantId 68a4459a-ccb8-493c-b9da-dd30457d1b84 -UseAadAuth $true -UseCommonAlertSchema $true
IdentifierUri        : http://someidentifier/d7811ba3-7996-4a93-99b6-6b2f3f355f8a
Name                 : sample webhook
ObjectId             : d3bb868c-fe44-452c-aa26-769a6538c808
ServiceUri           : http://www.example.com/webhook1
TenantId             : 68a4459a-ccb8-493c-b9da-dd30457d1b84
UseAadAuth           : True
UseCommonAlertSchema : True

This command creates action group webhook receiver object.

Example 2: create minimum action group webhook receiver

New-AzActionGroupWebhookReceiverObject -Name "sample webhook" -ServiceUri "http://www.example.com/webhook2"
IdentifierUri        :
Name                 : sample webhook
ObjectId             :
ServiceUri           : http://www.example.com/webhook2
TenantId             :
UseAadAuth           :
UseCommonAlertSchema :

This command creates action group email receiver object.

Parameters

-IdentifierUri

Indicates the identifier uri for aad auth.

Parameter properties

Type:String
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:False
Value from remaining arguments:False

-Name

The name of the webhook receiver. Names must be unique across all receivers within an action group.

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:False
Value from remaining arguments:False

-ObjectId

Indicates the webhook app object Id for aad auth.

Parameter properties

Type:String
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:False
Value from remaining arguments:False

-ServiceUri

The URI where webhooks should be sent.

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:False
Value from remaining arguments:False

-TenantId

Indicates the tenant id for aad auth.

Parameter properties

Type:String
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:False
Value from remaining arguments:False

-UseAadAuth

Indicates whether or not use AAD authentication.

Parameter properties

Type:Boolean
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:False
Value from remaining arguments:False

-UseCommonAlertSchema

Indicates whether to use common alert schema.

Parameter properties

Type:Boolean
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:False
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

WebhookReceiver