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] Review request for Microsoft.SqlVirtualMachine to add version preview/2022-07-01-preview #20209

Conversation

yareyes
Copy link
Member

@yareyes yareyes commented Aug 12, 2022

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

ARM API Information (Control Plane)

Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

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. By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

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 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 copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For 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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.

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

NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)

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

@openapi-workflow-bot
Copy link

Hi, @yareyes 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-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 12, 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
    sqlvm.json 2022-07-01-preview(bc2fc3c) 2022-02-01(main)
    sqlvm.json 2022-07-01-preview(bc2fc3c) 2022-02-01-preview(main)
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️⚠️LintDiff: 1 Warnings warning [Detail]
    compared tags (via openapi-validator v1.13.0) new version base version
    package-preview-2022-07 package-preview-2022-07(bc2fc3c) 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: enableAutomaticUpgrade
    Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L1720


    The following errors/warnings exist before current PR submission:

    Rule Message
    R4018 - OperationsApiResponseSchema The response schema of operations API '/providers/Microsoft.SqlVirtualMachine/operations' does not match the ARM specification. Please standardize the schema.
    Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L241
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L987
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L1227
    ⚠️ R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'availabilityGroupListeners' with immediate parent 'SqlVirtualMachineGroup', must have a list by immediate parent operation.
    Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L1184
    ⚠️ R3017 - GuidUsage Guid used in model definition 'ResourceIdentity' for property 'principalId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L1577
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: createDefaultAvailabilityGroupIfNotExist
    Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L1002
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enable
    Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L1748
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enable
    Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L1786
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableEncryption
    Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L1790
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: backupSystemDbs
    Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L1823
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enable
    Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L1892
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: sqlSystemDbOnDataDisk
    Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L1960
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enable
    Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L2000
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: runImmediately
    Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L2004
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isRServicesEnabled
    Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L2108
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isOptimizeForAdHocWorkloadsEnabled
    Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L2127
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isLpimEnabled
    Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L2141
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isIfiEnabled
    Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L2145
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: persistFolder
    Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L2198
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enable
    Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L2224
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️❌~[Staging] ServiceAPIReadinessTest: 2 Errors, 0 Warnings failed [Detail]
    Rule Message
    RUNTIME_ERROR "errorCode: AssertionError,
    errorMessage: ResourceType 'sqlVirtualMachineGroups' should be deployed in 'West Central US' on apiVersion '2022-07-01'.: expected [ Array(10) ] to satisfy [Function]"
    RUNTIME_ERROR "errorCode: AssertionError,
    errorMessage: ResourceType 'sqlVirtualMachineGroups' should be deployed in 'West Central US' on apiVersion '2022-07-01'.: expected [ Array(10) ] to satisfy [Function]"
    ️️✔️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 succeeded [Detail] [Expand]
    Validation passes for SDKTrack2Validation

    • The following tags are being changed in this PR
      • "https://github.com/Azure/azure-rest-api-specs/blob/bc2fc3c154ad12a7950ed99510428fcd89167ea5/specification/sqlvirtualmachine/resource-manager/readme.md#tag-package-preview-2022-07">sqlvirtualmachine/resource-manager/readme.md#package-preview-2022-07
    ️️✔️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

    openapi-pipeline-app bot commented Aug 12, 2022

    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-go - armsqlvirtualmachine - 0.7.0
    azure-sdk-for-python-track2 - track2_azure-mgmt-sqlvirtualmachine - 1.0.0b3
    -	Client name is changed
    -	Model AdditionalFeaturesServerConfigurations no longer has parameter is_rservices_enabled
    -	Operation AvailabilityGroupListenersOperations.get has a new parameter expand
    -	Operation AvailabilityGroupListenersOperations.get has a new parameter kwargs
    -	Operation AvailabilityGroupListenersOperations.list_by_group has a new parameter kwargs
    -	Operation Operations.list has a new parameter kwargs
    -	Operation SqlVirtualMachineGroupsOperations.get has a new parameter kwargs
    -	Operation SqlVirtualMachineGroupsOperations.list has a new parameter kwargs
    -	Operation SqlVirtualMachineGroupsOperations.list_by_resource_group has a new parameter kwargs
    -	Operation SqlVirtualMachinesOperations.get has a new parameter kwargs
    -	Operation SqlVirtualMachinesOperations.list has a new parameter kwargs
    -	Operation SqlVirtualMachinesOperations.list_by_resource_group has a new parameter kwargs
    -	Operation SqlVirtualMachinesOperations.list_by_sql_vm_group has a new parameter kwargs
    -	Removed operation AvailabilityGroupListenersOperations.create_or_update
    -	Removed operation AvailabilityGroupListenersOperations.delete
    -	Removed operation SqlVirtualMachineGroupsOperations.create_or_update
    -	Removed operation SqlVirtualMachineGroupsOperations.delete
    -	Removed operation SqlVirtualMachineGroupsOperations.update
    -	Removed operation SqlVirtualMachinesOperations.create_or_update
    -	Removed operation SqlVirtualMachinesOperations.delete
    -	Removed operation SqlVirtualMachinesOperations.update
    ️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 2614c50. SDK Automation 14.0.0
      command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
      warn	File azure-sdk-for-net_tmp/initOutput.json not found to read
      command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
    • ️✔️Azure.ResourceManager.SqlVirtualMachine [View full logs]  [Release SDK Changes]
      info	[Changelog]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 2614c50. 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] WARN config global `--global`, `--local` are deprecated. Use `--location=global` instead.
    • ️✔️track2_azure-mgmt-sqlvirtualmachine [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog]   - Model AvailabilityGroupListener has a new parameter multi_subnet_ip_configurations
      info	[Changelog]   - Model SQLInstanceSettings has a new parameter is_ifi_enabled
      info	[Changelog]   - Model SQLInstanceSettings has a new parameter is_lpim_enabled
      info	[Changelog]   - Model SQLTempDbSettings has a new parameter persist_folder
      info	[Changelog]   - Model SQLTempDbSettings has a new parameter persist_folder_path
      info	[Changelog]   - Model SqlVirtualMachine has a new parameter enable_automatic_upgrade
      info	[Changelog]   - Model SqlVirtualMachine has a new parameter least_privilege_mode
      info	[Changelog]   - Model SqlVirtualMachine has a new parameter wsfc_static_ip
      info	[Changelog]   - Model WsfcDomainProfile has a new parameter cluster_subnet_type
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 2614c50. 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
    • ️✔️armsqlvirtualmachine [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New const `ClusterSubnetTypeMultiSubnet`
      info	[Changelog] - New const `ClusterSubnetTypeSingleSubnet`
      info	[Changelog] - New const `LeastPrivilegeModeEnabled`
      info	[Changelog] - New function `PossibleClusterSubnetTypeValues() []ClusterSubnetType`
      info	[Changelog] - New function `PossibleLeastPrivilegeModeValues() []LeastPrivilegeMode`
      info	[Changelog] - New struct `MultiSubnetIPConfiguration`
      info	[Changelog] - New field `ClusterSubnetType` in struct `WsfcDomainProfile`
      info	[Changelog] - New field `PersistFolderPath` in struct `SQLTempDbSettings`
      info	[Changelog] - New field `PersistFolder` in struct `SQLTempDbSettings`
      info	[Changelog] - New field `WsfcStaticIP` in struct `Properties`
      info	[Changelog] - New field `EnableAutomaticUpgrade` in struct `Properties`
      info	[Changelog] - New field `LeastPrivilegeMode` in struct `Properties`
      info	[Changelog] - New field `MultiSubnetIPConfigurations` in struct `AvailabilityGroupListenerProperties`
      info	[Changelog] - New field `IsIfiEnabled` in struct `SQLInstanceSettings`
      info	[Changelog] - New field `IsLpimEnabled` in struct `SQLInstanceSettings`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 12 additive change(s).
    ️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 2614c50. Schema Automation 14.0.0
      command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
      cmderr	[initScript.sh] WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
      cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
      cmderr	[initScript.sh] npm WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
      cmderr	[initScript.sh] npm WARN old lockfile
      warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
      command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
    • ️✔️sqlvirtualmachine [View full logs]  [Release Schema Changes]
    ️️✔️ azure-powershell succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 2614c50. 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.SqlVirtualMachine [View full logs]  [Release SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 12, 2022

    Generated ApiView

    Language Package Name ApiView Link
    Python track2_azure-mgmt-sqlvirtualmachine https://apiview.dev/Assemblies/Review/f7f3461a381e49dbbdcbe0ddd92e9fe0
    .Net Azure.ResourceManager.SqlVirtualMachine Create ApiView failed. Please ask PR assignee for help
    Java azure-resourcemanager-sqlvirtualmachine Create ApiView failed. Please ask PR assignee for help

    @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 Aug 12, 2022
    @openapi-workflow-bot
    Copy link

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

    @NetRock NetRock added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Aug 16, 2022
    @openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Aug 16, 2022
    @yareyes
    Copy link
    Member Author

    yareyes commented Aug 16, 2022

    @xiaoxuqi-ms we got ARM approval, can we please merge this PR?

    ghost pushed a commit to Azure/azure-resource-manager-schemas that referenced this pull request Aug 17, 2022
    @yareyes yareyes deleted the dev-sqlvirtualmachine-Microsoft.SqlVirtualMachine-2022-07-01-preview branch November 15, 2022 20:22
    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 resource-manager
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    3 participants