Skip to content

Commit 5c2e240

Browse files
zhangyd2015annatisch
zhangyd2015
authored and
annatisch
committed
Add two missing operation API-s into swagger for integration runtime (#3662)
* Add two API-s to integration runtime * Fixed model validation error for the new APIs * Improve the properties description per to review comments
1 parent 146bc8c commit 5c2e240

File tree

4 files changed

+261
-0
lines changed

4 files changed

+261
-0
lines changed

‎specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json‎

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1113,7 +1113,107 @@
11131113
}
11141114
}
11151115
},
1116+
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/linkedIntegrationRuntime": {
1117+
"post": {
1118+
"tags": [
1119+
"integrationRuntimes"
1120+
],
1121+
"operationId": "IntegrationRuntimes_CreateLinkedIntegrationRuntime",
1122+
"x-ms-examples": {
1123+
"IntegrationRuntimes_CreateLinkedIntegrationRuntime": {
1124+
"$ref": "./examples/IntegrationRuntimes_CreateLinkedIntegrationRuntime.json"
1125+
}
1126+
},
1127+
"description": "Create a linked integration runtime entry in a shared integration runtime.",
1128+
"parameters": [
1129+
{
1130+
"$ref": "#/parameters/subscriptionId"
1131+
},
1132+
{
1133+
"$ref": "#/parameters/resourceGroupName"
1134+
},
1135+
{
1136+
"$ref": "#/parameters/factoryName"
1137+
},
1138+
{
1139+
"$ref": "#/parameters/integrationRuntimeName"
1140+
},
1141+
{
1142+
"$ref": "#/parameters/api-version"
1143+
},
1144+
{
1145+
"name": "createLinkedIntegrationRuntimeRequest",
1146+
"description": "The linked integration runtime properties.",
1147+
"in": "body",
1148+
"required": true,
1149+
"schema": {
1150+
"$ref": "#/definitions/CreateLinkedIntegrationRuntimeRequest"
1151+
}
1152+
}
1153+
],
1154+
"responses": {
1155+
"200": {
1156+
"description": "OK.",
1157+
"schema": {
1158+
"$ref": "#/definitions/IntegrationRuntimeStatusResponse"
1159+
}
1160+
},
1161+
"default": {
1162+
"description": "An error response received from the Azure Data Factory service.",
1163+
"schema": {
1164+
"$ref": "#/definitions/CloudError"
1165+
}
1166+
}
1167+
}
1168+
}
1169+
},
11161170
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/nodes/{nodeName}": {
1171+
"get": {
1172+
"tags": [
1173+
"integrationRuntimeNodes"
1174+
],
1175+
"operationId": "IntegrationRuntimeNodes_Get",
1176+
"x-ms-examples": {
1177+
"IntegrationRuntimeNodes_Get": {
1178+
"$ref": "./examples/IntegrationRuntimeNodes_Get.json"
1179+
}
1180+
},
1181+
"description": "Gets a self-hosted integration runtime node.",
1182+
"parameters": [
1183+
{
1184+
"$ref": "#/parameters/subscriptionId"
1185+
},
1186+
{
1187+
"$ref": "#/parameters/resourceGroupName"
1188+
},
1189+
{
1190+
"$ref": "#/parameters/factoryName"
1191+
},
1192+
{
1193+
"$ref": "#/parameters/integrationRuntimeName"
1194+
},
1195+
{
1196+
"$ref": "#/parameters/nodeName"
1197+
},
1198+
{
1199+
"$ref": "#/parameters/api-version"
1200+
}
1201+
],
1202+
"responses": {
1203+
"200": {
1204+
"description": "OK.",
1205+
"schema": {
1206+
"$ref": "./entityTypes/IntegrationRuntime.json#/definitions/SelfHostedIntegrationRuntimeNode"
1207+
}
1208+
},
1209+
"default": {
1210+
"description": "An error response received from the Azure Data Factory service.",
1211+
"schema": {
1212+
"$ref": "#/definitions/CloudError"
1213+
}
1214+
}
1215+
}
1216+
},
11171217
"delete": {
11181218
"tags": [
11191219
"integrationRuntimeNodes"
@@ -2783,6 +2883,28 @@
27832883
"factoryName"
27842884
]
27852885
},
2886+
"CreateLinkedIntegrationRuntimeRequest": {
2887+
"description": "The linked integration runtime information.",
2888+
"type": "object",
2889+
"properties": {
2890+
"name": {
2891+
"description": "The name of the linked integration runtime.",
2892+
"type": "string"
2893+
},
2894+
"subscriptionId": {
2895+
"description": "The ID of the subscription that the linked integration runtime belongs to.",
2896+
"type": "string"
2897+
},
2898+
"dataFactoryName": {
2899+
"description": "The name of the data factory that the linked integration runtime belongs to.",
2900+
"type": "string"
2901+
},
2902+
"dataFactoryLocation": {
2903+
"description": "The location of the data factory that the linked integration runtime belongs to.",
2904+
"type": "string"
2905+
}
2906+
}
2907+
},
27862908
"LinkedServiceListResponse": {
27872909
"description": "A list of linked service resources.",
27882910
"type": "object",

‎specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/IntegrationRuntime.json‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -625,6 +625,12 @@
625625
"description": "The latest version on download center.",
626626
"type": "string",
627627
"readOnly": true
628+
},
629+
"autoUpdateETA": {
630+
"description": "The estimated time when the self-hosted integration runtime will be updated.",
631+
"type": "string",
632+
"format": "date-time",
633+
"readOnly": true
628634
}
629635
}
630636
},
@@ -761,6 +767,7 @@
761767
"description": "The result of the last integration runtime node update.",
762768
"type": "string",
763769
"enum": [
770+
"None",
764771
"Succeed",
765772
"Fail"
766773
],

‎specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimeNodes_Get.json‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
{
2+
"parameters": {
3+
"subscriptionId": "12345678-1234-1234-1234-12345678abc",
4+
"resourceGroupName": "exampleResourceGroup",
5+
"factoryName": "exampleFactoryName",
6+
"integrationRuntimeName": "exampleIntegrationRuntime",
7+
"nodeName": "Node_1",
8+
"api-version": "2018-06-01"
9+
},
10+
"responses": {
11+
"200": {
12+
"headers": {
13+
"Date": "Fri, 17 Aug 2018 06:31:04 GMT",
14+
"X-Content-Type-Options": "nosniff",
15+
"x-ms-ratelimit-remaining-subscription-reads": "14999",
16+
"x-ms-request-id": "1c8b259a-c6e6-48aa-8121-05b3b3b782aa",
17+
"x-ms-correlation-request-id": "1c8b259a-c6e6-48aa-8121-05b3b3b782aa"
18+
},
19+
"body": {
20+
"nodeName": "Node_1",
21+
"machineName": "YANZHANG-DT",
22+
"hostServiceUri": "https://yanzhang-dt.fareast.corp.microsoft.com:8050/HostServiceRemote.svc/",
23+
"status": "Online",
24+
"capabilities": {
25+
"serviceBusConnected": "True",
26+
"httpsPortEnabled": "True",
27+
"credentialInSync": "True",
28+
"connectedToResourceManager": "True",
29+
"nodeEnabled": "True"
30+
},
31+
"versionStatus": "UpToDate",
32+
"version": "3.8.6743.6",
33+
"registerTime": "2018-08-17T03:44:55.8012825Z",
34+
"lastConnectTime": "2018-08-17T06:30:46.6262976Z",
35+
"lastStartTime": "2018-08-17T03:45:30.8499851Z",
36+
"lastUpdateResult": "None",
37+
"isActiveDispatcher": true,
38+
"maxConcurrentJobs": 20
39+
}
40+
}
41+
}
42+
}

‎specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_CreateLinkedIntegrationRuntime.json‎

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
{
2+
"parameters": {
3+
"subscriptionId": "12345678-1234-1234-1234-12345678abc",
4+
"resourceGroupName": "exampleResourceGroup",
5+
"factoryName": "exampleFactoryName",
6+
"integrationRuntimeName": "exampleIntegrationRuntime",
7+
"createLinkedIntegrationRuntimeRequest": {
8+
"name": "bfa92911-9fb6-4fbe-8f23-beae87bc1c83",
9+
"subscriptionId": "061774c7-4b5a-4159-a55b-365581830283",
10+
"dataFactoryName": "e9955d6d-56ea-4be3-841c-52a12c1a9981",
11+
"dataFactoryLocation": "West US"
12+
},
13+
"api-version": "2018-06-01"
14+
},
15+
"responses": {
16+
"200": {
17+
"headers": {
18+
"Date": "Fri, 17 Aug 2018 06:31:03 GMT",
19+
"X-Content-Type-Options": "nosniff",
20+
"x-ms-ratelimit-remaining-subscription-writes": "1199",
21+
"x-ms-request-id": "f9a67067-62f3-43ce-b891-2ccb3de4a15f",
22+
"x-ms-correlation-request-id": "f9a67067-62f3-43ce-b891-2ccb3de4a15f"
23+
},
24+
"body": {
25+
"name": "exampleIntegrationRuntime",
26+
"properties": {
27+
"dataFactoryName": "exampleFactoryName",
28+
"state": "Online",
29+
"type": "SelfHosted",
30+
"typeProperties": {
31+
"autoUpdate": "On",
32+
"taskQueueId": "823da112-f2d9-426b-a0d8-5f361b94f72a",
33+
"version": "3.8.6743.6",
34+
"nodes": [
35+
{
36+
"nodeName": "Node_1",
37+
"machineName": "YANZHANG-DT",
38+
"hostServiceUri": "https://yanzhang-dt.fareast.corp.microsoft.com:8050/HostServiceRemote.svc/",
39+
"status": "Online",
40+
"capabilities": {
41+
"serviceBusConnected": "True",
42+
"httpsPortEnabled": "True",
43+
"credentialInSync": "True",
44+
"connectedToResourceManager": "True",
45+
"nodeEnabled": "True"
46+
},
47+
"versionStatus": "UpToDate",
48+
"version": "3.8.6743.6",
49+
"registerTime": "2018-08-17T03:44:55.8012825Z",
50+
"lastConnectTime": "2018-08-17T06:30:46.6262976Z",
51+
"lastStartTime": "2018-08-17T03:45:30.8499851Z",
52+
"lastUpdateResult": "None",
53+
"isActiveDispatcher": true,
54+
"maxConcurrentJobs": 20
55+
}
56+
],
57+
"scheduledUpdateDate": "2018-08-20T00:00:00Z",
58+
"updateDelayOffset": "PT19H",
59+
"localTimeZoneOffset": "PT8H",
60+
"serviceUrls": [
61+
"wu.frontend.int.clouddatahub-int.net",
62+
"*.servicebus.windows.net"
63+
],
64+
"links": [
65+
{
66+
"name": "bfa92911-9fb6-4fbe-8f23-beae87bc1c83",
67+
"subscriptionId": "061774c7-4b5a-4159-a55b-365581830283",
68+
"dataFactoryName": "e9955d6d-56ea-4be3-841c-52a12c1a9981",
69+
"dataFactoryLocation": "West US",
70+
"createTime": "2018-08-17T06:31:04.0617928Z"
71+
}
72+
],
73+
"versionStatus": "UpdateAvailable",
74+
"capabilities": {
75+
"serviceBusConnected": "True",
76+
"httpsPortEnabled": "True",
77+
"credentialInSync": "True",
78+
"connectedToResourceManager": "True",
79+
"nodeEnabled": "True"
80+
},
81+
"pushedVersion": "3.9.6774.1",
82+
"latestVersion": "3.9.6774.1",
83+
"autoUpdateETA": "2018-08-20T19:00:00Z",
84+
"createTime": "2018-08-17T03:43:25.7055573Z"
85+
}
86+
}
87+
}
88+
}
89+
}
90+
}

0 commit comments

Comments
 (0)