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

adding az cli command generation #14623

Merged
merged 8 commits into from
Jul 8, 2021
Merged

adding az cli command generation #14623

merged 8 commits into from
Jul 8, 2021

Conversation

aegal
Copy link
Contributor

@aegal aegal commented Jun 1, 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.
    This is just merging the CLI readme, the CLI has already been generated.
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
    It is already published
  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
    • Ensure to copy the existing version into new directory structure for first commit (including refactoring) and then push new changes including version updates in separate commits. This is required to review the changes efficiently.
    • 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.

@aegal aegal requested review from jsntcy and qiaozha as code owners June 1, 2021 20:13
@openapi-workflow-bot
Copy link

Hi, @aegal 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 Jun 1, 2021

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️LintDiff succeeded [Detail] [Expand]
    Validation passes for LintDiff.
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
    Validation passes for SDKTrack2Validation
    ️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
    Validation passes for Lint(RPaaS).
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    [Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks.

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jun 1, 2021

    Swagger Generation Artifacts

    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
    ️❌[Staging] SDK Breaking Change Tracking failed [Detail]

    Breaking Changes Tracking

    azure-sdk-for-go - delegatednetwork/mgmt/2021-03-15/delegatednetwork - v55.2.0
    +	Function `OrchestratorInstanceServiceClient.DeletePreparer` parameter(s) have been changed from `(context.Context, string, string)` to `(context.Context, string, string, *bool)`
    +	Function `OrchestratorInstanceServiceClient.Delete` parameter(s) have been changed from `(context.Context, string, string)` to `(context.Context, string, string, *bool)`
    azure-sdk-for-go - preview/delegatednetwork/mgmt/2020-08-08-preview/delegatednetwork - v55.2.0
    +	Field `Properties` of struct `Operation` has been removed
    +	Function `DelegatedSubnetServiceClient.DeleteDetailsPreparer` parameter(s) have been changed from `(context.Context, string, string)` to `(context.Context, string, string, *bool)`
    +	Function `DelegatedSubnetServiceClient.DeleteDetails` parameter(s) have been changed from `(context.Context, string, string)` to `(context.Context, string, string, *bool)`
    +	Function `ErrorDefinition.MarshalJSON` has been removed
    +	Struct `ControllerDetailsModel` has been removed
    +	Struct `ErrorDefinition` has been removed
    +	Type of `DelegatedSubnetProperties.ControllerDetails` has been changed from `*ControllerDetailsModel` to `*ControllerDetails`
    +	Type of `ErrorResponse.Error` has been changed from `*ErrorDefinition` to `*ErrorDetail`
    +	Type of `Operation.Origin` has been changed from `*string` to `Origin`
    ️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-dnc - first release
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 43976e1. 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/dnc/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
    • ️✔️Microsoft.Azure.Management.DelegatedNetwork [View full logs]  [Release SDK Changes]
      warn	Skip artifact folder because it doesn't exist: artifacts/packages
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 43976e1. 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
    • ️✔️track2_azure-mgmt-dnc [View full logs]  [Release SDK Changes]
      info	[Changelog]   - Initial Release
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 43976e1. 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-07-08 08:04:38 INFO [VERSION][Found] current version "com.azure.resourcemanager:azure-resourcemanager-delegatednetwork;1.0.0-beta.1;1.0.0-beta.2"
      cmderr	[generate.py] 2021-07-08 08:04:38 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.2"
      cmderr	[generate.py] 2021-07-08 08:04:38 INFO autorest --version=3.1.3 --use=@autorest/java@4.0.32 --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/delegatednetwork/azure-resourcemanager-delegatednetwork --java.namespace=com.azure.resourcemanager.delegatednetwork   --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/dnc/resource-manager/readme.md
      cmderr	[generate.py] 2021-07-08 08:05:12 INFO [CI][Skip] ci.yml already has module azure-resourcemanager-delegatednetwork
      cmderr	[generate.py] 2021-07-08 08:05:12 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2021-07-08 08:05:12 INFO [POM][Skip] pom already has module azure-resourcemanager-delegatednetwork
      cmderr	[generate.py] 2021-07-08 08:05:12 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2021-07-08 08:05:12 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2021-07-08 08:05:12 INFO [POM][Skip] pom already has module sdk/delegatednetwork
      cmderr	[generate.py] 2021-07-08 08:05:12 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-delegatednetwork [View full logs]  [Release SDK Changes]
      cmderr	[Inst] 2021-07-08 08:06:48 DEBUG Got artifact_id: azure-resourcemanager-delegatednetwork
      cmderr	[Inst] 2021-07-08 08:06:48 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-07-08 08:06:48 DEBUG Got artifact: azure-resourcemanager-delegatednetwork-1.0.0-beta.2-sources.jar
      cmderr	[Inst] 2021-07-08 08:06:48 DEBUG Got artifact: azure-resourcemanager-delegatednetwork-1.0.0-beta.2-javadoc.jar
      cmderr	[Inst] 2021-07-08 08:06:48 DEBUG Got artifact: azure-resourcemanager-delegatednetwork-1.0.0-beta.2.jar
      cmderr	[Inst] 2021-07-08 08:06:48 DEBUG Match jar package: azure-resourcemanager-delegatednetwork-1.0.0-beta.2.jar
      cmderr	[Inst] 2021-07-08 08:06:48 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/14623/azure-sdk-for-java/azure-resourcemanager-delegatednetwork/azure-resourcemanager-delegatednetwork-1.0.0-beta.2.jar\" -o azure-resourcemanager-delegatednetwork-1.0.0-beta.2.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-delegatednetwork -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-delegatednetwork-1.0.0-beta.2.jar -Dpackaging=jar -DgeneratePom=true
      ```"}
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 43976e1. SDK Automation 14.0.0
      command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	generator automation ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️delegatednetwork/mgmt/2021-03-15/delegatednetwork [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Function `OrchestratorInstanceServiceClient.Delete` parameter(s) have been changed from `(context.Context, string, string)` to `(context.Context, string, string, *bool)`
      info	[Changelog] - Function `OrchestratorInstanceServiceClient.DeletePreparer` parameter(s) have been changed from `(context.Context, string, string)` to `(context.Context, string, string, *bool)`
      info	[Changelog]
      info	[Changelog] ### New Content
      info	[Changelog]
      info	[Changelog]
      info	[Changelog] Total 2 breaking change(s), 0 additive change(s).
      info	[Changelog]
    • ️✔️preview/delegatednetwork/mgmt/2020-08-08-preview/delegatednetwork [View full logsBreaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Function `DelegatedSubnetServiceClient.DeleteDetailsPreparer` parameter(s) have been changed from `(context.Context, string, string)` to `(context.Context, string, string, *bool)`
      info	[Changelog] - Function `DelegatedSubnetServiceClient.DeleteDetails` parameter(s) have been changed from `(context.Context, string, string)` to `(context.Context, string, string, *bool)`
      info	[Changelog] - Type of `ErrorResponse.Error` has been changed from `*ErrorDefinition` to `*ErrorDetail`
      info	[Changelog] - Type of `DelegatedSubnetProperties.ControllerDetails` has been changed from `*ControllerDetailsModel` to `*ControllerDetails`
      info	[Changelog] - Type of `Operation.Origin` has been changed from `*string` to `Origin`
      info	[Changelog] - Function `ErrorDefinition.MarshalJSON` has been removed
      info	[Changelog] - Struct `ControllerDetailsModel` has been removed
      info	[Changelog] - Struct `ErrorDefinition` has been removed
      info	[Changelog] - Field `Properties` of struct `Operation` has been removed
      info	[Changelog]
      info	[Changelog] ### New Content
      info	[Changelog]
      info	[Changelog] - New const `System`
      info	[Changelog] - New const `Internal`
      info	[Changelog] - New const `User`
      info	[Changelog] - New const `Usersystem`
      info	[Changelog] - New function `ErrorDetail.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New function `PossibleOriginValues() []Origin`
      info	[Changelog] - New function `ErrorAdditionalInfo.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New function `PossibleActionTypeValues() []ActionType`
      info	[Changelog] - New struct `ErrorAdditionalInfo`
      info	[Changelog] - New struct `ErrorDetail`
      info	[Changelog] - New field `ActionType` in struct `Operation`
      info	[Changelog]
      info	[Changelog] Total 11 breaking change(s), 13 additive change(s).
      info	[Changelog]
    ️⚠️ azure-sdk-for-js warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 43976e1. 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.7.0 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/dnc/resource-manager/readme.md
      warn	No file changes detected after generation
      warn	No package detected after generation
    Posted by Swagger Pipeline | How to fix these errors?

    @aegal
    Copy link
    Contributor Author

    aegal commented Jun 3, 2021

    @jianyexi I see this is flagged for a breaking change in the go sdk, I don't see how that is the case since this doesn't change that path

    @jianyexi
    Copy link
    Contributor

    jianyexi commented Jun 6, 2021

    @jianyexi Jianye Xi FTE I see this is flagged for a breaking change in the go sdk, I don't see how that is the case since this doesn't change that path

    As you marked it as 'readonly' which means it only occurs in the response ,so it would be removed from the client request

    @aegal
    Copy link
    Contributor Author

    aegal commented Jun 14, 2021

    @jianyexi Jianye Xi FTE I see this is flagged for a breaking change in the go sdk, I don't see how that is the case since this doesn't change that path

    As you marked it as 'readonly' which means it only occurs in the response ,so it would be removed from the client request

    Hi @jianyexi - I removed this readonly and I still see that test not succeeding, I'm not sure why that is the case

    @@ -388,6 +388,7 @@
    ],
    "properties": {
    "properties": {
    "x-ms-client-flatten": true,
    Copy link
    Member

    Choose a reason for hiding this comment

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

    hold on this change

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

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

    removed

    @aegal aegal requested a review from tamilmani1989 June 15, 2021 19:22
    Copy link
    Member

    @tamilmani1989 tamilmani1989 left a comment

    Choose a reason for hiding this comment

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

    lgtm

    @aegal
    Copy link
    Contributor Author

    aegal commented Jun 17, 2021

    @jianyexi - can you please merge this P.R?

    @chiragg4u
    Copy link
    Contributor

    ARM API review is not required for this PR, please follow the process given @ https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/212/Swagger-PR-Review

    @aegal
    Copy link
    Contributor Author

    aegal commented Jun 18, 2021

    @jianyexi , @qiaozha, @jsntcy - who can help get this P.R merged, its been sitting for days. Is there anything else required from my side?

    @ghost
    Copy link

    ghost commented Jul 4, 2021

    Hi, @aegal. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

    @ghost ghost added the no-recent-activity label Jul 4, 2021
    @jianyexi jianyexi merged commit 43976e1 into Azure:master Jul 8, 2021
    @ghost ghost removed the no-recent-activity label Jul 8, 2021
    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    * adding az cli command generation
    
    * reverting x-ms-client-flatten for delegated subnet
    
    * address feedback from cli team
    
    * pushing another change
    
    * remove readonly flag
    
    * remove flatten flag
    
    Co-authored-by: Ali Egal <alegal@microsoft.com>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    4 participants