NamespaceTopicEventSubscriptions interface

Package:

@azure/arm-eventgrid

Interface representing a NamespaceTopicEventSubscriptions.

Methods

beginCreateOrUpdate(string, string, string, string, Subscription, NamespaceTopicEventSubscriptionsCreateOrUpdateOptionalParams)	Asynchronously creates or updates an event subscription of a namespace topic with the specified parameters. Existing event subscriptions will be updated with this API.
beginCreateOrUpdateAndWait(string, string, string, string, Subscription, NamespaceTopicEventSubscriptionsCreateOrUpdateOptionalParams)	Asynchronously creates or updates an event subscription of a namespace topic with the specified parameters. Existing event subscriptions will be updated with this API.
beginDelete(string, string, string, string, NamespaceTopicEventSubscriptionsDeleteOptionalParams)	Delete an existing event subscription of a namespace topic.
beginDeleteAndWait(string, string, string, string, NamespaceTopicEventSubscriptionsDeleteOptionalParams)	Delete an existing event subscription of a namespace topic.
beginUpdate(string, string, string, string, SubscriptionUpdateParameters, NamespaceTopicEventSubscriptionsUpdateOptionalParams)	Update an existing event subscription of a namespace topic.
beginUpdateAndWait(string, string, string, string, SubscriptionUpdateParameters, NamespaceTopicEventSubscriptionsUpdateOptionalParams)	Update an existing event subscription of a namespace topic.
get(string, string, string, string, NamespaceTopicEventSubscriptionsGetOptionalParams)	Get properties of an event subscription of a namespace topic.
getDeliveryAttributes(string, string, string, string, NamespaceTopicEventSubscriptionsGetDeliveryAttributesOptionalParams)	Get all delivery attributes for an event subscription of a namespace topic.
getFullUrl(string, string, string, string, NamespaceTopicEventSubscriptionsGetFullUrlOptionalParams)	Get the full endpoint URL for an event subscription of a namespace topic.
listByNamespaceTopic(string, string, string, NamespaceTopicEventSubscriptionsListByNamespaceTopicOptionalParams)	List event subscriptions that belong to a specific namespace topic.

Method Details

beginCreateOrUpdate(string, string, string, string, Subscription, NamespaceTopicEventSubscriptionsCreateOrUpdateOptionalParams)

Asynchronously creates or updates an event subscription of a namespace topic with the specified parameters. Existing event subscriptions will be updated with this API.

function beginCreateOrUpdate(resourceGroupName: string, namespaceName: string, topicName: string, eventSubscriptionName: string, eventSubscriptionInfo: Subscription, options?: NamespaceTopicEventSubscriptionsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Subscription>, Subscription>>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

namespaceName

string

Name of the namespace.

topicName

string

Name of the namespace topic.

eventSubscriptionName

string

Name of the event subscription to be created. Event subscription names must be between 3 and 50 characters in length and use alphanumeric letters only.

eventSubscriptionInfo

Subscription

Event subscription properties containing the delivery mode, filter information, and others.

options

NamespaceTopicEventSubscriptionsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<Subscription>, Subscription>>

beginCreateOrUpdateAndWait(string, string, string, string, Subscription, NamespaceTopicEventSubscriptionsCreateOrUpdateOptionalParams)

Asynchronously creates or updates an event subscription of a namespace topic with the specified parameters. Existing event subscriptions will be updated with this API.

function beginCreateOrUpdateAndWait(resourceGroupName: string, namespaceName: string, topicName: string, eventSubscriptionName: string, eventSubscriptionInfo: Subscription, options?: NamespaceTopicEventSubscriptionsCreateOrUpdateOptionalParams): Promise<Subscription>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

namespaceName

string

Name of the namespace.

topicName

string

Name of the namespace topic.

eventSubscriptionName

string

Name of the event subscription to be created. Event subscription names must be between 3 and 50 characters in length and use alphanumeric letters only.

eventSubscriptionInfo

Subscription

Event subscription properties containing the delivery mode, filter information, and others.

options

NamespaceTopicEventSubscriptionsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Subscription>

beginDelete(string, string, string, string, NamespaceTopicEventSubscriptionsDeleteOptionalParams)

Delete an existing event subscription of a namespace topic.

function beginDelete(resourceGroupName: string, namespaceName: string, topicName: string, eventSubscriptionName: string, options?: NamespaceTopicEventSubscriptionsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

namespaceName

string

Name of the namespace.

topicName

string

Name of the namespace topic.

eventSubscriptionName

string

Name of the event subscription to be deleted.

options

NamespaceTopicEventSubscriptionsDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, string, NamespaceTopicEventSubscriptionsDeleteOptionalParams)

Delete an existing event subscription of a namespace topic.

function beginDeleteAndWait(resourceGroupName: string, namespaceName: string, topicName: string, eventSubscriptionName: string, options?: NamespaceTopicEventSubscriptionsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

namespaceName

string

Name of the namespace.

topicName

string

Name of the namespace topic.

eventSubscriptionName

string

Name of the event subscription to be deleted.

options

NamespaceTopicEventSubscriptionsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, string, string, SubscriptionUpdateParameters, NamespaceTopicEventSubscriptionsUpdateOptionalParams)

Update an existing event subscription of a namespace topic.

function beginUpdate(resourceGroupName: string, namespaceName: string, topicName: string, eventSubscriptionName: string, eventSubscriptionUpdateParameters: SubscriptionUpdateParameters, options?: NamespaceTopicEventSubscriptionsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Subscription>, Subscription>>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

namespaceName

string

Name of the namespace.

topicName

string

Name of the namespace topic.

eventSubscriptionName

string

Name of the event subscription to be updated.

eventSubscriptionUpdateParameters

SubscriptionUpdateParameters

Updated event subscription information.

options

NamespaceTopicEventSubscriptionsUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<Subscription>, Subscription>>

beginUpdateAndWait(string, string, string, string, SubscriptionUpdateParameters, NamespaceTopicEventSubscriptionsUpdateOptionalParams)

Update an existing event subscription of a namespace topic.

function beginUpdateAndWait(resourceGroupName: string, namespaceName: string, topicName: string, eventSubscriptionName: string, eventSubscriptionUpdateParameters: SubscriptionUpdateParameters, options?: NamespaceTopicEventSubscriptionsUpdateOptionalParams): Promise<Subscription>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

namespaceName

string

Name of the namespace.

topicName

string

Name of the namespace topic.

eventSubscriptionName

string

Name of the event subscription to be updated.

eventSubscriptionUpdateParameters

SubscriptionUpdateParameters

Updated event subscription information.

options

NamespaceTopicEventSubscriptionsUpdateOptionalParams

The options parameters.

Returns

Promise<Subscription>

get(string, string, string, string, NamespaceTopicEventSubscriptionsGetOptionalParams)

Get properties of an event subscription of a namespace topic.

function get(resourceGroupName: string, namespaceName: string, topicName: string, eventSubscriptionName: string, options?: NamespaceTopicEventSubscriptionsGetOptionalParams): Promise<Subscription>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

namespaceName

string

Name of the namespace.

topicName

string

Name of the namespace topic.

eventSubscriptionName

string

Name of the event subscription to be found.

options

NamespaceTopicEventSubscriptionsGetOptionalParams

The options parameters.

Returns

Promise<Subscription>

getDeliveryAttributes(string, string, string, string, NamespaceTopicEventSubscriptionsGetDeliveryAttributesOptionalParams)

Get all delivery attributes for an event subscription of a namespace topic.

function getDeliveryAttributes(resourceGroupName: string, namespaceName: string, topicName: string, eventSubscriptionName: string, options?: NamespaceTopicEventSubscriptionsGetDeliveryAttributesOptionalParams): Promise<DeliveryAttributeListResult>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

namespaceName

string

Name of the namespace.

topicName

string

Name of the namespace topic.

eventSubscriptionName

string

Name of the event subscription.

options

NamespaceTopicEventSubscriptionsGetDeliveryAttributesOptionalParams

The options parameters.

Returns

Promise<DeliveryAttributeListResult>

getFullUrl(string, string, string, string, NamespaceTopicEventSubscriptionsGetFullUrlOptionalParams)

Get the full endpoint URL for an event subscription of a namespace topic.

function getFullUrl(resourceGroupName: string, namespaceName: string, topicName: string, eventSubscriptionName: string, options?: NamespaceTopicEventSubscriptionsGetFullUrlOptionalParams): Promise<SubscriptionFullUrl>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

namespaceName

string

Name of the namespace.

topicName

string

Name of the namespace topic.

eventSubscriptionName

string

Name of the event subscription.

options

NamespaceTopicEventSubscriptionsGetFullUrlOptionalParams

The options parameters.

Returns

Promise<SubscriptionFullUrl>

listByNamespaceTopic(string, string, string, NamespaceTopicEventSubscriptionsListByNamespaceTopicOptionalParams)

List event subscriptions that belong to a specific namespace topic.

function listByNamespaceTopic(resourceGroupName: string, namespaceName: string, topicName: string, options?: NamespaceTopicEventSubscriptionsListByNamespaceTopicOptionalParams): PagedAsyncIterableIterator<Subscription, Subscription[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

namespaceName

string

Name of the namespace.

topicName

string

Name of the namespace topic.

options

NamespaceTopicEventSubscriptionsListByNamespaceTopicOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Subscription, Subscription[], PageSettings>