integration_runtime_object_metadata

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

Overview

Name	integration_runtime_object_metadata
Type	Resource
Id	azure.synapse.integration_runtime_object_metadata

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description
nextLink	string	The link to the next page of results, if any remaining results exist.
value	array	List of SSIS object metadata.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	resource_group_name, workspace_name, integration_runtime_name, subscription_id		Get integration runtime object metadata. Get object metadata from an integration runtime.
refresh	exec	resource_group_name, workspace_name, integration_runtime_name, subscription_id		Refresh integration runtime object metadata. Refresh the object metadata in an 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.

SELECT examples

list

Get integration runtime object metadata. Get object metadata from an integration runtime.

SELECT
nextLink,
value
FROM azure.synapse.integration_runtime_object_metadata
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

refresh

Refresh integration runtime object metadata. Refresh the object metadata in an integration runtime.

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