With more companies adhering to the API-first approach for their internal applications, and the growing number and severity of threats to web applications over the internet, it's critical to have a security strategy to protect APIs. The first step toward API security is restricting who can access what aspects of an API, and from which locations. This article describes how to use Azure Application Gateway and Azure API Management to protect API access.
This article doesn't address the application's underlying services, like App Service Environment, Azure SQL Managed Instance, and Azure Kubernetes Services. Those parts of the diagram only showcase what you can do as a broader solution. This article specifically discusses the shaded areas, API Management and Application Gateway.
Application Gateway sets up a URL redirection mechanism that sends the request to the proper backend pool, depending on the URL format of the API call:
URLs formatted like
api.<some-domain>/external/*can reach the back end to interact with the requested APIs.
Calls formatted as
api.<some-domain>/*go to a dead end, which is a back-end pool with no target.
API Management accepts and properly maps internal calls, which come from resources in the same Azure virtual network, under
Finally, at the API Management level, APIs are set up to accept calls under the following patterns:
In this scenario, API Management uses two types of IP addresses, public and private. Public IP addresses are for internal communication on port 3443, and for runtime API traffic in the external virtual network configuration. When API Management sends a request to a public internet-facing back end, it shows a public IP address as the origin of the request. For more information, see IP addresses of API Management service in VNet.
A rule at the Application Gateway level properly redirects users under
portal.<some-domain>/*to the developer portal, so that developers can manage APIs and their configurations from both internal and external environments.
Azure Virtual Network enables many types of Azure resources, such as Azure Virtual Machines (VMs), to securely communicate with each other, the internet, and on-premises networks.
Azure Application Gateway is a web traffic load balancer that manages traffic to web applications. Load balancers operate at the transport layer, OSI layer 4 TCP and UDP, and route traffic based on source IP address and port to a destination IP address and port.
Azure API Management is a hybrid, multi-cloud management platform for APIs across all environments. API Management creates consistent, modern API gateways for existing backend services.
This solution focuses on implementing the whole solution, and testing API access from inside and outside the API Management virtual network. For more information about the API Management virtual network integration process, see Integrate API Management in an internal VNET with Application Gateway.
This solution doesn't cover product creation and API configuration in API Management. For a comprehensive tutorial covering those tasks, see Tutorial: Create and publish a product.
To communicate with private resources in the back end, Application Gateway and API Management must be in the same virtual network as the resources. Before implementing the solution, set up a virtual network for your resources. The solution creates subnets for Application Gateway and API Management.
The private, internal deployment model allows API Management to connect to an existing virtual network, making it reachable from the inside of that network context. To enable this feature, deploy either the Development or Production API Management tiers.
Application Gateway requires PFX certificates for SSL termination. Make sure these certificates are in place before you implement the solution.
Manage certificates and passwords in Azure Key Vault.
To personalize interactions with the services, you can use CNAME entries.
You can use other services to deliver the same level of firewall and Web Application Firewall (WAF) protection:
Application Gateway is the entry point for this architecture, and the WAF feature requires additional processing power for each request analysis. To allow Application Gateway to expand its computational capacity on the spot, it's important to enable autoscaling. For more information, see Specify autoscale.
Consider Application Gateway subnet sizing. Application Gateway requests one private address per instance, and another private IP address if a private front-end IP is configured. Application Gateway also takes five IPs per instance from its subnet. To properly deploy Application Gateway for this architecture, make sure its subnet has enough space to grow. For more information, see Application Gateway infrastructure configuration.
To support highly concurrent scenarios, turn on API Management autoscaling. Autoscaling quickly expands API Management capabilities in response to growing numbers of incoming requests. For more information, see Automatically scale an Azure API Management instance.
Azure Application Gateway is always deployed in a highly available fashion. If a certain instance stops functioning, Application Gateway transparently creates a new instance. To avoid downtime when creating new instances, you can configure the Application Gateway or WAF deployment to span multiple Availability Zones, making it more resilient to zone failure. For more information, see Autoscaling and High Availability.
Enable zone redundancy for your API Management instance to provide resiliency and high availability. Zone redundancy replicates the API Management gateway and control plane across datacenters in physically separated zones, making them resilient to zone failure. Zone redundancy requires the API Management Premium tier.
API Management also supports multi-region deployments, which help reduce request latency, and improve availability if one region goes offline. For more information, see Availability zone support for Azure API Management.
For more information about Application Gateway security, see Azure security baseline for Application Gateway.
For more information about API Management security, see Azure security baseline for API Management.
Deploy the solution
Deploy a new resource group.
$resGroupName = "<resource-group-name>" $location = "<azure-region>" New-AzResourceGroup -Name $resGroupName -Location $location
Add subnets for API Management and Application Gateway.
# Retrieve virtual network information $vnet = Get-AzVirtualNetwork -Name <vnet-name> -ResourceGroupName <resource-group-name> # Add the appgtw-subnet to the existing virtual network $subnetApplication GatewayConfig = Add-AzVirtualNetworkSubnetConfig ` -Name appgtw-subnet ` -AddressPrefix <subnet-prefix-address> ` -VirtualNetwork $vnet # Add the apim-subnet to the existing virtual network $subnetAPIMConfig = Add-AzVirtualNetworkSubnetConfig ` -Name apim-subnet ` -AddressPrefix <subnet-prefix-address> ` -VirtualNetwork $vnet # Attach subnets to the virtual network $vnet | Set-AzVirtualNetwork # Check that subnets were successfully added $vnet.Subnets # Assign subnet to variables $appgatewaysubnetdata = $vnet.Subnets[subnet-index] $apimsubnetdata = $vnet.Subnets[subnet-index]
Deploy a new API Management instance.
# Create an API Management virtual network-connected object $apimVirtualNetwork = New-AzApiManagementVirtualNetwork -SubnetResourceId $apimsubnetdata.Id # Create an API Management service inside the virtual network $apimServiceName = "<apim-name>" $apimOrganization = "<organization-name>" $apimAdminEmail = "<alias>@<somedomain>" $apimService = New-AzApiManagement ` -ResourceGroupName $resGroupName ` -Location $location ` -Name $apimServiceName ` -Organization $apimOrganization ` -AdminEmail $apimAdminEmail ` -VirtualNetwork $apimVirtualNetwork ` -VpnType "Internal" ` -Sku "<apim-tier>"
Configure hostnames and certificates.
# Specify certificate configuration $gatewayHostname = "api.<some-domain>" $portalHostname = "portal.<some-domain>" $gatewayCertCerPath = "<local-path-to-cer-certificate>" $gatewayCertPfxPath = "<local-path-to-pfx-certificate>" $portalCertPfxPath = "<local-path-to-pfx-certificate>" $gatewayCertPfxPassword = "<cert-api-password>" $portalCertPfxPassword = "<cert-portal-password>" # Convert to secure string before sending over HTTP $certPwd = ConvertTo-SecureString -String $gatewayCertPfxPassword -AsPlainText -Force $certPortalPwd = ConvertTo-SecureString -String $portalCertPfxPassword -AsPlainText -Force # Create and set the hostname configuration objects for the proxy and portal $proxyHostnameConfig = New-AzApiManagementCustomHostnameConfiguration ` -Hostname $gatewayHostname ` -HostnameType Proxy ` -PfxPath $gatewayCertPfxPath ` -PfxPassword $certPwd $portalHostnameConfig = New-AzApiManagementCustomHostnameConfiguration ` -Hostname $portalHostname ` -HostnameType Portal ` -PfxPath $portalCertPfxPath ` -PfxPassword $certPortalPwd # Tie certificates configurations into API Management service $apimService.ProxyCustomHostnameConfiguration = $proxyHostnameConfig $apimService.PortalCustomHostnameConfiguration = $portalHostnameConfig # Update API Management with the updated configuration Set-AzApiManagement -InputObject $apimService
Provision a public IP (PIP) for Application Gateway.
# Create a public IP address for the Application Gateway front end $publicip = New-AzPublicIpAddress ` -ResourceGroupName $resGroupName ` -name "<pip-name>" ` -location $location ` -AllocationMethod Dynamic
Configure Application Gateway.
Create the Application Gateway IP configuration.
# Step 1 - create new Application Gateway IP configuration $gipconfig = New-AzApplicationGatewayIPConfiguration ` -Name "gatewayIP" ` -Subnet $appgatewaysubnetdata
Configure the front-end IP port object.
# Step 2 - configure the front-end IP port for the public IP endpoint $fp01 = New-AzApplicationGatewayFrontendPort ` -Name "frontend-port443" ` -Port 443
Tie the front-end IP port to the public IP.
# Step 3 - configure the front-end IP with the public IP endpoint $fipconfig01 = New-AzApplicationGatewayFrontendIPConfig ` -Name "frontend1" ` -PublicIPAddress $publicip
Set up certificates for Application Gateway.
# Step 4 - configure certificates for the Application Gateway $cert = New-AzApplicationGatewaySslCertificate ` -Name "apim-gw-cert" ` -CertificateFile $gatewayCertPfxPath ` -Password $certPwd $certPortal = New-AzApplicationGatewaySslCertificate ` -Name "apim-portal-cert" ` -CertificateFile $portalCertPfxPath ` -Password $certPortalPwd
Create Application Gateway listeners.
# Step 5 - configure HTTP listeners for the Application Gateway $listener = New-AzApplicationGatewayHttpListener ` -Name "apim-api-listener" ` -Protocol "Https" ` -FrontendIPConfiguration $fipconfig01 ` -FrontendPort $fp01 ` -SslCertificate $cert ` -HostName $gatewayHostname ` -RequireServerNameIndication true $portalListener = New-AzApplicationGatewayHttpListener ` -Name "apim-portal-listener" ` -Protocol "Https" ` -FrontendIPConfiguration $fipconfig01 ` -FrontendPort $fp01 ` -SslCertificate $certPortal ` -HostName $portalHostname ` -RequireServerNameIndication true
Create Application Gateway probes to map API Management endpoints.
# Step 6 - create custom probes for API Management endpoints $apimprobe = New-AzApplicationGatewayProbeConfig ` -Name "apim-api-probe" ` -Protocol "Https" ` -HostName $gatewayHostname ` -Path "/status-0123456789abcdef" ` -Interval 30 ` -Timeout 120 ` -UnhealthyThreshold 8 $apimPortalProbe = New-AzApplicationGatewayProbeConfig ` -Name "apim-portal-probe" ` -Protocol "Https" ` -HostName $portalHostname ` -Path "/signin" ` -Interval 60 ` -Timeout 300 ` -UnhealthyThreshold 8
List API Management endpoints to backend pools.
# Step 7 - upload certificate for SSL-enabled backend pool resources $authcert = New-AzApplicationGatewayAuthenticationCertificate ` -Name "whitelistcert" ` -CertificateFile $gatewayCertCerPath
Configure Application Gateway HTTPs settings.
# Step 8 - configure HTTPs backend settings for the Application Gateway $apimPoolSetting = New-AzApplicationGatewayBackendHttpSettings ` -Name "apim-api-poolsetting" ` -Port 443 ` -Protocol "Https" ` -CookieBasedAffinity "Disabled" ` -Probe $apimprobe ` -AuthenticationCertificates $authcert ` -RequestTimeout 180 $apimPoolPortalSetting = New-AzApplicationGatewayBackendHttpSettings ` -Name "apim-portal-poolsetting" ` -Port 443 ` -Protocol "Https" ` -CookieBasedAffinity "Disabled" ` -Probe $apimPortalProbe ` -AuthenticationCertificates $authcert ` -RequestTimeout 180
Map backend pool IP to API Management internal IP.
# Step 9a - map backend pool IP with API Management internal IP $apimProxyBackendPool = New-AzApplicationGatewayBackendAddressPool ` -Name "apimbackend" ` -BackendIPAddresses $apimService.PrivateIPAddresses # Step 9b - create sinkpool for API Management requests to discard $sinkpool = New-AzApplicationGatewayBackendAddressPool -Name "sinkpool" $apimProxyBackendPool = New-AzApplicationGatewayBackendAddressPool ` -Name "apimbackend" ` -BackendIPAddresses $apimService.PrivateIPAddresses
Allow external access to the API Management developer portal.
# Step 10 - create a routing rule to allow external internet access to the developer portal $rule01 = New-AzApplicationGatewayRequestRoutingRule ` -Name "apim-portal-rule" ` -RuleType Basic ` -HttpListener $portalListener ` -BackendAddressPool $apimProxyBackendPool ` -BackendHttpSettings $apimPoolPortalSetting
Configure Application Gateway deployment.
# Step 11 - change Application Gateway SKU and instances (# instances can be configured as required) $sku = New-AzApplicationGatewaySku -Name "<waf-sku-name>" -Tier "WAF" -Capacity <instances-number> # Step 12 - configure WAF to be in prevention mode $config = New-AzApplicationGatewayWebApplicationFirewallConfiguration ` -Enabled $true ` -FirewallMode "Detection"
Deploy Application Gateway.
# Deploy the Application Gateway $appgwName = "<ag-name>" $appgw = New-AzApplicationGateway ` -Name $appgwName ` -ResourceGroupName $resGroupName ` -Location $location ` -BackendAddressPools $apimProxyBackendPool, $sinkpool ` -BackendHttpSettingsCollection $apimPoolSetting, $apimPoolPortalSetting ` -FrontendIpConfigurations $fipconfig01 ` -GatewayIpConfigurations $gipconfig ` -FrontendPorts $fp01 ` -HttpListeners $listener, $portalListener ` -RequestRoutingRules $rule01 ` -Sku $sku ` -WebApplicationFirewallConfig $config ` -SslCertificates $cert, $certPortal ` -AuthenticationCertificates $authcert ` -Probes $apimprobe, $apimPortalProbe
Configure redirection rules.
# Get existing Application Gateway config $appgw = Get-AzApplicationGateway ` -ResourceGroupName $resGroupName ` -Name $appgwName $listener = Get-AzApplicationGatewayHttpListener ` -Name "apim-api-listener" ` -ApplicationGateway $appgw $sinkpool = Get-AzApplicationGatewayBackendAddressPool ` -ApplicationGateway $appgw ` -Name "sinkpool" $pool = Get-AzApplicationGatewayBackendAddressPool ` -ApplicationGateway $appgw ` -Name "apimbackend" $poolSettings = Get-AzApplicationGatewayBackendHttpSettings ` -ApplicationGateway $appgw ` -Name "apim-api-poolsetting" $pathRule = New-AzApplicationGatewayPathRuleConfig ` -Name "external" ` -Paths "/external/*" ` -BackendAddressPool $pool ` -BackendHttpSettings $poolSettings $appgw = Add-AzApplicationGatewayUrlPathMapConfig ` -ApplicationGateway $appgw ` -Name "external-urlpathmapconfig" ` -PathRules $pathRule ` -DefaultBackendAddressPool $sinkpool ` -DefaultBackendHttpSettings $poolSettings $appgw = Set-AzApplicationGateway ` -ApplicationGateway $appgw $pathmap = Get-AzApplicationGatewayUrlPathMapConfig ` -ApplicationGateway $appgw ` -Name "external-urlpathmapconfig" $appgw = Add-AzApplicationGatewayRequestRoutingRule ` -ApplicationGateway $appgw ` -Name "apim-api-external-rule" ` -RuleType PathBasedRouting ` -HttpListener $listener ` -BackendAddressPool $Pool ` -BackendHttpSettings $poolSettings ` -UrlPathMap $pathMap
Update Application Gateway with the new configuration.
$appgw = Set-AzApplicationGateway ` -ApplicationGateway $appgw
The cost of this architecture depends on configuration aspects like:
- Service tiers
- Scalability, meaning the number of instances dynamically allocated by services to support a given demand
- Automation scripts
- Whether this architecture will run continuously or just a few hours a month
After you assess these aspects, go to the Azure Pricing Calculator to estimate pricing.