integration_runtimes

Creates, updates, deletes, gets or lists an integration_runtimes resource.

Overview

Name	integration_runtimes
Type	Resource
Id	azure.data_factory.integration_runtimes

Fields

The following fields are returned by SELECT queries:

get

OK.

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
etag	string	Etag identifies change in the resource.
properties	object	Integration runtime properties.
type	string	The resource type.

list_by_factory

OK.

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
etag	string	Etag identifies change in the resource.
properties	object	Integration runtime properties.
type	string	The resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, factoryName, integrationRuntimeName	api-version, If-None-Match	Gets an integration runtime.
list_by_factory	select	subscriptionId, resourceGroupName, factoryName	api-version	Lists integration runtimes.
create_or_update	insert	subscriptionId, resourceGroupName, factoryName, integrationRuntimeName, data__properties	api-version, If-Match	Creates or updates an integration runtime.
update	update	subscriptionId, resourceGroupName, factoryName, integrationRuntimeName	api-version	Updates an integration runtime.
delete	delete	subscriptionId, resourceGroupName, factoryName, integrationRuntimeName	api-version	Deletes an integration runtime.
regenerate_auth_key	exec	subscriptionId, resourceGroupName, factoryName, integrationRuntimeName	api-version	Regenerates the authentication key for an integration runtime.
start	exec	subscriptionId, resourceGroupName, factoryName, integrationRuntimeName	api-version	Starts a ManagedReserved type integration runtime.
stop	exec	subscriptionId, resourceGroupName, factoryName, integrationRuntimeName	api-version	Stops a ManagedReserved type integration runtime.
sync_credentials	exec	subscriptionId, resourceGroupName, factoryName, integrationRuntimeName	api-version	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.
upgrade	exec	subscriptionId, resourceGroupName, factoryName, integrationRuntimeName	api-version	Upgrade self-hosted integration runtime to latest version if availability.
remove_links	exec	subscriptionId, resourceGroupName, factoryName, integrationRuntimeName, factoryName	api-version	Remove all linked integration runtimes under specific data factory in a self-hosted integration runtime.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
factoryName	string	The factory name.
integrationRuntimeName	string	The integration runtime name.
resourceGroupName	string	The resource group name.
subscriptionId	string	The subscription identifier.
If-Match	string	ETag of the integration runtime entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.
If-None-Match	string	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.
api-version	string	The API version.

SELECT examples

get

Gets an integration runtime.

SELECT
id,
name,
etag,
properties,
type
FROM azure.data_factory.integration_runtimes
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND factoryName = '{{ factoryName }}' -- required
AND integrationRuntimeName = '{{ integrationRuntimeName }}' -- required
AND api-version = '{{ api-version }}'
AND If-None-Match = '{{ If-None-Match }}'
;

list_by_factory

Lists integration runtimes.

SELECT
id,
name,
etag,
properties,
type
FROM azure.data_factory.integration_runtimes
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND factoryName = '{{ factoryName }}' -- required
AND api-version = '{{ api-version }}'
;

INSERT examples

create_or_update

Creates or updates an integration runtime.

INSERT INTO azure.data_factory.integration_runtimes (
data__properties,
subscriptionId,
resourceGroupName,
factoryName,
integrationRuntimeName,
api-version,
If-Match
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ factoryName }}',
'{{ integrationRuntimeName }}',
'{{ api-version }}',
'{{ If-Match }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: integration_runtimes
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the integration_runtimes resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the integration_runtimes resource.
    - name: factoryName
      value: string
      description: Required parameter for the integration_runtimes resource.
    - name: integrationRuntimeName
      value: string
      description: Required parameter for the integration_runtimes resource.
    - name: properties
      value: object
      description: |
        Integration runtime properties.
    - name: api-version
      value: string
      description: The API version.
    - name: If-Match
      value: string
      description: ETag of the integration runtime entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.

UPDATE examples

update

Updates an integration runtime.

UPDATE azure.data_factory.integration_runtimes
SET 
data__autoUpdate = '{{ autoUpdate }}',
data__updateDelayOffset = '{{ updateDelayOffset }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND factoryName = '{{ factoryName }}' --required
AND integrationRuntimeName = '{{ integrationRuntimeName }}' --required
AND api-version = '{{ api-version}}'
RETURNING
id,
name,
etag,
properties,
type;

DELETE examples

delete

Deletes an integration runtime.

DELETE FROM azure.data_factory.integration_runtimes
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND factoryName = '{{ factoryName }}' --required
AND integrationRuntimeName = '{{ integrationRuntimeName }}' --required
AND api-version = '{{ api-version }}'
;

Lifecycle Methods

regenerate_auth_key

Regenerates the authentication key for an integration runtime.

EXEC azure.data_factory.integration_runtimes.regenerate_auth_key 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@factoryName='{{ factoryName }}' --required, 
@integrationRuntimeName='{{ integrationRuntimeName }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"keyName": "{{ keyName }}"
}'
;

start

Starts a ManagedReserved type integration runtime.

EXEC azure.data_factory.integration_runtimes.start 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@factoryName='{{ factoryName }}' --required, 
@integrationRuntimeName='{{ integrationRuntimeName }}' --required, 
@api-version='{{ api-version }}'
;

stop

Stops a ManagedReserved type integration runtime.

EXEC azure.data_factory.integration_runtimes.stop 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@factoryName='{{ factoryName }}' --required, 
@integrationRuntimeName='{{ integrationRuntimeName }}' --required, 
@api-version='{{ api-version }}'
;

sync_credentials

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.

EXEC azure.data_factory.integration_runtimes.sync_credentials 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@factoryName='{{ factoryName }}' --required, 
@integrationRuntimeName='{{ integrationRuntimeName }}' --required, 
@api-version='{{ api-version }}'
;

upgrade

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

EXEC azure.data_factory.integration_runtimes.upgrade 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@factoryName='{{ factoryName }}' --required, 
@integrationRuntimeName='{{ integrationRuntimeName }}' --required, 
@api-version='{{ api-version }}'
;

remove_links

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

EXEC azure.data_factory.integration_runtimes.remove_links 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@factoryName='{{ factoryName }}' --required, 
@integrationRuntimeName='{{ integrationRuntimeName }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"factoryName": "{{ factoryName }}"
}'
;