Interface ServersClient


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

      • beginCreate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ServerInner>,​ServerInner> beginCreate​(String resourceGroupName,
                                                                                                                                        String serverName,
                                                                                                                                        ServerInner parameters)
        Creates a new server or updates an existing server. The update action will overwrite the existing server.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        serverName - The name of the server.
        parameters - The required parameters for creating or updating a server.
        Returns:
        the SyncPoller for polling of represents a server.
        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.
      • beginCreate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ServerInner>,​ServerInner> beginCreate​(String resourceGroupName,
                                                                                                                                        String serverName,
                                                                                                                                        ServerInner parameters,
                                                                                                                                        com.azure.core.util.Context context)
        Creates a new server or updates an existing server. The update action will overwrite the existing server.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        serverName - The name of the server.
        parameters - The required parameters for creating or updating a server.
        context - The context to associate with this operation.
        Returns:
        the SyncPoller for polling of represents a server.
        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.
      • create

        ServerInner create​(String resourceGroupName,
                           String serverName,
                           ServerInner parameters)
        Creates a new server or updates an existing server. The update action will overwrite the existing server.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        serverName - The name of the server.
        parameters - The required parameters for creating or updating a server.
        Returns:
        represents a server.
        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.
      • create

        ServerInner create​(String resourceGroupName,
                           String serverName,
                           ServerInner parameters,
                           com.azure.core.util.Context context)
        Creates a new server or updates an existing server. The update action will overwrite the existing server.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        serverName - The name of the server.
        parameters - The required parameters for creating or updating a server.
        context - The context to associate with this operation.
        Returns:
        represents a server.
        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<ServerInner>,​ServerInner> beginUpdate​(String resourceGroupName,
                                                                                                                                        String serverName,
                                                                                                                                        ServerForUpdate parameters)
        Updates an existing server. The request body can contain one to many of the properties present in the normal server definition.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        serverName - The name of the server.
        parameters - The required parameters for updating a server.
        Returns:
        the SyncPoller for polling of represents a server.
        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<ServerInner>,​ServerInner> beginUpdate​(String resourceGroupName,
                                                                                                                                        String serverName,
                                                                                                                                        ServerForUpdate parameters,
                                                                                                                                        com.azure.core.util.Context context)
        Updates an existing server. The request body can contain one to many of the properties present in the normal server definition.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        serverName - The name of the server.
        parameters - The required parameters for updating a server.
        context - The context to associate with this operation.
        Returns:
        the SyncPoller for polling of represents a server.
        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

        ServerInner update​(String resourceGroupName,
                           String serverName,
                           ServerForUpdate parameters)
        Updates an existing server. The request body can contain one to many of the properties present in the normal server definition.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        serverName - The name of the server.
        parameters - The required parameters for updating a server.
        Returns:
        represents a server.
        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

        ServerInner update​(String resourceGroupName,
                           String serverName,
                           ServerForUpdate parameters,
                           com.azure.core.util.Context context)
        Updates an existing server. The request body can contain one to many of the properties present in the normal server definition.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        serverName - The name of the server.
        parameters - The required parameters for updating a server.
        context - The context to associate with this operation.
        Returns:
        represents a server.
        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 serverName)
        Deletes a server.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        serverName - The name of the server.
        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 serverName,
                                                                                                                          com.azure.core.util.Context context)
        Deletes a server.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        serverName - The name of the server.
        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 serverName)
        Deletes a server.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        serverName - The name of the server.
        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 serverName,
                    com.azure.core.util.Context context)
        Deletes a server.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        serverName - The name of the server.
        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

        ServerInner getByResourceGroup​(String resourceGroupName,
                                       String serverName)
        Gets information about a server.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        serverName - The name of the server.
        Returns:
        information about a server.
        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<ServerInner> getByResourceGroupWithResponse​(String resourceGroupName,
                                                                                      String serverName,
                                                                                      com.azure.core.util.Context context)
        Gets information about a server.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        serverName - The name of the server.
        context - The context to associate with this operation.
        Returns:
        information about a server 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.
      • listByResourceGroup

        com.azure.core.http.rest.PagedIterable<ServerInner> listByResourceGroup​(String resourceGroupName)
        List all the servers in a given resource group.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        Returns:
        a list of servers 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<ServerInner> listByResourceGroup​(String resourceGroupName,
                                                                                com.azure.core.util.Context context)
        List all the servers in a given resource group.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        context - The context to associate with this operation.
        Returns:
        a list of servers 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.
      • list

        com.azure.core.http.rest.PagedIterable<ServerInner> list()
        List all the servers in a given subscription.
        Returns:
        a list of servers 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<ServerInner> list​(com.azure.core.util.Context context)
        List all the servers in a given subscription.
        Parameters:
        context - The context to associate with this operation.
        Returns:
        a list of servers 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.
      • beginFailover

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginFailover​(String resourceGroupName,
                                                                                                                            String serverName)
        Manual failover a server.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        serverName - The name of the server.
        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.
      • beginFailover

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginFailover​(String resourceGroupName,
                                                                                                                            String serverName,
                                                                                                                            com.azure.core.util.Context context)
        Manual failover a server.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        serverName - The name of the server.
        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.
      • failover

        void failover​(String resourceGroupName,
                      String serverName)
        Manual failover a server.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        serverName - The name of the server.
        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.
      • failover

        void failover​(String resourceGroupName,
                      String serverName,
                      com.azure.core.util.Context context)
        Manual failover a server.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        serverName - The name of the server.
        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.
      • beginRestart

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginRestart​(String resourceGroupName,
                                                                                                                           String serverName,
                                                                                                                           ServerRestartParameter parameters)
        Restarts a server.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        serverName - The name of the server.
        parameters - The required parameters for restarting a server.
        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 serverName,
                                                                                                                           ServerRestartParameter parameters,
                                                                                                                           com.azure.core.util.Context context)
        Restarts a server.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        serverName - The name of the server.
        parameters - The required parameters for restarting a server.
        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 serverName,
                     ServerRestartParameter parameters)
        Restarts a server.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        serverName - The name of the server.
        parameters - The required parameters for restarting a server.
        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 serverName,
                     ServerRestartParameter parameters,
                     com.azure.core.util.Context context)
        Restarts a server.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        serverName - The name of the server.
        parameters - The required parameters for restarting a server.
        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.
      • beginStart

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginStart​(String resourceGroupName,
                                                                                                                         String serverName)
        Starts a server.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        serverName - The name of the server.
        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.
      • beginStart

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginStart​(String resourceGroupName,
                                                                                                                         String serverName,
                                                                                                                         com.azure.core.util.Context context)
        Starts a server.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        serverName - The name of the server.
        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.
      • start

        void start​(String resourceGroupName,
                   String serverName)
        Starts a server.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        serverName - The name of the server.
        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.
      • start

        void start​(String resourceGroupName,
                   String serverName,
                   com.azure.core.util.Context context)
        Starts a server.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        serverName - The name of the server.
        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.
      • beginStop

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginStop​(String resourceGroupName,
                                                                                                                        String serverName)
        Stops a server.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        serverName - The name of the server.
        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.
      • beginStop

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginStop​(String resourceGroupName,
                                                                                                                        String serverName,
                                                                                                                        com.azure.core.util.Context context)
        Stops a server.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        serverName - The name of the server.
        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.
      • stop

        void stop​(String resourceGroupName,
                  String serverName)
        Stops a server.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        serverName - The name of the server.
        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.
      • stop

        void stop​(String resourceGroupName,
                  String serverName,
                  com.azure.core.util.Context context)
        Stops a server.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        serverName - The name of the server.
        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.