Update Azure Governance Policy api-version to 2018-03-01 by mentat9 · Pull Request #3032 · Azure/azure-rest-api-specs

mentat9 · 2018-05-07T21:57:39Z

This api spec combines api-version 2017-06-01-preview and 2016-12-01 into one, cleans up all validation issues, adds full examples, and clarifies/improves all descriptions. It should be fully back-compatible.

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.

- add many missing examples - improve/complete descriptions and summaries

Add/correct some response codes

azuresdkciprbot · 2018-05-07T22:03:37Z

AutoRest linter results for SDK Related Validation Errors/Warnings

These errors are reported by the SDK team's validation tools, reachout to ADX Swagger Reviewers directly for any questions or concerns.

File: specification/resources/resource-manager/readme.md

⚠️

0 new Warnings.(0 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

azuresdkciprbot · 2018-05-07T22:03:37Z

AutoRest linter results for ARM Related Validation Errors/Warnings

These errors are reported by the ARM team's validation tools, reachout to ARM RP API Review directly for any questions or concerns.

File: specification/resources/resource-manager/readme.md

⚠️

0 new Warnings.(0 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

AutorestCI · 2018-05-07T22:03:54Z

Automation for azure-sdk-for-node

Encountered a Subprocess error: (azure-sdk-for-node)

Command: ['/usr/local/bin/autorest', '/tmp/tmp6rn5la_d/rest/specification/resources/resource-manager/readme.md', '--license-header=MICROSOFT_MIT_NO_VERSION', '--node-sdks-folder=/tmp/tmp6rn5la_d/sdk', '--nodejs', '--use=@microsoft.azure/autorest.nodejs@^2.1.43']
Finished with return code 1
and output:

AutoRest code generation utility [version: 2.0.4262; node: v7.10.1]
(C) 2018 Microsoft Corporation.
https://aka.ms/autorest
   Loading AutoRest core      '/root/.autorest/@microsoft.azure_autorest-core@2.0.4275/node_modules/@microsoft.azure/autorest-core/dist' (2.0.4275)
   Loading AutoRest extension '@microsoft.azure/autorest.nodejs' (^2.1.43->2.1.59)
   Loading AutoRest extension '@microsoft.azure/autorest.modeler' (2.3.44->2.3.44)
[Exception] No input files provided.

Use --help to get help information.

marstr

Our CI system is pretty unhappy with this PR. Before I review this in earnest, could you fix the invalid JSON that is likely messing with our tooling?
https://travis-ci.org/Azure/azure-rest-api-specs/jobs/376107691#L699

AutorestCI · 2018-05-08T00:50:39Z

Automation for azure-libraries-for-java

The initial PR has been merged into your service PR:
AutorestCI/azure-libraries-for-java#154

AutorestCI · 2018-05-08T00:54:02Z

Automation for azure-sdk-for-go

The initial PR has been merged into your service PR:
Azure/azure-sdk-for-go#1839

AutorestCI · 2018-05-08T00:59:56Z

Automation for azure-sdk-for-python

The initial PR has been merged into your service PR:
Azure/azure-sdk-for-python#2570

mentat9 · 2018-05-08T01:17:01Z

I'd love to. Thing is, that file exists and is completely valid JSON: https://github.com/mentat9/azure-rest-api-specs/blob/master/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/listBuiltInPolicyDefinitions.json

I haven't learned all the quirks of Travis, but it looks like it's detecting something different than what the message says. I don't see anything wrong with that file, or anything wrong in the nearby JSON. All of the local validation tools find that file and validate it just fine. Have you come across this kind of error before?

mentat9 · 2018-05-08T17:25:11Z

Adding @pilor

Change policyAssignment result for nonexistent delete by ID to match all other delete methods Attempt to fix Travis FNF error

azuresdkciprbot · 2018-05-08T17:54:13Z

AutoRest linter results for SDK Related Validation Errors/Warnings

These errors are reported by the SDK team's validation tools, reachout to ADX Swagger Reviewers directly for any questions or concerns.

File: specification/resources/resource-manager/readme.md

⚠️

0 new Warnings.(0 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

azuresdkciprbot · 2018-05-08T17:54:13Z

AutoRest linter results for ARM Related Validation Errors/Warnings

These errors are reported by the ARM team's validation tools, reachout to ARM RP API Review directly for any questions or concerns.

File: specification/resources/resource-manager/readme.md

⚠️

0 new Warnings.(0 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

azuresdkciprbot · 2018-05-08T18:21:56Z

AutoRest linter results for ARM Related Validation Errors/Warnings

These errors are reported by the ARM team's validation tools, reachout to ARM RP API Review directly for any questions or concerns.

File: specification/resources/resource-manager/readme.md

⚠️

0 new Warnings.(0 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

azuresdkciprbot · 2018-05-08T18:21:56Z

AutoRest linter results for SDK Related Validation Errors/Warnings

These errors are reported by the SDK team's validation tools, reachout to ADX Swagger Reviewers directly for any questions or concerns.

File: specification/resources/resource-manager/readme.md

⚠️

0 new Warnings.(0 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

…ile as much as possible.

azuresdkciprbot · 2018-05-08T19:43:18Z

AutoRest linter results for ARM Related Validation Errors/Warnings

These errors are reported by the ARM team's validation tools, reachout to ARM RP API Review directly for any questions or concerns.

File: specification/resources/resource-manager/readme.md

⚠️

0 new Warnings.(0 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

azuresdkciprbot · 2018-05-08T19:43:18Z

AutoRest linter results for SDK Related Validation Errors/Warnings

These errors are reported by the SDK team's validation tools, reachout to ADX Swagger Reviewers directly for any questions or concerns.

File: specification/resources/resource-manager/readme.md

⚠️

0 new Warnings.(0 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

azuresdkciprbot · 2018-05-08T20:25:40Z

AutoRest linter results for ARM Related Validation Errors/Warnings

These errors are reported by the ARM team's validation tools, reachout to ARM RP API Review directly for any questions or concerns.

File: specification/resources/resource-manager/readme.md

⚠️

0 new Warnings.(0 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

azuresdkciprbot · 2018-05-08T20:25:40Z

AutoRest linter results for SDK Related Validation Errors/Warnings

These errors are reported by the SDK team's validation tools, reachout to ADX Swagger Reviewers directly for any questions or concerns.

File: specification/resources/resource-manager/readme.md

⚠️

0 new Warnings.(0 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

azuresdkciprbot · 2018-05-08T21:25:10Z

AutoRest linter results for SDK Related Validation Errors/Warnings

These errors are reported by the SDK team's validation tools, reachout to ADX Swagger Reviewers directly for any questions or concerns.

File: specification/resources/resource-manager/readme.md

⚠️

0 new Warnings.(0 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

azuresdkciprbot · 2018-05-08T21:25:10Z

AutoRest linter results for ARM Related Validation Errors/Warnings

These errors are reported by the ARM team's validation tools, reachout to ARM RP API Review directly for any questions or concerns.

File: specification/resources/resource-manager/readme.md

⚠️

0 new Warnings.(0 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

mentat9 · 2018-05-08T22:22:53Z

OK, I've fixed the Travis issue. Turns out sometimes JSON references to external files interpret the file path as case sensitive. Autorest running against a local repo on my dev box resolves $ref as case INsensitive, but when it runs against a GitHub repo, it resolves that same $ref as case sensitive. This is a bad tool bug, IMO.

pilor · 2018-05-08T23:52:12Z

...orization/stable/2018-03-01/examples/createOrUpdatePolicySetDefinitionAtManagementGroup.json

+        },
+        "policyDefinitions": [
+          {
+            "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",


an MG policySet wouldn't be able to reference a policyDefinition in a subscription (can only reference at the same level or above). Should change this to an MG level reference for completeness

Agree, will do.

pilor · 2018-05-08T23:53:49Z

...e-manager/Microsoft.Authorization/stable/2018-03-01/examples/createPolicyAssignmentById.json

@@ -0,0 +1,51 @@
+{
+  "parameters": {
+    "policyAssignmentId": "providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyAssignments/LowCostStorage",


leading slash?

Nah, the slash is in the path template: /{policyAssignmentId}. Including it in the parameter would create a double slash. Similar thing happens in examples of the /{scope}/. . . path.

pilor · 2018-05-08T23:54:54Z

...e-manager/Microsoft.Authorization/stable/2018-03-01/examples/deletePolicyAssignmentById.json

@@ -0,0 +1,36 @@
+{
+  "parameters": {
+    "policyAssignmentId": "providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyAssignments/LowCostStorage",


leading slash?

pilor · 2018-05-08T23:58:05Z

...ger/Microsoft.Authorization/stable/2018-03-01/examples/listPolicyAssignmentsForResource.json

+    "resourceName": "MyTestComputer.cloudapp.net",
+    "subscriptionId": "ae640e6b-ba3e-4256-9d62-2993eecfa6f2",
+    "api-version": "2018-03-01",
+    "$filter": "atScope()"


if atScope() was provided only policies that were assigned directly on the resource would be returned, the response below has subscription level resources

Quite right. I'll get it fixed up.

azuresdkciprbot · 2018-05-09T01:01:09Z

AutoRest linter results for ARM Related Validation Errors/Warnings

These errors are reported by the ARM team's validation tools, reachout to ARM RP API Review directly for any questions or concerns.

File: specification/resources/resource-manager/readme.md

⚠️

0 new Warnings.(0 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

azuresdkciprbot · 2018-05-09T01:01:09Z

AutoRest linter results for SDK Related Validation Errors/Warnings

These errors are reported by the SDK team's validation tools, reachout to ADX Swagger Reviewers directly for any questions or concerns.

File: specification/resources/resource-manager/readme.md

⚠️

0 new Warnings.(0 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

ravbhatnagar · 2018-05-15T06:07:46Z

@marstr @mentat9 - Its hard to review the changes in this api-version. The first commit didnt include the original version.

ravbhatnagar · 2018-05-15T06:16:01Z

Ok, so I compared the policyAssignment.json, policyDefinition.json with the previos version using a diff tool. There were no major changes. I also took a look at policySetDefinition.json which is a new file. APIs for this are already live on service side. So signing off from ARM side.

mentat9 · 2018-05-15T18:23:15Z

@marstr, all checks are passing: can you close your change request/comment?

marstr · 2018-05-15T23:31:35Z

@mentat9, are these changes deployed from your side, and ready for me to merge?

mentat9 · 2018-05-16T00:59:31Z

Actually, I just discovered some wording changes I want to make in description fields. I'll ping back after those are done.

azuresdkciprbot · 2018-05-16T02:28:44Z

AutoRest linter results for SDK Related Validation Errors/Warnings

These errors are reported by the SDK team's validation tools, reachout to ADX Swagger Reviewers directly for any questions or concerns.

File: specification/resources/resource-manager/readme.md

⚠️

0 new Warnings.(0 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

azuresdkciprbot · 2018-05-16T02:28:44Z

AutoRest linter results for ARM Related Validation Errors/Warnings

These errors are reported by the ARM team's validation tools, reachout to ARM RP API Review directly for any questions or concerns.

File: specification/resources/resource-manager/readme.md

⚠️

0 new Warnings.(0 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

mentat9 · 2018-05-16T02:39:59Z

@marstr, We are good to go from a service perspective, and my description updates are in. Please merge at your earliest convenience after checks succeed.

mentat9 · 2018-06-06T21:35:23Z

@marstr do you happen to know whom I should follow this failure up with? I need to generate the Node.js SDK, but the docs give an email alias that no longer exists for the Node.js SDK team.

Automation for azure-sdk-for-node

Encountered a Subprocess error: (azure-sdk-for-node)

Command: ['/usr/local/bin/autorest', '/tmp/tmp6rn5la_d/rest/specification/resources/resource-manager/readme.md', '--license-header=MICROSOFT_MIT_NO_VERSION', '--node-sdks-folder=/tmp/tmp6rn5la_d/sdk', '--nodejs', '--use=@microsoft.azure/autorest.nodejs@^2.1.43']
Finished with return code 1
and output:
AutoRest code generation utility [version: 2.0.4262; node: v7.10.1]
(C) 2018 Microsoft Corporation.
https://aka.ms/autorest
Loading AutoRest core '/root/.autorest/@microsoft.azure_autorest-core@2.0.4275/node_modules/@microsoft.azure/autorest-core/dist' (2.0.4275)
Loading AutoRest extension '@microsoft.azure/autorest.nodejs' (^2.1.43->2.1.59)
Loading AutoRest extension '@microsoft.azure/autorest.modeler' (2.3.44->2.3.44)
[Exception] No input files provided.

Use --help to get help information.

RikkiGibson · 2018-06-13T17:29:50Z

@AutorestCI rebuild azure-sdk-for-node

AutorestCI · 2018-06-13T17:31:22Z

Encountered a Subprocess error

Command: ['/usr/local/bin/autorest', '/tmp/tmpda054lkj/rest/specification/resources/resource-manager/readme.md', '--license-header=MICROSOFT_MIT_NO_VERSION', '--node-sdks-folder=/tmp/tmpda054lkj/sdk', '--nodejs', '--use=@microsoft.azure/autorest.nodejs@^2.1.43']
Finished with return code 1
and output:

AutoRest code generation utility [version: 2.0.4262; node: v7.10.1]
(C) 2018 Microsoft Corporation.
https://aka.ms/autorest
   Loading AutoRest core      '/root/.autorest/@microsoft.azure_autorest-core@2.0.4278/node_modules/@microsoft.azure/autorest-core/dist' (2.0.4278)
   Loading AutoRest extension '@microsoft.azure/autorest.nodejs' (^2.1.43->2.1.59)
   Loading AutoRest extension '@microsoft.azure/autorest.modeler' (2.3.44->2.3.44)
[Exception] No input files provided.

Use --help to get help information.

RikkiGibson · 2018-07-18T17:15:56Z

@AutorestCI rebuild azure-sdk-for-node

AutorestCI · 2018-07-18T17:16:26Z

Encountered a Subprocess error

Command: ['/usr/local/bin/autorest', '/tmp/tmpnpmjnkn8/rest/specification/resources/resource-manager/readme.md', '--license-header=MICROSOFT_MIT_NO_VERSION', '--node-sdks-folder=/tmp/tmpnpmjnkn8/sdk', '--nodejs', '--use=@microsoft.azure/autorest.nodejs@^2.1.43']
Finished with return code 1
and output:

AutoRest code generation utility [version: 2.0.4280; node: v8.11.3]
(C) 2018 Microsoft Corporation.
https://aka.ms/autorest
   Loading AutoRest core      '/root/.autorest/@microsoft.azure_autorest-core@2.0.4280/node_modules/@microsoft.azure/autorest-core/dist' (2.0.4280)
   Loading AutoRest extension '@microsoft.azure/autorest.nodejs' (^2.1.43->2.1.59)
   Loading AutoRest extension '@microsoft.azure/autorest.modeler' (2.3.44->2.3.44)
[Exception] No input files provided.

Use --help to get help information.

RikkiGibson · 2018-07-18T17:17:19Z

Really not sure what the problem is-- when I copy those args, modify to my local versions of the SDK and rest-api-specs and run locally, it's fine. I'm opening a PR for you @mentat9.

mentat9 added 2 commits May 4, 2018 15:41

Update swagger for api-version 2018-03-01

260b409

- add many missing examples - improve/complete descriptions and summaries

Fix a handful of validation failures

f5706dc

Add/correct some response codes

sarangan12 added the review label May 7, 2018

azuresdkci assigned marstr May 7, 2018

azuresdkci requested a review from marstr May 7, 2018 21:58

marstr requested changes May 7, 2018

View reviewed changes

Fix back-compat for some error codes (leaving it inconsistent)

bb2c39e

Change policyAssignment result for nonexistent delete by ID to match all other delete methods Attempt to fix Travis FNF error

Fix bracket bug in last commit

952d075

Another attempt to fix Travis CI FNF error: simplifying the example f…

98661bb

…ile as much as possible.

Another attempt to fix Travis FNF error (filename casing...)

e429227

Putting back original example, modified during troubleshooting.

c6fdb57

marstr mentioned this pull request May 8, 2018

Inconsistent case sensitivity behavior of $ref file path resolution Azure/autorest#2914

Closed

pilor suggested changes May 9, 2018

View reviewed changes

Apply PR feedback (fix errors in a couple examples)

feef9b1

AutorestCI mentioned this pull request May 9, 2018

[AutoPR resources/resource-manager] Update Azure Governance Policy api-version to 2018-03-01 AutorestCI/azure-libraries-for-java#153

Merged

pilor approved these changes May 9, 2018

View reviewed changes

marstr added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label May 9, 2018

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 May 15, 2018

marstr approved these changes May 15, 2018

View reviewed changes

Correct/improve wording in description properties.

fbc7d29

marstr merged commit a2422bb into Azure:master May 16, 2018

RikkiGibson mentioned this pull request Jun 13, 2018

[not swagger] Fix readme.nodejs.md config for resources #3228

Merged

mentat9 mentioned this pull request Jun 27, 2018

Update tests for Policy SDK version 2018-03-01 Azure/azure-sdk-for-net#4499

Merged

9 tasks

RikkiGibson mentioned this pull request Jul 18, 2018

Regen resources Azure/azure-sdk-for-node#3192

Closed

Conversation

mentat9 commented May 7, 2018 • edited by azuresdkci Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR information

Quality of Swagger

Uh oh!

azuresdkciprbot commented May 7, 2018

AutoRest linter results for SDK Related Validation Errors/Warnings

Uh oh!

azuresdkciprbot commented May 7, 2018

AutoRest linter results for ARM Related Validation Errors/Warnings

Uh oh!

AutorestCI commented May 7, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-sdk-for-node

Uh oh!

marstr left a comment

Choose a reason for hiding this comment

Uh oh!

AutorestCI commented May 8, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-libraries-for-java

Uh oh!

AutorestCI commented May 8, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-sdk-for-go

Uh oh!

AutorestCI commented May 8, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-sdk-for-python

Uh oh!

mentat9 commented May 8, 2018

Uh oh!

mentat9 commented May 8, 2018

Uh oh!

azuresdkciprbot commented May 8, 2018

AutoRest linter results for SDK Related Validation Errors/Warnings

Uh oh!

azuresdkciprbot commented May 8, 2018

AutoRest linter results for ARM Related Validation Errors/Warnings

Uh oh!

azuresdkciprbot commented May 8, 2018

AutoRest linter results for ARM Related Validation Errors/Warnings

Uh oh!

azuresdkciprbot commented May 8, 2018

AutoRest linter results for SDK Related Validation Errors/Warnings

Uh oh!

azuresdkciprbot commented May 8, 2018

AutoRest linter results for ARM Related Validation Errors/Warnings

Uh oh!

azuresdkciprbot commented May 8, 2018

AutoRest linter results for SDK Related Validation Errors/Warnings

Uh oh!

azuresdkciprbot commented May 8, 2018

AutoRest linter results for ARM Related Validation Errors/Warnings

Uh oh!

azuresdkciprbot commented May 8, 2018

AutoRest linter results for SDK Related Validation Errors/Warnings

Uh oh!

azuresdkciprbot commented May 8, 2018

AutoRest linter results for SDK Related Validation Errors/Warnings

Uh oh!

azuresdkciprbot commented May 8, 2018

AutoRest linter results for ARM Related Validation Errors/Warnings

Uh oh!

mentat9 commented May 8, 2018

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

mentat9 commented May 7, 2018 •

edited by azuresdkci

Loading

AutorestCI commented May 7, 2018 •

edited

Loading

AutorestCI commented May 8, 2018 •

edited

Loading

AutorestCI commented May 8, 2018 •

edited

Loading

AutorestCI commented May 8, 2018 •

edited

Loading

mentat9 commented May 16, 2018 •

edited

Loading