Package com.azure.resourcemanager.datafactory.models

Interface IntegrationRuntimeResource

  • public interface IntegrationRuntimeResource
    An immutable client-side representation of IntegrationRuntimeResource.

    • Method Detail

      • id

        String id()
        Gets the id property: Fully qualified resource Id for the resource.
        Returns:
        the id value.

      • properties

        IntegrationRuntime properties()
        Gets the properties property: Integration runtime properties.
        Returns:
        the properties value.

      • name

        String name()
        Gets the name property: The resource name.
        Returns:
        the name value.

      • type

        String type()
        Gets the type property: The resource type.
        Returns:
        the type value.

      • etag

        String etag()
        Gets the etag property: Etag identifies change in the resource.
        Returns:
        the etag value.

      • innerModel

        IntegrationRuntimeResourceInner innerModel()
        Gets the inner com.azure.resourcemanager.datafactory.fluent.models.IntegrationRuntimeResourceInner object.
        Returns:
        the inner object.

      • refresh

        IntegrationRuntimeResource refresh​(com.azure.core.util.Context context)
        Refreshes the resource to sync with Azure.
        Parameters:
        context - The context to associate with this operation.
        Returns:
        the refreshed resource.

      • getStatus

        IntegrationRuntimeStatusResponse getStatus()
        Gets detailed status information for an integration runtime.
        Returns:
        detailed status information for an integration runtime.
        Throws:
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • getStatusWithResponse

        com.azure.core.http.rest.Response<IntegrationRuntimeStatusResponse> getStatusWithResponse​(com.azure.core.util.Context context)
        Gets detailed status information for an integration runtime.
        Parameters:
        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.

      • getConnectionInfo

        IntegrationRuntimeConnectionInfo getConnectionInfo()
        Gets the on-premises integration runtime connection information for encrypting the on-premises data source credentials.
        Returns:
        the on-premises integration runtime connection information for encrypting the on-premises data source credentials.
        Throws:
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • getConnectionInfoWithResponse

        com.azure.core.http.rest.Response<IntegrationRuntimeConnectionInfo> getConnectionInfoWithResponse​(com.azure.core.util.Context context)
        Gets the on-premises integration runtime connection information for encrypting the on-premises data source credentials.
        Parameters:
        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​(IntegrationRuntimeRegenerateKeyParameters regenerateKeyParameters)
        Regenerates the authentication key for an integration runtime.
        Parameters:
        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​(IntegrationRuntimeRegenerateKeyParameters regenerateKeyParameters,
                                                                                            com.azure.core.util.Context context)
        Regenerates the authentication key for an integration runtime.
        Parameters:
        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()
        Retrieves the authentication keys for an integration runtime.
        Returns:
        the integration runtime authentication keys.
        Throws:
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • listAuthKeysWithResponse

        com.azure.core.http.rest.Response<IntegrationRuntimeAuthKeys> listAuthKeysWithResponse​(com.azure.core.util.Context context)
        Retrieves the authentication keys for an integration runtime.
        Parameters:
        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()
        Starts a ManagedReserved type integration runtime.
        Returns:
        integration runtime status response.
        Throws:
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • start

        IntegrationRuntimeStatusResponse start​(com.azure.core.util.Context context)
        Starts a ManagedReserved type integration runtime.
        Parameters:
        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()
        Stops a ManagedReserved type integration runtime.
        Throws:
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • stop

        void stop​(com.azure.core.util.Context context)
        Stops a ManagedReserved type integration runtime.
        Parameters:
        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()
        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.
        Throws:
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • syncCredentialsWithResponse

        com.azure.core.http.rest.Response<Void> syncCredentialsWithResponse​(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:
        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()
        Get the integration runtime monitoring data, which includes the monitor data for all the nodes under this integration runtime.
        Returns:
        the integration runtime monitoring data, which includes the monitor data for all the nodes under this integration runtime.
        Throws:
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • getMonitoringDataWithResponse

        com.azure.core.http.rest.Response<IntegrationRuntimeMonitoringData> getMonitoringDataWithResponse​(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:
        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()
        Upgrade self-hosted integration runtime to latest version if availability.
        Throws:
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • upgradeWithResponse

        com.azure.core.http.rest.Response<Void> upgradeWithResponse​(com.azure.core.util.Context context)
        Upgrade self-hosted integration runtime to latest version if availability.
        Parameters:
        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​(LinkedIntegrationRuntimeRequest linkedIntegrationRuntimeRequest)
        Remove all linked integration runtimes under specific data factory in a self-hosted integration runtime.
        Parameters:
        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​(LinkedIntegrationRuntimeRequest linkedIntegrationRuntimeRequest,
                                                                com.azure.core.util.Context context)
        Remove all linked integration runtimes under specific data factory in a self-hosted integration runtime.
        Parameters:
        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​(CreateLinkedIntegrationRuntimeRequest createLinkedIntegrationRuntimeRequest)
        Create a linked integration runtime entry in a shared integration runtime.
        Parameters:
        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​(CreateLinkedIntegrationRuntimeRequest createLinkedIntegrationRuntimeRequest,
                                                                                                               com.azure.core.util.Context context)
        Create a linked integration runtime entry in a shared integration runtime.
        Parameters:
        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.