Skip to content

Commit 91d4085

Browse files
authored
Update README.md
1 parent 5014bfa commit 91d4085

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

src/vm-repair/README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Azure CLI VM Repair Extension #
2-
This is a extension for repairing VMs.
2+
This is an extension for repairing VMs. Usually this is used to repair VMs that cannot boot by copying the
3+
OS Disk to a separate repair VM copy and run [repair scripts](https://github.com/Azure/repair-script-library) against it.
4+
You can also create then run your own custom repair scripts, seen in the `--custom-script-file` parameter in the `az vm repair run` command.
35

46
### How to use ###
57
Install this extension using the below CLI command
@@ -8,11 +10,15 @@ az extension add --name vm-repair
810
```
911

1012
### Sample Commands ###
11-
Repair create command
13+
Create repair VM command
1214
```
1315
az vm repair create -g MyResourceGroup -n myVM --verbose
1416
```
15-
Restore command
17+
Run a repair script on the new repair VM
18+
```
19+
az vm repair run -g MyResourceGroup -n MySourceWinVM --run-id win-hello-world --run-on-repair --verbose
20+
```
21+
Restore the now fixed copied OS disk from the repair VM to the original VM
1622
```
1723
az vm repair restore -g MyResourceGroup -n myVM --verbose
18-
```
24+
```

0 commit comments

Comments
 (0)