az bicep

  • リファレンス

Bicep CLI コマンド グループ。

bicep を含め、コマンド グループに対して設定できる構成は 2 つあります。チェック_versionとbicep.use_binary_from_path:

[1] az config set bicep.チェック_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 です。

コマンド

名前 説明 型 Status
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

Bicep ファイルを Lint します。

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

サブスクリプションの名前または ID。 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

サブスクリプションの名前または ID。 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

サブスクリプションの名前または ID。 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

using 宣言で参照される bicep テンプレート ファイル (.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

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az bicep format

Bicep ファイルを書式設定します。

az bicep format --file
                [--indent-kind]
                [--indent-size]
                [--insert-final-newline]
                [--newline]
                [--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 ファイルへのパス。

省略可能のパラメーター

--indent-kind

インデントの種類を設定します。 有効な値は ( スペース |Tab)。

--indent-size

インデントするスペースの数 (--indent-kind が Space に設定されている場合のみ有効)。

--insert-final-newline

最後の改行を挿入します。

--newline

改行文字を設定します。 有効な値は ( Auto |LF |CRLF |CR)。

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

サブスクリプションの名前または ID。 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

サブスクリプションの名前または ID。 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-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-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

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az bicep lint

Bicep ファイルを Lint します。

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

例

Bicep ファイルを Lint します。

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

ファイル システム内の 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

サブスクリプションの名前または ID。 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

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az bicep publish

bicep ファイルをリモート モジュール レジストリに発行します。

az bicep publish --file
                 --target
                 [--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}" --documentationUri {documentationUri}

ドキュメント URI を使用して bicep ファイルを発行し、ソース コードを含める

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

必須のパラメーター

--file -f

ファイル システムに発行する Bicep モジュール ファイルへのパス。

--target -t

Bicep モジュールが発行されるターゲットの場所。

省略可能のパラメーター

--documentationUri -d

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

サブスクリプションの名前または ID。 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

サブスクリプションの名前または ID。 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

サブスクリプションの名前または ID。 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-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-x64
グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 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

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。