使用英语阅读

通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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

  • 2025/05/20

适用于：消耗 | 开发人员 | 基本 | 标准 | 高级

在本快速入门中，你将使用 Azure PowerShell cmdlet 创建新的 API 管理实例。 创建实例后，可以使用 Azure PowerShell cmdlet 执行常见管理作，例如在 API 管理实例中导入 API。

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

如果没有 Azure 帐户，请在开始前创建一个免费帐户。

先决条件

创建资源组

使用 New-AzResourceGroup 创建 Azure 资源组。 资源组是在其中部署和管理 Azure 资源的逻辑容器。

以下命令在“美国西部”位置创建名为 myResourceGroup 的资源组：

New-AzResourceGroup -Name myResourceGroup -Location WestUS

创建 API 管理实例

拥有资源组后，可以创建 API 管理服务实例。 使用 New-AzApiManagement 创建一个，并提供服务名称和发布者详细信息。 服务名称在 Azure 中必须是唯一的。

在以下示例中， myapim 用于服务名称。 将名称更新为唯一值。 此外，请更新 API 发布者和管理员电子邮件地址的组织名称，以接收通知。

默认情况下，该命令在开发人员层中创建实例，这是评估 Azure API 管理的经济选项。 此层不用于生产。 有关 API 管理层的详细信息，请参阅 Azure API 管理层的基于功能的比较。

提示

这是一个长时间运行的操作。 创建和激活此层中的 API 管理服务可能需要 30 到 40 分钟。

New-AzApiManagement -Name "myapim" -ResourceGroupName "myResourceGroup" `
  -Location "West US" -Organization "Contoso" -AdminEmail "admin@contoso.com"

命令返回时，运行 Get-AzApiManagement 以查看 Azure API 管理服务的属性。 激活后，ProvisioningState 被标记为“成功”，且该实例有多个相关联的 URL。 例如：

Get-AzApiManagement -Name "myapim" -ResourceGroupName "myResourceGroup"

示例输出：

PublicIPAddresses                     : {203.0.113.1}
PrivateIPAddresses                    :
Id                                    : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ApiManagement/service/myapim
Name                                  : myapim
Location                              : West US
Sku                                   : Developer
Capacity                              : 1
CreatedTimeUtc                        : 9/9/2022 9:07:43 PM
ProvisioningState                     : Succeeded
RuntimeUrl                            : https://myapim.azure-api.net
RuntimeRegionalUrl                    : https://myapi-westus-01.regional.azure-api.net
PortalUrl                             : https://myapim.portal.azure-api.net
DeveloperPortalUrl                    : https://myapim.developer.azure-api.net
ManagementApiUrl                      : https://myapim.management.azure-api.net
ScmUrl                                : https://myapim.scm.azure-api.net
PublisherEmail                        : admin@contoso.com
OrganizationName                      : Contoso
NotificationSenderEmail               : apimgmt-noreply@mail.windowsazure.com
VirtualNetwork                        :
VpnType                               : None
PortalCustomHostnameConfiguration     :
ProxyCustomHostnameConfiguration      : {myapim.azure-api.net}
ManagementCustomHostnameConfiguration :
ScmCustomHostnameConfiguration        :
DeveloperPortalHostnameConfiguration  :
SystemCertificates                    :
Tags                                  : {}
AdditionalRegions                     : {}
SslSetting                            : Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSslSetting
Identity                              :
EnableClientCertificate               :
EnableClientCertificate               :
Zone                                  :
DisableGateway                        : False
MinimalControlPlaneApiVersion         :
PublicIpAddressId                     :
PlatformVersion                       : stv2
PublicNetworkAccess                   : Enabled
PrivateEndpointConnections            :
ResourceGroupName                     : myResourceGroup

部署 API 管理服务实例后，即可使用它。 从导入并发布第一个 API 教程开始。

清理资源

不再需要时，可以使用 Remove-AzResourceGroup 命令删除资源组和所有相关资源。

Remove-AzResourceGroup -Name myResourceGroup

后续步骤

导入和发布第一个 API

其他资源

文档