integration_runtimes

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

Overview

Name	integration_runtimes
Type	Resource
Id	azure.synapse.integration_runtimes

Fields

vw_integration_runtimes

Name	Datatype	Description
description	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	field from the properties object
workspaceName	text	field from the properties object

integration_runtimes

Name	Datatype	Description
properties	object	Azure Synapse nested object which serves as a compute resource for activities.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	integrationRuntimeName, resourceGroupName, subscriptionId, workspaceName	Get an integration runtime
list_by_workspace	SELECT	resourceGroupName, subscriptionId, workspaceName	List all integration runtimes
create	INSERT	integrationRuntimeName, resourceGroupName, subscriptionId, workspaceName, data__properties	Create an integration runtime
delete	DELETE	integrationRuntimeName, resourceGroupName, subscriptionId, workspaceName	Delete an integration runtime
update	UPDATE	integrationRuntimeName, resourceGroupName, subscriptionId, workspaceName	Update an integration runtime
disable_interactive_query	EXEC	integrationRuntimeName, resourceGroupName, subscriptionId, workspaceName	Disable interactive query in integration runtime
enable_interactive_query	EXEC	integrationRuntimeName, resourceGroupName, subscriptionId, workspaceName	Enable interactive query in integration runtime
start	EXEC	integrationRuntimeName, resourceGroupName, subscriptionId, workspaceName	Start an integration runtime
stop	EXEC	integrationRuntimeName, resourceGroupName, subscriptionId, workspaceName	Stop an integration runtime
upgrade	EXEC	integrationRuntimeName, resourceGroupName, subscriptionId, workspaceName	Upgrade an integration runtime

SELECT examples

List all integration runtimes

vw_integration_runtimes

SELECT
description,
integrationRuntimeName,
resourceGroupName,
subscriptionId,
type,
workspaceName
FROM azure.synapse.vw_integration_runtimes
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';

integration_runtimes

SELECT
properties
FROM azure.synapse.integration_runtimes
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';

INSERT example

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

All Properties

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

Manifest

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

UPDATE example

Updates a integration_runtimes resource.

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

DELETE example

Deletes the specified integration_runtimes resource.

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