EventSubscriptionsImpl | @azure/arm-eventgrid

Class containing EventSubscriptions operations.

Hierarchy

EventSubscriptionsImpl

Implements

EventSubscriptions

Constructors

constructor

new EventSubscriptionsImpl(client: EventGridManagementClient): EventSubscriptionsImpl

- Defined in operations/eventSubscriptions.ts:76
Initialize a new instance of the class EventSubscriptions class.

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

Methods

beginCreateOrUpdate

beginCreateOrUpdate(scope: string, eventSubscriptionName: string, eventSubscriptionInfo: EventSubscription, options?: EventSubscriptionsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<EventSubscriptionsCreateOrUpdateResponse>, EventSubscriptionsCreateOrUpdateResponse>>

Implementation of EventSubscriptions.beginCreateOrUpdate
- Defined in operations/eventSubscriptions.ts:815
Asynchronously creates a new event subscription or updates an existing event subscription based on the specified scope.

Parameters
- scope: string
  
  The identifier of the resource to which the event subscription needs to be created or updated. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.
- eventSubscriptionName: string
  
  Name of the event subscription. Event subscription names must be between 3 and 64 characters in length and should use alphanumeric letters only.
- eventSubscriptionInfo: EventSubscription
  
  Event subscription properties containing the destination and filter information.
- Optional options: EventSubscriptionsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<EventSubscriptionsCreateOrUpdateResponse>, EventSubscriptionsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(scope: string, eventSubscriptionName: string, eventSubscriptionInfo: EventSubscription, options?: EventSubscriptionsCreateOrUpdateOptionalParams): Promise<EventSubscriptionsCreateOrUpdateResponse>

Implementation of EventSubscriptions.beginCreateOrUpdateAndWait
- Defined in operations/eventSubscriptions.ts:896
Asynchronously creates a new event subscription or updates an existing event subscription based on the specified scope.

Parameters
- scope: string
  
  The identifier of the resource to which the event subscription needs to be created or updated. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.
- eventSubscriptionName: string
  
  Name of the event subscription. Event subscription names must be between 3 and 64 characters in length and should use alphanumeric letters only.
- eventSubscriptionInfo: EventSubscription
  
  Event subscription properties containing the destination and filter information.
- Optional options: EventSubscriptionsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<EventSubscriptionsCreateOrUpdateResponse>

beginDelete

beginDelete(scope: string, eventSubscriptionName: string, options?: EventSubscriptionsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of EventSubscriptions.beginDelete
- Defined in operations/eventSubscriptions.ts:924
Delete an existing event subscription.

Parameters
- scope: string
  
  The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.
- eventSubscriptionName: string
  
  Name of the event subscription.
- Optional options: EventSubscriptionsDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

beginDeleteAndWait(scope: string, eventSubscriptionName: string, options?: EventSubscriptionsDeleteOptionalParams): Promise<void>

Implementation of EventSubscriptions.beginDeleteAndWait
- Defined in operations/eventSubscriptions.ts:994
Delete an existing event subscription.

Parameters
- scope: string
  
  The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.
- eventSubscriptionName: string
  
  Name of the event subscription.
- Optional options: EventSubscriptionsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

beginUpdate

beginUpdate(scope: string, eventSubscriptionName: string, eventSubscriptionUpdateParameters: EventSubscriptionUpdateParameters, options?: EventSubscriptionsUpdateOptionalParams): Promise<PollerLike<PollOperationState<EventSubscriptionsUpdateResponse>, EventSubscriptionsUpdateResponse>>

Implementation of EventSubscriptions.beginUpdate
- Defined in operations/eventSubscriptions.ts:1021
Asynchronously updates an existing event subscription.

Parameters
- scope: string
  
  The scope of existing event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.
- eventSubscriptionName: string
  
  Name of the event subscription to be updated.
- eventSubscriptionUpdateParameters: EventSubscriptionUpdateParameters
  
  Updated event subscription information.
- Optional options: EventSubscriptionsUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<EventSubscriptionsUpdateResponse>, EventSubscriptionsUpdateResponse>>

beginUpdateAndWait

beginUpdateAndWait(scope: string, eventSubscriptionName: string, eventSubscriptionUpdateParameters: EventSubscriptionUpdateParameters, options?: EventSubscriptionsUpdateOptionalParams): Promise<EventSubscriptionsUpdateResponse>

Implementation of EventSubscriptions.beginUpdateAndWait
- Defined in operations/eventSubscriptions.ts:1103
Asynchronously updates an existing event subscription.

Parameters
- scope: string
  
  The scope of existing event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.
- eventSubscriptionName: string
  
  Name of the event subscription to be updated.
- eventSubscriptionUpdateParameters: EventSubscriptionUpdateParameters
  
  Updated event subscription information.
- Optional options: EventSubscriptionsUpdateOptionalParams
  
  The options parameters.
Returns Promise<EventSubscriptionsUpdateResponse>

get

get(scope: string, eventSubscriptionName: string, options?: EventSubscriptionsGetOptionalParams): Promise<EventSubscriptionsGetResponse>

Implementation of EventSubscriptions.get
- Defined in operations/eventSubscriptions.ts:786
Get properties of an event subscription.

Parameters
- scope: string
  
  The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.
- eventSubscriptionName: string
  
  Name of the event subscription.
- Optional options: EventSubscriptionsGetOptionalParams
  
  The options parameters.
Returns Promise<EventSubscriptionsGetResponse>

getDeliveryAttributes

getDeliveryAttributes(scope: string, eventSubscriptionName: string, options?: EventSubscriptionsGetDeliveryAttributesOptionalParams): Promise<EventSubscriptionsGetDeliveryAttributesResponse>

Implementation of EventSubscriptions.getDeliveryAttributes
- Defined in operations/eventSubscriptions.ts:1334
Get all delivery attributes for an event subscription.

Parameters
- scope: string
  
  The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.
- eventSubscriptionName: string
  
  Name of the event subscription.
- Optional options: EventSubscriptionsGetDeliveryAttributesOptionalParams
  
  The options parameters.
Returns Promise<EventSubscriptionsGetDeliveryAttributesResponse>

getFullUrl

getFullUrl(scope: string, eventSubscriptionName: string, options?: EventSubscriptionsGetFullUrlOptionalParams): Promise<EventSubscriptionsGetFullUrlResponse>

Implementation of EventSubscriptions.getFullUrl
- Defined in operations/eventSubscriptions.ts:1131
Get the full endpoint URL for an event subscription.

Parameters
- scope: string
  
  The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.
- eventSubscriptionName: string
  
  Name of the event subscription.
- Optional options: EventSubscriptionsGetFullUrlOptionalParams
  
  The options parameters.
Returns Promise<EventSubscriptionsGetFullUrlResponse>

listByDomainTopic

listByDomainTopic(resourceGroupName: string, domainName: string, topicName: string, options?: EventSubscriptionsListByDomainTopicOptionalParams): PagedAsyncIterableIterator<EventSubscription>

Implementation of EventSubscriptions.listByDomainTopic
- Defined in operations/eventSubscriptions.ts:700
List all event subscriptions that have been created for a specific domain topic.

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.
- Optional options: EventSubscriptionsListByDomainTopicOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<EventSubscription>

listByResource

listByResource(resourceGroupName: string, providerNamespace: string, resourceTypeName: string, resourceName: string, options?: EventSubscriptionsListByResourceOptionalParams): PagedAsyncIterableIterator<EventSubscription>

Implementation of EventSubscriptions.listByResource
- Defined in operations/eventSubscriptions.ts:612
List all event subscriptions that have been created for a specific resource.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- providerNamespace: string
  
  Namespace of the provider of the topic.
- resourceTypeName: string
  
  Name of the resource type.
- resourceName: string
  
  Name of the resource.
- Optional options: EventSubscriptionsListByResourceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<EventSubscription>

listGlobalByResourceGroup

listGlobalByResourceGroup(resourceGroupName: string, options?: EventSubscriptionsListGlobalByResourceGroupOptionalParams): PagedAsyncIterableIterator<EventSubscription>

Implementation of EventSubscriptions.listGlobalByResourceGroup
- Defined in operations/eventSubscriptions.ts:198
List all global event subscriptions under a specific Azure subscription and resource group.

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

listGlobalByResourceGroupForTopicType

listGlobalByResourceGroupForTopicType(resourceGroupName: string, topicTypeName: string, options?: EventSubscriptionsListGlobalByResourceGroupForTopicTypeOptionalParams): PagedAsyncIterableIterator<EventSubscription>

Implementation of EventSubscriptions.listGlobalByResourceGroupForTopicType
- Defined in operations/eventSubscriptions.ts:261
List all global event subscriptions under a resource group for a specific topic type.

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

listGlobalBySubscription

listGlobalBySubscription(options?: EventSubscriptionsListGlobalBySubscriptionOptionalParams): PagedAsyncIterableIterator<EventSubscription>

Implementation of EventSubscriptions.listGlobalBySubscription
- Defined in operations/eventSubscriptions.ts:90
List all aggregated global event subscriptions under a specific Azure subscription.

Parameters
- Optional options: EventSubscriptionsListGlobalBySubscriptionOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<EventSubscription>

listGlobalBySubscriptionForTopicType

listGlobalBySubscriptionForTopicType(topicTypeName: string, options?: EventSubscriptionsListGlobalBySubscriptionForTopicTypeOptionalParams): PagedAsyncIterableIterator<EventSubscription>

Implementation of EventSubscriptions.listGlobalBySubscriptionForTopicType
- Defined in operations/eventSubscriptions.ts:136
List all global event subscriptions under an Azure subscription for a topic type.

Parameters
- topicTypeName: string
  
  Name of the topic type.
- Optional options: EventSubscriptionsListGlobalBySubscriptionForTopicTypeOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<EventSubscription>

listRegionalByResourceGroup

listRegionalByResourceGroup(resourceGroupName: string, location: string, options?: EventSubscriptionsListRegionalByResourceGroupOptionalParams): PagedAsyncIterableIterator<EventSubscription>

Implementation of EventSubscriptions.listRegionalByResourceGroup
- Defined in operations/eventSubscriptions.ts:386
List all event subscriptions from the given location under a specific Azure subscription and resource group.

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

listRegionalByResourceGroupForTopicType

listRegionalByResourceGroupForTopicType(resourceGroupName: string, location: string, topicTypeName: string, options?: EventSubscriptionsListRegionalByResourceGroupForTopicTypeOptionalParams): PagedAsyncIterableIterator<EventSubscription>

Implementation of EventSubscriptions.listRegionalByResourceGroupForTopicType
- Defined in operations/eventSubscriptions.ts:531
List all event subscriptions from the given location under a specific Azure subscription and resource group and topic type.

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

listRegionalBySubscription

listRegionalBySubscription(location: string, options?: EventSubscriptionsListRegionalBySubscriptionOptionalParams): PagedAsyncIterableIterator<EventSubscription>

Implementation of EventSubscriptions.listRegionalBySubscription
- Defined in operations/eventSubscriptions.ts:331
List all event subscriptions from the given location under a specific Azure subscription.

Parameters
- location: string
  
  Name of the location.
- Optional options: EventSubscriptionsListRegionalBySubscriptionOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<EventSubscription>

listRegionalBySubscriptionForTopicType

listRegionalBySubscriptionForTopicType(location: string, topicTypeName: string, options?: EventSubscriptionsListRegionalBySubscriptionForTopicTypeOptionalParams): PagedAsyncIterableIterator<EventSubscription>

Implementation of EventSubscriptions.listRegionalBySubscriptionForTopicType
- Defined in operations/eventSubscriptions.ts:458
List all event subscriptions from the given location under a specific Azure subscription and topic type.

Parameters
- location: string
  
  Name of the location.
- topicTypeName: string
  
  Name of the topic type.
- Optional options: EventSubscriptionsListRegionalBySubscriptionForTopicTypeOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<EventSubscription>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: EventGridManagementClient

Returns EventSubscriptionsImpl

Methods

beginCreateOrUpdate

Parameters

scope: string

eventSubscriptionName: string

eventSubscriptionInfo: EventSubscription

Optional options: EventSubscriptionsCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<EventSubscriptionsCreateOrUpdateResponse>, EventSubscriptionsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

scope: string

eventSubscriptionName: string

eventSubscriptionInfo: EventSubscription

Optional options: EventSubscriptionsCreateOrUpdateOptionalParams

Returns Promise<EventSubscriptionsCreateOrUpdateResponse>

beginDelete

Parameters

scope: string

eventSubscriptionName: string

Optional options: EventSubscriptionsDeleteOptionalParams

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

beginDeleteAndWait

Parameters

scope: string

eventSubscriptionName: string

Optional options: EventSubscriptionsDeleteOptionalParams

Returns Promise<void>

beginUpdate

Parameters

scope: string

eventSubscriptionName: string

eventSubscriptionUpdateParameters: EventSubscriptionUpdateParameters

Optional options: EventSubscriptionsUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<EventSubscriptionsUpdateResponse>, EventSubscriptionsUpdateResponse>>

beginUpdateAndWait

Parameters

scope: string

eventSubscriptionName: string

eventSubscriptionUpdateParameters: EventSubscriptionUpdateParameters

Optional options: EventSubscriptionsUpdateOptionalParams

Returns Promise<EventSubscriptionsUpdateResponse>

get

Parameters

scope: string

eventSubscriptionName: string

Optional options: EventSubscriptionsGetOptionalParams

Returns Promise<EventSubscriptionsGetResponse>

getDeliveryAttributes

Parameters

scope: string

eventSubscriptionName: string

Optional options: EventSubscriptionsGetDeliveryAttributesOptionalParams

Returns Promise<EventSubscriptionsGetDeliveryAttributesResponse>

getFullUrl

Parameters

scope: string

eventSubscriptionName: string

Optional options: EventSubscriptionsGetFullUrlOptionalParams

Returns Promise<EventSubscriptionsGetFullUrlResponse>

listByDomainTopic

Parameters

resourceGroupName: string

domainName: string

topicName: string

Optional options: EventSubscriptionsListByDomainTopicOptionalParams

Returns PagedAsyncIterableIterator<EventSubscription>

listByResource

Parameters

resourceGroupName: string

providerNamespace: string