integration_runtimes

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

Overview

Name	integration_runtimes
Type	Resource
Id	azure.synapse.integration_runtimes

Fields

The following fields are returned by SELECT queries:

get

OK.

Name	Datatype	Description
properties	object	Integration runtime properties.

list_by_workspace

OK.

Name	Datatype	Description
properties	object	Integration runtime properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, workspaceName, integrationRuntimeName	If-None-Match	Get an integration runtime
list_by_workspace	select	subscriptionId, resourceGroupName, workspaceName		List all integration runtimes
create	insert	subscriptionId, resourceGroupName, workspaceName, integrationRuntimeName, data__properties	If-Match	Create an integration runtime
update	update	subscriptionId, resourceGroupName, workspaceName, integrationRuntimeName		Update an integration runtime
delete	delete	subscriptionId, resourceGroupName, workspaceName, integrationRuntimeName		Delete an integration runtime
upgrade	exec	subscriptionId, resourceGroupName, workspaceName, integrationRuntimeName		Upgrade an integration runtime
start	exec	subscriptionId, resourceGroupName, workspaceName, integrationRuntimeName		Start an integration runtime
stop	exec	subscriptionId, resourceGroupName, workspaceName, integrationRuntimeName		Stop an integration runtime
enable_interactive_query	exec	subscriptionId, resourceGroupName, workspaceName, integrationRuntimeName		Enable interactive query in integration runtime
disable_interactive_query	exec	subscriptionId, resourceGroupName, workspaceName, integrationRuntimeName		Disable interactive query in 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
integrationRuntimeName	string	Integration runtime name
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
workspaceName	string	The name of the workspace.
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.

SELECT examples

get

Get an integration runtime

SELECT
properties
FROM azure.synapse.integration_runtimes
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND integrationRuntimeName = '{{ integrationRuntimeName }}' -- required
AND If-None-Match = '{{ If-None-Match }}'
;

list_by_workspace

List all integration runtimes

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

INSERT examples

create

Create an integration runtime

INSERT INTO azure.synapse.integration_runtimes (
data__properties,
subscriptionId,
resourceGroupName,
workspaceName,
integrationRuntimeName,
If-Match
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ workspaceName }}',
'{{ integrationRuntimeName }}',
'{{ If-Match }}'
RETURNING
properties
;

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: workspaceName
      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: 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

Update an integration runtime

UPDATE azure.synapse.integration_runtimes
SET 
data__autoUpdate = '{{ autoUpdate }}',
data__updateDelayOffset = '{{ updateDelayOffset }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
AND integrationRuntimeName = '{{ integrationRuntimeName }}' --required
RETURNING
properties;

DELETE examples

delete

Delete an integration runtime

DELETE FROM azure.synapse.integration_runtimes
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
AND integrationRuntimeName = '{{ integrationRuntimeName }}' --required
;

Lifecycle Methods

upgrade

Upgrade an integration runtime

EXEC azure.synapse.integration_runtimes.upgrade 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@workspaceName='{{ workspaceName }}' --required, 
@integrationRuntimeName='{{ integrationRuntimeName }}' --required
;

start

Start an integration runtime

EXEC azure.synapse.integration_runtimes.start 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@workspaceName='{{ workspaceName }}' --required, 
@integrationRuntimeName='{{ integrationRuntimeName }}' --required
;

stop

Stop an integration runtime

EXEC azure.synapse.integration_runtimes.stop 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@workspaceName='{{ workspaceName }}' --required, 
@integrationRuntimeName='{{ integrationRuntimeName }}' --required
;

enable_interactive_query

Enable interactive query in integration runtime

EXEC azure.synapse.integration_runtimes.enable_interactive_query 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@workspaceName='{{ workspaceName }}' --required, 
@integrationRuntimeName='{{ integrationRuntimeName }}' --required
;

disable_interactive_query

Disable interactive query in integration runtime

EXEC azure.synapse.integration_runtimes.disable_interactive_query 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@workspaceName='{{ workspaceName }}' --required, 
@integrationRuntimeName='{{ integrationRuntimeName }}' --required
;