diff --git a/src/vm-repair/HISTORY.rst b/src/vm-repair/HISTORY.rst index a41cc6e4be2..a84849d41f8 100644 --- a/src/vm-repair/HISTORY.rst +++ b/src/vm-repair/HISTORY.rst @@ -2,6 +2,10 @@ Release History =============== +2.0.2 +++++++ +Updated parameter descriptions and examples for `az vm repair create`. + 2.0.1 ++++++ Fixed 2 Unbound variable bugs in `vm repair create` and improved the code documentation. diff --git a/src/vm-repair/azext_vm_repair/_help.py b/src/vm-repair/azext_vm_repair/_help.py index 75099c79015..71bf5369bb6 100644 --- a/src/vm-repair/azext_vm_repair/_help.py +++ b/src/vm-repair/azext_vm_repair/_help.py @@ -7,9 +7,9 @@ helps['vm repair'] = """ type: group - short-summary: Auto repair commands to fix VMs. + short-summary: Setup repair VMs with copied source OS Disk to resolve issues. long-summary: | - VM repair command will enable Azure users to self-repair non-bootable VMs by copying the source VM's OS disk and attaching it to a newly created repair VM. + When your VM is non-bootable, VM Repair enables users to setup new repair VMs and copy over the source VM's OS Disk and attach it as a data disk. Then the user can run their own scripts or use [pre-built](https://github.com/Azure/repair-script-library) ones to fix the disk. """ helps['vm repair create'] = """ @@ -25,6 +25,18 @@ - name: Create a repair VM of a specific distro or a specific URN could also be provided text: > az vm repair create -g MyResourceGroup -n myVM --distro 'rhel7|sles12|ubuntu20|centos6|oracle8|sles15' + - name: Create a repair VM with a Private IP address without any pop up asking for confirmation. + text: > + az vm repair create -g MyResourceGroup -n myVM --yes --repair-username --repair-password + - name: Create a repair VM with a Public IP address without any user input. + text: > + az vm repair create -g MyResourceGroup -n myVM --associate-public-ip --yes --repair-username --repair-password + - name: Create a repair VM with Standard Security type. + text: > + az vm repair create -g MyResourceGroup -n myVM --yes --repair-username --repair-password --disable-trusted-launch + - name: Create a repair VM from a source VM with an encrypted disk. The repair VM is created with the data disk unencrypted and accessible. + text: > + az vm repair create -g MyResourceGroup -n myVM --yes --repair-username --repair-password --unlock-encrypted-vm --encrypt-recovery-key """ helps['vm repair restore'] = """ diff --git a/src/vm-repair/azext_vm_repair/_params.py b/src/vm-repair/azext_vm_repair/_params.py index 63a25ff2a6e..b65ea19fe84 100644 --- a/src/vm-repair/azext_vm_repair/_params.py +++ b/src/vm-repair/azext_vm_repair/_params.py @@ -29,7 +29,7 @@ def load_arguments(self, _): c.argument('copy_disk_name', help='Name of OS disk copy.') c.argument('repair_group_name', help='Name for new or existing resource group that will contain repair VM.') c.argument('unlock_encrypted_vm', help='Option to auto-unlock encrypted VMs using current subscription auth.') - c.argument('encrypt_recovery_key', help='Option to auto-unlock encrypted VMs using provided recovery password.') + c.argument('encrypt_recovery_key', help='Option to auto-unlock encrypted VMs using provided recovery password. The \'--unlock-encrypted-vm\' parameter must be used to use this parameter.') c.argument('enable_nested', help='enable nested hyperv.') c.argument('associate_public_ip', help='Option to create a repair vm with a public ip. If this parameter is not used, a private ip will be made.') c.argument('distro', help='Option to create repair vm from a specific linux distro (rhel7|rhel8|sles12|sles15|ubuntu20|centos7|centos8|oracle7)') diff --git a/src/vm-repair/setup.py b/src/vm-repair/setup.py index 84813bfb1c6..462139f047c 100644 --- a/src/vm-repair/setup.py +++ b/src/vm-repair/setup.py @@ -8,7 +8,7 @@ from codecs import open from setuptools import setup, find_packages -VERSION = "2.0.1" +VERSION = "2.0.2" CLASSIFIERS = [ 'Development Status :: 4 - Beta',