[Doc]: Invoke-AzVMRunCommand example 1 is incorrect

Open Beginner friendly
#27,931 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
78/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Tech stack
powershell
Domain
documentation

Research direction

Open src/Compute/Compute/help/Invoke-AzVMRunCommand.md and locate the first Invoke-AzVMRunCommand example. Verify the ScriptPath and ScriptString descriptions against the issue and the linked documentation page. Done means the example correctly says ScriptPath is for a script on the local Windows VM and ScriptString is used for a script on the remote Windows VM.

Written by the indexing model from the issue text.

Description

Compute customer-reported Service Attention
Type of issue

Code doesn't work

Feedback

The example states: "Invoke a command on Windows - Using ScriptPath parameter when the script resides on the remote Windows VM". This is incorrect. It should say "Invoke a command on Windows - Using ScriptPath parameter when the script resides on the local Windows VM". To run a script which resides on the remote Windows VM, ScriptString must be used.

Page URL

https://learn.microsoft.com/en-us/powershell/module/az.compute/invoke-azvmruncommand?view=azps-14.1.0&source=docs

Content source URL

https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Invoke-AzVMRunCommand.md

Author

@mikefrobbins

Document Id

e7d2f266-0b25-3b15-6278-40c58d41600d

Platform Id

7f4198ec-6ee3-a28b-1755-3607472dcb43

Dominant language
C#
Stars
4.8k
Forks
4.3k
Avg merge
3d 21h
Merged PRs (30d)
49

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Azure/azure-powershell

All issues in Azure/azure-powershell

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.