Adding AAD based security principal for PublicPreview #13345

syhamza · 2021-03-09T17:27:00Z

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

Changelog

Please ensure to add changelog with this PR by answering the following questions.

What's the purpose of the update?
- new service onboarding
- new API version
- update existing version for new feature
- update existing version to fix swagger quality issue in s360
- Other, please clarify
When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
- SDK of .NET (need service team to ensure code readiness)
- SDK of Python
- SDK of Java
- SDK of Js
- SDK of Go
- PowerShell
- CLI
- Terraform
- No, no need to refresh for updates in this PR

Contribution checklist:

I commit to follow the Breaking Change Policy of "no breaking changes"
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
- Adding new API(s)
- Adding a new API version
- Adding a new service
Please ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
[] If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the Breaking Change Policy.

Removing API(s) in stable version
Removing properties in stable version
Removing API version(s) in stable version
Updating API in stable or public preview version with Breaking Change Validation errors
Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.

Please follow the link to find more details on PR review process.

openapi-workflow-bot · 2021-03-09T17:27:02Z

Hi, @syhamza Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com

openapi-pipeline-app · 2021-03-09T17:27:04Z

Swagger Validation Report

️❌BreakingChange: 5 Errors, 0 Warnings failed [Detail]

Compared Swaggers (Based on Oad v0.8.7)
- original: preview/2020-12-01-preview/confidentialledger.json <---> new: preview/2020-12-01-preview/confidentialledger.json

Rule	Message
`❌` 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'certUsers' renamed or removed? New: Microsoft.ConfidentialLedger/preview/2020-12-01-preview/confidentialledger.json#L562:7 Old: Microsoft.ConfidentialLedger/preview/2020-12-01-preview/confidentialledger.json#L529:7
`❌` 1041 - AddedPropertyInResponse	The new version has a new property 'aadBasedSecurityPrincipals' in response that was not found in the old version. New: Microsoft.ConfidentialLedger/preview/2020-12-01-preview/confidentialledger.json#L562:7 Old: Microsoft.ConfidentialLedger/preview/2020-12-01-preview/confidentialledger.json#L529:7
`❌` 1041 - AddedPropertyInResponse	The new version has a new property 'certBasedSecurityPrincipals' in response that was not found in the old version. New: Microsoft.ConfidentialLedger/preview/2020-12-01-preview/confidentialledger.json#L562:7 Old: Microsoft.ConfidentialLedger/preview/2020-12-01-preview/confidentialledger.json#L529:7
`❌` 1045 - AddedOptionalProperty	The new version has a new optional property 'aadBasedSecurityPrincipals' that was not found in the old version. New: Microsoft.ConfidentialLedger/preview/2020-12-01-preview/confidentialledger.json#L562:7 Old: Microsoft.ConfidentialLedger/preview/2020-12-01-preview/confidentialledger.json#L529:7
`❌` 1045 - AddedOptionalProperty	The new version has a new optional property 'certBasedSecurityPrincipals' that was not found in the old version. New: Microsoft.ConfidentialLedger/preview/2020-12-01-preview/confidentialledger.json#L562:7 Old: Microsoft.ConfidentialLedger/preview/2020-12-01-preview/confidentialledger.json#L529:7

️⚠️LintDiff: 2 Warnings warning [Detail]

Linted configuring files (Based on source branch, openapi-validator v1.9.0 , classic-openapi-validator v1.1.6 )
- confidentialledger/resource-manager/readme.md tag:package-2020-12-01-preview
Linted configuring files (Based on target branch, openapi-validator v1.9.0 , classic-openapi-validator v1.1.6 )
- confidentialledger/resource-manager/readme.md tag:package-2020-12-01-preview

Rule	Message
⚠️ R4021 - DescriptionAndTitleMissing	'ledgerRoleName' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.ConfidentialLedger/preview/2020-12-01-preview/confidentialledger.json#L536
⚠️ R4021 - DescriptionAndTitleMissing	'ledgerRoleName' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.ConfidentialLedger/preview/2020-12-01-preview/confidentialledger.json#L553

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️⚠️[Staging] SDK Track2 Validation: 4 Warnings warning [Detail]

The following tags are being changed in this PR

confidentialledger/resource-manager/readme.md#package-2020-12-01-preview

Rule	Message
⚠️ PreCheck/SchemaMissingType	"readme":"confidentialledger/resource-manager/readme.md", "tag":"package-2020-12-01-preview", "details":"The schema 'ErrorDetail' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
⚠️ PreCheck/SchemaMissingType	"readme":"confidentialledger/resource-manager/readme.md", "tag":"package-2020-12-01-preview", "details":"The schema 'ErrorResponse' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
⚠️ PreCheck/SchemaMissingType	"readme":"confidentialledger/resource-manager/readme.md", "tag":"package-2020-12-01-preview", "details":"The schema 'ErrorAdditionalInfo' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
⚠️ PreCheck/CheckDuplicateSchemas	"readme":"confidentialledger/resource-manager/readme.md", "tag":"package-2020-12-01-preview", "details":"Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail."

️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]

Validation passes for PrettierCheck.

️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2021-03-09T17:27:04Z

Swagger Generation Artifacts

️⚠️ azure-sdk-for-js warning [Detail]

⚠️Warning [Logs]Release - Generate from 3a823d7. SDK Automation 14.0.0

warn	Skip initScript due to not configured
command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.4.4 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/confidentialledger/resource-manager/readme.md
warn	No file changes detected after generation
warn	No package detected after generation

️⚠️ azure-sdk-for-python warning [Detail]

⚠️Warning [Logs]Release - Generate from 3a823d7. SDK Automation 14.0.0

command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json

️✔️azure-mgmt-confidentialledger [View full logs] [Release SDK Changes]
- azure-mgmt-confidentialledger-0.0.1.zip
- azure_mgmt_confidentialledger-0.0.1-py2.py3-none-any.whl
```
info	[Changelog]   - Initial Release
```

️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 3a823d7. SDK Automation 14.0.0

warn	Skip initScript due to not configured
command	sudo apt-get install -y dotnet-sdk-5.0
command	autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/confidentialledger/resource-manager/readme.md
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
warn	No package detected after generation

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 3a823d7. SDK Automation 14.0.0

command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	go run ./tools/generator/main.go ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

️✔️preview/confidentialledger/mgmt/2020-12-01-preview/confidentialledger [View full logs] [Release SDK Changes]
```
info	[Changelog] This is a new package
```

️⚠️ azure-sdk-for-java warning [Detail]

⚠️Warning [Logs]Release - Generate from 3a823d7. SDK Automation 14.0.0

command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
cmderr	[generate.py] 2021-03-16 05:11:26 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-confidentialledger"
cmderr	[generate.py] 2021-03-16 05:11:26 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
cmderr	[generate.py] 2021-03-16 05:11:26 INFO autorest --version=3.1.3 --use=@autorest/java@4.0.20 --java.azure-libraries-for-java-folder=/home/vsts/work/1/s/azure-sdk-for-java --java.output-folder=/home/vsts/work/1/s/azure-sdk-for-java/sdk/confidentialledger/azure-resourcemanager-confidentialledger --java.namespace=com.azure.resourcemanager.confidentialledger   --java --pipeline.modelerfour.additional-checks=false --pipeline.modelerfour.lenient-model-deduplication=true --azure-arm --verbose --sdk-integration --fluent=lite --java.fluent=lite --java.license-header=MICROSOFT_MIT_SMALL ../azure-rest-api-specs/specification/confidentialledger/resource-manager/readme.md
cmderr	[generate.py] 2021-03-16 05:11:59 INFO [CI][Success] Write to ci.yml
cmderr	[generate.py] 2021-03-16 05:11:59 INFO [POM][Process] dealing with pom.xml
cmderr	[generate.py] 2021-03-16 05:11:59 INFO [POM][Skip] pom already has module azure-resourcemanager-confidentialledger
cmderr	[generate.py] 2021-03-16 05:11:59 INFO [POM][Success] Write to pom.xml
cmderr	[generate.py] 2021-03-16 05:11:59 INFO [POM][Process] dealing with root pom
cmderr	[generate.py] 2021-03-16 05:11:59 INFO [POM][Success] Write to root pom

️✔️azure-resourcemanager-confidentialledger [View full logs] [Release SDK Changes]

cmderr	[Inst] 2021-03-16 05:15:01 DEBUG Got artifact_id: azure-resourcemanager-confidentialledger
cmderr	[Inst] 2021-03-16 05:15:01 DEBUG Got artifact: pom.xml
cmderr	[Inst] 2021-03-16 05:15:01 DEBUG Got artifact: azure-resourcemanager-confidentialledger-1.0.0-beta.1-sources.jar
cmderr	[Inst] 2021-03-16 05:15:01 DEBUG Got artifact: azure-resourcemanager-confidentialledger-1.0.0-beta.1.jar
cmderr	[Inst] 2021-03-16 05:15:01 DEBUG Match jar package: azure-resourcemanager-confidentialledger-1.0.0-beta.1.jar
cmderr	[Inst] 2021-03-16 05:15:01 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/13345/azure-sdk-for-java/azure-resourcemanager-confidentialledger/azure-resourcemanager-confidentialledger-1.0.0-beta.1.jar\" -o azure-resourcemanager-confidentialledger-1.0.0-beta.1.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-confidentialledger -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-confidentialledger-1.0.0-beta.1.jar -Dpackaging=jar -DgeneratePom=true
```"}

️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account.

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-workflow-bot · 2021-03-09T17:29:47Z

Hi @syhamza, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff.

Task	How to fix	Priority	Support (Microsoft alias)
Avocado	Fix-Avocado	High	ruowan
Semantic validation	Fix-SemanticValidation-Error	High	raychen, jianyxi
Model validation	Fix-ModelValidation-Error	High	raychen,jianyxi
LintDiff	Fix-LintDiff	high	jianyxi, ruoxuan

If you need further help, please feedback via swagger feedback."

openapi-workflow-bot · 2021-03-09T17:31:10Z

Hi @syhamza, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review.
Action: To initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
If you want to know the production traffic statistic, please see ARM Traffic statistic.
If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.

...urce-manager/Microsoft.ConfidentialLedger/preview/2020-12-01-preview/confidentialledger.json

...rosoft.ConfidentialLedger/preview/2020-12-01-preview/examples/ConfidentialLedger_Create.json

...Microsoft.ConfidentialLedger/preview/2020-12-01-preview/examples/ConfidentialLedger_Get.json

erich-wang · 2021-03-15T02:03:31Z

Please fix CI errors and follow comment posted by @openapi-workflow-bot

…_confidential-ledger_preview_with_aad_security_principal

openapi-workflow-bot · 2021-03-15T02:40:29Z

NewApiVersionRequired reason:

A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

syhamza · 2021-03-15T06:32:49Z

@erich-wang, the RP for this API spec hasn't been rolled out to Prod yet so we won't be breaking any customers. Please merge this change so that we can start testing it out in EDog and start the Prod rollout process.

* Adding AAD based security principal for PublicPreview * addressing comments * addressing comments * fixing roleName field * fixing minor prettier issue * fixing examples * running prettier check

Adding AAD based security principal for PublicPreview

9f4d470

openapi-assignment-bot bot assigned erich-wang Mar 9, 2021

openapi-pipeline-app bot added the CI-FixRequiredOnFailure label Mar 9, 2021

openapi-pipeline-app bot added the BreakingChangeReviewRequired label Mar 9, 2021

openapi-pipeline-app bot removed the CI-FixRequiredOnFailure label Mar 9, 2021

openapi-sdkautomation bot mentioned this pull request Mar 9, 2021

[AutoPR azure-mgmt-confidentialledger] Adding AAD based security principal for PublicPreview AzureSDKAutomation/azure-sdk-for-python#4556

Closed

openapi-pipeline-app bot added the CI-BreakingChange-Python label Mar 9, 2021

openapi-sdkautomation bot mentioned this pull request Mar 9, 2021

[AutoPR azure-resourcemanager-confidentialledger] Adding AAD based security principal for PublicPreview AzureSDKAutomation/azure-sdk-for-java#7778

Closed

lynshi reviewed Mar 9, 2021

View reviewed changes

addressing comments

bddcffc

openapi-pipeline-app bot added CI-FixRequiredOnFailure and removed CI-FixRequiredOnFailure labels Mar 9, 2021

sidmore reviewed Mar 9, 2021

View reviewed changes

...rosoft.ConfidentialLedger/preview/2020-12-01-preview/examples/ConfidentialLedger_Create.json Show resolved Hide resolved

sidmore reviewed Mar 9, 2021

View reviewed changes

...rosoft.ConfidentialLedger/preview/2020-12-01-preview/examples/ConfidentialLedger_Create.json Show resolved Hide resolved

sidmore reviewed Mar 9, 2021

View reviewed changes

...Microsoft.ConfidentialLedger/preview/2020-12-01-preview/examples/ConfidentialLedger_Get.json Show resolved Hide resolved

addressing comments

5ad1e9b

openapi-pipeline-app bot added CI-FixRequiredOnFailure and removed CI-FixRequiredOnFailure labels Mar 10, 2021

fixing roleName field

5781cad

openapi-pipeline-app bot added CI-FixRequiredOnFailure and removed CI-FixRequiredOnFailure labels Mar 10, 2021

syhamza added 2 commits March 14, 2021 19:23

Merge remote-tracking branch 'origin/master' into syhamza/task/update…

65a70ca

…_confidential-ledger_preview_with_aad_security_principal

fixing minor prettier issue

89bc9a4

openapi-pipeline-app bot added the CI-FixRequiredOnFailure label Mar 15, 2021

openapi-pipeline-app bot added NewApiVersionRequired and removed CI-FixRequiredOnFailure labels Mar 15, 2021

syhamza added 2 commits March 14, 2021 19:42

fixing examples

0d58d44

running prettier check

9c5af92

PhoenixHe-NV added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Mar 16, 2021

PhoenixHe-NV self-assigned this Mar 16, 2021

PhoenixHe-NV approved these changes Mar 16, 2021

View reviewed changes

PhoenixHe-NV merged commit 3a823d7 into master Mar 16, 2021

JackTn deleted the syhamza/task/update_confidential-ledger_preview_with_aad_security_principal branch August 17, 2021 06:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding AAD based security principal for PublicPreview #13345

Adding AAD based security principal for PublicPreview #13345

syhamza commented Mar 9, 2021

openapi-workflow-bot bot commented Mar 9, 2021

openapi-pipeline-app bot commented Mar 9, 2021 •

edited

Loading

openapi-pipeline-app bot commented Mar 9, 2021 •

edited

Loading

openapi-workflow-bot bot commented Mar 9, 2021

openapi-workflow-bot bot commented Mar 9, 2021

erich-wang commented Mar 15, 2021

openapi-workflow-bot bot commented Mar 15, 2021

syhamza commented Mar 15, 2021

Adding AAD based security principal for PublicPreview #13345

Adding AAD based security principal for PublicPreview #13345

Conversation

syhamza commented Mar 9, 2021

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Mar 9, 2021

openapi-pipeline-app bot commented Mar 9, 2021 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Mar 9, 2021 • edited Loading

Swagger Generation Artifacts

openapi-workflow-bot bot commented Mar 9, 2021

openapi-workflow-bot bot commented Mar 9, 2021

erich-wang commented Mar 15, 2021

openapi-workflow-bot bot commented Mar 15, 2021

syhamza commented Mar 15, 2021

openapi-pipeline-app bot commented Mar 9, 2021 •

edited

Loading

openapi-pipeline-app bot commented Mar 9, 2021 •

edited

Loading