Package version:

Interface IntegrationRuntimes

Interface representing a IntegrationRuntimes.

interface IntegrationRuntimes {
    beginStart(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesStartOptionalParams): Promise<SimplePollerLike<OperationState<IntegrationRuntimeStatusResponse>, IntegrationRuntimeStatusResponse>>;
    beginStartAndWait(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesStartOptionalParams): Promise<IntegrationRuntimeStatusResponse>;
    beginStop(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesStopOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginStopAndWait(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesStopOptionalParams): Promise<void>;
    createLinkedIntegrationRuntime(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, createLinkedIntegrationRuntimeRequest: CreateLinkedIntegrationRuntimeRequest, options?: IntegrationRuntimesCreateLinkedIntegrationRuntimeOptionalParams): Promise<IntegrationRuntimeStatusResponse>;
    createOrUpdate(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, integrationRuntime: IntegrationRuntimeResource, options?: IntegrationRuntimesCreateOrUpdateOptionalParams): Promise<IntegrationRuntimeResource>;
    delete(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesDeleteOptionalParams): Promise<void>;
    get(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesGetOptionalParams): Promise<IntegrationRuntimeResource>;
    getConnectionInfo(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesGetConnectionInfoOptionalParams): Promise<IntegrationRuntimeConnectionInfo>;
    getMonitoringData(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesGetMonitoringDataOptionalParams): Promise<IntegrationRuntimeMonitoringData>;
    getStatus(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesGetStatusOptionalParams): Promise<IntegrationRuntimeStatusResponse>;
    listAuthKeys(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesListAuthKeysOptionalParams): Promise<IntegrationRuntimeAuthKeys>;
    listByFactory(resourceGroupName: string, factoryName: string, options?: IntegrationRuntimesListByFactoryOptionalParams): PagedAsyncIterableIterator<IntegrationRuntimeResource>;
    listOutboundNetworkDependenciesEndpoints(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesListOutboundNetworkDependenciesEndpointsOptionalParams): Promise<IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse>;
    regenerateAuthKey(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, regenerateKeyParameters: IntegrationRuntimeRegenerateKeyParameters, options?: IntegrationRuntimesRegenerateAuthKeyOptionalParams): Promise<IntegrationRuntimeAuthKeys>;
    removeLinks(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, linkedIntegrationRuntimeRequest: LinkedIntegrationRuntimeRequest, options?: IntegrationRuntimesRemoveLinksOptionalParams): Promise<void>;
    syncCredentials(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesSyncCredentialsOptionalParams): Promise<void>;
    update(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, updateIntegrationRuntimeRequest: UpdateIntegrationRuntimeRequest, options?: IntegrationRuntimesUpdateOptionalParams): Promise<IntegrationRuntimeResource>;
    upgrade(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesUpgradeOptionalParams): Promise<void>;
}

Index

Methods

beginStart beginStartAndWait beginStop beginStopAndWait createLinkedIntegrationRuntime createOrUpdate delete get getConnectionInfo getMonitoringData getStatus listAuthKeys listByFactory listOutboundNetworkDependenciesEndpoints regenerateAuthKey removeLinks syncCredentials update upgrade

Methods

beginStart

beginStart(resourceGroupName, factoryName, integrationRuntimeName, options?): Promise<SimplePollerLike<OperationState<IntegrationRuntimeStatusResponse>, IntegrationRuntimeStatusResponse>>
Starts a ManagedReserved type integration runtime.
Parameters
- resourceGroupName: string
  The resource group name.
- factoryName: string
  The factory name.
- integrationRuntimeName: string
  The integration runtime name.
- Optionaloptions: IntegrationRuntimesStartOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<IntegrationRuntimeStatusResponse>, IntegrationRuntimeStatusResponse>>
- Defined in operationsInterfaces/integrationRuntimes.ts:193

beginStartAndWait

beginStartAndWait(resourceGroupName, factoryName, integrationRuntimeName, options?): Promise<IntegrationRuntimeStatusResponse>
Starts a ManagedReserved type integration runtime.
Parameters
- resourceGroupName: string
  The resource group name.
- factoryName: string
  The factory name.
- integrationRuntimeName: string
  The integration runtime name.
- Optionaloptions: IntegrationRuntimesStartOptionalParams
  The options parameters.
Returns Promise<IntegrationRuntimeStatusResponse>
- Defined in operationsInterfaces/integrationRuntimes.ts:211

beginStop

beginStop(resourceGroupName, factoryName, integrationRuntimeName, options?): Promise<SimplePollerLike<OperationState<void>, void>>
Stops a ManagedReserved type integration runtime.
Parameters
- resourceGroupName: string
  The resource group name.
- factoryName: string
  The factory name.
- integrationRuntimeName: string
  The integration runtime name.
- Optionaloptions: IntegrationRuntimesStopOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/integrationRuntimes.ts:224

beginStopAndWait

beginStopAndWait(resourceGroupName, factoryName, integrationRuntimeName, options?): Promise<void>
Stops a ManagedReserved type integration runtime.
Parameters
- resourceGroupName: string
  The resource group name.
- factoryName: string
  The factory name.
- integrationRuntimeName: string
  The integration runtime name.
- Optionaloptions: IntegrationRuntimesStopOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/integrationRuntimes.ts:237

createLinkedIntegrationRuntime

createLinkedIntegrationRuntime(resourceGroupName, factoryName, integrationRuntimeName, createLinkedIntegrationRuntimeRequest, options?): Promise<IntegrationRuntimeStatusResponse>
Create a linked integration runtime entry in a shared integration runtime.
Parameters
- resourceGroupName: string
  The resource group name.
- factoryName: string
  The factory name.
- integrationRuntimeName: string
  The integration runtime name.
- createLinkedIntegrationRuntimeRequest: CreateLinkedIntegrationRuntimeRequest
  The linked integration runtime properties.
- Optionaloptions: IntegrationRuntimesCreateLinkedIntegrationRuntimeOptionalParams
  The options parameters.
Returns Promise<IntegrationRuntimeStatusResponse>
- Defined in operationsInterfaces/integrationRuntimes.ts:310

createOrUpdate

createOrUpdate(resourceGroupName, factoryName, integrationRuntimeName, integrationRuntime, options?): Promise<IntegrationRuntimeResource>
Creates or updates an integration runtime.
Parameters
- resourceGroupName: string
  The resource group name.
- factoryName: string
  The factory name.
- integrationRuntimeName: string
  The integration runtime name.
- integrationRuntime: IntegrationRuntimeResource
  Integration runtime resource definition.
- Optionaloptions: IntegrationRuntimesCreateOrUpdateOptionalParams
  The options parameters.
Returns Promise<IntegrationRuntimeResource>
- Defined in operationsInterfaces/integrationRuntimes.ts:69

delete

delete(resourceGroupName, factoryName, integrationRuntimeName, options?): Promise<void>
Deletes an integration runtime.
Parameters
- resourceGroupName: string
  The resource group name.
- factoryName: string
  The factory name.
- integrationRuntimeName: string
  The integration runtime name.
- Optionaloptions: IntegrationRuntimesDeleteOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/integrationRuntimes.ts:111

get

get(resourceGroupName, factoryName, integrationRuntimeName, options?): Promise<IntegrationRuntimeResource>
Gets an integration runtime.
Parameters
- resourceGroupName: string
  The resource group name.
- factoryName: string
  The factory name.
- integrationRuntimeName: string
  The integration runtime name.
- Optionaloptions: IntegrationRuntimesGetOptionalParams
  The options parameters.
Returns Promise<IntegrationRuntimeResource>
- Defined in operationsInterfaces/integrationRuntimes.ts:83

getConnectionInfo

getConnectionInfo(resourceGroupName, factoryName, integrationRuntimeName, options?): Promise<IntegrationRuntimeConnectionInfo>
Gets the on-premises integration runtime connection information for encrypting the on-premises data source credentials.
Parameters
- resourceGroupName: string
  The resource group name.
- factoryName: string
  The factory name.
- integrationRuntimeName: string
  The integration runtime name.
- Optionaloptions: IntegrationRuntimesGetConnectionInfoOptionalParams
  The options parameters.
Returns Promise<IntegrationRuntimeConnectionInfo>
- Defined in operationsInterfaces/integrationRuntimes.ts:151

getMonitoringData

getMonitoringData(resourceGroupName, factoryName, integrationRuntimeName, options?): Promise<IntegrationRuntimeMonitoringData>
Get the integration runtime monitoring data, which includes the monitor data for all the nodes under this integration runtime.
Parameters
- resourceGroupName: string
  The resource group name.
- factoryName: string
  The factory name.
- integrationRuntimeName: string
  The integration runtime name.
- Optionaloptions: IntegrationRuntimesGetMonitoringDataOptionalParams
  The options parameters.
Returns Promise<IntegrationRuntimeMonitoringData>
- Defined in operationsInterfaces/integrationRuntimes.ts:267

getStatus

getStatus(resourceGroupName, factoryName, integrationRuntimeName, options?): Promise<IntegrationRuntimeStatusResponse>
Gets detailed status information for an integration runtime.
Parameters
- resourceGroupName: string
  The resource group name.
- factoryName: string
  The factory name.
- integrationRuntimeName: string
  The integration runtime name.
- Optionaloptions: IntegrationRuntimesGetStatusOptionalParams
  The options parameters.
Returns Promise<IntegrationRuntimeStatusResponse>
- Defined in operationsInterfaces/integrationRuntimes.ts:124

listAuthKeys

listAuthKeys(resourceGroupName, factoryName, integrationRuntimeName, options?): Promise<IntegrationRuntimeAuthKeys>
Retrieves the authentication keys for an integration runtime.
Parameters
- resourceGroupName: string
  The resource group name.
- factoryName: string
  The factory name.
- integrationRuntimeName: string
  The integration runtime name.
- Optionaloptions: IntegrationRuntimesListAuthKeysOptionalParams
  The options parameters.
Returns Promise<IntegrationRuntimeAuthKeys>
- Defined in operationsInterfaces/integrationRuntimes.ts:180

listByFactory

listByFactory(resourceGroupName, factoryName, options?): PagedAsyncIterableIterator<IntegrationRuntimeResource>
Lists integration runtimes.
Parameters
- resourceGroupName: string
  The resource group name.
- factoryName: string
  The factory name.
- Optionaloptions: IntegrationRuntimesListByFactoryOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<IntegrationRuntimeResource>
- Defined in operationsInterfaces/integrationRuntimes.ts:56

listOutboundNetworkDependenciesEndpoints

listOutboundNetworkDependenciesEndpoints(resourceGroupName, factoryName, integrationRuntimeName, options?): Promise<IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse>
Gets the list of outbound network dependencies for a given Azure-SSIS integration runtime.
Parameters
- resourceGroupName: string
  The resource group name.
- factoryName: string
  The factory name.
- integrationRuntimeName: string
  The integration runtime name.
- Optionaloptions: IntegrationRuntimesListOutboundNetworkDependenciesEndpointsOptionalParams
  The options parameters.
Returns Promise<IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse>
- Defined in operationsInterfaces/integrationRuntimes.ts:137

regenerateAuthKey

regenerateAuthKey(resourceGroupName, factoryName, integrationRuntimeName, regenerateKeyParameters, options?): Promise<IntegrationRuntimeAuthKeys>
Regenerates the authentication key for an integration runtime.
Parameters
- resourceGroupName: string
  The resource group name.
- factoryName: string
  The factory name.
- integrationRuntimeName: string
  The integration runtime name.
- regenerateKeyParameters: IntegrationRuntimeRegenerateKeyParameters
  The parameters for regenerating integration runtime authentication key.
- Optionaloptions: IntegrationRuntimesRegenerateAuthKeyOptionalParams
  The options parameters.
Returns Promise<IntegrationRuntimeAuthKeys>
- Defined in operationsInterfaces/integrationRuntimes.ts:166

removeLinks

removeLinks(resourceGroupName, factoryName, integrationRuntimeName, linkedIntegrationRuntimeRequest, options?): Promise<void>
Remove all linked integration runtimes under specific data factory in a self-hosted integration runtime.
Parameters
- resourceGroupName: string
  The resource group name.
- factoryName: string
  The factory name.
- integrationRuntimeName: string
  The integration runtime name.
- linkedIntegrationRuntimeRequest: LinkedIntegrationRuntimeRequest
  The data factory name for the linked integration runtime.
- Optionaloptions: IntegrationRuntimesRemoveLinksOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/integrationRuntimes.ts:295

syncCredentials

syncCredentials(resourceGroupName, factoryName, integrationRuntimeName, options?): Promise<void>
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: string
  The resource group name.
- factoryName: string
  The factory name.
- integrationRuntimeName: string
  The integration runtime name.
- Optionaloptions: IntegrationRuntimesSyncCredentialsOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/integrationRuntimes.ts:253

update

update(resourceGroupName, factoryName, integrationRuntimeName, updateIntegrationRuntimeRequest, options?): Promise<IntegrationRuntimeResource>
Updates an integration runtime.
Parameters
- resourceGroupName: string
  The resource group name.
- factoryName: string
  The factory name.
- integrationRuntimeName: string
  The integration runtime name.
- updateIntegrationRuntimeRequest: UpdateIntegrationRuntimeRequest
  The parameters for updating an integration runtime.
- Optionaloptions: IntegrationRuntimesUpdateOptionalParams
  The options parameters.
Returns Promise<IntegrationRuntimeResource>
- Defined in operationsInterfaces/integrationRuntimes.ts:97

upgrade

upgrade(resourceGroupName, factoryName, integrationRuntimeName, options?): Promise<void>
Upgrade self-hosted integration runtime to latest version if availability.
Parameters
- resourceGroupName: string
  The resource group name.
- factoryName: string
  The factory name.
- integrationRuntimeName: string
  The integration runtime name.
- Optionaloptions: IntegrationRuntimesUpgradeOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/integrationRuntimes.ts:280

Interface IntegrationRuntimes

Index

Methods

Methods

beginStart

Parameters

Returns Promise<SimplePollerLike<OperationState<IntegrationRuntimeStatusResponse>, IntegrationRuntimeStatusResponse>>

beginStartAndWait

Parameters

Returns Promise<IntegrationRuntimeStatusResponse>

beginStop

Parameters

Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginStopAndWait

Parameters

Returns Promise<void>

createLinkedIntegrationRuntime

Parameters

Returns Promise<IntegrationRuntimeStatusResponse>

createOrUpdate

Parameters

Returns Promise<IntegrationRuntimeResource>

delete

Parameters

Returns Promise<void>

get

Parameters

Returns Promise<IntegrationRuntimeResource>

getConnectionInfo

Parameters

Returns Promise<IntegrationRuntimeConnectionInfo>

getMonitoringData

Parameters

Returns Promise<IntegrationRuntimeMonitoringData>

getStatus

Parameters

Returns Promise<IntegrationRuntimeStatusResponse>

listAuthKeys

Parameters

Returns Promise<IntegrationRuntimeAuthKeys>

listByFactory

Parameters

Returns PagedAsyncIterableIterator<IntegrationRuntimeResource>

listOutboundNetworkDependenciesEndpoints

Parameters

Returns Promise<IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse>

regenerateAuthKey

Parameters

Returns Promise<IntegrationRuntimeAuthKeys>

removeLinks

Parameters

Returns Promise<void>

syncCredentials

Parameters

Returns Promise<void>

update

Parameters

Returns Promise<IntegrationRuntimeResource>

upgrade

Parameters

Returns Promise<void>

Settings