EventSubscriptions interface

Interface representing a EventSubscriptions.

Methods

beginCreateOrUpdate(string, string, EventSubscription, EventSubscriptionsCreateOrUpdateOptionalParams)

Asynchronously creates a new event subscription or updates an existing event subscription based on the specified scope.

beginCreateOrUpdateAndWait(string, string, EventSubscription, EventSubscriptionsCreateOrUpdateOptionalParams)

Asynchronously creates a new event subscription or updates an existing event subscription based on the specified scope.

beginDelete(string, string, EventSubscriptionsDeleteOptionalParams)

Delete an existing event subscription.

beginDeleteAndWait(string, string, EventSubscriptionsDeleteOptionalParams)

Delete an existing event subscription.

beginUpdate(string, string, EventSubscriptionUpdateParameters, EventSubscriptionsUpdateOptionalParams)

Asynchronously updates an existing event subscription.

beginUpdateAndWait(string, string, EventSubscriptionUpdateParameters, EventSubscriptionsUpdateOptionalParams)

Asynchronously updates an existing event subscription.

get(string, string, EventSubscriptionsGetOptionalParams)

Get properties of an event subscription.

getDeliveryAttributes(string, string, EventSubscriptionsGetDeliveryAttributesOptionalParams)

Get all delivery attributes for an event subscription.

getFullUrl(string, string, EventSubscriptionsGetFullUrlOptionalParams)

Get the full endpoint URL for an event subscription.

listByDomainTopic(string, string, string, EventSubscriptionsListByDomainTopicOptionalParams)

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

listByResource(string, string, string, string, EventSubscriptionsListByResourceOptionalParams)

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

listGlobalByResourceGroup(string, EventSubscriptionsListGlobalByResourceGroupOptionalParams)

List all global event subscriptions under a specific Azure subscription and resource group.

listGlobalByResourceGroupForTopicType(string, string, EventSubscriptionsListGlobalByResourceGroupForTopicTypeOptionalParams)

List all global event subscriptions under a resource group for a specific topic type.

listGlobalBySubscription(EventSubscriptionsListGlobalBySubscriptionOptionalParams)

List all aggregated global event subscriptions under a specific Azure subscription.

listGlobalBySubscriptionForTopicType(string, EventSubscriptionsListGlobalBySubscriptionForTopicTypeOptionalParams)

List all global event subscriptions under an Azure subscription for a topic type.

listRegionalByResourceGroup(string, string, EventSubscriptionsListRegionalByResourceGroupOptionalParams)

List all event subscriptions from the given location under a specific Azure subscription and resource group.

listRegionalByResourceGroupForTopicType(string, string, string, EventSubscriptionsListRegionalByResourceGroupForTopicTypeOptionalParams)

List all event subscriptions from the given location under a specific Azure subscription and resource group and topic type.

listRegionalBySubscription(string, EventSubscriptionsListRegionalBySubscriptionOptionalParams)

List all event subscriptions from the given location under a specific Azure subscription.

listRegionalBySubscriptionForTopicType(string, string, EventSubscriptionsListRegionalBySubscriptionForTopicTypeOptionalParams)

List all event subscriptions from the given location under a specific Azure subscription and topic type.

Method Details

beginCreateOrUpdate(string, string, EventSubscription, EventSubscriptionsCreateOrUpdateOptionalParams)

Asynchronously creates a new event subscription or updates an existing event subscription based on the specified scope.

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

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.

options
EventSubscriptionsCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, EventSubscription, EventSubscriptionsCreateOrUpdateOptionalParams)

Asynchronously creates a new event subscription or updates an existing event subscription based on the specified scope.

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

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.

options
EventSubscriptionsCreateOrUpdateOptionalParams

The options parameters.

Returns

beginDelete(string, string, EventSubscriptionsDeleteOptionalParams)

Delete an existing event subscription.

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

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.

options
EventSubscriptionsDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, EventSubscriptionsDeleteOptionalParams)

Delete an existing event subscription.

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

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.

options
EventSubscriptionsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, EventSubscriptionUpdateParameters, EventSubscriptionsUpdateOptionalParams)

Asynchronously updates an existing event subscription.

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

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.

options
EventSubscriptionsUpdateOptionalParams

The options parameters.

Returns

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

beginUpdateAndWait(string, string, EventSubscriptionUpdateParameters, EventSubscriptionsUpdateOptionalParams)

Asynchronously updates an existing event subscription.

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

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.

options
EventSubscriptionsUpdateOptionalParams

The options parameters.

Returns

get(string, string, EventSubscriptionsGetOptionalParams)

Get properties of an event subscription.

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

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.

options
EventSubscriptionsGetOptionalParams

The options parameters.

Returns

getDeliveryAttributes(string, string, EventSubscriptionsGetDeliveryAttributesOptionalParams)

Get all delivery attributes for an event subscription.

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

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.

Returns

getFullUrl(string, string, EventSubscriptionsGetFullUrlOptionalParams)

Get the full endpoint URL for an event subscription.

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

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.

options
EventSubscriptionsGetFullUrlOptionalParams

The options parameters.

Returns

listByDomainTopic(string, string, string, EventSubscriptionsListByDomainTopicOptionalParams)

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

function listByDomainTopic(resourceGroupName: string, domainName: string, topicName: string, options?: EventSubscriptionsListByDomainTopicOptionalParams): 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
EventSubscriptionsListByDomainTopicOptionalParams

The options parameters.

Returns

listByResource(string, string, string, string, EventSubscriptionsListByResourceOptionalParams)

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

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

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.

options
EventSubscriptionsListByResourceOptionalParams

The options parameters.

Returns

listGlobalByResourceGroup(string, EventSubscriptionsListGlobalByResourceGroupOptionalParams)

List all global event subscriptions under a specific Azure subscription and resource group.

function listGlobalByResourceGroup(resourceGroupName: string, options?: EventSubscriptionsListGlobalByResourceGroupOptionalParams): PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>

Parameters

resourceGroupName

string

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

Returns

listGlobalByResourceGroupForTopicType(string, string, EventSubscriptionsListGlobalByResourceGroupForTopicTypeOptionalParams)

List all global event subscriptions under a resource group for a specific topic type.

function listGlobalByResourceGroupForTopicType(resourceGroupName: string, topicTypeName: string, options?: EventSubscriptionsListGlobalByResourceGroupForTopicTypeOptionalParams): PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>

Parameters

resourceGroupName

string

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

topicTypeName

string

Name of the topic type.

Returns

listGlobalBySubscription(EventSubscriptionsListGlobalBySubscriptionOptionalParams)

List all aggregated global event subscriptions under a specific Azure subscription.

function listGlobalBySubscription(options?: EventSubscriptionsListGlobalBySubscriptionOptionalParams): PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>

Parameters

Returns

listGlobalBySubscriptionForTopicType(string, EventSubscriptionsListGlobalBySubscriptionForTopicTypeOptionalParams)

List all global event subscriptions under an Azure subscription for a topic type.

function listGlobalBySubscriptionForTopicType(topicTypeName: string, options?: EventSubscriptionsListGlobalBySubscriptionForTopicTypeOptionalParams): PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>

Parameters

topicTypeName

string

Name of the topic type.

Returns

listRegionalByResourceGroup(string, string, EventSubscriptionsListRegionalByResourceGroupOptionalParams)

List all event subscriptions from the given location under a specific Azure subscription and resource group.

function listRegionalByResourceGroup(resourceGroupName: string, location: string, options?: EventSubscriptionsListRegionalByResourceGroupOptionalParams): PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>

Parameters

resourceGroupName

string

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

location

string

Name of the location.

Returns

listRegionalByResourceGroupForTopicType(string, string, string, EventSubscriptionsListRegionalByResourceGroupForTopicTypeOptionalParams)

List all event subscriptions from the given location under a specific Azure subscription and resource group and topic type.

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

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.

Returns

listRegionalBySubscription(string, EventSubscriptionsListRegionalBySubscriptionOptionalParams)

List all event subscriptions from the given location under a specific Azure subscription.

function listRegionalBySubscription(location: string, options?: EventSubscriptionsListRegionalBySubscriptionOptionalParams): PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>

Parameters

location

string

Name of the location.

Returns

listRegionalBySubscriptionForTopicType(string, string, EventSubscriptionsListRegionalBySubscriptionForTopicTypeOptionalParams)

List all event subscriptions from the given location under a specific Azure subscription and topic type.

function listRegionalBySubscriptionForTopicType(location: string, topicTypeName: string, options?: EventSubscriptionsListRegionalBySubscriptionForTopicTypeOptionalParams): PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>

Parameters

location

string

Name of the location.

topicTypeName

string

Name of the topic type.

Returns