Interface Namespaces
-
public interface Namespaces
Resource collection API of Namespaces.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description CheckAvailabilityResult
checkAvailability(CheckAvailabilityParameters parameters)
Checks the availability of the given service namespace across all Azure subscriptions.com.azure.core.http.rest.Response<CheckAvailabilityResult>
checkAvailabilityWithResponse(CheckAvailabilityParameters parameters, com.azure.core.util.Context context)
Checks the availability of the given service namespace across all Azure subscriptions.NamespaceResource.DefinitionStages.Blank
define(String name)
Begins definition for a new NamespaceResource resource.SharedAccessAuthorizationRuleResource.DefinitionStages.Blank
defineAuthorizationRule(String name)
Begins definition for a new SharedAccessAuthorizationRuleResource resource.void
delete(String resourceGroupName, String namespaceName, com.azure.core.util.Context context)
Deletes an existing namespace.void
deleteAuthorizationRule(String resourceGroupName, String namespaceName, String authorizationRuleName)
Deletes a namespace authorization rule.void
deleteAuthorizationRuleById(String id)
Deletes a namespace authorization rule.com.azure.core.http.rest.Response<Void>
deleteAuthorizationRuleByIdWithResponse(String id, com.azure.core.util.Context context)
Deletes a namespace authorization rule.com.azure.core.http.rest.Response<Void>
deleteAuthorizationRuleWithResponse(String resourceGroupName, String namespaceName, String authorizationRuleName, com.azure.core.util.Context context)
Deletes a namespace authorization rule.void
deleteById(String id)
Deletes an existing namespace.void
deleteByIdWithResponse(String id, com.azure.core.util.Context context)
Deletes an existing namespace.void
deleteByResourceGroup(String resourceGroupName, String namespaceName)
Deletes an existing namespace.SharedAccessAuthorizationRuleResource
getAuthorizationRule(String resourceGroupName, String namespaceName, String authorizationRuleName)
Gets an authorization rule for a namespace by name.SharedAccessAuthorizationRuleResource
getAuthorizationRuleById(String id)
Gets an authorization rule for a namespace by name.com.azure.core.http.rest.Response<SharedAccessAuthorizationRuleResource>
getAuthorizationRuleByIdWithResponse(String id, com.azure.core.util.Context context)
Gets an authorization rule for a namespace by name.com.azure.core.http.rest.Response<SharedAccessAuthorizationRuleResource>
getAuthorizationRuleWithResponse(String resourceGroupName, String namespaceName, String authorizationRuleName, com.azure.core.util.Context context)
Gets an authorization rule for a namespace by name.NamespaceResource
getById(String id)
Returns the description for the specified namespace.com.azure.core.http.rest.Response<NamespaceResource>
getByIdWithResponse(String id, com.azure.core.util.Context context)
Returns the description for the specified namespace.NamespaceResource
getByResourceGroup(String resourceGroupName, String namespaceName)
Returns the description for the specified namespace.com.azure.core.http.rest.Response<NamespaceResource>
getByResourceGroupWithResponse(String resourceGroupName, String namespaceName, com.azure.core.util.Context context)
Returns the description for the specified namespace.com.azure.core.http.rest.PagedIterable<NamespaceResource>
list()
Lists all the available namespaces within the subscription irrespective of the resourceGroups.com.azure.core.http.rest.PagedIterable<NamespaceResource>
list(com.azure.core.util.Context context)
Lists all the available namespaces within the subscription irrespective of the resourceGroups.com.azure.core.http.rest.PagedIterable<SharedAccessAuthorizationRuleResource>
listAuthorizationRules(String resourceGroupName, String namespaceName)
Gets the authorization rules for a namespace.com.azure.core.http.rest.PagedIterable<SharedAccessAuthorizationRuleResource>
listAuthorizationRules(String resourceGroupName, String namespaceName, com.azure.core.util.Context context)
Gets the authorization rules for a namespace.com.azure.core.http.rest.PagedIterable<NamespaceResource>
listByResourceGroup(String resourceGroupName)
Lists the available namespaces within a resourceGroup.com.azure.core.http.rest.PagedIterable<NamespaceResource>
listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context)
Lists the available namespaces within a resourceGroup.ResourceListKeys
listKeys(String resourceGroupName, String namespaceName, String authorizationRuleName)
Gets the Primary and Secondary ConnectionStrings to the namespace.com.azure.core.http.rest.Response<ResourceListKeys>
listKeysWithResponse(String resourceGroupName, String namespaceName, String authorizationRuleName, com.azure.core.util.Context context)
Gets the Primary and Secondary ConnectionStrings to the namespace.ResourceListKeys
regenerateKeys(String resourceGroupName, String namespaceName, String authorizationRuleName, PolicykeyResource parameters)
Regenerates the Primary/Secondary Keys to the Namespace Authorization Rule.com.azure.core.http.rest.Response<ResourceListKeys>
regenerateKeysWithResponse(String resourceGroupName, String namespaceName, String authorizationRuleName, PolicykeyResource parameters, com.azure.core.util.Context context)
Regenerates the Primary/Secondary Keys to the Namespace Authorization Rule.
-
-
-
Method Detail
-
checkAvailability
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
- The namespace name.- Returns:
- description of a CheckAvailability resource.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
checkAvailabilityWithResponse
com.azure.core.http.rest.Response<CheckAvailabilityResult> checkAvailabilityWithResponse(CheckAvailabilityParameters parameters, com.azure.core.util.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
- The namespace name.context
- The context to associate with this operation.- Returns:
- description of a CheckAvailability resource.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
deleteByResourceGroup
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.namespaceName
- The namespace name.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
delete
void delete(String resourceGroupName, String namespaceName, com.azure.core.util.Context context)
Deletes an existing namespace. This operation also removes all associated notificationHubs under the namespace.- Parameters:
resourceGroupName
- The name of the resource group.namespaceName
- The namespace name.context
- The context to associate with this operation.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getByResourceGroup
NamespaceResource getByResourceGroup(String resourceGroupName, String namespaceName)
Returns the description for the specified namespace.- Parameters:
resourceGroupName
- The name of the resource group.namespaceName
- The namespace name.- Returns:
- description of a Namespace resource.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getByResourceGroupWithResponse
com.azure.core.http.rest.Response<NamespaceResource> getByResourceGroupWithResponse(String resourceGroupName, String namespaceName, com.azure.core.util.Context context)
Returns the description for the specified namespace.- Parameters:
resourceGroupName
- The name of the resource group.namespaceName
- The namespace name.context
- The context to associate with this operation.- Returns:
- description of a Namespace resource.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
deleteAuthorizationRule
void deleteAuthorizationRule(String resourceGroupName, String namespaceName, String authorizationRuleName)
Deletes a namespace authorization rule.- Parameters:
resourceGroupName
- The name of the resource group.namespaceName
- The namespace name.authorizationRuleName
- Authorization Rule Name.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
deleteAuthorizationRuleWithResponse
com.azure.core.http.rest.Response<Void> deleteAuthorizationRuleWithResponse(String resourceGroupName, String namespaceName, String authorizationRuleName, com.azure.core.util.Context context)
Deletes a namespace authorization rule.- Parameters:
resourceGroupName
- The name of the resource group.namespaceName
- The namespace name.authorizationRuleName
- Authorization Rule Name.context
- The context to associate with this operation.- Returns:
- the response.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getAuthorizationRule
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.namespaceName
- The namespace name.authorizationRuleName
- Authorization rule name.- Returns:
- an authorization rule for a namespace by name.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getAuthorizationRuleWithResponse
com.azure.core.http.rest.Response<SharedAccessAuthorizationRuleResource> getAuthorizationRuleWithResponse(String resourceGroupName, String namespaceName, String authorizationRuleName, com.azure.core.util.Context context)
Gets an authorization rule for a namespace by name.- Parameters:
resourceGroupName
- The name of the resource group.namespaceName
- The namespace name.authorizationRuleName
- Authorization rule name.context
- The context to associate with this operation.- Returns:
- an authorization rule for a namespace by name.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
listByResourceGroup
com.azure.core.http.rest.PagedIterable<NamespaceResource> listByResourceGroup(String resourceGroupName)
Lists the available namespaces within a resourceGroup.- Parameters:
resourceGroupName
- The name of the resource group. If resourceGroupName value is null the method lists all the namespaces within subscription.- Returns:
- the response of the List Namespace operation.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
listByResourceGroup
com.azure.core.http.rest.PagedIterable<NamespaceResource> listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context)
Lists the available namespaces within a resourceGroup.- Parameters:
resourceGroupName
- The name of the resource group. If resourceGroupName value is null the method lists all the namespaces within subscription.context
- The context to associate with this operation.- Returns:
- the response of the List Namespace operation.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
list
com.azure.core.http.rest.PagedIterable<NamespaceResource> list()
Lists all the available namespaces within the subscription irrespective of the resourceGroups.- Returns:
- the response of the List Namespace operation.
- Throws:
com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
list
com.azure.core.http.rest.PagedIterable<NamespaceResource> list(com.azure.core.util.Context context)
Lists all the available namespaces within the subscription irrespective of the resourceGroups.- Parameters:
context
- The context to associate with this operation.- Returns:
- the response of the List Namespace operation.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
listAuthorizationRules
com.azure.core.http.rest.PagedIterable<SharedAccessAuthorizationRuleResource> listAuthorizationRules(String resourceGroupName, String namespaceName)
Gets the authorization rules for a namespace.- Parameters:
resourceGroupName
- The name of the resource group.namespaceName
- The namespace name.- Returns:
- the authorization rules for a namespace.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
listAuthorizationRules
com.azure.core.http.rest.PagedIterable<SharedAccessAuthorizationRuleResource> listAuthorizationRules(String resourceGroupName, String namespaceName, com.azure.core.util.Context context)
Gets the authorization rules for a namespace.- Parameters:
resourceGroupName
- The name of the resource group.namespaceName
- The namespace name.context
- The context to associate with this operation.- Returns:
- the authorization rules for a namespace.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
listKeys
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.namespaceName
- The namespace name.authorizationRuleName
- The connection string of the namespace for the specified authorizationRule.- Returns:
- the Primary and Secondary ConnectionStrings to the namespace.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
listKeysWithResponse
com.azure.core.http.rest.Response<ResourceListKeys> listKeysWithResponse(String resourceGroupName, String namespaceName, String authorizationRuleName, com.azure.core.util.Context context)
Gets the Primary and Secondary ConnectionStrings to the namespace.- Parameters:
resourceGroupName
- The name of the resource group.namespaceName
- The namespace name.authorizationRuleName
- The connection string of the namespace for the specified authorizationRule.context
- The context to associate with this operation.- Returns:
- the Primary and Secondary ConnectionStrings to the namespace.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
regenerateKeys
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.namespaceName
- The namespace name.authorizationRuleName
- The connection string of the namespace for the specified authorizationRule.parameters
- Parameters supplied to regenerate the Namespace Authorization Rule Key.- Returns:
- namespace/NotificationHub Connection String.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
regenerateKeysWithResponse
com.azure.core.http.rest.Response<ResourceListKeys> regenerateKeysWithResponse(String resourceGroupName, String namespaceName, String authorizationRuleName, PolicykeyResource parameters, com.azure.core.util.Context context)
Regenerates the Primary/Secondary Keys to the Namespace Authorization Rule.- Parameters:
resourceGroupName
- The name of the resource group.namespaceName
- The namespace name.authorizationRuleName
- The connection string of the namespace for the specified authorizationRule.parameters
- Parameters supplied to regenerate the Namespace Authorization Rule Key.context
- The context to associate with this operation.- Returns:
- namespace/NotificationHub Connection String.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getById
NamespaceResource getById(String id)
Returns the description for the specified namespace.- Parameters:
id
- the resource ID.- Returns:
- description of a Namespace resource.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getByIdWithResponse
com.azure.core.http.rest.Response<NamespaceResource> getByIdWithResponse(String id, com.azure.core.util.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.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getAuthorizationRuleById
SharedAccessAuthorizationRuleResource getAuthorizationRuleById(String id)
Gets an authorization rule for a namespace by name.- Parameters:
id
- the resource ID.- Returns:
- an authorization rule for a namespace by name.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getAuthorizationRuleByIdWithResponse
com.azure.core.http.rest.Response<SharedAccessAuthorizationRuleResource> getAuthorizationRuleByIdWithResponse(String id, com.azure.core.util.Context context)
Gets an authorization rule for a namespace by name.- Parameters:
id
- the resource ID.context
- The context to associate with this operation.- Returns:
- an authorization rule for a namespace by name.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
deleteById
void deleteById(String id)
Deletes an existing namespace. This operation also removes all associated notificationHubs under the namespace.- Parameters:
id
- the resource ID.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
deleteByIdWithResponse
void deleteByIdWithResponse(String id, com.azure.core.util.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.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
deleteAuthorizationRuleById
void deleteAuthorizationRuleById(String id)
Deletes a namespace authorization rule.- Parameters:
id
- the resource ID.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
deleteAuthorizationRuleByIdWithResponse
com.azure.core.http.rest.Response<Void> deleteAuthorizationRuleByIdWithResponse(String id, com.azure.core.util.Context context)
Deletes a namespace authorization rule.- Parameters:
id
- the resource ID.context
- The context to associate with this operation.- Returns:
- the response.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
define
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.
-
defineAuthorizationRule
SharedAccessAuthorizationRuleResource.DefinitionStages.Blank defineAuthorizationRule(String name)
Begins definition for a new SharedAccessAuthorizationRuleResource resource.- Parameters:
name
- resource name.- Returns:
- the first stage of the new SharedAccessAuthorizationRuleResource definition.
-
-