ManagementGroups API update (2018-01-01-preview) by sendhil · Pull Request #2345 · Azure/azure-rest-api-specs

sendhil · 2018-01-26T09:35:24Z

This checklist is used to make sure that common issues in a pull request are addressed. This will expedite the process of getting your pull request merged and avoid extra work on your part to fix issues discovered during the review process.

PR information

The title of the PR is clear and informative.
There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For information on cleaning up the commits in your pull request, see this page.
Except for special cases involving multiple contributors, the PR is started from a fork of the main repository, not a branch.
If applicable, the PR references the bug/issue that it fixes.
Swagger files are correctly named (e.g. the api-version in the path should match the api-version in the spec).

Quality of Swagger

I have read the contribution guidelines.
My spec meets the review criteria:
- The spec conforms to the Swagger 2.0 specification.
- The spec follows the guidelines described in the Swagger checklist document.
- Validation tools were run on swagger spec(s) and have all been fixed in this PR.

AutorestCI · 2018-01-26T09:35:41Z

This commit was treated and no generation was made for Python

AutorestCI · 2018-01-26T09:35:46Z

This commit was treated and no generation was made for Python

* PUT /providers/Microsoft.Management/managementGroups/{groupName}/subscriptions/{subscriptionId} returns 204 instead of 200. * DELETE /providers/Microsoft.Management/managementGroups/{groupName}/subscriptions/{subscriptionId} returns 204 instead of 200. * GET /providers/Microsoft.Management/entities has been changed to POST /providers/Microsoft.Management/getEntities * GET /providers/Microsoft.Management/entities/hierarchy has been changed to POST /providers/Microsoft.Management/getEntities?view=hierarchy. * PUT /providers/Microsoft.Management/managementGroups/{groupName} had it's input structure change to match the response from the GET. Most of the properties are read only as we only need the displayName + parentId. * Removed /providers/Microsoft.Management/operationResults endpoint.

AutorestCI · 2018-01-28T02:27:38Z

This commit was treated and no generation was made for Azure/azure-sdk-for-go

AutorestCI · 2018-01-28T02:27:41Z

This commit was treated and no generation was made for Azure/azure-sdk-for-python

sendhil · 2018-01-28T02:30:23Z

Pushed some updates as per the changes suggested from our REST API board meeting.

PUT /providers/Microsoft.Management/managementGroups/{groupName}/subscriptions/{subscriptionId} returns 204 instead of 200.
DELETE /providers/Microsoft.Management/managementGroups/{groupName}/subscriptions/{subscriptionId} returns 204 instead of 200.
GET /providers/Microsoft.Management/entities has been changed to POST /providers/Microsoft.Management/getEntities
GET /providers/Microsoft.Management/entities/hierarchy has been changed to POST /providers/Microsoft.Management/getEntities?view=hierarchy.
PUT /providers/Microsoft.Management/managementGroups/{groupName} had it's input structure change to match the response from the GET. Most of the properties are read only as we only need the displayName + parentId.
Removed /providers/Microsoft.Management/operationResults endpoint.

AutorestCI · 2018-01-28T04:50:18Z

This commit was treated and no generation was made for Azure/azure-sdk-for-go

AutorestCI · 2018-01-28T04:50:22Z

This commit was treated and no generation was made for Azure/azure-sdk-for-python

AutorestCI · 2018-01-28T05:18:52Z

This commit was treated and no generation was made for Azure/azure-sdk-for-go

AutorestCI · 2018-01-28T05:18:56Z

This commit was treated and no generation was made for Azure/azure-sdk-for-python

…ble's

AutorestCI · 2018-01-29T23:55:12Z

This commit was treated and no generation was made for Azure/azure-sdk-for-go

AutorestCI · 2018-01-29T23:57:56Z

This commit was treated and no generation was made for Azure/azure-sdk-for-python

…idator

AutorestCI · 2018-01-30T06:22:53Z

This commit was treated and no generation was made for Azure/azure-sdk-for-go

AutorestCI · 2018-01-30T06:22:56Z

This commit was treated and no generation was made for Azure/azure-sdk-for-python

mcardosos · 2018-01-30T18:58:43Z

...n/resources/resource-manager/Microsoft.Management/preview/2018-01-01-preview/management.json

+      "type": "string",
+      "description": "Page continuation token is only used if a previous operation returned a partial result. \nIf a previous response contains a nextLink element, the value of the nextLink element will include a token parameter that specifies a starting point to use for subsequent calls.\n"
+    },
+    "CacheControlHeader": {


CacheControlHeader [](start = 5, length = 18)

Is this required? #Resolved

Yes. There's a bug with arm pas caching that this bypasses. #Resolved

Why not mark it as required then?

In reply to: 164897820 [](ancestors = 164897820)

Will do. #Resolved

mcardosos · 2018-01-30T19:46:37Z

...n/resources/resource-manager/Microsoft.Management/preview/2018-01-01-preview/management.json

+        "tags": [
+          "ManagementGroups"
+        ],
+        "operationId": "ManagementGroups_List",


ManagementGroups_List [](start = 24, length = 21)

Odata extension could be useful here

We only do a subset of Odata operations and the generators complain due to a lack of some parameters. e.g. "Method with x-ms-odata needs to have "$filter" parameter.

mcardosos · 2018-01-30T21:23:20Z

...n/resources/resource-manager/Microsoft.Management/preview/2018-01-01-preview/management.json

+        "id": {
+          "type": "string",
+          "description": "The fully qualified ID for the management group.  For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000",
+          "readOnly": true


readOnly [](start = 11, length = 8)

Why would there be readonly parameters in a model that is used to create a resource?

Because we only actually take the display name field and the parent id. This was done as our review wanted the put structure to more closely match the get structure.

The API review board you mean?

Yes - sorry, was typing from my phone.

mcardosos · 2018-01-30T21:29:02Z

...n/resources/resource-manager/Microsoft.Management/preview/2018-01-01-preview/management.json

+          "description": "The friendly name of the management group. If no value is passed then this  field will be set to the groupId.",
+          "x-nullable": true
+        },
+        "roles": {


roles [](start = 9, length = 5)

What kind of roles? It sounds as if this could be expressed as an enum #Resolved

Role definition ids #Resolved

Could this be clarified in the description?

In reply to: 164898347 [](ancestors = 164898347)

Yep. #Resolved

mcardosos · 2018-01-30T21:32:11Z

...n/resources/resource-manager/Microsoft.Management/preview/2018-01-01-preview/management.json

+          "description": "The name of the management group. For example, 00000000-0000-0000-0000-000000000000",
+          "readOnly": true
+        },
+        "provisioningState": {


provisioningState [](start = 9, length = 17)

Could this be an enum?

Right now it's just one value... But we can change it

mcardosos · 2018-01-30T21:34:58Z

...n/resources/resource-manager/Microsoft.Management/preview/2018-01-01-preview/management.json

+          "type": "string",
+          "readOnly": true
+        },
+        "display": {


display [](start = 9, length = 7)

For code generation purposes, it is better no to define models inline #Resolved

mcardosos · 2018-01-30T21:41:36Z

...n/resources/resource-manager/Microsoft.Management/preview/2018-01-01-preview/management.json

+        "tags": [
+          "Entities"
+        ],
+        "operationId": "Entities_List",


Entities_List [](start = 24, length = 13)

Odata extension can be useful here too

AutorestCI · 2018-02-01T01:47:22Z

This commit was treated and no generation was made for Azure/azure-sdk-for-python

AutorestCI · 2018-02-01T01:48:08Z

This commit was treated and no generation was made for Azure/azure-sdk-for-go

AutorestCI · 2018-02-01T05:23:05Z

This commit was treated and no generation was made for Azure/azure-sdk-for-python

AutorestCI · 2018-02-01T05:23:51Z

This commit was treated and no generation was made for Azure/azure-sdk-for-go

AutorestCI · 2018-02-01T20:18:20Z

This commit was treated and no generation was made for Azure/azure-sdk-for-go

AutorestCI · 2018-02-01T20:20:33Z

This commit was treated and no generation was made for Azure/azure-sdk-for-python

AutorestCI · 2018-02-01T21:54:42Z

This commit was treated and no generation was made for Azure/azure-sdk-for-python

AutorestCI · 2018-02-01T22:17:21Z

This commit was treated and no generation was made for Azure/azure-sdk-for-go

mcardosos · 2018-02-02T01:55:45Z

...n/resources/resource-manager/Microsoft.Management/preview/2018-01-01-preview/management.json

+  "host": "management.azure.com",
+  "info": {
+    "version": "2018-01-01-preview",
+    "title": "Management Groups API",


Are you adding this to the markdown file?

The config file

azuresdkciprbot · 2018-02-02T02:10:24Z

Hi There,

I am the AutoRest Linter Azure bot. I am here to help. My task is to analyze the situation from the AutoRest linter perspective. Please review the below analysis result:

File: specification/resources/resource-manager/readme.md
Before the PR: Warning(s): 0 Error(s): 71
After the PR: Warning(s): 0 Error(s): 71

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

azuresdkciprbot · 2018-02-02T02:12:44Z

Hi There,

I am the AutoRest Linter Azure bot. I am here to help. My task is to analyze the situation from the AutoRest linter perspective. Please review the below analysis result:

File: specification/resources/resource-manager/readme.md
Before the PR: Warning(s): 0 Error(s): 71
After the PR: Warning(s): 0 Error(s): 0

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

AutorestCI · 2018-02-02T02:14:18Z

Swagger to SDK encountered a Subprocess error: (Azure/azure-sdk-for-go)

Command: ['/usr/local/bin/autorest', '/tmp/tmpsh7fdubi/rest/specification/resources/resource-manager/readme.md', '--go', '--go-sdk-folder=/tmp/tmpsh7fdubi/sdk', '--multiapi', '--package-version=v12.2.1-beta', '--use=@microsoft.azure/autorest.go@preview', "--user-agent='Azure-SDK-For-Go/v12.2.1-beta services'", '--verbose']
Finished with return code 1
and output:

AutoRest code generation utility [version: 2.0.4244; node: v7.10.1]
(C) 2018 Microsoft Corporation.
https://aka.ms/autorest

There is a new version of AutoRest available (2.0.4245).
 > You can install the newer version with with npm install -g autorest@latest

   Loading AutoRest core      '/tmp/.autorest/@microsoft.azure_autorest-core@2.0.4244/node_modules/@microsoft.azure/autorest-core/dist' (2.0.4244)
   Loading AutoRest extension '@microsoft.azure/autorest.go' (preview->3.0.40)
   Loading AutoRest extension '@microsoft.azure/autorest.modeler' (2.1.22->2.1.22)
Processing batch task - {"tag":"package-2017-04-preview"} .
Failure during batch task - {"tag":"package-2017-04-preview"} -- Error: [Exception] No input files provided.

Use --help to get help information..
[Exception] No input files provided.

Use --help to get help information.

ravbhatnagar · 2018-02-02T02:24:25Z

This was reviewed over skype by Azure API review board and ARM. Signing off!

AutorestCI · 2018-02-02T02:28:32Z

Swagger to SDK encountered a Subprocess error: (Azure/azure-sdk-for-go)

Command: ['/usr/local/bin/autorest', '/tmp/tmpuvcktwmy/rest/specification/resources/resource-manager/readme.md', '--go', '--go-sdk-folder=/tmp/tmpuvcktwmy/sdk', '--multiapi', '--package-version=v12.2.1-beta', '--use=@microsoft.azure/autorest.go@preview', "--user-agent='Azure-SDK-For-Go/v12.2.1-beta services'", '--verbose']
Finished with return code 1
and output:

AutoRest code generation utility [version: 2.0.4244; node: v7.10.1]
(C) 2018 Microsoft Corporation.
https://aka.ms/autorest

There is a new version of AutoRest available (2.0.4245).
 > You can install the newer version with with npm install -g autorest@latest

   Loading AutoRest core      '/tmp/.autorest/@microsoft.azure_autorest-core@2.0.4244/node_modules/@microsoft.azure/autorest-core/dist' (2.0.4244)
   Loading AutoRest extension '@microsoft.azure/autorest.go' (preview->3.0.40)
   Loading AutoRest extension '@microsoft.azure/autorest.modeler' (2.1.22->2.1.22)
Processing batch task - {"tag":"package-2017-04-preview"} .
Failure during batch task - {"tag":"package-2017-04-preview"} -- Error: [Exception] No input files provided.

Use --help to get help information..
[Exception] No input files provided.

Use --help to get help information.

AutorestCI · 2018-02-02T02:35:18Z

This commit was treated and no generation was made for Azure/azure-sdk-for-python

AutorestCI · 2018-02-02T03:17:45Z

This commit was treated and no generation was made for Azure/azure-sdk-for-python

mcardosos

Thanks for the good teamwork :D

AutorestCI · 2018-02-02T03:40:18Z

Swagger to SDK encountered a Subprocess error: (Azure/azure-sdk-for-go)

Command: ['/usr/local/bin/autorest', '/tmp/tmpqcw4b1rf/rest/specification/resources/resource-manager/readme.md', '--go', '--go-sdk-folder=/tmp/tmpqcw4b1rf/sdk', '--multiapi', '--package-version=v12.2.1-beta', '--use=@microsoft.azure/autorest.go@preview', "--user-agent='Azure-SDK-For-Go/v12.2.1-beta services'", '--verbose']
Finished with return code 1
and output:

AutoRest code generation utility [version: 2.0.4244; node: v7.10.1]
(C) 2018 Microsoft Corporation.
https://aka.ms/autorest

There is a new version of AutoRest available (2.0.4245).
 > You can install the newer version with with npm install -g autorest@latest

   Loading AutoRest core      '/tmp/.autorest/@microsoft.azure_autorest-core@2.0.4244/node_modules/@microsoft.azure/autorest-core/dist' (2.0.4244)
   Loading AutoRest extension '@microsoft.azure/autorest.go' (preview->3.0.40)
   Loading AutoRest extension '@microsoft.azure/autorest.modeler' (2.1.22->2.1.22)
Processing batch task - {"tag":"package-2017-04-preview"} .
Failure during batch task - {"tag":"package-2017-04-preview"} -- Error: [Exception] No input files provided.

Use --help to get help information..
[Exception] No input files provided.

Use --help to get help information.

AutorestCI · 2018-02-02T04:15:03Z

This commit was treated and no generation was made for Azure/azure-sdk-for-python

AutorestCI · 2018-02-02T04:15:05Z

Was unable to create SDK Azure/azure-sdk-for-python PR for this closed PR.

ManagementGroups API update (2018-01-01-preview)

17c3aef

azuresdkci assigned mcardosos Jan 26, 2018

sendhil added 2 commits January 27, 2018 18:19

Tweaking the examples

bee9dec

Updating PutManagementGroup.json

87cc7b0

Updating GetManagementGroupWithExpandAndRecurse.json

d2c5a7e

REDMOND\sepancha added 3 commits January 29, 2018 15:53

Updating some examples

a47a5b8

Removing example in the wrong directory

6ffe4b6

Few tweaks to the descriptions as well as adding some missing x-nulla…

6650e54

…ble's

Removing all the format:uuid's as they're causing warnings in the val…

acfafa4

…idator

mcardosos reviewed Jan 30, 2018

View reviewed changes

Fixing warnings generated by oav

fba085a

Fixing a few more warnings

2e71e26

Adding an x-nullable to the getEntities permissions property

da770a6

mcardosos reviewed Feb 2, 2018

View reviewed changes

mcardosos added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Feb 2, 2018

REDMOND\sepancha added 2 commits February 1, 2018 18:04

Updating the config file

e2cba49

One more thing for the config file...

817918c

ravbhatnagar added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Feb 2, 2018

mcardosos approved these changes Feb 2, 2018

View reviewed changes

mcardosos merged commit f9ec240 into Azure:master Feb 2, 2018

rajshah11 mentioned this pull request Feb 10, 2018

Move ManagementGroups out of Resources to a separate folder #2469

Merged

10 tasks

Conversation

sendhil commented Jan 26, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR information

Quality of Swagger

Uh oh!

AutorestCI commented Jan 26, 2018

Uh oh!

AutorestCI commented Jan 26, 2018

Uh oh!

AutorestCI commented Jan 28, 2018

Uh oh!

AutorestCI commented Jan 28, 2018

Uh oh!

sendhil commented Jan 28, 2018

Uh oh!

AutorestCI commented Jan 28, 2018

Uh oh!

AutorestCI commented Jan 28, 2018

Uh oh!

AutorestCI commented Jan 28, 2018

Uh oh!

AutorestCI commented Jan 28, 2018

Uh oh!

AutorestCI commented Jan 29, 2018

Uh oh!

AutorestCI commented Jan 29, 2018

Uh oh!

AutorestCI commented Jan 30, 2018

Uh oh!

AutorestCI commented Jan 30, 2018

Uh oh!

mcardosos Jan 30, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sendhil Jan 30, 2018 • edited by mcardosos Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sendhil Jan 31, 2018 • edited by mcardosos Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mcardosos Jan 30, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sendhil Jan 30, 2018 • edited by mcardosos Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sendhil Jan 31, 2018 • edited by mcardosos Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mcardosos Jan 30, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

sendhil commented Jan 26, 2018 •

edited

Loading

mcardosos Jan 30, 2018 •

edited

Loading

sendhil Jan 30, 2018 •

edited by mcardosos

Loading

sendhil Jan 31, 2018 •

edited by mcardosos

Loading

mcardosos Jan 30, 2018 •

edited

Loading

sendhil Jan 30, 2018 •

edited by mcardosos

Loading

sendhil Jan 31, 2018 •

edited by mcardosos

Loading

mcardosos Jan 30, 2018 •

edited

Loading