Skip to main content

integration_runtime_object_metadata

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

Overview

Nameintegration_runtime_object_metadata
TypeResource
Idazure.data_factory.integration_runtime_object_metadata

Fields

The following fields are returned by SELECT queries:

OK.

NameDatatypeDescription
idinteger (int64)Metadata id.
namestringMetadata name.
descriptionstringMetadata description.
typestringType of metadata.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectsubscriptionId, resourceGroupName, factoryName, integrationRuntimeNameapi-versionGet a SSIS integration runtime object metadata by specified path. The return is pageable metadata list.
refreshexecsubscriptionId, resourceGroupName, factoryName, integrationRuntimeNameapi-versionRefresh a SSIS integration runtime object metadata.

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.

NameDatatypeDescription
factoryNamestringThe factory name.
integrationRuntimeNamestringThe integration runtime name.
resourceGroupNamestringThe resource group name.
subscriptionIdstringThe subscription identifier.
api-versionstringThe API version.

SELECT examples

Get a SSIS integration runtime object metadata by specified path. The return is pageable metadata list.

SELECT
id,
name,
description,
type
FROM azure.data_factory.integration_runtime_object_metadata
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND factoryName = '{{ factoryName }}' -- required
AND integrationRuntimeName = '{{ integrationRuntimeName }}' -- required
AND api-version = '{{ api-version }}'
;

Lifecycle Methods

Refresh a SSIS integration runtime object metadata.

EXEC azure.data_factory.integration_runtime_object_metadata.refresh 
@subscriptionId='{{ subscriptionId }}' --required,
@resourceGroupName='{{ resourceGroupName }}' --required,
@factoryName='{{ factoryName }}' --required,
@integrationRuntimeName='{{ integrationRuntimeName }}' --required,
@api-version='{{ api-version }}'
;