TopicEventSubscriptions interface
Interface representing a TopicEventSubscriptions.
Methods
Method Details
beginCreateOrUpdate(string, string, string, EventSubscription, TopicEventSubscriptionsCreateOrUpdateOptionalParams)
Asynchronously creates a new event subscription or updates an existing event subscription.
function beginCreateOrUpdate(resourceGroupName: string, topicName: string, eventSubscriptionName: string, eventSubscriptionInfo: EventSubscription, options?: TopicEventSubscriptionsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<EventSubscription>, EventSubscription>>Parameters
- resourceGroupName
-
string
The name of the resource group within the user's subscription.
- topicName
-
string
Name of the domain topic.
- eventSubscriptionName
-
string
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.
- eventSubscriptionInfo
- EventSubscription
Event subscription properties containing the destination and filter information.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<EventSubscription>, EventSubscription>>
beginCreateOrUpdateAndWait(string, string, string, EventSubscription, TopicEventSubscriptionsCreateOrUpdateOptionalParams)
Asynchronously creates a new event subscription or updates an existing event subscription.
function beginCreateOrUpdateAndWait(resourceGroupName: string, topicName: string, eventSubscriptionName: string, eventSubscriptionInfo: EventSubscription, options?: TopicEventSubscriptionsCreateOrUpdateOptionalParams): Promise<EventSubscription>Parameters
- resourceGroupName
-
string
The name of the resource group within the user's subscription.
- topicName
-
string
Name of the domain topic.
- eventSubscriptionName
-
string
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.
- eventSubscriptionInfo
- EventSubscription
Event subscription properties containing the destination and filter information.
The options parameters.
Returns
Promise<EventSubscription>
beginDelete(string, string, string, TopicEventSubscriptionsDeleteOptionalParams)
Delete an existing event subscription for a topic.
function beginDelete(resourceGroupName: string, topicName: string, eventSubscriptionName: string, options?: TopicEventSubscriptionsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group within the user's subscription.
- topicName
-
string
Name of the topic.
- eventSubscriptionName
-
string
Name of the event subscription to be deleted. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteAndWait(string, string, string, TopicEventSubscriptionsDeleteOptionalParams)
Delete an existing event subscription for a topic.
function beginDeleteAndWait(resourceGroupName: string, topicName: string, eventSubscriptionName: string, options?: TopicEventSubscriptionsDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group within the user's subscription.
- topicName
-
string
Name of the topic.
- eventSubscriptionName
-
string
Name of the event subscription to be deleted. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.
The options parameters.
Returns
Promise<void>
beginUpdate(string, string, string, EventSubscriptionUpdateParameters, TopicEventSubscriptionsUpdateOptionalParams)
Update an existing event subscription for a topic.
function beginUpdate(resourceGroupName: string, topicName: string, eventSubscriptionName: string, eventSubscriptionUpdateParameters: EventSubscriptionUpdateParameters, options?: TopicEventSubscriptionsUpdateOptionalParams): Promise<PollerLike<PollOperationState<EventSubscription>, EventSubscription>>Parameters
- resourceGroupName
-
string
The name of the resource group within the user's subscription.
- topicName
-
string
Name of the domain.
- eventSubscriptionName
-
string
Name of the event subscription to be updated.
- eventSubscriptionUpdateParameters
- EventSubscriptionUpdateParameters
Updated event subscription information.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<EventSubscription>, EventSubscription>>
beginUpdateAndWait(string, string, string, EventSubscriptionUpdateParameters, TopicEventSubscriptionsUpdateOptionalParams)
Update an existing event subscription for a topic.
function beginUpdateAndWait(resourceGroupName: string, topicName: string, eventSubscriptionName: string, eventSubscriptionUpdateParameters: EventSubscriptionUpdateParameters, options?: TopicEventSubscriptionsUpdateOptionalParams): Promise<EventSubscription>Parameters
- resourceGroupName
-
string
The name of the resource group within the user's subscription.
- topicName
-
string
Name of the domain.
- eventSubscriptionName
-
string
Name of the event subscription to be updated.
- eventSubscriptionUpdateParameters
- EventSubscriptionUpdateParameters
Updated event subscription information.
The options parameters.
Returns
Promise<EventSubscription>
get(string, string, string, TopicEventSubscriptionsGetOptionalParams)
Get properties of an event subscription of a topic.
function get(resourceGroupName: string, topicName: string, eventSubscriptionName: string, options?: TopicEventSubscriptionsGetOptionalParams): Promise<EventSubscription>Parameters
- resourceGroupName
-
string
The name of the resource group within the user's subscription.
- topicName
-
string
Name of the partner topic.
- eventSubscriptionName
-
string
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.
The options parameters.
Returns
Promise<EventSubscription>
getDeliveryAttributes(string, string, string, TopicEventSubscriptionsGetDeliveryAttributesOptionalParams)
Get all delivery attributes for an event subscription for topic.
function getDeliveryAttributes(resourceGroupName: string, topicName: string, eventSubscriptionName: string, options?: TopicEventSubscriptionsGetDeliveryAttributesOptionalParams): Promise<DeliveryAttributeListResult>Parameters
- resourceGroupName
-
string
The name of the resource group within the user's subscription.
- topicName
-
string
Name of the domain topic.
- eventSubscriptionName
-
string
Name of the event subscription.
The options parameters.
Returns
Promise<DeliveryAttributeListResult>
getFullUrl(string, string, string, TopicEventSubscriptionsGetFullUrlOptionalParams)
Get the full endpoint URL for an event subscription for topic.
function getFullUrl(resourceGroupName: string, topicName: string, eventSubscriptionName: string, options?: TopicEventSubscriptionsGetFullUrlOptionalParams): Promise<EventSubscriptionFullUrl>Parameters
- resourceGroupName
-
string
The name of the resource group within the user's subscription.
- topicName
-
string
Name of the domain topic.
- eventSubscriptionName
-
string
Name of the event subscription.
The options parameters.
Returns
Promise<EventSubscriptionFullUrl>
list(string, string, TopicEventSubscriptionsListOptionalParams)
List all event subscriptions that have been created for a specific topic.
function list(resourceGroupName: string, topicName: string, options?: TopicEventSubscriptionsListOptionalParams): PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group within the user's subscription.
- topicName
-
string
Name of the topic.
The options parameters.