Interface JobAgentsClient


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

      • listByServerAsync

        com.azure.core.http.rest.PagedFlux<JobAgentInner> listByServerAsync​(String resourceGroupName,
                                                                            String serverName)
        Gets a list of job 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.
        Returns:
        a list of job agents in 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.
      • listByServer

        com.azure.core.http.rest.PagedIterable<JobAgentInner> listByServer​(String resourceGroupName,
                                                                           String serverName)
        Gets a list of job 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.
        Returns:
        a list of job agents in 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.
      • listByServer

        com.azure.core.http.rest.PagedIterable<JobAgentInner> listByServer​(String resourceGroupName,
                                                                           String serverName,
                                                                           com.azure.core.util.Context context)
        Gets a list of job 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.
        context - The context to associate with this operation.
        Returns:
        a list of job agents in 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.
      • getWithResponseAsync

        Mono<com.azure.core.http.rest.Response<JobAgentInner>> getWithResponseAsync​(String resourceGroupName,
                                                                                    String serverName,
                                                                                    String jobAgentName)
        Gets a job 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.
        jobAgentName - The name of the job agent to be retrieved.
        Returns:
        a job 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<JobAgentInner> getAsync​(String resourceGroupName,
                                     String serverName,
                                     String jobAgentName)
        Gets a job 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.
        jobAgentName - The name of the job agent to be retrieved.
        Returns:
        a job 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

        JobAgentInner get​(String resourceGroupName,
                          String serverName,
                          String jobAgentName)
        Gets a job 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.
        jobAgentName - The name of the job agent to be retrieved.
        Returns:
        a job 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<JobAgentInner> getWithResponse​(String resourceGroupName,
                                                                         String serverName,
                                                                         String jobAgentName,
                                                                         com.azure.core.util.Context context)
        Gets a job 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.
        jobAgentName - The name of the job agent to be retrieved.
        context - The context to associate with this operation.
        Returns:
        a job 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 jobAgentName,
                                                                                                  JobAgentInner parameters)
        Creates or updates a job 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.
        jobAgentName - The name of the job agent to be created or updated.
        parameters - An Azure SQL job agent.
        Returns:
        an Azure SQL job 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<JobAgentInner>,​JobAgentInner> beginCreateOrUpdateAsync​(String resourceGroupName,
                                                                                                                                                         String serverName,
                                                                                                                                                         String jobAgentName,
                                                                                                                                                         JobAgentInner parameters)
        Creates or updates a job 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.
        jobAgentName - The name of the job agent to be created or updated.
        parameters - An Azure SQL job agent.
        Returns:
        an Azure SQL job 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<JobAgentInner>,​JobAgentInner> beginCreateOrUpdate​(String resourceGroupName,
                                                                                                                                                    String serverName,
                                                                                                                                                    String jobAgentName,
                                                                                                                                                    JobAgentInner parameters)
        Creates or updates a job 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.
        jobAgentName - The name of the job agent to be created or updated.
        parameters - An Azure SQL job agent.
        Returns:
        an Azure SQL job 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<JobAgentInner>,​JobAgentInner> beginCreateOrUpdate​(String resourceGroupName,
                                                                                                                                                    String serverName,
                                                                                                                                                    String jobAgentName,
                                                                                                                                                    JobAgentInner parameters,
                                                                                                                                                    com.azure.core.util.Context context)
        Creates or updates a job 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.
        jobAgentName - The name of the job agent to be created or updated.
        parameters - An Azure SQL job agent.
        context - The context to associate with this operation.
        Returns:
        an Azure SQL job 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<JobAgentInner> createOrUpdateAsync​(String resourceGroupName,
                                                String serverName,
                                                String jobAgentName,
                                                JobAgentInner parameters)
        Creates or updates a job 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.
        jobAgentName - The name of the job agent to be created or updated.
        parameters - An Azure SQL job agent.
        Returns:
        an Azure SQL job 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

        JobAgentInner createOrUpdate​(String resourceGroupName,
                                     String serverName,
                                     String jobAgentName,
                                     JobAgentInner parameters)
        Creates or updates a job 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.
        jobAgentName - The name of the job agent to be created or updated.
        parameters - An Azure SQL job agent.
        Returns:
        an Azure SQL job 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

        JobAgentInner createOrUpdate​(String resourceGroupName,
                                     String serverName,
                                     String jobAgentName,
                                     JobAgentInner parameters,
                                     com.azure.core.util.Context context)
        Creates or updates a job 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.
        jobAgentName - The name of the job agent to be created or updated.
        parameters - An Azure SQL job agent.
        context - The context to associate with this operation.
        Returns:
        an Azure SQL job 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 jobAgentName)
        Deletes a job 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.
        jobAgentName - The name of the job agent to be deleted.
        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 jobAgentName)
        Deletes a job 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.
        jobAgentName - The name of the job agent to be deleted.
        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 jobAgentName)
        Deletes a job 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.
        jobAgentName - The name of the job agent to be deleted.
        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 jobAgentName,
                                                                                                                          com.azure.core.util.Context context)
        Deletes a job 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.
        jobAgentName - The name of the job agent to be deleted.
        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 jobAgentName)
        Deletes a job 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.
        jobAgentName - The name of the job agent to be deleted.
        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 jobAgentName)
        Deletes a job 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.
        jobAgentName - The name of the job agent to be deleted.
        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 jobAgentName,
                    com.azure.core.util.Context context)
        Deletes a job 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.
        jobAgentName - The name of the job agent to be deleted.
        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.
      • updateWithResponseAsync

        Mono<com.azure.core.http.rest.Response<Flux<ByteBuffer>>> updateWithResponseAsync​(String resourceGroupName,
                                                                                          String serverName,
                                                                                          String jobAgentName,
                                                                                          Map<String,​String> tags)
        Updates a job 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.
        jobAgentName - The name of the job agent to be updated.
        tags - Resource tags.
        Returns:
        an Azure SQL job 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.
      • beginUpdateAsync

        com.azure.core.util.polling.PollerFlux<com.azure.core.management.polling.PollResult<JobAgentInner>,​JobAgentInner> beginUpdateAsync​(String resourceGroupName,
                                                                                                                                                 String serverName,
                                                                                                                                                 String jobAgentName,
                                                                                                                                                 Map<String,​String> tags)
        Updates a job 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.
        jobAgentName - The name of the job agent to be updated.
        tags - Resource tags.
        Returns:
        an Azure SQL job 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.
      • beginUpdate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<JobAgentInner>,​JobAgentInner> beginUpdate​(String resourceGroupName,
                                                                                                                                            String serverName,
                                                                                                                                            String jobAgentName,
                                                                                                                                            Map<String,​String> tags)
        Updates a job 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.
        jobAgentName - The name of the job agent to be updated.
        tags - Resource tags.
        Returns:
        an Azure SQL job 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.
      • beginUpdate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<JobAgentInner>,​JobAgentInner> beginUpdate​(String resourceGroupName,
                                                                                                                                            String serverName,
                                                                                                                                            String jobAgentName,
                                                                                                                                            Map<String,​String> tags,
                                                                                                                                            com.azure.core.util.Context context)
        Updates a job 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.
        jobAgentName - The name of the job agent to be updated.
        tags - Resource tags.
        context - The context to associate with this operation.
        Returns:
        an Azure SQL job 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.
      • updateAsync

        Mono<JobAgentInner> updateAsync​(String resourceGroupName,
                                        String serverName,
                                        String jobAgentName,
                                        Map<String,​String> tags)
        Updates a job 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.
        jobAgentName - The name of the job agent to be updated.
        tags - Resource tags.
        Returns:
        an Azure SQL job 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.
      • updateAsync

        Mono<JobAgentInner> updateAsync​(String resourceGroupName,
                                        String serverName,
                                        String jobAgentName)
        Updates a job 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.
        jobAgentName - The name of the job agent to be updated.
        Returns:
        an Azure SQL job 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.
      • update

        JobAgentInner update​(String resourceGroupName,
                             String serverName,
                             String jobAgentName,
                             Map<String,​String> tags)
        Updates a job 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.
        jobAgentName - The name of the job agent to be updated.
        tags - Resource tags.
        Returns:
        an Azure SQL job 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.
      • update

        JobAgentInner update​(String resourceGroupName,
                             String serverName,
                             String jobAgentName,
                             Map<String,​String> tags,
                             com.azure.core.util.Context context)
        Updates a job 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.
        jobAgentName - The name of the job agent to be updated.
        tags - Resource tags.
        context - The context to associate with this operation.
        Returns:
        an Azure SQL job 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.
      • update

        JobAgentInner update​(String resourceGroupName,
                             String serverName,
                             String jobAgentName)
        Updates a job 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.
        jobAgentName - The name of the job agent to be updated.
        Returns:
        an Azure SQL job 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.