Integration Runtime Object Metadata - List
获取集成运行时对象元数据
从集成运行时获取对象元数据
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/getObjectMetadata?api-version=2021-06-01-previewURI 参数
| 名称 | 在 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
integration
|
path | True |
string |
集成运行时名称 |
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
资源组的名称。 名称不区分大小写。 |
|
subscription
|
path | True |
string minLength: 1 |
目标订阅的 ID。 |
|
workspace
|
path | True |
string |
工作区的名称。 |
|
api-version
|
query | True |
string minLength: 1 |
用于此作的 API 版本。 |
请求正文
| 名称 | 类型 | 说明 |
|---|---|---|
| metadataPath |
string |
元数据路径。 |
响应
| 名称 | 类型 | 说明 |
|---|---|---|
| 200 OK |
还行。 |
|
| Other Status Codes |
从 Azure Synapse 服务收到的错误响应。 |
示例
Get integration runtime object metadata
示例请求
POST https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspace/integrationRuntimes/testactivityv2/getObjectMetadata?api-version=2021-06-01-preview
{
"metadataPath": "ssisFolders"
}
示例响应
Date: Mon, 03 Dec 2018 06:24:54 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-writes: 1198
x-ms-request-id: 0cbc67c4-60e7-4d49-97d9-e4bc4f9851cd
x-ms-correlation-request-id: 0cbc67c4-60e7-4d49-97d9-e4bc4f9851cd{
"value": [
{
"id": 1,
"name": "TestFolder",
"description": "",
"type": "Folder"
},
{
"id": 2,
"name": "EnvironmentFolder",
"description": "",
"type": "Folder"
},
{
"id": 3,
"name": "ActivityTest",
"description": "",
"type": "Folder"
},
{
"id": 4,
"name": "这是文件夹",
"description": "",
"type": "Folder"
},
{
"id": 5,
"name": "1",
"type": "Folder"
},
{
"id": 6,
"name": "2",
"type": "Folder"
},
{
"id": 7,
"name": "3",
"type": "Folder"
},
{
"id": 8,
"name": "4",
"type": "Folder"
},
{
"id": 9,
"name": "5",
"type": "Folder"
},
{
"id": 10,
"name": "6",
"type": "Folder"
},
{
"id": 11,
"name": "7",
"type": "Folder"
},
{
"id": 12,
"name": "8",
"type": "Folder"
},
{
"id": 13,
"name": "9",
"type": "Folder"
},
{
"id": 14,
"name": "10",
"type": "Folder"
},
{
"id": 15,
"name": "11",
"type": "Folder"
},
{
"id": 16,
"name": "12",
"type": "Folder"
},
{
"id": 17,
"name": "13",
"type": "Folder"
},
{
"id": 18,
"name": "14",
"type": "Folder"
},
{
"id": 19,
"name": "15",
"type": "Folder"
},
{
"id": 20,
"name": "16",
"type": "Folder"
},
{
"id": 21,
"name": "17",
"type": "Folder"
},
{
"id": 22,
"name": "18",
"type": "Folder"
},
{
"id": 23,
"name": "19",
"type": "Folder"
},
{
"id": 24,
"name": "20",
"type": "Folder"
},
{
"id": 25,
"name": "21",
"type": "Folder"
},
{
"id": 26,
"name": "22",
"type": "Folder"
},
{
"id": 27,
"name": "23",
"type": "Folder"
},
{
"id": 28,
"name": "24",
"type": "Folder"
},
{
"id": 29,
"name": "25",
"type": "Folder"
},
{
"id": 30,
"name": "26",
"type": "Folder"
},
{
"id": 31,
"name": "27",
"type": "Folder"
},
{
"id": 32,
"name": "28",
"type": "Folder"
},
{
"id": 33,
"name": "29",
"type": "Folder"
},
{
"id": 34,
"name": "30",
"type": "Folder"
},
{
"id": 35,
"name": "31",
"type": "Folder"
},
{
"id": 36,
"name": "32",
"type": "Folder"
},
{
"id": 37,
"name": "33",
"type": "Folder"
},
{
"id": 38,
"name": "34",
"type": "Folder"
},
{
"id": 39,
"name": "35",
"type": "Folder"
},
{
"id": 40,
"name": "36",
"type": "Folder"
},
{
"id": 41,
"name": "37",
"type": "Folder"
},
{
"id": 42,
"name": "38",
"type": "Folder"
},
{
"id": 43,
"name": "39",
"type": "Folder"
},
{
"id": 44,
"name": "40",
"type": "Folder"
},
{
"id": 45,
"name": "41",
"type": "Folder"
},
{
"id": 46,
"name": "42",
"type": "Folder"
},
{
"id": 47,
"name": "43",
"type": "Folder"
},
{
"id": 48,
"name": "44",
"type": "Folder"
},
{
"id": 49,
"name": "45",
"type": "Folder"
},
{
"id": 50,
"name": "46",
"type": "Folder"
},
{
"id": 51,
"name": "47",
"type": "Folder"
},
{
"id": 52,
"name": "48",
"type": "Folder"
},
{
"id": 53,
"name": "49",
"type": "Folder"
},
{
"id": 54,
"name": "50",
"type": "Folder"
},
{
"id": 55,
"name": "51",
"type": "Folder"
},
{
"id": 56,
"name": "52",
"type": "Folder"
},
{
"id": 57,
"name": "53",
"type": "Folder"
},
{
"id": 58,
"name": "54",
"type": "Folder"
},
{
"id": 59,
"name": "55",
"type": "Folder"
},
{
"id": 60,
"name": "56",
"type": "Folder"
},
{
"id": 61,
"name": "57",
"type": "Folder"
},
{
"id": 62,
"name": "58",
"type": "Folder"
},
{
"id": 63,
"name": "59",
"type": "Folder"
},
{
"id": 64,
"name": "60",
"type": "Folder"
},
{
"id": 65,
"name": "61",
"type": "Folder"
},
{
"id": 66,
"name": "62",
"type": "Folder"
},
{
"id": 67,
"name": "63",
"type": "Folder"
},
{
"id": 68,
"name": "64",
"type": "Folder"
},
{
"id": 69,
"name": "65",
"type": "Folder"
},
{
"id": 70,
"name": "66",
"type": "Folder"
},
{
"id": 71,
"name": "67",
"type": "Folder"
},
{
"id": 72,
"name": "68",
"type": "Folder"
},
{
"id": 73,
"name": "69",
"type": "Folder"
},
{
"id": 74,
"name": "70",
"type": "Folder"
},
{
"id": 75,
"name": "71",
"type": "Folder"
},
{
"id": 76,
"name": "72",
"type": "Folder"
},
{
"id": 77,
"name": "73",
"type": "Folder"
},
{
"id": 78,
"name": "74",
"type": "Folder"
},
{
"id": 79,
"name": "75",
"type": "Folder"
},
{
"id": 80,
"name": "76",
"type": "Folder"
},
{
"id": 81,
"name": "77",
"type": "Folder"
},
{
"id": 82,
"name": "78",
"type": "Folder"
},
{
"id": 83,
"name": "79",
"type": "Folder"
},
{
"id": 84,
"name": "80",
"type": "Folder"
},
{
"id": 85,
"name": "81",
"type": "Folder"
},
{
"id": 86,
"name": "82",
"type": "Folder"
},
{
"id": 87,
"name": "83",
"type": "Folder"
},
{
"id": 88,
"name": "84",
"type": "Folder"
},
{
"id": 89,
"name": "85",
"type": "Folder"
},
{
"id": 90,
"name": "86",
"type": "Folder"
},
{
"id": 91,
"name": "87",
"type": "Folder"
},
{
"id": 92,
"name": "88",
"type": "Folder"
},
{
"id": 93,
"name": "89",
"type": "Folder"
},
{
"id": 94,
"name": "90",
"type": "Folder"
},
{
"id": 95,
"name": "91",
"type": "Folder"
},
{
"id": 96,
"name": "92",
"type": "Folder"
},
{
"id": 97,
"name": "93",
"type": "Folder"
},
{
"id": 98,
"name": "94",
"type": "Folder"
},
{
"id": 99,
"name": "95",
"type": "Folder"
},
{
"id": 100,
"name": "96",
"type": "Folder"
}
],
"nextLink": "https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/integrationRuntimes/testactivityv2/getObjectMetadata?api-version=2021-06-01-preview&%24skipToken=https%3a%2f%2fwcu.frontend.clouddatahub.net%2fsubscriptions%2f12345678-1234-1234-1234-12345678abc%2fdatafactories%2f6C8E7C90-FD45-4010-8B7C-B5227D0F0CB7%2fintegrationruntimes%2fTESTACTIVITYV2%2fgetSsisObjectMetadata%3f%24skipToken%3dc3Npc0ZvbGRlcnNAQDIwMTgtMTEtMjlUMDM6NTk6MzIuMDQ1Mzc1MiswMDowMEBAZm9sZGVyQEAwMDAwMDAwMDAwMDAwMDAwMTAx0%26api-version%3d1.0"
}定义
| 名称 | 说明 |
|---|---|
|
Error |
资源管理错误附加信息。 |
|
Error |
错误详细信息。 |
|
Error |
错误响应 |
|
Get |
获取 SSIS 对象元数据的请求有效负载。 |
|
Ssis |
Ssis 环境。 |
|
Ssis |
Ssis 环境参考。 |
|
Ssis |
Ssis 文件夹。 |
|
Ssis |
SSIS 对象元数据的列表。 |
|
Ssis |
SSIS 对象元数据的类型。 |
|
Ssis |
Ssis 包。 |
|
Ssis |
Ssis 参数。 |
|
Ssis |
Ssis 项目。 |
|
Ssis |
Ssis 变量。 |
ErrorAdditionalInfo
资源管理错误附加信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| info |
object |
其他信息。 |
| type |
string |
其他信息类型。 |
ErrorDetail
错误详细信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| additionalInfo |
错误附加信息。 |
|
| code |
string |
错误代码。 |
| details |
错误详细信息。 |
|
| message |
string |
错误消息。 |
| target |
string |
错误目标。 |
ErrorResponse
错误响应
| 名称 | 类型 | 说明 |
|---|---|---|
| error |
错误对象。 |
GetSsisObjectMetadataRequest
获取 SSIS 对象元数据的请求有效负载。
| 名称 | 类型 | 说明 |
|---|---|---|
| metadataPath |
string |
元数据路径。 |
SsisEnvironment
Ssis 环境。
| 名称 | 类型 | 说明 |
|---|---|---|
| description |
string |
元数据说明。 |
| folderId |
integer (int64) |
包含环境的文件夹 ID。 |
| id |
integer (int64) |
元数据 ID。 |
| name |
string |
元数据名称。 |
| type |
string:
Environment |
元数据的类型。 |
| variables |
环境中的变量 |
SsisEnvironmentReference
Ssis 环境参考。
| 名称 | 类型 | 说明 |
|---|---|---|
| environmentFolderName |
string |
环境文件夹名称。 |
| environmentName |
string |
环境名称。 |
| id |
integer (int64) |
环境引用 ID。 |
| referenceType |
string |
引用类型 |
SsisFolder
Ssis 文件夹。
| 名称 | 类型 | 说明 |
|---|---|---|
| description |
string |
元数据说明。 |
| id |
integer (int64) |
元数据 ID。 |
| name |
string |
元数据名称。 |
| type |
string:
Folder |
元数据的类型。 |
SsisObjectMetadataListResponse
SSIS 对象元数据的列表。
| 名称 | 类型 | 说明 |
|---|---|---|
| nextLink |
string |
指向下一页结果的链接（如果存在任何剩余的结果）。 |
| value | SsisObjectMetadata[]: |
SSIS 对象元数据的列表。 |
SsisObjectMetadataType
SSIS 对象元数据的类型。
| 值 | 说明 |
|---|---|
| Environment | |
| Folder | |
| Package | |
| Project |
SsisPackage
Ssis 包。
| 名称 | 类型 | 说明 |
|---|---|---|
| description |
string |
元数据说明。 |
| folderId |
integer (int64) |
包含包的文件夹 ID。 |
| id |
integer (int64) |
元数据 ID。 |
| name |
string |
元数据名称。 |
| parameters |
包中的参数 |
|
| projectId |
integer (int64) |
包含包的项目 ID。 |
| projectVersion |
integer (int64) |
包含包的项目版本。 |
| type |
string:
Package |
元数据的类型。 |
SsisParameter
Ssis 参数。
| 名称 | 类型 | 说明 |
|---|---|---|
| dataType |
string |
参数类型。 |
| defaultValue |
string |
参数的默认值。 |
| description |
string |
参数说明。 |
| designDefaultValue |
string |
设计参数的默认值。 |
| id |
integer (int64) |
参数 ID。 |
| name |
string |
参数名称。 |
| required |
boolean |
是否需要参数。 |
| sensitive |
boolean |
参数是否敏感。 |
| sensitiveDefaultValue |
string |
参数的默认敏感值。 |
| valueSet |
boolean |
参数值集。 |
| valueType |
string |
参数值类型。 |
| variable |
string |
参数引用变量。 |
SsisProject
Ssis 项目。
| 名称 | 类型 | 说明 |
|---|---|---|
| description |
string |
元数据说明。 |
| environmentRefs |
项目中的环境引用 |
|
| folderId |
integer (int64) |
包含项目的文件夹 ID。 |
| id |
integer (int64) |
元数据 ID。 |
| name |
string |
元数据名称。 |
| parameters |
项目中的参数 |
|
| type |
string:
Project |
元数据的类型。 |
| version |
integer (int64) |
项目版本。 |
SsisVariable
Ssis 变量。
| 名称 | 类型 | 说明 |
|---|---|---|
| dataType |
string |
变量类型。 |
| description |
string |
变量说明。 |
| id |
integer (int64) |
变量 ID。 |
| name |
string |
变量名称。 |
| sensitive |
boolean |
变量是否敏感。 |
| sensitiveValue |
string |
变量敏感值。 |
| value |
string |
变量值。 |