Domains Interface

Package:

com.azure.resourcemanager.eventgrid.models

Maven Artifact:

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

public interface Domains

Resource collection API of Domains.

Method Summary

Modifier and Type	Method and Description
abstract Blank	define(String name) Begins definition for a new Domain resource.
abstract void	delete(String resourceGroupName, String domainName, Context context) Delete a domain.
abstract void	deleteById(String id) Delete a domain.
abstract void	deleteByIdWithResponse(String id, Context context) Delete a domain.
abstract void	deleteByResourceGroup(String resourceGroupName, String domainName) Delete a domain.
abstract Domain	getById(String id) Get a domain.
abstract Response<Domain>	getByIdWithResponse(String id, Context context) Get a domain.
abstract Domain	getByResourceGroup(String resourceGroupName, String domainName) Get a domain.
abstract Response<Domain>	getByResourceGroupWithResponse(String resourceGroupName, String domainName, Context context) Get a domain.
abstract PagedIterable<Domain>	list() List domains under an Azure subscription.
abstract PagedIterable<Domain>	list(String filter, Integer top, Context context) List domains under an Azure subscription.
abstract PagedIterable<Domain>	listByResourceGroup(String resourceGroupName) List domains under a resource group.
abstract PagedIterable<Domain>	listByResourceGroup(String resourceGroupName, String filter, Integer top, Context context) List domains under a resource group.
abstract DomainSharedAccessKeys	listSharedAccessKeys(String resourceGroupName, String domainName) List keys for a domain.
abstract Response<DomainSharedAccessKeys>	listSharedAccessKeysWithResponse(String resourceGroupName, String domainName, Context context) List keys for a domain.
abstract DomainSharedAccessKeys	regenerateKey(String resourceGroupName, String domainName, DomainRegenerateKeyRequest regenerateKeyRequest) Regenerate key for a domain.
abstract Response<DomainSharedAccessKeys>	regenerateKeyWithResponse(String resourceGroupName, String domainName, DomainRegenerateKeyRequest regenerateKeyRequest, Context context) Regenerate key for a domain.

Method Details

define

public abstract Domain.DefinitionStages.Blank define(String name)

Begins definition for a new Domain resource.

Parameters:

name - resource name.

Returns:

the first stage of the new Domain definition.

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.

deleteById

public abstract void deleteById(String id)

Delete a domain. Delete existing domain.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract void deleteByIdWithResponse(String id, Context context)

Delete a domain. Delete existing domain.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

deleteByResourceGroup

public abstract void deleteByResourceGroup(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.

getById

public abstract Domain getById(String id)

Get a domain. Get properties of a domain.

Parameters:

id - the resource ID.

Returns:

properties of a domain along with Response<T>.

getByIdWithResponse

public abstract Response<Domain> getByIdWithResponse(String id, Context context)

Get a domain. Get properties of a domain.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

properties of a domain along with Response<T>.

getByResourceGroup

public abstract Domain 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<Domain> 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<Domain> 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<Domain> 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<Domain> 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<Domain> 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 DomainSharedAccessKeys 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<DomainSharedAccessKeys> 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 DomainSharedAccessKeys 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<DomainSharedAccessKeys> 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>.