Partilhar via

az bicep

  • Referência

Grupo de comandos da CLI do Bíceps.

Há duas configurações que podem ser definidas para o grupo de comandos, incluindo bicep.check_version e bicep.use_binary_from_path:

[1] az config set bicep.check_version=True/False Ativar/desativar a verificação de versão da CLI do Bicep ao executar comandos az bicep.

[2] az config set bicep.use_binary_from_path=True/False/if_found_in_ci Especifique se a CLI do Bicep deve ser usada ou não. O valor padrão é if_found_in_ci.

Comandos

Name Description Tipo Status
az bicep build

Crie um arquivo Bicep.

 Principal GA
az bicep build-params

Crie o arquivo .bicepparam.

 Principal GA
az bicep decompile

Tente descompilar um arquivo de modelo ARM para um arquivo Bicep.

 Principal GA
az bicep decompile-params

Descompile um arquivo de parâmetros .json para .bicepparam.

 Principal GA
az bicep format

Formate um arquivo Bicep.

 Principal GA
az bicep generate-params

Gere um arquivo de parâmetros para um arquivo Bicep.

 Principal GA
az bicep install

Instale a CLI do Bicep.

 Principal GA
az bicep lint

Lint um arquivo Bicep.

 Principal GA
az bicep list-versions

Liste todas as versões disponíveis do Bicep CLI.

 Principal GA
az bicep publish

Publique um arquivo bicep em um registro de módulo remoto.

 Principal GA
az bicep restore

Restaure módulos externos para um arquivo bíceps.

 Principal GA
az bicep uninstall

Desinstale a CLI do Bicep.

 Principal GA
az bicep upgrade

Atualize a CLI do Bicep para a versão mais recente.

 Principal GA
az bicep version

Mostrar a versão instalada do Bicep CLI.

 Principal GA

az bicep build

Crie um arquivo Bicep.

az bicep build --file
               [--no-restore]
               [--outdir]
               [--outfile]
               [--stdout]

Exemplos

Crie um arquivo Bicep.

az bicep build --file {bicep_file}

Crie um arquivo Bicep e imprima toda a saída para stdout.

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

Crie um arquivo Bicep e salve o resultado no diretório especificado.

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

Crie um arquivo Bicep e salve o resultado no arquivo especificado.

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

Crie um arquivo Bicep sem restaurar módulos externos.

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

Parâmetros Obrigatórios

--file -f

O caminho para o arquivo Bicep para construir no sistema de arquivos.

Parâmetros Opcionais

--no-restore

Quando definido, constrói o arquivo bicep sem restaurar módulos externos.

--outdir

Quando definido, salva a saída no diretório especificado.

--outfile

Quando definido, salva a saída como o caminho do arquivo especificado.

--stdout

Quando definido, imprime toda a saída em stdout em vez dos arquivos correspondentes.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az bicep build-params

Crie o arquivo .bicepparam.

az bicep build-params --file
                      [--no-restore]
                      [--outdir]
                      [--outfile]
                      [--stdout]

Exemplos

Crie um arquivo .bicepparam.

az bicep build-params --file {bicepparam_file}

Crie um arquivo .bicepparam e imprima toda a saída para stdout.

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

Crie um arquivo .bicepparam e salve o resultado no arquivo especificado.

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

Parâmetros Obrigatórios

--file -f

O caminho para o arquivo .bicepparam a ser compilado no sistema de arquivos.

Parâmetros Opcionais

--no-restore

Quando definido, cria o arquivo .bicepparam sem restaurar módulos externos.

--outdir

Quando definido, salva a saída no diretório especificado.

--outfile

Quando definido, salva a saída como o caminho do arquivo especificado.

--stdout

Quando definido, imprime toda a saída em stdout em vez dos arquivos correspondentes.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az bicep decompile

Tente descompilar um arquivo de modelo ARM para um arquivo Bicep.

az bicep decompile --file
                   [--force]

Exemplos

Descompile um arquivo de modelo ARM.

az bicep decompile --file {json_template_file}

Descompile um arquivo de modelo ARM e substitua o arquivo Bicep existente.

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

Parâmetros Obrigatórios

--file -f

O caminho para o modelo ARM a ser descompilado no sistema de arquivos.

Parâmetros Opcionais

--force

Permite substituir o arquivo de saída, se ele existir.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az bicep decompile-params

Descompile um arquivo de parâmetros .json para .bicepparam.

az bicep decompile-params --file
                          [--bicep-file]
                          [--outdir]
                          [--outfile]
                          [--stdout]

Exemplos

Tenta descompilar um arquivo de parâmetros .json para .bicepparam.

az bicep decompile-params --file {json_template_file}

Tenta descompilar um arquivo de parâmetros .json para .bicepparam usando o arquivo bicep fornecido.

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

Tenta descompilar um arquivo de parâmetros .json para .bicepparam e imprimir toda a saída para stdout.

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

Tenta descompilar um arquivo de parâmetros .json para .bicepparam e imprimir toda a saída para stdout e salvar o resultado no diretório especificado.

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

Tenta descompilar um arquivo de parâmetros .json para .bicepparam e imprimir toda a saída para stdout e salvar o resultado no arquivo especificado.

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

Parâmetros Obrigatórios

--file -f

O caminho para o arquivo de parâmetros a ser compilado no sistema de arquivos.

Parâmetros Opcionais

--bicep-file

Caminho para o arquivo de modelo bicep (relativo ao arquivo .bicepparam) que será referenciado na declaração using .

--outdir

Quando definido, salva a saída no diretório especificado.

--outfile

Quando definido, salva a saída como o caminho do arquivo especificado.

--stdout

Quando definido, imprime toda a saída em stdout em vez dos arquivos correspondentes.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az bicep format

Formate um arquivo Bicep.

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

Exemplos

Formate um arquivo Bicep.

az bicep format --file {bicep_file}

Formate um arquivo Bicep e imprima toda a saída para stdout.

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

Formate um arquivo Bicep e salve o resultado no diretório especificado.

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

Formate um arquivo Bicep e salve o resultado no arquivo especificado.

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

Formatar um arquivo Bicep, inserir uma nova linha final.

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

Formate um tipo de recuo do conjunto de arquivos Bicep. Os valores válidos são ( Espaço | Tab ).

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

Formatar um arquivo Bicep define o número de espaços para recuar com (Válido apenas com --indent-kind definido como Espaço).

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

Parâmetros Obrigatórios

--file -f

O caminho para o arquivo Bicep para formatar no sistema de arquivos.

Parâmetros Opcionais

--indent-kind

Defina o tipo de recuo.

Valores aceites: Space, Tab
--indent-size

Número de espaços para recuar com (Válido apenas com --indent-kind definido como Espaço).

--insert-final-newline

Insira uma nova linha final.

--newline
Preterido

A opção '--newline' foi preterida e será removida em uma versão futura. Em vez disso, use '--newline-kind'.

Definir carvo de nova linha. Os valores válidos são ( Auto | LF | CRLF | CR ).

--newline-kind

Defina caracteres finais de linha.

Valores aceites: CR, CRLF, LF
--outdir

Quando definido, salva a saída no diretório especificado.

--outfile

Quando definido, salva a saída como o caminho do arquivo especificado.

--stdout

Quando definido, imprime toda a saída em stdout em vez dos arquivos correspondentes.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az bicep generate-params

Gere um arquivo de parâmetros para um arquivo Bicep.

az bicep generate-params --file
                         [--include-params]
                         [--no-restore]
                         [--outdir]
                         [--outfile]
                         [--output-format]
                         [--stdout]

Exemplos

Gere um arquivo de parâmetros para um arquivo Bicep.

az bicep generate-params --file {bicep_file}

Gere o arquivo de parâmetros para um arquivo Bicep e imprima toda a saída para stdout.

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

Gere o arquivo de parâmetros para um arquivo Bicep e salve o resultado no diretório especificado.

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

Gere o arquivo de parâmetros para um arquivo Bicep e salve o resultado no arquivo especificado.

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

Gere um arquivo de parâmetros para um arquivo Bicep sem restaurar módulos externos.

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

Gere um arquivo de parâmetros para um arquivo Bicep com formato de saída especificado. Os valores válidos são ( json | bicepparam ).

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

Parâmetros Obrigatórios

--file -f

O caminho para o arquivo Bicep para gerar o arquivo de parâmetros no sistema de arquivos.

Parâmetros Opcionais

--include-params

O conjunto inclui parámetros. Os valores válidos são ( todos | ObrigatórioApenas ).

--no-restore

Quando definido, gera o arquivo de parâmetros sem restaurar módulos externos.

--outdir

Quando definido, salva a saída no diretório especificado.

--outfile

Quando definido, salva a saída como o caminho do arquivo especificado.

--output-format

Defina o formato de saída. Os valores válidos são ( json | bicepparam ).

--stdout

Quando definido, imprime toda a saída em stdout em vez dos arquivos correspondentes.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az bicep install

Instale a CLI do Bicep.

az bicep install [--target-platform {linux-arm64, linux-musl-x64, linux-x64, osx-arm64, osx-x64, win-arm64, win-x64}]
                 [--version]

Exemplos

Instale a CLI do Bicep.

az bicep install

Instale uma versão específica do Bicep CLI.

az bicep install --version v0.2.212

Instale a CLI do Bicep e especifique a plataforma de destino.

az bicep install --target-platform linux-x64

Parâmetros Opcionais

--target-platform -t

A plataforma em que a CLI do Bicep será executada. Defina isso para ignorar a deteção automática de plataforma se ela não funcionar corretamente.

Valores aceites: linux-arm64, linux-musl-x64, linux-x64, osx-arm64, osx-x64, win-arm64, win-x64
--version -v

A versão da CLI do Bicep a ser instalada. O padrão é o mais recente se não for especificado.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az bicep lint

Lint um arquivo Bicep.

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

Exemplos

Lint um arquivo Bicep.

az bicep lint --file {bicep_file}

Lint um arquivo Bicep sem restaurar módulos externos.

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

Lint um arquivo Bicep com formato de diagnóstico especificado. Os valores válidos são ( default | sarif ).

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

Parâmetros Obrigatórios

--file -f

O caminho para o arquivo do módulo Bicep para lint no sistema de arquivos.

Parâmetros Opcionais

--diagnostics-format

Defina o formato de diagnóstico.

Valores aceites: default, sarif
--no-restore

Quando definido, gera o arquivo de parâmetros sem restaurar módulos externos.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az bicep list-versions

Liste todas as versões disponíveis do Bicep CLI.

az bicep list-versions
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az bicep publish

Publique um arquivo bicep em um registro de módulo remoto.

az bicep publish --file
                 --target
                 [--documentation-uri]
                 [--documentationUri]
                 [--force]
                 [--with-source]

Exemplos

Publique um arquivo bíceps.

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

Publique um arquivo bicep substituindo uma tag existente.

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

Publique um arquivo bicep com uri de documentação.

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

Publicar um arquivo bicep com uri de documentação e incluir código-fonte

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

Parâmetros Obrigatórios

--file -f

O caminho para o arquivo de módulo Bicep a ser publicado no sistema de arquivos.

--target -t

O local de destino onde o módulo Bicep será publicado.

Parâmetros Opcionais

--documentation-uri -d

O uri de documentação do módulo Bicep.

--documentationUri
Preterido

A opção '--documentationuri' foi preterida e será removida em uma versão futura. Use '--documentation-uri' em vez disso.

O uri de documentação do módulo Bicep.

--force

Permitir a substituição de uma versão existente do módulo Bicep.

--with-source

Publique o código-fonte com o módulo.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az bicep restore

Restaure módulos externos para um arquivo bíceps.

az bicep restore --file
                 [--force]

Exemplos

Restaure módulos externos.

az bicep restore --file {bicep_file}

Restaure módulos externos e substitua módulos externos armazenados em cache.

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

Parâmetros Obrigatórios

--file -f

O caminho para o arquivo Bicep para restaurar módulos externos.

Parâmetros Opcionais

--force

Permite substituir os módulos externos armazenados em cache.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az bicep uninstall

Desinstale a CLI do Bicep.

az bicep uninstall
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az bicep upgrade

Atualize a CLI do Bicep para a versão mais recente.

az bicep upgrade [--target-platform {linux-arm64, linux-musl-x64, linux-x64, osx-arm64, osx-x64, win-arm64, win-x64}]

Exemplos

Atualize a CLI do Bicep.

az bicep upgrade

Atualize a CLI do Bicep e especifique a plataforma de destino.

az bicep upgrade --target-platform linux-x64

Parâmetros Opcionais

--target-platform -t

A plataforma em que a CLI do Bicep será executada. Defina isso para ignorar a deteção automática de plataforma se ela não funcionar corretamente.

Valores aceites: linux-arm64, linux-musl-x64, linux-x64, osx-arm64, osx-x64, win-arm64, win-x64
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az bicep version

Mostrar a versão instalada do Bicep CLI.

az bicep version
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.