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

适用于:所有 API 管理层级

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

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

Bicep 是一种特定于域的语言 (DSL),使用声明性语法来部署 Azure 资源。 它提供简明的语法、可靠的类型安全性以及对代码重用的支持。 Bicep 会针对你的 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@2022-08-01' = {
  name: apiManagementServiceName
  location: location
  sku: {
    name: sku
    capacity: skuCount
  }
  properties: {
    publisherEmail: publisherEmail
    publisherName: publisherName
  }
}

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

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

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

部署 Bicep 文件

可以使用 Azure CLI 或 Azure PowerShell 部署 Bicep 文件。 若要详细了解如何部署 Bicep 文件,请参阅部署

  1. 将该 Bicep 文件另存为本地计算机上的 main.bicep。

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

    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>
    

    将 <publisher-name> 和 <publisher-email> 替换为 API 发布者组织的名称以及用于接收通知的电子邮件地址。

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

    提示

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

查看已部署的资源

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

az resource list --resource-group exampleRG

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

清理资源

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

az group delete --name exampleRG

后续步骤