Skip to content

Revise README for VM assist usage and output details #112

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

Open
kegregoi wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Revise README for VM assist usage and output details #112

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
130c4e1
Revise README for VM assist usage and output details
kegregoi Jan 22, 2026
5e8d09f
Update README.md for VM assist documentation
kegregoi Jan 22, 2026
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
18 changes: 3 additions & 15 deletions vmassist/windows/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,33 +18,19 @@ Set-ExecutionPolicy Bypass -Force
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
(Invoke-WebRequest -Uri https://aka.ms/vmassist -OutFile vmassist.ps1) | .\vmassist.ps1
```
Or you can specify the full URL instead of the aka.ms short link -
```powershell
(Invoke-WebRequest -Uri https://raw.githubusercontent.com/Azure/azure-support-scripts/master/vmassist/windows/vmassist.ps1 -OutFile vmassist.ps1) | .\vmassist.ps1
```

## Manual download and run
Download:
```powershell
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
Invoke-WebRequest -Uri https://aka.ms/vmassist -OutFile vmassist.ps1
```
Or you can specify the full URL instead of the aka.ms short link -
```powershell
Invoke-WebRequest -Uri https://raw.githubusercontent.com/Azure/azure-support-scripts/master/vmassist/windows/vmassist.ps1 -OutFile vmassist.ps1
```

Run the script:
```powershell
Set-ExecutionPolicy Bypass -Force
.\vmassist.ps1
```
## Download from browser
1. Download the file ```vmassist.ps1``` [from a web browser.](https://github.com/Azure/azure-support-scripts/blob/master/vmassist/windows/vmassist.ps1)
1. From an elevated PowerShell window, ensure you're in the same directory that you downloaded the script to, then run the following to run the script:
```powershell
Set-ExecutionPolicy Bypass -Force
.\vmassist.ps1
```

# Analyzing output

Expand All @@ -59,3 +45,5 @@ The .log file will have a copy of the results that are displayed in the PowerShe
The .htm file is a report that shows all of the checks and findings along with information on how to mitigate any issues it found. It will also have additional information about the OS and the VM that can further assist in troubleshooting any issues that are found.

If you open a support request, please include both of the above files to aid your support representative in helping you.