New-AzEventGridWebHookEventSubscriptionDestinationObject

Module:

Az.EventGrid Module

Create an in-memory object for WebHookEventSubscriptionDestination.

Syntax

Default (Default)

New-AzEventGridWebHookEventSubscriptionDestinationObject
    [-AzureActiveDirectoryApplicationIdOrUri <String>]
    [-AzureActiveDirectoryTenantId <String>]
    [-DeliveryAttributeMapping <IDeliveryAttributeMapping[]>]
    [-EndpointUrl <String>]
    [-MaxEventsPerBatch <Int32>]
    [-MinimumTlsVersionAllowed <String>]
    [-PreferredBatchSizeInKilobyte <Int32>]
    [<CommonParameters>]

Description

Create an in-memory object for WebHookEventSubscriptionDestination.

Examples

Example 1: Create an in-memory object for WebHookEventSubscriptionDestination.

New-AzEventGridWebHookEventSubscriptionDestinationObject -EndpointUrl "https://azpsweb.azurewebsites.net/api/updates"

EndpointType
------------
WebHook

Create an in-memory object for WebHookEventSubscriptionDestination. A usable EndpointUrl can be created from this link: https://learn.microsoft.com/en-us/azure/event-grid/custom-event-quickstart-powershell

Parameters

-AzureActiveDirectoryApplicationIdOrUri

The Azure Active Directory Application ID or URI to get the access token that will be included as the bearer token in delivery requests.

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

-AzureActiveDirectoryTenantId

The Azure Active Directory Tenant ID to get the access token that will be included as the bearer token in delivery requests.

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

-DeliveryAttributeMapping

Delivery attribute details.

Parameter properties

Type:	IDeliveryAttributeMapping[]
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

-EndpointUrl

The URL that represents the endpoint of the destination of an event subscription.

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

-MaxEventsPerBatch

Maximum number of events per batch.

Parameter properties

Type:	Int32
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

-MinimumTlsVersionAllowed

Minimum TLS version that should be supported by webhook endpoint.

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

-PreferredBatchSizeInKilobyte

Preferred batch size in Kilobytes.

Parameter properties

Type:	Int32
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

WebHookEventSubscriptionDestination