透過參數建立動態藍圖

發行項
09/22/2023

重要

在 2026 年 7 月 11 日，藍圖 (預覽) 將會淘汰。將現有的藍圖定義和指派移轉至範本規格和部署堆疊。藍圖成品會轉換成用來定義部署堆疊的 ARM JSON 範本或 Bicep 檔案。若要了解如何將成品撰寫為 ARM 資源，請參閱：

以各種成品 (例如，資源群組、Azure Resource Manager 範本 (ARM 範本)、原則或角色指派) 完整定義的藍圖，可讓您在 Azure 內快速又一致建立物件。為了能夠彈性使用這些可重複使用的設計模式與容器，Azure 藍圖支援參數。參數會在定義與指派期間建立彈性，以變更藍圖所部署成品上的屬性。

資源群組成品即為一個簡單的範例。建立資源群組時，必須提供兩個必要的值：名稱與位置。將資源群組新增至藍圖時，如果參數不存在，則每次使用藍圖時都需要定義該名稱和位置。此種重複導致每次使用藍圖時，就會在相同資源群組中建立成品。該資源群組內的群組會變成重複且導致衝突。

注意

對於兩個不同的藍圖來說，包含相同名稱的資源群組並不會造成任何問題。如果藍圖內含的資源群組已經存在，則藍圖會繼續在該資源群組中建立相關成品。這可能導致衝突，因為具有相同名稱與資源類型的兩個資源不能存在於一個訂用帳戶內。

這個問題的解決方式為參數。 Azure 藍圖可讓您在指派給訂用帳戶期間，定義值給成品的每個屬性。此參數讓您能夠重複使用藍圖，在單一訂用帳戶中建立資源群組與其他資源，而不會發生衝突。

藍圖參數

透過 REST API，可以在藍圖本身建立參數。這些參數與每個支援的成品上的參數不同。在藍圖上建立參數時，可透過該藍圖中的成品使用該參數。用來為資源群組命名的前置詞即為範例之一。成品可以使用藍圖參數來建立「主要動態」參數。由於此參數也可以在指派期間內定義，所以此模式會考量到遵守命名規則的一致性。如需步驟，請參閱設定靜態參數 - 藍圖層級參數。

使用 secureString 與 secureObject 參數

雖然 ARM 範本「成品」支援 secureString 和 secureObject 類型的參數，但 Azure 藍圖要求每個成品都與 Azure Key Vault 相連結。此安全性措施可防止將祕密與藍圖儲存在一起的這種不安全做法，並鼓勵採用安全模式。 Azure 藍圖支援此種安全性措施，以偵測 ARM 範本「成品」中是否包含任一個安全參數。服務接著會在指派期間，針對每個偵測到的安全參數提示下列 Key Vault 屬性：

Key Vault 資源識別碼
Key Vault 祕密名稱
Key Vault 祕密版本

如果藍圖指派使用系統指派的受控識別，則參考的 Key Vault「必須」存在於指派藍圖定義的同一個訂用帳戶中。

如果藍圖指派使用使用者指派的受控識別，則參考的 Key Vault「可以」存在於集中式訂用帳戶中。在藍圖指派之前，必須將 Key Vault 的適當權限授與受控識別。

重要

在這兩種情況下，Key Vault 必須在 [存取原則] 頁面上設定 [為範本部署啟用對 Azure Resource Manager 的存取]。如需如何啟用此功能的相關指示，請參閱 Key Vault - 啟用範本部署。

如需 Azure Key Vault 的詳細資訊，請參閱 Azure Key Vault 概觀。

參數型別

靜態參數

藍圖定義中所定義的參數值稱為靜態參數，因為每次使用藍圖時都會使用該靜態值來部署成品。在資源群組範例中，雖然這對資源群組名稱不具任何意義，但它對位置來說可能是有意義的。接著，每個藍圖指派都會在相同的位置建立資源群組，而無論指派期間是否會呼叫它。此彈性可讓您選擇要視需要定義哪些內容，以及可在指派期間變更哪些內容。

在入口網站中設定靜態參數

在左側窗格中選取 [所有服務]。搜尋並選取 [藍圖]。
在頁面左側選取 [藍圖定義]。
選取現有的藍圖，然後選取 [編輯藍圖]，「或」選取 [+ 建立藍圖]，並在 [基本] 索引標籤上填寫資訊。
選取 [下一步：成品]，「或」選取 [成品] 索引標籤。
新增到具有參數選項之藍圖的成品會在 [參數] 欄中顯示 [已填入 X 個參數 (共 Y 個)]。選取成品列來編輯成品參數。
[編輯成品] 頁面顯示所選取的成品適合的值選項。成品中的每個參數都有標題、值方塊與核取方塊。將此方塊設定為未選取狀態，以使其成為靜態參數。在下列範例中，只有「位置」是靜態參數，因為未勾選，而「資源群組名稱」已勾選。

從 REST API 設定靜態參數

在每個 REST API URI 中有一些變數，需要您以自己的值取代它們：

{YourMG} - 以您的管理群組名稱取代
{subscriptionId} - 以您的訂用帳戶識別碼取代

藍圖層級參數

透過 REST API 建立藍圖時，就能夠建立藍圖參數。若要這樣做，請使用下列 REST API URI 與主體格式：

REST API URI

PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/{YourMG}/providers/Microsoft.Blueprint/blueprints/MyBlueprint?api-version=2018-11-01-preview

要求本文

{
    "properties": {
        "description": "This blueprint has blueprint level parameters.",
        "targetScope": "subscription",
        "parameters": {
            "owners": {
                "type": "array",
                "metadata": {
                    "description": "List of AAD object IDs that is assigned Owner role at the resource group"
                }
            }
        },
        "resourceGroups": {
            "storageRG": {
                "description": "Contains the resource template deployment and a role assignment."
            }
        }
    }
}

建立藍圖層級參數之後，就能在已新增至該藍圖的成品中使用。下列 REST API 範例會在藍圖上建立角色指派成品，並使用藍圖層級參數。

REST API URI

PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/{YourMG}/providers/Microsoft.Blueprint/blueprints/MyBlueprint/artifacts/roleOwner?api-version=2018-11-01-preview

要求本文

{
    "kind": "roleAssignment",
    "properties": {
        "resourceGroup": "storageRG",
        "roleDefinitionId": "/providers/Microsoft.Authorization/roleDefinitions/8e3af657-a8ff-443c-a75c-2fe8c4bcb635",
        "principalIds": "[parameters('owners')]"
    }
}

在此範例中，principalIds 屬性會利用 [parameters('owners')] 的值來使用擁有者藍圖層級參數。使用藍圖層級參數在成品上設定參數，仍然是一個靜態參數範例。藍圖層級參數無法在藍圖指派期間設定，而且在每個指派上都會是相同的值。

成品層級參數

在成品上建立靜態參數的方式很類似，但會採用直接值，而非使用 parameters() 函式。下列範例會建立兩個靜態參數，亦即 tagName 與 tagValue。每個值都是直接提供的，不會使用函式呼叫。

REST API URI

PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/{YourMG}/providers/Microsoft.Blueprint/blueprints/MyBlueprint/artifacts/policyStorageTags?api-version=2018-11-01-preview

要求本文

{
    "kind": "policyAssignment",
    "properties": {
        "description": "Apply storage tag and the parameter also used by the template to resource groups",
        "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/49c88fc8-6fd1-46fd-a676-f12d1d3a4c71",
        "parameters": {
            "tagName": {
                "value": "StorageType"
            },
            "tagValue": {
                "value": "Premium_LRS"
            }
        }
    }
}

動態參數

靜態參數的相反是動態參數。此參數並未定義於藍圖上，而是改為在藍圖的每個指派期間內定義。在資源群組範例中，動態參數適合用於資源群組名稱。它可為藍圖的每個指派提供不同的名稱。如需藍圖函式的清單，請參閱藍圖函式參考。

在入口網站中設定動態參數

在左側窗格中選取 [所有服務]。搜尋並選取 [藍圖]。
在頁面左側選取 [藍圖定義]。
以滑鼠右鍵按一下您想要指派的藍圖。選取 [指派藍圖]「或」選取您要指派的藍圖，然後使用 [指派藍圖] 按鈕。
在 [指派藍圖] 頁面上，找出 [成品參數] 區段。至少具有一個動態參數的每個成品都會顯示成品與設定選項。指派藍圖之前，請先為參數提供所需的值。在下列範例中，「名稱」是完成藍圖指派所必須定義的動態參數。

從 REST API 設定動態參數

在指派期間設定動態參數，可透過直接輸入值來完成。提供的值即為適當字串，不必使用函式 (例如 parameters())。資源群組的成品是使用「範本名稱」與名稱和位置屬性來定義。內含成品的所有其他參數都定義在 parameters 之下，並具備 <name> 和 value 金鑰組。如果已針對指派期間未提供的動態參數設定藍圖，指派將會失敗。

REST API URI

PUT https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Blueprint/blueprintAssignments/assignMyBlueprint?api-version=2018-11-01-preview

要求本文

{
    "properties": {
        "blueprintId": "/providers/Microsoft.Management/managementGroups/{YourMG}  /providers/Microsoft.Blueprint/blueprints/MyBlueprint",
        "resourceGroups": {
            "storageRG": {
                "name": "StorageAccount",
                "location": "eastus2"
            }
        },
        "parameters": {
            "storageAccountType": {
                "value": "Standard_GRS"
            },
            "tagName": {
                "value": "CostCenter"
            },
            "tagValue": {
                "value": "ContosoIT"
            },
            "contributors": {
                "value": [
                    "7be2f100-3af5-4c15-bcb7-27ee43784a1f",
                    "38833b56-194d-420b-90ce-cff578296714"
                ]
              },
            "owners": {
                "value": [
                    "44254d2b-a0c7-405f-959c-f829ee31c2e7",
                    "316deb5f-7187-4512-9dd4-21e7798b0ef9"
                ]
            }
        }
    },
    "identity": {
        "type": "systemAssigned"
    },
    "location": "westus"
}

下一步

請參閱藍圖函式的清單。
了解藍圖生命週期。
了解如何自訂藍圖排序順序。
了解如何使用藍圖資源鎖定。
了解如何更新現有的指派。
使用一般疑難排解來解決藍圖指派期間發生的問題。

共用方式為

透過參數建立動態藍圖

藍圖參數

使用 secureString 與 secureObject 參數

參數型別

靜態參數

在入口網站中設定靜態參數

從 REST API 設定靜態參數

藍圖層級參數

成品層級參數

動態參數

在入口網站中設定動態參數

從 REST API 設定動態參數

下一步

意見反應

其他資源