Skip to content

Conversation

@BigCat20196
Copy link
Contributor

@BigCat20196 BigCat20196 commented Mar 24, 2021

Description

Resolve #16541

[Compute] Modify description of license_ msg. After reminding the user to set the license type on VMSS, execute the following command to apply the change to the existing VM.
az vmss update-instances -g "Your resource group name" -n "Your VMSS name" --instance-ids "*"

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


This checklist is used to make sure that common guidelines for a pull request are followed.

@qwordy
Copy link
Member

qwordy commented Mar 24, 2021

I would suggest update help in command level instead of parameter level

@yungezz yungezz added the Compute az vm/vmss/image/disk/snapshot label Mar 24, 2021
@yungezz yungezz assigned yungezz and qwordy and unassigned yungezz Mar 24, 2021
license_msg = "Specifies that the Windows image or disk was licensed on-premises. " \
"To enable Azure Hybrid Benefit for Windows Server, use 'Windows_Server'. " \
"To enable Multitenant Hosting Rights for Windows 10, use 'Windows_Client'. " \
"Remember that after setting the license type on VMSs, execute the following command to apply the changes to the existing VM." \
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
"Remember that after setting the license type on VMSs, execute the following command to apply the changes to the existing VM." \
"Remember that after setting the license type on VMSS, execute the following command to apply the changes to the existing VM." \

helps['vmss update'] = """
type: command
short-summary: Update a VMSS.
long-summary: To update a global scale set property, you must update the property in the scale set model.Remember to execute the `az vmss update-instances -g 'Your resource group name' -n 'Your VMSS name' --instance-ids '*' ` command after using this command to make the change take effect. If you don't set the automatic modes for the upgrade policy.
Copy link
Member

@qwordy qwordy Apr 2, 2021

Choose a reason for hiding this comment

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

@BigCat20196 Put it in short summary. Long summary is not shown in references.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

OK,I've tried to write it in the short summary.

type: command
short-summary: Update a VMSS.
long-summary: To update a global scale set property, you must update the property in the scale set model.Remember to execute the `az vmss update-instances -g 'Your resource group name' -n 'Your VMSS name' --instance-ids '*' ` command after using this command to make the change take effect. If you don't set the automatic modes for the upgrade policy.
short-summary: Update a VMSS.After that,remember to execute the 'az vmss update-instances' command to make the changes take effect, assuming that you have not set the automatic modes for the upgrade policy
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
short-summary: Update a VMSS.After that,remember to execute the 'az vmss update-instances' command to make the changes take effect, assuming that you have not set the automatic modes for the upgrade policy
short-summary: Update a VMSS. Run 'az vmss update-instances' command to roll out the changes to VMs if you have not configured upgrade policy.

@qwordy qwordy changed the title {Compute}Update description of license_msg {Compute} Update description of license_msg Apr 2, 2021
@qwordy
Copy link
Member

qwordy commented Apr 2, 2021

@BigCat20196 You should have seen a "Commit suggestion" button on my comment. If it looks good, just click it.

@BigCat20196 BigCat20196 merged commit 29767d7 into Azure:dev Apr 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Compute az vm/vmss/image/disk/snapshot

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Wording for --license-type is vague

3 participants