DomainTopicEventSubscriptions interface

Package:

@azure/arm-eventgrid

Interface representing a DomainTopicEventSubscriptions.

Methods

beginCreateOrUpdate(string, string, string, string, EventSubscription, DomainTopicEventSubscriptionsCreateOrUpdateOptionalParams)	Asynchronously creates a new event subscription or updates an existing event subscription.
beginCreateOrUpdateAndWait(string, string, string, string, EventSubscription, DomainTopicEventSubscriptionsCreateOrUpdateOptionalParams)	Asynchronously creates a new event subscription or updates an existing event subscription.
beginDelete(string, string, string, string, DomainTopicEventSubscriptionsDeleteOptionalParams)	Delete a nested existing event subscription for a domain topic.
beginDeleteAndWait(string, string, string, string, DomainTopicEventSubscriptionsDeleteOptionalParams)	Delete a nested existing event subscription for a domain topic.
beginUpdate(string, string, string, string, EventSubscriptionUpdateParameters, DomainTopicEventSubscriptionsUpdateOptionalParams)	Update an existing event subscription for a domain topic.
beginUpdateAndWait(string, string, string, string, EventSubscriptionUpdateParameters, DomainTopicEventSubscriptionsUpdateOptionalParams)	Update an existing event subscription for a domain topic.
get(string, string, string, string, DomainTopicEventSubscriptionsGetOptionalParams)	Get properties of a nested event subscription for a domain topic.
getDeliveryAttributes(string, string, string, string, DomainTopicEventSubscriptionsGetDeliveryAttributesOptionalParams)	Get all delivery attributes for an event subscription for domain topic.
getFullUrl(string, string, string, string, DomainTopicEventSubscriptionsGetFullUrlOptionalParams)	Get the full endpoint URL for a nested event subscription for domain topic.
list(string, string, string, DomainTopicEventSubscriptionsListOptionalParams)	List all event subscriptions that have been created for a specific domain topic.

Method Details

beginCreateOrUpdate(string, string, string, string, EventSubscription, DomainTopicEventSubscriptionsCreateOrUpdateOptionalParams)

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

function beginCreateOrUpdate(resourceGroupName: string, domainName: string, topicName: string, eventSubscriptionName: string, eventSubscriptionInfo: EventSubscription, options?: DomainTopicEventSubscriptionsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<EventSubscription>, EventSubscription>>

Parameters

resourceGroupName

string

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

domainName

string

Name of the top level domain.

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

DomainTopicEventSubscriptionsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<EventSubscription>, EventSubscription>>

beginCreateOrUpdateAndWait(string, string, string, string, EventSubscription, DomainTopicEventSubscriptionsCreateOrUpdateOptionalParams)

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

function beginCreateOrUpdateAndWait(resourceGroupName: string, domainName: string, topicName: string, eventSubscriptionName: string, eventSubscriptionInfo: EventSubscription, options?: DomainTopicEventSubscriptionsCreateOrUpdateOptionalParams): Promise<EventSubscription>

Parameters

resourceGroupName

string

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

domainName

string

Name of the top level domain.

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

DomainTopicEventSubscriptionsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<EventSubscription>

beginDelete(string, string, string, string, DomainTopicEventSubscriptionsDeleteOptionalParams)

Delete a nested existing event subscription for a domain topic.

function beginDelete(resourceGroupName: string, domainName: string, topicName: string, eventSubscriptionName: string, options?: DomainTopicEventSubscriptionsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

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

domainName

string

Name of the top level domain.

topicName

string

Name of the domain 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

DomainTopicEventSubscriptionsDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, string, string, DomainTopicEventSubscriptionsDeleteOptionalParams)

Delete a nested existing event subscription for a domain topic.

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

Parameters

resourceGroupName

string

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

domainName

string

Name of the top level domain.

topicName

string

Name of the domain 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

DomainTopicEventSubscriptionsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, string, string, EventSubscriptionUpdateParameters, DomainTopicEventSubscriptionsUpdateOptionalParams)

Update an existing event subscription for a domain topic.

function beginUpdate(resourceGroupName: string, domainName: string, topicName: string, eventSubscriptionName: string, eventSubscriptionUpdateParameters: EventSubscriptionUpdateParameters, options?: DomainTopicEventSubscriptionsUpdateOptionalParams): Promise<PollerLike<PollOperationState<EventSubscription>, EventSubscription>>

Parameters

resourceGroupName

string

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

domainName

string

Name of the domain.

topicName

string

Name of the topic.

eventSubscriptionName

string

Name of the event subscription to be updated.

eventSubscriptionUpdateParameters

EventSubscriptionUpdateParameters

Updated event subscription information.

options

DomainTopicEventSubscriptionsUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<EventSubscription>, EventSubscription>>

beginUpdateAndWait(string, string, string, string, EventSubscriptionUpdateParameters, DomainTopicEventSubscriptionsUpdateOptionalParams)

Update an existing event subscription for a domain topic.

function beginUpdateAndWait(resourceGroupName: string, domainName: string, topicName: string, eventSubscriptionName: string, eventSubscriptionUpdateParameters: EventSubscriptionUpdateParameters, options?: DomainTopicEventSubscriptionsUpdateOptionalParams): Promise<EventSubscription>

Parameters

resourceGroupName

string

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

domainName

string

Name of the domain.

topicName

string

Name of the topic.

eventSubscriptionName

string

Name of the event subscription to be updated.

eventSubscriptionUpdateParameters

EventSubscriptionUpdateParameters

Updated event subscription information.

options

DomainTopicEventSubscriptionsUpdateOptionalParams

The options parameters.

Returns

Promise<EventSubscription>

get(string, string, string, string, DomainTopicEventSubscriptionsGetOptionalParams)

Get properties of a nested event subscription for a domain topic.

function get(resourceGroupName: string, domainName: string, topicName: string, eventSubscriptionName: string, options?: DomainTopicEventSubscriptionsGetOptionalParams): Promise<EventSubscription>

Parameters

resourceGroupName

string

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

domainName

string

Name of the top level domain.

topicName

string

Name of the domain topic.

eventSubscriptionName

string

Name of the event subscription.

options

DomainTopicEventSubscriptionsGetOptionalParams

The options parameters.

Returns

Promise<EventSubscription>

getDeliveryAttributes(string, string, string, string, DomainTopicEventSubscriptionsGetDeliveryAttributesOptionalParams)

Get all delivery attributes for an event subscription for domain topic.

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

Parameters

resourceGroupName

string

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

domainName

string

Name of the top level domain.

topicName

string

Name of the domain topic.

eventSubscriptionName

string

Name of the event subscription.

options

DomainTopicEventSubscriptionsGetDeliveryAttributesOptionalParams

The options parameters.

Returns

Promise<DeliveryAttributeListResult>

getFullUrl(string, string, string, string, DomainTopicEventSubscriptionsGetFullUrlOptionalParams)

Get the full endpoint URL for a nested event subscription for domain topic.

function getFullUrl(resourceGroupName: string, domainName: string, topicName: string, eventSubscriptionName: string, options?: DomainTopicEventSubscriptionsGetFullUrlOptionalParams): Promise<EventSubscriptionFullUrl>

Parameters

resourceGroupName

string

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

domainName

string

Name of the top level domain.

topicName

string

Name of the domain topic.

eventSubscriptionName

string

Name of the event subscription.

options

DomainTopicEventSubscriptionsGetFullUrlOptionalParams

The options parameters.

Returns

Promise<EventSubscriptionFullUrl>

list(string, string, string, DomainTopicEventSubscriptionsListOptionalParams)

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

function list(resourceGroupName: string, domainName: string, topicName: string, options?: DomainTopicEventSubscriptionsListOptionalParams): PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>

Parameters

resourceGroupName

string

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

domainName

string

Name of the top level domain.

topicName

string

Name of the domain topic.

options

DomainTopicEventSubscriptionsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>