EventSubscriptionsClient Interface

Package:

com.azure.resourcemanager.eventgrid.fluent

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-eventgrid:1.2.0-beta.7

public interface EventSubscriptionsClient

An instance of this class provides access to all the operations defined in EventSubscriptionsClient.

Method Summary

Modifier and Type	Method and Description
abstract SyncPoller<PollResult<EventSubscriptionInner>,EventSubscriptionInner>	beginCreateOrUpdate(String scope, String eventSubscriptionName, EventSubscriptionInner eventSubscriptionInfo) Create or update an event subscription.
abstract SyncPoller<PollResult<EventSubscriptionInner>,EventSubscriptionInner>	beginCreateOrUpdate(String scope, String eventSubscriptionName, EventSubscriptionInner eventSubscriptionInfo, Context context) Create or update an event subscription.
abstract SyncPoller<PollResult<Void>,Void>	beginDelete(String scope, String eventSubscriptionName) Delete an event subscription.
abstract SyncPoller<PollResult<Void>,Void>	beginDelete(String scope, String eventSubscriptionName, Context context) Delete an event subscription.
abstract SyncPoller<PollResult<EventSubscriptionInner>,EventSubscriptionInner>	beginUpdate(String scope, String eventSubscriptionName, EventSubscriptionUpdateParameters eventSubscriptionUpdateParameters) Update an event subscription.
abstract SyncPoller<PollResult<EventSubscriptionInner>,EventSubscriptionInner>	beginUpdate(String scope, String eventSubscriptionName, EventSubscriptionUpdateParameters eventSubscriptionUpdateParameters, Context context) Update an event subscription.
abstract EventSubscriptionInner	createOrUpdate(String scope, String eventSubscriptionName, EventSubscriptionInner eventSubscriptionInfo) Create or update an event subscription.
abstract EventSubscriptionInner	createOrUpdate(String scope, String eventSubscriptionName, EventSubscriptionInner eventSubscriptionInfo, Context context) Create or update an event subscription.
abstract void	delete(String scope, String eventSubscriptionName) Delete an event subscription.
abstract void	delete(String scope, String eventSubscriptionName, Context context) Delete an event subscription.
abstract EventSubscriptionInner	get(String scope, String eventSubscriptionName) Get an event subscription.
abstract DeliveryAttributeListResultInner	getDeliveryAttributes(String scope, String eventSubscriptionName) Get delivery attributes for an event subscription.
abstract Response<DeliveryAttributeListResultInner>	getDeliveryAttributesWithResponse(String scope, String eventSubscriptionName, Context context) Get delivery attributes for an event subscription.
abstract EventSubscriptionFullUrlInner	getFullUrl(String scope, String eventSubscriptionName) Get full URL of an event subscription.
abstract Response<EventSubscriptionFullUrlInner>	getFullUrlWithResponse(String scope, String eventSubscriptionName, Context context) Get full URL of an event subscription.
abstract Response<EventSubscriptionInner>	getWithResponse(String scope, String eventSubscriptionName, Context context) Get an event subscription.
abstract PagedIterable<EventSubscriptionInner>	list() Get an aggregated list of all global event subscriptions under an Azure subscription.
abstract PagedIterable<EventSubscriptionInner>	list(String filter, Integer top, Context context) Get an aggregated list of all global event subscriptions under an Azure subscription.
abstract PagedIterable<EventSubscriptionInner>	listByDomainTopic(String resourceGroupName, String domainName, String topicName) List all event subscriptions for a specific domain topic.
abstract PagedIterable<EventSubscriptionInner>	listByDomainTopic(String resourceGroupName, String domainName, String topicName, String filter, Integer top, Context context) List all event subscriptions for a specific domain topic.
abstract PagedIterable<EventSubscriptionInner>	listByResource(String resourceGroupName, String providerNamespace, String resourceTypeName, String resourceName) List all event subscriptions.
abstract PagedIterable<EventSubscriptionInner>	listByResource(String resourceGroupName, String providerNamespace, String resourceTypeName, String resourceName, String filter, Integer top, Context context) List all event subscriptions.
abstract PagedIterable<EventSubscriptionInner>	listByResourceGroup(String resourceGroupName) List all global event subscriptions under an Azure subscription and resource group.
abstract PagedIterable<EventSubscriptionInner>	listByResourceGroup(String resourceGroupName, String filter, Integer top, Context context) List all global event subscriptions under an Azure subscription and resource group.
abstract PagedIterable<EventSubscriptionInner>	listGlobalByResourceGroupForTopicType(String resourceGroupName, String topicTypeName) List all global event subscriptions under a resource group for a topic type.
abstract PagedIterable<EventSubscriptionInner>	listGlobalByResourceGroupForTopicType(String resourceGroupName, String topicTypeName, String filter, Integer top, Context context) List all global event subscriptions under a resource group for a topic type.
abstract PagedIterable<EventSubscriptionInner>	listGlobalBySubscriptionForTopicType(String topicTypeName) List all global event subscriptions for a topic type.
abstract PagedIterable<EventSubscriptionInner>	listGlobalBySubscriptionForTopicType(String topicTypeName, String filter, Integer top, Context context) List all global event subscriptions for a topic type.
abstract PagedIterable<EventSubscriptionInner>	listRegionalByResourceGroup(String resourceGroupName, String location) List all regional event subscriptions under an Azure subscription and resource group.
abstract PagedIterable<EventSubscriptionInner>	listRegionalByResourceGroup(String resourceGroupName, String location, String filter, Integer top, Context context) List all regional event subscriptions under an Azure subscription and resource group.
abstract PagedIterable<EventSubscriptionInner>	listRegionalByResourceGroupForTopicType(String resourceGroupName, String location, String topicTypeName) List all regional event subscriptions under an Azure subscription and resource group for a topic type.
abstract PagedIterable<EventSubscriptionInner>	listRegionalByResourceGroupForTopicType(String resourceGroupName, String location, String topicTypeName, String filter, Integer top, Context context) List all regional event subscriptions under an Azure subscription and resource group for a topic type.
abstract PagedIterable<EventSubscriptionInner>	listRegionalBySubscription(String location) List all regional event subscriptions under an Azure subscription.
abstract PagedIterable<EventSubscriptionInner>	listRegionalBySubscription(String location, String filter, Integer top, Context context) List all regional event subscriptions under an Azure subscription.
abstract PagedIterable<EventSubscriptionInner>	listRegionalBySubscriptionForTopicType(String location, String topicTypeName) List all regional event subscriptions under an Azure subscription for a topic type.
abstract PagedIterable<EventSubscriptionInner>	listRegionalBySubscriptionForTopicType(String location, String topicTypeName, String filter, Integer top, Context context) List all regional event subscriptions under an Azure subscription for a topic type.
abstract EventSubscriptionInner	update(String scope, String eventSubscriptionName, EventSubscriptionUpdateParameters eventSubscriptionUpdateParameters) Update an event subscription.
abstract EventSubscriptionInner	update(String scope, String eventSubscriptionName, EventSubscriptionUpdateParameters eventSubscriptionUpdateParameters, Context context) Update an event subscription.

Method Details

beginCreateOrUpdate

public abstract SyncPoller,EventSubscriptionInner> beginCreateOrUpdate(String scope, String eventSubscriptionName, EventSubscriptionInner eventSubscriptionInfo)

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

Parameters:

scope - 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 - Name of the event subscription to be created. Event subscription names must be between 3 and 64 characters in length and should use alphanumeric letters only.

eventSubscriptionInfo - Event subscription properties containing the destination and filter information.

Returns:

the SyncPoller<T,U> for polling of event Subscription.

beginCreateOrUpdate

public abstract SyncPoller,EventSubscriptionInner> beginCreateOrUpdate(String scope, String eventSubscriptionName, EventSubscriptionInner eventSubscriptionInfo, Context context)

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

Parameters:

scope - 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 - Name of the event subscription to be created. Event subscription names must be between 3 and 64 characters in length and should use alphanumeric letters only.

eventSubscriptionInfo - Event subscription properties containing the destination and filter information.

context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of event Subscription.

beginDelete

public abstract SyncPoller,Void> beginDelete(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 to be deleted.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginDelete

public abstract SyncPoller,Void> beginDelete(String scope, String eventSubscriptionName, Context context)

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 to be deleted.

context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginUpdate

public abstract SyncPoller,EventSubscriptionInner> beginUpdate(String scope, String eventSubscriptionName, EventSubscriptionUpdateParameters eventSubscriptionUpdateParameters)

Update an event subscription. Asynchronously updates an existing event subscription.

Parameters:

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

eventSubscriptionUpdateParameters - Updated event subscription information.

Returns:

the SyncPoller<T,U> for polling of event Subscription.

beginUpdate

public abstract SyncPoller,EventSubscriptionInner> beginUpdate(String scope, String eventSubscriptionName, EventSubscriptionUpdateParameters eventSubscriptionUpdateParameters, Context context)

Update an event subscription. Asynchronously updates an existing event subscription.

Parameters:

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

eventSubscriptionUpdateParameters - Updated event subscription information.

context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of event Subscription.

createOrUpdate

public abstract EventSubscriptionInner createOrUpdate(String scope, String eventSubscriptionName, EventSubscriptionInner eventSubscriptionInfo)

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

Parameters:

scope - 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 - Name of the event subscription to be created. Event subscription names must be between 3 and 64 characters in length and should use alphanumeric letters only.

eventSubscriptionInfo - Event subscription properties containing the destination and filter information.

Returns:

event Subscription.

createOrUpdate

public abstract EventSubscriptionInner createOrUpdate(String scope, String eventSubscriptionName, EventSubscriptionInner eventSubscriptionInfo, Context context)

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

Parameters:

scope - 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 - Name of the event subscription to be created. Event subscription names must be between 3 and 64 characters in length and should use alphanumeric letters only.

eventSubscriptionInfo - Event subscription properties containing the destination and filter information.

context - The context to associate with this operation.

Returns:

event Subscription.

delete

public abstract void delete(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 to be deleted.

delete

public abstract void delete(String scope, String eventSubscriptionName, Context context)

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 to be deleted.

context - The context to associate with this operation.

get

public abstract EventSubscriptionInner get(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 to be found.

Returns:

properties of an event subscription.

getDeliveryAttributes

public abstract DeliveryAttributeListResultInner getDeliveryAttributes(String scope, String eventSubscriptionName)

Get delivery attributes for an event subscription. Get all delivery attributes 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:

all delivery attributes for an event subscription.

getDeliveryAttributesWithResponse

public abstract Response getDeliveryAttributesWithResponse(String scope, String eventSubscriptionName, Context context)

Get delivery attributes for an event subscription. Get all delivery attributes 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.

context - The context to associate with this operation.

Returns:

all delivery attributes for an event subscription along with Response<T>.

getFullUrl

public abstract EventSubscriptionFullUrlInner getFullUrl(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 full endpoint URL for an event subscription.

getFullUrlWithResponse

public abstract Response getFullUrlWithResponse(String scope, String eventSubscriptionName, Context context)

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.

context - The context to associate with this operation.

Returns:

the full endpoint URL for an event subscription along with Response<T>.

getWithResponse

public abstract Response getWithResponse(String scope, String eventSubscriptionName, Context context)

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 to be found.

context - The context to associate with this operation.

Returns:

properties of an event subscription along with Response<T>.

list

public abstract PagedIterable list()

Get an aggregated list of all global event subscriptions under an Azure subscription. List all aggregated global event subscriptions under a specific Azure subscription.

Returns:

result of the List EventSubscriptions operation as paginated response with PagedIterable<T>.

list

public abstract PagedIterable list(String filter, Integer top, Context context)

Get an aggregated list of all global event subscriptions under an Azure subscription. List all aggregated global event subscriptions under a specific Azure subscription.

Parameters:

filter - The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'.

top - The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page.

context - The context to associate with this operation.

Returns:

result of the List EventSubscriptions operation as paginated response with PagedIterable<T>.

listByDomainTopic

public abstract PagedIterable listByDomainTopic(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:

result of the List EventSubscriptions operation as paginated response with PagedIterable<T>.

listByDomainTopic

public abstract PagedIterable listByDomainTopic(String resourceGroupName, String domainName, String topicName, String filter, Integer top, Context context)

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.

filter - The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'.

top - The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page.

context - The context to associate with this operation.

Returns:

result of the List EventSubscriptions operation as paginated response with PagedIterable<T>.

listByResource

public abstract PagedIterable listByResource(String resourceGroupName, String providerNamespace, String resourceTypeName, String resourceName)

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

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:

result of the List EventSubscriptions operation as paginated response with PagedIterable<T>.

listByResource

public abstract PagedIterable listByResource(String resourceGroupName, String providerNamespace, String resourceTypeName, String resourceName, String filter, Integer top, Context context)

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

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.

filter - The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'.

top - The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page.

context - The context to associate with this operation.

Returns:

result of the List EventSubscriptions operation as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable listByResourceGroup(String resourceGroupName)

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

Parameters:

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

Returns:

result of the List EventSubscriptions operation as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable listByResourceGroup(String resourceGroupName, String filter, Integer top, Context context)

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

Parameters:

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

filter - The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'.

top - The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page.

context - The context to associate with this operation.

Returns:

result of the List EventSubscriptions operation as paginated response with PagedIterable<T>.

listGlobalByResourceGroupForTopicType

public abstract PagedIterable listGlobalByResourceGroupForTopicType(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:

result of the List EventSubscriptions operation as paginated response with PagedIterable<T>.

listGlobalByResourceGroupForTopicType

public abstract PagedIterable listGlobalByResourceGroupForTopicType(String resourceGroupName, String topicTypeName, String filter, Integer top, Context context)

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.

filter - The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'.

top - The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page.

context - The context to associate with this operation.

Returns:

result of the List EventSubscriptions operation as paginated response with PagedIterable<T>.

listGlobalBySubscriptionForTopicType

public abstract PagedIterable listGlobalBySubscriptionForTopicType(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:

result of the List EventSubscriptions operation as paginated response with PagedIterable<T>.

listGlobalBySubscriptionForTopicType

public abstract PagedIterable listGlobalBySubscriptionForTopicType(String topicTypeName, String filter, Integer top, Context context)

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.

filter - The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'.

top - The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page.

context - The context to associate with this operation.

Returns:

result of the List EventSubscriptions operation as paginated response with PagedIterable<T>.

listRegionalByResourceGroup

public abstract PagedIterable listRegionalByResourceGroup(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:

result of the List EventSubscriptions operation as paginated response with PagedIterable<T>.

listRegionalByResourceGroup

public abstract PagedIterable listRegionalByResourceGroup(String resourceGroupName, String location, String filter, Integer top, Context context)

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.

filter - The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'.

top - The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page.

context - The context to associate with this operation.

Returns:

result of the List EventSubscriptions operation as paginated response with PagedIterable<T>.

listRegionalByResourceGroupForTopicType

public abstract PagedIterable listRegionalByResourceGroupForTopicType(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:

result of the List EventSubscriptions operation as paginated response with PagedIterable<T>.

listRegionalByResourceGroupForTopicType

public abstract PagedIterable listRegionalByResourceGroupForTopicType(String resourceGroupName, String location, String topicTypeName, String filter, Integer top, Context context)

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.

filter - The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'.

top - The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page.

context - The context to associate with this operation.

Returns:

result of the List EventSubscriptions operation as paginated response with PagedIterable<T>.

listRegionalBySubscription

public abstract PagedIterable listRegionalBySubscription(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:

result of the List EventSubscriptions operation as paginated response with PagedIterable<T>.

listRegionalBySubscription

public abstract PagedIterable listRegionalBySubscription(String location, String filter, Integer top, Context context)

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.

filter - The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'.

top - The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page.

context - The context to associate with this operation.

Returns:

result of the List EventSubscriptions operation as paginated response with PagedIterable<T>.

listRegionalBySubscriptionForTopicType

public abstract PagedIterable listRegionalBySubscriptionForTopicType(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:

result of the List EventSubscriptions operation as paginated response with PagedIterable<T>.

listRegionalBySubscriptionForTopicType

public abstract PagedIterable listRegionalBySubscriptionForTopicType(String location, String topicTypeName, String filter, Integer top, Context context)

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.

filter - The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'.

top - The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page.

context - The context to associate with this operation.

Returns:

result of the List EventSubscriptions operation as paginated response with PagedIterable<T>.

update

public abstract EventSubscriptionInner update(String scope, String eventSubscriptionName, EventSubscriptionUpdateParameters eventSubscriptionUpdateParameters)

Update an event subscription. Asynchronously updates an existing event subscription.

Parameters:

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

eventSubscriptionUpdateParameters - Updated event subscription information.

Returns:

event Subscription.

update

public abstract EventSubscriptionInner update(String scope, String eventSubscriptionName, EventSubscriptionUpdateParameters eventSubscriptionUpdateParameters, Context context)

Update an event subscription. Asynchronously updates an existing event subscription.

Parameters:

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

eventSubscriptionUpdateParameters - Updated event subscription information.

context - The context to associate with this operation.

Returns:

event Subscription.

Azure SDK for Java

Preview