[Doc]: Get-AzWebApp needs to make -ResourceGroupName a required parameter for optimal results

[Xingyixzhang]

Description

Document Link

https://docs.microsoft.com/en-us/powershell/module/az.websites/get-azwebapp?view=azps-7.2.0&viewFallbackFrom=azps-7.2

Issue

The command below with and without the -ResourceGroupName parameter returns different results, yet the document does not specify that the -ResourceGroupName should be a required field.

$apps = Get-azWebApp (-ResourceGroupName)

foreach($a in $apps){
    $a.name
    $a.siteconfig.FtpsState
}

Demonstration on Expected Results (with the parameter, the FtpsState value showed up correctly)

Demonstration on Actual Results (without the parameter, the FtpsState value showed up null)

Additional findings

Many other values are missing when the -ResourceGroupName parameter is not set. Feel free to check full detailed SiteConfig comparisons running the following commands:

Get-azWebApp | ConvertTo-Json
Get-azWebApp -ResourceGroupName "YourRGName" | ConvertTo-Json

Recommendation

Make the -ResourceGroupName a required parameter so that customers can achieve the desired results.

[ghost]

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @antcp, @AzureAppServiceCLI.

Issue Details

---

Description

Document Link

https://docs.microsoft.com/en-us/powershell/module/az.websites/get-azwebapp?view=azps-7.2.0&viewFallbackFrom=azps-7.2

Issue

The command below with and without the -ResourceGroupName parameter returns different results, yet the document does not specify that the -ResourceGroupName should be a required field.

$apps = Get-azWebApp (-ResourceGroupName)

foreach($a in $apps){
    $a.name
    $a.siteconfig.FtpsState
}

Demonstration on Expected Results (with the parameter, the FtpsState value showed up correctly)

Demonstration on Actual Results (without the parameter, the FtpsState value showed up null)

Additional findings

Many other values are missing when the -ResourceGroupName parameter is not set. Feel free to check full detailed SiteConfig comparisons running the following commands:

Get-azWebApp | ConvertTo-Json
Get-azWebApp -ResourceGroupName "YourRGName" | ConvertTo-Json

Recommendation

Make the -ResourceGroupName a required parameter so that customers can achieve the desired results.

Author:	Xingyixzhang
Assignees:	-
Labels:	App Services, Service Attention, question, customer-reported, needs-triage
Milestone:	-

[ghost]

Thank you for your feedback. This has been routed to the support team for assistance.

[ghost]

Thank you for your feedback. This has been routed to the support team for assistance.

[navba-MSFT]

@Xingyixzhang Apologies for the late reply. I am looking into this issue. I will get back on this thread once I have more details on this.

[navba-MSFT]

@Xingyixzhang Please check the similar issue being reported here #9168.

As a workaround, you can get the consistent result using the Get-AzResource PS cmdlet.

$siteConfig = Get-AzResource -ResourceGroupName 'MyRGName' -Name 'MyResourceName' -ResourceType Microsoft.Web/sites/config -ApiVersion 2021-03-01

$siteConfig.Properties.ftpsState

cc: @panchagnula

[panchagnula]

@Xingyixzhang / @navba-MSFT making an argument required from optional is a breaking change since currently this command can be run on Sub level, RG level or app level. @navba-MSFT we should close since this is not possible for now.

[navba-MSFT]

Thanks @panchagnula for your reply.

@Xingyixzhang I hope you had a chance to look at the above comment. We will now proceed with the closure as this feature would be a breaking change and not it is not possible to add now. If you have any further questions, please feel free to reopen this thread.