Skip to content

Adding bulk remove API where users can remove multiple resources and service does the orchestration. #10481

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Lei Ni (leniatgh) merged 4 commits into from
Oct 7, 2020
Merged

Adding bulk remove API where users can remove multiple resources and service does the orchestration. #10481

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
22fb68d
adding remove move resources api
Aug 14, 2020
24fbe34
Merge https://github.com/Azure/azure-rest-api-specs into users/dukum/…
Aug 17, 2020
f30e25c
syncing with master
Aug 17, 2020
e0d681c
renaming the api
Aug 18, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions ...soft.Migrate/preview/2019-10-01-preview/examples/MoveCollections_RemoveMoveResources.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{
"parameters": {
"moveCollectionName": "movecollection1",
"subscriptionId": "subid",
"resourceGroupName": "rg1",
"api-version": "2019-10-01-preview",
"validateOnly": false,
"moveResources": [
"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Migrate/MoveCollections/movecollection1/MoveResources/moveresource1"
]
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/e80eb9fa-c996-4435-aa32-5af6f3d3077c/resourceGroups/RegionMoveRG-southcentralus-southeastasia/providers/Microsoft.Migrate/MoveCollections/MoveCollection-southcentralus-southeastasia/operations/1e4193c3-206e-4916-b124-1da16175eb0e",
"name": "1e4193c3-206e-4916-b124-1da16175eb0e",
"status": "Succeeded",
"startTime": "6/17/2020 6:45:55 AM",
"endTime": "6/17/2020 6:45:56 AM",
"error": null,
"properties": {}
}
},
"202": {}
}
}
97 changes: 97 additions & 0 deletions ...e/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/regionmovecollection.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -666,6 +666,71 @@
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/moveCollections/{moveCollectionName}/removeMoveResources": {

@innosam Harkirat Singh (innosam) Aug 18, 2020 •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Discussed with pravk, and we came to conclusion that "bulkRemove" name is a better fit for following reasons:
a. the name suggestion that this is meant to supplement the DELETE the move resources in a bulk.

"post": {
"tags": [
"MoveCollections"
],
"operationId": "MoveCollections_RemoveMoveResources",
"description": "Removes the set of resources included in the request body from move collection. The orchestration is done by service. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true.",

@innosam Harkirat Singh (innosam) Aug 17, 2020 •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removes the set of moveResources

"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "azure-async-operation"
},
"consumes": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "moveCollectionName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/api-version"
},
{
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/RemoveMoveResourcesRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"202": {
"description": "Accepted"
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"x-ms-examples": {
"MoveCollections_RemoveMoveResources": {
"$ref": "./examples/MoveCollections_RemoveMoveResources.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/moveCollections/{moveCollectionName}/moveResources/{moveResourceName}": {
"put": {
"tags": [
Expand Down Expand Up @@ -1033,6 +1098,18 @@
"modelAsString": true
}
},
"MoveResourceInputType": {
"description": "Defines the move resource input type.",
"type": "string",
"enum": [
"MoveResourceId",
"MoveResourceSourceId"
],
"x-ms-enum": {
"name": "moveResourceInputType",
"modelAsString": true
}
},
"ProvisioningState": {
"description": "Defines the provisioning states.",
"enum": [
Expand Down Expand Up @@ -1400,6 +1477,26 @@
}
}
},
"RemoveMoveResourcesRequest": {
"description": "Defines the request body for remove of move resources operation.",
"type": "object",
"properties": {
"validateOnly": {
"description": "Gets or sets a value indicating whether the operation needs to only run pre-requisite.",
"type": "boolean"
},
"moveResources": {
"description": "Gets or sets the list of resource Id's, by default it accepts move resource id's unless the input type is switched via moveResourceInputType property.",
"type": "array",
"items": {
"type": "string"
}
},
"moveResourceInputType": {
"$ref": "#/definitions/MoveResourceInputType"
}
}
},
"MoveResourceFilter": {
"description": "Move resource filter.",
"properties": {
Expand Down