Namespaces Interface

Package:

com.azure.resourcemanager.eventgrid.models

Maven Artifact:

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

public interface Namespaces

Resource collection API of Namespaces.

Method Summary

Modifier and Type	Method and Description
abstract Blank	define(String name) Begins definition for a new Namespace resource.
abstract void	delete(String resourceGroupName, String namespaceName, Context context) Delete a namespace.
abstract void	deleteById(String id) Delete a namespace.
abstract void	deleteByIdWithResponse(String id, Context context) Delete a namespace.
abstract void	deleteByResourceGroup(String resourceGroupName, String namespaceName) Delete a namespace.
abstract Namespace	getById(String id) Get a namespace.
abstract Response<Namespace>	getByIdWithResponse(String id, Context context) Get a namespace.
abstract Namespace	getByResourceGroup(String resourceGroupName, String namespaceName) Get a namespace.
abstract Response<Namespace>	getByResourceGroupWithResponse(String resourceGroupName, String namespaceName, Context context) Get a namespace.
abstract PagedIterable<Namespace>	list() List namespaces under an Azure subscription.
abstract PagedIterable<Namespace>	list(String filter, Integer top, Context context) List namespaces under an Azure subscription.
abstract PagedIterable<Namespace>	listByResourceGroup(String resourceGroupName) List namespaces under a resource group.
abstract PagedIterable<Namespace>	listByResourceGroup(String resourceGroupName, String filter, Integer top, Context context) List namespaces under a resource group.
abstract NamespaceSharedAccessKeys	listSharedAccessKeys(String resourceGroupName, String namespaceName) List keys for a namespace.
abstract Response<NamespaceSharedAccessKeys>	listSharedAccessKeysWithResponse(String resourceGroupName, String namespaceName, Context context) List keys for a namespace.
abstract NamespaceSharedAccessKeys	regenerateKey(String resourceGroupName, String namespaceName, NamespaceRegenerateKeyRequest regenerateKeyRequest) Regenerate key for a namespace.
abstract NamespaceSharedAccessKeys	regenerateKey(String resourceGroupName, String namespaceName, NamespaceRegenerateKeyRequest regenerateKeyRequest, Context context) Regenerate key for a namespace.
abstract CustomDomainOwnershipValidationResult	validateCustomDomainOwnership(String resourceGroupName, String namespaceName) Validate ownership for all custom domains in a namespace.
abstract CustomDomainOwnershipValidationResult	validateCustomDomainOwnership(String resourceGroupName, String namespaceName, Context context) Validate ownership for all custom domains in a namespace.

Method Details

define

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

Begins definition for a new Namespace resource.

Parameters:

name - resource name.

Returns:

the first stage of the new Namespace definition.

delete

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

Delete a namespace. Delete existing namespace.

Parameters:

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

namespaceName - Name of the namespace.

context - The context to associate with this operation.

deleteById

public abstract void deleteById(String id)

Delete a namespace. Delete existing namespace.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract void deleteByIdWithResponse(String id, Context context)

Delete a namespace. Delete existing namespace.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

deleteByResourceGroup

public abstract void deleteByResourceGroup(String resourceGroupName, String namespaceName)

Delete a namespace. Delete existing namespace.

Parameters:

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

namespaceName - Name of the namespace.

getById

public abstract Namespace getById(String id)

Get a namespace. Get properties of a namespace.

Parameters:

id - the resource ID.

Returns:

properties of a namespace along with Response<T>.

getByIdWithResponse

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

Get a namespace. Get properties of a namespace.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

properties of a namespace along with Response<T>.

getByResourceGroup

public abstract Namespace getByResourceGroup(String resourceGroupName, String namespaceName)

Get a namespace. Get properties of a namespace.

Parameters:

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

namespaceName - Name of the namespace.

Returns:

properties of a namespace.

getByResourceGroupWithResponse

public abstract Response<Namespace> getByResourceGroupWithResponse(String resourceGroupName, String namespaceName, Context context)

Get a namespace. Get properties of a namespace.

Parameters:

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

namespaceName - Name of the namespace.

context - The context to associate with this operation.

Returns:

properties of a namespace along with Response<T>.

list

public abstract PagedIterable<Namespace> list()

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

Returns:

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

list

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

List namespaces under an Azure subscription. List all the namespaces 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 Namespaces operation as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<Namespace> listByResourceGroup(String resourceGroupName)

List namespaces under a resource group. List all the namespaces under a resource group.

Parameters:

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

Returns:

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

listByResourceGroup

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

List namespaces under a resource group. List all the namespaces 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 Namespaces operation as paginated response with PagedIterable<T>.

listSharedAccessKeys

public abstract NamespaceSharedAccessKeys listSharedAccessKeys(String resourceGroupName, String namespaceName)

List keys for a namespace. List the two keys used to publish to a namespace.

Parameters:

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

namespaceName - Name of the namespace.

Returns:

shared access keys of the Namespace.

listSharedAccessKeysWithResponse

public abstract Response<NamespaceSharedAccessKeys> listSharedAccessKeysWithResponse(String resourceGroupName, String namespaceName, Context context)

List keys for a namespace. List the two keys used to publish to a namespace.

Parameters:

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

namespaceName - Name of the namespace.

context - The context to associate with this operation.

Returns:

shared access keys of the Namespace along with Response<T>.

regenerateKey

public abstract NamespaceSharedAccessKeys regenerateKey(String resourceGroupName, String namespaceName, NamespaceRegenerateKeyRequest regenerateKeyRequest)

Regenerate key for a namespace. Regenerate a shared access key for a namespace.

Parameters:

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

namespaceName - Name of the Namespace.

regenerateKeyRequest - Request body to regenerate key.

Returns:

shared access keys of the Namespace.

regenerateKey

public abstract NamespaceSharedAccessKeys regenerateKey(String resourceGroupName, String namespaceName, NamespaceRegenerateKeyRequest regenerateKeyRequest, Context context)

Regenerate key for a namespace. Regenerate a shared access key for a namespace.

Parameters:

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

namespaceName - Name of the Namespace.

regenerateKeyRequest - Request body to regenerate key.

context - The context to associate with this operation.

Returns:

shared access keys of the Namespace.

validateCustomDomainOwnership

public abstract CustomDomainOwnershipValidationResult validateCustomDomainOwnership(String resourceGroupName, String namespaceName)

Validate ownership for all custom domains in a namespace. Performs ownership validation via checking TXT records for all custom domains in a namespace.

Parameters:

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

namespaceName - Name of the Namespace.

Returns:

namespace custom domain ownership validation result.

validateCustomDomainOwnership

public abstract CustomDomainOwnershipValidationResult validateCustomDomainOwnership(String resourceGroupName, String namespaceName, Context context)

Validate ownership for all custom domains in a namespace. Performs ownership validation via checking TXT records for all custom domains in a namespace.

Parameters:

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

namespaceName - Name of the Namespace.

context - The context to associate with this operation.

Returns:

namespace custom domain ownership validation result.