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

OK.

Name	Datatype	Description
id	integer (int64)	Metadata id.
name	string	Metadata name.
description	string	Metadata description.
type	string	Type of metadata.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	subscriptionId, resourceGroupName, workspaceName, integrationRuntimeName		Get object metadata from an integration runtime
refresh	exec	subscriptionId, resourceGroupName, workspaceName, integrationRuntimeName		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
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.

SELECT examples

list

Get object metadata from an integration runtime

SELECT
id,
name,
description,
type
FROM azure.synapse.integration_runtime_object_metadata
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND integrationRuntimeName = '{{ integrationRuntimeName }}' -- required
;

Lifecycle Methods

refresh

Refresh the object metadata in an integration runtime

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