Swagger for canceling MI management operations #7924

toki95 · 2019-12-09T16:01:26Z

Adding swagger for cancel and list of management operations on managed server.

azure-pipelines · 2019-12-09T16:01:45Z

Azure Pipelines successfully started running 1 pipeline(s).

openapi-sdkautomation · 2019-12-09T16:03:46Z

azure-sdk-for-java

🔄 inProgress [Logs] [Expand Details]

🔄 Generate from 79f4e8d with merge commit 4de4341bfad81551c22bffbb670e6621d8c075ad. SDK Automation 13.0.17.20191226.1

openapi-sdkautomation · 2019-12-09T16:03:48Z

azure-sdk-for-go

🔄 inProgress [Logs] [Expand Details]

🔄 Generate from 79f4e8d with merge commit 4de4341bfad81551c22bffbb670e6621d8c075ad. SDK Automation 13.0.17.20191226.1

openapi-sdkautomation · 2019-12-09T16:03:51Z

azure-sdk-for-net

🔄 inProgress [Logs] [Expand Details]

🔄 Generate from 79f4e8d with merge commit 4de4341bfad81551c22bffbb670e6621d8c075ad. SDK Automation 13.0.17.20191226.1

openapi-sdkautomation · 2019-12-09T16:03:59Z

azure-sdk-for-python

🔄 inProgress [Logs] [Expand Details]

🔄 Generate from 79f4e8d with merge commit 4de4341bfad81551c22bffbb670e6621d8c075ad. SDK Automation 13.0.17.20191226.1

openapi-sdkautomation · 2019-12-09T16:04:02Z

azure-sdk-for-js

🔄 inProgress [Logs] [Expand Details]

🔄 Generate from 79f4e8d with merge commit 4de4341bfad81551c22bffbb670e6621d8c075ad. SDK Automation 13.0.17.20191226.1

azure-pipelines · 2019-12-09T16:14:06Z

Azure Pipelines successfully started running 1 pipeline(s).

yungezz · 2019-12-10T01:33:57Z

...sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/ManagedInstanceOperations.json

+            "modelAsString": true
+          }
+        },
+        "errorCode": {


is there min and max?

I am not sure that I understand what you mean.

Also can you add other people for ARM team, I don't have permission to do that. Jared is on vacation until the end of the year.

azure-pipelines · 2019-12-10T08:00:29Z

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines · 2019-12-10T08:40:13Z

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines · 2019-12-10T09:42:35Z

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines · 2019-12-10T10:17:06Z

Azure Pipelines successfully started running 1 pipeline(s).

azuresdkci · 2019-12-11T16:12:56Z

Can one of the admins verify this patch?

toki95 · 2019-12-13T10:06:47Z

@yungezz can you please merge this pull request?

yungezz · 2019-12-13T14:41:45Z

hi @toki95 , this PR is adding new version, need ARM review and signoff.

toki95 · 2019-12-13T15:13:13Z

@yungezz what does that mean? Adam Krom has signed off and he is from ARM team since Jared if oof until end of the year.

yungezz · 2019-12-16T01:49:52Z

hi @akromm could you pls label the PR with "ARMSignedOff"?

pilor · 2019-12-18T18:02:48Z

...sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/ManagedInstanceOperations.json

+{
+  "swagger": "2.0",
+  "info": {
+    "version": "2019-06-01-preview",


For future PRs please copy the previous version's swagger spec in commit 1 before making changes in future commits. This makes it much easier to review.

pilor · 2019-12-18T18:04:58Z

...sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/ManagedInstanceOperations.json

+            "$ref": "#/parameters/ManagedInstanceNameParameter"
+          },
+          {
+            "name": "operationId",


This should be "operationName". "ID" typically refers to the full resource ID and the list of operations gives the value you want the user to provider here in the "name" property

pilor · 2019-12-18T18:10:12Z

...sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/ManagedInstanceOperations.json

+    "application/json"
+  ],
+  "paths": {
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/operations/{operationId}/cancel": {


You need a GET API for individual operations to be compliant with the RPC especially if you are now allowing people to cancel individual operations. A comparison is operations on a template deployment: https://docs.microsoft.com/en-us/rest/api/resources/deploymentoperations/get

This API for cancel was done in a manner to be compliant with SQL DB and they don't have an API fro getting one particular operation.
Also can you please explain if there is a requirement to create a new API or if we can add not-required parameter in existing API for listing all operations-operationId which will allow customer to get one particular operation.

Existing APIs not following the RPC shouldn't be a reason to continue that trend. Services within Azure rely on RPs following the RPC so they can work with resources in a generic way without needing to know the quirks of any specific API.

I have not seen an example in existing swagger specs where someone modeled a LIST and GET operation in the same operation via an optional name parameter. The response model would be different so I don't imagine that is a good idea.

I don't think that we understood each other entirely. What I was thinking of doing is adding new key in existing API for getting all operations.
Current call of API:
https://management.azure.com/subscriptions/a8c9a924-06c0-4bde-9788-e7b1370969e1/resourceGroups/v-urmila/providers/Microsoft.Sql/managedInstances/v-urmila-mi-test/operations?api-version=2018-06-01-preview
which returns all operations to customer.
And adding a key operationId the same API can be called like this:
https://management.azure.com/subscriptions/a8c9a924-06c0-4bde-9788-e7b1370969e1/resourceGroups/v-urmila/providers/Microsoft.Sql/managedInstances/v-urmila-mi-test/operations/a64077e8-43e6-47b6-a6ef-9c2f40fac38b?api-version=2018-06-01-preview

yungezz · 2019-12-23T02:00:02Z

pls address ARM reviewing comments.

yungezz · 2020-01-02T03:11:29Z

hi @toki95 pls address reviewing comments .

yungezz · 2020-01-08T06:26:29Z

hi @toki95 pls address reviewing comments .

yungezz · 2020-01-14T02:25:04Z

hi @toki95 any update? thanks.

yungezz · 2020-01-19T01:57:56Z

ping again. @toki95

Addressing comments

azure-pipelines · 2020-01-27T16:51:43Z

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines · 2020-01-27T16:54:21Z

Azure Pipelines failed to run 1 pipeline(s).

azure-pipelines · 2020-01-27T16:54:24Z

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines · 2020-01-27T17:00:17Z

Azure Pipelines successfully started running 1 pipeline(s).

Added example for getting MI operation.

azure-pipelines · 2020-01-27T17:03:19Z

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines · 2020-01-27T17:07:26Z

Azure Pipelines successfully started running 1 pipeline(s).

Swahger for canceling MI management operations

f744810

toki95 requested a review from jaredmoo as a code owner December 9, 2019 16:01

azuresdkci assigned yungezz Dec 9, 2019

azuresdkci requested a review from yungezz December 9, 2019 16:03

This was referenced Dec 9, 2019

[AutoPR azure-mgmt-sql] Swagger for canceling MI management operations AzureSDKAutomation/azure-sdk-for-python#81

Open

[AutoPR @azure/arm-sql] Swagger for canceling MI management operations AzureSDKAutomation/azure-sdk-for-js#89

Open

Adding examples

1e90632

yungezz reviewed Dec 10, 2019

View reviewed changes

yungezz added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Dec 10, 2019

Fixing swagger file

4730398

Runned pretier edit

73094a4

Modifing examples

f70a5e9

Jovana Toroman added 2 commits December 10, 2019 10:48

Fixed readme file

1665791

Fixed example for cancel

a1e24ed

toki95 requested a review from yungezz December 10, 2019 10:49

akromm-zz approved these changes Dec 12, 2019

View reviewed changes

pilor added the ARMReviewInProgress label Dec 18, 2019

pilor suggested changes Dec 18, 2019

View reviewed changes

pilor added ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review and removed ARMReviewInProgress labels Dec 18, 2019

Add files via upload

93abafe

Addressing comments

toki95 added 2 commits January 27, 2020 17:53

Delete GetManagedInstanceOperation.json

b124379

Delete ManagedInstanceOperations.json

0089bf0

Update ManagedInstanceOperations.json

79f4e8d

Create GetManagedInstanceOperation

8caad0a

Added example for getting MI operation.

Delete GetManagedInstanceOperation

a18554a

toki95 closed this Jan 29, 2020

Swagger for canceling MI management operations #7924

Swagger for canceling MI management operations #7924

Conversation

toki95 commented Dec 9, 2019

azure-pipelines bot commented Dec 9, 2019

openapi-sdkautomation bot commented Dec 9, 2019 • edited Loading

azure-sdk-for-java

openapi-sdkautomation bot commented Dec 9, 2019 • edited Loading

azure-sdk-for-go

openapi-sdkautomation bot commented Dec 9, 2019 • edited Loading

azure-sdk-for-net

openapi-sdkautomation bot commented Dec 9, 2019 • edited Loading

azure-sdk-for-python

openapi-sdkautomation bot commented Dec 9, 2019 • edited Loading

azure-sdk-for-js

azure-pipelines bot commented Dec 9, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

azure-pipelines bot commented Dec 10, 2019

azure-pipelines bot commented Dec 10, 2019

azure-pipelines bot commented Dec 10, 2019

azure-pipelines bot commented Dec 10, 2019

azuresdkci commented Dec 11, 2019

toki95 commented Dec 13, 2019

yungezz commented Dec 13, 2019

toki95 commented Dec 13, 2019

yungezz commented Dec 16, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yungezz commented Dec 23, 2019

yungezz commented Jan 2, 2020

yungezz commented Jan 8, 2020

yungezz commented Jan 14, 2020

yungezz commented Jan 19, 2020

azure-pipelines bot commented Jan 27, 2020

azure-pipelines bot commented Jan 27, 2020

azure-pipelines bot commented Jan 27, 2020

azure-pipelines bot commented Jan 27, 2020

azure-pipelines bot commented Jan 27, 2020

azure-pipelines bot commented Jan 27, 2020

openapi-sdkautomation bot commented Dec 9, 2019 •

edited

Loading

openapi-sdkautomation bot commented Dec 9, 2019 •

edited

Loading

openapi-sdkautomation bot commented Dec 9, 2019 •

edited

Loading

openapi-sdkautomation bot commented Dec 9, 2019 •

edited

Loading

openapi-sdkautomation bot commented Dec 9, 2019 •

edited

Loading