WebHookEventSubscriptionDestination Class

Information about the webhook destination for an event subscription.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Inheritance
azure.mgmt.eventgrid.models._models_py3.EventSubscriptionDestination
WebHookEventSubscriptionDestination

Constructor

WebHookEventSubscriptionDestination(*, endpoint_url: str | None = None, max_events_per_batch: int = 1, preferred_batch_size_in_kilobytes: int = 64, azure_active_directory_tenant_id: str | None = None, azure_active_directory_application_id_or_uri: str | None = None, delivery_attribute_mappings: List[_models.DeliveryAttributeMapping] | None = None, minimum_tls_version_allowed: str | _models.TlsVersion | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
endpoint_url
str

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

max_events_per_batch
int

Maximum number of events per batch.

Default value: 1
preferred_batch_size_in_kilobytes
int

Preferred batch size in Kilobytes.

Default value: 64
azure_active_directory_tenant_id
str

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

azure_active_directory_application_id_or_uri
str

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

delivery_attribute_mappings

Delivery attribute details.

minimum_tls_version_allowed

Minimum TLS version that should be supported by webhook endpoint. Known values are: "1.0", "1.1", and "1.2".

Variables

Name Description
endpoint_type

Type of the endpoint for the event subscription destination. Required. Known values are: "WebHook", "EventHub", "StorageQueue", "HybridConnection", "ServiceBusQueue", "ServiceBusTopic", "AzureFunction", "PartnerDestination", "MonitorAlert", and "NamespaceTopic".

endpoint_url
str

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

endpoint_base_url
str

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

max_events_per_batch
int

Maximum number of events per batch.

preferred_batch_size_in_kilobytes
int

Preferred batch size in Kilobytes.

azure_active_directory_tenant_id
str

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

azure_active_directory_application_id_or_uri
str

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

delivery_attribute_mappings

Delivery attribute details.

minimum_tls_version_allowed

Minimum TLS version that should be supported by webhook endpoint. Known values are: "1.0", "1.1", and "1.2".