Document Details
Api Management Howto Integrate Internal Vnet Appgateway
❌
This page contains Windows bias
About This Page
This page is part of the Azure documentation. It contains code examples and configuration instructions for working with Azure services.
Bias Analysis
Bias Types:
⚠️
powershell_heavy
⚠️
missing_linux_example
⚠️
windows_tools
⚠️
windows_first
Summary:
The documentation is heavily biased toward Windows and PowerShell usage. All command-line examples are provided exclusively in Azure PowerShell, with no mention of Azure CLI, Bash, or cross-platform scripting. File paths use Windows-style conventions (e.g., C:\Users\Contoso\), and there is no guidance for Linux or macOS users regarding certificate storage or command adaptation. The documentation assumes the use of Windows tools and patterns throughout, making it less accessible for users on Linux or macOS.
Recommendations:
- Provide equivalent Azure CLI (az) command examples alongside PowerShell for all resource creation and configuration steps.
- Include Bash shell script examples and use cross-platform file path conventions (e.g., $HOME/certs/ or ~/certs/) in variable definitions.
- Add notes or sections specifically addressing Linux/macOS users, especially for certificate handling, file paths, and environment setup.
- Reference cross-platform tools (such as OpenSSL for certificate generation) and avoid assuming the use of Windows-only utilities.
- Where PowerShell is required, clarify that Azure PowerShell is available on Linux/macOS and provide installation instructions for those platforms.
- Reorder or parallelize instructions so that Linux/macOS approaches are presented equally, not as an afterthought.
Create pull request
Scan History
| Date | Scan ID | Status | Bias Status |
|---|---|---|---|
| 2025-09-14 00:00 | #111 | completed | ❌ Biased |
| 2025-08-14 00:01 | #80 | in_progress | ❌ Biased |
| 2025-07-13 21:25 | #47 | cancelled | ✅ Clean |
| 2025-07-13 20:48 | #44 | cancelled | ✅ Clean |
| 2025-07-09 13:09 | #3 | cancelled | ✅ Clean |
| 2025-07-08 04:23 | #2 | cancelled | ❌ Biased |
Flagged Code Snippets
Connect-AzAccount
# These variables must be changed.
$subscriptionId = "aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e" # GUID of your Azure subscription
$domain = "contoso.net" # The custom domain for your certificate
$apimServiceName = "apim-contoso" # API Management service instance name, must be globally unique
$apimDomainNameLabel = $apimServiceName # Domain name label for API Management's public IP address, must be globally unique
$apimAdminEmail = "admin@contoso.net" # Administrator's email address - use your email address
$gatewayHostname = "api.$domain" # API gateway host
$portalHostname = "portal.$domain" # API developer portal host
$managementHostname = "management.$domain" # API management endpoint host
$baseCertPath = "C:\Users\Contoso\" # The base path where all certificates are stored
$trustedRootCertCerPath = "${baseCertPath}trustedroot.cer" # Full path to contoso.net trusted root .cer file
$gatewayCertPfxPath = "${baseCertPath}gateway.pfx" # Full path to api.contoso.net .pfx file
$portalCertPfxPath = "${baseCertPath}portal.pfx" # Full path to portal.contoso.net .pfx file
$managementCertPfxPath = "${baseCertPath}management.pfx" # Full path to management.contoso.net .pfx file
$gatewayCertPfxPassword = "certificatePassword123" # Password for api.contoso.net pfx certificate
$portalCertPfxPassword = "certificatePassword123" # Password for portal.contoso.net pfx certificate
$managementCertPfxPassword = "certificatePassword123" # Password for management.contoso.net pfx certificate
# These variables may be changed.
$resGroupName = "rg-apim-agw" # Resource group name that will hold all assets
$location = "West US" # Azure region that will hold all assets
$apimOrganization = "Contoso" # Organization name
$appgwName = "agw-contoso" # The name of the Application Gateway
1. Create an API Management virtual network object by using the subnet `$apimSubnetData` you created.