教學課程:利用 ARM 範本參考

了解如何尋找範本結構描述資訊,以及使用此資訊來建立 Azure Resource Manager 範本 (ARM 範本)。

在本教學課程中,您會使用 Azure 快速入門範本中的基底範本。 您可使用範本參考文件來驗證範本。

Resource Manager template reference deploy storage account

本教學課程涵蓋下列工作:

  • 開啟快速入門範本
  • 了解範本
  • 尋找範本參考
  • 編輯範本
  • 部署範本

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

必要條件

若要完成本文,您需要:

開啟快速入門範本

Azure 快速入門範本是 ARM 範本的存放庫。 您可以尋找範例範本並加以自訂,而不要從頭建立範本。 本快速入門中使用的範本名為建立標準儲存體帳戶。 此範本會定義 Azure 儲存體帳戶資源。

  1. 在 Visual Studio Code 中,選取 [檔案]>[開啟檔案]

  2. 在 [檔案名稱] 中,貼上下列 URL:

    https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/quickstarts/microsoft.storage/storage-account-create/azuredeploy.json
    
  3. 選取 [開啟] 以開啟檔案。

  4. 選取 [檔案]>[另存新檔],在您的本機電腦上將檔案另存為 azuredeploy.json

了解結構描述

  1. 在 Visual Studio Code 中,將範本摺疊至根層級。 此時會有最簡單的結構,內含下列元素:

    Resource Manager template simplest structure

    • $schema:指定說明範本語言版本的 JSON 結構描述檔案所在位置。
    • contentVersion:為此元素指定任何值,用以記錄範本中的重大變更。
    • metadata:指定範本的中繼資料。
    • parameters:指定執行部署以自訂資源部署時所提供的值。
    • variables:指定範本中作為 JSON 片段以簡化範本語言運算式的值。 此範本未包括此元素。
    • resources:指定在資源群組中部署或更新的資源類型。
    • outputs:指定部署後傳回的值。
  2. 展開 resources。 出現已定義的 Microsoft.Storage/storageAccounts 資源。 螢幕擷取畫面中顯示的 API 版本為 2022-09-01。 SKU 名稱會使用參數值。 參數稱為 storageAccountType

    Resource Manager template storage account definition

  3. 展開 parameters 以查看 storageAccountType 的定義。 參數有 8 個允許的值。 Resource Manager template storage account resources skus

您可以使用範本參考,找出您是否使用最新的 API 版本,以及參數定義是否包括所有允許的值。

尋找範本參考

  1. 瀏覽至Azure 範本參考

  2. 在 [依標題篩選] 方塊中,輸入儲存體帳戶,然後選取 [參考] > [儲存體] 底下的第一個 [儲存體帳戶]

    Resource Manager template reference storage account

  3. 選取 [ARM 範本]

  4. 資源類型通常有數個 API 版本。 此頁面預設會顯示最新的範本結構描述版本。 選取 [最新] 的下拉式清單方塊以查看版本。 螢幕擷取畫面中顯示的最新版本為 2022-09-01。 選取 [最新] 或 [最新] 下方的版本,以查看最新版本。 請確定此版本符合在範本中用於儲存體帳戶資源的版本。 如果您更新 API 版本,請確認資源定義符合範本參考。

    Resource Manager template reference storage account versions

  5. 此頁面會列出 storageAccount 資源類型的詳細資料。 例如,其會列出 Sku 物件的允許值。 這裡有 8 個 SKU,其符合您稍早開啟的快速入門範本中所列出的 SKU。

    Resource Manager template reference storage account skus

部署範本

  1. 登入 Azure Cloud Shell

  2. 藉由選取左上角的 PowerShellBash (適用於 CLI) 來選擇您慣用的環境。 切換時必須重新啟動殼層。

    Azure portal Cloud Shell upload file

  3. 選取 [上傳/下載檔案],然後選取 [上傳]。 請參閱上一個螢幕擷取畫面。 選取您在前一節中儲存的檔案。 上傳檔案之後,您可以使用 ls 命令和 cat 命令來確認檔案是否已成功上傳。

  4. 從 Cloud Shell 執行下列命令。 選取要顯示 PowerShell 程式碼或 CLI 程式碼的索引標籤。

    當您部署範本時,請使用新增的值來指定 storageAccountType 參數,例如 Standard_RAGRS。 如果您使用原始快速入門範本,部署將會失敗,因為 Standard_RAGRS 不是允許的值。

    echo "Enter a project name that is used to generate resource group name:" &&
    read projectName &&
    echo "Enter the location (i.e. centralus):" &&
    read location &&
    resourceGroupName="${projectName}rg" &&
    az group create --name $resourceGroupName --location "$location" &&
    az deployment group create --resource-group $resourceGroupName --template-file "$HOME/azuredeploy.json" --parameters storageAccountType='Standard_RAGRS'
    

清除資源

不再需要 Azure 資源時,可藉由刪除資源群組來清除您所部署的資源。

  1. 在 Azure 入口網站中,選取左側功能表中的 [資源群組]
  2. 在 [依名稱篩選] 欄位中輸入資源群組名稱。
  3. 選取資源群組名稱。 您在資源群組中應該會看到共計六個資源。
  4. 從頂端功能表中選取 [刪除資源群組]

下一步

在本教學課程中,您已了解如何使用範本參考來自訂現有的範本。 若要了解如何建立多個儲存體帳戶執行個體,請參閱: