SystemTopicEventSubscriptions Interface

Package:

com.azure.resourcemanager.eventgrid.models

Maven Artifact:

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

public interface SystemTopicEventSubscriptions

Resource collection API of SystemTopicEventSubscriptions.

Method Summary

Modifier and Type	Method and Description
abstract EventSubscription	createOrUpdate(String resourceGroupName, String systemTopicName, String eventSubscriptionName, EventSubscriptionInner eventSubscriptionInfo) Create or update an event subscription for a system topic.
abstract EventSubscription	createOrUpdate(String resourceGroupName, String systemTopicName, String eventSubscriptionName, EventSubscriptionInner eventSubscriptionInfo, Context context) Create or update an event subscription for a system topic.
abstract void	delete(String resourceGroupName, String systemTopicName, String eventSubscriptionName) Delete an event subscription of a system topic.
abstract void	delete(String resourceGroupName, String systemTopicName, String eventSubscriptionName, Context context) Delete an event subscription of a system topic.
abstract EventSubscription	get(String resourceGroupName, String systemTopicName, String eventSubscriptionName) Get an event subscription of a system topic.
abstract DeliveryAttributeListResult	getDeliveryAttributes(String resourceGroupName, String systemTopicName, String eventSubscriptionName) Get delivery attributes for an event subscription.
abstract Response<DeliveryAttributeListResult>	getDeliveryAttributesWithResponse(String resourceGroupName, String systemTopicName, String eventSubscriptionName, Context context) Get delivery attributes for an event subscription.
abstract EventSubscriptionFullUrl	getFullUrl(String resourceGroupName, String systemTopicName, String eventSubscriptionName) Get full URL of an event subscription of a system topic.
abstract Response<EventSubscriptionFullUrl>	getFullUrlWithResponse(String resourceGroupName, String systemTopicName, String eventSubscriptionName, Context context) Get full URL of an event subscription of a system topic.
abstract Response<EventSubscription>	getWithResponse(String resourceGroupName, String systemTopicName, String eventSubscriptionName, Context context) Get an event subscription of a system topic.
abstract PagedIterable<EventSubscription>	listBySystemTopic(String resourceGroupName, String systemTopicName) List event subscriptions of a system topic.
abstract PagedIterable<EventSubscription>	listBySystemTopic(String resourceGroupName, String systemTopicName, String filter, Integer top, Context context) List event subscriptions of a system topic.
abstract EventSubscription	update(String resourceGroupName, String systemTopicName, String eventSubscriptionName, EventSubscriptionUpdateParameters eventSubscriptionUpdateParameters) Update event subscription of a system topic.
abstract EventSubscription	update(String resourceGroupName, String systemTopicName, String eventSubscriptionName, EventSubscriptionUpdateParameters eventSubscriptionUpdateParameters, Context context) Update event subscription of a system topic.

Method Details

createOrUpdate

public abstract EventSubscription createOrUpdate(String resourceGroupName, String systemTopicName, String eventSubscriptionName, EventSubscriptionInner eventSubscriptionInfo)

Create or update an event subscription for a system topic. Asynchronously creates or updates an event subscription with the specified parameters. Existing event subscriptions will be updated with this API.

Parameters:

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

systemTopicName - Name of the system topic.

eventSubscriptionName - Name of the event subscription to be created. Event subscription names must be between 3 and 64 characters in length and use alphanumeric letters only.

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

Returns:

event Subscription.

createOrUpdate

public abstract EventSubscription createOrUpdate(String resourceGroupName, String systemTopicName, String eventSubscriptionName, EventSubscriptionInner eventSubscriptionInfo, Context context)

Create or update an event subscription for a system topic. Asynchronously creates or updates an event subscription with the specified parameters. Existing event subscriptions will be updated with this API.

Parameters:

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

systemTopicName - Name of the system topic.

eventSubscriptionName - Name of the event subscription to be created. Event subscription names must be between 3 and 64 characters in length and 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 resourceGroupName, String systemTopicName, String eventSubscriptionName)

Delete an event subscription of a system topic. Delete an existing event subscription of a system topic.

Parameters:

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

systemTopicName - Name of the system topic.

eventSubscriptionName - Name of the event subscription to be deleted.

delete

public abstract void delete(String resourceGroupName, String systemTopicName, String eventSubscriptionName, Context context)

Delete an event subscription of a system topic. Delete an existing event subscription of a system topic.

Parameters:

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

systemTopicName - Name of the system topic.

eventSubscriptionName - Name of the event subscription to be deleted.

context - The context to associate with this operation.

get

public abstract EventSubscription get(String resourceGroupName, String systemTopicName, String eventSubscriptionName)

Get an event subscription of a system topic. Get an event subscription.

Parameters:

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

systemTopicName - Name of the system topic.

eventSubscriptionName - Name of the event subscription to be found.

Returns:

an event subscription.

getDeliveryAttributes

public abstract DeliveryAttributeListResult getDeliveryAttributes(String resourceGroupName, String systemTopicName, String eventSubscriptionName)

Get delivery attributes for an event subscription. Get all delivery attributes for an event subscription.

Parameters:

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

systemTopicName - Name of the system topic.

eventSubscriptionName - Name of the event subscription.

Returns:

all delivery attributes for an event subscription.

getDeliveryAttributesWithResponse

public abstract Response<DeliveryAttributeListResult> getDeliveryAttributesWithResponse(String resourceGroupName, String systemTopicName, String eventSubscriptionName, Context context)

Get delivery attributes for an event subscription. Get all delivery attributes for an event subscription.

Parameters:

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

systemTopicName - Name of the system 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 EventSubscriptionFullUrl getFullUrl(String resourceGroupName, String systemTopicName, String eventSubscriptionName)

Get full URL of an event subscription of a system topic. Get the full endpoint URL for an event subscription of a system topic.

Parameters:

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

systemTopicName - Name of the system topic.

eventSubscriptionName - Name of the event subscription.

Returns:

the full endpoint URL for an event subscription of a system topic.

getFullUrlWithResponse

public abstract Response<EventSubscriptionFullUrl> getFullUrlWithResponse(String resourceGroupName, String systemTopicName, String eventSubscriptionName, Context context)

Get full URL of an event subscription of a system topic. Get the full endpoint URL for an event subscription of a system topic.

Parameters:

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

systemTopicName - Name of the system topic.

eventSubscriptionName - Name of the event subscription.

context - The context to associate with this operation.

Returns:

the full endpoint URL for an event subscription of a system topic along with Response<T>.

getWithResponse

public abstract Response<EventSubscription> getWithResponse(String resourceGroupName, String systemTopicName, String eventSubscriptionName, Context context)

Get an event subscription of a system topic. Get an event subscription.

Parameters:

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

systemTopicName - Name of the system topic.

eventSubscriptionName - Name of the event subscription to be found.

context - The context to associate with this operation.

Returns:

an event subscription along with Response<T>.

listBySystemTopic

public abstract PagedIterable<EventSubscription> listBySystemTopic(String resourceGroupName, String systemTopicName)

List event subscriptions of a system topic. List event subscriptions that belong to a specific system topic.

Parameters:

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

systemTopicName - Name of the system topic.

Returns:

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

listBySystemTopic

public abstract PagedIterable<EventSubscription> listBySystemTopic(String resourceGroupName, String systemTopicName, String filter, Integer top, Context context)

List event subscriptions of a system topic. List event subscriptions that belong to a specific system topic.

Parameters:

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

systemTopicName - Name of the system 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>.

update

public abstract EventSubscription update(String resourceGroupName, String systemTopicName, String eventSubscriptionName, EventSubscriptionUpdateParameters eventSubscriptionUpdateParameters)

Update event subscription of a system topic. Update an existing event subscription of a system topic.

Parameters:

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

systemTopicName - Name of the system topic.

eventSubscriptionName - Name of the event subscription to be updated.

eventSubscriptionUpdateParameters - Updated event subscription information.

Returns:

event Subscription.

update

public abstract EventSubscription update(String resourceGroupName, String systemTopicName, String eventSubscriptionName, EventSubscriptionUpdateParameters eventSubscriptionUpdateParameters, Context context)

Update event subscription of a system topic. Update an existing event subscription of a system topic.

Parameters:

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

systemTopicName - Name of the system 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.