EventSubscriptions interface
Interface representing a EventSubscriptions.
Methods
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.
The options parameters.
Returns
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.
The options parameters.
Returns
Promise<EventSubscription>
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.
The options parameters.
Returns
Promise<PollerLike<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.
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.
The options parameters.
Returns
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.
The options parameters.
Returns
Promise<EventSubscription>
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.
The options parameters.
Returns
Promise<EventSubscription>
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.
The options parameters.
Returns
Promise<DeliveryAttributeListResult>
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.
The options parameters.
Returns
Promise<EventSubscriptionFullUrl>
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.
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.
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.
The options parameters.
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.
The options parameters.
Returns
listGlobalBySubscription(EventSubscriptionsListGlobalBySubscriptionOptionalParams)
List all aggregated global event subscriptions under a specific Azure subscription.
function listGlobalBySubscription(options?: EventSubscriptionsListGlobalBySubscriptionOptionalParams): PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>Parameters
The options 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.
The options parameters.
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.
The options parameters.
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.
The options parameters.
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.
The options parameters.
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.
The options parameters.