IntegrationRuntimesOperations interface

Package:
@azure/arm-datafactory

Interface representing a IntegrationRuntimes operations.

Properties

beginStart
beginStartAndWait
beginStop
beginStopAndWait
createLinkedIntegrationRuntime

Create a linked integration runtime entry in a shared integration runtime.
createOrUpdate

Creates or updates an integration runtime.
delete

Deletes an integration runtime.
get

Gets an integration runtime.
getConnectionInfo

Gets the on-premises integration runtime connection information for encrypting the on-premises data source credentials.
getMonitoringData

Get the integration runtime monitoring data, which includes the monitor data for all the nodes under this integration runtime.
getStatus

Gets detailed status information for an integration runtime.
listAuthKeys

Retrieves the authentication keys for an integration runtime.
listByFactory

Lists integration runtimes.
listOutboundNetworkDependenciesEndpoints

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

Regenerates the authentication key for an integration runtime.
removeLinks

Remove all linked integration runtimes under specific data factory in a self-hosted integration runtime.
start

Starts a ManagedReserved type integration runtime.
stop

Stops a ManagedReserved type integration runtime.
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.
update

Updates an integration runtime.
upgrade

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

Property Details

beginStart

Warning

This API is now deprecated.

use start instead

beginStart: (resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesStartOptionalParams) => Promise<SimplePollerLike<OperationState<IntegrationRuntimeStatusResponse>, IntegrationRuntimeStatusResponse>>

Property Value

(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesStartOptionalParams) => Promise<SimplePollerLike<OperationState<IntegrationRuntimeStatusResponse>, IntegrationRuntimeStatusResponse>>

beginStartAndWait

Warning

This API is now deprecated.

use start instead

beginStartAndWait: (resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesStartOptionalParams) => Promise<IntegrationRuntimeStatusResponse>

Property Value

(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesStartOptionalParams) => Promise<IntegrationRuntimeStatusResponse>

beginStop

Warning

This API is now deprecated.

use stop instead

beginStop: (resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesStopOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesStopOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginStopAndWait

Warning

This API is now deprecated.

use stop instead

beginStopAndWait: (resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesStopOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesStopOptionalParams) => Promise<void>

createLinkedIntegrationRuntime

Create a linked integration runtime entry in a shared integration runtime.

createLinkedIntegrationRuntime: (resourceGroupName: string, factoryName: string, integrationRuntimeName: string, createLinkedIntegrationRuntimeRequest: CreateLinkedIntegrationRuntimeRequest, options?: IntegrationRuntimesCreateLinkedIntegrationRuntimeOptionalParams) => Promise<IntegrationRuntimeStatusResponse>

Property Value

(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, createLinkedIntegrationRuntimeRequest: CreateLinkedIntegrationRuntimeRequest, options?: IntegrationRuntimesCreateLinkedIntegrationRuntimeOptionalParams) => Promise<IntegrationRuntimeStatusResponse>

createOrUpdate

Creates or updates an integration runtime.

createOrUpdate: (resourceGroupName: string, factoryName: string, integrationRuntimeName: string, integrationRuntime: IntegrationRuntimeResource, options?: IntegrationRuntimesCreateOrUpdateOptionalParams) => Promise<IntegrationRuntimeResource>

Property Value

(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, integrationRuntime: IntegrationRuntimeResource, options?: IntegrationRuntimesCreateOrUpdateOptionalParams) => Promise<IntegrationRuntimeResource>

delete

Deletes an integration runtime.

delete: (resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesDeleteOptionalParams) => Promise<void>

get

Gets an integration runtime.

get: (resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesGetOptionalParams) => Promise<IntegrationRuntimeResource>

Property Value

(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesGetOptionalParams) => Promise<IntegrationRuntimeResource>

getConnectionInfo

Gets the on-premises integration runtime connection information for encrypting the on-premises data source credentials.

getConnectionInfo: (resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesGetConnectionInfoOptionalParams) => Promise<IntegrationRuntimeConnectionInfo>

Property Value

(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesGetConnectionInfoOptionalParams) => Promise<IntegrationRuntimeConnectionInfo>

getMonitoringData

Get the integration runtime monitoring data, which includes the monitor data for all the nodes under this integration runtime.

getMonitoringData: (resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesGetMonitoringDataOptionalParams) => Promise<IntegrationRuntimeMonitoringData>

Property Value

(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesGetMonitoringDataOptionalParams) => Promise<IntegrationRuntimeMonitoringData>

getStatus

Gets detailed status information for an integration runtime.

getStatus: (resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesGetStatusOptionalParams) => Promise<IntegrationRuntimeStatusResponse>

Property Value

(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesGetStatusOptionalParams) => Promise<IntegrationRuntimeStatusResponse>

listAuthKeys

Retrieves the authentication keys for an integration runtime.

listAuthKeys: (resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesListAuthKeysOptionalParams) => Promise<IntegrationRuntimeAuthKeys>

Property Value

(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesListAuthKeysOptionalParams) => Promise<IntegrationRuntimeAuthKeys>

listByFactory

Lists integration runtimes.

listByFactory: (resourceGroupName: string, factoryName: string, options?: IntegrationRuntimesListByFactoryOptionalParams) => PagedAsyncIterableIterator<IntegrationRuntimeResource, IntegrationRuntimeResource[], PageSettings>

Property Value

(resourceGroupName: string, factoryName: string, options?: IntegrationRuntimesListByFactoryOptionalParams) => PagedAsyncIterableIterator<IntegrationRuntimeResource, IntegrationRuntimeResource[], PageSettings>

listOutboundNetworkDependenciesEndpoints

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

listOutboundNetworkDependenciesEndpoints: (resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesListOutboundNetworkDependenciesEndpointsOptionalParams) => Promise<IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse>

Property Value

(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesListOutboundNetworkDependenciesEndpointsOptionalParams) => Promise<IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse>

regenerateAuthKey

Regenerates the authentication key for an integration runtime.

regenerateAuthKey: (resourceGroupName: string, factoryName: string, integrationRuntimeName: string, regenerateKeyParameters: IntegrationRuntimeRegenerateKeyParameters, options?: IntegrationRuntimesRegenerateAuthKeyOptionalParams) => Promise<IntegrationRuntimeAuthKeys>

Property Value

(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, regenerateKeyParameters: IntegrationRuntimeRegenerateKeyParameters, options?: IntegrationRuntimesRegenerateAuthKeyOptionalParams) => Promise<IntegrationRuntimeAuthKeys>

Remove all linked integration runtimes under specific data factory in a self-hosted integration runtime.

removeLinks: (resourceGroupName: string, factoryName: string, integrationRuntimeName: string, linkedIntegrationRuntimeRequest: LinkedIntegrationRuntimeRequest, options?: IntegrationRuntimesRemoveLinksOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, linkedIntegrationRuntimeRequest: LinkedIntegrationRuntimeRequest, options?: IntegrationRuntimesRemoveLinksOptionalParams) => Promise<void>

start

Starts a ManagedReserved type integration runtime.

start: (resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesStartOptionalParams) => PollerLike<OperationState<IntegrationRuntimeStatusResponse>, IntegrationRuntimeStatusResponse>

Property Value

(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesStartOptionalParams) => PollerLike<OperationState<IntegrationRuntimeStatusResponse>, IntegrationRuntimeStatusResponse>

stop

Stops a ManagedReserved type integration runtime.

stop: (resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesStopOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesStopOptionalParams) => PollerLike<OperationState<void>, 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.

syncCredentials: (resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesSyncCredentialsOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesSyncCredentialsOptionalParams) => Promise<void>

update

Updates an integration runtime.

update: (resourceGroupName: string, factoryName: string, integrationRuntimeName: string, updateIntegrationRuntimeRequest: UpdateIntegrationRuntimeRequest, options?: IntegrationRuntimesUpdateOptionalParams) => Promise<IntegrationRuntimeResource>

Property Value

(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, updateIntegrationRuntimeRequest: UpdateIntegrationRuntimeRequest, options?: IntegrationRuntimesUpdateOptionalParams) => Promise<IntegrationRuntimeResource>

upgrade

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

upgrade: (resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesUpgradeOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesUpgradeOptionalParams) => Promise<void>