integration_runtimes

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

Overview

Name	integration_runtimes
Type	Resource
Id	azure.synapse_artifacts.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}. # pylint: disable=line-too-long
name	string	The name of the resource.
	object	Unmatched properties from the message are deserialized to this collection.
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

Name	Datatype	Description
nextLink	string	The link to the next page of results, if any remaining results exist.
value	array	List of integration runtimes. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	integration_runtime_name, endpoint		Get Integration Runtime.
list	select	endpoint		List Integration Runtimes.

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
endpoint	string	The service endpoint host (no scheme). (default: )
integration_runtime_name	string	The Integration Runtime name. Required.

SELECT examples

get

Get Integration Runtime.

SELECT
id,
name,
,
description,
etag,
type
FROM azure.synapse_artifacts.integration_runtimes
WHERE integration_runtime_name = '{{ integration_runtime_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list

List Integration Runtimes.

SELECT
nextLink,
value
FROM azure.synapse_artifacts.integration_runtimes
WHERE endpoint = '{{ endpoint }}' -- required
;