適用於:消費 | 開發人員 | 基本 | 標準 | 進階
本快速入門說明使用 Azure CLI 命令建立新 API 管理實例的步驟。 建立實例之後,您可以使用 Azure CLI 來執行常見的管理工作,例如在 API 管理實例中匯入 API。
Azure API 管理 可協助組織將 API 發布至外部、合作夥伴和內部開發人員,以釋放其數據和服務的潛力。 「API 管理」提供的核心專長認證,透過開發人員參與、商務洞察力、分析、安全性和保護,可確保 API 程式獲致成功。 透過 APIM,為裝載於任何位置的現有後端服務,建立和管理新式 API 閘道。
如果您沒有 Azure 帳戶,請在開始之前建立 免費帳戶 。
先決條件
在 Azure Cloud Shell 中使用 Bash 環境。 如需詳細資訊,請參閱開始使用 Azure Cloud Shell。
若要在本地執行 CLI 參考命令,請安裝 Azure CLI。 如果您正在 Windows 或 macOS 上執行,請考慮在 Docker 容器中執行 Azure CLI。 如需詳細資訊,請參閱〈如何在 Docker 容器中執行 Azure CLI〉。
如果您使用的是本機安裝,請使用 az login 命令,透過 Azure CLI 來登入。 若要完成驗證程式,請遵循終端機中顯示的步驟。 如需其他登入選項,請參閱 使用 Azure CLI 向 Azure 進行驗證。
出現提示時,請在第一次使用時安裝 Azure CLI 延伸模組。 如需擴充功能的詳細資訊,請參閱 使用和管理 Azure CLI 的擴充功能。
執行 az version 以尋找已安裝的版本和相依程式庫。 若要升級至最新版本,請執行 az upgrade。
- 本文需要 Azure CLI 2.11.1 版或更新版本。 如果使用 Azure Cloud Shell,則已安裝最新版本。
建立資源群組
Azure API 管理實例,例如所有 Azure 資源,都必須部署到資源群組中。 資源群組可讓您組織和管理相關的 Azure 資源。
首先,使用下列 az group create 命令,在美國中部位置中建立名為 myResourceGroup 的資源群組:
az group create --name myResourceGroup --location centralus
建立 API 管理實例
現在您已擁有資源群組,您可以建立 API 管理實例。 使用 az apim create 命令建立一個資源,並提供服務名稱和發佈者詳細資訊。 服務名稱在 Azure 內必須是唯一的。
在下列範例中, myapim 會用於服務名稱。 將名稱更新為唯一值。 同時更新 API 發行者組織的名稱,以及接收通知的電子郵件位址。
az apim create --name myapim --resource-group myResourceGroup \
--publisher-name Contoso --publisher-email admin@contoso.com \
--no-wait
根據預設,命令會在開發人員層中建立實例,這是評估 Azure API 管理的經濟選項。 此層不適用於生產用途。 如需調整 API 管理層的詳細資訊,請參閱 升級和調整。
小提示
建立並啟動此層中的 API 管理服務可能需要 30 到 40 分鐘的時間。 上一個命令會使用 --no-wait
選項,讓命令在建立服務時立即傳回。
執行 az apim show 命令來檢查部署的狀態:
az apim show --name myapim --resource-group myResourceGroup --output table
一開始,輸出會類似下列內容,其中顯示 Activating
狀態:
NAME RESOURCE GROUP LOCATION GATEWAY ADDR PUBLIC IP PRIVATE IP STATUS TIER UNITS
----------- ---------------- ---------- -------------- ----------- ------------ ---------- --------- -------
myapim myResourceGroup Central US Activating Developer 1
啟用之後,狀態為 Online
,且服務實例具有閘道地址和公用IP位址。 目前,這些位址不會公開任何內容。 例如:
NAME RESOURCE GROUP LOCATION GATEWAY ADDR PUBLIC IP PRIVATE IP STATUS TIER UNITS
----------- ---------------- ---------- --------------------------------- ------------ ------------ -------- --------- -------
myapim myResourceGroup Central US https://myapim.azure-api.net 203.0.113.1 Online Developer 1
當您的 API 管理服務實例上線時,您就可以使用它。 從教程開始 ,匯入並發佈您的第一個 API。
清理資源
您可以使用 az group delete 命令,在不需要資源群組和 API 管理服務實例時移除它們。
az group delete --name myResourceGroup