Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PIM API Specs #12526

Merged
merged 9 commits into from
Jan 26, 2021
Merged

PIM API Specs #12526

merged 9 commits into from
Jan 26, 2021

Conversation

amanswaika
Copy link
Contributor

@amanswaika amanswaika commented Jan 20, 2021

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.

  1. 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
  2. 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.
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
  4. 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:

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 API 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 version with Breaking Change Validation errors
  • Updating API(s) in preview over 1 year

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
Copy link

Hi, @amanswaika 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
    Copy link

    openapi-pipeline-app bot commented Jan 20, 2021

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️⚠️LintDiff: 14 Warnings warning [Detail] Only 10 items are listed, please refer to log for more details.

    Rule Message
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isOrganizationDefault
    New: Microsoft.Authorization/preview/2020-10-01-preview/RoleManagementPolicy.json#L246
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isApprovalRequired
    New: Microsoft.Authorization/preview/2020-10-01-preview/RoleManagementPolicy.json#L368
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isApprovalRequiredForExtension
    New: Microsoft.Authorization/preview/2020-10-01-preview/RoleManagementPolicy.json#L372
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isRequestorJustificationRequired
    New: Microsoft.Authorization/preview/2020-10-01-preview/RoleManagementPolicy.json#L376
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isApproverJustificationRequired
    New: Microsoft.Authorization/preview/2020-10-01-preview/RoleManagementPolicy.json#L412
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isEscalationEnabled
    New: Microsoft.Authorization/preview/2020-10-01-preview/RoleManagementPolicy.json#L428
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isBackup
    New: Microsoft.Authorization/preview/2020-10-01-preview/RoleManagementPolicy.json#L453
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isBackup
    New: Microsoft.Authorization/preview/2020-10-01-preview/RoleManagementPolicy.json#L490
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isEnabled
    New: Microsoft.Authorization/preview/2020-10-01-preview/RoleManagementPolicy.json#L517
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isExpirationRequired
    New: Microsoft.Authorization/preview/2020-10-01-preview/RoleManagementPolicy.json#L578
    ️️✔️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.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jan 20, 2021

    Swagger Generation Artifacts

    ️🔄 azure-sdk-for-net inProgress [Detail]
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 9022265. 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/authorization/resource-manager/readme.md
    • ️✔️@azure/arm-authorization [View full logs]  [Release SDK Changes]
      cmderr	[npmPack] loaded rollup.config.js with warnings
      cmderr	[npmPack] (!) Unused external imports
      cmderr	[npmPack] default imported from external module 'rollup' but never used
      cmderr	[npmPack] ./esm/authorizationManagementClient.js → ./dist/arm-authorization.js...
      cmderr	[npmPack] created ./dist/arm-authorization.js in 175ms
    ️️✔️ azure-resource-manager-schemas succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 9022265. Schema Automation 14.0.0
      warn	Skip initScript due to not configured
      command	npx n 12
      command	autorest --use=@autorest/azureresourceschema@3.0.92 --version=3.0.6351 --azureresourceschema --multiapi --title=none --pass-thru:subset-reducer --azureresourceschema-folder=/home/vsts/work/1/s/azure-resource-manager-schemas/azure-resource-manager-schemas ../../azure-rest-api-specs/specification/authorization/resource-manager/readme.md
      cmdout	[Autorest] WARNING: Skipping path '/{roleId}': Unable to locate '/providers/' segment
      cmdout	[Autorest] WARNING: Skipping path '/{roleId}': Unable to locate '/providers/' segment
      cmdout	[Autorest] WARNING: Skipping path '/{roleId}': Unable to locate '/providers/' segment
      cmdout	[Autorest] WARNING: Skipping path '/{roleAssignmentId}': Unable to locate '/providers/' segment
      cmdout	[Autorest] WARNING: Skipping path '/{roleAssignmentId}': Unable to locate '/providers/' segment
    • ️✔️authorization [View full logs]  [Release Schema Changes]
      cmderr	[resource-manager] node-pre-gyp
      cmderr	[resource-manager] WARN Using request for node-pre-gyp https download
      cmderr	[resource-manager]  template-schema-validation-tools@1.0.0 No repository field.
      cmderr	[resource-manager]  optional SKIPPING OPTIONAL DEPENDENCY: fsevents@2.1.3 (node_modules/fsevents):
      cmderr	[resource-manager] npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for fsevents@2.1.3: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})
    ️⚠️ azure-sdk-for-python warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 9022265. 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] Ignoring mock: markers 'python_version <= "2.7"' don't match your environment
      cmderr	[automation_init.sh]   Failed building wheel for ConfigArgParse
      cmderr	[automation_init.sh]   Failed building wheel for yarl
      cmderr	[automation_init.sh]   Failed building wheel for wrapt
      cmderr	[automation_init.sh]   Failed building wheel for multidict
      cmderr	[automation_init.sh] Cannot uninstall requirement azure-nspkg, not installed
      cmderr	[automation_init.sh] Command '['/home/vsts/work/1/s/azure-sdk-for-python_tmp/venv-sdk/bin/python', '-m', 'pip', 'uninstall', '-y', 'azure-nspkg']' returned non-zero exit status 1.
      command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
    • ️✔️azure-mgmt-authorization [View full logs]  [Release SDK Changes]
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model RoleAssignment has a new parameter delegated_managed_identity_resource_id
      info	[Changelog]   - Model RoleAssignment has a new parameter created_by
      info	[Changelog]   - Model RoleAssignment has a new parameter updated_on
      info	[Changelog]   - Model RoleAssignment has a new parameter updated_by
      info	[Changelog]   - Model RoleAssignment has a new parameter created_on
      info	[Changelog]   - Added operation group AccessReviewScheduleDefinitionsOperations
      info	[Changelog]   - Added operation group AccessReviewInstanceMyDecisionsOperations
      info	[Changelog]   - Added operation group AccessReviewInstanceDecisionsOperations
      info	[Changelog]   - Added operation group AccessReviewInstanceOperations
      info	[Changelog]   - Added operation group AccessReviewInstancesOperations
      info	[Changelog]   - Added operation group AccessReviewInstancesAssignedForMyApprovalOperations
      info	[Changelog]   - Added operation group Operations
      info	[Changelog]   - Added operation group AccessReviewScheduleDefinitionsAssignedForMyApprovalOperations
      info	[Changelog]   - Added operation group AccessReviewDefaultSettingsOperations
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 9022265. 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-01-26 02:07:10 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-authorization-generated"
      cmderr	[generate.py] 2021-01-26 02:07:10 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
      cmderr	[generate.py] 2021-01-26 02:07:10 INFO autorest --version=3.0.6350 --use=@autorest/java@4.0.11 --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/authorization/azure-resourcemanager-authorization-generated --java.namespace=com.azure.resourcemanager.authorization.generated   --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/authorization/resource-manager/readme.md
      cmderr	[generate.py] 2021-01-26 02:07:53 INFO [CI][Success] Write to ci.yml
      cmderr	[generate.py] 2021-01-26 02:07:53 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2021-01-26 02:07:53 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2021-01-26 02:07:53 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2021-01-26 02:07:53 INFO [POM][Skip] pom already has module sdk/authorization
      cmderr	[generate.py] 2021-01-26 02:07:53 INFO [POM][Success] Write to root pom
      cmderr	[generate.py] WARNING: An illegal reflective access operation has occurred
      cmderr	[generate.py] WARNING: Illegal reflective access by org.codehaus.groovy.reflection.ReflectionUtils (file:/home/vsts/.m2/repository/org/codehaus/groovy/groovy/3.0.0-beta-2/groovy-3.0.0-beta-2-indy.jar) to method java.util.Collections$UnmodifiableCollection.toString()
      cmderr	[generate.py] WARNING: Please consider reporting this to the maintainers of org.codehaus.groovy.reflection.ReflectionUtils
      cmderr	[generate.py] WARNING: Use --illegal-access=warn to enable warnings of further illegal reflective access operations
      cmderr	[generate.py] WARNING: All illegal access operations will be denied in a future release
    • ️✔️azure-resourcemanager-authorization-generated [View full logs]  [Release SDK Changes]
      cmderr	[Inst] 2021-01-26 02:11:04 DEBUG Got artifact_id: azure-resourcemanager-authorization-generated
      cmderr	[Inst] 2021-01-26 02:11:04 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-01-26 02:11:04 DEBUG Got artifact: azure-resourcemanager-authorization-generated-1.0.0-beta.1-sources.jar
      cmderr	[Inst] 2021-01-26 02:11:04 DEBUG Got artifact: azure-resourcemanager-authorization-generated-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-01-26 02:11:04 DEBUG Match jar package: azure-resourcemanager-authorization-generated-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-01-26 02:11:04 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/12526/azure-sdk-for-java/azure-resourcemanager-authorization-generated/azure-resourcemanager-authorization-generated-1.0.0-beta.1.jar\" -o azure-resourcemanager-authorization-generated-1.0.0-beta.1.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-authorization-generated -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-authorization-generated-1.0.0-beta.1.jar -Dpackaging=jar -DgeneratePom=true
      ```"}
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 9022265. 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
    • ️✔️authorization/mgmt/2015-07-01/authorization [View full logs]  [Release SDK Changes]
      info	[Changelog] No exported changes
    • ️✔️preview/authorization/mgmt/2020-04-01-preview/authorization [View full logs]  [Release SDK Changes]
      info	[Changelog] No exported changes
    • ️✔️preview/authorization/mgmt/2018-09-01-preview/authorization [View full logs]  [Release SDK Changes]
      info	[Changelog] No exported changes
    • ️✔️preview/authorization/mgmt/2018-07-01-preview/authorization [View full logs]  [Release SDK Changes]
      info	[Changelog] No exported changes
    • ️✔️preview/authorization/mgmt/2018-01-01-preview/authorization [View full logs]  [Release SDK Changes]
      info	[Changelog] No exported changes
    • ️✔️preview/authorization/mgmt/2017-10-01-preview/authorization [View full logs]  [Release SDK Changes]
      info	[Changelog] No exported changes
    ️️✔️[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
    Copy link

    Hi, @amanswaika your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). cc @yungezz

    @openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jan 20, 2021
    @amanswaika
    Copy link
    Contributor Author

    Link to the approved private repo PR - https://github.com/Azure/azure-rest-api-specs-pr/pull/2049/

    @openapi-workflow-bot
    Copy link

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

    TaskHow to fixPrioritySupport (Microsoft alias)
    AvocadoFix-AvocadoHighruowan
    Semantic validationFix-SemanticValidation-ErrorHighraychen, jianyxi
    Model validationFix-ModelValidation-ErrorHighraychen,jianyxi
    LintDiffFix-LintDiffhighjianyxi, ruoxuan
    If you need further help, please feedback via swagger feedback."

    @zhenglaizhang
    Copy link
    Contributor

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 2 pipeline(s).

    @pilor pilor self-requested a review January 25, 2021 21:14
    @pilor pilor 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 Jan 25, 2021
    Copy link
    Contributor

    @pilor pilor left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Only a change in resource type name from an approved private PR

    @zhenglaizhang zhenglaizhang merged commit 9022265 into Azure:master Jan 26, 2021
    This was referenced Jan 26, 2021
    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    * PIM API Specs
    
    * update readme
    
    * Update
    
    * Update readme
    
    * operation id fix
    
    * name fix
    
    * Name changes
    
    * fix
    
    * Fix
    
    Co-authored-by: Aman Swaika <amansw@microsoft.com>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    4 participants