Package com.azure.resourcemanager.relay.models

Interface Namespaces

public interface Namespaces
Resource collection API of Namespaces.

  • Method Details

    • checkNameAvailability

      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.
      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<CheckNameAvailabilityResult> 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<RelayNamespace> 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<RelayNamespace> 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<RelayNamespace> 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<RelayNamespace> 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.

    • deleteByResourceGroup

      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.
      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 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

      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.
      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<RelayNamespace> 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.

    • listAuthorizationRules

      com.azure.core.http.rest.PagedIterable<AuthorizationRule> 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<AuthorizationRule> 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.

    • 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

      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.
      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<AuthorizationRule> 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

      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.
      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<AccessKeys> 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

      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.
      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<AccessKeys> 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.

    • getById

      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.
      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<RelayNamespace> 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 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.

    • getAuthorizationRuleById

      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.
      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<AuthorizationRule> getAuthorizationRuleByIdWithResponse(String id, com.azure.core.util.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.
      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 resources 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 resources 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

      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

      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.