Package com.azure.resourcemanager.synapse.models

Interface IntegrationRuntimes

public interface IntegrationRuntimes
Resource collection API of IntegrationRuntimes.

  • Method Details

    • getWithResponse

      com.azure.core.http.rest.Response<IntegrationRuntimeResource> getWithResponse(String resourceGroupName, String workspaceName, String integrationRuntimeName, String ifNoneMatch, com.azure.core.util.Context context)
      Get integration runtime

      Get an integration runtime.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - The name of the workspace.
      integrationRuntimeName - Integration runtime name.
      ifNoneMatch - ETag of the integration runtime entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.
      context - The context to associate with this operation.
      Returns:
      an integration runtime 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.

    • get

      IntegrationRuntimeResource get(String resourceGroupName, String workspaceName, String integrationRuntimeName)
      Get integration runtime

      Get an integration runtime.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - The name of the workspace.
      integrationRuntimeName - Integration runtime name.
      Returns:
      an integration runtime.
      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 workspaceName, String integrationRuntimeName)
      Delete integration runtime

      Delete an integration runtime.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - The name of the workspace.
      integrationRuntimeName - Integration runtime name.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • delete

      void delete(String resourceGroupName, String workspaceName, String integrationRuntimeName, com.azure.core.util.Context context)
      Delete integration runtime

      Delete an integration runtime.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - The name of the workspace.
      integrationRuntimeName - Integration runtime name.
      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.

    • upgradeWithResponse

      com.azure.core.http.rest.Response<Void> upgradeWithResponse(String resourceGroupName, String workspaceName, String integrationRuntimeName, com.azure.core.util.Context context)
      Upgrade integration runtime

      Upgrade an integration runtime.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - The name of the workspace.
      integrationRuntimeName - Integration runtime name.
      context - The context to associate with this operation.
      Returns:
      the Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • upgrade

      void upgrade(String resourceGroupName, String workspaceName, String integrationRuntimeName)
      Upgrade integration runtime

      Upgrade an integration runtime.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - The name of the workspace.
      integrationRuntimeName - Integration runtime name.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listByWorkspace

      com.azure.core.http.rest.PagedIterable<IntegrationRuntimeResource> listByWorkspace(String resourceGroupName, String workspaceName)
      List integration runtimes

      List all integration runtimes.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - The name of the workspace.
      Returns:
      a list of integration runtime resources 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.

    • listByWorkspace

      com.azure.core.http.rest.PagedIterable<IntegrationRuntimeResource> listByWorkspace(String resourceGroupName, String workspaceName, com.azure.core.util.Context context)
      List integration runtimes

      List all integration runtimes.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - The name of the workspace.
      context - The context to associate with this operation.
      Returns:
      a list of integration runtime resources 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.

    • start

      IntegrationRuntimeStatusResponse start(String resourceGroupName, String workspaceName, String integrationRuntimeName)
      Start integration runtime

      Start an integration runtime.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - The name of the workspace.
      integrationRuntimeName - Integration runtime name.
      Returns:
      integration runtime status 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.

    • start

      IntegrationRuntimeStatusResponse start(String resourceGroupName, String workspaceName, String integrationRuntimeName, com.azure.core.util.Context context)
      Start integration runtime

      Start an integration runtime.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - The name of the workspace.
      integrationRuntimeName - Integration runtime name.
      context - The context to associate with this operation.
      Returns:
      integration runtime status 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.

    • stop

      void stop(String resourceGroupName, String workspaceName, String integrationRuntimeName)
      Stop integration runtime

      Stop an integration runtime.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - The name of the workspace.
      integrationRuntimeName - Integration runtime name.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • stop

      void stop(String resourceGroupName, String workspaceName, String integrationRuntimeName, com.azure.core.util.Context context)
      Stop integration runtime

      Stop an integration runtime.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - The name of the workspace.
      integrationRuntimeName - Integration runtime name.
      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.

    • listOutboundNetworkDependenciesEndpointsWithResponse

      com.azure.core.http.rest.Response<IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse> listOutboundNetworkDependenciesEndpointsWithResponse(String resourceGroupName, String workspaceName, String integrationRuntimeName, com.azure.core.util.Context context)
      Gets list of outbound network dependencies for a given Azure-SSIS integration runtime.

      Gets the list of outbound network dependencies for a given Azure-SSIS integration runtime.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - The name of the workspace.
      integrationRuntimeName - Integration runtime name.
      context - The context to associate with this operation.
      Returns:
      the list of outbound network dependencies for a given Azure-SSIS integration runtime 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.

    • listOutboundNetworkDependenciesEndpoints

      IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse listOutboundNetworkDependenciesEndpoints(String resourceGroupName, String workspaceName, String integrationRuntimeName)
      Gets list of outbound network dependencies for a given Azure-SSIS integration runtime.

      Gets the list of outbound network dependencies for a given Azure-SSIS integration runtime.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - The name of the workspace.
      integrationRuntimeName - Integration runtime name.
      Returns:
      the list of outbound network dependencies for a given Azure-SSIS integration runtime.
      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.

    • enableInteractiveQuery

      void enableInteractiveQuery(String resourceGroupName, String workspaceName, String integrationRuntimeName)
      Enable interactive query in integration runtime.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - The name of the workspace.
      integrationRuntimeName - Integration runtime name.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • enableInteractiveQuery

      void enableInteractiveQuery(String resourceGroupName, String workspaceName, String integrationRuntimeName, com.azure.core.util.Context context)
      Enable interactive query in integration runtime.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - The name of the workspace.
      integrationRuntimeName - Integration runtime name.
      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.

    • disableInteractiveQuery

      void disableInteractiveQuery(String resourceGroupName, String workspaceName, String integrationRuntimeName)
      Disable interactive query in integration runtime.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - The name of the workspace.
      integrationRuntimeName - Integration runtime name.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • disableInteractiveQuery

      void disableInteractiveQuery(String resourceGroupName, String workspaceName, String integrationRuntimeName, com.azure.core.util.Context context)
      Disable interactive query in integration runtime.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - The name of the workspace.
      integrationRuntimeName - Integration runtime name.
      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.

    • getById

      IntegrationRuntimeResource getById(String id)
      Get integration runtime

      Get an integration runtime.

      Parameters:
      id - the resource ID.
      Returns:
      an integration runtime 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.

    • getByIdWithResponse

      com.azure.core.http.rest.Response<IntegrationRuntimeResource> getByIdWithResponse(String id, String ifNoneMatch, com.azure.core.util.Context context)
      Get integration runtime

      Get an integration runtime.

      Parameters:
      id - the resource ID.
      ifNoneMatch - ETag of the integration runtime entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.
      context - The context to associate with this operation.
      Returns:
      an integration runtime 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.

    • deleteById

      void deleteById(String id)
      Delete integration runtime

      Delete an integration runtime.

      Parameters:
      id - the resource ID.
      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.

    • deleteByIdWithResponse

      void deleteByIdWithResponse(String id, com.azure.core.util.Context context)
      Delete integration runtime

      Delete an integration runtime.

      Parameters:
      id - the resource ID.
      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.

    • define

      IntegrationRuntimeResource.DefinitionStages.Blank define(String name)
      Begins definition for a new IntegrationRuntimeResource resource.
      Parameters:
      name - resource name.
      Returns:
      the first stage of the new IntegrationRuntimeResource definition.