PartnerTopicEventSubscriptions interface

Package:

@azure/arm-eventgrid

Interface representing a PartnerTopicEventSubscriptions.

Methods

beginCreateOrUpdate(string, string, string, EventSubscription, PartnerTopicEventSubscriptionsCreateOrUpdateOptionalParams)	Asynchronously creates or updates an event subscription of a partner topic with the specified parameters. Existing event subscriptions will be updated with this API.
beginCreateOrUpdateAndWait(string, string, string, EventSubscription, PartnerTopicEventSubscriptionsCreateOrUpdateOptionalParams)	Asynchronously creates or updates an event subscription of a partner topic with the specified parameters. Existing event subscriptions will be updated with this API.
beginDelete(string, string, string, PartnerTopicEventSubscriptionsDeleteOptionalParams)	Delete an existing event subscription of a partner topic.
beginDeleteAndWait(string, string, string, PartnerTopicEventSubscriptionsDeleteOptionalParams)	Delete an existing event subscription of a partner topic.
beginUpdate(string, string, string, EventSubscriptionUpdateParameters, PartnerTopicEventSubscriptionsUpdateOptionalParams)	Update an existing event subscription of a partner topic.
beginUpdateAndWait(string, string, string, EventSubscriptionUpdateParameters, PartnerTopicEventSubscriptionsUpdateOptionalParams)	Update an existing event subscription of a partner topic.
get(string, string, string, PartnerTopicEventSubscriptionsGetOptionalParams)	Get properties of an event subscription of a partner topic.
getDeliveryAttributes(string, string, string, PartnerTopicEventSubscriptionsGetDeliveryAttributesOptionalParams)	Get all delivery attributes for an event subscription of a partner topic.
getFullUrl(string, string, string, PartnerTopicEventSubscriptionsGetFullUrlOptionalParams)	Get the full endpoint URL for an event subscription of a partner topic.
listByPartnerTopic(string, string, PartnerTopicEventSubscriptionsListByPartnerTopicOptionalParams)	List event subscriptions that belong to a specific partner topic.

Method Details

beginCreateOrUpdate(string, string, string, EventSubscription, PartnerTopicEventSubscriptionsCreateOrUpdateOptionalParams)

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

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

Parameters

resourceGroupName

string

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

partnerTopicName

string

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

PartnerTopicEventSubscriptionsCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, string, EventSubscription, PartnerTopicEventSubscriptionsCreateOrUpdateOptionalParams)

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

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

Parameters

resourceGroupName

string

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

partnerTopicName

string

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

PartnerTopicEventSubscriptionsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<EventSubscription>

beginDelete(string, string, string, PartnerTopicEventSubscriptionsDeleteOptionalParams)

Delete an existing event subscription of a partner topic.

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

Parameters

resourceGroupName

string

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

partnerTopicName

string

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

PartnerTopicEventSubscriptionsDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, PartnerTopicEventSubscriptionsDeleteOptionalParams)

Delete an existing event subscription of a partner topic.

function beginDeleteAndWait(resourceGroupName: string, partnerTopicName: string, eventSubscriptionName: string, options?: PartnerTopicEventSubscriptionsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

partnerTopicName

string

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

PartnerTopicEventSubscriptionsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, string, EventSubscriptionUpdateParameters, PartnerTopicEventSubscriptionsUpdateOptionalParams)

Update an existing event subscription of a partner topic.

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

Parameters

resourceGroupName

string

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

partnerTopicName

string

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

PartnerTopicEventSubscriptionsUpdateOptionalParams

The options parameters.

Returns

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

beginUpdateAndWait(string, string, string, EventSubscriptionUpdateParameters, PartnerTopicEventSubscriptionsUpdateOptionalParams)

Update an existing event subscription of a partner topic.

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

Parameters

resourceGroupName

string

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

partnerTopicName

string

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

PartnerTopicEventSubscriptionsUpdateOptionalParams

The options parameters.

Returns

Promise<EventSubscription>

get(string, string, string, PartnerTopicEventSubscriptionsGetOptionalParams)

Get properties of an event subscription of a partner topic.

function get(resourceGroupName: string, partnerTopicName: string, eventSubscriptionName: string, options?: PartnerTopicEventSubscriptionsGetOptionalParams): Promise<EventSubscription>

Parameters

resourceGroupName

string

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

partnerTopicName

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

PartnerTopicEventSubscriptionsGetOptionalParams

The options parameters.

Returns

Promise<EventSubscription>

getDeliveryAttributes(string, string, string, PartnerTopicEventSubscriptionsGetDeliveryAttributesOptionalParams)

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

function getDeliveryAttributes(resourceGroupName: string, partnerTopicName: string, eventSubscriptionName: string, options?: PartnerTopicEventSubscriptionsGetDeliveryAttributesOptionalParams): Promise<DeliveryAttributeListResult>

Parameters

resourceGroupName

string

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

partnerTopicName

string

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

PartnerTopicEventSubscriptionsGetDeliveryAttributesOptionalParams

The options parameters.

Returns

Promise<DeliveryAttributeListResult>

getFullUrl(string, string, string, PartnerTopicEventSubscriptionsGetFullUrlOptionalParams)

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

function getFullUrl(resourceGroupName: string, partnerTopicName: string, eventSubscriptionName: string, options?: PartnerTopicEventSubscriptionsGetFullUrlOptionalParams): Promise<EventSubscriptionFullUrl>

Parameters

resourceGroupName

string

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

partnerTopicName

string

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

PartnerTopicEventSubscriptionsGetFullUrlOptionalParams

The options parameters.

Returns

Promise<EventSubscriptionFullUrl>

listByPartnerTopic(string, string, PartnerTopicEventSubscriptionsListByPartnerTopicOptionalParams)

List event subscriptions that belong to a specific partner topic.

function listByPartnerTopic(resourceGroupName: string, partnerTopicName: string, options?: PartnerTopicEventSubscriptionsListByPartnerTopicOptionalParams): PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>

Parameters

resourceGroupName

string

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

partnerTopicName

string

Name of the partner topic.

options

PartnerTopicEventSubscriptionsListByPartnerTopicOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>