快速入門:使用 PowerShell 建立新的 Azure APIM 執行個體

適用於:取用 |開發人員 |基本 |標準 |進階版

在此快速入門中,您會使用 Azure PowerShell Cmdlet 建立新的 Azure API 管理執行個體。 建立執行個體後,您可以使用 Azure PowerShell Cmdlet 來執行常見的管理動作,例如在 APIM 執行個體中匯入 API。

Azure APIM 可協助組織將 API 發佈給外部、合作夥伴及內部開發人員,以發揮其資料與服務的潛力。 「API 管理」提供的核心專長認證,透過開發人員參與、商務洞察力、分析、安全性和保護,可確保 API 程式獲致成功。 APIM 可讓您為裝載於任何位置的現有後端服務,建立和管理新式 API 閘道。

如果您沒有 Azure 訂閱,請在開始之前,先建立 Azure 免費帳戶

必要條件

建立資源群組

使用 New-AzResourceGroup 來建立 Azure 資源群組。 資源群組是在其中部署與管理 Azure 資源的邏輯容器。

下列命令會在美國西部地區建立名為 myResourceGroup 的資源群組:

New-AzResourceGroup -Name myResourceGroup -Location WestUS

建立 API 管理執行個體

現在您已有資源群組,您可以接著建立 APIM 服務執行個體。 使用 New-AzApiManagement 建立執行個體,並提供服務名稱和發行者詳細資料。 服務名稱必須是 Azure 中唯一的。

在下列範例中,服務名稱會使用 myapim。 將名稱更新為唯一值。 也請更新 API 發行者的組織名稱,以及用來接收通知的系統管理員電子郵件地址。

根據預設,此命令會在開發人員層中建立執行個體,以此經濟實惠的選項評估 Azure APIM。 此階層不適用於生產環境。 如需 API 管理層級的詳細資訊,請參閱 Azure API 管理層的功能式比較

提示

此為長時間執行的事件。 這可能需要 30 到 40 分鐘的時間,才能在此階層中建立及啟用 APIM 服務。

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

當命令傳回時,請執行 Get-AzApiManagement 來檢視 Azure APIM 服務的屬性。 啟用後,ProvisioningState 為 Succeeded (已成功),且執行個體具有數個相關聯的 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

部署您的 APIM 服務執行個體之後,您就可以開始使用了。 從匯入和發佈第一個 API 教學課程開始。

清除資源

當不再需要時,您可以使用 Remove-AzResourceGroup 命令來移除資源群組和所有相關資源。

Remove-AzResourceGroup -Name myResourceGroup

下一步