DomainsClient Interface

Package:

com.azure.resourcemanager.eventgrid.fluent

Maven Artifact:

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

public interface DomainsClient

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

Method Summary

Modifier and Type	Method and Description
abstract SyncPoller<PollResult<DomainInner>,DomainInner>	beginCreateOrUpdate(String resourceGroupName, String domainName, DomainInner domainInfo) Create or update a domain.
abstract SyncPoller<PollResult<DomainInner>,DomainInner>	beginCreateOrUpdate(String resourceGroupName, String domainName, DomainInner domainInfo, Context context) Create or update a domain.
abstract SyncPoller<PollResult<Void>,Void>	beginDelete(String resourceGroupName, String domainName) Delete a domain.
abstract SyncPoller<PollResult<Void>,Void>	beginDelete(String resourceGroupName, String domainName, Context context) Delete a domain.
abstract SyncPoller<PollResult<DomainInner>,DomainInner>	beginUpdate(String resourceGroupName, String domainName, DomainUpdateParameters domainUpdateParameters) Update a domain.
abstract SyncPoller<PollResult<DomainInner>,DomainInner>	beginUpdate(String resourceGroupName, String domainName, DomainUpdateParameters domainUpdateParameters, Context context) Update a domain.
abstract DomainInner	createOrUpdate(String resourceGroupName, String domainName, DomainInner domainInfo) Create or update a domain.
abstract DomainInner	createOrUpdate(String resourceGroupName, String domainName, DomainInner domainInfo, Context context) Create or update a domain.
abstract void	delete(String resourceGroupName, String domainName) Delete a domain.
abstract void	delete(String resourceGroupName, String domainName, Context context) Delete a domain.
abstract DomainInner	getByResourceGroup(String resourceGroupName, String domainName) Get a domain.
abstract Response<DomainInner>	getByResourceGroupWithResponse(String resourceGroupName, String domainName, Context context) Get a domain.
abstract PagedIterable<DomainInner>	list() List domains under an Azure subscription.
abstract PagedIterable<DomainInner>	list(String filter, Integer top, Context context) List domains under an Azure subscription.
abstract PagedIterable<DomainInner>	listByResourceGroup(String resourceGroupName) List domains under a resource group.
abstract PagedIterable<DomainInner>	listByResourceGroup(String resourceGroupName, String filter, Integer top, Context context) List domains under a resource group.
abstract DomainSharedAccessKeysInner	listSharedAccessKeys(String resourceGroupName, String domainName) List keys for a domain.
abstract Response<DomainSharedAccessKeysInner>	listSharedAccessKeysWithResponse(String resourceGroupName, String domainName, Context context) List keys for a domain.
abstract DomainSharedAccessKeysInner	regenerateKey(String resourceGroupName, String domainName, DomainRegenerateKeyRequest regenerateKeyRequest) Regenerate key for a domain.
abstract Response<DomainSharedAccessKeysInner>	regenerateKeyWithResponse(String resourceGroupName, String domainName, DomainRegenerateKeyRequest regenerateKeyRequest, Context context) Regenerate key for a domain.
abstract DomainInner	update(String resourceGroupName, String domainName, DomainUpdateParameters domainUpdateParameters) Update a domain.
abstract DomainInner	update(String resourceGroupName, String domainName, DomainUpdateParameters domainUpdateParameters, Context context) Update a domain.

Method Details

beginCreateOrUpdate

public abstract SyncPoller,DomainInner> beginCreateOrUpdate(String resourceGroupName, String domainName, DomainInner domainInfo)

Create or update a domain. 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:

the SyncPoller<T,U> for polling of eventGrid Domain.

beginCreateOrUpdate

public abstract SyncPoller,DomainInner> beginCreateOrUpdate(String resourceGroupName, String domainName, DomainInner domainInfo, Context context)

Create or update a domain. 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:

the SyncPoller<T,U> for polling of eventGrid Domain.

beginDelete

public abstract SyncPoller,Void> beginDelete(String resourceGroupName, String domainName)

Delete a domain. Delete existing domain.

Parameters:

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

domainName - Name of the domain.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginDelete

public abstract SyncPoller,Void> beginDelete(String resourceGroupName, String domainName, Context context)

Delete a domain. 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 SyncPoller<T,U> for polling of long-running operation.

beginUpdate

public abstract SyncPoller,DomainInner> beginUpdate(String resourceGroupName, String domainName, DomainUpdateParameters domainUpdateParameters)

Update a domain. 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 SyncPoller<T,U> for polling of long-running operation.

beginUpdate

public abstract SyncPoller,DomainInner> beginUpdate(String resourceGroupName, String domainName, DomainUpdateParameters domainUpdateParameters, Context context)

Update a domain. 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 SyncPoller<T,U> for polling of long-running operation.

createOrUpdate

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

Create or update a domain. 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.

createOrUpdate

public abstract DomainInner createOrUpdate(String resourceGroupName, String domainName, DomainInner domainInfo, Context context)

Create or update a domain. 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.

delete

public abstract void delete(String resourceGroupName, String domainName)

Delete a domain. Delete existing domain.

Parameters:

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

domainName - Name of the domain.

delete

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

Delete a domain. 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.

getByResourceGroup

public abstract DomainInner getByResourceGroup(String resourceGroupName, String domainName)

Get a domain. 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.

getByResourceGroupWithResponse

public abstract Response getByResourceGroupWithResponse(String resourceGroupName, String domainName, Context context)

Get a domain. 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<T>.

list

public abstract PagedIterable list()

List domains under an Azure subscription. List all the domains under an Azure subscription.

Returns:

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

list

public abstract PagedIterable list(String filter, Integer top, Context context)

List domains under an Azure subscription. 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 as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable listByResourceGroup(String resourceGroupName)

List domains under a resource group. 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 as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable listByResourceGroup(String resourceGroupName, String filter, Integer top, Context context)

List domains under a resource group. 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 as paginated response with PagedIterable<T>.

listSharedAccessKeys

public abstract DomainSharedAccessKeysInner listSharedAccessKeys(String resourceGroupName, String domainName)

List keys for a domain. 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.

listSharedAccessKeysWithResponse

public abstract Response listSharedAccessKeysWithResponse(String resourceGroupName, String domainName, Context context)

List keys for a domain. 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<T>.

regenerateKey

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

Regenerate key for a domain. 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.

regenerateKeyWithResponse

public abstract Response regenerateKeyWithResponse(String resourceGroupName, String domainName, DomainRegenerateKeyRequest regenerateKeyRequest, Context context)

Regenerate key for a domain. 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<T>.

update

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

Update a domain. 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.

update

public abstract DomainInner update(String resourceGroupName, String domainName, DomainUpdateParameters domainUpdateParameters, Context context)

Update a domain. 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.

Azure SDK for Java

Preview