快速入门：使用 Bicep 创建新的 Azure API 管理实例

适用于：所有 API 管理层级

本快速入门介绍如何使用 Bicep 文件来创建 Azure API 管理实例。 你还可以使用 Bicep 执行常见管理任务，例如在 API 管理实例中导入 API。

Azure API 管理可帮助组织将 API 发布给外部、合作伙伴和内部开发人员，以充分发挥其数据和服务的潜力。 API 管理通过开发人员参与、商业洞察力、分析、安全性和保护提供了核心竞争力以确保成功的 API 程序。 使用 API 管理，可以为托管在任何位置的现有后端服务创建和管理新式 API 网关。

Bicep 是一种特定于域的语言 (DSL)，使用声明性语法来部署 Azure 资源。 它提供简明的语法、可靠的类型安全性以及对代码重用的支持。 Bicep 会针对你的 Azure 基础结构即代码解决方案提供最佳创作体验。

先决条件

• 如果没有 Azure 订阅，可在开始前创建一个试用帐户。

• 对于 Azure CLI：

  可以使用本地 Azure CLI。

  • 如果需要，请安装 Azure CLI 来运行 CLI 参考命令。

  • 本地 Azure CLI，请了解如何安装 Azure CLI。 如果在 Windows 或 macOS 上运行，请考虑在 Docker 容器中运行 Azure CLI。 有关详细信息，请参阅如何在 Docker 容器中运行 Azure CLI。

    • 通过使用 az login 命令登录到 Azure CLI。 若要完成身份验证过程，请遵循终端中显示的步骤。 有关其他登录选项，请参阅使用 Azure CLI 登录。

    • 出现提示时，请在首次使用时安装 Azure CLI 扩展。 有关扩展详细信息，请参阅使用 Azure CLI 的扩展。

    • 运行 az version 以查找安装的版本和依赖库。 若要升级到最新版本，请运行 az upgrade。

• 对于 Azure PowerShell：

  • 如果选择在本地使用 Azure PowerShell：
    • 安装最新版本的 Az PowerShell 模块。
    • 使用 Connect-AzAccount -Environment AzureChinaCloud cmdlet 连接到 Azure 帐户。

查阅 Bicep 文件

本快速入门中使用的 Bicep 文件来自 Azure 快速入门模板。

@description('The name of the API Management service instance')
param apiManagementServiceName string = 'apiservice${uniqueString(resourceGroup().id)}'

@description('The email address of the owner of the service')
@minLength(1)
param publisherEmail string

@description('The name of the owner of the service')
@minLength(1)
param publisherName string

@description('The pricing tier of this API Management service')
@allowed([
  'Consumption'
  'Developer'
  'Basic'
  'Standard'
  'Premium'
])
param sku string = 'Developer'

@description('The instance size of this API Management service.')
@allowed([
  0
  1
  2
])
param skuCount int = 1

@description('Location for all resources.')
param location string = resourceGroup().location

resource apiManagementService 'Microsoft.ApiManagement/service@2023-05-01-preview' = {
  name: apiManagementServiceName
  location: location
  sku: {
    name: sku
    capacity: skuCount
  }
  properties: {
    publisherEmail: publisherEmail
    publisherName: publisherName
  }
}

Bicep 文件中定义了以下资源：

• Microsoft.ApiManagement/service

在此示例中，Bicep 文件默认在开发人员层级中配置 API 管理实例，这是评估 Azure API 管理的一个经济实惠的选项。 此层不用于生产。

可以在 Azure 快速入门模板中找到更多Azure API Management Bicep 示例。

部署 Bicep 文件

可以使用 Azure CLI 或 Azure PowerShell 部署 Bicep 文件。 有关部署 Bicep 文件的详细信息，请参阅 使用 Azure CLI 部署 Bicep 文件。

1. 将 Bicep 文件保存为 main.bicep 到你的本地计算机上。

2. 使用 Azure CLI 或 Azure PowerShell 来部署该 Bicep 文件。

   将发布者名称和<发布者电子邮件>替换为<组织的名称和电子邮件地址，以接收通知。>

   • CLI
   • PowerShell

   az group create --name exampleRG --location chinanorth
   
   az deployment group create --resource-group exampleRG --template-file main.bicep --parameters publisherEmail=<publisher-email> publisherName=<publisher-name>
   

   部署完成后，应会看到一条指出部署成功的消息。

   提示

   在“开发人员”层中创建和激活 API 管理服务可能需要 30 到 40 分钟。 时间因层级而异。

查看已部署的资源

使用 Azure 门户、Azure CLI 或 Azure PowerShell 列出资源组中已部署的应用配置资源。

az resource list --resource-group exampleRG

Get-AzResource -ResourceGroupName exampleRG

当 API 管理服务实例处于联机状态时，便可以使用它了。 从教程开始导入并发布您的第一个 API。

清理资源

如果打算继续使用后续的教程，你可能需要保留 API 管理实例。 如果不再需要资源组，可以将其删除，这将删除资源组中的资源。

az group delete --name exampleRG

Remove-AzResourceGroup -Name exampleRG

后续步骤