EventSubscriptionsOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:event_subscriptions> attribute.
Constructor
EventSubscriptionsOperations(*args, **kwargs)Methods
| begin_create_or_update |
Create or update an event subscription. Asynchronously creates a new event subscription or updates an existing event subscription based on the specified scope. |
| begin_delete |
Delete an event subscription. Delete an existing event subscription. |
| begin_update |
Update an event subscription. Asynchronously updates an existing event subscription. |
| get |
Get an event subscription. Get properties of an event subscription. |
| get_delivery_attributes |
Get delivery attributes for an event subscription. Get all delivery attributes for an event subscription. |
| get_full_url |
Get full URL of an event subscription. Get the full endpoint URL for an event subscription. |
| list_by_domain_topic |
List all event subscriptions for a specific domain topic. List all event subscriptions that have been created for a specific domain topic. |
| list_by_resource |
List all event subscriptions. List all event subscriptions that have been created for a specific resource. |
| list_global_by_resource_group |
List all global event subscriptions under an Azure subscription and resource group. List all global event subscriptions under a specific Azure subscription and resource group. |
| list_global_by_resource_group_for_topic_type |
List all global event subscriptions under a resource group for a topic type. List all global event subscriptions under a resource group for a specific topic type. |
| list_global_by_subscription |
Get an aggregated list of all global event subscriptions under an Azure subscription. List all aggregated global event subscriptions under a specific Azure subscription. |
| list_global_by_subscription_for_topic_type |
List all global event subscriptions for a topic type. List all global event subscriptions under an Azure subscription for a topic type. |
| list_regional_by_resource_group |
List all regional event subscriptions under an Azure subscription and resource group. List all event subscriptions from the given location under a specific Azure subscription and resource group. |
| list_regional_by_resource_group_for_topic_type |
List all regional event subscriptions under an Azure subscription and resource group for a topic type. List all event subscriptions from the given location under a specific Azure subscription and resource group and topic type. |
| list_regional_by_subscription |
List all regional event subscriptions under an Azure subscription. List all event subscriptions from the given location under a specific Azure subscription. |
| list_regional_by_subscription_for_topic_type |
List all regional event subscriptions under an Azure subscription for a topic type. List all event subscriptions from the given location under a specific Azure subscription and topic type. |
begin_create_or_update
Create or update an event subscription.
Asynchronously creates a new event subscription or updates an existing event subscription based on the specified scope.
begin_create_or_update(scope: str, event_subscription_name: str, event_subscription_info: _models.EventSubscription, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.EventSubscription]Parameters
| Name | Description |
|---|---|
|
scope
Required
|
The identifier of the resource to which the event subscription needs to be created or updated. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic. Required. |
|
event_subscription_name
Required
|
Name of the event subscription to be created. Event subscription names must be between 3 and 64 characters in length and should use alphanumeric letters only. Required. |
|
event_subscription_info
Required
|
Event subscription properties containing the destination and filter information. Is either a EventSubscription type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either EventSubscription or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_delete
Delete an event subscription.
Delete an existing event subscription.
begin_delete(scope: str, event_subscription_name: str, **kwargs: Any) -> LROPoller[None]Parameters
| Name | Description |
|---|---|
|
scope
Required
|
The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic. Required. |
|
event_subscription_name
Required
|
Name of the event subscription to be deleted. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_update
Update an event subscription.
Asynchronously updates an existing event subscription.
begin_update(scope: str, event_subscription_name: str, event_subscription_update_parameters: _models.EventSubscriptionUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.EventSubscription]Parameters
| Name | Description |
|---|---|
|
scope
Required
|
The scope of existing event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic. Required. |
|
event_subscription_name
Required
|
Name of the event subscription to be updated. Required. |
|
event_subscription_update_parameters
Required
|
Updated event subscription information. Is either a EventSubscriptionUpdateParameters type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either EventSubscription or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get
Get an event subscription.
Get properties of an event subscription.
get(scope: str, event_subscription_name: str, **kwargs: Any) -> EventSubscriptionParameters
| Name | Description |
|---|---|
|
scope
Required
|
The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic. Required. |
|
event_subscription_name
Required
|
Name of the event subscription to be found. Required. |
Returns
| Type | Description |
|---|---|
|
EventSubscription or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get_delivery_attributes
Get delivery attributes for an event subscription.
Get all delivery attributes for an event subscription.
get_delivery_attributes(scope: str, event_subscription_name: str, **kwargs: Any) -> DeliveryAttributeListResultParameters
| Name | Description |
|---|---|
|
scope
Required
|
The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic. Required. |
|
event_subscription_name
Required
|
Name of the event subscription. Required. |
Returns
| Type | Description |
|---|---|
|
DeliveryAttributeListResult or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get_full_url
Get full URL of an event subscription.
Get the full endpoint URL for an event subscription.
get_full_url(scope: str, event_subscription_name: str, **kwargs: Any) -> EventSubscriptionFullUrlParameters
| Name | Description |
|---|---|
|
scope
Required
|
The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic. Required. |
|
event_subscription_name
Required
|
Name of the event subscription. Required. |
Returns
| Type | Description |
|---|---|
|
EventSubscriptionFullUrl or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_by_domain_topic
List all event subscriptions for a specific domain topic.
List all event subscriptions that have been created for a specific domain topic.
list_by_domain_topic(resource_group_name: str, domain_name: str, topic_name: str, filter: str | None = None, top: int | None = None, **kwargs: Any) -> ItemPaged[EventSubscription]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group within the user's subscription. Required. |
|
domain_name
Required
|
Name of the top level domain. Required. |
|
topic_name
Required
|
Name of the domain topic. Required. |
|
filter
|
The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. Default value is None. Default value: None
|
|
top
|
The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. Default value is None. Default value: None
|
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either EventSubscription or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_by_resource
List all event subscriptions.
List all event subscriptions that have been created for a specific resource.
list_by_resource(resource_group_name: str, provider_namespace: str, resource_type_name: str, resource_name: str, filter: str | None = None, top: int | None = None, **kwargs: Any) -> ItemPaged[EventSubscription]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group within the user's subscription. Required. |
|
provider_namespace
Required
|
Namespace of the provider of the topic. Required. |
|
resource_type_name
Required
|
Name of the resource type. Required. |
|
resource_name
Required
|
Name of the resource. Required. |
|
filter
|
The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. Default value is None. Default value: None
|
|
top
|
The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. Default value is None. Default value: None
|
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either EventSubscription or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_global_by_resource_group
List all global event subscriptions under an Azure subscription and resource group.
List all global event subscriptions under a specific Azure subscription and resource group.
list_global_by_resource_group(resource_group_name: str, filter: str | None = None, top: int | None = None, **kwargs: Any) -> ItemPaged[EventSubscription]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group within the user's subscription. Required. |
|
filter
|
The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. Default value is None. Default value: None
|
|
top
|
The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. Default value is None. Default value: None
|
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either EventSubscription or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_global_by_resource_group_for_topic_type
List all global event subscriptions under a resource group for a topic type.
List all global event subscriptions under a resource group for a specific topic type.
list_global_by_resource_group_for_topic_type(resource_group_name: str, topic_type_name: str, filter: str | None = None, top: int | None = None, **kwargs: Any) -> ItemPaged[EventSubscription]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group within the user's subscription. Required. |
|
topic_type_name
Required
|
Name of the topic type. Required. |
|
filter
|
The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. Default value is None. Default value: None
|
|
top
|
The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. Default value is None. Default value: None
|
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either EventSubscription or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_global_by_subscription
Get an aggregated list of all global event subscriptions under an Azure subscription.
List all aggregated global event subscriptions under a specific Azure subscription.
list_global_by_subscription(filter: str | None = None, top: int | None = None, **kwargs: Any) -> ItemPaged[EventSubscription]Parameters
| Name | Description |
|---|---|
|
filter
|
The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. Default value is None. Default value: None
|
|
top
|
The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. Default value is None. Default value: None
|
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either EventSubscription or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_global_by_subscription_for_topic_type
List all global event subscriptions for a topic type.
List all global event subscriptions under an Azure subscription for a topic type.
list_global_by_subscription_for_topic_type(topic_type_name: str, filter: str | None = None, top: int | None = None, **kwargs: Any) -> ItemPaged[EventSubscription]Parameters
| Name | Description |
|---|---|
|
topic_type_name
Required
|
Name of the topic type. Required. |
|
filter
|
The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. Default value is None. Default value: None
|
|
top
|
The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. Default value is None. Default value: None
|
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either EventSubscription or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_regional_by_resource_group
List all regional event subscriptions under an Azure subscription and resource group.
List all event subscriptions from the given location under a specific Azure subscription and resource group.
list_regional_by_resource_group(resource_group_name: str, location: str, filter: str | None = None, top: int | None = None, **kwargs: Any) -> ItemPaged[EventSubscription]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group within the user's subscription. Required. |
|
location
Required
|
Name of the location. Required. |
|
filter
|
The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. Default value is None. Default value: None
|
|
top
|
The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. Default value is None. Default value: None
|
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either EventSubscription or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_regional_by_resource_group_for_topic_type
List all regional event subscriptions under an Azure subscription and resource group for a topic type.
List all event subscriptions from the given location under a specific Azure subscription and resource group and topic type.
list_regional_by_resource_group_for_topic_type(resource_group_name: str, location: str, topic_type_name: str, filter: str | None = None, top: int | None = None, **kwargs: Any) -> ItemPaged[EventSubscription]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group within the user's subscription. Required. |
|
location
Required
|
Name of the location. Required. |
|
topic_type_name
Required
|
Name of the topic type. Required. |
|
filter
|
The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. Default value is None. Default value: None
|
|
top
|
The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. Default value is None. Default value: None
|
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either EventSubscription or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_regional_by_subscription
List all regional event subscriptions under an Azure subscription.
List all event subscriptions from the given location under a specific Azure subscription.
list_regional_by_subscription(location: str, filter: str | None = None, top: int | None = None, **kwargs: Any) -> ItemPaged[EventSubscription]Parameters
| Name | Description |
|---|---|
|
location
Required
|
Name of the location. Required. |
|
filter
|
The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. Default value is None. Default value: None
|
|
top
|
The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. Default value is None. Default value: None
|
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either EventSubscription or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_regional_by_subscription_for_topic_type
List all regional event subscriptions under an Azure subscription for a topic type.
List all event subscriptions from the given location under a specific Azure subscription and topic type.
list_regional_by_subscription_for_topic_type(location: str, topic_type_name: str, filter: str | None = None, top: int | None = None, **kwargs: Any) -> ItemPaged[EventSubscription]Parameters
| Name | Description |
|---|---|
|
location
Required
|
Name of the location. Required. |
|
topic_type_name
Required
|
Name of the topic type. Required. |
|
filter
|
The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. Default value is None. Default value: None
|
|
top
|
The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. Default value is None. Default value: None
|
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either EventSubscription or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
Attributes
models
models = <module 'azure.mgmt.eventgrid.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv137\\Lib\\site-packages\\azure\\mgmt\\eventgrid\\models\\__init__.py'>