Dela via

az bicep

  • Referens

Bicep CLI-kommandogrupp.

Det finns två konfigurationer som kan anges för kommandogruppen, inklusive bicep.check_version och bicep.use_binary_from_path:

[1] az config set bicep.check_version=True/False Aktivera/inaktivera Bicep CLI-versionskontroll vid körning av az bicep-kommandon.

[2] az config set bicep.use_binary_from_path=True/False/if_found_in_ci Ange om Bicep CLI ska användas från PATH eller inte. Standardvärdet är if_found_in_ci.

Kommandon

Name Description Typ Status
az bicep build

Skapa en Bicep-fil.

 Kärna Allmän tillgänglighet
az bicep build-params

Skapa .bicepparam-fil.

 Kärna Allmän tillgänglighet
az bicep decompile

Försök att dela upp en ARM-mallfil till en Bicep-fil.

 Kärna Allmän tillgänglighet
az bicep decompile-params

Dela upp en parameter .json fil till .bicepparam.

 Kärna Allmän tillgänglighet
az bicep format

Formatera en Bicep-fil.

 Kärna Allmän tillgänglighet
az bicep generate-params

Generera parameterfil för en Bicep-fil.

 Kärna Allmän tillgänglighet
az bicep install

Installera Bicep CLI.

 Kärna Allmän tillgänglighet
az bicep lint

Lint en Bicep-fil.

 Kärna Allmän tillgänglighet
az bicep list-versions

Visa en lista över alla tillgängliga versioner av Bicep CLI.

 Kärna Allmän tillgänglighet
az bicep publish

Publicera en bicep-fil till ett fjärrmodulregister.

 Kärna Allmän tillgänglighet
az bicep restore

Återställa externa moduler för en bicep-fil.

 Kärna Allmän tillgänglighet
az bicep uninstall

Avinstallera Bicep CLI.

 Kärna Allmän tillgänglighet
az bicep upgrade

Uppgradera Bicep CLI till den senaste versionen.

 Kärna Allmän tillgänglighet
az bicep version

Visa den installerade versionen av Bicep CLI.

 Kärna Allmän tillgänglighet

az bicep build

Skapa en Bicep-fil.

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

Exempel

Skapa en Bicep-fil.

az bicep build --file {bicep_file}

Skapa en Bicep-fil och skriv ut alla utdata till stdout.

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

Skapa en Bicep-fil och spara resultatet i den angivna katalogen.

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

Skapa en Bicep-fil och spara resultatet i den angivna filen.

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

Skapa en Bicep-fil utan att återställa externa moduler.

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

Obligatoriska parametrar

--file -f

Sökvägen till Bicep-filen som ska skapas i filsystemet.

Valfria parametrar

--no-restore

När den har angetts skapar bicep-filen utan att återställa externa moduler.

--outdir

När du har angett sparas utdata i den angivna katalogen.

--outfile

När du har angett sparas utdata som den angivna filsökvägen.

--stdout

När det är inställt skrivs alla utdata ut till stdout i stället för motsvarande filer.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az bicep build-params

Skapa .bicepparam-fil.

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

Exempel

Skapa en .bicepparam-fil.

az bicep build-params --file {bicepparam_file}

Skapa en .bicepparam-fil och skriv ut alla utdata till stdout.

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

Skapa en .bicepparam-fil och spara resultatet i den angivna filen.

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

Obligatoriska parametrar

--file -f

Sökvägen till .bicepparam-filen som ska skapas i filsystemet.

Valfria parametrar

--no-restore

När den har angetts skapar den .bicepparam-filen utan att återställa externa moduler.

--outdir

När du har angett sparas utdata i den angivna katalogen.

--outfile

När du har angett sparas utdata som den angivna filsökvägen.

--stdout

När det är inställt skrivs alla utdata ut till stdout i stället för motsvarande filer.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az bicep decompile

Försök att dela upp en ARM-mallfil till en Bicep-fil.

az bicep decompile --file
                   [--force]

Exempel

Dela upp en ARM-mallfil.

az bicep decompile --file {json_template_file}

Dela upp en ARM-mallfil och skriv över befintlig Bicep-fil.

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

Obligatoriska parametrar

--file -f

Sökvägen till ARM-mallen för att dekompilera i filsystemet.

Valfria parametrar

--force

Tillåter att utdatafilen skrivs över om den finns.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az bicep decompile-params

Dela upp en parameter .json fil till .bicepparam.

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

Exempel

Försöker dela upp en parameter .json fil till .bicepparam.

az bicep decompile-params --file {json_template_file}

Försöker dela upp en parameter .json fil till .bicepparam med hjälp av den angivna bicep-filen.

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

Försöker dekompilera en parameter .json fil till .bicepparam och skriva ut alla utdata till stdout.

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

Försöker dekompilera en parameter .json fil till .bicepparam och skriva ut alla utdata till stdout och spara resultatet i den angivna katalogen.

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

Försöker dekompilera en parameter .json fil till .bicepparam och skriva ut alla utdata till stdout och spara resultatet i den angivna filen.

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

Obligatoriska parametrar

--file -f

Sökvägen till parameterfilen som ska skapas i filsystemet.

Valfria parametrar

--bicep-file

Sökväg till bicep-mallfilen (i förhållande till .bicepparam-filen) som refereras till i deklarationen.

--outdir

När du har angett sparas utdata i den angivna katalogen.

--outfile

När du har angett sparas utdata som den angivna filsökvägen.

--stdout

När det är inställt skrivs alla utdata ut till stdout i stället för motsvarande filer.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az bicep format

Formatera en Bicep-fil.

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

Exempel

Formatera en Bicep-fil.

az bicep format --file {bicep_file}

Formatera en Bicep-fil och skriv ut alla utdata till stdout.

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

Formatera en Bicep-fil och spara resultatet i den angivna katalogen.

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

Formatera en Bicep-fil och spara resultatet i den angivna filen.

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

Formatera en Bicep-fil infoga en sista ny rad.

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

Formatera en indragstyp för Bicep-filuppsättningen. Giltiga värden är ( Blanksteg | Fliken ).

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

Formatera en Bicep-fil anger antalet blanksteg som ska dras in med (Endast giltigt med --indent-kind inställt på Blanksteg).

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

Obligatoriska parametrar

--file -f

Sökvägen till Bicep-filen som ska formateras i filsystemet.

Valfria parametrar

--indent-kind

Ange indragstyp.

Godkända värden: Space, Tab
--indent-size

Antal blanksteg att dra in med (Endast giltigt med --indent-kind inställt på Blanksteg).

--insert-final-newline

Infoga en sista ny rad.

--newline
Inaktuell

Alternativet "--newline" har blivit inaktuellt och tas bort i en framtida version. Använd "--newline-kind" i stället.

Ange tecken för ny rad. Giltiga värden är ( Auto | LF | CRLF | CR ).

--newline-kind

Ange radsluttecken.

Godkända värden: CR, CRLF, LF
--outdir

När du har angett sparas utdata i den angivna katalogen.

--outfile

När du har angett sparas utdata som den angivna filsökvägen.

--stdout

När det är inställt skrivs alla utdata ut till stdout i stället för motsvarande filer.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az bicep generate-params

Generera parameterfil för en Bicep-fil.

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

Exempel

Generera parameterfil för en Bicep-fil.

az bicep generate-params --file {bicep_file}

Generera parameterfilen för en Bicep-fil och skriv ut alla utdata till stdout.

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

Generera parameterfilen för en Bicep-fil och spara resultatet i den angivna katalogen.

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

Generera parameterfilen för en Bicep-fil och spara resultatet i den angivna filen.

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

Generera parameterfil för en Bicep-fil utan att återställa externa moduler.

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

Generera parameterfil för en Bicep-fil med angivet utdataformat. Giltiga värden är ( json | bicepparam ).

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

Obligatoriska parametrar

--file -f

Sökvägen till Bicep-filen för att generera parameterfilen från i filsystemet.

Valfria parametrar

--include-params

Ange inkluderingsparamer. Giltiga värden är ( alla | endast obligatoriska ).

--no-restore

När den anges genererar den parameterfilen utan att återställa externa moduler.

--outdir

När du har angett sparas utdata i den angivna katalogen.

--outfile

När du har angett sparas utdata som den angivna filsökvägen.

--output-format

Ange utdataformat. Giltiga värden är ( json | bicepparam ).

--stdout

När det är inställt skrivs alla utdata ut till stdout i stället för motsvarande filer.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az bicep install

Installera Bicep CLI.

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

Exempel

Installera Bicep CLI.

az bicep install

Installera en specifik version av Bicep CLI.

az bicep install --version v0.2.212

Installera Bicep CLI och ange målplattformen.

az bicep install --target-platform linux-x64

Valfria parametrar

--target-platform -t

Plattformen som Bicep CLI körs på. Ange detta för att hoppa över automatisk plattformsidentifiering om det inte fungerar korrekt.

Godkända värden: linux-arm64, linux-musl-x64, linux-x64, osx-arm64, osx-x64, win-arm64, win-x64
--version -v

Den version av Bicep CLI som ska installeras. Standardvärdet är det senaste om det inte anges.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az bicep lint

Lint en Bicep-fil.

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

Exempel

Lint en Bicep-fil.

az bicep lint --file {bicep_file}

Lint en Bicep-fil utan att återställa externa moduler.

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

Lint en Bicep-fil med angivet diagnostikformat. Giltiga värden är ( standard | sarif ).

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

Obligatoriska parametrar

--file -f

Sökvägen till Bicep-modulfilen för lint i filsystemet.

Valfria parametrar

--diagnostics-format

Ange diagnostikformat.

Godkända värden: default, sarif
--no-restore

När den anges genererar den parameterfilen utan att återställa externa moduler.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az bicep list-versions

Visa en lista över alla tillgängliga versioner av Bicep CLI.

az bicep list-versions
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az bicep publish

Publicera en bicep-fil till ett fjärrmodulregister.

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

Exempel

Publicera en bicep-fil.

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

Publicera en bicep-fil som skriver över en befintlig tagg.

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

Publicera en bicep-fil med dokumentations-URI.

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

Publicera en bicep-fil med dokumentations-URI och inkludera källkod

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

Obligatoriska parametrar

--file -f

Sökvägen till Bicep-modulfilen som ska publiceras i filsystemet.

--target -t

Målplatsen där Bicep-modulen publiceras.

Valfria parametrar

--documentation-uri -d

Dokumentations-URI för Bicep-modulen.

--documentationUri
Inaktuell

Alternativet "--documentationuri" har blivit inaktuellt och tas bort i en framtida version. Använd "--documentation-uri" i stället.

Dokumentations-URI för Bicep-modulen.

--force

Tillåt överskrivning av en befintlig Bicep-modulversion.

--with-source
Förhandsgranskning

Publicera källkod med modulen.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az bicep restore

Återställa externa moduler för en bicep-fil.

az bicep restore --file
                 [--force]

Exempel

Återställ externa moduler.

az bicep restore --file {bicep_file}

Återställ externa moduler och skriv över cachelagrade externa moduler.

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

Obligatoriska parametrar

--file -f

Sökvägen till Bicep-filen som externa moduler ska återställas för.

Valfria parametrar

--force

Tillåter att de cachelagrade externa modulerna skrivs över.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az bicep uninstall

Avinstallera Bicep CLI.

az bicep uninstall
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az bicep upgrade

Uppgradera Bicep CLI till den senaste versionen.

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

Exempel

Uppgradera Bicep CLI.

az bicep upgrade

Uppgradera Bicep CLI och ange målplattformen.

az bicep upgrade --target-platform linux-x64

Valfria parametrar

--target-platform -t

Plattformen som Bicep CLI körs på. Ange detta för att hoppa över automatisk plattformsidentifiering om det inte fungerar korrekt.

Godkända värden: linux-arm64, linux-musl-x64, linux-x64, osx-arm64, osx-x64, win-arm64, win-x64
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az bicep version

Visa den installerade versionen av Bicep CLI.

az bicep version
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.