TopicEventSubscriptions interface

Interface representing a TopicEventSubscriptions.

Methods

beginCreateOrUpdate(string, string, string, EventSubscription, TopicEventSubscriptionsCreateOrUpdateOptionalParams)

Asynchronously creates a new event subscription or updates an existing event subscription.

beginCreateOrUpdateAndWait(string, string, string, EventSubscription, TopicEventSubscriptionsCreateOrUpdateOptionalParams)

Asynchronously creates a new event subscription or updates an existing event subscription.

beginDelete(string, string, string, TopicEventSubscriptionsDeleteOptionalParams)

Delete an existing event subscription for a topic.

beginDeleteAndWait(string, string, string, TopicEventSubscriptionsDeleteOptionalParams)

Delete an existing event subscription for a topic.

beginUpdate(string, string, string, EventSubscriptionUpdateParameters, TopicEventSubscriptionsUpdateOptionalParams)

Update an existing event subscription for a topic.

beginUpdateAndWait(string, string, string, EventSubscriptionUpdateParameters, TopicEventSubscriptionsUpdateOptionalParams)

Update an existing event subscription for a topic.

get(string, string, string, TopicEventSubscriptionsGetOptionalParams)

Get properties of an event subscription of a topic.

getDeliveryAttributes(string, string, string, TopicEventSubscriptionsGetDeliveryAttributesOptionalParams)

Get all delivery attributes for an event subscription for topic.

getFullUrl(string, string, string, TopicEventSubscriptionsGetFullUrlOptionalParams)

Get the full endpoint URL for an event subscription for topic.

list(string, string, TopicEventSubscriptionsListOptionalParams)

List all event subscriptions that have been created for a specific topic.

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.

options
TopicEventSubscriptionsCreateOrUpdateOptionalParams

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.

options
TopicEventSubscriptionsCreateOrUpdateOptionalParams

The options parameters.

Returns

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.

options
TopicEventSubscriptionsDeleteOptionalParams

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.

options
TopicEventSubscriptionsDeleteOptionalParams

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.

options
TopicEventSubscriptionsUpdateOptionalParams

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.

options
TopicEventSubscriptionsUpdateOptionalParams

The options parameters.

Returns

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.

options
TopicEventSubscriptionsGetOptionalParams

The options parameters.

Returns

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.

Returns

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.

options
TopicEventSubscriptionsGetFullUrlOptionalParams

The options parameters.

Returns

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.

options
TopicEventSubscriptionsListOptionalParams

The options parameters.

Returns