Interface SignalRsClient


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

      • checkNameAvailability

        NameAvailabilityInner checkNameAvailability​(String location,
                                                    NameAvailabilityParameters parameters)
        Checks that the resource name is valid and is not already in use.
        Parameters:
        location - the region.
        parameters - Parameters supplied to the operation.
        Returns:
        result of the request to check name availability.
        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<NameAvailabilityInner> checkNameAvailabilityWithResponse​(String location,
                                                                                                   NameAvailabilityParameters parameters,
                                                                                                   com.azure.core.util.Context context)
        Checks that the resource name is valid and is not already in use.
        Parameters:
        location - the region.
        parameters - Parameters supplied to the operation.
        context - The context to associate with this operation.
        Returns:
        result of the request to check name availability 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<SignalRResourceInner> list()
        Handles requests to list all resources in a subscription.
        Returns:
        object that includes an array of resources and a possible link for next set 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<SignalRResourceInner> list​(com.azure.core.util.Context context)
        Handles requests to list all resources in a subscription.
        Parameters:
        context - The context to associate with this operation.
        Returns:
        object that includes an array of resources and a possible link for next set 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<SignalRResourceInner> listByResourceGroup​(String resourceGroupName)
        Handles requests to list all resources in a resource group.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        Returns:
        object that includes an array of resources and a possible link for next set 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<SignalRResourceInner> listByResourceGroup​(String resourceGroupName,
                                                                                         com.azure.core.util.Context context)
        Handles requests to list all resources in a resource group.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        context - The context to associate with this operation.
        Returns:
        object that includes an array of resources and a possible link for next set 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.
      • getByResourceGroup

        SignalRResourceInner getByResourceGroup​(String resourceGroupName,
                                                String resourceName)
        Get the resource and its properties.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        resourceName - The name of the resource.
        Returns:
        the resource and its 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.
      • getByResourceGroupWithResponse

        com.azure.core.http.rest.Response<SignalRResourceInner> getByResourceGroupWithResponse​(String resourceGroupName,
                                                                                               String resourceName,
                                                                                               com.azure.core.util.Context context)
        Get the resource and its properties.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        resourceName - The name of the resource.
        context - The context to associate with this operation.
        Returns:
        the resource and its 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.
      • beginCreateOrUpdate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<SignalRResourceInner>,​SignalRResourceInner> beginCreateOrUpdate​(String resourceGroupName,
                                                                                                                                                                  String resourceName,
                                                                                                                                                                  SignalRResourceInner parameters)
        Create or update a resource.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        resourceName - The name of the resource.
        parameters - Parameters for the create or update operation.
        Returns:
        the SyncPoller for polling of a class represent a 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<SignalRResourceInner>,​SignalRResourceInner> beginCreateOrUpdate​(String resourceGroupName,
                                                                                                                                                                  String resourceName,
                                                                                                                                                                  SignalRResourceInner parameters,
                                                                                                                                                                  com.azure.core.util.Context context)
        Create or update a resource.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        resourceName - The name of the resource.
        parameters - Parameters for the create or update operation.
        context - The context to associate with this operation.
        Returns:
        the SyncPoller for polling of a class represent a 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

        SignalRResourceInner createOrUpdate​(String resourceGroupName,
                                            String resourceName,
                                            SignalRResourceInner parameters)
        Create or update a resource.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        resourceName - The name of the resource.
        parameters - Parameters for the create or update operation.
        Returns:
        a class represent a 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

        SignalRResourceInner createOrUpdate​(String resourceGroupName,
                                            String resourceName,
                                            SignalRResourceInner parameters,
                                            com.azure.core.util.Context context)
        Create or update a resource.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        resourceName - The name of the resource.
        parameters - Parameters for the create or update operation.
        context - The context to associate with this operation.
        Returns:
        a class represent a 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 resourceName)
        Operation to delete a resource.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        resourceName - The name of the resource.
        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 resourceName,
                                                                                                                          com.azure.core.util.Context context)
        Operation to delete a resource.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        resourceName - The name of the resource.
        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

        void delete​(String resourceGroupName,
                    String resourceName)
        Operation to delete a resource.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        resourceName - The name of the 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 resourceName,
                    com.azure.core.util.Context context)
        Operation to delete a resource.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        resourceName - The name of the resource.
        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.
      • beginUpdate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<SignalRResourceInner>,​SignalRResourceInner> beginUpdate​(String resourceGroupName,
                                                                                                                                                          String resourceName,
                                                                                                                                                          SignalRResourceInner parameters)
        Operation to update an exiting resource.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        resourceName - The name of the resource.
        parameters - Parameters for the update operation.
        Returns:
        the SyncPoller for polling of a class represent a 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.
      • beginUpdate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<SignalRResourceInner>,​SignalRResourceInner> beginUpdate​(String resourceGroupName,
                                                                                                                                                          String resourceName,
                                                                                                                                                          SignalRResourceInner parameters,
                                                                                                                                                          com.azure.core.util.Context context)
        Operation to update an exiting resource.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        resourceName - The name of the resource.
        parameters - Parameters for the update operation.
        context - The context to associate with this operation.
        Returns:
        the SyncPoller for polling of a class represent a 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.
      • update

        SignalRResourceInner update​(String resourceGroupName,
                                    String resourceName,
                                    SignalRResourceInner parameters)
        Operation to update an exiting resource.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        resourceName - The name of the resource.
        parameters - Parameters for the update operation.
        Returns:
        a class represent a 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.
      • update

        SignalRResourceInner update​(String resourceGroupName,
                                    String resourceName,
                                    SignalRResourceInner parameters,
                                    com.azure.core.util.Context context)
        Operation to update an exiting resource.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        resourceName - The name of the resource.
        parameters - Parameters for the update operation.
        context - The context to associate with this operation.
        Returns:
        a class represent a 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.
      • listKeys

        SignalRKeysInner listKeys​(String resourceGroupName,
                                  String resourceName)
        Get the access keys of the resource.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        resourceName - The name of the resource.
        Returns:
        the access keys of the 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.
      • listKeysWithResponse

        com.azure.core.http.rest.Response<SignalRKeysInner> listKeysWithResponse​(String resourceGroupName,
                                                                                 String resourceName,
                                                                                 com.azure.core.util.Context context)
        Get the access keys of the resource.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        resourceName - The name of the resource.
        context - The context to associate with this operation.
        Returns:
        the access keys of the 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.
      • beginRegenerateKey

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<SignalRKeysInner>,​SignalRKeysInner> beginRegenerateKey​(String resourceGroupName,
                                                                                                                                                         String resourceName,
                                                                                                                                                         RegenerateKeyParameters parameters)
        Regenerate the access key for the resource. PrimaryKey and SecondaryKey cannot be regenerated at the same time.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        resourceName - The name of the resource.
        parameters - Parameter that describes the Regenerate Key Operation.
        Returns:
        the SyncPoller for polling of a class represents the access keys of the 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.
      • beginRegenerateKey

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<SignalRKeysInner>,​SignalRKeysInner> beginRegenerateKey​(String resourceGroupName,
                                                                                                                                                         String resourceName,
                                                                                                                                                         RegenerateKeyParameters parameters,
                                                                                                                                                         com.azure.core.util.Context context)
        Regenerate the access key for the resource. PrimaryKey and SecondaryKey cannot be regenerated at the same time.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        resourceName - The name of the resource.
        parameters - Parameter that describes the Regenerate Key Operation.
        context - The context to associate with this operation.
        Returns:
        the SyncPoller for polling of a class represents the access keys of the 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.
      • regenerateKey

        SignalRKeysInner regenerateKey​(String resourceGroupName,
                                       String resourceName,
                                       RegenerateKeyParameters parameters)
        Regenerate the access key for the resource. PrimaryKey and SecondaryKey cannot be regenerated at the same time.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        resourceName - The name of the resource.
        parameters - Parameter that describes the Regenerate Key Operation.
        Returns:
        a class represents the access keys of the 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.
      • regenerateKey

        SignalRKeysInner regenerateKey​(String resourceGroupName,
                                       String resourceName,
                                       RegenerateKeyParameters parameters,
                                       com.azure.core.util.Context context)
        Regenerate the access key for the resource. PrimaryKey and SecondaryKey cannot be regenerated at the same time.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        resourceName - The name of the resource.
        parameters - Parameter that describes the Regenerate Key Operation.
        context - The context to associate with this operation.
        Returns:
        a class represents the access keys of the 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.
      • beginRestart

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginRestart​(String resourceGroupName,
                                                                                                                           String resourceName)
        Operation to restart a resource.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        resourceName - The name of the resource.
        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.
      • beginRestart

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginRestart​(String resourceGroupName,
                                                                                                                           String resourceName,
                                                                                                                           com.azure.core.util.Context context)
        Operation to restart a resource.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        resourceName - The name of the resource.
        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.
      • restart

        void restart​(String resourceGroupName,
                     String resourceName)
        Operation to restart a resource.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        resourceName - The name of the 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.
      • restart

        void restart​(String resourceGroupName,
                     String resourceName,
                     com.azure.core.util.Context context)
        Operation to restart a resource.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        resourceName - The name of the resource.
        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.
      • listSkus

        SkuListInner listSkus​(String resourceGroupName,
                              String resourceName)
        List all available skus of the resource.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        resourceName - The name of the resource.
        Returns:
        the list skus operation 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.
      • listSkusWithResponse

        com.azure.core.http.rest.Response<SkuListInner> listSkusWithResponse​(String resourceGroupName,
                                                                             String resourceName,
                                                                             com.azure.core.util.Context context)
        List all available skus of the resource.
        Parameters:
        resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
        resourceName - The name of the resource.
        context - The context to associate with this operation.
        Returns:
        the list skus operation response 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.