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.

Sign up for GitHub

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

Update repair-button and repair-and-restore descriptions and --button-command help text #8488

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Update repair-button and repair-and-restore descriptions and --button-command help text #8488

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
06c87b5
Update _params.py
divargas-msft Feb 18, 2025
ae88790
Update _help.py
divargas-msft Feb 18, 2025
ff77b94
Update setup.py
divargas-msft Feb 18, 2025
4be9c84
Update HISTORY.rst
divargas-msft Feb 18, 2025
d1346ca
Update src/vm-repair/azext_vm_repair/_help.py
divargas-msft Feb 19, 2025
a7e30e0
Update src/vm-repair/azext_vm_repair/_help.py
divargas-msft Feb 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions src/vm-repair/HISTORY.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@

Release History
===============
2.0.4
++++++
Updated `az vm repair repair-button` and `az vm repair repair-and-restore` help descriptions and parameter description in the --button-command argument from repair-button.

2.0.3
++++++
Expand Down
4 changes: 2 additions & 2 deletions src/vm-repair/azext_vm_repair/_help.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,15 +110,15 @@

helps['vm repair repair-and-restore'] = """
type: command
short-summary: Repair and restore the VM.
short-summary: Non-interactive command. Repair fstab issues using a temporary repair VM and restore the VM by replacing the VM's OS disk with the fixed copy disk.
examples:
- name: Repair and restore a VM.
text: >
az vm repair repair-and-restore --name vmrepairtest --resource-group MyResourceGroup --verbose
"""
helps['vm repair repair-button'] = """
type: command
short-summary: repair button script.
short-summary: Non-interactive command used by repair VM buttons. Repair issues using ALAR scripts. Create a temporary repair VM and restore the VM by replacing the VM's OS disk with the fixed copy disk.
examples:
- name: repair-button.
text: >
Expand Down
2 changes: 1 addition & 1 deletion src/vm-repair/azext_vm_repair/_params.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ def load_arguments(self, _):
c.argument('repair_group_name', help='Name for new or existing resource group that will contain repair VM.')

with self.argument_context('vm repair repair-button') as c:
c.argument('button_command', help='Button_command for repair VM.')
c.argument('button_command', help='Specific ALAR script being used for repair VM.')
Copy link
Member

Choose a reason for hiding this comment

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

is this just a flag parameter? or can it take values? If it can take in values, is this cmd only specified to run the alar2 script? If it's not alar specific, remove that mention and just describe what it does.

Copy link
Author

Choose a reason for hiding this comment

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

@Sandido the --button-command needs to receive the name of an ALAR function/command as a value ( and it needs that value to work)

c.argument('repair_username', help='Admin username for repair VM.')
c.argument('repair_password', help='Admin password for the repair VM.')
c.argument('copy_disk_name', help='Name of OS disk copy.')
Expand Down
2 changes: 1 addition & 1 deletion src/vm-repair/setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
from codecs import open
from setuptools import setup, find_packages

VERSION = "2.0.3"
VERSION = "2.0.4"

CLASSIFIERS = [
'Development Status :: 4 - Beta',
Expand Down
Loading