Share via


EventSubscriptions Interface

Implements

com.microsoft.azure.arm.collection.SupportsCreating<Blank> com.microsoft.azure.arm.collection.SupportsListing<EventSubscription> com.microsoft.azure.arm.model.HasInner<com.microsoft.azure.management.eventgrid.v2020_04_01_preview.implementation.EventSubscriptionsInner> com.microsoft.azure.arm.resources.collection.SupportsListingByResourceGroup<EventSubscription>

public interface EventSubscriptions
extends com.microsoft.azure.arm.collection.SupportsCreating<Blank>, com.microsoft.azure.arm.resources.collection.SupportsListingByResourceGroup<EventSubscription>, com.microsoft.azure.arm.collection.SupportsListing<EventSubscription>, com.microsoft.azure.arm.model.HasInner<com.microsoft.azure.management.eventgrid.v2020_04_01_preview.implementation.EventSubscriptionsInner>

Type representing EventSubscriptions.

Method Summary

Modifier and Type Method and Description
abstract rx.Completable deleteAsync(String scope, String eventSubscriptionName)

Delete an event subscription.

abstract rx.Observable<EventSubscription> getAsync(String scope, String eventSubscriptionName)

Get an event subscription.

abstract rx.Observable<EventSubscriptionFullUrl> getFullUrlAsync(String scope, String eventSubscriptionName)

Get full URL of an event subscription.

abstract rx.Observable<EventSubscription> listByDomainTopicAsync(String resourceGroupName, String domainName, String topicName)

List all event subscriptions for a specific domain topic.

abstract rx.Observable<EventSubscription> listByResourceAsync(String resourceGroupName, String providerNamespace, String resourceTypeName, String resourceName)

List all event subscriptions for a specific topic.

abstract rx.Observable<EventSubscription> listGlobalByResourceGroupForTopicTypeAsync(String resourceGroupName, String topicTypeName)

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

abstract rx.Observable<EventSubscription> listGlobalBySubscriptionForTopicTypeAsync(String topicTypeName)

List all global event subscriptions for a topic type.

abstract rx.Observable<EventSubscription> listRegionalByResourceGroupAsync(String resourceGroupName, String location)

List all regional event subscriptions under an Azure subscription and resource group.

abstract rx.Observable<EventSubscription> listRegionalByResourceGroupForTopicTypeAsync(String resourceGroupName, String location, String topicTypeName)

List all regional event subscriptions under an Azure subscription and resource group for a topic type.

abstract rx.Observable<EventSubscription> listRegionalBySubscriptionAsync(String location)

List all regional event subscriptions under an Azure subscription.

abstract rx.Observable<EventSubscription> listRegionalBySubscriptionForTopicTypeAsync(String location, String topicTypeName)

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

Method Details

deleteAsync

public abstract Completable deleteAsync(String scope, String eventSubscriptionName)

Delete an event subscription. Delete an existing event subscription.

Parameters:

scope - 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 - Name of the event subscription.

Returns:

the observable for the request

getAsync

public abstract Observable<EventSubscription> getAsync(String scope, String eventSubscriptionName)

Get an event subscription. Get properties of an event subscription.

Parameters:

scope - 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 - Name of the event subscription.

Returns:

the observable for the request

getFullUrlAsync

public abstract Observable<EventSubscriptionFullUrl> getFullUrlAsync(String scope, String eventSubscriptionName)

Get full URL of an event subscription. Get the full endpoint URL for an event subscription.

Parameters:

scope - 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 - Name of the event subscription.

Returns:

the observable for the request

listByDomainTopicAsync

public abstract Observable<EventSubscription> listByDomainTopicAsync(String resourceGroupName, String domainName, String topicName)

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

Parameters:

resourceGroupName - The name of the resource group within the user's subscription.
domainName - Name of the top level domain.
topicName - Name of the domain topic.

Returns:

the observable for the request

listByResourceAsync

public abstract Observable<EventSubscription> listByResourceAsync(String resourceGroupName, String providerNamespace, String resourceTypeName, String resourceName)

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

Parameters:

resourceGroupName - The name of the resource group within the user's subscription.
providerNamespace - Namespace of the provider of the topic.
resourceTypeName - Name of the resource type.
resourceName - Name of the resource.

Returns:

the observable for the request

listGlobalByResourceGroupForTopicTypeAsync

public abstract Observable<EventSubscription> listGlobalByResourceGroupForTopicTypeAsync(String resourceGroupName, String topicTypeName)

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

Parameters:

resourceGroupName - The name of the resource group within the user's subscription.
topicTypeName - Name of the topic type.

Returns:

the observable for the request

listGlobalBySubscriptionForTopicTypeAsync

public abstract Observable<EventSubscription> listGlobalBySubscriptionForTopicTypeAsync(String topicTypeName)

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

Parameters:

topicTypeName - Name of the topic type.

Returns:

the observable for the request

listRegionalByResourceGroupAsync

public abstract Observable<EventSubscription> listRegionalByResourceGroupAsync(String resourceGroupName, String location)

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

Parameters:

resourceGroupName - The name of the resource group within the user's subscription.
location - Name of the location.

Returns:

the observable for the request

listRegionalByResourceGroupForTopicTypeAsync

public abstract Observable<EventSubscription> listRegionalByResourceGroupForTopicTypeAsync(String resourceGroupName, String location, String topicTypeName)

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

Parameters:

resourceGroupName - The name of the resource group within the user's subscription.
location - Name of the location.
topicTypeName - Name of the topic type.

Returns:

the observable for the request

listRegionalBySubscriptionAsync

public abstract Observable<EventSubscription> listRegionalBySubscriptionAsync(String location)

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

Parameters:

location - Name of the location.

Returns:

the observable for the request

listRegionalBySubscriptionForTopicTypeAsync

public abstract Observable<EventSubscription> listRegionalBySubscriptionForTopicTypeAsync(String location, String topicTypeName)

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

Parameters:

location - Name of the location.
topicTypeName - Name of the topic type.

Returns:

the observable for the request

Applies to