Package com.azure.resourcemanager.sql.fluent

Interface SyncAgentsClient

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

    • Method Detail

      • getWithResponseAsync

        Mono<com.azure.core.http.rest.Response<SyncAgentInner>> getWithResponseAsync​(String resourceGroupName,
                                                                             String serverName,
                                                                             String syncAgentName)
        Gets a sync agent.
        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.
        serverName - The name of the server on which the sync agent is hosted.
        syncAgentName - The name of the sync agent.
        Returns:
        a sync agent.
        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.

      • getAsync

        Mono<SyncAgentInner> getAsync​(String resourceGroupName,
                              String serverName,
                              String syncAgentName)
        Gets a sync agent.
        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.
        serverName - The name of the server on which the sync agent is hosted.
        syncAgentName - The name of the sync agent.
        Returns:
        a sync agent.
        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

        SyncAgentInner get​(String resourceGroupName,
                   String serverName,
                   String syncAgentName)
        Gets a sync agent.
        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.
        serverName - The name of the server on which the sync agent is hosted.
        syncAgentName - The name of the sync agent.
        Returns:
        a sync agent.
        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<SyncAgentInner> getWithResponse​(String resourceGroupName,
                                                                  String serverName,
                                                                  String syncAgentName,
                                                                  com.azure.core.util.Context context)
        Gets a sync agent.
        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.
        serverName - The name of the server on which the sync agent is hosted.
        syncAgentName - The name of the sync agent.
        context - The context to associate with this operation.
        Returns:
        a sync agent.
        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.

      • createOrUpdateWithResponseAsync

        Mono<com.azure.core.http.rest.Response<Flux<ByteBuffer>>> createOrUpdateWithResponseAsync​(String resourceGroupName,
                                                                                          String serverName,
                                                                                          String syncAgentName,
                                                                                          String syncDatabaseId)
        Creates or updates a sync agent.
        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.
        serverName - The name of the server on which the sync agent is hosted.
        syncAgentName - The name of the sync agent.
        syncDatabaseId - ARM resource id of the sync database in the sync agent.
        Returns:
        an Azure SQL Database sync agent.
        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.

      • beginCreateOrUpdateAsync

        com.azure.core.util.polling.PollerFlux<com.azure.core.management.polling.PollResult<SyncAgentInner>,​SyncAgentInner> beginCreateOrUpdateAsync​(String resourceGroupName,
                                                                                                                                                   String serverName,
                                                                                                                                                   String syncAgentName,
                                                                                                                                                   String syncDatabaseId)
        Creates or updates a sync agent.
        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.
        serverName - The name of the server on which the sync agent is hosted.
        syncAgentName - The name of the sync agent.
        syncDatabaseId - ARM resource id of the sync database in the sync agent.
        Returns:
        an Azure SQL Database sync agent.
        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<SyncAgentInner>,​SyncAgentInner> beginCreateOrUpdate​(String resourceGroupName,
                                                                                                                                              String serverName,
                                                                                                                                              String syncAgentName,
                                                                                                                                              String syncDatabaseId)
        Creates or updates a sync agent.
        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.
        serverName - The name of the server on which the sync agent is hosted.
        syncAgentName - The name of the sync agent.
        syncDatabaseId - ARM resource id of the sync database in the sync agent.
        Returns:
        an Azure SQL Database sync agent.
        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<SyncAgentInner>,​SyncAgentInner> beginCreateOrUpdate​(String resourceGroupName,
                                                                                                                                              String serverName,
                                                                                                                                              String syncAgentName,
                                                                                                                                              String syncDatabaseId,
                                                                                                                                              com.azure.core.util.Context context)
        Creates or updates a sync agent.
        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.
        serverName - The name of the server on which the sync agent is hosted.
        syncAgentName - The name of the sync agent.
        syncDatabaseId - ARM resource id of the sync database in the sync agent.
        context - The context to associate with this operation.
        Returns:
        an Azure SQL Database sync agent.
        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.

      • createOrUpdateAsync

        Mono<SyncAgentInner> createOrUpdateAsync​(String resourceGroupName,
                                         String serverName,
                                         String syncAgentName,
                                         String syncDatabaseId)
        Creates or updates a sync agent.
        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.
        serverName - The name of the server on which the sync agent is hosted.
        syncAgentName - The name of the sync agent.
        syncDatabaseId - ARM resource id of the sync database in the sync agent.
        Returns:
        an Azure SQL Database sync agent.
        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.

      • createOrUpdateAsync

        Mono<SyncAgentInner> createOrUpdateAsync​(String resourceGroupName,
                                         String serverName,
                                         String syncAgentName)
        Creates or updates a sync agent.
        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.
        serverName - The name of the server on which the sync agent is hosted.
        syncAgentName - The name of the sync agent.
        Returns:
        an Azure SQL Database sync agent.
        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

        SyncAgentInner createOrUpdate​(String resourceGroupName,
                              String serverName,
                              String syncAgentName,
                              String syncDatabaseId)
        Creates or updates a sync agent.
        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.
        serverName - The name of the server on which the sync agent is hosted.
        syncAgentName - The name of the sync agent.
        syncDatabaseId - ARM resource id of the sync database in the sync agent.
        Returns:
        an Azure SQL Database sync agent.
        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

        SyncAgentInner createOrUpdate​(String resourceGroupName,
                              String serverName,
                              String syncAgentName,
                              String syncDatabaseId,
                              com.azure.core.util.Context context)
        Creates or updates a sync agent.
        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.
        serverName - The name of the server on which the sync agent is hosted.
        syncAgentName - The name of the sync agent.
        syncDatabaseId - ARM resource id of the sync database in the sync agent.
        context - The context to associate with this operation.
        Returns:
        an Azure SQL Database sync agent.
        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

        SyncAgentInner createOrUpdate​(String resourceGroupName,
                              String serverName,
                              String syncAgentName)
        Creates or updates a sync agent.
        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.
        serverName - The name of the server on which the sync agent is hosted.
        syncAgentName - The name of the sync agent.
        Returns:
        an Azure SQL Database sync agent.
        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.

      • deleteWithResponseAsync

        Mono<com.azure.core.http.rest.Response<Flux<ByteBuffer>>> deleteWithResponseAsync​(String resourceGroupName,
                                                                                  String serverName,
                                                                                  String syncAgentName)
        Deletes a sync agent.
        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.
        serverName - The name of the server on which the sync agent is hosted.
        syncAgentName - The name of the sync agent.
        Returns:
        the completion.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • beginDeleteAsync

        com.azure.core.util.polling.PollerFlux<com.azure.core.management.polling.PollResult<Void>,​Void> beginDeleteAsync​(String resourceGroupName,
                                                                                                                       String serverName,
                                                                                                                       String syncAgentName)
        Deletes a sync agent.
        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.
        serverName - The name of the server on which the sync agent is hosted.
        syncAgentName - The name of the sync agent.
        Returns:
        the completion.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • beginDelete

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginDelete​(String resourceGroupName,
                                                                                                                  String serverName,
                                                                                                                  String syncAgentName)
        Deletes a sync agent.
        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.
        serverName - The name of the server on which the sync agent is hosted.
        syncAgentName - The name of the sync agent.
        Returns:
        the completion.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • beginDelete

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginDelete​(String resourceGroupName,
                                                                                                                  String serverName,
                                                                                                                  String syncAgentName,
                                                                                                                  com.azure.core.util.Context context)
        Deletes a sync agent.
        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.
        serverName - The name of the server on which the sync agent is hosted.
        syncAgentName - The name of the sync agent.
        context - The context to associate with this operation.
        Returns:
        the completion.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • deleteAsync

        Mono<Void> deleteAsync​(String resourceGroupName,
                       String serverName,
                       String syncAgentName)
        Deletes a sync agent.
        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.
        serverName - The name of the server on which the sync agent is hosted.
        syncAgentName - The name of the sync agent.
        Returns:
        the completion.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • delete

        void delete​(String resourceGroupName,
            String serverName,
            String syncAgentName)
        Deletes a sync agent.
        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.
        serverName - The name of the server on which the sync agent is hosted.
        syncAgentName - The name of the sync agent.
        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,
            String syncAgentName,
            com.azure.core.util.Context context)
        Deletes a sync agent.
        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.
        serverName - The name of the server on which the sync agent is hosted.
        syncAgentName - The name of the sync agent.
        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.

      • listByServerAsync

        com.azure.core.http.rest.PagedFlux<SyncAgentInner> listByServerAsync​(String resourceGroupName,
                                                                     String serverName)
        Lists sync agents in a server.
        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.
        serverName - The name of the server on which the sync agent is hosted.
        Returns:
        a list of sync agents.
        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.

      • listByServer

        com.azure.core.http.rest.PagedIterable<SyncAgentInner> listByServer​(String resourceGroupName,
                                                                    String serverName)
        Lists sync agents in a server.
        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.
        serverName - The name of the server on which the sync agent is hosted.
        Returns:
        a list of sync agents.
        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.

      • listByServer

        com.azure.core.http.rest.PagedIterable<SyncAgentInner> listByServer​(String resourceGroupName,
                                                                    String serverName,
                                                                    com.azure.core.util.Context context)
        Lists sync agents in a server.
        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.
        serverName - The name of the server on which the sync agent is hosted.
        context - The context to associate with this operation.
        Returns:
        a list of sync agents.
        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.

      • generateKeyWithResponseAsync

        Mono<com.azure.core.http.rest.Response<SyncAgentKeyPropertiesInner>> generateKeyWithResponseAsync​(String resourceGroupName,
                                                                                                  String serverName,
                                                                                                  String syncAgentName)
        Generates a sync agent key.
        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.
        serverName - The name of the server on which the sync agent is hosted.
        syncAgentName - The name of the sync agent.
        Returns:
        properties of an Azure SQL Database sync agent key.
        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.

      • generateKeyAsync

        Mono<SyncAgentKeyPropertiesInner> generateKeyAsync​(String resourceGroupName,
                                                   String serverName,
                                                   String syncAgentName)
        Generates a sync agent key.
        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.
        serverName - The name of the server on which the sync agent is hosted.
        syncAgentName - The name of the sync agent.
        Returns:
        properties of an Azure SQL Database sync agent key.
        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.

      • generateKey

        SyncAgentKeyPropertiesInner generateKey​(String resourceGroupName,
                                        String serverName,
                                        String syncAgentName)
        Generates a sync agent key.
        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.
        serverName - The name of the server on which the sync agent is hosted.
        syncAgentName - The name of the sync agent.
        Returns:
        properties of an Azure SQL Database sync agent key.
        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.

      • generateKeyWithResponse

        com.azure.core.http.rest.Response<SyncAgentKeyPropertiesInner> generateKeyWithResponse​(String resourceGroupName,
                                                                                       String serverName,
                                                                                       String syncAgentName,
                                                                                       com.azure.core.util.Context context)
        Generates a sync agent key.
        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.
        serverName - The name of the server on which the sync agent is hosted.
        syncAgentName - The name of the sync agent.
        context - The context to associate with this operation.
        Returns:
        properties of an Azure SQL Database sync agent key.
        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.

      • listLinkedDatabasesAsync

        com.azure.core.http.rest.PagedFlux<SyncAgentLinkedDatabaseInner> listLinkedDatabasesAsync​(String resourceGroupName,
                                                                                          String serverName,
                                                                                          String syncAgentName)
        Lists databases linked to a sync agent.
        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.
        serverName - The name of the server on which the sync agent is hosted.
        syncAgentName - The name of the sync agent.
        Returns:
        a list of sync agent linked databases.
        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.

      • listLinkedDatabases

        com.azure.core.http.rest.PagedIterable<SyncAgentLinkedDatabaseInner> listLinkedDatabases​(String resourceGroupName,
                                                                                         String serverName,
                                                                                         String syncAgentName)
        Lists databases linked to a sync agent.
        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.
        serverName - The name of the server on which the sync agent is hosted.
        syncAgentName - The name of the sync agent.
        Returns:
        a list of sync agent linked databases.
        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.

      • listLinkedDatabases

        com.azure.core.http.rest.PagedIterable<SyncAgentLinkedDatabaseInner> listLinkedDatabases​(String resourceGroupName,
                                                                                         String serverName,
                                                                                         String syncAgentName,
                                                                                         com.azure.core.util.Context context)
        Lists databases linked to a sync agent.
        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.
        serverName - The name of the server on which the sync agent is hosted.
        syncAgentName - The name of the sync agent.
        context - The context to associate with this operation.
        Returns:
        a list of sync agent linked databases.
        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.