Using 和 using none 陳述式

所有 Bicep 參數檔案都必須包含 using 或 using none 宣告。

Bicep 參數檔通常使用using語句將檔案連結到 Bicep 檔案、JSON Azure Resource Manager 範本(ARM 範本)、Bicep 模組或範本規範。這種連結使 Bicep 語言伺服器與編譯器能根據範本輸入檢查正確的名稱、型別及所需值來驗證參數檔案。

相較之下,該 using none 陳述明確表示參數檔在編譯時並未連結到任何特定範本。 此聲明表示參數不會針對特定範本驗證,而是供更廣泛的使用,例如被外部工具消耗或作為共享且可重用的參數集。

附註

Bicep 參數檔案僅支援 Bicep CLI 0.18.4 版或更新版本、 Azure CLI 2.47.0 版或更新版本,以及 Azure PowerShell 9.7.1 版或更新版本。 using none Bicep CLI 0.31.0 版或更新版本支援此功能。

若要搭配 JSON ARM 範本、Bicep 模組和範本規格使用 語句,您必須擁有 Bicep CLI 0.22.6 版或更新版本,以及 Azure CLI 2.53.0 版或更新版本。

using 陳述式

語句的 using 語法:

  • 若要使用 Bicep 檔案:

    using '<path>/<file-name>.bicep'
    
  • 若要使用 JSON ARM 範本:

    using '<path>/<file-name>.json'
    
  • 若要使用公用模組:

    using 'br/public:<file-path>:<tag>'
    

    例如:

    using 'br/public:avm/res/storage/storage-account:0.9.0' 
    
    param name = 'mystorage'
    
  • 若要使用私人模組:

    using 'br:<acr-name>.azurecr.io/bicep/<file-path>:<tag>'
    

    例如:

    using 'br:myacr.azurecr.io/bicep/modules/storage:v1'
    

    若要使用具有在 bicepconfig.json 檔案中定義的別名的私人模組:

    using 'br/<alias>:<file>:<tag>'
    

    例如:

    using 'br/storageModule:storage:v1'
    
  • 若要使用範本規格:

    using 'ts:<subscription-id>/<resource-group-name>/<template-spec-name>:<tag>
    

    例如:

    using 'ts:00000000-0000-0000-0000-000000000000/myResourceGroup/storageSpec:1.0'
    

    若要使用具有在 bicepconfig.json 檔案中定義的別名的範本規格:

    using 'ts/<alias>:<template-spec-name>:<tag>'
    

    例如:

    using 'ts/myStorage:storageSpec:1.0'
    

using none 陳述式

Bicep 參數檔 (.bicepparam) 中的 using none 陳述式表示該檔案在製作或編譯期間不會與特定的 Bicep 範本繫結。 此陳述將參數檔案與特定範本解耦,使你在不同部署間定義與使用參數時更具彈性。

語句的 using none 語法:

using none

將此陳述放在 Bicep 參數檔的開頭,表示沒有參考特定範本。

Bicep 中 using none 的主要優點在於參數檔一般化、共用或與範本動態整合的案例中。 常見的使用案例包括:

  • 集中式參數存放庫

    組織通常會維護標準參數值,例如預設區域、命名慣例或全域標籤,這些值會在多個 Bicep 部署中使用。 一個包含 的 using none Bicep 參數檔可作為這些共享值的中央儲存,提升一致性並減少重複。 你可以在部署時以程式方式將這些參數與範本特定的值合併。

    例如,共用的 Bicep 參數檔案可能會定義:

    using none
    
    param location = 'westus2'
    param environmentTag = 'production'
    param projectName = 'myApp'
    

    此外,你也可以擴充這個參數檔案。 欲了解更多資訊,請參閱 Extend 參數檔案。

  • 動態生成和運行時整合

    在 CI/CD 管線或自動化腳本中,你可以即時建立參數檔案,或在執行時將它們與範本關聯。 藉由省略固定範本參考, using none 可讓這些檔案保持彈性且可適應不同的部署內容。

當你在 Bicep 參數檔中指定using none時,編譯器不會根據特定的 Bicep 範本驗證參數。 這表示編譯器不會因名稱或型別不符而產生任何編譯時警告或錯誤,因為缺少連結範本。 然而,這種解耦僅適用於撰寫與編譯時。 部署時,Azure Resource Manager(ARM)仍需 Bicep 範本和參數檔案。 ARM 引擎會針對目標範本中定義的參數解析檔案中的參數,在部署期間執行驗證。

後續步驟