Skip to content

Commit ad1a0be

Browse files
niteshvijay1995FredericHeem
niteshvijay1995
authored and
FredericHeem
committed
Add Pause Resume API (Azure#18803)
* Add Pause Resume API * Fix LintDiff * Fix responses * Fix prettier
1 parent d35cd6e commit ad1a0be

File tree

7 files changed

+246
-10
lines changed

7 files changed

+246
-10
lines changed

‎specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2022-02-15-preview/dataTransferService.json

Lines changed: 134 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@
6969
}
7070
],
7171
"responses": {
72-
"201": {
72+
"200": {
7373
"description": "Successful CreateJob response",
7474
"schema": {
7575
"$ref": "#/definitions/DataTransferJobGetResults"
@@ -124,6 +124,132 @@
124124
}
125125
}
126126
},
127+
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/dataTransferJobs/{jobName}/pause": {
128+
"post": {
129+
"operationId": "DataTransferJobs_Pause",
130+
"description": "Pause a Data Transfer Job.",
131+
"x-ms-examples": {
132+
"CosmosDBDataTransferJobPause": {
133+
"$ref": "./examples/data-transfer-service/CosmosDBDataTransferJobPause.json"
134+
}
135+
},
136+
"parameters": [
137+
{
138+
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
139+
},
140+
{
141+
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
142+
},
143+
{
144+
"$ref": "./cosmos-db.json#/parameters/accountNameParameter"
145+
},
146+
{
147+
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
148+
},
149+
{
150+
"$ref": "#/parameters/JobNameParameter"
151+
}
152+
],
153+
"responses": {
154+
"200": {
155+
"description": "Successful Pause Job response",
156+
"schema": {
157+
"$ref": "#/definitions/DataTransferJobGetResults"
158+
}
159+
},
160+
"default": {
161+
"description": "Error response describing why the operation failed.",
162+
"schema": {
163+
"$ref": "cosmos-db.json#/definitions/CloudError"
164+
}
165+
}
166+
}
167+
}
168+
},
169+
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/dataTransferJobs/{jobName}/resume": {
170+
"post": {
171+
"operationId": "DataTransferJobs_Resume",
172+
"description": "Resumes a Data Transfer Job.",
173+
"x-ms-examples": {
174+
"CosmosDBDataTransferJobCreate": {
175+
"$ref": "./examples/data-transfer-service/CosmosDBDataTransferJobResume.json"
176+
}
177+
},
178+
"parameters": [
179+
{
180+
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
181+
},
182+
{
183+
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
184+
},
185+
{
186+
"$ref": "./cosmos-db.json#/parameters/accountNameParameter"
187+
},
188+
{
189+
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
190+
},
191+
{
192+
"$ref": "#/parameters/JobNameParameter"
193+
}
194+
],
195+
"responses": {
196+
"200": {
197+
"description": "Successful Resume Job response",
198+
"schema": {
199+
"$ref": "#/definitions/DataTransferJobGetResults"
200+
}
201+
},
202+
"default": {
203+
"description": "Error response describing why the operation failed.",
204+
"schema": {
205+
"$ref": "cosmos-db.json#/definitions/CloudError"
206+
}
207+
}
208+
}
209+
}
210+
},
211+
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/dataTransferJobs/{jobName}/cancel": {
212+
"post": {
213+
"operationId": "DataTransferJobs_Cancel",
214+
"description": "Cancels a Data Transfer Job.",
215+
"x-ms-examples": {
216+
"CosmosDBDataTransferJobCreate": {
217+
"$ref": "./examples/data-transfer-service/CosmosDBDataTransferJobCancel.json"
218+
}
219+
},
220+
"parameters": [
221+
{
222+
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
223+
},
224+
{
225+
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
226+
},
227+
{
228+
"$ref": "./cosmos-db.json#/parameters/accountNameParameter"
229+
},
230+
{
231+
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
232+
},
233+
{
234+
"$ref": "#/parameters/JobNameParameter"
235+
}
236+
],
237+
"responses": {
238+
"200": {
239+
"description": "Successful Cancel Job response",
240+
"schema": {
241+
"$ref": "#/definitions/DataTransferJobGetResults"
242+
}
243+
},
244+
"default": {
245+
"description": "Error response describing why the operation failed.",
246+
"schema": {
247+
"$ref": "cosmos-db.json#/definitions/CloudError"
248+
}
249+
}
250+
}
251+
}
252+
},
127253
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/dataTransferJobs": {
128254
"get": {
129255
"operationId": "DataTransferJobs_ListByDatabaseAccount",
@@ -278,10 +404,15 @@
278404
"type": "string",
279405
"description": "Job Status"
280406
},
281-
"percentageComplete": {
407+
"processedCount": {
408+
"readOnly": true,
409+
"type": "number",
410+
"description": "Processed Count."
411+
},
412+
"totalCount": {
282413
"readOnly": true,
283414
"type": "number",
284-
"description": "Percentage of completion."
415+
"description": "Total Count."
285416
},
286417
"lastUpdatedUtcTime": {
287418
"readOnly": true,

‎specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2022-02-15-preview/examples/data-transfer-service/CosmosDBDataTransferJobCancel.json

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
{
2+
"parameters": {
3+
"accountName": "ddb1",
4+
"resourceGroupName": "rg1",
5+
"api-version": "2022-02-15-preview",
6+
"subscriptionId": "subid",
7+
"jobName": "j1"
8+
},
9+
"responses": {
10+
"200": {
11+
"body": {
12+
"id": "ab1b6f34-b33c-46b1-98c7-3a0a63fd0d16",
13+
"type": "Microsoft.DocumentDB/databaseAccounts/dataTransferJobs",
14+
"properties": {
15+
"jobName": "j1",
16+
"source": {
17+
"tableName": "table",
18+
"keyspaceName": "keyspace",
19+
"component": "CosmosDBCassandra"
20+
},
21+
"destination": {
22+
"component": "AzureBlobStorage",
23+
"containerName": "blob_container",
24+
"endpointUrl": "https://blob.windows.net"
25+
},
26+
"status": "Cancelled",
27+
"processedCount": 20,
28+
"totalCount": 100,
29+
"lastUpdatedUtcTime": "2021-06-12T11:10:55.2780000Z"
30+
}
31+
}
32+
}
33+
}
34+
}

‎specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2022-02-15-preview/examples/data-transfer-service/CosmosDBDataTransferJobCreate.json

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"parameters": {
33
"accountName": "ddb1",
44
"resourceGroupName": "rg1",
5-
"api-version": "2020-10-15-preview",
5+
"api-version": "2022-02-15-preview",
66
"subscriptionId": "subid",
77
"jobName": "j1",
88
"jobCreateParameters": {
@@ -21,7 +21,7 @@
2121
}
2222
},
2323
"responses": {
24-
"201": {
24+
"200": {
2525
"body": {
2626
"id": "ab1b6f34-b33c-46b1-98c7-3a0a63fd0d16",
2727
"type": "Microsoft.DocumentDB/databaseAccounts/dataTransferJobs",
@@ -38,7 +38,8 @@
3838
"endpointUrl": "https://blob.windows.net"
3939
},
4040
"status": "Running",
41-
"percentageComplete": 20,
41+
"processedCount": 0,
42+
"totalCount": 0,
4243
"lastUpdatedUtcTime": "2021-06-12T11:10:55.2780000Z"
4344
}
4445
}

‎specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2022-02-15-preview/examples/data-transfer-service/CosmosDBDataTransferJobFeed.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"parameters": {
33
"accountName": "ddb1",
44
"resourceGroupName": "rg1",
5-
"api-version": "2020-10-15-preview",
5+
"api-version": "2022-02-15-preview",
66
"subscriptionId": "subid"
77
},
88
"responses": {
@@ -25,7 +25,8 @@
2525
"containerName": "blob_container"
2626
},
2727
"status": "Completed",
28-
"percentageComplete": 100,
28+
"processedCount": 100,
29+
"totalCount": 100,
2930
"lastUpdatedUtcTime": "2021-06-12T12:04:23.1530000Z"
3031
}
3132
}

‎specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2022-02-15-preview/examples/data-transfer-service/CosmosDBDataTransferJobGet.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"parameters": {
33
"accountName": "ddb1",
44
"resourceGroupName": "rg1",
5-
"api-version": "2020-10-15-preview",
5+
"api-version": "2022-02-15-preview",
66
"subscriptionId": "subid",
77
"jobName": "j1"
88
},
@@ -24,7 +24,8 @@
2424
"containerName": "blob_container"
2525
},
2626
"status": "Completed",
27-
"percentageComplete": 100,
27+
"processedCount": 50,
28+
"totalCount": 50,
2829
"lastUpdatedUtcTime": "2021-06-12T12:04:23.1530000Z"
2930
}
3031
}

‎specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2022-02-15-preview/examples/data-transfer-service/CosmosDBDataTransferJobPause.json

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
{
2+
"parameters": {
3+
"accountName": "ddb1",
4+
"resourceGroupName": "rg1",
5+
"api-version": "2022-02-15-preview",
6+
"subscriptionId": "subid",
7+
"jobName": "j1"
8+
},
9+
"responses": {
10+
"200": {
11+
"body": {
12+
"id": "ab1b6f34-b33c-46b1-98c7-3a0a63fd0d16",
13+
"type": "Microsoft.DocumentDB/databaseAccounts/dataTransferJobs",
14+
"properties": {
15+
"jobName": "j1",
16+
"source": {
17+
"tableName": "table",
18+
"keyspaceName": "keyspace",
19+
"component": "CosmosDBCassandra"
20+
},
21+
"destination": {
22+
"component": "AzureBlobStorage",
23+
"containerName": "blob_container",
24+
"endpointUrl": "https://blob.windows.net"
25+
},
26+
"status": "Paused",
27+
"processedCount": 20,
28+
"totalCount": 100,
29+
"lastUpdatedUtcTime": "2021-06-12T11:10:55.2780000Z"
30+
}
31+
}
32+
}
33+
}
34+
}

‎specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2022-02-15-preview/examples/data-transfer-service/CosmosDBDataTransferJobResume.json

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
{
2+
"parameters": {
3+
"accountName": "ddb1",
4+
"resourceGroupName": "rg1",
5+
"api-version": "2022-04-15-preview",
6+
"subscriptionId": "subid",
7+
"jobName": "j1"
8+
},
9+
"responses": {
10+
"200": {
11+
"body": {
12+
"id": "ab1b6f34-b33c-46b1-98c7-3a0a63fd0d16",
13+
"type": "Microsoft.DocumentDB/databaseAccounts/dataTransferJobs",
14+
"properties": {
15+
"jobName": "j1",
16+
"source": {
17+
"tableName": "table",
18+
"keyspaceName": "keyspace",
19+
"component": "CosmosDBCassandra"
20+
},
21+
"destination": {
22+
"component": "AzureBlobStorage",
23+
"containerName": "blob_container",
24+
"endpointUrl": "https://blob.windows.net"
25+
},
26+
"status": "Pending",
27+
"processedCount": 20,
28+
"totalCount": 100,
29+
"lastUpdatedUtcTime": "2021-06-12T11:10:55.2780000Z"
30+
}
31+
}
32+
}
33+
}
34+
}

0 commit comments

Comments
 (0)