com.azure.resourcemanager.eventgrid.fluent.EventSubscriptionsClient Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-resourcemanager-eventgrid Show documentation
Show all versions of azure-resourcemanager-eventgrid Show documentation
This package contains Microsoft Azure SDK for EventGrid Management SDK. For documentation on how to use this package, please see https://aka.ms/azsdk/java/mgmt. Azure EventGrid Management Client. Package tag package-2021-10-preview.
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// Code generated by Microsoft (R) AutoRest Code Generator.
package com.azure.resourcemanager.eventgrid.fluent;
import com.azure.core.annotation.ReturnType;
import com.azure.core.annotation.ServiceMethod;
import com.azure.core.http.rest.PagedIterable;
import com.azure.core.http.rest.Response;
import com.azure.core.management.polling.PollResult;
import com.azure.core.util.Context;
import com.azure.core.util.polling.SyncPoller;
import com.azure.resourcemanager.eventgrid.fluent.models.DeliveryAttributeListResultInner;
import com.azure.resourcemanager.eventgrid.fluent.models.EventSubscriptionFullUrlInner;
import com.azure.resourcemanager.eventgrid.fluent.models.EventSubscriptionInner;
import com.azure.resourcemanager.eventgrid.models.EventSubscriptionUpdateParameters;
/**
* An instance of this class provides access to all the operations defined in EventSubscriptionsClient.
*/
public interface EventSubscriptionsClient {
/**
* Get delivery attributes for an event subscription.
*
* Get all delivery attributes for an event subscription.
*
* @param 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.
* @param eventSubscriptionName Name of the event subscription.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return all delivery attributes for an event subscription along with {@link Response}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
Response getDeliveryAttributesWithResponse(String scope,
String eventSubscriptionName, Context context);
/**
* Get delivery attributes for an event subscription.
*
* Get all delivery attributes for an event subscription.
*
* @param 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.
* @param eventSubscriptionName Name of the event subscription.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return all delivery attributes for an event subscription.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
DeliveryAttributeListResultInner getDeliveryAttributes(String scope, String eventSubscriptionName);
/**
* Get an event subscription.
*
* Get properties of an event subscription.
*
* @param 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.
* @param eventSubscriptionName Name of the event subscription to be found.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return properties of an event subscription along with {@link Response}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
Response getWithResponse(String scope, String eventSubscriptionName, Context context);
/**
* Get an event subscription.
*
* Get properties of an event subscription.
*
* @param 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.
* @param eventSubscriptionName Name of the event subscription to be found.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return properties of an event subscription.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
EventSubscriptionInner get(String scope, String eventSubscriptionName);
/**
* Create or update an event subscription.
*
* Asynchronously creates a new event subscription or updates an existing event subscription based on the specified
* scope.
*
* @param 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.
* @param 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.
* @param eventSubscriptionInfo Event subscription properties containing the destination and filter information.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the {@link SyncPoller} for polling of event Subscription.
*/
@ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
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.
*
* @param 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.
* @param 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.
* @param eventSubscriptionInfo Event subscription properties containing the destination and filter information.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the {@link SyncPoller} for polling of event Subscription.
*/
@ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
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.
*
* @param 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.
* @param 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.
* @param eventSubscriptionInfo Event subscription properties containing the destination and filter information.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return event Subscription.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
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.
*
* @param 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.
* @param 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.
* @param eventSubscriptionInfo Event subscription properties containing the destination and filter information.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return event Subscription.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
EventSubscriptionInner createOrUpdate(String scope, String eventSubscriptionName,
EventSubscriptionInner eventSubscriptionInfo, Context context);
/**
* Delete an event subscription.
*
* Delete an existing event subscription.
*
* @param 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.
* @param eventSubscriptionName Name of the event subscription to be deleted.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the {@link SyncPoller} for polling of long-running operation.
*/
@ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
SyncPoller, Void> beginDelete(String scope, String eventSubscriptionName);
/**
* Delete an event subscription.
*
* Delete an existing event subscription.
*
* @param 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.
* @param eventSubscriptionName Name of the event subscription to be deleted.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the {@link SyncPoller} for polling of long-running operation.
*/
@ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
SyncPoller, Void> beginDelete(String scope, String eventSubscriptionName, Context context);
/**
* Delete an event subscription.
*
* Delete an existing event subscription.
*
* @param 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.
* @param eventSubscriptionName Name of the event subscription to be deleted.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
void delete(String scope, String eventSubscriptionName);
/**
* Delete an event subscription.
*
* Delete an existing event subscription.
*
* @param 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.
* @param eventSubscriptionName Name of the event subscription to be deleted.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
void delete(String scope, String eventSubscriptionName, Context context);
/**
* Update an event subscription.
*
* Asynchronously updates an existing event subscription.
*
* @param 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.
* @param eventSubscriptionName Name of the event subscription to be updated.
* @param eventSubscriptionUpdateParameters Updated event subscription information.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the {@link SyncPoller} for polling of event Subscription.
*/
@ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
SyncPoller, EventSubscriptionInner> beginUpdate(String scope,
String eventSubscriptionName, EventSubscriptionUpdateParameters eventSubscriptionUpdateParameters);
/**
* Update an event subscription.
*
* Asynchronously updates an existing event subscription.
*
* @param 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.
* @param eventSubscriptionName Name of the event subscription to be updated.
* @param eventSubscriptionUpdateParameters Updated event subscription information.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the {@link SyncPoller} for polling of event Subscription.
*/
@ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
SyncPoller, EventSubscriptionInner> beginUpdate(String scope,
String eventSubscriptionName, EventSubscriptionUpdateParameters eventSubscriptionUpdateParameters,
Context context);
/**
* Update an event subscription.
*
* Asynchronously updates an existing event subscription.
*
* @param 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.
* @param eventSubscriptionName Name of the event subscription to be updated.
* @param eventSubscriptionUpdateParameters Updated event subscription information.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return event Subscription.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
EventSubscriptionInner update(String scope, String eventSubscriptionName,
EventSubscriptionUpdateParameters eventSubscriptionUpdateParameters);
/**
* Update an event subscription.
*
* Asynchronously updates an existing event subscription.
*
* @param 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.
* @param eventSubscriptionName Name of the event subscription to be updated.
* @param eventSubscriptionUpdateParameters Updated event subscription information.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return event Subscription.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
EventSubscriptionInner update(String scope, String eventSubscriptionName,
EventSubscriptionUpdateParameters eventSubscriptionUpdateParameters, Context context);
/**
* Get full URL of an event subscription.
*
* Get the full endpoint URL for an event subscription.
*
* @param 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.
* @param eventSubscriptionName Name of the event subscription.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the full endpoint URL for an event subscription along with {@link Response}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
Response getFullUrlWithResponse(String scope, String eventSubscriptionName,
Context context);
/**
* Get full URL of an event subscription.
*
* Get the full endpoint URL for an event subscription.
*
* @param 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.
* @param eventSubscriptionName Name of the event subscription.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the full endpoint URL for an event subscription.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
EventSubscriptionFullUrlInner getFullUrl(String scope, String eventSubscriptionName);
/**
* Get an aggregated list of all global event subscriptions under an Azure subscription.
*
* List all aggregated global event subscriptions under a specific Azure subscription.
*
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return result of the List EventSubscriptions operation as paginated response with {@link PagedIterable}.
*/
@ServiceMethod(returns = ReturnType.COLLECTION)
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.
*
* @param 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'.
* @param 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.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return result of the List EventSubscriptions operation as paginated response with {@link PagedIterable}.
*/
@ServiceMethod(returns = ReturnType.COLLECTION)
PagedIterable list(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.
*
* @param topicTypeName Name of the topic type.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return result of the List EventSubscriptions operation as paginated response with {@link PagedIterable}.
*/
@ServiceMethod(returns = ReturnType.COLLECTION)
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.
*
* @param topicTypeName Name of the topic type.
* @param 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'.
* @param 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.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return result of the List EventSubscriptions operation as paginated response with {@link PagedIterable}.
*/
@ServiceMethod(returns = ReturnType.COLLECTION)
PagedIterable listGlobalBySubscriptionForTopicType(String topicTypeName, 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.
*
* @param resourceGroupName The name of the resource group within the user's subscription.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return result of the List EventSubscriptions operation as paginated response with {@link PagedIterable}.
*/
@ServiceMethod(returns = ReturnType.COLLECTION)
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.
*
* @param resourceGroupName The name of the resource group within the user's subscription.
* @param 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'.
* @param 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.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return result of the List EventSubscriptions operation as paginated response with {@link PagedIterable}.
*/
@ServiceMethod(returns = ReturnType.COLLECTION)
PagedIterable listByResourceGroup(String resourceGroupName, 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.
*
* @param resourceGroupName The name of the resource group within the user's subscription.
* @param topicTypeName Name of the topic type.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return result of the List EventSubscriptions operation as paginated response with {@link PagedIterable}.
*/
@ServiceMethod(returns = ReturnType.COLLECTION)
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.
*
* @param resourceGroupName The name of the resource group within the user's subscription.
* @param topicTypeName Name of the topic type.
* @param 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'.
* @param 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.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return result of the List EventSubscriptions operation as paginated response with {@link PagedIterable}.
*/
@ServiceMethod(returns = ReturnType.COLLECTION)
PagedIterable listGlobalByResourceGroupForTopicType(String resourceGroupName,
String topicTypeName, 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.
*
* @param location Name of the location.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return result of the List EventSubscriptions operation as paginated response with {@link PagedIterable}.
*/
@ServiceMethod(returns = ReturnType.COLLECTION)
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.
*
* @param location Name of the location.
* @param 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'.
* @param 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.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return result of the List EventSubscriptions operation as paginated response with {@link PagedIterable}.
*/
@ServiceMethod(returns = ReturnType.COLLECTION)
PagedIterable listRegionalBySubscription(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.
*
* @param resourceGroupName The name of the resource group within the user's subscription.
* @param location Name of the location.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return result of the List EventSubscriptions operation as paginated response with {@link PagedIterable}.
*/
@ServiceMethod(returns = ReturnType.COLLECTION)
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.
*
* @param resourceGroupName The name of the resource group within the user's subscription.
* @param location Name of the location.
* @param 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'.
* @param 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.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return result of the List EventSubscriptions operation as paginated response with {@link PagedIterable}.
*/
@ServiceMethod(returns = ReturnType.COLLECTION)
PagedIterable listRegionalByResourceGroup(String resourceGroupName, String location,
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.
*
* @param location Name of the location.
* @param topicTypeName Name of the topic type.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return result of the List EventSubscriptions operation as paginated response with {@link PagedIterable}.
*/
@ServiceMethod(returns = ReturnType.COLLECTION)
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.
*
* @param location Name of the location.
* @param topicTypeName Name of the topic type.
* @param 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'.
* @param 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.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return result of the List EventSubscriptions operation as paginated response with {@link PagedIterable}.
*/
@ServiceMethod(returns = ReturnType.COLLECTION)
PagedIterable listRegionalBySubscriptionForTopicType(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.
*
* @param resourceGroupName The name of the resource group within the user's subscription.
* @param location Name of the location.
* @param topicTypeName Name of the topic type.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return result of the List EventSubscriptions operation as paginated response with {@link PagedIterable}.
*/
@ServiceMethod(returns = ReturnType.COLLECTION)
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.
*
* @param resourceGroupName The name of the resource group within the user's subscription.
* @param location Name of the location.
* @param topicTypeName Name of the topic type.
* @param 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'.
* @param 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.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return result of the List EventSubscriptions operation as paginated response with {@link PagedIterable}.
*/
@ServiceMethod(returns = ReturnType.COLLECTION)
PagedIterable listRegionalByResourceGroupForTopicType(String resourceGroupName,
String location, String topicTypeName, String filter, Integer top, Context context);
/**
* List all event subscriptions.
*
* List all event subscriptions that have been created for a specific resource.
*
* @param resourceGroupName The name of the resource group within the user's subscription.
* @param providerNamespace Namespace of the provider of the topic.
* @param resourceTypeName Name of the resource type.
* @param resourceName Name of the resource.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return result of the List EventSubscriptions operation as paginated response with {@link PagedIterable}.
*/
@ServiceMethod(returns = ReturnType.COLLECTION)
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.
*
* @param resourceGroupName The name of the resource group within the user's subscription.
* @param providerNamespace Namespace of the provider of the topic.
* @param resourceTypeName Name of the resource type.
* @param resourceName Name of the resource.
* @param 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'.
* @param 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.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return result of the List EventSubscriptions operation as paginated response with {@link PagedIterable}.
*/
@ServiceMethod(returns = ReturnType.COLLECTION)
PagedIterable listByResource(String resourceGroupName, String providerNamespace,
String resourceTypeName, String resourceName, 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.
*
* @param resourceGroupName The name of the resource group within the user's subscription.
* @param domainName Name of the top level domain.
* @param topicName Name of the domain topic.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return result of the List EventSubscriptions operation as paginated response with {@link PagedIterable}.
*/
@ServiceMethod(returns = ReturnType.COLLECTION)
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.
*
* @param resourceGroupName The name of the resource group within the user's subscription.
* @param domainName Name of the top level domain.
* @param topicName Name of the domain topic.
* @param 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'.
* @param 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.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return result of the List EventSubscriptions operation as paginated response with {@link PagedIterable}.
*/
@ServiceMethod(returns = ReturnType.COLLECTION)
PagedIterable listByDomainTopic(String resourceGroupName, String domainName,
String topicName, String filter, Integer top, Context context);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy