Swagger and Examples for the new Scoped tokens feature of Azure Container registry #5543

mnltejaswini · 2019-04-03T20:50:22Z

Latest improvements:

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Contribution checklist:

I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and have all been fixed in this PR.
The OpenAPI Hub was used for checking validation status and next steps.

ARM API Review Checklist

Service team MUST add the "WaitForARMFeedback" label if the management plane API changes fall into one of the below categories.
adding/removing APIs.
adding/removing properties.
adding/removing API-version.
adding a new service in Azure.

Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs.

If you are blocked on ARM review and want to get the PR merged urgently, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Please follow the link to find more details on API review process.

Feature Description

Scoped tokens gives ability for users to create tokens with fine grained scope to the artifacts of the registry. Registry administrator defines the permission maps/sets by creating scope maps. After the permission sets are defined by creating scope maps, tokens can be created for a registry with specific scope map. Users can generate credentials for a token and the permissions of the credentials are bound to a token and thereby transitively bound to the scope map.
We are adding two new resources "scopeMaps" and "tokens" under the top level resource "registries". ScopeMaps model the permission sets and tokens are the mapping to the specific scope map.

AutorestCI · 2019-04-03T20:50:55Z

Automation for azure-sdk-for-go

Nothing to generate for azure-sdk-for-go

AutorestCI · 2019-04-03T20:50:55Z

Automation for azure-sdk-for-python

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

AutorestCI · 2019-04-03T20:50:59Z

Automation for azure-sdk-for-ruby

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

Command: ['/usr/local/bin/autorest', '/tmp/tmpnds_adqx/rest/specification/containerregistry/resource-manager/readme.md', '--perform-load=false', '--swagger-to-sdk', '--output-artifact=configuration.json', '--input-file=foo', '--output-folder=/tmp/tmpem2k9nx3']
Finished with return code 7
and output:

AutoRest code generation utility [version: 2.0.4283; node: v8.12.0]
(C) 2018 Microsoft Corporation.
https://aka.ms/autorest
Failure:
Error: Unable to start AutoRest Core from /root/.autorest/@[email protected]/node_modules/@microsoft.azure/autorest-core
Error: Unable to start AutoRest Core from /root/.autorest/@[email protected]/node_modules/@microsoft.azure/autorest-core
    at main (/opt/node_modules/autorest/dist/app.js:232:19)
    at <anonymous>

/root/.autorest/@[email protected]/node_modules/@microsoft.azure/autorest-core/dist/app.js:33
    autorest_core_1.Shutdown();
    ^
ReferenceError: autorest_core_1 is not defined
    at process.on (/root/.autorest/@[email protected]/node_modules/@microsoft.azure/autorest-core/dist/app.js:33:5)
    at emitOne (events.js:121:20)
    at process.emit (events.js:211:7)
    at process.emit (/node_modules/source-map-support/source-map-support.js:439:21)
fs.js:612
  return binding.close(fd);
                 ^

Error: EBADF: bad file descriptor, close
    at Object.fs.closeSync (fs.js:612:18)
    at StaticVolumeFile.shutdown (/opt/node_modules/autorest/dist/static-loader.js:352:10)
    at StaticFilesystem.shutdown (/opt/node_modules/autorest/dist/static-loader.js:406:17)
    at process.exit.n [as exit] (/opt/node_modules/autorest/dist/static-loader.js:169:11)
    at printErrorAndExit (/node_modules/source-map-support/source-map-support.js:423:11)
    at process.emit (/node_modules/source-map-support/source-map-support.js:435:16)
    at process._fatalException (bootstrap_node.js:391:26)

AutorestCI · 2019-04-03T20:51:00Z

Automation for azure-sdk-for-js

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

AutorestCI · 2019-04-03T20:51:49Z

Automation for azure-sdk-for-java

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

azuresdkci · 2019-04-03T20:59:34Z

Can one of the admins verify this patch?

REST Spec PR 'Azure/azure-rest-api-specs#5543' REST Spec PR Author 'mnltejaswini' REST Spec PR Last commit

adxsdknet · 2019-04-03T21:04:52Z

Automation for azure-sdk-for-net

A PR has been created for you:
Azure/azure-sdk-for-net#5677
.NET SDK Commits:
adxsdknet/azure-sdk-for-net@5b99a0d
adxsdknet/azure-sdk-for-net@17bd82e
adxsdknet/azure-sdk-for-net@0780621
adxsdknet/azure-sdk-for-net@a97223a

REST Spec PR 'Azure/azure-rest-api-specs#5543' REST Spec PR Author 'mnltejaswini' REST Spec PR Last commit

kpajdzik · 2019-04-05T20:59:49Z

If you haven't taken a look at our new onboarding experience at OpenAPIHub, it's a convenient way to create your PR when you're copying from an existing API version or when you're editing your existing specs. If you have any feedback or questions, feel free to use the feedback button on top of the site for help. Thanks!

Also, regarding "[Do not merge]" tag, take a look at GitHub pull requests drafts - https://github.blog/2019-02-14-introducing-draft-pull-requests/.

...nager/Microsoft.ContainerRegistry/preview/2019-05-01-preview/containerregistry_scopemap.json

KrisBash

A few small comments to review

KrisBash · 2019-04-09T03:04:32Z

...nager/Microsoft.ContainerRegistry/preview/2019-05-01-preview/containerregistry_scopemap.json

+              "$ref": "#/definitions/ScopeMap"
+            }
+          },
+          "201": {


A 202 would be more accurate

for PUT /PATCH resource we are following the AzureAsync header pattern rather than Location header pattern as recommended by https://armwiki.azurewebsites.net/faq/Intro.html?q=async

KrisBash · 2019-04-09T03:05:04Z

...nager/Microsoft.ContainerRegistry/preview/2019-05-01-preview/containerregistry_scopemap.json

+              "$ref": "#/definitions/Token"
+            }
+          },
+          "201": {


KrisBash · 2019-04-09T03:05:40Z

...nager/Microsoft.ContainerRegistry/preview/2019-05-01-preview/containerregistry_scopemap.json

+          "type": "string"
+        },
+        "name": {
+          "description": "Specifies name of the password which should be regenerated if any -- password or password1.",


The description doesn't match the enum

KrisBash · 2019-04-09T03:06:05Z

...nager/Microsoft.ContainerRegistry/preview/2019-05-01-preview/containerregistry_scopemap.json

+          "type": "string",
+          "x-ms-enum": {
+            "name": "PasswordName",
+            "modelAsString": false


modelAsString: true would allow for future enum additions without breaking API

KrisBash · 2019-04-09T03:06:35Z

...nager/Microsoft.ContainerRegistry/preview/2019-05-01-preview/containerregistry_scopemap.json

+          "type": "string",
+          "x-ms-enum": {
+            "name": "PasswordName",
+            "modelAsString": false


See prior comment on modelAsString: true

KrisBash · 2019-04-09T03:07:59Z

...nager/Microsoft.ContainerRegistry/preview/2019-05-01-preview/containerregistry_scopemap.json

+        }
+      }
+    },
+    "ProxyResource": {


FYI, there are common definitions you can reference in: https://github.com/Azure/azure-rest-api-specs/blob/master/specification/common-types/resource-management/v1/types.json

@KrisBash The parent swagger has some description mismatch with that defined in common types. The build breaks for that. I will fix the parent swagger and this change separate to this PR. For now I added the custom proxy resource schema to the definitions.

This is a recommendation, not blocking. thanks

mnltejaswini · 2019-04-12T00:43:41Z

@KrisBash Addressed your feedback.

...nager/Microsoft.ContainerRegistry/preview/2019-05-01-preview/containerregistry_scopemap.json

mnltejaswini · 2019-05-04T01:22:45Z

@kpajdzik We will be rolling out RP changes to Production starting next week after Build. Once it si deployed, I will resolve conflicts and remove the tag Do not Update tag on the title.

…tificates

REST Spec PR 'Azure/azure-rest-api-specs#5543' REST Spec PR Author 'mnltejaswini' REST Spec PR Last commit

kpajdzik · 2019-05-14T15:44:00Z

@mnltejaswini, is it ready to merge?

mnltejaswini · 2019-05-16T21:04:12Z

@kpajdzik Thank you for checking on it. The rollout is in progress. Its start was delayed due to some internal reasons. By next week, the rollout should be completed.

REST Spec PR 'Azure/azure-rest-api-specs#5543' REST Spec PR Author 'mnltejaswini' REST Spec PR Last commit

mnltejaswini · 2019-05-16T21:37:48Z

Not sure why the SDK python failed. It complains INFO:swaggertosdk.autorest_tools: File "./scripts/multiapi_init_gen.py", line 22, in
INFO:swaggertosdk.autorest_tools: import azure.common
INFO:swaggertosdk.autorest_tools:ModuleNotFoundError: No module named 'azure'
INFO:swaggertosdk.autorest_tools:
INFO:swaggertosdk.autorest_tools:During handling of the above exception, another exception occurred:
INFO:swaggertosdk.autorest_tools:
INFO:swaggertosdk.autorest_tools:Traceback (most recent call last):
INFO:swaggertosdk.autorest_tools: File "./scripts/multiapi_init_gen.py", line 26, in
INFO:swaggertosdk.autorest_tools: import azure.common
INFO:swaggertosdk.autorest_tools:ModuleNotFoundError: No module named 'azure'
ERROR:swaggertosdk.autorest_tools:Command 'python ./scripts/multiapi_init_gen.py azure-mgmt-containerregistry' returned non-zero exit status 1.

kpajdzik · 2019-05-17T15:44:54Z

Not sure why the SDK python failed. It complains INFO:swaggertosdk.autorest_tools: File "./scripts/multiapi_init_gen.py", line 22, in
INFO:swaggertosdk.autorest_tools: import azure.common
INFO:swaggertosdk.autorest_tools:ModuleNotFoundError: No module named 'azure'
INFO:swaggertosdk.autorest_tools:
INFO:swaggertosdk.autorest_tools:During handling of the above exception, another exception occurred:
INFO:swaggertosdk.autorest_tools:
INFO:swaggertosdk.autorest_tools:Traceback (most recent call last):
INFO:swaggertosdk.autorest_tools: File "./scripts/multiapi_init_gen.py", line 26, in
INFO:swaggertosdk.autorest_tools: import azure.common
INFO:swaggertosdk.autorest_tools:ModuleNotFoundError: No module named 'azure'
ERROR:swaggertosdk.autorest_tools:Command 'python ./scripts/multiapi_init_gen.py azure-mgmt-containerregistry' returned non-zero exit status 1.

I don't think you should be worried. @lmazuel to confirm.

mnltejaswini · 2019-05-17T16:03:32Z

@kpajdzik we have rolled out to the region where this feature will be enabled. If you reviewed it, it is good for merging.

kpajdzik · 2019-05-20T16:27:07Z

@sergey-shandar - this is ready to merge

sergey-shandar · 2019-05-20T17:18:46Z

@lmazuel could you have a look why Python is failing?

* .NET SDK Resource Provider:'ContainerRegistry' REST Spec PR 'Azure/azure-rest-api-specs#5543' REST Spec PR Author 'mnltejaswini' REST Spec PR Last commit * .NET SDK Resource Provider:'ContainerRegistry' REST Spec PR 'Azure/azure-rest-api-specs#5543' REST Spec PR Author 'mnltejaswini' REST Spec PR Last commit

…6161) * .NET SDK Resource Provider:'ContainerRegistry' REST Spec PR 'Azure/azure-rest-api-specs#5543' REST Spec PR Author 'mnltejaswini' REST Spec PR Last commit * .NET SDK Resource Provider:'ContainerRegistry' REST Spec PR 'Azure/azure-rest-api-specs#5543' REST Spec PR Author 'mnltejaswini' REST Spec PR Last commit

azuresdkci assigned kpajdzik Apr 3, 2019

azuresdkci requested a review from kpajdzik April 3, 2019 20:50

AutorestCI mentioned this pull request Apr 3, 2019

[AutoPR containerregistry/resource-manager] [Do not merge] Swagger and Examples for the new Scoped tokens feature of Azure Container registry Azure/azure-sdk-for-java#3294

Merged

adxsdknet added a commit to adxsdknet/azure-sdk-for-net that referenced this pull request Apr 3, 2019

.NET SDK Resource Provider:'ContainerRegistry'

5b99a0d

REST Spec PR 'Azure/azure-rest-api-specs#5543' REST Spec PR Author 'mnltejaswini' REST Spec PR Last commit

KrisBash added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Apr 4, 2019

adxsdknet added a commit to adxsdknet/azure-sdk-for-net that referenced this pull request Apr 4, 2019

.NET SDK Resource Provider:'ContainerRegistry'

17bd82e

REST Spec PR 'Azure/azure-rest-api-specs#5543' REST Spec PR Author 'mnltejaswini' REST Spec PR Last commit

kpajdzik reviewed Apr 6, 2019

View reviewed changes

...nager/Microsoft.ContainerRegistry/preview/2019-05-01-preview/containerregistry_scopemap.json Show resolved Hide resolved

kpajdzik reviewed Apr 8, 2019

View reviewed changes

...nager/Microsoft.ContainerRegistry/preview/2019-05-01-preview/containerregistry_scopemap.json Outdated Show resolved Hide resolved

kpajdzik reviewed Apr 8, 2019

View reviewed changes

...nager/Microsoft.ContainerRegistry/preview/2019-05-01-preview/containerregistry_scopemap.json Show resolved Hide resolved

KrisBash suggested changes Apr 9, 2019

View reviewed changes

mnltejaswini force-pushed the master branch from d6dad63 to 66064f8 Compare April 12, 2019 00:42

AutorestCI mentioned this pull request Apr 12, 2019

[AutoPR containerregistry/resource-manager] [Do not merge] Swagger and Examples for the new Scoped tokens feature of Azure Container registry Azure/azure-sdk-for-js#2200

Closed

kpajdzik reviewed Apr 12, 2019

View reviewed changes

...nager/Microsoft.ContainerRegistry/preview/2019-05-01-preview/containerregistry_scopemap.json Show resolved Hide resolved

AutorestCI mentioned this pull request Apr 12, 2019

[AutoPR containerregistry/resource-manager] [Do not merge] Swagger and Examples for the new Scoped tokens feature of Azure Container registry Azure/azure-sdk-for-js#2212

Closed

mnltejaswini added 7 commits May 3, 2019 18:26

Add APIs and Models to support scope map and tokens for ACR

0279786

Updated APIs and Models to support scope map and tokens for ACR

089175a

Add swagger, examples for the new scoped tokens feature of ACR

41dc5c1

Removed the scopemap and token APIs from stable GA version

9cd3eba

Addressed comments from ARM team

ddcca09

Added the PRoxy resource definition

dfd0249

Resolved merge conflicts, updated the model for the token to take cer…

3256b5c

…tificates

mnltejaswini force-pushed the master branch from f52b339 to 3256b5c Compare May 6, 2019 21:36

mnltejaswini added 2 commits May 6, 2019 15:04

Fix the build and validation errors

6f7a6a2

Fixed the SDK violation issues.

072ac9a

kpajdzik approved these changes May 6, 2019

View reviewed changes

adxsdknet added a commit to adxsdknet/azure-sdk-for-net that referenced this pull request May 7, 2019

.NET SDK Resource Provider:'ContainerRegistry'

0780621

REST Spec PR 'Azure/azure-rest-api-specs#5543' REST Spec PR Author 'mnltejaswini' REST Spec PR Last commit

dsgouda mentioned this pull request May 7, 2019

AutoPr-ContainerRegistry-mnltejaswini-REST Spec PrNumber 5543 Azure/azure-sdk-for-net#6161

Merged

Fixed a minor regular expression for token and scope map name

43f5c29

AutorestCI mentioned this pull request May 16, 2019

[AutoPR containerregistry/resource-manager] [Do not merge] Swagger and Examples for the new Scoped tokens feature of Azure Container registry Azure/azure-sdk-for-js#2956

Merged

adxsdknet added a commit to adxsdknet/azure-sdk-for-net that referenced this pull request May 16, 2019

.NET SDK Resource Provider:'ContainerRegistry'

a97223a

REST Spec PR 'Azure/azure-rest-api-specs#5543' REST Spec PR Author 'mnltejaswini' REST Spec PR Last commit

mnltejaswini changed the title ~~[Do not merge] Swagger and Examples for the new Scoped tokens feature of Azure Container registry~~ Swagger and Examples for the new Scoped tokens feature of Azure Container registry May 17, 2019

sergey-shandar merged commit f1b1a70 into Azure:master May 20, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Swagger and Examples for the new Scoped tokens feature of Azure Container registry #5543

Swagger and Examples for the new Scoped tokens feature of Azure Container registry #5543

mnltejaswini commented Apr 3, 2019

AutorestCI commented Apr 3, 2019 •

edited

Loading

AutorestCI commented Apr 3, 2019 •

edited

Loading

AutorestCI commented Apr 3, 2019 •

edited

Loading

AutorestCI commented Apr 3, 2019 •

edited

Loading

AutorestCI commented Apr 3, 2019 •

edited

Loading

azuresdkci commented Apr 3, 2019

adxsdknet commented Apr 3, 2019 •

edited

Loading

kpajdzik commented Apr 5, 2019

KrisBash left a comment

KrisBash Apr 9, 2019

mnltejaswini Apr 11, 2019

KrisBash Apr 9, 2019

mnltejaswini Apr 11, 2019

KrisBash Apr 9, 2019

mnltejaswini Apr 12, 2019

KrisBash Apr 9, 2019

mnltejaswini Apr 12, 2019

KrisBash Apr 9, 2019

mnltejaswini Apr 12, 2019

KrisBash Apr 9, 2019

mnltejaswini Apr 12, 2019

mnltejaswini Apr 12, 2019

KrisBash Apr 15, 2019

mnltejaswini commented Apr 12, 2019

mnltejaswini commented May 4, 2019

kpajdzik commented May 14, 2019

mnltejaswini commented May 16, 2019 •

edited

Loading

mnltejaswini commented May 16, 2019

kpajdzik commented May 17, 2019

mnltejaswini commented May 17, 2019

kpajdzik commented May 20, 2019

sergey-shandar commented May 20, 2019

Swagger and Examples for the new Scoped tokens feature of Azure Container registry #5543

Swagger and Examples for the new Scoped tokens feature of Azure Container registry #5543

Conversation

mnltejaswini commented Apr 3, 2019

Latest improvements:

Contribution checklist:

ARM API Review Checklist

Feature Description

AutorestCI commented Apr 3, 2019 • edited Loading

Automation for azure-sdk-for-go

AutorestCI commented Apr 3, 2019 • edited Loading

Automation for azure-sdk-for-python

AutorestCI commented Apr 3, 2019 • edited Loading

Automation for azure-sdk-for-ruby

AutorestCI commented Apr 3, 2019 • edited Loading

Automation for azure-sdk-for-js

AutorestCI commented Apr 3, 2019 • edited Loading

Automation for azure-sdk-for-java

azuresdkci commented Apr 3, 2019

adxsdknet commented Apr 3, 2019 • edited Loading

Automation for azure-sdk-for-net

kpajdzik commented Apr 5, 2019

KrisBash left a 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

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

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

mnltejaswini commented Apr 12, 2019

mnltejaswini commented May 4, 2019

kpajdzik commented May 14, 2019

mnltejaswini commented May 16, 2019 • edited Loading

mnltejaswini commented May 16, 2019

kpajdzik commented May 17, 2019

mnltejaswini commented May 17, 2019

kpajdzik commented May 20, 2019

sergey-shandar commented May 20, 2019

AutorestCI commented Apr 3, 2019 •

edited

Loading

AutorestCI commented Apr 3, 2019 •

edited

Loading

AutorestCI commented Apr 3, 2019 •

edited

Loading

AutorestCI commented Apr 3, 2019 •

edited

Loading

AutorestCI commented Apr 3, 2019 •

edited

Loading

adxsdknet commented Apr 3, 2019 •

edited

Loading

mnltejaswini commented May 16, 2019 •

edited

Loading