Package com.azure.resourcemanager.eventgrid.fluent

Interface DomainsClient

public interface DomainsClient

An instance of this class provides access to all the operations defined in DomainsClient.

Method Summary

Modifier and Type	Method	Description
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<DomainInner>,DomainInner>	beginCreateOrUpdate(String resourceGroupName, String domainName, DomainInner domainInfo)	Asynchronously creates or updates a new domain with the specified parameters.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<DomainInner>,DomainInner>	beginCreateOrUpdate(String resourceGroupName, String domainName, DomainInner domainInfo, com.azure.core.util.Context context)	Asynchronously creates or updates a new domain with the specified parameters.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>	beginDelete(String resourceGroupName, String domainName)	Delete existing domain.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>	beginDelete(String resourceGroupName, String domainName, com.azure.core.util.Context context)	Delete existing domain.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<DomainInner>,DomainInner>	beginUpdate(String resourceGroupName, String domainName, DomainUpdateParameters domainUpdateParameters)	Asynchronously updates a domain with the specified parameters.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<DomainInner>,DomainInner>	beginUpdate(String resourceGroupName, String domainName, DomainUpdateParameters domainUpdateParameters, com.azure.core.util.Context context)	Asynchronously updates a domain with the specified parameters.
DomainInner	createOrUpdate(String resourceGroupName, String domainName, DomainInner domainInfo)	Asynchronously creates or updates a new domain with the specified parameters.
DomainInner	createOrUpdate(String resourceGroupName, String domainName, DomainInner domainInfo, com.azure.core.util.Context context)	Asynchronously creates or updates a new domain with the specified parameters.
void	delete(String resourceGroupName, String domainName)	Delete existing domain.
void	delete(String resourceGroupName, String domainName, com.azure.core.util.Context context)	Delete existing domain.
DomainInner	getByResourceGroup(String resourceGroupName, String domainName)	Get properties of a domain.
com.azure.core.http.rest.Response<DomainInner>	getByResourceGroupWithResponse(String resourceGroupName, String domainName, com.azure.core.util.Context context)	Get properties of a domain.
com.azure.core.http.rest.PagedIterable<DomainInner>	list()	List all the domains under an Azure subscription.
com.azure.core.http.rest.PagedIterable<DomainInner>	list(String filter, Integer top, com.azure.core.util.Context context)	List all the domains under an Azure subscription.
com.azure.core.http.rest.PagedIterable<DomainInner>	listByResourceGroup(String resourceGroupName)	List all the domains under a resource group.
com.azure.core.http.rest.PagedIterable<DomainInner>	listByResourceGroup(String resourceGroupName, String filter, Integer top, com.azure.core.util.Context context)	List all the domains under a resource group.
DomainSharedAccessKeysInner	listSharedAccessKeys(String resourceGroupName, String domainName)	List the two keys used to publish to a domain.
com.azure.core.http.rest.Response<DomainSharedAccessKeysInner>	listSharedAccessKeysWithResponse(String resourceGroupName, String domainName, com.azure.core.util.Context context)	List the two keys used to publish to a domain.
DomainSharedAccessKeysInner	regenerateKey(String resourceGroupName, String domainName, DomainRegenerateKeyRequest regenerateKeyRequest)	Regenerate a shared access key for a domain.
com.azure.core.http.rest.Response<DomainSharedAccessKeysInner>	regenerateKeyWithResponse(String resourceGroupName, String domainName, DomainRegenerateKeyRequest regenerateKeyRequest, com.azure.core.util.Context context)	Regenerate a shared access key for a domain.
DomainInner	update(String resourceGroupName, String domainName, DomainUpdateParameters domainUpdateParameters)	Asynchronously updates a domain with the specified parameters.
DomainInner	update(String resourceGroupName, String domainName, DomainUpdateParameters domainUpdateParameters, com.azure.core.util.Context context)	Asynchronously updates a domain with the specified parameters.

Method Detail

getByResourceGroup

DomainInner getByResourceGroup(String resourceGroupName,
                               String domainName)

Get properties of a domain.

Parameters:

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

domainName - Name of the domain.

Returns:

properties of a domain.

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.

getByResourceGroupWithResponse

com.azure.core.http.rest.Response<DomainInner> getByResourceGroupWithResponse(String resourceGroupName,
                                                                              String domainName,
                                                                              com.azure.core.util.Context context)

Get properties of a domain.

Parameters:

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

domainName - Name of the domain.

context - The context to associate with this operation.

Returns:

properties of a domain 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.

beginCreateOrUpdate

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<DomainInner>,DomainInner> beginCreateOrUpdate(String resourceGroupName,
                                                                                                                                        String domainName,
                                                                                                                                        DomainInner domainInfo)

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

Parameters:

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

domainName - Name of the domain.

domainInfo - Domain information.

Returns:

eventGrid Domain along with Response on successful completion of Mono.

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.

beginCreateOrUpdate

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<DomainInner>,DomainInner> beginCreateOrUpdate(String resourceGroupName,
                                                                                                                                        String domainName,
                                                                                                                                        DomainInner domainInfo,
                                                                                                                                        com.azure.core.util.Context context)

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

Parameters:

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

domainName - Name of the domain.

domainInfo - Domain information.

context - The context to associate with this operation.

Returns:

eventGrid Domain along with Response on successful completion of Mono.

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

DomainInner createOrUpdate(String resourceGroupName,
                           String domainName,
                           DomainInner domainInfo)

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

Parameters:

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

domainName - Name of the domain.

domainInfo - Domain information.

Returns:

eventGrid Domain.

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

DomainInner createOrUpdate(String resourceGroupName,
                           String domainName,
                           DomainInner domainInfo,
                           com.azure.core.util.Context context)

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

Parameters:

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

domainName - Name of the domain.

domainInfo - Domain information.

context - The context to associate with this operation.

Returns:

eventGrid Domain.

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.

beginDelete

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(String resourceGroupName,
                                                                                                                  String domainName)

Delete existing domain.

Parameters:

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

domainName - Name of the domain.

Returns:

the Response on successful completion of Mono.

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.

beginDelete

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(String resourceGroupName,
                                                                                                                  String domainName,
                                                                                                                  com.azure.core.util.Context context)

Delete existing domain.

Parameters:

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

domainName - Name of the domain.

context - The context to associate with this operation.

Returns:

the Response on successful completion of Mono.

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)

Delete existing domain.

Parameters:

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

domainName - Name of the domain.

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,
            com.azure.core.util.Context context)

Delete existing domain.

Parameters:

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

domainName - Name of the domain.

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.

beginUpdate

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<DomainInner>,DomainInner> beginUpdate(String resourceGroupName,
                                                                                                                                String domainName,
                                                                                                                                DomainUpdateParameters domainUpdateParameters)

Asynchronously updates a domain with the specified parameters.

Parameters:

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

domainName - Name of the domain.

domainUpdateParameters - Domain update information.

Returns:

the response body along with Response on successful completion of Mono.

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.

beginUpdate

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<DomainInner>,DomainInner> beginUpdate(String resourceGroupName,
                                                                                                                                String domainName,
                                                                                                                                DomainUpdateParameters domainUpdateParameters,
                                                                                                                                com.azure.core.util.Context context)

Asynchronously updates a domain with the specified parameters.

Parameters:

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

domainName - Name of the domain.

domainUpdateParameters - Domain update information.

context - The context to associate with this operation.

Returns:

the response body along with Response on successful completion of Mono.

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

DomainInner update(String resourceGroupName,
                   String domainName,
                   DomainUpdateParameters domainUpdateParameters)

Asynchronously updates a domain with the specified parameters.

Parameters:

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

domainName - Name of the domain.

domainUpdateParameters - Domain update information.

Returns:

the 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.

update

DomainInner update(String resourceGroupName,
                   String domainName,
                   DomainUpdateParameters domainUpdateParameters,
                   com.azure.core.util.Context context)

Asynchronously updates a domain with the specified parameters.

Parameters:

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

domainName - Name of the domain.

domainUpdateParameters - Domain update information.

context - The context to associate with this operation.

Returns:

the 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<DomainInner> list()

List all the domains under an Azure subscription.

Returns:

result of the List Domains operation.

Throws:

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<DomainInner> list(String filter,
                                                         Integer top,
                                                         com.azure.core.util.Context context)

List all the domains under an Azure subscription.

Parameters:

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 Domains 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.

listByResourceGroup

com.azure.core.http.rest.PagedIterable<DomainInner> listByResourceGroup(String resourceGroupName)

List all the domains under a resource group.

Parameters:

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

Returns:

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

listByResourceGroup

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

List all the domains under a resource group.

Parameters:

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

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 Domains 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.

listSharedAccessKeys

DomainSharedAccessKeysInner listSharedAccessKeys(String resourceGroupName,
                                                 String domainName)

List the two keys used to publish to a domain.

Parameters:

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

domainName - Name of the domain.

Returns:

shared access keys of the Domain.

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.

listSharedAccessKeysWithResponse

com.azure.core.http.rest.Response<DomainSharedAccessKeysInner> listSharedAccessKeysWithResponse(String resourceGroupName,
                                                                                                String domainName,
                                                                                                com.azure.core.util.Context context)

List the two keys used to publish to a domain.

Parameters:

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

domainName - Name of the domain.

context - The context to associate with this operation.

Returns:

shared access keys of the Domain 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.

regenerateKey

DomainSharedAccessKeysInner regenerateKey(String resourceGroupName,
                                          String domainName,
                                          DomainRegenerateKeyRequest regenerateKeyRequest)

Regenerate a shared access key for a domain.

Parameters:

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

domainName - Name of the domain.

regenerateKeyRequest - Request body to regenerate key.

Returns:

shared access keys of the Domain.

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.

regenerateKeyWithResponse

com.azure.core.http.rest.Response<DomainSharedAccessKeysInner> regenerateKeyWithResponse(String resourceGroupName,
                                                                                         String domainName,
                                                                                         DomainRegenerateKeyRequest regenerateKeyRequest,
                                                                                         com.azure.core.util.Context context)

Regenerate a shared access key for a domain.

Parameters:

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

domainName - Name of the domain.

regenerateKeyRequest - Request body to regenerate key.

context - The context to associate with this operation.

Returns:

shared access keys of the Domain 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.