你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

az bicep

Bicep CLI 命令组。

可以为命令组设置两种配置，包括bicep.check_version和bicep.use_binary_from_path：

[1] 执行 az bicep 命令时，az config set bicep.check_version=True/False 启用/关闭 Bicep CLI 版本检查。

[2] az config set bicep.use_binary_from_path=True/False/if_found_in_ci 指定是否在 PATH 中使用 Bicep CLI。 默认值为if_found_in_ci。

命令

名称 说明 类型 Status
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文件进行 Lint 处理。

 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 Policy令牌。

属性 值
参数组: 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

订阅的名称或 ID。 可以使用 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 Policy令牌。

属性 值
参数组: 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

订阅的名称或 ID。 可以使用 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 Policy令牌。

属性 值
参数组: 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

订阅的名称或 ID。 可以使用 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 Policy令牌。

属性 值
参数组: Global Policy Arguments
--bicep-file

将在 using 声明中引用的 bicep 模板文件的路径（相对于 .bicepparam 文件）。

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

订阅的名称或 ID。 可以使用 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文件并将所有输出打印到 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文件集缩进类型的格式。 有效值为 （空格 |Tab 。

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文件的路径。

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--acquire-policy-token

为此资源操作自动获取Azure Policy令牌。

属性 值
参数组: 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”。

设置换行符。 有效值为 （自动 |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

订阅的名称或 ID。 可以使用 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 Policy令牌。

属性 值
参数组: 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

订阅的名称或 ID。 可以使用 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 Policy令牌。

属性 值
参数组: 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

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False

az bicep lint

对Bicep文件进行 Lint 处理。

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

示例

对Bicep文件进行 Lint 处理。

az bicep lint --file {bicep_file}

在不还原外部模块的情况下对Bicep文件进行 Lint。

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

使用指定的诊断格式对Bicep文件进行 Lint。 有效值为 （default | sarif ）。

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

必需参数

--file -f

Bicep模块文件的路径，用于文件系统中的 lint。

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--acquire-policy-token

为此资源操作自动获取Azure Policy令牌。

属性 值
参数组: 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

订阅的名称或 ID。 可以使用 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 Policy令牌。

属性 值
参数组: 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

订阅的名称或 ID。 可以使用 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 Policy令牌。

属性 值
参数组: 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

订阅的名称或 ID。 可以使用 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 Policy令牌。

属性 值
参数组: 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

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False

az bicep run

将原始命令转发到已安装的 Bicep CLI。

使用提供--command的参数运行 Bicep CLI，从而允许使用尚未具有专用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 命令（包括其参数）作为单引号字符串（例如“生成 main.bicep").

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--acquire-policy-token

为此资源操作自动获取Azure Policy令牌。

属性 值
参数组: 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

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False

az bicep snapshot

捕获或验证 .bicepparam 文件预测要部署的资源的快照。

编译 .bicepparam 文件及其引用的Bicep模板，并将部署快照（文件*.snapshot.json）写入 .bicepparam 文件旁。 运行 --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 Policy令牌。

属性 值
参数组: 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”将现有快照与当前模板进行比较，如果检测到差异，则失败。

属性 值
接受的值: 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

订阅的名称或 ID。 可以使用 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 Policy令牌。

属性 值
参数组: 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

订阅的名称或 ID。 可以使用 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 Policy令牌。

属性 值
参数组: 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

订阅的名称或 ID。 可以使用 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 Policy令牌。

属性 值
参数组: 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

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False