Package com.azure.resourcemanager.notificationhubs.fluent

Interface NamespacesClient

  • public interface NamespacesClient
    An instance of this class provides access to all the operations defined in NamespacesClient.

    • Method Detail

      • checkAvailability

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

      • createOrUpdate

        NamespaceResourceInner createOrUpdate​(String resourceGroupName,
                                      String namespaceName,
                                      NamespaceCreateOrUpdateParameters parameters)
        Creates/Updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.
        Parameters:
        resourceGroupName - The name of the resource group.
        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.

      • createOrUpdateWithResponse

        com.azure.core.http.rest.Response<NamespaceResourceInner> createOrUpdateWithResponse​(String resourceGroupName,
                                                                                     String namespaceName,
                                                                                     NamespaceCreateOrUpdateParameters parameters,
                                                                                     com.azure.core.util.Context context)
        Creates/Updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.
        Parameters:
        resourceGroupName - The name of the resource group.
        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.

      • patch

        NamespaceResourceInner patch​(String resourceGroupName,
                             String namespaceName,
                             NamespacePatchParameters parameters)
        Patches the existing namespace.
        Parameters:
        resourceGroupName - The name of the resource group.
        namespaceName - The namespace name.
        parameters - Parameters supplied to patch 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.

      • patchWithResponse

        com.azure.core.http.rest.Response<NamespaceResourceInner> patchWithResponse​(String resourceGroupName,
                                                                            String namespaceName,
                                                                            NamespacePatchParameters parameters,
                                                                            com.azure.core.util.Context context)
        Patches the existing namespace.
        Parameters:
        resourceGroupName - The name of the resource group.
        namespaceName - The namespace name.
        parameters - Parameters supplied to patch 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 notificationHubs under the namespace.
        Parameters:
        resourceGroupName - The name of the resource group.
        namespaceName - The namespace name.
        Returns:
        the completion.
        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 notificationHubs under the namespace.
        Parameters:
        resourceGroupName - The name of the resource group.
        namespaceName - The namespace name.
        context - The context to associate with this operation.
        Returns:
        the completion.
        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)
        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

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

      • createOrUpdateAuthorizationRule

        SharedAccessAuthorizationRuleResourceInner createOrUpdateAuthorizationRule​(String resourceGroupName,
                                                                           String namespaceName,
                                                                           String authorizationRuleName,
                                                                           SharedAccessAuthorizationRuleCreateOrUpdateParameters parameters)
        Creates an authorization rule for a namespace.
        Parameters:
        resourceGroupName - The name of the resource group.
        namespaceName - The namespace name.
        authorizationRuleName - Authorization Rule Name.
        parameters - The shared access authorization rule.
        Returns:
        description of a Namespace AuthorizationRules.
        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<SharedAccessAuthorizationRuleResourceInner> createOrUpdateAuthorizationRuleWithResponse​(String resourceGroupName,
                                                                                                                          String namespaceName,
                                                                                                                          String authorizationRuleName,
                                                                                                                          SharedAccessAuthorizationRuleCreateOrUpdateParameters parameters,
                                                                                                                          com.azure.core.util.Context context)
        Creates an authorization rule for a namespace.
        Parameters:
        resourceGroupName - The name of the resource group.
        namespaceName - The namespace name.
        authorizationRuleName - Authorization Rule Name.
        parameters - The shared access authorization rule.
        context - The context to associate with this operation.
        Returns:
        description of a Namespace AuthorizationRules.
        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

        SharedAccessAuthorizationRuleResourceInner 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<SharedAccessAuthorizationRuleResourceInner> 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<NamespaceResourceInner> 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<NamespaceResourceInner> 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<NamespaceResourceInner> 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<NamespaceResourceInner> 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<SharedAccessAuthorizationRuleResourceInner> 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<SharedAccessAuthorizationRuleResourceInner> 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

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

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