共用方式為


快速入門:使用 ARM 範本建立新的 Azure APIM 服務執行個體

適用於:所有 APIM 層

此快速入門描述如何使用 Azure Resource Manager 範本 (ARM 範本) 來建立 Azure APIM 執行個體。 您也可以使用 ARM 範本來執行常見的管理工作,例如,在 APIM 執行個體中匯入 API。

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

Azure Resource Manager 範本是一個 JavaScript 物件標記法 (JSON) 檔案,會定義專案的基礎結構和設定。 範本使用宣告式語法。 您可以描述預期的部署,而不需要撰寫程式設計命令順序來建立部署。

如果您的環境符合必要條件,而且您很熟悉 ARM 範本,請選取 [部署至 Azure] 按鈕。 範本會在 Azure 入口網站中開啟。

將 Resource Manager 範本部署至 Azure 的按鈕。

必要條件

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

檢閱範本

本快速入門中使用的範本是來自 Azure 快速入門範本

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "metadata": {
    "_generator": {
      "name": "bicep",
      "version": "0.26.54.24096",
      "templateHash": "15176578550391235821"
    }
  },
  "parameters": {
    "apiManagementServiceName": {
      "type": "string",
      "defaultValue": "[format('apiservice{0}', uniqueString(resourceGroup().id))]",
      "metadata": {
        "description": "The name of the API Management service instance"
      }
    },
    "publisherEmail": {
      "type": "string",
      "minLength": 1,
      "metadata": {
        "description": "The email address of the owner of the service"
      }
    },
    "publisherName": {
      "type": "string",
      "minLength": 1,
      "metadata": {
        "description": "The name of the owner of the service"
      }
    },
    "sku": {
      "type": "string",
      "defaultValue": "Developer",
      "allowedValues": [
        "Consumption",
        "Developer",
        "Basic",
        "Basicv2",
        "Standard",
        "Standardv2",
        "Premium"
      ],
      "metadata": {
        "description": "The pricing tier of this API Management service"
      }
    },
    "skuCount": {
      "type": "int",
      "defaultValue": 1,
      "allowedValues": [
        0,
        1,
        2
      ],
      "metadata": {
        "description": "The instance size of this API Management service."
      }
    },
    "location": {
      "type": "string",
      "defaultValue": "[resourceGroup().location]",
      "metadata": {
        "description": "Location for all resources."
      }
    }
  },
  "resources": [
    {
      "type": "Microsoft.ApiManagement/service",
      "apiVersion": "2023-05-01-preview",
      "name": "[parameters('apiManagementServiceName')]",
      "location": "[parameters('location')]",
      "sku": {
        "name": "[parameters('sku')]",
        "capacity": "[parameters('skuCount')]"
      },
      "properties": {
        "publisherEmail": "[parameters('publisherEmail')]",
        "publisherName": "[parameters('publisherName')]"
      }
    }
  ]
}

範本中已定義下列資源:

Azure 快速入門範本中,可找到更多 Azure API 管理範本範例。

部署範本

  1. 選取以下影像來登入 Azure 並開啟範本。 此範本會建立 API 管理服務執行個體,其具有自動產生的名稱。

    將 Resource Manager 範本部署至 Azure 的按鈕。

    在此範例中,執行個體設定於開發人員層,此經濟實惠的選項用以評估 Azure API 管理。 此階層不適用於生產環境。 如需有關調整 API 管理層規模的詳細資訊,請參閱升級和調整規模

  2. 選取或輸入下列值。

    • 訂用帳戶:選取 Azure 訂用帳戶。
    • 資源群組:選取 [新建],輸入資源群組的唯一名稱,然後選取 [確認]
    • 區域:選取資源群組的位置。 範例:美國中部
    • 發行者電子郵件:輸入電子郵件地址以接收通知。
    • 發行者名稱:輸入您為 API 發行者選擇的名稱。
    • Sku:接受 [開發人員] 的預設值。 或者,選擇另一個值。
    • Sku 計數:接受預設值。
    • 位置:接受針對 API 管理服務產生的位置。

    API 管理 範本屬性

  3. 選取 [檢閱 + 建立],然後檢閱條款及條件。 如果您同意,請選取 [建立]

    提示

    這可能需要 30 到 40 分鐘的時間,才能在開發人員層中建立及啟用 API 管理服務。 時間會依階層而有所不同。

  4. 成功部署執行個體之後,您會收到通知:

    部署通知

Azure 入口網站用於部署範本。 除了 Azure 入口網站,您可以使用 Azure PowerShell、Azure CLI 和 REST API。 若要了解其他部署方法,請參閱部署範本

檢閱已部署的資源

使用 Azure 入口網站來檢查已部署的資源,或使用 Azure CLI 或 Azure PowerShell 之類的工具來列出已部署的資源。

  1. Azure 入口網站中,搜尋並選取 [API 管理服務],然後選取您建立的服務執行個體。
  2. 在 [概觀] 頁面上,檢閱服務的屬性。

服務概觀頁面

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

清除資源

如果您打算繼續進行後續的教學課程,您可以讓 API 管理執行個體留在原處。 如果不再需要,請刪除資源群組,這會刪除資源群組中的資源。

  1. Azure 入口網站中,搜尋並選取 [資源群組]。 您也可以在首頁上選取 [資源群組]

  2. 在 [資源群組] 頁面中,選取您的資源群組。

  3. 在 [資源群組] 頁面中,選取 [刪除資源群組]。

    刪除資源群組

  4. 輸入您的資源群組名稱,然後選取 [刪除]

下一步