Skip to content

Merging new API version from private repro https://github.com/Azure/azure-rest-api-specs-pr/blob/RPSaaSMaster/specification/connectedvmware/resource-manager/Microsoft.ConnectedVMwarevSphere/preview/2022-01-10-preview#19637

Merged
chunyu3 merged 3 commits intomainfrom
dev/siddhsingh/connectedvmware-new-public-api-version
Jul 6, 2022

Conversation

@sidsinghms
Copy link
Copy Markdown
Contributor

@sidsinghms sidsinghms commented Jun 30, 2022

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

The new api version is copied as it is from the pr repo, This api version is already ARM reviewed in that repo.

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.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  4. If updating an existing version, please select the specific language 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 appy to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.
  • 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.

@openapi-workflow-bot
Copy link
Copy Markdown

Hi, @sidsinghms 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. vscswagger@microsoft.com

    @openapi-workflow-bot openapi-workflow-bot Bot added ARMReview WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jun 30, 2022
    @openapi-workflow-bot
    Copy link
    Copy Markdown

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

    @openapi-pipeline-app
    Copy link
    Copy Markdown

    openapi-pipeline-app Bot commented Jun 30, 2022

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
    There are no breaking changes.
    compared swaggers (via Oad v0.9.6)] new version base version
    connectedvmware.json 2022-01-10(e3ada85) 2020-10-01(main)
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️⚠️LintDiff: 8 Warnings warning [Detail]
    compared tags (via openapi-validator v1.13.0) new version base version
    package-2022-01-10-preview package-2022-01-10-preview(e3ada85) default(main)

    The following errors/warnings are introduced by current PR:

    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: retain
    Location: Microsoft.ConnectedVMwarevSphere/preview/2022-01-10-preview/connectedvmware.json#L2055
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: allowExtensionOperations
    Location: Microsoft.ConnectedVMwarevSphere/preview/2022-01-10-preview/connectedvmware.json#L4526
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: secureBootEnabled
    Location: Microsoft.ConnectedVMwarevSphere/preview/2022-01-10-preview/connectedvmware.json#L4824
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableAutomaticUpgrade
    Location: Microsoft.ConnectedVMwarevSphere/preview/2022-01-10-preview/connectedvmware.json#L6652
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableAutomaticUpgrade
    Location: Microsoft.ConnectedVMwarevSphere/preview/2022-01-10-preview/connectedvmware.json#L6704
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: rebootPending
    Location: Microsoft.ConnectedVMwarevSphere/preview/2022-01-10-preview/connectedvmware.json#L6961
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: excludeKbsRequiringReboot
    Location: Microsoft.ConnectedVMwarevSphere/preview/2022-01-10-preview/connectedvmware.json#L7166
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: maintenanceWindowExceeded
    Location: Microsoft.ConnectedVMwarevSphere/preview/2022-01-10-preview/connectedvmware.json#L7255


    The following errors/warnings exist before current PR submission:

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

    Rule Message
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.ConnectedVMwarevSphere/preview/2022-01-10-preview/connectedvmware.json#L4065
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.ConnectedVMwarevSphere/preview/2022-01-10-preview/connectedvmware.json#L4261
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.ConnectedVMwarevSphere/preview/2022-01-10-preview/connectedvmware.json#L4643
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.ConnectedVMwarevSphere/preview/2022-01-10-preview/connectedvmware.json#L4656
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.ConnectedVMwarevSphere/preview/2022-01-10-preview/connectedvmware.json#L4725
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.ConnectedVMwarevSphere/preview/2022-01-10-preview/connectedvmware.json#L4732
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.ConnectedVMwarevSphere/preview/2022-01-10-preview/connectedvmware.json#L4746
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.ConnectedVMwarevSphere/preview/2022-01-10-preview/connectedvmware.json#L4789
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.ConnectedVMwarevSphere/preview/2022-01-10-preview/connectedvmware.json#L4945
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.ConnectedVMwarevSphere/preview/2022-01-10-preview/connectedvmware.json#L5158
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.ConnectedVMwarevSphere/preview/2022-01-10-preview/connectedvmware.json#L5166
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.ConnectedVMwarevSphere/preview/2022-01-10-preview/connectedvmware.json#L5194
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.ConnectedVMwarevSphere/preview/2022-01-10-preview/connectedvmware.json#L5235
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.ConnectedVMwarevSphere/preview/2022-01-10-preview/connectedvmware.json#L5375
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.ConnectedVMwarevSphere/preview/2022-01-10-preview/connectedvmware.json#L5499
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.ConnectedVMwarevSphere/preview/2022-01-10-preview/connectedvmware.json#L5724
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.ConnectedVMwarevSphere/preview/2022-01-10-preview/connectedvmware.json#L6050
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.ConnectedVMwarevSphere/preview/2022-01-10-preview/connectedvmware.json#L6076
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.ConnectedVMwarevSphere/preview/2022-01-10-preview/connectedvmware.json#L6133
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.ConnectedVMwarevSphere/preview/2022-01-10-preview/connectedvmware.json#L6170
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.ConnectedVMwarevSphere/preview/2022-01-10-preview/connectedvmware.json#L6922
    ⚠️ R2063 - OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'HybridIdentityMetadataModel'. Consider using the plural form of 'HybridIdentityMetadata' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.ConnectedVMwarevSphere/preview/2022-01-10-preview/connectedvmware.json#L3213
    ⚠️ R2063 - OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'HybridIdentityMetadataModel'. Consider using the plural form of 'HybridIdentityMetadata' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.ConnectedVMwarevSphere/preview/2022-01-10-preview/connectedvmware.json#L3279
    ⚠️ R2063 - OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'HybridIdentityMetadataModel'. Consider using the plural form of 'HybridIdentityMetadata' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.ConnectedVMwarevSphere/preview/2022-01-10-preview/connectedvmware.json#L3334
    ⚠️ R2063 - OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'HybridIdentityMetadataModel'. Consider using the plural form of 'HybridIdentityMetadata' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.ConnectedVMwarevSphere/preview/2022-01-10-preview/connectedvmware.json#L3391
    ⚠️ R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'hybridIdentityMetadata' with immediate parent 'VirtualMachine', must have a list by immediate parent operation.
    Location: Microsoft.ConnectedVMwarevSphere/preview/2022-01-10-preview/connectedvmware.json#L6491
    ⚠️ R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'extensions' with immediate parent 'VirtualMachine', must have a list by immediate parent operation.
    Location: Microsoft.ConnectedVMwarevSphere/preview/2022-01-10-preview/connectedvmware.json#L6571
    ⚠️ R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'guestAgents' with immediate parent 'VirtualMachine', must have a list by immediate parent operation.
    Location: Microsoft.ConnectedVMwarevSphere/preview/2022-01-10-preview/connectedvmware.json#L6865
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: force
    Location: Microsoft.ConnectedVMwarevSphere/preview/2022-01-10-preview/connectedvmware.json#L408
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: force
    Location: Microsoft.ConnectedVMwarevSphere/preview/2022-01-10-preview/connectedvmware.json#L734
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️PoliCheck succeeded [Detail] [Expand]
    Validation passed for PoliCheck.
    ️⚠️SDK Track2 Validation: 1 Warnings warning [Detail]
    The following errors/warnings are introduced by current PR:
    Rule Message
    ⚠️ IgnoredPropertyNextToRef "readme":"connectedvmware/resource-manager/readme.md",
    "tag":"package-2022-01-10-preview",
    "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > GuestAgentProperties > properties > provisioningAction)\n keys: [ \u001b[32m'type'\u001b[39m ]"
    💬 "readme":"connectedvmware/resource-manager/readme.md",
    "tag":"package-2022-01-10-preview",
    "details":"AutoRest core version selected from configuration: ^3.2.0."
    💬 "readme":"connectedvmware/resource-manager/readme.md",
    "tag":"package-2022-01-10-preview",
    "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.11.0 -> 1.11.0)"
    💬 "readme":"connectedvmware/resource-manager/readme.md",
    "tag":"package-2022-01-10-preview",
    "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.11.0->1.11.0)"
    💬 "readme":"connectedvmware/resource-manager/readme.md",
    "tag":"package-2022-01-10-preview",
    "details":"> Installing AutoRest extension '@autorest/modelerfour' (4.21.4 -> 4.21.4)"
    💬 "readme":"connectedvmware/resource-manager/readme.md",
    "tag":"package-2022-01-10-preview",
    "details":"> Installed AutoRest extension '@autorest/modelerfour' (4.21.4->4.21.4)"
    💬 "readme":"connectedvmware/resource-manager/readme.md",
    "tag":"package-2022-01-10-preview",
    "details":"Autorest completed in 15.4s. 0 files generated."
    ️️✔️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).
    ️️✔️CadlValidation succeeded [Detail] [Expand]
    Validation passes for CadlValidation.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link
    Copy Markdown

    openapi-pipeline-app Bot commented Jun 30, 2022

    Swagger Generation Artifacts

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

    Breaking Changes Tracking

    ️✔️azure-sdk-for-go - armconnectedvmware - 0.1.0
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from bab2f43. 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
      cmderr	[automation_generate.sh]  config global `--global`, `--local` are deprecated. Use `--location=global` instead.
      cmderr	[automation_generate.sh] npm notice
      cmderr	[automation_generate.sh] npm notice New minor version of npm available! 8.11.0 -> 8.13.2
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.13.2>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@8.13.2` to update!
      cmderr	[automation_generate.sh] npm notice
      warn	No file changes detected after generation
      warn	No package detected after generation
    ️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from bab2f43. SDK Automation 14.0.0
      command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️armconnectedvmware [View full logs]  [Release SDK Changes]
      info	[Changelog] This is a new package
      info	[Changelog]
    ️⚠️ azure-sdk-for-js warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from bab2f43. SDK Automation 14.0.0
      command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
      cmderr	[automation_init.sh]  read-package-tree@5.1.6: The functionality that this package provided is now in @npmcli/arborist
      cmderr	[automation_init.sh] npm WARN deprecated uuid@3.4.0: Please upgrade  to version 7 or higher.  Older versions may use Math.random() in certain circumstances, which is known to be problematic.  See https://v8.dev/blog/math-random for details.
      cmderr	[automation_init.sh]  @opentelemetry/types@0.2.0: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
      cmderr	[automation_init.sh] deprecated @azure/storage-blob@10.5.0: This version has been deprecated, please upgrade to the version tagged as latest
      cmderr	[automation_init.sh]  @octokit/plugin-request-log@1.0.4 requires a peer of @octokit/core@>=3 but none is installed. You must install peer dependencies yourself.
      warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
      command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
      warn	No file changes detected after generation
      warn	No package detected after generation
    ️️✔️ azure-powershell succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from bab2f43. SDK Automation 14.0.0
      command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
      command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
    • ️✔️Az.ArcVMwareServiceApi [View full logs]  [Release SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link
    Copy Markdown

    Hi @sidsinghms, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic validationFix-SemanticValidation-ErrorHigh
    Model validationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffhigh
    If you need further help, please feedback via swagger feedback.

    @openapi-workflow-bot
    Copy link
    Copy Markdown

    Hi @sidsinghms, 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.
    Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.

    @subbartt subbartt changed the title New public api version for connectedvmware Merging new API version from private repro Jul 4, 2022
    @subbartt subbartt changed the title Merging new API version from private repro Merging new API version from private repro https://github.com/Azure/azure-rest-api-specs-pr/blob/RPSaaSMaster/specification/connectedvmware/resource-manager/Microsoft.ConnectedVMwarevSphere/preview/2022-01-10-preview Jul 4, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Labels

    ARMReview 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.

    5 participants