Package com.azure.resourcemanager.eventgrid.models

Interface DomainTopicEventSubscriptions

public interface DomainTopicEventSubscriptions

Resource collection API of DomainTopicEventSubscriptions.

Method Summary

Modifier and Type	Method	Description
EventSubscription	createOrUpdate(String resourceGroupName, String domainName, String topicName, String eventSubscriptionName, EventSubscriptionInner eventSubscriptionInfo)	Asynchronously creates a new event subscription or updates an existing event subscription.
EventSubscription	createOrUpdate(String resourceGroupName, String domainName, String topicName, String eventSubscriptionName, EventSubscriptionInner eventSubscriptionInfo, com.azure.core.util.Context context)	Asynchronously creates a new event subscription or updates an existing event subscription.
void	delete(String resourceGroupName, String domainName, String topicName, String eventSubscriptionName)	Delete a nested existing event subscription for a domain topic.
void	delete(String resourceGroupName, String domainName, String topicName, String eventSubscriptionName, com.azure.core.util.Context context)	Delete a nested existing event subscription for a domain topic.
EventSubscription	get(String resourceGroupName, String domainName, String topicName, String eventSubscriptionName)	Get properties of a nested event subscription for a domain topic.
DeliveryAttributeListResult	getDeliveryAttributes(String resourceGroupName, String domainName, String topicName, String eventSubscriptionName)	Get all delivery attributes for an event subscription for domain topic.
com.azure.core.http.rest.Response<DeliveryAttributeListResult>	getDeliveryAttributesWithResponse(String resourceGroupName, String domainName, String topicName, String eventSubscriptionName, com.azure.core.util.Context context)	Get all delivery attributes for an event subscription for domain topic.
EventSubscriptionFullUrl	getFullUrl(String resourceGroupName, String domainName, String topicName, String eventSubscriptionName)	Get the full endpoint URL for a nested event subscription for domain topic.
com.azure.core.http.rest.Response<EventSubscriptionFullUrl>	getFullUrlWithResponse(String resourceGroupName, String domainName, String topicName, String eventSubscriptionName, com.azure.core.util.Context context)	Get the full endpoint URL for a nested event subscription for domain topic.
com.azure.core.http.rest.Response<EventSubscription>	getWithResponse(String resourceGroupName, String domainName, String topicName, String eventSubscriptionName, com.azure.core.util.Context context)	Get properties of a nested event subscription for a domain topic.
com.azure.core.http.rest.PagedIterable<EventSubscription>	list(String resourceGroupName, String domainName, String topicName)	List all event subscriptions that have been created for a specific domain topic.
com.azure.core.http.rest.PagedIterable<EventSubscription>	list(String resourceGroupName, String domainName, String topicName, String filter, Integer top, com.azure.core.util.Context context)	List all event subscriptions that have been created for a specific domain topic.
EventSubscription	update(String resourceGroupName, String domainName, String topicName, String eventSubscriptionName, EventSubscriptionUpdateParameters eventSubscriptionUpdateParameters)	Update an existing event subscription for a domain topic.
EventSubscription	update(String resourceGroupName, String domainName, String topicName, String eventSubscriptionName, EventSubscriptionUpdateParameters eventSubscriptionUpdateParameters, com.azure.core.util.Context context)	Update an existing event subscription for a domain topic.

Method Detail

get

EventSubscription get(String resourceGroupName,
                      String domainName,
                      String topicName,
                      String eventSubscriptionName)

Get properties of a nested event subscription for a 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.

eventSubscriptionName - Name of the event subscription.

Returns:

properties of a nested event subscription for a domain topic.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getWithResponse

com.azure.core.http.rest.Response<EventSubscription> getWithResponse(String resourceGroupName,
                                                                     String domainName,
                                                                     String topicName,
                                                                     String eventSubscriptionName,
                                                                     com.azure.core.util.Context context)

Get properties of a nested event subscription for a 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.

eventSubscriptionName - Name of the event subscription.

context - The context to associate with this operation.

Returns:

properties of a nested event subscription for a domain topic along with Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createOrUpdate

EventSubscription createOrUpdate(String resourceGroupName,
                                 String domainName,
                                 String topicName,
                                 String eventSubscriptionName,
                                 EventSubscriptionInner eventSubscriptionInfo)

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 top level domain.

topicName - Name of the domain topic.

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

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

Returns:

event Subscription.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createOrUpdate

EventSubscription createOrUpdate(String resourceGroupName,
                                 String domainName,
                                 String topicName,
                                 String eventSubscriptionName,
                                 EventSubscriptionInner eventSubscriptionInfo,
                                 com.azure.core.util.Context context)

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 top level domain.

topicName - Name of the domain topic.

eventSubscriptionName - Name of the event subscription to be created. Event subscription names must be between 3 and 100 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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

delete

void delete(String resourceGroupName,
            String domainName,
            String topicName,
            String eventSubscriptionName)

Delete a nested existing event subscription for a 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.

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

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

delete

void delete(String resourceGroupName,
            String domainName,
            String topicName,
            String eventSubscriptionName,
            com.azure.core.util.Context context)

Delete a nested existing event subscription for a 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.

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

context - The context to associate with this operation.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

update

EventSubscription update(String resourceGroupName,
                         String domainName,
                         String topicName,
                         String eventSubscriptionName,
                         EventSubscriptionUpdateParameters eventSubscriptionUpdateParameters)

Update an existing event subscription for a domain topic.

Parameters:

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

domainName - Name of the domain.

topicName - Name of the topic.

eventSubscriptionName - Name of the event subscription to be updated.

eventSubscriptionUpdateParameters - Updated event subscription information.

Returns:

event Subscription.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

update

EventSubscription update(String resourceGroupName,
                         String domainName,
                         String topicName,
                         String eventSubscriptionName,
                         EventSubscriptionUpdateParameters eventSubscriptionUpdateParameters,
                         com.azure.core.util.Context context)

Update an existing event subscription for a domain topic.

Parameters:

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

domainName - Name of the domain.

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

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getFullUrl

EventSubscriptionFullUrl getFullUrl(String resourceGroupName,
                                    String domainName,
                                    String topicName,
                                    String eventSubscriptionName)

Get the full endpoint URL for a nested event subscription for 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.

eventSubscriptionName - Name of the event subscription.

Returns:

the full endpoint URL for a nested event subscription for domain topic.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getFullUrlWithResponse

com.azure.core.http.rest.Response<EventSubscriptionFullUrl> getFullUrlWithResponse(String resourceGroupName,
                                                                                   String domainName,
                                                                                   String topicName,
                                                                                   String eventSubscriptionName,
                                                                                   com.azure.core.util.Context context)

Get the full endpoint URL for a nested event subscription for 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.

eventSubscriptionName - Name of the event subscription.

context - The context to associate with this operation.

Returns:

the full endpoint URL for a nested event subscription for domain topic along with Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

list

com.azure.core.http.rest.PagedIterable<EventSubscription> list(String resourceGroupName,
                                                               String domainName,
                                                               String topicName)

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

list

com.azure.core.http.rest.PagedIterable<EventSubscription> list(String resourceGroupName,
                                                               String domainName,
                                                               String topicName,
                                                               String filter,
                                                               Integer top,
                                                               com.azure.core.util.Context context)

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getDeliveryAttributes

DeliveryAttributeListResult getDeliveryAttributes(String resourceGroupName,
                                                  String domainName,
                                                  String topicName,
                                                  String eventSubscriptionName)

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

eventSubscriptionName - Name of the event subscription.

Returns:

all delivery attributes for an event subscription for domain topic.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getDeliveryAttributesWithResponse

com.azure.core.http.rest.Response<DeliveryAttributeListResult> getDeliveryAttributesWithResponse(String resourceGroupName,
                                                                                                 String domainName,
                                                                                                 String topicName,
                                                                                                 String eventSubscriptionName,
                                                                                                 com.azure.core.util.Context context)

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

eventSubscriptionName - Name of the event subscription.

context - The context to associate with this operation.

Returns:

all delivery attributes for an event subscription for domain topic along with Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.