Namespaces Interface

public interface Namespaces

Resource collection API of Namespaces.

Method Summary

Modifier and Type Method and Description
abstract CheckNameAvailabilityResult checkNameAvailability(CheckNameAvailability parameters)

Check the specified namespace name availability.

abstract Response<CheckNameAvailabilityResult> checkNameAvailabilityWithResponse(CheckNameAvailability parameters, Context context)

Check the specified namespace name availability.

abstract Blank define(String name)

Begins definition for a new RelayNamespace resource.

abstract Blank defineAuthorizationRule(String name)

Begins definition for a new AuthorizationRule resource.

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

Deletes an existing namespace.

abstract void deleteAuthorizationRule(String resourceGroupName, String namespaceName, String authorizationRuleName)

Deletes a namespace authorization rule.

abstract void deleteAuthorizationRuleById(String id)

Deletes a namespace authorization rule.

abstract Response<Void> deleteAuthorizationRuleByIdWithResponse(String id, Context context)

Deletes a namespace authorization rule.

abstract Response<Void> deleteAuthorizationRuleWithResponse(String resourceGroupName, String namespaceName, String authorizationRuleName, Context context)

Deletes a namespace authorization rule.

abstract void deleteById(String id)

Deletes an existing namespace.

abstract void deleteByIdWithResponse(String id, Context context)

Deletes an existing namespace.

abstract void deleteByResourceGroup(String resourceGroupName, String namespaceName)

Deletes an existing namespace.

abstract AuthorizationRule getAuthorizationRule(String resourceGroupName, String namespaceName, String authorizationRuleName)

Authorization rule for a namespace by name.

abstract AuthorizationRule getAuthorizationRuleById(String id)

Authorization rule for a namespace by name.

abstract Response<AuthorizationRule> getAuthorizationRuleByIdWithResponse(String id, Context context)

Authorization rule for a namespace by name.

abstract Response<AuthorizationRule> getAuthorizationRuleWithResponse(String resourceGroupName, String namespaceName, String authorizationRuleName, Context context)

Authorization rule for a namespace by name.

abstract RelayNamespace getById(String id)

Returns the description for the specified namespace.

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

Returns the description for the specified namespace.

abstract RelayNamespace getByResourceGroup(String resourceGroupName, String namespaceName)

Returns the description for the specified namespace.

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

Returns the description for the specified namespace.

abstract PagedIterable<RelayNamespace> list()

Lists all the available namespaces within the subscription regardless of the resourceGroups.

abstract PagedIterable<RelayNamespace> list(Context context)

Lists all the available namespaces within the subscription regardless of the resourceGroups.

abstract PagedIterable<AuthorizationRule> listAuthorizationRules(String resourceGroupName, String namespaceName)

Authorization rules for a namespace.

abstract PagedIterable<AuthorizationRule> listAuthorizationRules(String resourceGroupName, String namespaceName, Context context)

Authorization rules for a namespace.

abstract PagedIterable<RelayNamespace> listByResourceGroup(String resourceGroupName)

Lists all the available namespaces within the ResourceGroup.

abstract PagedIterable<RelayNamespace> listByResourceGroup(String resourceGroupName, Context context)

Lists all the available namespaces within the ResourceGroup.

abstract AccessKeys listKeys(String resourceGroupName, String namespaceName, String authorizationRuleName)

Primary and secondary connection strings to the namespace.

abstract Response<AccessKeys> listKeysWithResponse(String resourceGroupName, String namespaceName, String authorizationRuleName, Context context)

Primary and secondary connection strings to the namespace.

abstract AccessKeys regenerateKeys(String resourceGroupName, String namespaceName, String authorizationRuleName, RegenerateAccessKeyParameters parameters)

Regenerates the primary or secondary connection strings to the namespace.

abstract Response<AccessKeys> regenerateKeysWithResponse(String resourceGroupName, String namespaceName, String authorizationRuleName, RegenerateAccessKeyParameters parameters, Context context)

Regenerates the primary or secondary connection strings to the namespace.

Method Details

checkNameAvailability

public abstract CheckNameAvailabilityResult checkNameAvailability(CheckNameAvailability parameters)

Check the specified namespace name availability.

Parameters:

parameters - Parameters to check availability of the specified namespace name.

Returns:

description of the check name availability request properties.

checkNameAvailabilityWithResponse

public abstract Response checkNameAvailabilityWithResponse(CheckNameAvailability parameters, Context context)

Check the specified namespace name availability.

Parameters:

parameters - Parameters to check availability of the specified namespace name.
context - The context to associate with this operation.

Returns:

description of the check name availability request properties along with Response<T>.

define

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

Begins definition for a new RelayNamespace resource.

Parameters:

name - resource name.

Returns:

the first stage of the new RelayNamespace definition.

defineAuthorizationRule

public abstract AuthorizationRule.DefinitionStages.Blank defineAuthorizationRule(String name)

Begins definition for a new AuthorizationRule resource.

Parameters:

name - resource name.

Returns:

the first stage of the new AuthorizationRule definition.

delete

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

Deletes an existing namespace. This operation also removes all associated resources under the namespace.

Parameters:

resourceGroupName - Name of the Resource group within the Azure subscription.
namespaceName - The namespace name.
context - The context to associate with this operation.

deleteAuthorizationRule

public abstract void deleteAuthorizationRule(String resourceGroupName, String namespaceName, String authorizationRuleName)

Deletes a namespace authorization rule.

Parameters:

resourceGroupName - Name of the Resource group within the Azure subscription.
namespaceName - The namespace name.
authorizationRuleName - The authorization rule name.

deleteAuthorizationRuleById

public abstract void deleteAuthorizationRuleById(String id)

Deletes a namespace authorization rule.

Parameters:

id - the resource ID.

deleteAuthorizationRuleByIdWithResponse

public abstract Response deleteAuthorizationRuleByIdWithResponse(String id, Context context)

Deletes a namespace authorization rule.

Parameters:

id - the resource ID.
context - The context to associate with this operation.

Returns:

deleteAuthorizationRuleWithResponse

public abstract Response deleteAuthorizationRuleWithResponse(String resourceGroupName, String namespaceName, String authorizationRuleName, Context context)

Deletes a namespace authorization rule.

Parameters:

resourceGroupName - Name of the Resource group within the Azure subscription.
namespaceName - The namespace name.
authorizationRuleName - The authorization rule name.
context - The context to associate with this operation.

Returns:

deleteById

public abstract void deleteById(String id)

Deletes an existing namespace. This operation also removes all associated resources under the namespace.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract void deleteByIdWithResponse(String id, Context context)

Deletes an existing namespace. This operation also removes all associated resources under the namespace.

Parameters:

id - the resource ID.
context - The context to associate with this operation.

deleteByResourceGroup

public abstract void deleteByResourceGroup(String resourceGroupName, String namespaceName)

Deletes an existing namespace. This operation also removes all associated resources under the namespace.

Parameters:

resourceGroupName - Name of the Resource group within the Azure subscription.
namespaceName - The namespace name.

getAuthorizationRule

public abstract AuthorizationRule getAuthorizationRule(String resourceGroupName, String namespaceName, String authorizationRuleName)

Authorization rule for a namespace by name.

Parameters:

resourceGroupName - Name of the Resource group within the Azure subscription.
namespaceName - The namespace name.
authorizationRuleName - The authorization rule name.

Returns:

description of a namespace authorization rule.

getAuthorizationRuleById

public abstract AuthorizationRule getAuthorizationRuleById(String id)

Authorization rule for a namespace by name.

Parameters:

id - the resource ID.

Returns:

description of a namespace authorization rule along with Response<T>.

getAuthorizationRuleByIdWithResponse

public abstract Response getAuthorizationRuleByIdWithResponse(String id, Context context)

Authorization rule for a namespace by name.

Parameters:

id - the resource ID.
context - The context to associate with this operation.

Returns:

description of a namespace authorization rule along with Response<T>.

getAuthorizationRuleWithResponse

public abstract Response getAuthorizationRuleWithResponse(String resourceGroupName, String namespaceName, String authorizationRuleName, Context context)

Authorization rule for a namespace by name.

Parameters:

resourceGroupName - Name of the Resource group within the Azure subscription.
namespaceName - The namespace name.
authorizationRuleName - The authorization rule name.
context - The context to associate with this operation.

Returns:

description of a namespace authorization rule along with Response<T>.

getById

public abstract RelayNamespace getById(String id)

Returns the description for the specified namespace.

Parameters:

id - the resource ID.

Returns:

description of a namespace resource along with Response<T>.

getByIdWithResponse

public abstract Response getByIdWithResponse(String id, Context context)

Returns the description for the specified namespace.

Parameters:

id - the resource ID.
context - The context to associate with this operation.

Returns:

description of a namespace resource along with Response<T>.

getByResourceGroup

public abstract RelayNamespace getByResourceGroup(String resourceGroupName, String namespaceName)

Returns the description for the specified namespace.

Parameters:

resourceGroupName - Name of the Resource group within the Azure subscription.
namespaceName - The namespace name.

Returns:

description of a namespace resource.

getByResourceGroupWithResponse

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

Returns the description for the specified namespace.

Parameters:

resourceGroupName - Name of the Resource group within the Azure subscription.
namespaceName - The namespace name.
context - The context to associate with this operation.

Returns:

description of a namespace resource along with Response<T>.

list

public abstract PagedIterable list()

Lists all the available namespaces within the subscription regardless of the resourceGroups.

Returns:

the response from the list namespace operation as paginated response with PagedIterable<T>.

list

public abstract PagedIterable list(Context context)

Lists all the available namespaces within the subscription regardless of the resourceGroups.

Parameters:

context - The context to associate with this operation.

Returns:

the response from the list namespace operation as paginated response with PagedIterable<T>.

listAuthorizationRules

public abstract PagedIterable listAuthorizationRules(String resourceGroupName, String namespaceName)

Authorization rules for a namespace.

Parameters:

resourceGroupName - Name of the Resource group within the Azure subscription.
namespaceName - The namespace name.

Returns:

the response from the list namespace operation as paginated response with PagedIterable<T>.

listAuthorizationRules

public abstract PagedIterable listAuthorizationRules(String resourceGroupName, String namespaceName, Context context)

Authorization rules for a namespace.

Parameters:

resourceGroupName - Name of the Resource group within the Azure subscription.
namespaceName - The namespace name.
context - The context to associate with this operation.

Returns:

the response from the list namespace operation as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable listByResourceGroup(String resourceGroupName)

Lists all the available namespaces within the ResourceGroup.

Parameters:

resourceGroupName - Name of the Resource group within the Azure subscription.

Returns:

the response from the list namespace operation as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable listByResourceGroup(String resourceGroupName, Context context)

Lists all the available namespaces within the ResourceGroup.

Parameters:

resourceGroupName - Name of the Resource group within the Azure subscription.
context - The context to associate with this operation.

Returns:

the response from the list namespace operation as paginated response with PagedIterable<T>.

listKeys

public abstract AccessKeys listKeys(String resourceGroupName, String namespaceName, String authorizationRuleName)

Primary and secondary connection strings to the namespace.

Parameters:

resourceGroupName - Name of the Resource group within the Azure subscription.
namespaceName - The namespace name.
authorizationRuleName - The authorization rule name.

Returns:

namespace/Relay Connection String.

listKeysWithResponse

public abstract Response listKeysWithResponse(String resourceGroupName, String namespaceName, String authorizationRuleName, Context context)

Primary and secondary connection strings to the namespace.

Parameters:

resourceGroupName - Name of the Resource group within the Azure subscription.
namespaceName - The namespace name.
authorizationRuleName - The authorization rule name.
context - The context to associate with this operation.

Returns:

namespace/Relay Connection String along with Response<T>.

regenerateKeys

public abstract AccessKeys regenerateKeys(String resourceGroupName, String namespaceName, String authorizationRuleName, RegenerateAccessKeyParameters parameters)

Regenerates the primary or secondary connection strings to the namespace.

Parameters:

resourceGroupName - Name of the Resource group within the Azure subscription.
namespaceName - The namespace name.
authorizationRuleName - The authorization rule name.
parameters - Parameters supplied to regenerate authorization rule.

Returns:

namespace/Relay Connection String.

regenerateKeysWithResponse

public abstract Response regenerateKeysWithResponse(String resourceGroupName, String namespaceName, String authorizationRuleName, RegenerateAccessKeyParameters parameters, Context context)

Regenerates the primary or secondary connection strings to the namespace.

Parameters:

resourceGroupName - Name of the Resource group within the Azure subscription.
namespaceName - The namespace name.
authorizationRuleName - The authorization rule name.
parameters - Parameters supplied to regenerate authorization rule.
context - The context to associate with this operation.

Returns:

namespace/Relay Connection String along with Response<T>.

Applies to