IntegrationRuntimes interface
Interface representing a IntegrationRuntimes.
Methods
Method Details
beginStart(string, string, string, IntegrationRuntimesStartOptionalParams)
Starts a ManagedReserved type integration runtime.
function beginStart(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesStartOptionalParams): Promise<SimplePollerLike<OperationState<IntegrationRuntimeStatusResponse>, IntegrationRuntimeStatusResponse>>Parameters
- resourceGroupName
-
string
The resource group name.
- factoryName
-
string
The factory name.
- integrationRuntimeName
-
string
The integration runtime name.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<IntegrationRuntimeStatusResponse>, IntegrationRuntimeStatusResponse>>
beginStartAndWait(string, string, string, IntegrationRuntimesStartOptionalParams)
Starts a ManagedReserved type integration runtime.
function beginStartAndWait(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesStartOptionalParams): Promise<IntegrationRuntimeStatusResponse>Parameters
- resourceGroupName
-
string
The resource group name.
- factoryName
-
string
The factory name.
- integrationRuntimeName
-
string
The integration runtime name.
The options parameters.
Returns
Promise<IntegrationRuntimeStatusResponse>
beginStop(string, string, string, IntegrationRuntimesStopOptionalParams)
Stops a ManagedReserved type integration runtime.
function beginStop(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesStopOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The resource group name.
- factoryName
-
string
The factory name.
- integrationRuntimeName
-
string
The integration runtime name.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginStopAndWait(string, string, string, IntegrationRuntimesStopOptionalParams)
Stops a ManagedReserved type integration runtime.
function beginStopAndWait(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesStopOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The resource group name.
- factoryName
-
string
The factory name.
- integrationRuntimeName
-
string
The integration runtime name.
The options parameters.
Returns
Promise<void>
createLinkedIntegrationRuntime(string, string, string, CreateLinkedIntegrationRuntimeRequest, IntegrationRuntimesCreateLinkedIntegrationRuntimeOptionalParams)
Create a linked integration runtime entry in a shared integration runtime.
function createLinkedIntegrationRuntime(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, createLinkedIntegrationRuntimeRequest: CreateLinkedIntegrationRuntimeRequest, options?: IntegrationRuntimesCreateLinkedIntegrationRuntimeOptionalParams): Promise<IntegrationRuntimeStatusResponse>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.
The options parameters.
Returns
Promise<IntegrationRuntimeStatusResponse>
createOrUpdate(string, string, string, IntegrationRuntimeResource, IntegrationRuntimesCreateOrUpdateOptionalParams)
Creates or updates an integration runtime.
function createOrUpdate(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, integrationRuntime: IntegrationRuntimeResource, options?: IntegrationRuntimesCreateOrUpdateOptionalParams): Promise<IntegrationRuntimeResource>Parameters
- resourceGroupName
-
string
The resource group name.
- factoryName
-
string
The factory name.
- integrationRuntimeName
-
string
The integration runtime name.
- integrationRuntime
- IntegrationRuntimeResource
Integration runtime resource definition.
The options parameters.
Returns
Promise<IntegrationRuntimeResource>
delete(string, string, string, IntegrationRuntimesDeleteOptionalParams)
Deletes an integration runtime.
function delete(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The resource group name.
- factoryName
-
string
The factory name.
- integrationRuntimeName
-
string
The integration runtime name.
The options parameters.
Returns
Promise<void>
get(string, string, string, IntegrationRuntimesGetOptionalParams)
Gets an integration runtime.
function get(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesGetOptionalParams): Promise<IntegrationRuntimeResource>Parameters
- resourceGroupName
-
string
The resource group name.
- factoryName
-
string
The factory name.
- integrationRuntimeName
-
string
The integration runtime name.
The options parameters.
Returns
Promise<IntegrationRuntimeResource>
getConnectionInfo(string, string, string, IntegrationRuntimesGetConnectionInfoOptionalParams)
Gets the on-premises integration runtime connection information for encrypting the on-premises data source credentials.
function getConnectionInfo(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesGetConnectionInfoOptionalParams): Promise<IntegrationRuntimeConnectionInfo>Parameters
- resourceGroupName
-
string
The resource group name.
- factoryName
-
string
The factory name.
- integrationRuntimeName
-
string
The integration runtime name.
The options parameters.
Returns
Promise<IntegrationRuntimeConnectionInfo>
getMonitoringData(string, string, string, IntegrationRuntimesGetMonitoringDataOptionalParams)
Get the integration runtime monitoring data, which includes the monitor data for all the nodes under this integration runtime.
function getMonitoringData(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesGetMonitoringDataOptionalParams): Promise<IntegrationRuntimeMonitoringData>Parameters
- resourceGroupName
-
string
The resource group name.
- factoryName
-
string
The factory name.
- integrationRuntimeName
-
string
The integration runtime name.
The options parameters.
Returns
Promise<IntegrationRuntimeMonitoringData>
getStatus(string, string, string, IntegrationRuntimesGetStatusOptionalParams)
Gets detailed status information for an integration runtime.
function getStatus(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesGetStatusOptionalParams): Promise<IntegrationRuntimeStatusResponse>Parameters
- resourceGroupName
-
string
The resource group name.
- factoryName
-
string
The factory name.
- integrationRuntimeName
-
string
The integration runtime name.
The options parameters.
Returns
Promise<IntegrationRuntimeStatusResponse>
listAuthKeys(string, string, string, IntegrationRuntimesListAuthKeysOptionalParams)
Retrieves the authentication keys for an integration runtime.
function listAuthKeys(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesListAuthKeysOptionalParams): Promise<IntegrationRuntimeAuthKeys>Parameters
- resourceGroupName
-
string
The resource group name.
- factoryName
-
string
The factory name.
- integrationRuntimeName
-
string
The integration runtime name.
The options parameters.
Returns
Promise<IntegrationRuntimeAuthKeys>
listByFactory(string, string, IntegrationRuntimesListByFactoryOptionalParams)
Lists integration runtimes.
function listByFactory(resourceGroupName: string, factoryName: string, options?: IntegrationRuntimesListByFactoryOptionalParams): PagedAsyncIterableIterator<IntegrationRuntimeResource, IntegrationRuntimeResource[], PageSettings>Parameters
- resourceGroupName
-
string
The resource group name.
- factoryName
-
string
The factory name.
The options parameters.
Returns
listOutboundNetworkDependenciesEndpoints(string, string, string, IntegrationRuntimesListOutboundNetworkDependenciesEndpointsOptionalParams)
Gets the list of outbound network dependencies for a given Azure-SSIS integration runtime.
function listOutboundNetworkDependenciesEndpoints(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesListOutboundNetworkDependenciesEndpointsOptionalParams): Promise<IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse>Parameters
- resourceGroupName
-
string
The resource group name.
- factoryName
-
string
The factory name.
- integrationRuntimeName
-
string
The integration runtime name.
The options parameters.
Returns
regenerateAuthKey(string, string, string, IntegrationRuntimeRegenerateKeyParameters, IntegrationRuntimesRegenerateAuthKeyOptionalParams)
Regenerates the authentication key for an integration runtime.
function regenerateAuthKey(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, regenerateKeyParameters: IntegrationRuntimeRegenerateKeyParameters, options?: IntegrationRuntimesRegenerateAuthKeyOptionalParams): Promise<IntegrationRuntimeAuthKeys>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.
The options parameters.
Returns
Promise<IntegrationRuntimeAuthKeys>
removeLinks(string, string, string, LinkedIntegrationRuntimeRequest, IntegrationRuntimesRemoveLinksOptionalParams)
Remove all linked integration runtimes under specific data factory in a self-hosted integration runtime.
function removeLinks(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, linkedIntegrationRuntimeRequest: LinkedIntegrationRuntimeRequest, options?: IntegrationRuntimesRemoveLinksOptionalParams): Promise<void>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.
The options parameters.
Returns
Promise<void>
syncCredentials(string, string, string, IntegrationRuntimesSyncCredentialsOptionalParams)
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.
function syncCredentials(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesSyncCredentialsOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The resource group name.
- factoryName
-
string
The factory name.
- integrationRuntimeName
-
string
The integration runtime name.
The options parameters.
Returns
Promise<void>
update(string, string, string, UpdateIntegrationRuntimeRequest, IntegrationRuntimesUpdateOptionalParams)
Updates an integration runtime.
function update(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, updateIntegrationRuntimeRequest: UpdateIntegrationRuntimeRequest, options?: IntegrationRuntimesUpdateOptionalParams): Promise<IntegrationRuntimeResource>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.
The options parameters.
Returns
Promise<IntegrationRuntimeResource>
upgrade(string, string, string, IntegrationRuntimesUpgradeOptionalParams)
Upgrade self-hosted integration runtime to latest version if availability.
function upgrade(resourceGroupName: string, factoryName: string, integrationRuntimeName: string, options?: IntegrationRuntimesUpgradeOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The resource group name.
- factoryName
-
string
The factory name.
- integrationRuntimeName
-
string
The integration runtime name.
The options parameters.
Returns
Promise<void>