IntegrationRuntimeResource Interface

Package:

com.azure.resourcemanager.datafactory.models

Maven Artifact:

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

public interface IntegrationRuntimeResource

An immutable client-side representation of IntegrationRuntimeResource.

Method Summary

Modifier and Type	Method and Description
abstract IntegrationRuntimeStatusResponse	createLinkedIntegrationRuntime(CreateLinkedIntegrationRuntimeRequest createLinkedIntegrationRuntimeRequest) Create a linked integration runtime entry in a shared integration runtime.
abstract Response<IntegrationRuntimeStatusResponse>	createLinkedIntegrationRuntimeWithResponse(CreateLinkedIntegrationRuntimeRequest createLinkedIntegrationRuntimeRequest, Context context) Create a linked integration runtime entry in a shared integration runtime.
abstract String	etag() Gets the etag property: Etag identifies change in the resource.
abstract IntegrationRuntimeConnectionInfo	getConnectionInfo() Gets the on-premises integration runtime connection information for encrypting the on-premises data source credentials.
abstract Response<IntegrationRuntimeConnectionInfo>	getConnectionInfoWithResponse(Context context) Gets the on-premises integration runtime connection information for encrypting the on-premises data source credentials.
abstract IntegrationRuntimeMonitoringData	getMonitoringData() Get the integration runtime monitoring data, which includes the monitor data for all the nodes under this integration runtime.
abstract Response<IntegrationRuntimeMonitoringData>	getMonitoringDataWithResponse(Context context) Get the integration runtime monitoring data, which includes the monitor data for all the nodes under this integration runtime.
abstract IntegrationRuntimeStatusResponse	getStatus() Gets detailed status information for an integration runtime.
abstract Response<IntegrationRuntimeStatusResponse>	getStatusWithResponse(Context context) Gets detailed status information for an integration runtime.
abstract String	id() Gets the id property: Fully qualified resource Id for the resource.
abstract IntegrationRuntimeResourceInner	innerModel() Gets the inner com.azure.resourcemanager.datafactory.fluent.models.IntegrationRuntimeResourceInner object.
abstract IntegrationRuntimeAuthKeys	listAuthKeys() Retrieves the authentication keys for an integration runtime.
abstract Response<IntegrationRuntimeAuthKeys>	listAuthKeysWithResponse(Context context) Retrieves the authentication keys for an integration runtime.
abstract String	name() Gets the name property: The resource name.
abstract IntegrationRuntime	properties() Gets the properties property: Integration runtime properties.
abstract IntegrationRuntimeResource	refresh() Refreshes the resource to sync with Azure.
abstract IntegrationRuntimeResource	refresh(Context context) Refreshes the resource to sync with Azure.
abstract IntegrationRuntimeAuthKeys	regenerateAuthKey(IntegrationRuntimeRegenerateKeyParameters regenerateKeyParameters) Regenerates the authentication key for an integration runtime.
abstract Response<IntegrationRuntimeAuthKeys>	regenerateAuthKeyWithResponse(IntegrationRuntimeRegenerateKeyParameters regenerateKeyParameters, Context context) Regenerates the authentication key for an integration runtime.
abstract void	removeLinks(LinkedIntegrationRuntimeRequest linkedIntegrationRuntimeRequest) Remove all linked integration runtimes under specific data factory in a self-hosted integration runtime.
abstract Response<Void>	removeLinksWithResponse(LinkedIntegrationRuntimeRequest linkedIntegrationRuntimeRequest, Context context) Remove all linked integration runtimes under specific data factory in a self-hosted integration runtime.
abstract String	resourceGroupName() Gets the name of the resource group.
abstract IntegrationRuntimeStatusResponse	start() Starts a ManagedReserved type integration runtime.
abstract IntegrationRuntimeStatusResponse	start(Context context) Starts a ManagedReserved type integration runtime.
abstract void	stop() Stops a ManagedReserved type integration runtime.
abstract void	stop(Context context) Stops a ManagedReserved type integration runtime.
abstract 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.
abstract Response<Void>	syncCredentialsWithResponse(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 String	type() Gets the type property: The resource type.
abstract Update	update() Begins update for the IntegrationRuntimeResource resource.
abstract void	upgrade() Upgrade self-hosted integration runtime to latest version if availability.
abstract Response<Void>	upgradeWithResponse(Context context) Upgrade self-hosted integration runtime to latest version if availability.

Method Details

createLinkedIntegrationRuntime

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

createLinkedIntegrationRuntimeWithResponse

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

etag

public abstract String etag()

Gets the etag property: Etag identifies change in the resource.

Returns:

the etag value.

getConnectionInfo

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

getConnectionInfoWithResponse

public abstract Response getConnectionInfoWithResponse(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<T>.

getMonitoringData

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

getMonitoringDataWithResponse

public abstract Response getMonitoringDataWithResponse(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<T>.

getStatus

public abstract IntegrationRuntimeStatusResponse getStatus()

Gets detailed status information for an integration runtime.

Returns:

detailed status information for an integration runtime.

getStatusWithResponse

public abstract Response getStatusWithResponse(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<T>.

id

public abstract String id()

Gets the id property: Fully qualified resource Id for the resource.

Returns:

the id value.

innerModel

public abstract IntegrationRuntimeResourceInner innerModel()

Gets the inner com.azure.resourcemanager.datafactory.fluent.models.IntegrationRuntimeResourceInner object.

Returns:

the inner object.

listAuthKeys

public abstract IntegrationRuntimeAuthKeys listAuthKeys()

Retrieves the authentication keys for an integration runtime.

Returns:

the integration runtime authentication keys.

listAuthKeysWithResponse

public abstract Response listAuthKeysWithResponse(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<T>.

name

public abstract String name()

Gets the name property: The resource name.

Returns:

the name value.

properties

public abstract IntegrationRuntime properties()

Gets the properties property: Integration runtime properties.

Returns:

the properties value.

refresh

public abstract IntegrationRuntimeResource refresh()

Refreshes the resource to sync with Azure.

Returns:

the refreshed resource.

refresh

public abstract IntegrationRuntimeResource refresh(Context context)

Refreshes the resource to sync with Azure.

Parameters:

context - The context to associate with this operation.

Returns:

the refreshed resource.

regenerateAuthKey

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

regenerateAuthKeyWithResponse

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

removeLinks

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

removeLinksWithResponse

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

resourceGroupName

public abstract String resourceGroupName()

Gets the name of the resource group.

Returns:

the name of the resource group.

start

public abstract IntegrationRuntimeStatusResponse start()

Starts a ManagedReserved type integration runtime.

Returns:

integration runtime status response.

start

public abstract IntegrationRuntimeStatusResponse start(Context context)

Starts a ManagedReserved type integration runtime.

Parameters:

context - The context to associate with this operation.

Returns:

integration runtime status response.

stop

public abstract void stop()

Stops a ManagedReserved type integration runtime.

stop

public abstract void stop(Context context)

Stops a ManagedReserved type integration runtime.

Parameters:

context - The context to associate with this operation.

syncCredentials

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

syncCredentialsWithResponse

public abstract Response syncCredentialsWithResponse(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<T>.

type

public abstract String type()

Gets the type property: The resource type.

Returns:

the type value.

update

public abstract IntegrationRuntimeResource.Update update()

Begins update for the IntegrationRuntimeResource resource.

Returns:

the stage of resource update.

upgrade

public abstract void upgrade()

Upgrade self-hosted integration runtime to latest version if availability.

upgradeWithResponse

public abstract Response upgradeWithResponse(Context context)

Upgrade self-hosted integration runtime to latest version if availability.

Parameters:

context - The context to associate with this operation.

Returns:

the Response<T>.