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

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	Resource Etag.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_workspace

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	Resource Etag.
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, workspace_name, integration_runtime_name, subscription_id	If-None-Match	Get integration runtime. Get an integration runtime.
list_by_workspace	select	resource_group_name, workspace_name, subscription_id		List integration runtimes. List all integration runtimes.
create	insert	resource_group_name, workspace_name, integration_runtime_name, subscription_id, properties	If-Match	Create integration runtime. Create an integration runtime.
update	update	resource_group_name, workspace_name, integration_runtime_name, subscription_id		Update integration runtime. Update an integration runtime.
delete	delete	resource_group_name, workspace_name, integration_runtime_name, subscription_id		Delete integration runtime. Delete an integration runtime.
list_outbound_network_dependencies_endpoints	exec	resource_group_name, workspace_name, integration_runtime_name, subscription_id		Gets list of outbound network dependencies for a given Azure-SSIS integration runtime. Gets the list of outbound network dependencies for a given Azure-SSIS integration runtime.
upgrade	exec	resource_group_name, workspace_name, integration_runtime_name, subscription_id		Upgrade integration runtime. Upgrade an integration runtime.
start	exec	resource_group_name, workspace_name, integration_runtime_name, subscription_id		Start integration runtime. Start an integration runtime.
stop	exec	resource_group_name, workspace_name, integration_runtime_name, subscription_id		Stop integration runtime. Stop an integration runtime.
enable_interactive_query	exec	resource_group_name, workspace_name, integration_runtime_name, subscription_id		Enable interactive query in integration runtime.
disable_interactive_query	exec	resource_group_name, workspace_name, integration_runtime_name, subscription_id		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
integration_runtime_name	string	Integration runtime name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
workspace_name	string	The name of the workspace. Required.
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. Default value is None.
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. Default value is None.

SELECT examples

get

Get integration runtime. Get an integration runtime.

SELECT
id,
name,
description,
etag,
type
FROM azure.synapse.integration_runtimes
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND integration_runtime_name = '{{ integration_runtime_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND If-None-Match = '{{ If-None-Match }}'
;

list_by_workspace

List integration runtimes. List all integration runtimes.

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

INSERT examples

create

Create integration runtime. Create an integration runtime.

INSERT INTO azure.synapse.integration_runtimes (
properties,
resource_group_name,
workspace_name,
integration_runtime_name,
subscription_id,
If-Match
)
SELECT 
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ workspace_name }}',
'{{ integration_runtime_name }}',
'{{ subscription_id }}',
'{{ If-Match }}'
RETURNING
id,
name,
etag,
properties,
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: workspace_name
    value: "{{ workspace_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
    value:
      type: "{{ type }}"
      description: "{{ description }}"
  - name: If-Match
    value: "{{ If-Match }}"
    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. Default value is None.
    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. Default value is None.

UPDATE examples

update

Update integration runtime. Update an integration runtime.

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

DELETE examples

delete

Delete integration runtime. Delete an integration runtime.

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

Lifecycle Methods

list_outbound_network_dependencies_endpoints

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

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

upgrade

Upgrade integration runtime. Upgrade an integration runtime.

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

start

Start integration runtime. Start an integration runtime.

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

stop

Stop integration runtime. Stop an integration runtime.

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

enable_interactive_query

Enable interactive query in integration runtime.

EXEC azure.synapse.integration_runtimes.enable_interactive_query 
@resource_group_name='{{ resource_group_name }}' --required, 
@workspace_name='{{ workspace_name }}' --required, 
@integration_runtime_name='{{ integration_runtime_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

disable_interactive_query

Disable interactive query in integration runtime.

EXEC azure.synapse.integration_runtimes.disable_interactive_query 
@resource_group_name='{{ resource_group_name }}' --required, 
@workspace_name='{{ workspace_name }}' --required, 
@integration_runtime_name='{{ integration_runtime_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;