PartnerTopicEventSubscriptionsOperations Class
PartnerTopicEventSubscriptionsOperations async operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Inheritance
-
builtins.objectPartnerTopicEventSubscriptionsOperations
Constructor
PartnerTopicEventSubscriptionsOperations(client, config, serializer, deserializer)Parameters
| Name | Description |
|---|---|
|
client
Required
|
Client for service requests. |
|
config
Required
|
Configuration of service client. |
|
serializer
Required
|
An object model serializer. |
|
deserializer
Required
|
An object model deserializer. |
Variables
| Name | Description |
|---|---|
|
models
|
Alias to model classes used in this operation group. |
Methods
| begin_create_or_update |
Create or update an event subscription of a partner topic. Asynchronously creates or updates an event subscription of a partner topic with the specified parameters. Existing event subscriptions will be updated with this API. |
| begin_delete |
Delete an event subscription of a partner topic. Delete an existing event subscription of a partner topic. |
| begin_update |
Update event subscription of a partner topic. Update an existing event subscription of a partner topic. |
| get |
Get an event subscription of a partner topic. Get properties of an event subscription of a partner topic. |
| get_delivery_attributes |
Get delivery attributes for an event subscription of a partner topic. Get all delivery attributes for an event subscription of a partner topic. |
| get_full_url |
Get full URL of an event subscription of a partner topic. Get the full endpoint URL for an event subscription of a partner topic. |
| list_by_partner_topic |
List event subscriptions of a partner topic. List event subscriptions that belong to a specific partner topic. |
begin_create_or_update
Create or update an event subscription of a partner topic.
Asynchronously creates or updates an event subscription of a partner topic with the specified parameters. Existing event subscriptions will be updated with this API.
async begin_create_or_update(resource_group_name: str, partner_topic_name: str, event_subscription_name: str, event_subscription_info: EventSubscription, **kwargs: Any) -> AsyncLROPoller[EventSubscription]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group within the user's subscription. |
|
partner_topic_name
Required
|
Name of the partner topic. |
|
event_subscription_name
Required
|
Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only. |
|
event_subscription_info
Required
|
Event subscription properties containing the destination and filter information. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy. |
|
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns either EventSubscription or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_delete
Delete an event subscription of a partner topic.
Delete an existing event subscription of a partner topic.
async begin_delete(resource_group_name: str, partner_topic_name: str, event_subscription_name: str, **kwargs: Any) -> AsyncLROPoller[None]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group within the user's subscription. |
|
partner_topic_name
Required
|
Name of the partner topic. |
|
event_subscription_name
Required
|
Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy. |
|
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_update
Update event subscription of a partner topic.
Update an existing event subscription of a partner topic.
async begin_update(resource_group_name: str, partner_topic_name: str, event_subscription_name: str, event_subscription_update_parameters: EventSubscriptionUpdateParameters, **kwargs: Any) -> AsyncLROPoller[EventSubscription]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group within the user's subscription. |
|
partner_topic_name
Required
|
Name of the partner topic. |
|
event_subscription_name
Required
|
Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only. |
|
event_subscription_update_parameters
Required
|
Updated event subscription information. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy. |
|
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns either EventSubscription or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get
Get an event subscription of a partner topic.
Get properties of an event subscription of a partner topic.
async get(resource_group_name: str, partner_topic_name: str, event_subscription_name: str, **kwargs: Any) -> EventSubscriptionParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group within the user's subscription. |
|
partner_topic_name
Required
|
Name of the partner topic. |
|
event_subscription_name
Required
|
Name of the event subscription to be found. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
EventSubscription, or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get_delivery_attributes
Get delivery attributes for an event subscription of a partner topic.
Get all delivery attributes for an event subscription of a partner topic.
async get_delivery_attributes(resource_group_name: str, partner_topic_name: str, event_subscription_name: str, **kwargs: Any) -> DeliveryAttributeListResultParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group within the user's subscription. |
|
partner_topic_name
Required
|
Name of the partner topic. |
|
event_subscription_name
Required
|
Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
DeliveryAttributeListResult, or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get_full_url
Get full URL of an event subscription of a partner topic.
Get the full endpoint URL for an event subscription of a partner topic.
async get_full_url(resource_group_name: str, partner_topic_name: str, event_subscription_name: str, **kwargs: Any) -> EventSubscriptionFullUrlParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group within the user's subscription. |
|
partner_topic_name
Required
|
Name of the partner topic. |
|
event_subscription_name
Required
|
Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
EventSubscriptionFullUrl, or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_by_partner_topic
List event subscriptions of a partner topic.
List event subscriptions that belong to a specific partner topic.
list_by_partner_topic(resource_group_name: str, partner_topic_name: str, filter: str | None = None, top: int | None = None, **kwargs: Any) -> AsyncIterable[EventSubscriptionsListResult]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group within the user's subscription. |
|
partner_topic_name
Required
|
Name of the partner topic. |
|
filter
Required
|
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. |
|
top
Required
|
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. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either EventSubscriptionsListResult or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
Attributes
models
models = <module 'azure.mgmt.eventgrid.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\eventgrid\\models\\__init__.py'>
Azure SDK for Python