IntegrationRuntimes Interface

Package:

com.azure.resourcemanager.datafactory.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-datafactory:1.0.0-beta.28

public interface IntegrationRuntimes

Resource collection API of IntegrationRuntimes.

Method Summary

Modifier and Type	Method and Description
abstract IntegrationRuntimeStatusResponse	createLinkedIntegrationRuntime(String resourceGroupName, String factoryName, String integrationRuntimeName, CreateLinkedIntegrationRuntimeRequest createLinkedIntegrationRuntimeRequest) Create a linked integration runtime entry in a shared integration runtime.
abstract Response<IntegrationRuntimeStatusResponse>	createLinkedIntegrationRuntimeWithResponse(String resourceGroupName, String factoryName, String integrationRuntimeName, CreateLinkedIntegrationRuntimeRequest createLinkedIntegrationRuntimeRequest, Context context) Create a linked integration runtime entry in a shared integration runtime.
abstract Blank	define(String name) Begins definition for a new IntegrationRuntimeResource resource.
abstract void	delete(String resourceGroupName, String factoryName, String integrationRuntimeName) Deletes an integration runtime.
abstract void	deleteById(String id) Deletes an integration runtime.
abstract Response<Void>	deleteByIdWithResponse(String id, Context context) Deletes an integration runtime.
abstract Response<Void>	deleteWithResponse(String resourceGroupName, String factoryName, String integrationRuntimeName, Context context) Deletes an integration runtime.
abstract IntegrationRuntimeResource	get(String resourceGroupName, String factoryName, String integrationRuntimeName) Gets an integration runtime.
abstract IntegrationRuntimeResource	getById(String id) Gets an integration runtime.
abstract Response<IntegrationRuntimeResource>	getByIdWithResponse(String id, String ifNoneMatch, Context context) Gets an integration runtime.
abstract IntegrationRuntimeConnectionInfo	getConnectionInfo(String resourceGroupName, String factoryName, String integrationRuntimeName) Gets the on-premises integration runtime connection information for encrypting the on-premises data source credentials.
abstract Response<IntegrationRuntimeConnectionInfo>	getConnectionInfoWithResponse(String resourceGroupName, String factoryName, String integrationRuntimeName, Context context) Gets the on-premises integration runtime connection information for encrypting the on-premises data source credentials.
abstract 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.
abstract Response<IntegrationRuntimeMonitoringData>	getMonitoringDataWithResponse(String resourceGroupName, String factoryName, String integrationRuntimeName, Context context) Get the integration runtime monitoring data, which includes the monitor data for all the nodes under this integration runtime.
abstract IntegrationRuntimeStatusResponse	getStatus(String resourceGroupName, String factoryName, String integrationRuntimeName) Gets detailed status information for an integration runtime.
abstract Response<IntegrationRuntimeStatusResponse>	getStatusWithResponse(String resourceGroupName, String factoryName, String integrationRuntimeName, Context context) Gets detailed status information for an integration runtime.
abstract Response<IntegrationRuntimeResource>	getWithResponse(String resourceGroupName, String factoryName, String integrationRuntimeName, String ifNoneMatch, Context context) Gets an integration runtime.
abstract IntegrationRuntimeAuthKeys	listAuthKeys(String resourceGroupName, String factoryName, String integrationRuntimeName) Retrieves the authentication keys for an integration runtime.
abstract Response<IntegrationRuntimeAuthKeys>	listAuthKeysWithResponse(String resourceGroupName, String factoryName, String integrationRuntimeName, Context context) Retrieves the authentication keys for an integration runtime.
abstract PagedIterable<IntegrationRuntimeResource>	listByFactory(String resourceGroupName, String factoryName) Lists integration runtimes.
abstract PagedIterable<IntegrationRuntimeResource>	listByFactory(String resourceGroupName, String factoryName, Context context) Lists integration runtimes.
abstract IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse	listOutboundNetworkDependenciesEndpoints(String resourceGroupName, String factoryName, String integrationRuntimeName) Gets the list of outbound network dependencies for a given Azure-SSIS integration runtime.
abstract Response<IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse>	listOutboundNetworkDependenciesEndpointsWithResponse(String resourceGroupName, String factoryName, String integrationRuntimeName, Context context) Gets the list of outbound network dependencies for a given Azure-SSIS integration runtime.
abstract IntegrationRuntimeAuthKeys	regenerateAuthKey(String resourceGroupName, String factoryName, String integrationRuntimeName, IntegrationRuntimeRegenerateKeyParameters regenerateKeyParameters) Regenerates the authentication key for an integration runtime.
abstract Response<IntegrationRuntimeAuthKeys>	regenerateAuthKeyWithResponse(String resourceGroupName, String factoryName, String integrationRuntimeName, IntegrationRuntimeRegenerateKeyParameters regenerateKeyParameters, Context context) Regenerates the authentication key for an integration runtime.
abstract 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.
abstract Response<Void>	removeLinksWithResponse(String resourceGroupName, String factoryName, String integrationRuntimeName, LinkedIntegrationRuntimeRequest linkedIntegrationRuntimeRequest, Context context) Remove all linked integration runtimes under specific data factory in a self-hosted integration runtime.
abstract IntegrationRuntimeStatusResponse	start(String resourceGroupName, String factoryName, String integrationRuntimeName) Starts a ManagedReserved type integration runtime.
abstract IntegrationRuntimeStatusResponse	start(String resourceGroupName, String factoryName, String integrationRuntimeName, Context context) Starts a ManagedReserved type integration runtime.
abstract void	stop(String resourceGroupName, String factoryName, String integrationRuntimeName) Stops a ManagedReserved type integration runtime.
abstract void	stop(String resourceGroupName, String factoryName, String integrationRuntimeName, Context context) Stops a ManagedReserved type integration runtime.
abstract 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.
abstract Response<Void>	syncCredentialsWithResponse(String resourceGroupName, String factoryName, String integrationRuntimeName, 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.
abstract void	upgrade(String resourceGroupName, String factoryName, String integrationRuntimeName) Upgrade self-hosted integration runtime to latest version if availability.
abstract Response<Void>	upgradeWithResponse(String resourceGroupName, String factoryName, String integrationRuntimeName, Context context) Upgrade self-hosted integration runtime to latest version if availability.

Method Details

createLinkedIntegrationRuntime

public abstract 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.

createLinkedIntegrationRuntimeWithResponse

public abstract Response createLinkedIntegrationRuntimeWithResponse(String resourceGroupName, String factoryName, String integrationRuntimeName, CreateLinkedIntegrationRuntimeRequest createLinkedIntegrationRuntimeRequest, 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<T>.

define

public abstract 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.

delete

public abstract 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.

deleteById

public abstract void deleteById(String id)

Deletes an integration runtime.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract Response deleteByIdWithResponse(String id, Context context)

Deletes an integration runtime.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

the Response<T>.

deleteWithResponse

public abstract Response deleteWithResponse(String resourceGroupName, String factoryName, String integrationRuntimeName, 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<T>.

get

public abstract 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.

getById

public abstract IntegrationRuntimeResource getById(String id)

Gets an integration runtime.

Parameters:

id - the resource ID.

Returns:

an integration runtime along with Response<T>.

getByIdWithResponse

public abstract Response getByIdWithResponse(String id, String ifNoneMatch, 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<T>.

getConnectionInfo

public abstract 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.

getConnectionInfoWithResponse

public abstract Response getConnectionInfoWithResponse(String resourceGroupName, String factoryName, String integrationRuntimeName, 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<T>.

getMonitoringData

public abstract 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.

getMonitoringDataWithResponse

public abstract Response getMonitoringDataWithResponse(String resourceGroupName, String factoryName, String integrationRuntimeName, 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<T>.

getStatus

public abstract 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.

getStatusWithResponse

public abstract Response getStatusWithResponse(String resourceGroupName, String factoryName, String integrationRuntimeName, 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<T>.

getWithResponse

public abstract Response getWithResponse(String resourceGroupName, String factoryName, String integrationRuntimeName, String ifNoneMatch, 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<T>.

listAuthKeys

public abstract 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.

listAuthKeysWithResponse

public abstract Response listAuthKeysWithResponse(String resourceGroupName, String factoryName, String integrationRuntimeName, 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<T>.

listByFactory

public abstract PagedIterable 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<T>.

listByFactory

public abstract PagedIterable listByFactory(String resourceGroupName, String factoryName, 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<T>.

listOutboundNetworkDependenciesEndpoints

public abstract 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.

listOutboundNetworkDependenciesEndpointsWithResponse

public abstract Response listOutboundNetworkDependenciesEndpointsWithResponse(String resourceGroupName, String factoryName, String integrationRuntimeName, 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<T>.

regenerateAuthKey

public abstract 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.

regenerateAuthKeyWithResponse

public abstract Response regenerateAuthKeyWithResponse(String resourceGroupName, String factoryName, String integrationRuntimeName, IntegrationRuntimeRegenerateKeyParameters regenerateKeyParameters, 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<T>.

removeLinks

public abstract 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.

removeLinksWithResponse

public abstract Response removeLinksWithResponse(String resourceGroupName, String factoryName, String integrationRuntimeName, LinkedIntegrationRuntimeRequest linkedIntegrationRuntimeRequest, 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<T>.

start

public abstract 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.

start

public abstract IntegrationRuntimeStatusResponse start(String resourceGroupName, String factoryName, String integrationRuntimeName, 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.

stop

public abstract 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.

stop

public abstract void stop(String resourceGroupName, String factoryName, String integrationRuntimeName, 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.

syncCredentials

public abstract 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.

syncCredentialsWithResponse

public abstract Response syncCredentialsWithResponse(String resourceGroupName, String factoryName, String integrationRuntimeName, 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<T>.

upgrade

public abstract 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.

upgradeWithResponse

public abstract Response upgradeWithResponse(String resourceGroupName, String factoryName, String integrationRuntimeName, 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<T>.