Skip to content

Latest commit

 

History

History
75 lines (52 loc) · 3.57 KB

README.md

File metadata and controls

75 lines (52 loc) · 3.57 KB
Raw

Azure API Management - Secure Baseline [Bicep]

This is the Bicep-based deployment guide for Scenario 1: Azure API Management - Secure Baseline.

Prerequisites

This is the starting point for the instructions on deploying this reference implementation. There is required access and tooling you'll need in order to accomplish this.

  • An Azure subscription

  • The following resource providers registered:

    • Microsoft.ApiManagement
    • Microsoft.Network
    • Microsoft.KeyVault

  • The user or service principal initiating the deployment process must have the owner role at the subscription level to have the ability to create resource groups and to delegate access to others (Azure Managed Identities created from the IaC deployment).

  • Access to Bash command line to run the deployment script.

  • Latest Azure CLI installed (must be at least 2.40), or you can perform this from Azure Cloud Shell by clicking below.

    Launch Azure Cloud Shell

  • JQ command line JSON processor installed

    sudo apt-get install jq

Steps

  1. Clone/download this repo locally, or even better fork this repository.

    git clone https://github.com/Azure/apim-landing-zone-accelerator.git
cd apim-landing-zone-accelerator/scenarios/scripts

  2. Log into Azure from the AZ CLI and select your subscription.

    az login

  3. Review and update deployment parameters.

    Copy the sample.env into a new file called .env in the same directory.

    The [**.env**](../../.env) parameter file is where you can customize your deployment. The defaults are a suitable starting point, but feel free to adjust any to fit your requirements.

**Deployment parameters**

| Name  | Description | Default | Example(s) |
| :---- | :---------- | :------ | :--------- |
| `AZURE_LOCATION` | The Azure location to deploy to. | **eastus** | **westus** |
| `RESOURCE_NAME_PREFIX` | A suffix for naming. | **apimdemo** | **appname** |
| `ENVIRONMENT_TAG` | A tag that will be included in the naming. | **dev** | **stage** |
| `APPGATEWAY_FQDN` | The Azure location to deploy to. | **apim.example.com** | **my.org.com** |
| `CERT_TYPE` | selfsigned will create a self-signed certificate for the APPGATEWAY_FQDN. custom will use an existing certificate in pfx format that needs to be available in the [certs](../../certs) folder and named appgw.pfx | **selfsigned** | **custom** |
| `CERT_PWD` | The password for the pfx certificate. Only required if CERT_TYPE is custom. | **N/A** | **password123** |
| `RANDOM_IDENTIFIER` | Optional 3 character random string to ensure deployments are unique. Automatically assigned if not provided | **abc** | **pqr** |

  4. Deploy the reference implementation.

    Run the following command to deploy the APIM baseline

    ./scripts/bicep/deploy-apim-baseline.sh

Test the echo api using the generated command from the output

Troubleshooting

If you see the message -bash: ./deploy-apim-baseline.sh: /bin/bash^M: bad interpreter: No such file or directory when running the script, you can fix this by running the following command:

 sed -i -e 's/\r$//' deploy-apim-baseline.sh