EventSubscriptionsOperations interface

Package:

@azure/arm-eventgrid

Interface representing a EventSubscriptions operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
beginUpdate
beginUpdateAndWait
createOrUpdate	Asynchronously creates a new event subscription or updates an existing event subscription based on the specified scope.
delete
get	Get properties of an event subscription.
getDeliveryAttributes	Get all delivery attributes for an event subscription.
getFullUrl	Get the full endpoint URL for an event subscription.
listByDomainTopic	List all event subscriptions that have been created for a specific domain topic.
listByResource	List all event subscriptions that have been created for a specific resource.
listGlobalByResourceGroup	List all global event subscriptions under a specific Azure subscription and resource group.
listGlobalByResourceGroupForTopicType	List all global event subscriptions under a resource group for a specific topic type.
listGlobalBySubscription	List all aggregated global event subscriptions under a specific Azure subscription.
listGlobalBySubscriptionForTopicType	List all global event subscriptions under an Azure subscription for a topic type.
listRegionalByResourceGroup	List all event subscriptions from the given location under a specific Azure subscription and resource group.
listRegionalByResourceGroupForTopicType	List all event subscriptions from the given location under a specific Azure subscription and resource group and topic type.
listRegionalBySubscription	List all event subscriptions from the given location under a specific Azure subscription.
listRegionalBySubscriptionForTopicType	List all event subscriptions from the given location under a specific Azure subscription and topic type.
update	Asynchronously updates an existing event subscription.

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdate: (scope: string, eventSubscriptionName: string, eventSubscriptionInfo: EventSubscription, options?: EventSubscriptionsCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<EventSubscription>, EventSubscription>>

Property Value

(scope: string, eventSubscriptionName: string, eventSubscriptionInfo: EventSubscription, options?: EventSubscriptionsCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<EventSubscription>, EventSubscription>>

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

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

Property Value

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

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (scope: string, eventSubscriptionName: string, options?: EventSubscriptionsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(scope: string, eventSubscriptionName: string, options?: EventSubscriptionsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginUpdate

Warning

This API is now deprecated.

use update instead

beginUpdate: (scope: string, eventSubscriptionName: string, eventSubscriptionUpdateParameters: EventSubscriptionUpdateParameters, options?: EventSubscriptionsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<EventSubscription>, EventSubscription>>

Property Value

(scope: string, eventSubscriptionName: string, eventSubscriptionUpdateParameters: EventSubscriptionUpdateParameters, options?: EventSubscriptionsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<EventSubscription>, EventSubscription>>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

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

Property Value

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

createOrUpdate

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

createOrUpdate: (scope: string, eventSubscriptionName: string, eventSubscriptionInfo: EventSubscription, options?: EventSubscriptionsCreateOrUpdateOptionalParams) => PollerLike<OperationState<EventSubscription>, EventSubscription>

Property Value

(scope: string, eventSubscriptionName: string, eventSubscriptionInfo: EventSubscription, options?: EventSubscriptionsCreateOrUpdateOptionalParams) => PollerLike<OperationState<EventSubscription>, EventSubscription>

delete

delete: (scope: string, eventSubscriptionName: string, options?: EventSubscriptionsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(scope: string, eventSubscriptionName: string, options?: EventSubscriptionsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Get properties of an event subscription.

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

Property Value

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

getDeliveryAttributes

Get all delivery attributes for an event subscription.

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

Property Value

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

getFullUrl

Get the full endpoint URL for an event subscription.

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

Property Value

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

listByDomainTopic

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

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

Property Value

(resourceGroupName: string, domainName: string, topicName: string, options?: EventSubscriptionsListByDomainTopicOptionalParams) => PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>

listByResource

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

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

Property Value

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

listGlobalByResourceGroup

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

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

Property Value

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

listGlobalByResourceGroupForTopicType

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

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

Property Value

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

listGlobalBySubscription

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

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

Property Value

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

listGlobalBySubscriptionForTopicType

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

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

Property Value

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

listRegionalByResourceGroup

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

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

Property Value

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

listRegionalByResourceGroupForTopicType

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

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

Property Value

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

listRegionalBySubscription

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

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

Property Value

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

listRegionalBySubscriptionForTopicType

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

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

Property Value

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

update

Asynchronously updates an existing event subscription.

update: (scope: string, eventSubscriptionName: string, eventSubscriptionUpdateParameters: EventSubscriptionUpdateParameters, options?: EventSubscriptionsUpdateOptionalParams) => PollerLike<OperationState<EventSubscription>, EventSubscription>

Property Value

(scope: string, eventSubscriptionName: string, eventSubscriptionUpdateParameters: EventSubscriptionUpdateParameters, options?: EventSubscriptionsUpdateOptionalParams) => PollerLike<OperationState<EventSubscription>, EventSubscription>