DomainEventSubscriptions Interface

Package:

com.azure.resourcemanager.eventgrid.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-eventgrid:1.3.0-beta.1

public interface DomainEventSubscriptions

Resource collection API of DomainEventSubscriptions.

Method Summary

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

Method Details

createOrUpdate

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

Create or update an event subscription to a domain. Asynchronously creates a new event subscription or updates an existing event subscription.

Parameters:

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

domainName - Name of the domain 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 domainName, String eventSubscriptionName, EventSubscriptionInner eventSubscriptionInfo, Context context)

Create or update an event subscription to a domain. Asynchronously creates a new event subscription or updates an existing event subscription.

Parameters:

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

domainName - Name of the domain 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 domainName, String eventSubscriptionName)

Delete an event subscription for a domain. Delete an existing event subscription for a domain.

Parameters:

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

domainName - Name of the domain.

eventSubscriptionName - Name of the event subscription to be deleted.

delete

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

Delete an event subscription for a domain. Delete an existing event subscription for a domain.

Parameters:

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

domainName - Name of the domain.

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 domainName, String eventSubscriptionName)

Get an event subscription of a domain. Get properties of an event subscription of a domain.

Parameters:

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

domainName - Name of the domain.

eventSubscriptionName - Name of the event subscription to be found.

Returns:

properties of an event subscription of a domain.

getDeliveryAttributes

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

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

Parameters:

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

domainName - Name of the domain.

eventSubscriptionName - Name of the event subscription.

Returns:

all delivery attributes for an event subscription for domain.

getDeliveryAttributesWithResponse

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

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

Parameters:

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

domainName - Name of the domain.

eventSubscriptionName - Name of the event subscription.

context - The context to associate with this operation.

Returns:

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

getFullUrl

public abstract EventSubscriptionFullUrl getFullUrl(String resourceGroupName, String domainName, String eventSubscriptionName)

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

Parameters:

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

domainName - Name of the domain topic.

eventSubscriptionName - Name of the event subscription.

Returns:

the full endpoint URL for an event subscription for domain.

getFullUrlWithResponse

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

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

Parameters:

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

domainName - Name of the domain topic.

eventSubscriptionName - Name of the event subscription.

context - The context to associate with this operation.

Returns:

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

getWithResponse

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

Get an event subscription of a domain. Get properties of an event subscription of a domain.

Parameters:

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

domainName - Name of the domain.

eventSubscriptionName - Name of the event subscription to be found.

context - The context to associate with this operation.

Returns:

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

list

public abstract PagedIterable<EventSubscription> list(String resourceGroupName, String domainName)

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

Parameters:

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

domainName - Name of the domain.

Returns:

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

list

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

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

Parameters:

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

domainName - Name of the domain.

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 domainName, String eventSubscriptionName, EventSubscriptionUpdateParameters eventSubscriptionUpdateParameters)

Update an event subscription for a domain. Update an existing event subscription for a topic.

Parameters:

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

domainName - Name of the domain.

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 domainName, String eventSubscriptionName, EventSubscriptionUpdateParameters eventSubscriptionUpdateParameters, Context context)

Update an event subscription for a domain. Update an existing event subscription for a topic.

Parameters:

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

domainName - Name of the domain.

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.