{Compute} Bump version for azure-mgmt-compute package#26882
{Compute} Bump version for azure-mgmt-compute package#26882
Conversation
…ion_test_70752
️✔️AzureCLI-FullTest
|
️✔️AzureCLI-BreakingChangeTest
|
|
Compute |
…ion_test_70752
…ion_test_70752
|
The reason of changing some custom functions from positional to keyword-only arguments is due to a breaking change of Python SDK since 29.2.0b2, e.g., https://github.com/Azure/azure-sdk-for-python/blob/azure-mgmt-compute_30.0.0/sdk/compute/azure-mgmt-compute/azure/mgmt/compute/v2023_03_01/operations/_operations.py#L6997 |
| vm_shared_gallery_image_version = CliCommandType( | ||
| operations_tmpl='azure.mgmt.compute.operations._shared_gallery_image_versions_operations#SharedGalleryImageVers' | ||
| 'ionsOperations.{}', | ||
| operations_tmpl='azure.mgmt.compute.operations#SharedGalleryImageVersionsOperations.{}', |
There was a problem hiding this comment.
Does the SDK also break the operation path?
There was a problem hiding this comment.
| image show: | ||
| parameters: | ||
| expand: | ||
| rule_exclusions: | ||
| - missing_parameter_help | ||
| ppg update: | ||
| parameters: | ||
| include_colocation_status: | ||
| rule_exclusions: | ||
| - missing_parameter_help | ||
| restore-point collection wait: | ||
| parameters: | ||
| expand: | ||
| rule_exclusions: | ||
| - missing_parameter_help | ||
| restore-point wait: | ||
| parameters: | ||
| expand: | ||
| rule_exclusions: | ||
| - missing_parameter_help | ||
| sig image-version wait: | ||
| parameters: | ||
| expand: | ||
| rule_exclusions: | ||
| - missing_parameter_help |
There was a problem hiding this comment.
These are all existing parameters, why these linter issues haven't they been scanned and detected before?
There was a problem hiding this comment.
Additionally, I can see the help message for these parameters through -h
There was a problem hiding this comment.
Hi @msyyc, we noticed that the comment of some params are changed from ":param" to ":keyword" (e.g., https://github.com/Azure/azure-sdk-for-python/blob/azure-mgmt-compute_29.1.0/sdk/compute/azure-mgmt-compute/azure/mgmt/compute/v2022_11_01/operations/_virtual_machines_operations.py#L1662 and https://github.com/Azure/azure-sdk-for-python/blob/azure-mgmt-compute_30.0.0/sdk/compute/azure-mgmt-compute/azure/mgmt/compute/v2022_11_01/operations/_operations.py#L15734).
Since our CLI would read the SDK function params and apply the comments of SDK as the help message for some params, this change would bring a breaking change to our CLI.
May I ask why do you make this change? Is it possible to keep it consistent with the previous one?
There was a problem hiding this comment.
For latest compute, all query and header parameter will be keyword-only instead of positoinal. So its doc type changes from param to keyword
There was a problem hiding this comment.
These are all existing parameters, why these linter issues haven't they been scanned and detected before?
Since our CLI read comments from SDK as arguments help messages and the doc type of these params are changed from param to keyword in Python SDK side, the help messages are lost when using the latest SDK package. We would add them manually to avoid breaking changes.
src/azure-cli/azure/cli/command_modules/vm/tests/latest/test_vm_commands.py
Outdated
Show resolved
Hide resolved
src/azure-cli/azure/cli/command_modules/vm/tests/latest/test_vm_commands.py
Outdated
Show resolved
Hide resolved
src/azure-cli/azure/cli/command_modules/vm/tests/latest/test_vm_commands.py
Show resolved
Hide resolved
src/azure-cli/azure/cli/command_modules/vm/tests/latest/test_vm_commands.py
Show resolved
Hide resolved
src/azure-cli/azure/cli/command_modules/vm/tests/latest/test_vm_commands.py
Show resolved
Hide resolved
aff37a8
Related command
Description
Bump version for
azure-mgmt-computepackage: 29.1.0 -> 30.0.0Upgrade api version for
MGMT_COMPUTEresource type: virtual_machine_scale_sets 2022-11-01 -> 2023-03-31Close: #26642
Testing Guide
History Notes
[Component Name 1] BREAKING CHANGE:
az command a: Make some customer-facing breaking change[Component Name 2]
az command b: Add some customer-facing featureThis checklist is used to make sure that common guidelines for a pull request are followed.
The PR title and description has followed the guideline in Submitting Pull Requests.
I adhere to the Command Guidelines.
I adhere to the Error Handling Guidelines.