Variables within PowerShell commands need to be explained

Open Beginner friendly

#24,072 opened on Jan 30, 2024 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty: 2/5
Estimated time: 1-3 hours
Newbie friendliness: 72/100

Issue type: Documentation
Clarity: Mostly clear
Activity status: Quiet
Tech stack: powershell
Domain: documentation

Research direction

Start with src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesAsrProtectableItem.md and review the examples containing $Container, $pc, $piFriendlyName, and $piName. Check the linked Get-AzRecoveryServicesAsrProtectableItem documentation and surrounding examples to determine what each variable represents and how users obtain it. Done means the examples explain the required variable values sufficiently to run the commands.

Written by the indexing model from the issue text.

Description

act-observability-squad customer-reported Doc - Reference Recovery Services Backup Service Attention

Type of issue

Missing information

Feedback

When I look at the PS commands, there are variables within the examples which are not explained (on what goes into each variable):

$ProtectableItems = Get-AzRecoveryServicesAsrProtectableItem -ProtectionContainer $Container
Get-AzRecoveryServicesAsrProtectableItem -ProtectionContainer $pc -FriendlyName $piFriendlyName
Get-AzRecoveryServicesAsrProtectableItem -ProtectionContainer $pc -Name $piName

I feel the examples should explain how to get the data for each variable to run the command

Page URL

https://learn.microsoft.com/en-us/powershell/module/az.recoveryservices/get-azrecoveryservicesasrprotectableitem?view=azps-11.2.0&tryIt=true&source=docs#code-try-5

Content source URL

https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesAsrProtectableItem.md

Author

@mikefrobbins

Document Id

bf1c237f-b687-f13f-5ac3-155d291aa343

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

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

Similar issues

[quality-improver] Repository Quality: AzureFoundry Extension Missing from Self-Registration Acceptance Test Open

type/automation type/tech-debt

Difficulty 2/5 1-3 hours Newbie friendliness 78/100

microsoft/testfx#11431 · Opened Sep 21, 2026
[Bug]: Composite `ui screenshot` success output ignores `--quiet` Open

bug

Difficulty 2/5 1-3 hours Newbie friendliness 88/100

microsoft/winappCli#914 · Opened Sep 21, 2026
GeometryHelper.FlattenArc / FlattenCubicBezier / FlattenQuadraticBezier emit a NaN point when the segment count truncates to 0 (0/0) — a Path with a sub-pixel arc fail-fasts Windows with D2DERR_BAD_NUMBER (root cause of #8512, #13757) Open

t/bug

Difficulty 2/5 1-3 hours Newbie friendliness 82/100

dotnet/maui#38751 · 1 reaction · Opened Sep 21, 2026
[CI Failure] Flaky: MauiBuildQueueTests.CancelQueuedResource_CompletesGracefullyAndDoesNotAcquireSemaphore asserts exact exception type but sometimes gets TaskCanceledException instead of OperationCanceledException Open

ci-failure-cause test-failure

Difficulty 2/5 1-3 hours Newbie friendliness 82/100

microsoft/aspire#20284 · Opened Sep 21, 2026
The login flow's text-link submit is 42 px tall on a narrow screen; its docblock says 44 Open

area:auth FE mvp P3

Difficulty 2/5 1-3 hours Newbie friendliness 88/100

klasolsson81/jobbliggaren#1788 · Opened Sep 21, 2026

More C# issues