[Doc]: Add-AzApplicationGatewaySslCertificate example omits required Set-AzApplicationGateway to persist changes

[aricade]

Type of issue

Other (describe below)

Feedback

The current example shows how to add an SSL certificate to an Application Gateway by updating the in-memory object returned by Get-AzApplicationGateway and then calling Add-AzApplicationGatewaySslCertificate. However, it does not demonstrate the final step needed to persist those changes back to the Azure resource.
Without calling Set-AzApplicationGateway -ApplicationGateway $AppGW (or Update-AzApplicationGateway in some patterns), users may assume the change is applied, but the certificate is not actually pushed to the Application Gateway.

# Persist the change to Azure (required)
Set-AzApplicationGateway -ApplicationGateway $AppGW

Page URL

https://learn.microsoft.com/en-us/powershell/module/az.network/add-azapplicationgatewaysslcertificate?view=azps-15.1.0&viewFallbackFrom=azps-14.1.0

Content source URL

https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzApplicationGatewaySslCertificate.md

Author

@mikefrobbins

Document Id

d9014bc0-dbaa-ad6f-bb29-f30fe3c2a3bd

Platform Id

805a1f56-1b93-78c3-7724-9427da6332a5

[github-actions]

Here are some similar issues that might help you. Please check if they can solve your problem.

• Remove-AzApplicationGatewaySslCertificate documentation should include Set-AzApplicationGateway #15042

---

Possible solution (Extracted from existing issue, might be incorrect; please verify carefully)

Add a third line on the example to let users know that they have to run the Set-AzApplicationGateway:

PS C:\>$AppGW = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01"
PS C:\> Remove-AzApplicationGatewaySslCertificate -ApplicationGateway $AppGW -Name "Cert02"
PS C:\> Set-AzApplicationGateway -ApplicationGateway $AppGW

Reference:

• Remove-AzApplicationGatewaySslCertificate documentation should include Set-AzApplicationGateway #15042 (comment)

Powered by issue-sentinel

[microsoft-github-policy-service]

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

[microsoft-github-policy-service]

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