SystemTopicEventSubscriptions interface

Interface representing a SystemTopicEventSubscriptions.

Methods

beginCreateOrUpdate(string, string, string, EventSubscription, SystemTopicEventSubscriptionsCreateOrUpdateOptionalParams)

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

beginCreateOrUpdateAndWait(string, string, string, EventSubscription, SystemTopicEventSubscriptionsCreateOrUpdateOptionalParams)

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

beginDelete(string, string, string, SystemTopicEventSubscriptionsDeleteOptionalParams)

Delete an existing event subscription of a system topic.

beginDeleteAndWait(string, string, string, SystemTopicEventSubscriptionsDeleteOptionalParams)

Delete an existing event subscription of a system topic.

beginUpdate(string, string, string, EventSubscriptionUpdateParameters, SystemTopicEventSubscriptionsUpdateOptionalParams)

Update an existing event subscription of a system topic.

beginUpdateAndWait(string, string, string, EventSubscriptionUpdateParameters, SystemTopicEventSubscriptionsUpdateOptionalParams)

Update an existing event subscription of a system topic.

get(string, string, string, SystemTopicEventSubscriptionsGetOptionalParams)

Get an event subscription.

getDeliveryAttributes(string, string, string, SystemTopicEventSubscriptionsGetDeliveryAttributesOptionalParams)

Get all delivery attributes for an event subscription.

getFullUrl(string, string, string, SystemTopicEventSubscriptionsGetFullUrlOptionalParams)

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

listBySystemTopic(string, string, SystemTopicEventSubscriptionsListBySystemTopicOptionalParams)

List event subscriptions that belong to a specific system topic.

Method Details

beginCreateOrUpdate(string, string, string, EventSubscription, SystemTopicEventSubscriptionsCreateOrUpdateOptionalParams)

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

function beginCreateOrUpdate(resourceGroupName: string, systemTopicName: string, eventSubscriptionName: string, eventSubscriptionInfo: EventSubscription, options?: SystemTopicEventSubscriptionsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<EventSubscription>, EventSubscription>>

Parameters

resourceGroupName

string

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

systemTopicName

string

Name of the system 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.

Returns

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

beginCreateOrUpdateAndWait(string, string, string, EventSubscription, SystemTopicEventSubscriptionsCreateOrUpdateOptionalParams)

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

function beginCreateOrUpdateAndWait(resourceGroupName: string, systemTopicName: string, eventSubscriptionName: string, eventSubscriptionInfo: EventSubscription, options?: SystemTopicEventSubscriptionsCreateOrUpdateOptionalParams): Promise<EventSubscription>

Parameters

resourceGroupName

string

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

systemTopicName

string

Name of the system 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.

Returns

beginDelete(string, string, string, SystemTopicEventSubscriptionsDeleteOptionalParams)

Delete an existing event subscription of a system topic.

function beginDelete(resourceGroupName: string, systemTopicName: string, eventSubscriptionName: string, options?: SystemTopicEventSubscriptionsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

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

systemTopicName

string

Name of the system 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.

options
SystemTopicEventSubscriptionsDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, SystemTopicEventSubscriptionsDeleteOptionalParams)

Delete an existing event subscription of a system topic.

function beginDeleteAndWait(resourceGroupName: string, systemTopicName: string, eventSubscriptionName: string, options?: SystemTopicEventSubscriptionsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

systemTopicName

string

Name of the system 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.

options
SystemTopicEventSubscriptionsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, string, EventSubscriptionUpdateParameters, SystemTopicEventSubscriptionsUpdateOptionalParams)

Update an existing event subscription of a system topic.

function beginUpdate(resourceGroupName: string, systemTopicName: string, eventSubscriptionName: string, eventSubscriptionUpdateParameters: EventSubscriptionUpdateParameters, options?: SystemTopicEventSubscriptionsUpdateOptionalParams): Promise<PollerLike<PollOperationState<EventSubscription>, EventSubscription>>

Parameters

resourceGroupName

string

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

systemTopicName

string

Name of the system 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.

eventSubscriptionUpdateParameters
EventSubscriptionUpdateParameters

Updated event subscription information.

options
SystemTopicEventSubscriptionsUpdateOptionalParams

The options parameters.

Returns

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

beginUpdateAndWait(string, string, string, EventSubscriptionUpdateParameters, SystemTopicEventSubscriptionsUpdateOptionalParams)

Update an existing event subscription of a system topic.

function beginUpdateAndWait(resourceGroupName: string, systemTopicName: string, eventSubscriptionName: string, eventSubscriptionUpdateParameters: EventSubscriptionUpdateParameters, options?: SystemTopicEventSubscriptionsUpdateOptionalParams): Promise<EventSubscription>

Parameters

resourceGroupName

string

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

systemTopicName

string

Name of the system 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.

eventSubscriptionUpdateParameters
EventSubscriptionUpdateParameters

Updated event subscription information.

options
SystemTopicEventSubscriptionsUpdateOptionalParams

The options parameters.

Returns

get(string, string, string, SystemTopicEventSubscriptionsGetOptionalParams)

Get an event subscription.

function get(resourceGroupName: string, systemTopicName: string, eventSubscriptionName: string, options?: SystemTopicEventSubscriptionsGetOptionalParams): Promise<EventSubscription>

Parameters

resourceGroupName

string

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

systemTopicName

string

Name of the system 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.

options
SystemTopicEventSubscriptionsGetOptionalParams

The options parameters.

Returns

getDeliveryAttributes(string, string, string, SystemTopicEventSubscriptionsGetDeliveryAttributesOptionalParams)

Get all delivery attributes for an event subscription.

function getDeliveryAttributes(resourceGroupName: string, systemTopicName: string, eventSubscriptionName: string, options?: SystemTopicEventSubscriptionsGetDeliveryAttributesOptionalParams): Promise<DeliveryAttributeListResult>

Parameters

resourceGroupName

string

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

systemTopicName

string

Name of the system 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.

Returns

getFullUrl(string, string, string, SystemTopicEventSubscriptionsGetFullUrlOptionalParams)

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

function getFullUrl(resourceGroupName: string, systemTopicName: string, eventSubscriptionName: string, options?: SystemTopicEventSubscriptionsGetFullUrlOptionalParams): Promise<EventSubscriptionFullUrl>

Parameters

resourceGroupName

string

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

systemTopicName

string

Name of the system 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.

Returns

listBySystemTopic(string, string, SystemTopicEventSubscriptionsListBySystemTopicOptionalParams)

List event subscriptions that belong to a specific system topic.

function listBySystemTopic(resourceGroupName: string, systemTopicName: string, options?: SystemTopicEventSubscriptionsListBySystemTopicOptionalParams): PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>

Parameters

resourceGroupName

string

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

systemTopicName

string

Name of the system topic.

Returns