Package com.azure.resourcemanager.notificationhubs.fluent

Interface NotificationHubsClient

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

    • Method Detail

      • checkNotificationHubAvailability

        CheckAvailabilityResultInner checkNotificationHubAvailability​(String resourceGroupName,
                                                              String namespaceName,
                                                              CheckAvailabilityParameters parameters)
        Checks the availability of the given notificationHub in a namespace.
        Parameters:
        resourceGroupName - The name of the resource group.
        namespaceName - The namespace name.
        parameters - The notificationHub 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.

      • checkNotificationHubAvailabilityWithResponse

        com.azure.core.http.rest.Response<CheckAvailabilityResultInner> checkNotificationHubAvailabilityWithResponse​(String resourceGroupName,
                                                                                                             String namespaceName,
                                                                                                             CheckAvailabilityParameters parameters,
                                                                                                             com.azure.core.util.Context context)
        Checks the availability of the given notificationHub in a namespace.
        Parameters:
        resourceGroupName - The name of the resource group.
        namespaceName - The namespace name.
        parameters - The notificationHub 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

        NotificationHubResourceInner createOrUpdate​(String resourceGroupName,
                                            String namespaceName,
                                            String notificationHubName,
                                            NotificationHubCreateOrUpdateParameters parameters)
        Creates/Update a NotificationHub in a namespace.
        Parameters:
        resourceGroupName - The name of the resource group.
        namespaceName - The namespace name.
        notificationHubName - The notification hub name.
        parameters - Parameters supplied to the create/update a NotificationHub Resource.
        Returns:
        description of a NotificationHub 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<NotificationHubResourceInner> createOrUpdateWithResponse​(String resourceGroupName,
                                                                                           String namespaceName,
                                                                                           String notificationHubName,
                                                                                           NotificationHubCreateOrUpdateParameters parameters,
                                                                                           com.azure.core.util.Context context)
        Creates/Update a NotificationHub in a namespace.
        Parameters:
        resourceGroupName - The name of the resource group.
        namespaceName - The namespace name.
        notificationHubName - The notification hub name.
        parameters - Parameters supplied to the create/update a NotificationHub Resource.
        context - The context to associate with this operation.
        Returns:
        description of a NotificationHub 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

        NotificationHubResourceInner patch​(String resourceGroupName,
                                   String namespaceName,
                                   String notificationHubName)
        Patch a NotificationHub in a namespace.
        Parameters:
        resourceGroupName - The name of the resource group.
        namespaceName - The namespace name.
        notificationHubName - The notification hub name.
        Returns:
        description of a NotificationHub 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<NotificationHubResourceInner> patchWithResponse​(String resourceGroupName,
                                                                                  String namespaceName,
                                                                                  String notificationHubName,
                                                                                  NotificationHubPatchParameters parameters,
                                                                                  com.azure.core.util.Context context)
        Patch a NotificationHub in a namespace.
        Parameters:
        resourceGroupName - The name of the resource group.
        namespaceName - The namespace name.
        notificationHubName - The notification hub name.
        parameters - Parameters supplied to patch a NotificationHub Resource.
        context - The context to associate with this operation.
        Returns:
        description of a NotificationHub 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.

      • delete

        void delete​(String resourceGroupName,
            String namespaceName,
            String notificationHubName)
        Deletes a notification hub associated with a namespace.
        Parameters:
        resourceGroupName - The name of the resource group.
        namespaceName - The namespace name.
        notificationHubName - The notification hub 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.

      • deleteWithResponse

        com.azure.core.http.rest.Response<Void> deleteWithResponse​(String resourceGroupName,
                                                           String namespaceName,
                                                           String notificationHubName,
                                                           com.azure.core.util.Context context)
        Deletes a notification hub associated with a namespace.
        Parameters:
        resourceGroupName - The name of the resource group.
        namespaceName - The namespace name.
        notificationHubName - The notification hub 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.

      • get

        NotificationHubResourceInner get​(String resourceGroupName,
                                 String namespaceName,
                                 String notificationHubName)
        Lists the notification hubs associated with a namespace.
        Parameters:
        resourceGroupName - The name of the resource group.
        namespaceName - The namespace name.
        notificationHubName - The notification hub name.
        Returns:
        description of a NotificationHub 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.

      • getWithResponse

        com.azure.core.http.rest.Response<NotificationHubResourceInner> getWithResponse​(String resourceGroupName,
                                                                                String namespaceName,
                                                                                String notificationHubName,
                                                                                com.azure.core.util.Context context)
        Lists the notification hubs associated with a namespace.
        Parameters:
        resourceGroupName - The name of the resource group.
        namespaceName - The namespace name.
        notificationHubName - The notification hub name.
        context - The context to associate with this operation.
        Returns:
        description of a NotificationHub 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.

      • debugSend

        DebugSendResponseInner debugSend​(String resourceGroupName,
                                 String namespaceName,
                                 String notificationHubName)
        test send a push notification.
        Parameters:
        resourceGroupName - The name of the resource group.
        namespaceName - The namespace name.
        notificationHubName - The notification hub name.
        Returns:
        description of a NotificationHub 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.

      • debugSendWithResponse

        com.azure.core.http.rest.Response<DebugSendResponseInner> debugSendWithResponse​(String resourceGroupName,
                                                                                String namespaceName,
                                                                                String notificationHubName,
                                                                                Object parameters,
                                                                                com.azure.core.util.Context context)
        test send a push notification.
        Parameters:
        resourceGroupName - The name of the resource group.
        namespaceName - The namespace name.
        notificationHubName - The notification hub name.
        parameters - Debug send parameters.
        context - The context to associate with this operation.
        Returns:
        description of a NotificationHub 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 notificationHubName,
                                                                           String authorizationRuleName,
                                                                           SharedAccessAuthorizationRuleCreateOrUpdateParameters parameters)
        Creates/Updates an authorization rule for a NotificationHub.
        Parameters:
        resourceGroupName - The name of the resource group.
        namespaceName - The namespace name.
        notificationHubName - The notification hub 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 notificationHubName,
                                                                                                                          String authorizationRuleName,
                                                                                                                          SharedAccessAuthorizationRuleCreateOrUpdateParameters parameters,
                                                                                                                          com.azure.core.util.Context context)
        Creates/Updates an authorization rule for a NotificationHub.
        Parameters:
        resourceGroupName - The name of the resource group.
        namespaceName - The namespace name.
        notificationHubName - The notification hub 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 notificationHubName,
                             String authorizationRuleName)
        Deletes a notificationHub authorization rule.
        Parameters:
        resourceGroupName - The name of the resource group.
        namespaceName - The namespace name.
        notificationHubName - The notification hub 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 notificationHubName,
                                                                            String authorizationRuleName,
                                                                            com.azure.core.util.Context context)
        Deletes a notificationHub authorization rule.
        Parameters:
        resourceGroupName - The name of the resource group.
        namespaceName - The namespace name.
        notificationHubName - The notification hub 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 notificationHubName,
                                                                String authorizationRuleName)
        Gets an authorization rule for a NotificationHub by name.
        Parameters:
        resourceGroupName - The name of the resource group.
        namespaceName - The namespace name.
        notificationHubName - The notification hub name.
        authorizationRuleName - authorization rule name.
        Returns:
        an authorization rule for a NotificationHub 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 notificationHubName,
                                                                                                               String authorizationRuleName,
                                                                                                               com.azure.core.util.Context context)
        Gets an authorization rule for a NotificationHub by name.
        Parameters:
        resourceGroupName - The name of the resource group.
        namespaceName - The namespace name.
        notificationHubName - The notification hub name.
        authorizationRuleName - authorization rule name.
        context - The context to associate with this operation.
        Returns:
        an authorization rule for a NotificationHub 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.

      • list

        com.azure.core.http.rest.PagedIterable<NotificationHubResourceInner> list​(String resourceGroupName,
                                                                          String namespaceName)
        Lists the notification hubs associated with a namespace.
        Parameters:
        resourceGroupName - The name of the resource group.
        namespaceName - The namespace name.
        Returns:
        the response of the List NotificationHub 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<NotificationHubResourceInner> list​(String resourceGroupName,
                                                                          String namespaceName,
                                                                          com.azure.core.util.Context context)
        Lists the notification hubs associated with a namespace.
        Parameters:
        resourceGroupName - The name of the resource group.
        namespaceName - The namespace name.
        context - The context to associate with this operation.
        Returns:
        the response of the List NotificationHub 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,
                                                                                                          String notificationHubName)
        Gets the authorization rules for a NotificationHub.
        Parameters:
        resourceGroupName - The name of the resource group.
        namespaceName - The namespace name.
        notificationHubName - The notification hub name.
        Returns:
        the authorization rules for a NotificationHub.
        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,
                                                                                                          String notificationHubName,
                                                                                                          com.azure.core.util.Context context)
        Gets the authorization rules for a NotificationHub.
        Parameters:
        resourceGroupName - The name of the resource group.
        namespaceName - The namespace name.
        notificationHubName - The notification hub name.
        context - The context to associate with this operation.
        Returns:
        the authorization rules for a NotificationHub.
        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 notificationHubName,
                               String authorizationRuleName)
        Gets the Primary and Secondary ConnectionStrings to the NotificationHub.
        Parameters:
        resourceGroupName - The name of the resource group.
        namespaceName - The namespace name.
        notificationHubName - The notification hub name.
        authorizationRuleName - The connection string of the NotificationHub for the specified authorizationRule.
        Returns:
        the Primary and Secondary ConnectionStrings to the NotificationHub.
        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 notificationHubName,
                                                                              String authorizationRuleName,
                                                                              com.azure.core.util.Context context)
        Gets the Primary and Secondary ConnectionStrings to the NotificationHub.
        Parameters:
        resourceGroupName - The name of the resource group.
        namespaceName - The namespace name.
        notificationHubName - The notification hub name.
        authorizationRuleName - The connection string of the NotificationHub for the specified authorizationRule.
        context - The context to associate with this operation.
        Returns:
        the Primary and Secondary ConnectionStrings to the NotificationHub.
        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 notificationHubName,
                                     String authorizationRuleName,
                                     PolicykeyResource parameters)
        Regenerates the Primary/Secondary Keys to the NotificationHub Authorization Rule.
        Parameters:
        resourceGroupName - The name of the resource group.
        namespaceName - The namespace name.
        notificationHubName - The notification hub name.
        authorizationRuleName - The connection string of the NotificationHub for the specified authorizationRule.
        parameters - Parameters supplied to regenerate the NotificationHub 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 notificationHubName,
                                                                                    String authorizationRuleName,
                                                                                    PolicykeyResource parameters,
                                                                                    com.azure.core.util.Context context)
        Regenerates the Primary/Secondary Keys to the NotificationHub Authorization Rule.
        Parameters:
        resourceGroupName - The name of the resource group.
        namespaceName - The namespace name.
        notificationHubName - The notification hub name.
        authorizationRuleName - The connection string of the NotificationHub for the specified authorizationRule.
        parameters - Parameters supplied to regenerate the NotificationHub 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.

      • getPnsCredentials

        PnsCredentialsResourceInner getPnsCredentials​(String resourceGroupName,
                                              String namespaceName,
                                              String notificationHubName)
        Lists the PNS Credentials associated with a notification hub .
        Parameters:
        resourceGroupName - The name of the resource group.
        namespaceName - The namespace name.
        notificationHubName - The notification hub name.
        Returns:
        description of a NotificationHub PNS Credentials.
        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.

      • getPnsCredentialsWithResponse

        com.azure.core.http.rest.Response<PnsCredentialsResourceInner> getPnsCredentialsWithResponse​(String resourceGroupName,
                                                                                             String namespaceName,
                                                                                             String notificationHubName,
                                                                                             com.azure.core.util.Context context)
        Lists the PNS Credentials associated with a notification hub .
        Parameters:
        resourceGroupName - The name of the resource group.
        namespaceName - The namespace name.
        notificationHubName - The notification hub name.
        context - The context to associate with this operation.
        Returns:
        description of a NotificationHub PNS Credentials.
        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.