integration_runtimes

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

Overview

Name	integration_runtimes
Type	Resource
Id	azure.data_factory.integration_runtimes

Fields

vw_integration_runtimes

Name	Datatype	Description
id	text	The resource identifier.
name	text	The resource name.
description	text	field from the properties object
etag	text	Etag identifies change in the resource.
factoryName	text	field from the properties object
integrationRuntimeName	text	field from the properties object
resourceGroupName	text	field from the properties object
subscriptionId	text	field from the properties object
type	text	The resource type.

integration_runtimes

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
etag	string	Etag identifies change in the resource.
properties	object	Azure Data Factory nested object which serves as a compute resource for activities.
type	string	The resource type.

Methods

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

SELECT examples

Lists integration runtimes.

vw_integration_runtimes

SELECT
id,
name,
description,
etag,
factoryName,
integrationRuntimeName,
resourceGroupName,
subscriptionId,
type
FROM azure.data_factory.vw_integration_runtimes
WHERE factoryName = '{{ factoryName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

integration_runtimes

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

INSERT example

Use the following StackQL query and manifest file to create a new integration_runtimes resource.

All Properties

/*+ create */
INSERT INTO azure.data_factory.integration_runtimes (
factoryName,
integrationRuntimeName,
resourceGroupName,
subscriptionId,
data__properties,
properties
)
SELECT 
'{{ factoryName }}',
'{{ integrationRuntimeName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__properties }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: etag
      value: string
    - name: properties
      value:
        - name: type
          value: []
        - name: description
          value: string

UPDATE example

Updates a integration_runtimes resource.

/*+ update */
UPDATE azure.data_factory.integration_runtimes
SET 
autoUpdate = '{{ autoUpdate }}',
updateDelayOffset = '{{ updateDelayOffset }}'
WHERE 
factoryName = '{{ factoryName }}'
AND integrationRuntimeName = '{{ integrationRuntimeName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified integration_runtimes resource.

/*+ delete */
DELETE FROM azure.data_factory.integration_runtimes
WHERE factoryName = '{{ factoryName }}'
AND integrationRuntimeName = '{{ integrationRuntimeName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';