Azure / azure-powershell

Microsoft Azure PowerShell
Other
4.22k stars 3.83k forks source link

Variables within PowerShell commands need to be explained #24072

Open TimAbmgf opened 8 months ago

TimAbmgf commented 8 months ago

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):

  1. $ProtectableItems = Get-AzRecoveryServicesAsrProtectableItem -ProtectionContainer $Container
  2. Get-AzRecoveryServicesAsrProtectableItem -ProtectionContainer $pc -FriendlyName $piFriendlyName
  3. 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

microsoft-github-policy-service[bot] commented 8 months ago

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @Daya-Patil.

microsoft-github-policy-service[bot] commented 8 months ago

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @Daya-Patil.

Daya-Patil commented 8 months ago

This is recovery services ASR. Adding @Sharmistha-Rai

isra-fel commented 8 months ago

Let me group more similar requests in this single issue:

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

$ProtectionContainers = Get-AzRecoveryServicesAsrProtectionContainer -Fabric $fabric
Get-AzRecoveryServicesAsrProtectionContainer -Name xxxxx -Fabric $fabric
Get-AzRecoveryServicesAsrProtectionContainer -FriendlyName xxxxxxxx -Fabric $fabric

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

$ProtectionContainerMappings = Get-AzRecoveryServicesAsrProtectionContainerMapping -ProtectionContainer $Container
$ProtectionContainerMappings = Get-AzRecoveryServicesAsrProtectionContainerMapping -ProtectionContainer $Container -Name $PrimaryProtectionContainerMapping