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

[Hub Generated] Public private branch 'ikanni/2021-04-30-preview_new' #16681

Conversation

ikanni
Copy link
Contributor

@ikanni ikanni commented Nov 5, 2021

This is a PR generated at OpenAPI Hub. You can view your work branch via this link.

Changelog

Add a changelog entry for 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 are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month. => Nov 2021
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month. => Nov 2021
  4. If updating an existing version, please select the specific langauge SDKs and CLIs that must be refreshed after the 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 refresh required 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

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

  • Change to data plane APIs
  • Adding new properties
  • All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

  • Check this box if any of the following apply to the PR so that label “WaitForARMFeedback” will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits.
  • 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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in a stable version
  • Removing properties in a stable version
  • Removing API version(s) in a stable version
  • Updating API in a 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.

@ikanni
Copy link
Contributor Author

ikanni commented Nov 5, 2021

The PR is created based on the updates in the private branch. The updates in the PR has already been reviewed and approved with this PR Azure/azure-rest-api-specs-pr/4266

@openapi-workflow-bot
Copy link

Hi, @ikanni 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-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 Nov 5, 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.
    ️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️❌Cross-Version Breaking Changes: 28 Errors, 14 Warnings failed [Detail]
    The following breaking changes are detected by comparison with latest preview version:

    Only 30 items are listed, please refer to log for more details.

    Rule Message
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automanage/accounts/{accountName}' removed or restructured?
    Old: Microsoft.Automanage/preview/2020-06-30-preview/automanage.json#L30:5
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automanage/accounts' removed or restructured?
    Old: Microsoft.Automanage/preview/2020-06-30-preview/automanage.json#L259:5
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.Automanage/accounts' removed or restructured?
    Old: Microsoft.Automanage/preview/2020-06-30-preview/automanage.json#L307:5
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automanage/configurationProfilePreferences/{configurationProfilePreferenceName}' removed or restructured?
    Old: Microsoft.Automanage/preview/2020-06-30-preview/automanage.json#L623:5
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automanage/configurationProfilePreferences' removed or restructured?
    Old: Microsoft.Automanage/preview/2020-06-30-preview/automanage.json#L852:5
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.Automanage/configurationProfilePreferences' removed or restructured?
    Old: Microsoft.Automanage/preview/2020-06-30-preview/automanage.json#L900:5
    1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'Account' removed or renamed?
    New: Microsoft.Automanage/preview/2021-04-30-preview/automanage.json#L1288:3
    Old: Microsoft.Automanage/preview/2020-06-30-preview/automanage.json#L988:3
    1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'AccountUpdate' removed or renamed?
    New: Microsoft.Automanage/preview/2021-04-30-preview/automanage.json#L1288:3
    Old: Microsoft.Automanage/preview/2020-06-30-preview/automanage.json#L988:3
    1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'AccountIdentity' removed or renamed?
    New: Microsoft.Automanage/preview/2021-04-30-preview/automanage.json#L1288:3
    Old: Microsoft.Automanage/preview/2020-06-30-preview/automanage.json#L988:3
    1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'ConfigurationProfileAssignmentCompliance' removed or renamed?
    New: Microsoft.Automanage/preview/2021-04-30-preview/automanage.json#L1288:3
    Old: Microsoft.Automanage/preview/2020-06-30-preview/automanage.json#L988:3
    1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'ConfigurationProfilePreference' removed or renamed?
    New: Microsoft.Automanage/preview/2021-04-30-preview/automanage.json#L1288:3
    Old: Microsoft.Automanage/preview/2020-06-30-preview/automanage.json#L988:3
    1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'ConfigurationProfilePreferenceUpdate' removed or renamed?
    New: Microsoft.Automanage/preview/2021-04-30-preview/automanage.json#L1288:3
    Old: Microsoft.Automanage/preview/2020-06-30-preview/automanage.json#L988:3
    1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'ConfigurationProfilePreferenceProperties' removed or renamed?
    New: Microsoft.Automanage/preview/2021-04-30-preview/automanage.json#L1288:3
    Old: Microsoft.Automanage/preview/2020-06-30-preview/automanage.json#L988:3
    1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'ConfigurationProfilePreferenceVmBackup' removed or renamed?
    New: Microsoft.Automanage/preview/2021-04-30-preview/automanage.json#L1288:3
    Old: Microsoft.Automanage/preview/2020-06-30-preview/automanage.json#L988:3
    1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'ConfigurationProfilePreferenceAntiMalware' removed or renamed?
    New: Microsoft.Automanage/preview/2021-04-30-preview/automanage.json#L1288:3
    Old: Microsoft.Automanage/preview/2020-06-30-preview/automanage.json#L988:3
    1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: common-types/resource-management/v2/types.json#L354:9
    Old: Microsoft.Automanage/preview/2020-06-30-preview/automanage.json#L1294:9
    1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: common-types/resource-management/v2/types.json#L359:9
    Old: Microsoft.Automanage/preview/2020-06-30-preview/automanage.json#L1298:9
    1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: common-types/resource-management/v2/types.json#L368:13
    Old: Microsoft.Automanage/preview/2020-06-30-preview/automanage.json#L1304:13
    1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: common-types/resource-management/v2/types.json#L373:13
    Old: Microsoft.Automanage/preview/2020-06-30-preview/automanage.json#L1308:13
    1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: common-types/resource-management/v2/types.json#L378:13
    Old: Microsoft.Automanage/preview/2020-06-30-preview/automanage.json#L1312:13
    1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: common-types/resource-management/v2/types.json#L383:13
    Old: Microsoft.Automanage/preview/2020-06-30-preview/automanage.json#L1316:13
    1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: common-types/resource-management/v2/types.json#L422:9
    Old: Microsoft.Automanage/preview/2020-06-30-preview/automanage.json#L1337:9
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'accountId' renamed or removed?
    New: Microsoft.Automanage/preview/2021-04-30-preview/automanage.json#L1452:7
    Old: Microsoft.Automanage/preview/2020-06-30-preview/automanage.json#L1084:7
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'configurationProfilePreferenceId' renamed or removed?
    New: Microsoft.Automanage/preview/2021-04-30-preview/automanage.json#L1452:7
    Old: Microsoft.Automanage/preview/2020-06-30-preview/automanage.json#L1084:7
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'provisioningState' renamed or removed?
    New: Microsoft.Automanage/preview/2021-04-30-preview/automanage.json#L1452:7
    Old: Microsoft.Automanage/preview/2020-06-30-preview/automanage.json#L1084:7
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'compliance' renamed or removed?
    New: Microsoft.Automanage/preview/2021-04-30-preview/automanage.json#L1452:7
    Old: Microsoft.Automanage/preview/2020-06-30-preview/automanage.json#L1084:7
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'properties' renamed or removed?
    New: common-types/resource-management/v2/types.json#L353:7
    Old: Microsoft.Automanage/preview/2020-06-30-preview/automanage.json#L1293:7
    1044 - XmsLongRunningOperationChanged The new version has a different 'x-ms-longrunning-operation' value than the previous one.
    New: Microsoft.Automanage/preview/2021-04-30-preview/automanage.json#L855:7
    Old: Microsoft.Automanage/preview/2020-06-30-preview/automanage.json#L353:7
    ⚠️ 1026 - TypeChanged The new version has a different type 'object' than the previous one ''.
    New: Microsoft.Automanage/preview/2021-04-30-preview/automanage.json#L878:13
    Old: Microsoft.Automanage/preview/2020-06-30-preview/automanage.json#L376:13
    ⚠️ 1026 - TypeChanged The new version has a different type 'object' than the previous one ''.
    New: Microsoft.Automanage/preview/2021-04-30-preview/automanage.json#L1432:9
    Old: Microsoft.Automanage/preview/2020-06-30-preview/automanage.json#L1070:9
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
    Validation passes for SDKTrack2Validation

    ️️✔️PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
    Validation passes for Lint(RPaaS).
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Nov 5, 2021

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️❌SDK Breaking Change Tracking failed [Detail]

    Breaking Changes Tracking

    azure-sdk-for-python-track2 - track2_azure-mgmt-automanage - Approved - 1.0.0b2
    +	Model ConfigurationProfileAssignmentProperties no longer has parameter provisioning_status
    ️✔️azure-sdk-for-go - preview/automanage/mgmt/2020-06-30-preview/automanage - v59.1.0
    ️❌ azure-sdk-for-net failed [Detail]
    • Failed [Logs]Release - Generate from 5c9696d. 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/automanage/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.Automanage [View full logs]  [Release SDK Changes]
      cmdout	[msbuild] /home/vsts/work/1/s/azure-sdk-for-net/sdk/automanage/Microsoft.Azure.Management.Automanage/tests/ScenarioTests/ConfigurationProfilesAssignmentsTests.cs(70,17): error CS1739: The best overload for 'ConfigurationProfileAssignmentProperties' does not have a parameter named 'provisioningStatus' [/home/vsts/work/1/s/azure-sdk-for-net/sdk/automanage/Microsoft.Azure.Management.Automanage/tests/Microsoft.Azure.Management.Automanage.Tests.csproj]
      cmdout	[msbuild]      3>/home/vsts/work/1/s/azure-sdk-for-net/sdk/automanage/Microsoft.Azure.Management.Automanage/tests/ScenarioTests/ConfigurationProfilesAssignmentsTests.cs(76,17): error CS1739: The best overload for 'ConfigurationProfileAssignment' does not have a parameter named 'location' [/home/vsts/work/1/s/azure-sdk-for-net/sdk/automanage/Microsoft.Azure.Management.Automanage/tests/Microsoft.Azure.Management.Automanage.Tests.csproj]
      cmdout	[msbuild]          /home/vsts/work/1/s/azure-sdk-for-net/sdk/automanage/Microsoft.Azure.Management.Automanage/tests/ScenarioTests/ConfigurationProfilesAssignmentsTests.cs(70,17): error CS1739: The best overload for 'ConfigurationProfileAssignmentProperties' does not have a parameter named 'provisioningStatus' [/home/vsts/work/1/s/azure-sdk-for-net/sdk/automanage/Microsoft.Azure.Management.Automanage/tests/Microsoft.Azure.Management.Automanage.Tests.csproj]
      cmdout	[msbuild]          /home/vsts/work/1/s/azure-sdk-for-net/sdk/automanage/Microsoft.Azure.Management.Automanage/tests/ScenarioTests/ConfigurationProfilesAssignmentsTests.cs(76,17): error CS1739: The best overload for 'ConfigurationProfileAssignment' does not have a parameter named 'location' [/home/vsts/work/1/s/azure-sdk-for-net/sdk/automanage/Microsoft.Azure.Management.Automanage/tests/Microsoft.Azure.Management.Automanage.Tests.csproj]
      error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-net]: dotnet
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 5c9696d. 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-automanage [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model ConfigurationProfileAssignmentProperties has a new parameter provisioning_state
      info	[Changelog]
      info	[Changelog] **Breaking changes**
      info	[Changelog]
      info	[Changelog]   - Model ConfigurationProfileAssignmentProperties no longer has parameter provisioning_status
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 5c9696d. SDK Automation 14.0.0
      command	sh ./eng/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
    • ️✔️preview/automanage/mgmt/2020-06-30-preview/automanage [View full logs]  [Release SDK Changes]
      info	[Changelog] No exported changes
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 5c9696d. 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/automanage/resource-manager/readme.md
    • ️✔️@azure/arm-automanage [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/automanageClient.js → ./dist/arm-automanage.js...
      cmderr	[npmPack] created ./dist/arm-automanage.js in 248ms
    Posted by Swagger Pipeline | How to fix these errors?

    @ikanni
    Copy link
    Contributor Author

    ikanni commented Nov 5, 2021

    @chunyu3 I need your help in merging the above swagger. Please note the above PR was created based on the updates in the private branch.

    Questions:
    Do we need to fix any error mentioned above before merging?
    We have the breaking change approval in the private branch PR. Do we need to get any other approval?

    @chunyu3
    Copy link
    Member

    chunyu3 commented Nov 8, 2021

    @chunyu3 I need your help in merging the above swagger. Please note the above PR was created based on the updates in the private branch.

    Questions: Do we need to fix any error mentioned above before merging? We have the breaking change approval in the private branch PR. Do we need to get any other approval?

    hi @ikanni The 'cross version breaking changes' which is compared to latest preview version, so it need 'breaking change' review and acquire approve. Even it is approved in private branch, it still need to acquired the approval here. Please acquire the 'breaking changes' approval. thanks.

    @openapi-workflow-bot
    Copy link

    Hi @ikanni, 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.

    @JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Nov 8, 2021
    @chunyu3 chunyu3 self-requested a review November 9, 2021 01:57
    @chunyu3 chunyu3 merged commit 5c9696d into main Nov 9, 2021
    LeiWang3 pushed a commit to LeiWang3/azure-rest-api-specs that referenced this pull request Mar 31, 2022
    …Azure#16681)
    
    * Copy the existing version 2020-06-30-preview as new version 2020-06-30-preview
    
    * [Automanage]Added new version 2021-04-30-preview
    
    * Fixed Hassan's commnet
    
    * Updated one example
    
    * Added report for Michele
    
    * Pushing for Michele
    
    * Pushing changes for Michele
    
    * Pushing changes for Michele
    
    * Pushing changes for Michele
    
    * Pushing changes for Michele
    
    * Pushing changes for Michele
    
    * Pushing changes for Michele
    
    * Fixed comments
    
    * Fixed comments
    @JackTn JackTn deleted the published/Azure/azure-rest-api-specs-pr/ikanni/2021-04-30-preview_new branch June 16, 2022 00:51
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 Approved-SdkBreakingChange-Python
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    4 participants