Package com.azure.resourcemanager.eventgrid.models

Interface DomainTopics

public interface DomainTopics

Resource collection API of DomainTopics.

Method Summary

Modifier and Type	Method	Description
DomainTopic	createOrUpdate(String resourceGroupName, String domainName, String domainTopicName)	Asynchronously creates or updates a new domain topic with the specified parameters.
DomainTopic	createOrUpdate(String resourceGroupName, String domainName, String domainTopicName, com.azure.core.util.Context context)	Asynchronously creates or updates a new domain topic with the specified parameters.
void	delete(String resourceGroupName, String domainName, String domainTopicName)	Delete existing domain topic.
void	delete(String resourceGroupName, String domainName, String domainTopicName, com.azure.core.util.Context context)	Delete existing domain topic.
DomainTopic	get(String resourceGroupName, String domainName, String domainTopicName)	Get properties of a domain topic.
com.azure.core.http.rest.Response<DomainTopic>	getWithResponse(String resourceGroupName, String domainName, String domainTopicName, com.azure.core.util.Context context)	Get properties of a domain topic.
com.azure.core.http.rest.PagedIterable<DomainTopic>	listByDomain(String resourceGroupName, String domainName)	List all the topics in a domain.
com.azure.core.http.rest.PagedIterable<DomainTopic>	listByDomain(String resourceGroupName, String domainName, String filter, Integer top, com.azure.core.util.Context context)	List all the topics in a domain.

Method Detail

get

DomainTopic get(String resourceGroupName,
                String domainName,
                String domainTopicName)

Get properties of a domain topic.

Parameters:

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

domainName - Name of the domain.

domainTopicName - Name of the topic.

Returns:

properties of 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<DomainTopic> getWithResponse(String resourceGroupName,
                                                               String domainName,
                                                               String domainTopicName,
                                                               com.azure.core.util.Context context)

Get properties of a domain topic.

Parameters:

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

domainName - Name of the domain.

domainTopicName - Name of the topic.

context - The context to associate with this operation.

Returns:

properties of 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

DomainTopic createOrUpdate(String resourceGroupName,
                           String domainName,
                           String domainTopicName)

Asynchronously creates or updates a new domain topic with the specified parameters.

Parameters:

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

domainName - Name of the domain.

domainTopicName - Name of the domain topic.

Returns:

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.

createOrUpdate

DomainTopic createOrUpdate(String resourceGroupName,
                           String domainName,
                           String domainTopicName,
                           com.azure.core.util.Context context)

Asynchronously creates or updates a new domain topic with the specified parameters.

Parameters:

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

domainName - Name of the domain.

domainTopicName - Name of the domain topic.

context - The context to associate with this operation.

Returns:

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.

delete

void delete(String resourceGroupName,
            String domainName,
            String domainTopicName)

Delete existing domain topic.

Parameters:

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

domainName - Name of the domain.

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

delete

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

Delete existing domain topic.

Parameters:

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

domainName - Name of the domain.

domainTopicName - Name of the domain topic.

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.

listByDomain

com.azure.core.http.rest.PagedIterable<DomainTopic> listByDomain(String resourceGroupName,
                                                                 String domainName)

List all the topics in a domain.

Parameters:

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

domainName - Domain name.

Returns:

result of the List Domain Topics 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.

listByDomain

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

List all the topics in a domain.

Parameters:

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

domainName - Domain name.

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 Domain Topics 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.