az bicep

Bicep CLI 指令群組。

命令群組可以設定兩個組態，包括bicep.check_version和bicep.use_binary_from_path：

[1] az config set bicep.check_version=True/False 執行 az bicep 指令時Bicep CLI 版本檢查。

[2] az config set bicep.use_binary_from_path=True/False/if_found_in_ci 指定是否使用 PATH Bicep CLI。 預設值為 if_found_in_ci。

命令

名稱 Description 類型 狀態
az bicep build

建立一個Bicep檔案。

 Core GA
az bicep build-params

建置 .bicepparam 檔案。

 Core GA
az bicep decompile

嘗試將 ARM 範本檔案反編譯成 Bicep 檔案。

 Core GA
az bicep decompile-params

將參數 .json 檔案分解為 .bicepparam。

 Core GA
az bicep format

格式化一個 Bicep 檔案。

 Core GA
az bicep generate-params

產生 Bicep 檔案的參數檔案。

 Core GA
az bicep install

安裝 Bicep CLI。

 Core GA
az bicep lint

用棉線貼上Bicep銼刀。

 Core GA
az bicep list-versions

列出所有可用的 Bicep CLI 版本。

 Core GA
az bicep publish

將 bicep 檔案發佈至遠端模組登錄。

 Core GA
az bicep restore

還原 bicep 檔案的外部模組。

 Core GA
az bicep run

將原始指令轉發到已安裝的 Bicep CLI。

 Core GA
az bicep snapshot

擷取或驗證 .bicepparam 檔案預測將部署的資源快照。

 Core GA
az bicep uninstall

移除 Bicep CLI。

 Core GA
az bicep upgrade

將 Bicep CLI 升級到最新版本。

 Core GA
az bicep version

顯示已安裝的 Bicep CLI 版本。

 Core GA

az bicep build

建立一個Bicep檔案。

az bicep build --file
               [--acquire-policy-token]
               [--change-reference]
               [--no-restore]
               [--outdir]
               [--outfile]
               [--stdout]

範例

建立一個Bicep檔案。

az bicep build --file {bicep_file}

建立一個 Bicep 檔案，並將所有輸出列印到 stdout。

az bicep build --file {bicep_file} --stdout

建立一個 Bicep 檔案，並將結果儲存到指定的目錄。

az bicep build --file {bicep_file} --outdir {out_dir}

建立一個 Bicep 檔案，並將結果儲存到指定的檔案中。

az bicep build --file {bicep_file} --outfile {out_file}

建立一個 Bicep 檔案，但不還原外部模組。

az bicep build --file {bicep_file} --no-restore

必要參數

--file -f

這是 Bicep 檔案的路徑，用來建立在檔案系統中。

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性 值
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性 值
參數群組: Global Policy Arguments
--no-restore

設定時，會建置 bicep 檔案，而不還原外部模組。

--outdir

設定時，會將輸出儲存在指定的目錄。

--outfile

設定時，將輸出儲存為指定的檔案路徑。

--stdout

設定時，將所有輸出列印到 stdout，而不是對應的檔案。

全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID 設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False

az bicep build-params

建置 .bicepparam 檔案。

az bicep build-params --file
                      [--acquire-policy-token]
                      [--change-reference]
                      [--no-restore]
                      [--outdir]
                      [--outfile]
                      [--stdout]

範例

建置 .bicepparam 檔案。

az bicep build-params --file {bicepparam_file}

建置 .bicepparam 檔案，並將所有輸出列印到 stdout。

az bicep build-params --file {bicepparam_file} --stdout

建置 .bicepparam 檔案，並將結果儲存至指定的檔案。

az bicep build-params --file {bicepparam_file} --outfile {out_file}

必要參數

--file -f

要建置在文件系統中的 .bicepparam 檔案路徑。

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性 值
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性 值
參數群組: Global Policy Arguments
--no-restore

設定時，會建置 .bicepparam 檔案，而不還原外部模組。

--outdir

設定時，會將輸出儲存在指定的目錄。

--outfile

設定時，將輸出儲存為指定的檔案路徑。

--stdout

設定時，將所有輸出列印到 stdout，而不是對應的檔案。

全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID 設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False

az bicep decompile

嘗試將 ARM 範本檔案反編譯成 Bicep 檔案。

az bicep decompile --file
                   [--acquire-policy-token]
                   [--change-reference]
                   [--force]

範例

將 ARM 範本檔案分解。

az bicep decompile --file {json_template_file}

反編譯一個 ARM 範本檔案並覆寫現有的 Bicep 檔案。

az bicep decompile --file {json_template_file} --force

必要參數

--file -f

要分解文件系統中ARM範本的路徑。

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性 值
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性 值
參數群組: Global Policy Arguments
--force

允許在輸出檔案存在時覆寫輸出檔案。

全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID 設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False

az bicep decompile-params

將參數 .json 檔案分解為 .bicepparam。

az bicep decompile-params --file
                          [--acquire-policy-token]
                          [--bicep-file]
                          [--change-reference]
                          [--force]
                          [--outdir]
                          [--outfile]
                          [--stdout]

範例

嘗試將參數 .json 檔案分解為 .bicepparam。

az bicep decompile-params --file {json_template_file}

嘗試使用指定的 bicep 檔案，將參數 .json 檔案反編譯為 .bicepparam。

az bicep decompile-params --file {json_template_file} --bicep-file {bicep_file}

嘗試將參數反編譯 .json 檔案為 .bicepparam 並覆寫現有輸出。

az bicep decompile-params --file {json_template_file} --force

嘗試將參數 .json 檔案分解為 .bicepparam，並將所有輸出列印到 stdout。

az bicep decompile-params --file {json_template_file} --stdout

嘗試將參數 .json 檔案分解為 .bicepparam，並將所有輸出列印到 stdout，並將結果儲存至指定的目錄。

az bicep decompile-params --file {json_template_file} --outdir {out_dir}

嘗試將參數 .json 檔案分解為 .bicepparam，並將所有輸出列印到 stdout，並將結果儲存至指定的檔案。

az bicep decompile-params --file {json_template_file} --outfile {out_file}

必要參數

--file -f

要建置在文件系統中的參數檔案路徑。

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性 值
參數群組: Global Policy Arguments
--bicep-file

bicep 範本檔案的路徑（相對於 .bicepparam 檔案），將在 using 宣告中參考。

--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性 值
參數群組: Global Policy Arguments
--force

允許在輸出檔案存在時覆寫輸出檔案。

--outdir

設定時，會將輸出儲存在指定的目錄。

--outfile

設定時，將輸出儲存為指定的檔案路徑。

--stdout

設定時，將所有輸出列印到 stdout，而不是對應的檔案。

全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID 設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False

az bicep format

格式化一個 Bicep 檔案。

az bicep format --file
                [--acquire-policy-token]
                [--change-reference]
                [--indent-kind {Space, Tab}]
                [--indent-size]
                [--insert-final-newline]
                [--newline]
                [--newline-kind {CR, CRLF, LF}]
                [--outdir]
                [--outfile]
                [--stdout]

範例

格式化一個 Bicep 檔案。

az bicep format --file {bicep_file}

格式化一個 Bicep 檔案，然後把所有輸出列印成標準。

az bicep format --file {bicep_file} --stdout

格式化一個 Bicep 檔案，並將結果儲存到指定的目錄。

az bicep format --file {bicep_file} --outdir {out_dir}

格式化一個 Bicep 檔案，並將結果儲存到指定的檔案中。

az bicep format --file {bicep_file} --outfile {out_file}

格式化一個 Bicep 檔案，插入最後一個換行。

az bicep format --file {bicep_file} --insert-final-newline

格式化一個 Bicep 檔案，設定縮排類型。 有效值為 （空格 |索引標籤 。

az bicep format --file {bicep_file} --indent-kind {indent_kind}

格式化 Bicep 檔案，設定縮排的空格數（僅在 --縮排-類型設為空格時有效）。

az bicep format --file {bicep_file} --indent-size {indent_size}

必要參數

--file -f

Bicep 檔案的路徑，用於檔案系統格式化。

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性 值
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性 值
參數群組: Global Policy Arguments
--indent-kind

設定縮排種類。

屬性 值
接受的值: Space, Tab
--indent-size

要縮排的空格數目，只有 --indent-kind 設定為Space時才有效。

--insert-final-newline

插入最終換行符。

--newline
已被取代

選項 '--newline' 已被取代，將在未來的版本中移除。 請改用 『--newline-kind』。

設定換行符。 有效值為 （Auto |LF |CRLF |CR ）。

--newline-kind

設定行尾字元。

屬性 值
接受的值: CR, CRLF, LF
--outdir

設定時，會將輸出儲存在指定的目錄。

--outfile

設定時，將輸出儲存為指定的檔案路徑。

--stdout

設定時，將所有輸出列印到 stdout，而不是對應的檔案。

全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID 設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False

az bicep generate-params

產生 Bicep 檔案的參數檔案。

az bicep generate-params --file
                         [--acquire-policy-token]
                         [--change-reference]
                         [--include-params]
                         [--no-restore]
                         [--outdir]
                         [--outfile]
                         [--output-format]
                         [--stdout]

範例

產生 Bicep 檔案的參數檔案。

az bicep generate-params --file {bicep_file}

產生 Bicep 檔案的參數檔，並將所有輸出列印到 stdout。

az bicep generate-params --file {bicep_file} --stdout

產生 Bicep 檔案的參數檔，並將結果儲存到指定的目錄。

az bicep generate-params --file {bicep_file} --outdir {out_dir}

產生 Bicep 檔案的參數檔案，並將結果儲存到指定的檔案中。

az bicep generate-params --file {bicep_file} --outfile {out_file}

在不還原外部模組的情況下，為 Bicep 檔案產生參數檔。

az bicep generate-params --file {bicep_file} --no-restore

為指定輸出格式的 Bicep 檔案產生參數檔。 有效值為 （json | bicepparam ）。

az bicep generate-params --file {bicep_file} --output-format {output_format} --include-params {include_params}

必要參數

--file -f

這是 Bicep 檔案的路徑，用來產生檔案系統中參數檔案。

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性 值
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性 值
參數群組: Global Policy Arguments
--include-params

設定 include 參數。 有效值為 （全部 |RequiredOnly 。

--no-restore

設定時，會產生參數檔案，而不還原外部模組。

--outdir

設定時，會將輸出儲存在指定的目錄。

--outfile

設定時，將輸出儲存為指定的檔案路徑。

--output-format

設定輸出格式。 有效值為 （json | bicepparam ）。

--stdout

設定時，將所有輸出列印到 stdout，而不是對應的檔案。

全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID 設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False

az bicep install

安裝 Bicep CLI。

az bicep install [--acquire-policy-token]
                 [--change-reference]
                 [--target-platform {linux-arm64, linux-musl-x64, linux-x64, osx-arm64, osx-x64, win-arm64, win-x64}]
                 [--version]

範例

安裝 Bicep CLI。

az bicep install

安裝特定版本的 Bicep CLI。

az bicep install --version v0.2.212

安裝 Bicep CLI 並指定目標平台。

az bicep install --target-platform linux-x64

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性 值
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性 值
參數群組: Global Policy Arguments
--target-platform -t

Bicep CLI 將運行的平台。 設定此選項可略過自動平臺偵測，如果無法正常運作。

屬性 值
接受的值: linux-arm64, linux-musl-x64, linux-x64, osx-arm64, osx-x64, win-arm64, win-x64
--version -v

Bicep CLI 的安裝版本。 如果未指定，則預設為最新的 。

全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID 設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False

az bicep lint

用棉線貼上Bicep銼刀。

az bicep lint --file
              [--acquire-policy-token]
              [--change-reference]
              [--diagnostics-format {default, sarif}]
              [--no-restore]

範例

用棉線貼上Bicep銼刀。

az bicep lint --file {bicep_file}

在不還原外部模組的情況下，直接刪除 Bicep 檔案。

az bicep lint --file {bicep_file} --no-restore

用指定診斷格式的 Bicep 檔案來 lint 。 有效值為 （預設值 | sarif ）。

az bicep lint --file {bicep_file} --diagnostics-format {diagnostics_format}

必要參數

--file -f

連接到 Bicep 模組檔案到 lint 的路徑。

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性 值
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性 值
參數群組: Global Policy Arguments
--diagnostics-format

設定診斷格式。

屬性 值
接受的值: default, sarif
--no-restore

設定時，會產生參數檔案，而不還原外部模組。

全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID 設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False

az bicep list-versions

列出所有可用的 Bicep CLI 版本。

az bicep list-versions [--acquire-policy-token]
                       [--change-reference]

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性 值
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性 值
參數群組: Global Policy Arguments
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID 設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False

az bicep publish

將 bicep 檔案發佈至遠端模組登錄。

az bicep publish --file
                 --target
                 [--acquire-policy-token]
                 [--change-reference]
                 [--documentation-uri]
                 [--documentationUri]
                 [--force]
                 [--with-source]

範例

發佈 bicep 檔案。

az bicep publish --file {bicep_file} --target "br:{registry}/{module_path}:{tag}"

發佈覆寫現有標記的 bicep 檔案。

az bicep publish --file {bicep_file} --target "br:{registry}/{module_path}:{tag} --force"

使用檔 URI 發佈 bicep 檔案。

az bicep publish --file {bicep_file} --target "br:{registry}/{module_path}:{tag}" --documentation-uri {documentation_uri}

使用檔 URI 發佈 bicep 檔案，並包含原始程式碼

az bicep publish --file {bicep_file} --target "br:{registry}/{module_path}:{tag}" --documentation-uri {documentation_uri} --with-source

必要參數

--file -f

Bicep 模組檔案的路徑，要在檔案系統中發佈。

--target -t

Bicep模組將發布的目標地點。

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性 值
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性 值
參數群組: Global Policy Arguments
--documentation-uri -d

Bicep 模組的文件 uri。

--documentationUri
已被取代

選項 '--documentationuri' 已被取代，將在未來的版本中移除。 請改用 『--documentation-uri』。

Bicep 模組的文件 uri。

--force

允許覆蓋現有的 Bicep 模組版本。

--with-source

使用 模組發佈原始程式碼。

全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID 設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False

az bicep restore

還原 bicep 檔案的外部模組。

az bicep restore --file
                 [--acquire-policy-token]
                 [--change-reference]
                 [--force]

範例

還原外部模組。

az bicep restore --file {bicep_file}

還原外部模組並覆寫快取的外部模組。

az bicep restore --file {bicep_file} --force

必要參數

--file -f

還原外部模組的 Bicep 檔案路徑。

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性 值
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性 值
參數群組: Global Policy Arguments
--force

允許覆寫快取的外部模組。

全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID 設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False

az bicep run

將原始指令轉發到已安裝的 Bicep CLI。

執行 Bicep CLI，參數由 --command提供，允許使用 尚未有專用az bicep包裝器的 Bicep CLI 功能。 傳遞給--command的字串會以 shell 式引號方式分割，並逐字轉發給 Bicep CLI。 當轉發指令本身以 -- （例如 --version）開頭時，請使用 --command=<value> 表單，避免 CLI 解析器誤認該值為其他選項。

由於該值會未經驗證直接轉發至 Bicep CLI，請勿傳遞來自不受信任輸入的字串。

az bicep run --command
             [--acquire-policy-token]
             [--change-reference]

範例

將建置指令轉發到 Bicep CLI。

az bicep run --command "build main.bicep"

顯示 Bicep CLI 說明（使用 --command=<value> 表單以取得類似選項的值）。

az bicep run --command=--help

必要參數

--command -c

Bicep CLI 指令，包含其參數，以單引號字串執行（例如「build main.bicep").

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性 值
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性 值
參數群組: Global Policy Arguments
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID 設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False

az bicep snapshot

擷取或驗證 .bicepparam 檔案預測將部署的資源快照。

編譯一個 .bicepparam 檔案及其參考的 Bicep 範本，並在 .bicepparam 檔案旁寫入部署快照（檔案*.snapshot.json）。 當執行時 --mode Validate，現有快照會與目前範本比較，若兩者不同，指令會失敗。 此指令需要 Bicep CLI v0.41.2 或更新版本。

az bicep snapshot --file
                  [--acquire-policy-token]
                  [--change-reference]
                  [--deployment-name]
                  [--location]
                  [--management-group-id]
                  [--mode {Overwrite, Validate}]
                  [--resource-group]
                  [--subscription-id]
                  [--tenant-id]

範例

擷取 .bicepparam 檔案的快照。

az bicep snapshot --file main.bicepparam

驗證現有快照是否仍與目前範本相符。

az bicep snapshot --file main.bicepparam --mode Validate

擷取帶有明確 Azure 上下文的快照。

az bicep snapshot --file main.bicepparam --subscription-id 00000000-0000-0000-0000-000000000000 --resource-group myRg --location westus

必要參數

--file -f

這是 .bicepparam 檔案的路徑，用來擷取快照。

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性 值
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性 值
參數群組: Global Policy Arguments
--deployment-name

部署名稱會作為部署上下文轉發給 Bicep CLI，作為擷取快照時用來解析existing參考的部署上下文。

--location -l

位置轉發至 Bicep CLI，作為部署上下文，用於解析existing快照時的參考。

--management-group-id

管理群組 ID 會轉發給 Bicep CLI，作為部署上下文，用於在擷取快照時解析existing參考。

--mode

快照模式。 預設值為「覆寫」會寫入快照檔案。 「驗證」會將現有快照與目前範本比較，若偵測到差異則失敗。

屬性 值
接受的值: Overwrite, Validate
--resource-group -g

資源群組名稱會被轉發給 Bicep CLI，作為擷取快照時用來解析existing參考的部署上下文。

--subscription-id

訂閱 ID 轉發給 Bicep CLI，作為部署上下文，用於解析existing快照時的參考。 這不會影響 Azure CLI 認證;請使用全域--subscription參數切換有效訂閱。

--tenant-id

租戶 ID 轉發至 Bicep CLI，作為部署上下文，用於解析existing快照時的參考。 這不會影響 Azure CLI 認證。

全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID 設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False

az bicep uninstall

移除 Bicep CLI。

az bicep uninstall [--acquire-policy-token]
                   [--change-reference]

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性 值
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性 值
參數群組: Global Policy Arguments
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID 設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False

az bicep upgrade

將 Bicep CLI 升級到最新版本。

az bicep upgrade [--acquire-policy-token]
                 [--change-reference]
                 [--target-platform {linux-arm64, linux-musl-x64, linux-x64, osx-arm64, osx-x64, win-arm64, win-x64}]

範例

升級 Bicep CLI。

az bicep upgrade

升級 Bicep CLI 並指定目標平台。

az bicep upgrade --target-platform linux-x64

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性 值
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性 值
參數群組: Global Policy Arguments
--target-platform -t

Bicep CLI 將運行的平台。 設定此選項可略過自動平臺偵測，如果無法正常運作。

屬性 值
接受的值: linux-arm64, linux-musl-x64, linux-x64, osx-arm64, osx-x64, win-arm64, win-x64
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID 設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False

az bicep version

顯示已安裝的 Bicep CLI 版本。

az bicep version [--acquire-policy-token]
                 [--change-reference]

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性 值
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性 值
參數群組: Global Policy Arguments
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID 設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False