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

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
description	string	Integration runtime description.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_factory

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
description	string	Integration runtime description.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, factory_name, integration_runtime_name, subscription_id		Gets an integration runtime.
list_by_factory	select	resource_group_name, factory_name, subscription_id		Lists integration runtimes.
create_or_update	insert	resource_group_name, factory_name, integration_runtime_name, subscription_id, properties		Creates or updates an integration runtime.
update	update	resource_group_name, factory_name, integration_runtime_name, subscription_id		Updates an integration runtime.
create_or_update	replace	resource_group_name, factory_name, integration_runtime_name, subscription_id, properties		Creates or updates an integration runtime.
delete	delete	resource_group_name, factory_name, integration_runtime_name, subscription_id		Deletes an integration runtime.
list_outbound_network_dependencies_endpoints	exec	resource_group_name, factory_name, integration_runtime_name, subscription_id		Gets the list of outbound network dependencies for a given Azure-SSIS integration runtime.
list_auth_keys	exec	resource_group_name, factory_name, integration_runtime_name, subscription_id		Retrieves the authentication keys for an integration runtime.
get_status	exec	resource_group_name, factory_name, integration_runtime_name, subscription_id		Gets detailed status information for an integration runtime.
get_connection_info	exec	resource_group_name, factory_name, integration_runtime_name, subscription_id		Gets the on-premises integration runtime connection information for encrypting the on-premises data source credentials.
get_monitoring_data	exec	resource_group_name, factory_name, integration_runtime_name, subscription_id		Get the integration runtime monitoring data, which includes the monitor data for all the nodes under this integration runtime.
regenerate_auth_key	exec	resource_group_name, factory_name, integration_runtime_name, subscription_id		Regenerates the authentication key for an integration runtime.
start	exec	resource_group_name, factory_name, integration_runtime_name, subscription_id		Starts a ManagedReserved type integration runtime.
stop	exec	resource_group_name, factory_name, integration_runtime_name, subscription_id		Stops a ManagedReserved type integration runtime.
sync_credentials	exec	resource_group_name, factory_name, integration_runtime_name, subscription_id		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	resource_group_name, factory_name, integration_runtime_name, subscription_id		Upgrade self-hosted integration runtime to latest version if availability.
remove_links	exec	resource_group_name, factory_name, integration_runtime_name, subscription_id, factoryName		Remove all linked integration runtimes under specific data factory in a self-hosted integration runtime.
create_linked_integration_runtime	exec	resource_group_name, factory_name, integration_runtime_name, subscription_id		Create a linked integration runtime entry in a shared 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
factory_name	string	The factory name. Required.
integration_runtime_name	string	The integration runtime name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets an integration runtime.

SELECT
id,
name,
description,
etag,
systemData,
type
FROM azure.data_factory.integration_runtimes
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND factory_name = '{{ factory_name }}' -- required
AND integration_runtime_name = '{{ integration_runtime_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_factory

Lists integration runtimes.

SELECT
id,
name,
description,
etag,
systemData,
type
FROM azure.data_factory.integration_runtimes
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND factory_name = '{{ factory_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates an integration runtime.

INSERT INTO azure.data_factory.integration_runtimes (
properties,
resource_group_name,
factory_name,
integration_runtime_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ factory_name }}',
'{{ integration_runtime_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: integration_runtimes
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the integration_runtimes resource.
  - name: factory_name
    value: "{{ factory_name }}"
    description: Required parameter for the integration_runtimes resource.
  - name: integration_runtime_name
    value: "{{ integration_runtime_name }}"
    description: Required parameter for the integration_runtimes resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the integration_runtimes resource.
  - name: properties
    description: |
      Integration runtime properties. Required.
    value:
      type: "{{ type }}"
      description: "{{ description }}"

UPDATE examples

update

Updates an integration runtime.

UPDATE azure.data_factory.integration_runtimes
SET 
autoUpdate = '{{ autoUpdate }}',
updateDelayOffset = '{{ updateDelayOffset }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND factory_name = '{{ factory_name }}' --required
AND integration_runtime_name = '{{ integration_runtime_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
properties,
systemData,
type;

REPLACE examples

create_or_update

Creates or updates an integration runtime.

REPLACE azure.data_factory.integration_runtimes
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND factory_name = '{{ factory_name }}' --required
AND integration_runtime_name = '{{ integration_runtime_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
etag,
properties,
systemData,
type;

DELETE examples

delete

Deletes an integration runtime.

DELETE FROM azure.data_factory.integration_runtimes
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND factory_name = '{{ factory_name }}' --required
AND integration_runtime_name = '{{ integration_runtime_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_outbound_network_dependencies_endpoints

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

EXEC azure.data_factory.integration_runtimes.list_outbound_network_dependencies_endpoints 
@resource_group_name='{{ resource_group_name }}' --required, 
@factory_name='{{ factory_name }}' --required, 
@integration_runtime_name='{{ integration_runtime_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_auth_keys

Retrieves the authentication keys for an integration runtime.

EXEC azure.data_factory.integration_runtimes.list_auth_keys 
@resource_group_name='{{ resource_group_name }}' --required, 
@factory_name='{{ factory_name }}' --required, 
@integration_runtime_name='{{ integration_runtime_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_status

Gets detailed status information for an integration runtime.

EXEC azure.data_factory.integration_runtimes.get_status 
@resource_group_name='{{ resource_group_name }}' --required, 
@factory_name='{{ factory_name }}' --required, 
@integration_runtime_name='{{ integration_runtime_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_connection_info

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

EXEC azure.data_factory.integration_runtimes.get_connection_info 
@resource_group_name='{{ resource_group_name }}' --required, 
@factory_name='{{ factory_name }}' --required, 
@integration_runtime_name='{{ integration_runtime_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_monitoring_data

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

EXEC azure.data_factory.integration_runtimes.get_monitoring_data 
@resource_group_name='{{ resource_group_name }}' --required, 
@factory_name='{{ factory_name }}' --required, 
@integration_runtime_name='{{ integration_runtime_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

regenerate_auth_key

Regenerates the authentication key for an integration runtime.

EXEC azure.data_factory.integration_runtimes.regenerate_auth_key 
@resource_group_name='{{ resource_group_name }}' --required, 
@factory_name='{{ factory_name }}' --required, 
@integration_runtime_name='{{ integration_runtime_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"keyName": "{{ keyName }}"
}'
;

start

Starts a ManagedReserved type integration runtime.

EXEC azure.data_factory.integration_runtimes.start 
@resource_group_name='{{ resource_group_name }}' --required, 
@factory_name='{{ factory_name }}' --required, 
@integration_runtime_name='{{ integration_runtime_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

stop

Stops a ManagedReserved type integration runtime.

EXEC azure.data_factory.integration_runtimes.stop 
@resource_group_name='{{ resource_group_name }}' --required, 
@factory_name='{{ factory_name }}' --required, 
@integration_runtime_name='{{ integration_runtime_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

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 
@resource_group_name='{{ resource_group_name }}' --required, 
@factory_name='{{ factory_name }}' --required, 
@integration_runtime_name='{{ integration_runtime_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

upgrade

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

EXEC azure.data_factory.integration_runtimes.upgrade 
@resource_group_name='{{ resource_group_name }}' --required, 
@factory_name='{{ factory_name }}' --required, 
@integration_runtime_name='{{ integration_runtime_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

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 
@resource_group_name='{{ resource_group_name }}' --required, 
@factory_name='{{ factory_name }}' --required, 
@integration_runtime_name='{{ integration_runtime_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"factoryName": "{{ factoryName }}"
}'
;

create_linked_integration_runtime

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

EXEC azure.data_factory.integration_runtimes.create_linked_integration_runtime 
@resource_group_name='{{ resource_group_name }}' --required, 
@factory_name='{{ factory_name }}' --required, 
@integration_runtime_name='{{ integration_runtime_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"name": "{{ name }}", 
"subscriptionId": "{{ subscriptionId }}", 
"dataFactoryName": "{{ dataFactoryName }}", 
"dataFactoryLocation": "{{ dataFactoryLocation }}"
}'
;