WebHookEventSubscriptionDestination interface

Package:

@azure/arm-eventgrid

Information about the webhook destination for an event subscription.

Extends

EventSubscriptionDestination

Properties

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.
azureActiveDirectoryTenantId	The Azure Active Directory 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. NOTE: This property will not be serialized. It can only be populated by the server.
endpointType	Polymorphic discriminator, which specifies the different types this object can be
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 Azure Active Directory 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 Azure Active Directory 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. NOTE: This property will not be serialized. It can only be populated by the server.

endpointBaseUrl?: string

Property Value

string

endpointType

Polymorphic discriminator, which specifies the different types this object can be

endpointType: "WebHook"

Property Value

"WebHook"

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