TopicEventSubscriptionsImpl | @azure/arm-eventgrid

Class containing TopicEventSubscriptions operations.

Hierarchy

TopicEventSubscriptionsImpl

Implements

TopicEventSubscriptions

Index

Constructors

constructor

Methods

Constructors

constructor

new TopicEventSubscriptionsImpl(client: EventGridManagementClient): TopicEventSubscriptionsImpl

- Defined in operations/topicEventSubscriptions.ts:40
Initialize a new instance of the class TopicEventSubscriptions class.

Parameters
- client: EventGridManagementClient
  
  Reference to the service client
Returns TopicEventSubscriptionsImpl

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, topicName: string, eventSubscriptionName: string, eventSubscriptionInfo: EventSubscription, options?: TopicEventSubscriptionsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<TopicEventSubscriptionsCreateOrUpdateResponse>, TopicEventSubscriptionsCreateOrUpdateResponse>>

Implementation of TopicEventSubscriptions.beginCreateOrUpdate
- Defined in operations/topicEventSubscriptions.ts:139
Asynchronously creates a new event subscription or updates an existing event subscription.

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.
- Optional options: TopicEventSubscriptionsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<TopicEventSubscriptionsCreateOrUpdateResponse>, TopicEventSubscriptionsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, topicName: string, eventSubscriptionName: string, eventSubscriptionInfo: EventSubscription, options?: TopicEventSubscriptionsCreateOrUpdateOptionalParams): Promise<TopicEventSubscriptionsCreateOrUpdateResponse>

Implementation of TopicEventSubscriptions.beginCreateOrUpdateAndWait
- Defined in operations/topicEventSubscriptions.ts:219
Asynchronously creates a new event subscription or updates an existing event subscription.

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.
- Optional options: TopicEventSubscriptionsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<TopicEventSubscriptionsCreateOrUpdateResponse>

beginDelete

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

Implementation of TopicEventSubscriptions.beginDelete
- Defined in operations/topicEventSubscriptions.ts:244
Delete an existing event subscription for a topic.

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.
- Optional options: TopicEventSubscriptionsDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, topicName: string, eventSubscriptionName: string, options?: TopicEventSubscriptionsDeleteOptionalParams): Promise<void>

Implementation of TopicEventSubscriptions.beginDeleteAndWait
- Defined in operations/topicEventSubscriptions.ts:310
Delete an existing event subscription for a topic.

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.
- Optional options: TopicEventSubscriptionsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

beginUpdate

beginUpdate(resourceGroupName: string, topicName: string, eventSubscriptionName: string, eventSubscriptionUpdateParameters: EventSubscriptionUpdateParameters, options?: TopicEventSubscriptionsUpdateOptionalParams): Promise<PollerLike<PollOperationState<TopicEventSubscriptionsUpdateResponse>, TopicEventSubscriptionsUpdateResponse>>

Implementation of TopicEventSubscriptions.beginUpdate
- Defined in operations/topicEventSubscriptions.ts:333
Update an existing event subscription for a topic.

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.
- Optional options: TopicEventSubscriptionsUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<TopicEventSubscriptionsUpdateResponse>, TopicEventSubscriptionsUpdateResponse>>

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, topicName: string, eventSubscriptionName: string, eventSubscriptionUpdateParameters: EventSubscriptionUpdateParameters, options?: TopicEventSubscriptionsUpdateOptionalParams): Promise<TopicEventSubscriptionsUpdateResponse>

Implementation of TopicEventSubscriptions.beginUpdateAndWait
- Defined in operations/topicEventSubscriptions.ts:411
Update an existing event subscription for a topic.

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.
- Optional options: TopicEventSubscriptionsUpdateOptionalParams
  
  The options parameters.
Returns Promise<TopicEventSubscriptionsUpdateResponse>

get

get(resourceGroupName: string, topicName: string, eventSubscriptionName: string, options?: TopicEventSubscriptionsGetOptionalParams): Promise<TopicEventSubscriptionsGetResponse>

Implementation of TopicEventSubscriptions.get
- Defined in operations/topicEventSubscriptions.ts:117
Get properties of an event subscription of a topic.

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.
- Optional options: TopicEventSubscriptionsGetOptionalParams
  
  The options parameters.
Returns Promise<TopicEventSubscriptionsGetResponse>

getDeliveryAttributes

getDeliveryAttributes(resourceGroupName: string, topicName: string, eventSubscriptionName: string, options?: TopicEventSubscriptionsGetDeliveryAttributesOptionalParams): Promise<TopicEventSubscriptionsGetDeliveryAttributesResponse>

Implementation of TopicEventSubscriptions.getDeliveryAttributes
- Defined in operations/topicEventSubscriptions.ts:471
Get all delivery attributes for an event subscription for topic.

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.
- Optional options: TopicEventSubscriptionsGetDeliveryAttributesOptionalParams
  
  The options parameters.
Returns Promise<TopicEventSubscriptionsGetDeliveryAttributesResponse>

getFullUrl

getFullUrl(resourceGroupName: string, topicName: string, eventSubscriptionName: string, options?: TopicEventSubscriptionsGetFullUrlOptionalParams): Promise<TopicEventSubscriptionsGetFullUrlResponse>

Implementation of TopicEventSubscriptions.getFullUrl
- Defined in operations/topicEventSubscriptions.ts:435
Get the full endpoint URL for an event subscription for topic.

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.
- Optional options: TopicEventSubscriptionsGetFullUrlOptionalParams
  
  The options parameters.
Returns Promise<TopicEventSubscriptionsGetFullUrlResponse>

list

list(resourceGroupName: string, topicName: string, options?: TopicEventSubscriptionsListOptionalParams): PagedAsyncIterableIterator<EventSubscription>

Implementation of TopicEventSubscriptions.list
- Defined in operations/topicEventSubscriptions.ts:56
List all event subscriptions that have been created for a specific topic.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- topicName: string
  
  Name of the topic.
- Optional options: TopicEventSubscriptionsListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<EventSubscription>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: EventGridManagementClient

Returns TopicEventSubscriptionsImpl

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

topicName: string

eventSubscriptionName: string

eventSubscriptionInfo: EventSubscription

Optional options: TopicEventSubscriptionsCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<TopicEventSubscriptionsCreateOrUpdateResponse>, TopicEventSubscriptionsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

topicName: string

eventSubscriptionName: string

eventSubscriptionInfo: EventSubscription

Optional options: TopicEventSubscriptionsCreateOrUpdateOptionalParams

Returns Promise<TopicEventSubscriptionsCreateOrUpdateResponse>

beginDelete

Parameters

resourceGroupName: string

topicName: string

eventSubscriptionName: string

Optional options: TopicEventSubscriptionsDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

topicName: string

eventSubscriptionName: string

Optional options: TopicEventSubscriptionsDeleteOptionalParams

Returns Promise<void>

beginUpdate

Parameters

resourceGroupName: string

topicName: string

eventSubscriptionName: string

eventSubscriptionUpdateParameters: EventSubscriptionUpdateParameters

Optional options: TopicEventSubscriptionsUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<TopicEventSubscriptionsUpdateResponse>, TopicEventSubscriptionsUpdateResponse>>

beginUpdateAndWait

Parameters

resourceGroupName: string

topicName: string

eventSubscriptionName: string

eventSubscriptionUpdateParameters: EventSubscriptionUpdateParameters

Optional options: TopicEventSubscriptionsUpdateOptionalParams

Returns Promise<TopicEventSubscriptionsUpdateResponse>

get

Parameters

resourceGroupName: string

topicName: string

eventSubscriptionName: string

Optional options: TopicEventSubscriptionsGetOptionalParams

Returns Promise<TopicEventSubscriptionsGetResponse>

getDeliveryAttributes

Parameters

resourceGroupName: string

topicName: string

eventSubscriptionName: string

Optional options: TopicEventSubscriptionsGetDeliveryAttributesOptionalParams

Returns Promise<TopicEventSubscriptionsGetDeliveryAttributesResponse>

getFullUrl

Parameters

resourceGroupName: string

topicName: string

eventSubscriptionName: string

Optional options: TopicEventSubscriptionsGetFullUrlOptionalParams

Returns Promise<TopicEventSubscriptionsGetFullUrlResponse>

list

Parameters