WebHookEventSubscriptionDestinationProperties interface

Package:

@azure/arm-eventgrid

Information about the webhook destination properties for an event subscription.

Properties

azureActiveDirectoryApplicationIdOrUri	The Microsoft Entra ID Application ID or URI to get the access token that will be included as the bearer token in delivery requests.
azureActiveDirectoryTenantId	The Microsoft Entra ID Tenant ID to get the access token that will be included as the bearer token in delivery requests.
deliveryAttributeMappings	Delivery attribute details.
endpointBaseUrl	The base URL that represents the endpoint of the destination of an event subscription.
endpointUrl	The URL that represents the endpoint of the destination of an event subscription.
maxEventsPerBatch	Maximum number of events per batch.
minimumTlsVersionAllowed	Minimum TLS version that should be supported by webhook endpoint
preferredBatchSizeInKilobytes	Preferred batch size in Kilobytes.

Property Details

azureActiveDirectoryApplicationIdOrUri

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

azureActiveDirectoryApplicationIdOrUri?: string

Property Value

string

azureActiveDirectoryTenantId

The Microsoft Entra ID Tenant ID to get the access token that will be included as the bearer token in delivery requests.

azureActiveDirectoryTenantId?: string

Property Value

string

deliveryAttributeMappings

Delivery attribute details.

deliveryAttributeMappings?: DeliveryAttributeMappingUnion[]

Property Value

DeliveryAttributeMappingUnion[]

endpointBaseUrl

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

endpointBaseUrl?: string

Property Value

string

endpointUrl

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

endpointUrl?: string

Property Value

string

maxEventsPerBatch

Maximum number of events per batch.

maxEventsPerBatch?: number

Property Value

number

minimumTlsVersionAllowed

Minimum TLS version that should be supported by webhook endpoint

minimumTlsVersionAllowed?: string

Property Value

string

preferredBatchSizeInKilobytes

Preferred batch size in Kilobytes.

preferredBatchSizeInKilobytes?: number

Property Value

number