integration_runtime_status

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

Overview

Name	integration_runtime_status
Type	Resource
Id	azure.synapse.integration_runtime_status

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	The integration runtime name.
dataFactoryName	string	The workspace name which the integration runtime belong to.
state	string	The state of integration runtime. Known values are: "Initial", "Stopped", "Started", "Starting", "Stopping", "NeedRegistration", "Online", "Limited", "Offline", and "AccessDenied".
type	string	Type of integration runtime. Required. Known values are: "Managed" and "SelfHosted".

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		Get integration runtime status. Get the integration runtime status.

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.

SELECT examples

get

Get integration runtime status. Get the integration runtime status.

SELECT
name,
dataFactoryName,
state,
type
FROM azure.synapse.integration_runtime_status
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
;