Interface NamespacesClient
public interface NamespacesClient
An instance of this class provides access to all the operations defined in NamespacesClient.
-
Method Summary
Modifier and TypeMethodDescriptioncom.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<RelayNamespaceInner>,
RelayNamespaceInner> beginCreateOrUpdate
(String resourceGroupName, String namespaceName, RelayNamespaceInner parameters) Create Azure Relay namespace.com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<RelayNamespaceInner>,
RelayNamespaceInner> beginCreateOrUpdate
(String resourceGroupName, String namespaceName, RelayNamespaceInner parameters, com.azure.core.util.Context context) Create Azure Relay namespace.beginDelete
(String resourceGroupName, String namespaceName) Deletes an existing namespace.beginDelete
(String resourceGroupName, String namespaceName, com.azure.core.util.Context context) Deletes an existing namespace.checkNameAvailability
(CheckNameAvailability parameters) Check the specified namespace name availability.com.azure.core.http.rest.Response<CheckNameAvailabilityResultInner>
checkNameAvailabilityWithResponse
(CheckNameAvailability parameters, com.azure.core.util.Context context) Check the specified namespace name availability.createOrUpdate
(String resourceGroupName, String namespaceName, RelayNamespaceInner parameters) Create Azure Relay namespace.createOrUpdate
(String resourceGroupName, String namespaceName, RelayNamespaceInner parameters, com.azure.core.util.Context context) Create Azure Relay namespace.createOrUpdateAuthorizationRule
(String resourceGroupName, String namespaceName, String authorizationRuleName, AuthorizationRuleInner parameters) Creates or updates an authorization rule for a namespace.com.azure.core.http.rest.Response<AuthorizationRuleInner>
createOrUpdateAuthorizationRuleWithResponse
(String resourceGroupName, String namespaceName, String authorizationRuleName, AuthorizationRuleInner parameters, com.azure.core.util.Context context) Creates or updates an authorization rule for a namespace.void
Deletes an existing namespace.void
Deletes an existing namespace.void
deleteAuthorizationRule
(String resourceGroupName, String namespaceName, String authorizationRuleName) 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.getAuthorizationRule
(String resourceGroupName, String namespaceName, String authorizationRuleName) Authorization rule for a namespace by name.com.azure.core.http.rest.Response<AuthorizationRuleInner>
getAuthorizationRuleWithResponse
(String resourceGroupName, String namespaceName, String authorizationRuleName, com.azure.core.util.Context context) Authorization rule for a namespace by name.getByResourceGroup
(String resourceGroupName, String namespaceName) Returns the description for the specified namespace.com.azure.core.http.rest.Response<RelayNamespaceInner>
getByResourceGroupWithResponse
(String resourceGroupName, String namespaceName, com.azure.core.util.Context context) Returns the description for the specified namespace.com.azure.core.http.rest.PagedIterable<RelayNamespaceInner>
list()
Lists all the available namespaces within the subscription regardless of the resourceGroups.com.azure.core.http.rest.PagedIterable<RelayNamespaceInner>
list
(com.azure.core.util.Context context) Lists all the available namespaces within the subscription regardless of the resourceGroups.com.azure.core.http.rest.PagedIterable<AuthorizationRuleInner>
listAuthorizationRules
(String resourceGroupName, String namespaceName) Authorization rules for a namespace.com.azure.core.http.rest.PagedIterable<AuthorizationRuleInner>
listAuthorizationRules
(String resourceGroupName, String namespaceName, com.azure.core.util.Context context) Authorization rules for a namespace.com.azure.core.http.rest.PagedIterable<RelayNamespaceInner>
listByResourceGroup
(String resourceGroupName) Lists all the available namespaces within the ResourceGroup.com.azure.core.http.rest.PagedIterable<RelayNamespaceInner>
listByResourceGroup
(String resourceGroupName, com.azure.core.util.Context context) Lists all the available namespaces within the ResourceGroup.Primary and secondary connection strings to the namespace.com.azure.core.http.rest.Response<AccessKeysInner>
listKeysWithResponse
(String resourceGroupName, String namespaceName, String authorizationRuleName, com.azure.core.util.Context context) Primary and secondary connection strings to the namespace.regenerateKeys
(String resourceGroupName, String namespaceName, String authorizationRuleName, RegenerateAccessKeyParameters parameters) Regenerates the primary or secondary connection strings to the namespace.com.azure.core.http.rest.Response<AccessKeysInner>
regenerateKeysWithResponse
(String resourceGroupName, String namespaceName, String authorizationRuleName, RegenerateAccessKeyParameters parameters, com.azure.core.util.Context context) Regenerates the primary or secondary connection strings to the namespace.update
(String resourceGroupName, String namespaceName, RelayUpdateParameters parameters) Creates or updates a namespace.com.azure.core.http.rest.Response<RelayNamespaceInner>
updateWithResponse
(String resourceGroupName, String namespaceName, RelayUpdateParameters parameters, com.azure.core.util.Context context) Creates or updates a namespace.
-
Method Details
-
checkNameAvailability
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.
- 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.
-
checkNameAvailabilityWithResponse
com.azure.core.http.rest.Response<CheckNameAvailabilityResultInner> checkNameAvailabilityWithResponse(CheckNameAvailability parameters, com.azure.core.util.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
. - 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<RelayNamespaceInner> 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
. - 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<RelayNamespaceInner> list(com.azure.core.util.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
. - 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<RelayNamespaceInner> 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
. - 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<RelayNamespaceInner> listByResourceGroup(String resourceGroupName, com.azure.core.util.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
. - 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.
-
beginCreateOrUpdate
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<RelayNamespaceInner>,RelayNamespaceInner> beginCreateOrUpdate(String resourceGroupName, String namespaceName, RelayNamespaceInner parameters) Create Azure Relay namespace.- Parameters:
resourceGroupName
- Name of the Resource group within the Azure subscription.namespaceName
- The namespace name.parameters
- Parameters supplied to create a namespace resource.- Returns:
- the
SyncPoller
for polling of 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.
-
beginCreateOrUpdate
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<RelayNamespaceInner>,RelayNamespaceInner> beginCreateOrUpdate(String resourceGroupName, String namespaceName, RelayNamespaceInner parameters, com.azure.core.util.Context context) Create Azure Relay namespace.- Parameters:
resourceGroupName
- Name of the Resource group within the Azure subscription.namespaceName
- The namespace name.parameters
- Parameters supplied to create a namespace resource.context
- The context to associate with this operation.- Returns:
- the
SyncPoller
for polling of 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.
-
createOrUpdate
RelayNamespaceInner createOrUpdate(String resourceGroupName, String namespaceName, RelayNamespaceInner parameters) Create Azure Relay namespace.- Parameters:
resourceGroupName
- Name of the Resource group within the Azure subscription.namespaceName
- The namespace name.parameters
- Parameters supplied to create a namespace resource.- 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.
-
createOrUpdate
RelayNamespaceInner createOrUpdate(String resourceGroupName, String namespaceName, RelayNamespaceInner parameters, com.azure.core.util.Context context) Create Azure Relay namespace.- Parameters:
resourceGroupName
- Name of the Resource group within the Azure subscription.namespaceName
- The namespace name.parameters
- Parameters supplied to create a namespace resource.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.
-
beginDelete
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(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.- Returns:
- the
SyncPoller
for polling of long-running 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.
-
beginDelete
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(String resourceGroupName, String namespaceName, com.azure.core.util.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.- Returns:
- the
SyncPoller
for polling of long-running 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.
-
delete
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.- 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
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.- 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
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.
- 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<RelayNamespaceInner> getByResourceGroupWithResponse(String resourceGroupName, String namespaceName, com.azure.core.util.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
. - 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.
-
update
RelayNamespaceInner update(String resourceGroupName, String namespaceName, RelayUpdateParameters parameters) Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.- Parameters:
resourceGroupName
- Name of the Resource group within the Azure subscription.namespaceName
- The namespace name.parameters
- Parameters for updating a namespace resource.- 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.
-
updateWithResponse
com.azure.core.http.rest.Response<RelayNamespaceInner> updateWithResponse(String resourceGroupName, String namespaceName, RelayUpdateParameters parameters, com.azure.core.util.Context context) Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.- Parameters:
resourceGroupName
- Name of the Resource group within the Azure subscription.namespaceName
- The namespace name.parameters
- Parameters for updating a namespace resource.context
- The context to associate with this operation.- Returns:
- description of a namespace resource along with
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.
-
listAuthorizationRules
com.azure.core.http.rest.PagedIterable<AuthorizationRuleInner> 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
. - 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<AuthorizationRuleInner> listAuthorizationRules(String resourceGroupName, String namespaceName, com.azure.core.util.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
. - 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.
-
createOrUpdateAuthorizationRule
AuthorizationRuleInner createOrUpdateAuthorizationRule(String resourceGroupName, String namespaceName, String authorizationRuleName, AuthorizationRuleInner parameters) Creates or updates an authorization rule for a namespace.- Parameters:
resourceGroupName
- Name of the Resource group within the Azure subscription.namespaceName
- The namespace name.authorizationRuleName
- The authorization rule name.parameters
- The authorization rule parameters.- Returns:
- description of a namespace authorization rule.
- 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.
-
createOrUpdateAuthorizationRuleWithResponse
com.azure.core.http.rest.Response<AuthorizationRuleInner> createOrUpdateAuthorizationRuleWithResponse(String resourceGroupName, String namespaceName, String authorizationRuleName, AuthorizationRuleInner parameters, com.azure.core.util.Context context) Creates or updates an authorization rule for a namespace.- Parameters:
resourceGroupName
- Name of the Resource group within the Azure subscription.namespaceName
- The namespace name.authorizationRuleName
- The authorization rule name.parameters
- The authorization rule parameters.context
- The context to associate with this operation.- Returns:
- description of a namespace authorization rule along with
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.
-
deleteAuthorizationRule
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.- 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
- 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:
- 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
AuthorizationRuleInner 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.
- 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<AuthorizationRuleInner> getAuthorizationRuleWithResponse(String resourceGroupName, String namespaceName, String authorizationRuleName, com.azure.core.util.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
. - 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
AccessKeysInner 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.
- 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<AccessKeysInner> listKeysWithResponse(String resourceGroupName, String namespaceName, String authorizationRuleName, com.azure.core.util.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
. - 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
AccessKeysInner 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.
- 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<AccessKeysInner> regenerateKeysWithResponse(String resourceGroupName, String namespaceName, String authorizationRuleName, RegenerateAccessKeyParameters parameters, com.azure.core.util.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
. - 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.
-