Namespaces Interface

Package:

com.azure.resourcemanager.notificationhubs.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-notificationhubs:1.0.0-beta.4

public interface Namespaces

Resource collection API of Namespaces.

Method Summary

Modifier and Type	Method and Description
abstract CheckAvailabilityResult	checkAvailability(CheckAvailabilityParameters parameters) Checks the availability of the given service namespace across all Azure subscriptions.
abstract Response<CheckAvailabilityResult>	checkAvailabilityWithResponse(CheckAvailabilityParameters parameters, Context context) Checks the availability of the given service namespace across all Azure subscriptions.
abstract SharedAccessAuthorizationRuleResource	createOrUpdateAuthorizationRule(String resourceGroupName, String namespaceName, String authorizationRuleName, SharedAccessAuthorizationRuleResourceInner parameters) Creates an authorization rule for a namespace.
abstract Response<SharedAccessAuthorizationRuleResource>	createOrUpdateAuthorizationRuleWithResponse(String resourceGroupName, String namespaceName, String authorizationRuleName, SharedAccessAuthorizationRuleResourceInner parameters, Context context) Creates an authorization rule for a namespace.
abstract Blank	define(String name) Begins definition for a new NamespaceResource resource.
abstract void	deleteAuthorizationRule(String resourceGroupName, String namespaceName, String authorizationRuleName) 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 Response<Void>	deleteByIdWithResponse(String id, Context context) Deletes an existing namespace.
abstract void	deleteByResourceGroup(String resourceGroupName, String namespaceName) Deletes an existing namespace.
abstract Response<Void>	deleteByResourceGroupWithResponse(String resourceGroupName, String namespaceName, Context context) Deletes an existing namespace.
abstract SharedAccessAuthorizationRuleResource	getAuthorizationRule(String resourceGroupName, String namespaceName, String authorizationRuleName) Gets an authorization rule for a namespace by name.
abstract Response<SharedAccessAuthorizationRuleResource>	getAuthorizationRuleWithResponse(String resourceGroupName, String namespaceName, String authorizationRuleName, Context context) Gets an authorization rule for a namespace by name.
abstract NamespaceResource	getById(String id) Returns the given namespace.
abstract Response<NamespaceResource>	getByIdWithResponse(String id, Context context) Returns the given namespace.
abstract NamespaceResource	getByResourceGroup(String resourceGroupName, String namespaceName) Returns the given namespace.
abstract Response<NamespaceResource>	getByResourceGroupWithResponse(String resourceGroupName, String namespaceName, Context context) Returns the given namespace.
abstract PnsCredentialsResource	getPnsCredentials(String resourceGroupName, String namespaceName) Lists the PNS credentials associated with a namespace.
abstract Response<PnsCredentialsResource>	getPnsCredentialsWithResponse(String resourceGroupName, String namespaceName, Context context) Lists the PNS credentials associated with a namespace.
abstract PagedIterable<NamespaceResource>	list() Lists all the available namespaces within the subscription.
abstract PagedIterable<NamespaceResource>	list(String skipToken, Integer top, Context context) Lists all the available namespaces within the subscription.
abstract PagedIterable<SharedAccessAuthorizationRuleResource>	listAuthorizationRules(String resourceGroupName, String namespaceName) Gets the authorization rules for a namespace.
abstract PagedIterable<SharedAccessAuthorizationRuleResource>	listAuthorizationRules(String resourceGroupName, String namespaceName, Context context) Gets the authorization rules for a namespace.
abstract PagedIterable<NamespaceResource>	listByResourceGroup(String resourceGroupName) Lists the available namespaces within a resource group.
abstract PagedIterable<NamespaceResource>	listByResourceGroup(String resourceGroupName, String skipToken, Integer top, Context context) Lists the available namespaces within a resource group.
abstract ResourceListKeys	listKeys(String resourceGroupName, String namespaceName, String authorizationRuleName) Gets the Primary and Secondary ConnectionStrings to the namespace.
abstract Response<ResourceListKeys>	listKeysWithResponse(String resourceGroupName, String namespaceName, String authorizationRuleName, Context context) Gets the Primary and Secondary ConnectionStrings to the namespace.
abstract ResourceListKeys	regenerateKeys(String resourceGroupName, String namespaceName, String authorizationRuleName, PolicyKeyResource parameters) Regenerates the Primary/Secondary Keys to the Namespace Authorization Rule.
abstract Response<ResourceListKeys>	regenerateKeysWithResponse(String resourceGroupName, String namespaceName, String authorizationRuleName, PolicyKeyResource parameters, Context context) Regenerates the Primary/Secondary Keys to the Namespace Authorization Rule.

Method Details

checkAvailability

public abstract CheckAvailabilityResult checkAvailability(CheckAvailabilityParameters parameters)

Checks the availability of the given service namespace across all Azure subscriptions. This is useful because the domain name is created based on the service namespace name.

Parameters:

parameters - Request content.

Returns:

description of a CheckAvailability resource.

checkAvailabilityWithResponse

public abstract Response checkAvailabilityWithResponse(CheckAvailabilityParameters parameters, Context context)

Checks the availability of the given service namespace across all Azure subscriptions. This is useful because the domain name is created based on the service namespace name.

Parameters:

parameters - Request content.

context - The context to associate with this operation.

Returns:

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

createOrUpdateAuthorizationRule

public abstract SharedAccessAuthorizationRuleResource createOrUpdateAuthorizationRule(String resourceGroupName, String namespaceName, String authorizationRuleName, SharedAccessAuthorizationRuleResourceInner parameters)

Creates an authorization rule for a namespace.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

namespaceName - Namespace name.

authorizationRuleName - Authorization Rule Name.

parameters - Request content.

Returns:

response for POST requests that return single SharedAccessAuthorizationRule.

createOrUpdateAuthorizationRuleWithResponse

public abstract Response createOrUpdateAuthorizationRuleWithResponse(String resourceGroupName, String namespaceName, String authorizationRuleName, SharedAccessAuthorizationRuleResourceInner parameters, Context context)

Creates an authorization rule for a namespace.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

namespaceName - Namespace name.

authorizationRuleName - Authorization Rule Name.

parameters - Request content.

context - The context to associate with this operation.

Returns:

response for POST requests that return single SharedAccessAuthorizationRule along with Response<T>.

define

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

Begins definition for a new NamespaceResource resource.

Parameters:

name - resource name.

Returns:

the first stage of the new NamespaceResource definition.

deleteAuthorizationRule

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

Deletes a namespace authorization rule.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

namespaceName - Namespace name.

authorizationRuleName - Authorization Rule Name.

deleteAuthorizationRuleWithResponse

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

Deletes a namespace authorization rule.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

namespaceName - Namespace name.

authorizationRuleName - Authorization Rule Name.

context - The context to associate with this operation.

Returns:

the Response<T>.

deleteById

public abstract void deleteById(String id)

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

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract Response deleteByIdWithResponse(String id, Context context)

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

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

the Response<T>.

deleteByResourceGroup

public abstract void deleteByResourceGroup(String resourceGroupName, String namespaceName)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

namespaceName - Namespace name.

deleteByResourceGroupWithResponse

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

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

namespaceName - Namespace name.

context - The context to associate with this operation.

Returns:

the Response<T>.

getAuthorizationRule

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

Gets an authorization rule for a namespace by name.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

namespaceName - Namespace name.

authorizationRuleName - Authorization Rule Name.

Returns:

an authorization rule for a namespace by name.

getAuthorizationRuleWithResponse

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

Gets an authorization rule for a namespace by name.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

namespaceName - Namespace name.

authorizationRuleName - Authorization Rule Name.

context - The context to associate with this operation.

Returns:

an authorization rule for a namespace by name along with Response<T>.

getById

public abstract NamespaceResource getById(String id)

Returns the given namespace.

Parameters:

id - the resource ID.

Returns:

notification Hubs Namespace Resource along with Response<T>.

getByIdWithResponse

public abstract Response getByIdWithResponse(String id, Context context)

Returns the given namespace.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

notification Hubs Namespace Resource along with Response<T>.

getByResourceGroup

public abstract NamespaceResource getByResourceGroup(String resourceGroupName, String namespaceName)

Returns the given namespace.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

namespaceName - Namespace name.

Returns:

notification Hubs Namespace Resource.

getByResourceGroupWithResponse

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

Returns the given namespace.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

namespaceName - Namespace name.

context - The context to associate with this operation.

Returns:

notification Hubs Namespace Resource along with Response<T>.

getPnsCredentials

public abstract PnsCredentialsResource getPnsCredentials(String resourceGroupName, String namespaceName)

Lists the PNS credentials associated with a namespace.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

namespaceName - Namespace name.

Returns:

description of a NotificationHub PNS Credentials.

getPnsCredentialsWithResponse

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

Lists the PNS credentials associated with a namespace.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

namespaceName - Namespace name.

context - The context to associate with this operation.

Returns:

description of a NotificationHub PNS Credentials along with Response<T>.

list

public abstract PagedIterable list()

Lists all the available namespaces within the subscription.

Returns:

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

list

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

Lists all the available namespaces within the subscription.

Parameters:

skipToken - Skip token for subsequent requests.

top - Maximum number of results to return.

context - The context to associate with this operation.

Returns:

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

listAuthorizationRules

public abstract PagedIterable listAuthorizationRules(String resourceGroupName, String namespaceName)

Gets the authorization rules for a namespace.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

namespaceName - Namespace name.

Returns:

the authorization rules for a namespace as paginated response with PagedIterable<T>.

listAuthorizationRules

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

Gets the authorization rules for a namespace.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

namespaceName - Namespace name.

context - The context to associate with this operation.

Returns:

the authorization rules for a namespace as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable listByResourceGroup(String resourceGroupName)

Lists the available namespaces within a resource group.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

Returns:

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

listByResourceGroup

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

Lists the available namespaces within a resource group.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

skipToken - Skip token for subsequent requests.

top - Maximum number of results to return.

context - The context to associate with this operation.

Returns:

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

listKeys

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

Gets the Primary and Secondary ConnectionStrings to the namespace.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

namespaceName - Namespace name.

authorizationRuleName - Authorization Rule Name.

Returns:

the Primary and Secondary ConnectionStrings to the namespace.

listKeysWithResponse

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

Gets the Primary and Secondary ConnectionStrings to the namespace.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

namespaceName - Namespace name.

authorizationRuleName - Authorization Rule Name.

context - The context to associate with this operation.

Returns:

the Primary and Secondary ConnectionStrings to the namespace along with Response<T>.

regenerateKeys

public abstract ResourceListKeys regenerateKeys(String resourceGroupName, String namespaceName, String authorizationRuleName, PolicyKeyResource parameters)

Regenerates the Primary/Secondary Keys to the Namespace Authorization Rule.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

namespaceName - Namespace name.

authorizationRuleName - Authorization Rule Name.

parameters - Request content.

Returns:

response for the POST request that returns Namespace or NotificationHub access keys (connection strings).

regenerateKeysWithResponse

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

Regenerates the Primary/Secondary Keys to the Namespace Authorization Rule.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

namespaceName - Namespace name.

authorizationRuleName - Authorization Rule Name.

parameters - Request content.

context - The context to associate with this operation.

Returns:

response for the POST request that returns Namespace or NotificationHub access keys (connection strings) along with Response<T>.