Enabling HTTP to HTTPS Redirection for Custom Domains in Azure API Management

Question

Pulumi · Accepted Answer

To enable HTTP to HTTPS redirection for custom domains in Azure API Management, you would typically need to set up a custom domain for your API Management service and then configure an HTTPS redirection policy. In Pulumi, this often involves creating a Custom Domain resource and a Gateway Hostname Configuration resource.

The `azure-native.apimanagement.CustomDomain` resource allows you to manage custom domain settings for Azure API Management. By using this, you can configure a domain name for your API Management service. Additionally, the `azure-native.apimanagement.GatewayHostnameConfiguration` resource can be used to configure the gateway in a way that directs traffic from HTTP to HTTPS.

Below, you will find a Pulumi program written in TypeScript that demonstrates how to set up HTTP to HTTPS redirection for custom domains in Azure API Management. The code will include comments explaining each step in the process.

```typescript
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure-native";

// The CustomDomain resource defines a custom domain for your API Management service.
const customDomain = new azure.apimanagement.CustomDomain("apiCustomDomain", {
    // The identifier of the API Management service.
    serviceName: apiManagementServiceName,
    // The name of the resource group where the service exists.
    resourceGroupName: resourceGroupName,
    // The name of your custom domain.
    domainName: customDomainName,
    properties: {
        // The hostname configurations for your custom domain.
        hostNameConfiguration: {
            hostName: customDomainName,
            // Your custom domain should be secured with an SSL certificate that you store in Azure Key Vault.
            keyVaultId: certificateSecretId,
            // Enabling this will negotiate client certificates during TLS handshake.
            negotiateClientCertificate: false,
        },
    },
});

// The GatewayHostnameConfiguration resource sets up the API Management gateway to redirect HTTP to HTTPS.
const gatewayHostnameConfiguration = new azure.apimanagement.GatewayHostnameConfiguration("gatewayHostnameConfig", {
    // The identifier of the API Management service.
    serviceName: apiManagementServiceName,
    // The name of the resource group where the service exists.
    resourceGroupName: resourceGroupName,
    // Enable redirection from HTTP to HTTPS.
    http2Enabled: true,
    tls10Enabled: false,
    tls11Enabled: false,
});

// Exporting the custom domain name and hostname configuration ID.
export const customDomainOutput = customDomain.domainName;
export const hostnameConfigurationId = gatewayHostnameConfiguration.id;
```

This code should be placed in a TypeScript file, such as `index.ts`, within your Pulumi project. Make sure to replace placeholder values with those specific to your Azure environment, like the resource group name, API Management service name, custom domain, and Key Vault secret ID.

Once this program is in place and the `pulumi up` command is called, Pulumi will create or update the necessary Azure API Management service configurations for custom domains and ensure that HTTP traffic is redirected to HTTPS.

Keep in mind that before running this program, you must have the Pulumi CLI installed, be logged in, and have a valid Azure subscription set up. Additionally, ensure that you have the necessary permissions to create and manage resources within Azure API Management and Key Vault services.