Package com.azure.resourcemanager.datafactory.models

Interface IntegrationRuntimes

  • public interface IntegrationRuntimes
    Resource collection API of IntegrationRuntimes.

    • Method Detail

      • listByFactory

        com.azure.core.http.rest.PagedIterable<IntegrationRuntimeResource> listByFactory​(String resourceGroupName,
                                                                                 String factoryName)
        Lists integration runtimes.
        Parameters:
        resourceGroupName - The resource group name.
        factoryName - The factory name.
        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.

      • listByFactory

        com.azure.core.http.rest.PagedIterable<IntegrationRuntimeResource> listByFactory​(String resourceGroupName,
                                                                                 String factoryName,
                                                                                 com.azure.core.util.Context context)
        Lists integration runtimes.
        Parameters:
        resourceGroupName - The resource group name.
        factoryName - The factory name.
        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.

      • get

        IntegrationRuntimeResource get​(String resourceGroupName,
                               String factoryName,
                               String integrationRuntimeName)
        Gets an integration runtime.
        Parameters:
        resourceGroupName - The resource group name.
        factoryName - The factory name.
        integrationRuntimeName - The 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.

      • getWithResponse

        com.azure.core.http.rest.Response<IntegrationRuntimeResource> getWithResponse​(String resourceGroupName,
                                                                              String factoryName,
                                                                              String integrationRuntimeName,
                                                                              String ifNoneMatch,
                                                                              com.azure.core.util.Context context)
        Gets an integration runtime.
        Parameters:
        resourceGroupName - The resource group name.
        factoryName - The factory name.
        integrationRuntimeName - The 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.

      • delete

        void delete​(String resourceGroupName,
            String factoryName,
            String integrationRuntimeName)
        Deletes an integration runtime.
        Parameters:
        resourceGroupName - The resource group name.
        factoryName - The factory name.
        integrationRuntimeName - The 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.

      • deleteWithResponse

        com.azure.core.http.rest.Response<Void> deleteWithResponse​(String resourceGroupName,
                                                           String factoryName,
                                                           String integrationRuntimeName,
                                                           com.azure.core.util.Context context)
        Deletes an integration runtime.
        Parameters:
        resourceGroupName - The resource group name.
        factoryName - The factory name.
        integrationRuntimeName - The 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.

      • getStatus

        IntegrationRuntimeStatusResponse getStatus​(String resourceGroupName,
                                           String factoryName,
                                           String integrationRuntimeName)
        Gets detailed status information for an integration runtime.
        Parameters:
        resourceGroupName - The resource group name.
        factoryName - The factory name.
        integrationRuntimeName - The integration runtime name.
        Returns:
        detailed status information for 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.

      • getStatusWithResponse

        com.azure.core.http.rest.Response<IntegrationRuntimeStatusResponse> getStatusWithResponse​(String resourceGroupName,
                                                                                          String factoryName,
                                                                                          String integrationRuntimeName,
                                                                                          com.azure.core.util.Context context)
        Gets detailed status information for an integration runtime.
        Parameters:
        resourceGroupName - The resource group name.
        factoryName - The factory name.
        integrationRuntimeName - The integration runtime name.
        context - The context to associate with this operation.
        Returns:
        detailed status information for 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.

      • listOutboundNetworkDependenciesEndpoints

        IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse listOutboundNetworkDependenciesEndpoints​(String resourceGroupName,
                                                                                                        String factoryName,
                                                                                                        String integrationRuntimeName)
        Gets the list of outbound network dependencies for a given Azure-SSIS integration runtime.
        Parameters:
        resourceGroupName - The resource group name.
        factoryName - The factory name.
        integrationRuntimeName - The 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.

      • listOutboundNetworkDependenciesEndpointsWithResponse

        com.azure.core.http.rest.Response<IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse> listOutboundNetworkDependenciesEndpointsWithResponse​(String resourceGroupName,
                                                                                                                                                       String factoryName,
                                                                                                                                                       String integrationRuntimeName,
                                                                                                                                                       com.azure.core.util.Context context)
        Gets the list of outbound network dependencies for a given Azure-SSIS integration runtime.
        Parameters:
        resourceGroupName - The resource group name.
        factoryName - The factory name.
        integrationRuntimeName - The 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.

      • getConnectionInfo

        IntegrationRuntimeConnectionInfo getConnectionInfo​(String resourceGroupName,
                                                   String factoryName,
                                                   String integrationRuntimeName)
        Gets the on-premises integration runtime connection information for encrypting the on-premises data source credentials.
        Parameters:
        resourceGroupName - The resource group name.
        factoryName - The factory name.
        integrationRuntimeName - The integration runtime name.
        Returns:
        the on-premises integration runtime connection information for encrypting the on-premises data source credentials.
        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.

      • getConnectionInfoWithResponse

        com.azure.core.http.rest.Response<IntegrationRuntimeConnectionInfo> getConnectionInfoWithResponse​(String resourceGroupName,
                                                                                                  String factoryName,
                                                                                                  String integrationRuntimeName,
                                                                                                  com.azure.core.util.Context context)
        Gets the on-premises integration runtime connection information for encrypting the on-premises data source credentials.
        Parameters:
        resourceGroupName - The resource group name.
        factoryName - The factory name.
        integrationRuntimeName - The integration runtime name.
        context - The context to associate with this operation.
        Returns:
        the on-premises integration runtime connection information for encrypting the on-premises data source credentials 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.

      • regenerateAuthKey

        IntegrationRuntimeAuthKeys regenerateAuthKey​(String resourceGroupName,
                                             String factoryName,
                                             String integrationRuntimeName,
                                             IntegrationRuntimeRegenerateKeyParameters regenerateKeyParameters)
        Regenerates the authentication key for an integration runtime.
        Parameters:
        resourceGroupName - The resource group name.
        factoryName - The factory name.
        integrationRuntimeName - The integration runtime name.
        regenerateKeyParameters - The parameters for regenerating integration runtime authentication key.
        Returns:
        the integration runtime authentication keys.
        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.

      • regenerateAuthKeyWithResponse

        com.azure.core.http.rest.Response<IntegrationRuntimeAuthKeys> regenerateAuthKeyWithResponse​(String resourceGroupName,
                                                                                            String factoryName,
                                                                                            String integrationRuntimeName,
                                                                                            IntegrationRuntimeRegenerateKeyParameters regenerateKeyParameters,
                                                                                            com.azure.core.util.Context context)
        Regenerates the authentication key for an integration runtime.
        Parameters:
        resourceGroupName - The resource group name.
        factoryName - The factory name.
        integrationRuntimeName - The integration runtime name.
        regenerateKeyParameters - The parameters for regenerating integration runtime authentication key.
        context - The context to associate with this operation.
        Returns:
        the integration runtime authentication keys 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.

      • listAuthKeys

        IntegrationRuntimeAuthKeys listAuthKeys​(String resourceGroupName,
                                        String factoryName,
                                        String integrationRuntimeName)
        Retrieves the authentication keys for an integration runtime.
        Parameters:
        resourceGroupName - The resource group name.
        factoryName - The factory name.
        integrationRuntimeName - The integration runtime name.
        Returns:
        the integration runtime authentication keys.
        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.

      • listAuthKeysWithResponse

        com.azure.core.http.rest.Response<IntegrationRuntimeAuthKeys> listAuthKeysWithResponse​(String resourceGroupName,
                                                                                       String factoryName,
                                                                                       String integrationRuntimeName,
                                                                                       com.azure.core.util.Context context)
        Retrieves the authentication keys for an integration runtime.
        Parameters:
        resourceGroupName - The resource group name.
        factoryName - The factory name.
        integrationRuntimeName - The integration runtime name.
        context - The context to associate with this operation.
        Returns:
        the integration runtime authentication keys 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.

      • start

        IntegrationRuntimeStatusResponse start​(String resourceGroupName,
                                       String factoryName,
                                       String integrationRuntimeName)
        Starts a ManagedReserved type integration runtime.
        Parameters:
        resourceGroupName - The resource group name.
        factoryName - The factory name.
        integrationRuntimeName - The 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 factoryName,
                                       String integrationRuntimeName,
                                       com.azure.core.util.Context context)
        Starts a ManagedReserved type integration runtime.
        Parameters:
        resourceGroupName - The resource group name.
        factoryName - The factory name.
        integrationRuntimeName - The 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 factoryName,
          String integrationRuntimeName)
        Stops a ManagedReserved type integration runtime.
        Parameters:
        resourceGroupName - The resource group name.
        factoryName - The factory name.
        integrationRuntimeName - The 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 factoryName,
          String integrationRuntimeName,
          com.azure.core.util.Context context)
        Stops a ManagedReserved type integration runtime.
        Parameters:
        resourceGroupName - The resource group name.
        factoryName - The factory name.
        integrationRuntimeName - The 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.

      • syncCredentials

        void syncCredentials​(String resourceGroupName,
                     String factoryName,
                     String integrationRuntimeName)
        Force the integration runtime to synchronize credentials across integration runtime nodes, and this will override the credentials across all worker nodes with those available on the dispatcher node. If you already have the latest credential backup file, you should manually import it (preferred) on any self-hosted integration runtime node than using this API directly.
        Parameters:
        resourceGroupName - The resource group name.
        factoryName - The factory name.
        integrationRuntimeName - The 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.

      • syncCredentialsWithResponse

        com.azure.core.http.rest.Response<Void> syncCredentialsWithResponse​(String resourceGroupName,
                                                                    String factoryName,
                                                                    String integrationRuntimeName,
                                                                    com.azure.core.util.Context context)
        Force the integration runtime to synchronize credentials across integration runtime nodes, and this will override the credentials across all worker nodes with those available on the dispatcher node. If you already have the latest credential backup file, you should manually import it (preferred) on any self-hosted integration runtime node than using this API directly.
        Parameters:
        resourceGroupName - The resource group name.
        factoryName - The factory name.
        integrationRuntimeName - The 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.

      • getMonitoringData

        IntegrationRuntimeMonitoringData getMonitoringData​(String resourceGroupName,
                                                   String factoryName,
                                                   String integrationRuntimeName)
        Get the integration runtime monitoring data, which includes the monitor data for all the nodes under this integration runtime.
        Parameters:
        resourceGroupName - The resource group name.
        factoryName - The factory name.
        integrationRuntimeName - The integration runtime name.
        Returns:
        the integration runtime monitoring data, which includes the monitor data for all the nodes under this 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.

      • getMonitoringDataWithResponse

        com.azure.core.http.rest.Response<IntegrationRuntimeMonitoringData> getMonitoringDataWithResponse​(String resourceGroupName,
                                                                                                  String factoryName,
                                                                                                  String integrationRuntimeName,
                                                                                                  com.azure.core.util.Context context)
        Get the integration runtime monitoring data, which includes the monitor data for all the nodes under this integration runtime.
        Parameters:
        resourceGroupName - The resource group name.
        factoryName - The factory name.
        integrationRuntimeName - The integration runtime name.
        context - The context to associate with this operation.
        Returns:
        the integration runtime monitoring data, which includes the monitor data for all the nodes under this 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.

      • upgrade

        void upgrade​(String resourceGroupName,
             String factoryName,
             String integrationRuntimeName)
        Upgrade self-hosted integration runtime to latest version if availability.
        Parameters:
        resourceGroupName - The resource group name.
        factoryName - The factory name.
        integrationRuntimeName - The 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.

      • upgradeWithResponse

        com.azure.core.http.rest.Response<Void> upgradeWithResponse​(String resourceGroupName,
                                                            String factoryName,
                                                            String integrationRuntimeName,
                                                            com.azure.core.util.Context context)
        Upgrade self-hosted integration runtime to latest version if availability.
        Parameters:
        resourceGroupName - The resource group name.
        factoryName - The factory name.
        integrationRuntimeName - The 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.

      • removeLinks

        void removeLinks​(String resourceGroupName,
                 String factoryName,
                 String integrationRuntimeName,
                 LinkedIntegrationRuntimeRequest linkedIntegrationRuntimeRequest)
        Remove all linked integration runtimes under specific data factory in a self-hosted integration runtime.
        Parameters:
        resourceGroupName - The resource group name.
        factoryName - The factory name.
        integrationRuntimeName - The integration runtime name.
        linkedIntegrationRuntimeRequest - The data factory name for the linked 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.

      • removeLinksWithResponse

        com.azure.core.http.rest.Response<Void> removeLinksWithResponse​(String resourceGroupName,
                                                                String factoryName,
                                                                String integrationRuntimeName,
                                                                LinkedIntegrationRuntimeRequest linkedIntegrationRuntimeRequest,
                                                                com.azure.core.util.Context context)
        Remove all linked integration runtimes under specific data factory in a self-hosted integration runtime.
        Parameters:
        resourceGroupName - The resource group name.
        factoryName - The factory name.
        integrationRuntimeName - The integration runtime name.
        linkedIntegrationRuntimeRequest - The data factory name for the linked integration runtime.
        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.

      • createLinkedIntegrationRuntime

        IntegrationRuntimeStatusResponse createLinkedIntegrationRuntime​(String resourceGroupName,
                                                                String factoryName,
                                                                String integrationRuntimeName,
                                                                CreateLinkedIntegrationRuntimeRequest createLinkedIntegrationRuntimeRequest)
        Create a linked integration runtime entry in a shared integration runtime.
        Parameters:
        resourceGroupName - The resource group name.
        factoryName - The factory name.
        integrationRuntimeName - The integration runtime name.
        createLinkedIntegrationRuntimeRequest - The linked integration runtime properties.
        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.

      • createLinkedIntegrationRuntimeWithResponse

        com.azure.core.http.rest.Response<IntegrationRuntimeStatusResponse> createLinkedIntegrationRuntimeWithResponse​(String resourceGroupName,
                                                                                                               String factoryName,
                                                                                                               String integrationRuntimeName,
                                                                                                               CreateLinkedIntegrationRuntimeRequest createLinkedIntegrationRuntimeRequest,
                                                                                                               com.azure.core.util.Context context)
        Create a linked integration runtime entry in a shared integration runtime.
        Parameters:
        resourceGroupName - The resource group name.
        factoryName - The factory name.
        integrationRuntimeName - The integration runtime name.
        createLinkedIntegrationRuntimeRequest - The linked integration runtime properties.
        context - The context to associate with this operation.
        Returns:
        integration runtime status response along with Response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • getById

        IntegrationRuntimeResource getById​(String id)
        Gets 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)
        Gets 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)
        Deletes 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

        com.azure.core.http.rest.Response<Void> deleteByIdWithResponse​(String id,
                                                               com.azure.core.util.Context context)
        Deletes an integration runtime.
        Parameters:
        id - the resource ID.
        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.