az bicep

Bicep CLI 命令群組。

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

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

[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 檔案。	核心	GA
az bicep build-params	建置 .bicepparam 檔案。	核心	GA
az bicep decompile	嘗試將ARM範本檔案分解成 Bicep 檔案。	核心	GA
az bicep decompile-params	將參數.json檔案分解為 .bicepparam。	核心	GA
az bicep format	格式化 Bicep 檔案。	核心	GA
az bicep generate-params	產生 Bicep 檔案的參數檔案。	核心	GA
az bicep install	安裝 Bicep CLI。	核心	GA
az bicep lint	Lint a Bicep file.	核心	GA
az bicep list-versions	列出所有可用的 Bicep CLI 版本。	核心	GA
az bicep publish	將 bicep 檔案發佈至遠端模組登錄。	核心	GA
az bicep restore	還原 bicep 檔案的外部模組。	核心	GA
az bicep uninstall	卸載 Bicep CLI。	核心	GA
az bicep upgrade	將 Bicep CLI 升級至最新版本。	核心	GA
az bicep version	顯示已安裝的 Bicep CLI 版本。	核心	GA

az bicep build

建置 Bicep 檔案。

az bicep build --file
               [--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 檔案路徑。

選擇性參數

--no-restore

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

--outdir

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

--outfile

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

--stdout

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

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az bicep build-params

建置 .bicepparam 檔案。

az bicep build-params --file
                      [--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 檔案路徑。

選擇性參數

--no-restore

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

--outdir

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

--outfile

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

--stdout

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

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az bicep decompile

嘗試將ARM範本檔案分解成 Bicep 檔案。

az bicep decompile --file
                   [--force]

範例

將 ARM 範本檔案分解。

az bicep decompile --file {json_template_file}

將 ARM 範本檔案分解，並覆寫現有的 Bicep 檔案。

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

必要參數

--file -f

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

選擇性參數

--force

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

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az bicep decompile-params

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

az bicep decompile-params --file
                          [--bicep-file]
                          [--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，並將所有輸出列印到 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

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

選擇性參數

--bicep-file

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

--outdir

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

--outfile

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

--stdout

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

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az bicep format

格式化 Bicep 檔案。

az bicep format --file
                [--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 檔案，並將所有輸出列印到 stdout。

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 檔案將空格數目設定為縮排 （只有 --indent-kind 設定為 Space 有效）。

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

必要參數

--file -f

在文件系統中格式化的 Bicep 檔案路徑。

選擇性參數

--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

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az bicep generate-params

產生 Bicep 檔案的參數檔案。

az bicep generate-params --file
                         [--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 檔案的路徑。

選擇性參數

--include-params

設定 include 參數。 有效值為 （全部 | 僅限必要 ）。

--no-restore

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

--outdir

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

--outfile

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

--output-format

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

--stdout

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

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az bicep install

安裝 Bicep CLI。

az bicep install [--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

選擇性參數

--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

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az bicep lint

Lint a Bicep file.

az bicep lint --file
              [--diagnostics-format {default, sarif}]
              [--no-restore]

範例

Lint a Bicep file.

az bicep lint --file {bicep_file}

在不還原外部模塊的情況下，Lint a Bicep 檔案。

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

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

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

必要參數

--file -f

文件系統中 Lint 之 Bicep 模組檔案的路徑。

選擇性參數

--diagnostics-format

設定診斷格式。

接受的值: default, sarif

--no-restore

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

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az bicep list-versions

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

az bicep list-versions

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az bicep publish

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

az bicep publish --file
                 --target
                 [--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 模組的目標位置。

選擇性參數

--documentation-uri -d

Bicep 模組的檔 URI。

--documentationUri

已被取代

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

Bicep 模組的檔 URI。

--force

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

--with-source

預覽

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

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az bicep restore

還原 bicep 檔案的外部模組。

az bicep restore --file
                 [--force]

範例

還原外部模組。

az bicep restore --file {bicep_file}

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

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

必要參數

--file -f

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

選擇性參數

--force

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

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az bicep uninstall

卸載 Bicep CLI。

az bicep uninstall

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az bicep upgrade

將 Bicep CLI 升級至最新版本。

az bicep upgrade [--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

選擇性參數

--target-platform -t

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

接受的值: linux-arm64, linux-musl-x64, linux-x64, osx-arm64, osx-x64, win-arm64, win-x64

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az bicep version

顯示已安裝的 Bicep CLI 版本。

az bicep version

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。