|
| 1 | +--- |
| 2 | +title: Quickstart - Create your Azure API center - ARM template |
| 3 | +description: In this quickstart, use an Azure Resource Manager template to set up an API center for API discovery, reuse, and governance. |
| 4 | +author: dlepow |
| 5 | +ms.service: api-center |
| 6 | +ms.topic: quickstart |
| 7 | +ms.date: 05/02/2024 |
| 8 | +ms.author: danlep |
| 9 | +--- |
| 10 | + |
| 11 | +# Quickstart: Create your API center - ARM template |
| 12 | + |
| 13 | +[!INCLUDE [quickstart-intro](includes/quickstart-intro.md)] |
| 14 | + |
| 15 | +[!INCLUDE [resource-manager-quickstart-introduction](../../includes/resource-manager-quickstart-introduction.md)] |
| 16 | + |
| 17 | +If your environment meets the prerequisites and you're familiar with using ARM templates, select the **Deploy to Azure** button. The template will open in the Azure portal. |
| 18 | + |
| 19 | +:::image type="content" source="../media/template-deployments/deploy-to-azure.svg" alt-text="Screenshot of the Deploy to Azure button to deploy resources with a template." link="https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fazure-quickstart-templates%2Fmaster%2Fquickstarts%2Fmicrosoft.apicenter%2Fazure-api-center-create%2Fazuredeploy.json>"::: |
| 20 | + |
| 21 | + |
| 22 | +[!INCLUDE [quickstart-prerequisites](includes/quickstart-prerequisites.md)] |
| 23 | + |
| 24 | +* For Azure CLI: |
| 25 | + [!INCLUDE [include](~/reusable-content/azure-cli/azure-cli-prepare-your-environment-no-header.md)] |
| 26 | + |
| 27 | +* For Azure PowerShell: |
| 28 | + [!INCLUDE [azure-powershell-requirements-no-header.md](../../includes/azure-powershell-requirements-no-header.md)] |
| 29 | + |
| 30 | +## Review the template |
| 31 | + |
| 32 | +The template used in this quickstart is from [Azure Quickstart Templates](https://azure.microsoft.com/resources/templates/<templateName>). |
| 33 | + |
| 34 | +:::code language="json" source="~/quickstart-templates/quickstarts/microsoft.apicenter/azure-api-center-create/azuredeploy.json"::: |
| 35 | + |
| 36 | +The following Azure resources are defined in the template: |
| 37 | + |
| 38 | +* [Microsoft.ApiCenter/services](/azure/templates/microsoft.apicenter/services) |
| 39 | +* [Microsoft.ApiCenter/services/workspaces](/azure/templates/microsoft.apicenter/services/workspaces) |
| 40 | +* [Microsoft.ApiCenter/services/workspaces/apis](/azure/templates/microsoft.apicenter/services/workspaces/apis) |
| 41 | + |
| 42 | +In this example, the template creates an API center in the Free plan and registers a sample API in the default workspace. |
| 43 | + |
| 44 | +## Deploy the template |
| 45 | + |
| 46 | +Deploy the template using any standard method for [deploying an ARM template](../azure-resource-manager/templates/deploy-cli.md) such as the following examples using Azure CLI and PowerShell. |
| 47 | + |
| 48 | +1. Save the template file as **azuredeploy.json** to your local computer. |
| 49 | +1. Deploy the template using either Azure CLI or Azure PowerShell. |
| 50 | + |
| 51 | + # [CLI](#tab/CLI) |
| 52 | + |
| 53 | + ```azurecli |
| 54 | + # Create a resource group in one of the supported regions for Azure API Center |
| 55 | + |
| 56 | + az group create --name exampleRG --location eastus |
| 57 | +
|
| 58 | + az deployment group create --resource-group exampleRG --template-file azuredeploy.json --parameters apiName="<api-name>" apiType="<api-type>" |
| 59 | + ``` |
| 60 | +
|
| 61 | + # [PowerShell](#tab/PowerShell) |
| 62 | +
|
| 63 | + ```azurepowershell |
| 64 | + # Create a resource group in one of the supported regions for Azure API Center |
| 65 | +
|
| 66 | + New-AzResourceGroup -Name exampleRG -Location eastus |
| 67 | +
|
| 68 | + New-AzResourceGroupDeployment -ResourceGroupName exampleRG -TemplateFile ./azuredeploy.json -apiName "<api-name>" -apiType "<api-type>" |
| 69 | + ``` |
| 70 | + --- |
| 71 | +
|
| 72 | +Replace **\<api-name\>** and **\<api-type\>** with the name and type of an API that you want to register in your API center. |
| 73 | +
|
| 74 | +When the deployment finishes, you should see a message indicating the deployment succeeded. |
| 75 | +
|
| 76 | +## Review deployed resources |
| 77 | +
|
| 78 | +Use the Azure portal to check the deployed resources, or use tools such as the Azure CLI or Azure PowerShell to list the deployed resources. |
| 79 | +
|
| 80 | +1. In the [Azure portal](https://portal.azure.com), search for and select **API Centers**, and select the API center that you created. |
| 81 | +1. Review the properties of your service on the **Overview** page. |
| 82 | +1. In the left menu, under **Assets**, select **APIs** to see the API that you registered in the default workspace. |
| 83 | +
|
| 84 | +[!INCLUDE [quickstart-next-steps](includes/quickstart-next-steps.md)] |
0 commit comments