Dela via

az deployment group

  • Referens

Hantera distribution av Azure Resource Manager-mallar i resursgruppen.

Kommandon

Name Description Typ Status
az deployment group cancel

Avbryt en distribution i resursgruppen.

 Kärna Allmän tillgänglighet
az deployment group create

Starta en distribution i resursgruppen.

 Kärna Allmän tillgänglighet
az deployment group delete

Ta bort en distribution i resursgruppen.

 Kärna Allmän tillgänglighet
az deployment group export

Exportera mallen som används för en distribution.

 Kärna Allmän tillgänglighet
az deployment group list

Lista distributioner i resursgruppen.

 Kärna Allmän tillgänglighet
az deployment group show

Visa en distribution i resursgruppen.

 Kärna Allmän tillgänglighet
az deployment group validate

Kontrollera om en mall är giltig i resursgruppen.

 Kärna Allmän tillgänglighet
az deployment group wait

Placera CLI i vänteläge tills ett distributionsvillkor uppfylls.

 Kärna Allmän tillgänglighet
az deployment group what-if

Kör en distributionsåtgärd med vad händer om i resursgruppens omfång.

 Kärna Allmän tillgänglighet

az deployment group cancel

Redigera

Avbryt en distribution i resursgruppen.

az deployment group cancel --name
                           --resource-group

Exempel

Avbryt en distribution i resursgruppen.

az deployment group cancel -g testrg -n deployment01

Obligatoriska parametrar

--name -n

Distributionsnamnet.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

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 deployment group create

Redigera

Starta en distribution i resursgruppen.

Ange endast en av --template-file FILE | --template-uri URI | --template-spec för att mata in ARM-mallen.

az deployment group create --resource-group
                           [--aux-subs]
                           [--aux-tenants]
                           [--confirm-with-what-if]
                           [--handle-extended-json-format]
                           [--mode {Complete, Incremental}]
                           [--name]
                           [--no-prompt {false, true}]
                           [--no-wait]
                           [--parameters]
                           [--proceed-if-no-change]
                           [--query-string]
                           [--rollback-on-error]
                           [--template-file]
                           [--template-spec]
                           [--template-uri]
                           [--what-if]
                           [--what-if-exclude-change-types {Create, Delete, Deploy, Ignore, Modify, NoChange, Unsupported}]
                           [--what-if-result-format {FullResourcePayloads, ResourceIdOnly}]

Exempel

Skapa en distribution i resursgruppen från en fjärrmallfil med parametrar från en lokal JSON-fil.

az deployment group create --resource-group testrg --name rollout01 \
    --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json

Skapa en distribution i resursgruppen från en lokal mallfil med hjälp av parametrar från en JSON-sträng.

az deployment group create --resource-group testrg --name rollout01 \
    --template-file azuredeploy.json  \
    --parameters '{ \"policyName\": { \"value\": \"policy2\" } }'

Skapa en distribution i resursgruppen från en lokal mallfil med parametrar från en matrissträng.

az deployment group create --resource-group testgroup --template-file demotemplate.json --parameters exampleString='inline string' exampleArray='("value1", "value2")'

Skapa en distribution i resursgruppen från en lokal mall med hjälp av en parameterfil, en fjärrparparfil och selektivt åsidosätta nyckel-/värdepar.

az deployment group create --resource-group testrg --name rollout01 \
    --template-file azuredeploy.json  --parameters @params.json \
    --parameters https://mysite/params.json --parameters MyValue=This MyArray=@array.json

Skapa en distribution i resursgruppsomfånget från en mallspecifikation

az deployment group create --resource-group testrg --template-spec "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Resources/templateSpecs/myTemplateSpec/versions/1.0"

Skapa en distribution i resursgruppsomfånget från en bicepparam-parameterfil

az deployment group create --resource-group testrg --parameters parameters.bicepparam

Skapa en distribution i resursgruppen mellan klientorganisationer

az deployment group create --resource-group testrg --name rollout01 \
    --template-file azuredeploy.json --parameters @myparameters.json --aux-tenants auxiliary_tenant01 auxiliary_tenant02

Obligatoriska parametrar

--resource-group -g

Resursgruppen som du vill skapa distribution på.

Valfria parametrar

--aux-subs
Inaktuell

Alternativet "--aux-subs" har blivit inaktuellt och tas bort i en framtida version. Använd "--aux-tenants" i stället.

Extraprenumerationer som ska användas under distributionen mellan klientorganisationer.

--aux-tenants

Hjälpklienter som ska användas under distributionen mellan klientorganisationer.

--confirm-with-what-if -c

Instruera kommandot att köra distributionen What-If innan du kör distributionen. Sedan uppmanas du att bekräfta resursändringar innan den fortsätter.

--handle-extended-json-format -j
Inaktuell

Alternativet "--handle-extended-json-format/-j" har blivit inaktuellt och tas bort i en framtida version.

Stöd för att hantera utökat mallinnehåll, inklusive flera ledningar och kommentarer i distributionen.

--mode

Distributionsläget.

Godkända värden: Complete, Incremental
Standardvärde: Incremental
--name -n

Distributionsnamnet.

--no-prompt

Alternativet för att inaktivera frågan om saknade parametrar för ARM-mallen. När värdet är sant ignoreras uppmaningen som kräver att användarna anger en parameter som saknas. Standardvärdet är "false".

Godkända värden: false, true
Standardvärde: False
--no-wait

Vänta inte tills den långvariga åtgärden har slutförts.

Standardvärde: False
--parameters -p

Ange parametervärden för distribution.

Parametrar kan anges från en fil med hjälp av syntaxen @{path} , en JSON-sträng eller som <KEY=VALUE-par> . Parametrar utvärderas i ordning, så när ett värde tilldelas två gånger används det senare värdet. Vi rekommenderar att du anger parameterfilen först och sedan åsidosätter selektivt med hjälp av KEY=VALUE-syntax. Observera också att om du tillhandahåller en bicepparam-fil kan du bara använda det här argumentet en gång.

--proceed-if-no-change

Instruera kommandot att köra distributionen om konsekvensresultatet inte innehåller några resursändringar. Gäller när --confirm-with-what-if har angetts.

--query-string -q

Frågesträngen (en SAS-token) som ska användas med mall-uri när det gäller länkade mallar.

--rollback-on-error

Namnet på en distribution som ska återställas till vid fel, eller använd som en flagga för att återställa till den senaste lyckade distributionen.

--template-file -f

Sökvägen till mallfilen eller Bicep-filen.

--template-spec -s

Resurs-ID:t för mallspecifikationen.

--template-uri -u

URI:n till mallfilen.

--what-if -w

Instruera kommandot att köra distributionen What-If.

--what-if-exclude-change-types -x

Blankstegsavgränsad lista över resursändringstyper som ska undantas från konsekvensresultat. Gäller när --confirm-with-what-if har angetts.

Godkända värden: Create, Delete, Deploy, Ignore, Modify, NoChange, Unsupported
--what-if-result-format -r

Formatet för Konsekvensresultat. Gäller när --confirm-with-what-if har angetts.

Godkända värden: FullResourcePayloads, ResourceIdOnly
Standardvärde: FullResourcePayloads
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 deployment group delete

Redigera

Ta bort en distribution i resursgruppen.

az deployment group delete --name
                           --resource-group
                           [--no-wait]

Exempel

Ta bort en distribution i resursgruppen.

az deployment group delete -g testrg -n deployment01

Obligatoriska parametrar

--name -n

Distributionsnamnet.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

Valfria parametrar

--no-wait

Vänta inte tills den långvariga åtgärden har slutförts.

Standardvärde: False
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 deployment group export

Redigera

Exportera mallen som används för en distribution.

az deployment group export --name
                           --resource-group

Exempel

Exportera mallen som används för en distribution i resursgruppen.

az deployment group export --resource-group testrg --name MyDeployment

Obligatoriska parametrar

--name -n

Distributionsnamnet.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

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 deployment group list

Redigera

Lista distributioner i resursgruppen.

az deployment group list --resource-group
                         [--filter]

Exempel

Lista distributioner i resursgruppen.

az deployment group list -g testrg

Obligatoriska parametrar

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

Valfria parametrar

--filter
Förhandsgranskning

Filtrera uttryck med OData-notation. Du kan använda --filter "provisioningState eq {state}" för att filtrera provisioningState. Mer information finns i https://docs.microsoft.com/rest/api/resources/deployments/listatsubscriptionscope#uri-parameters.

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 deployment group show

Redigera

Visa en distribution i resursgruppen.

az deployment group show --name
                         --resource-group

Exempel

Visa en distribution i resursgruppen.

az deployment group show -g testrg -n deployment01

Obligatoriska parametrar

--name -n

Distributionsnamnet.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

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 deployment group validate

Redigera

Kontrollera om en mall är giltig i resursgruppen.

Ange endast en av --template-file FILE | --template-uri URI | --template-spec för att mata in ARM-mallen.

az deployment group validate --resource-group
                             [--handle-extended-json-format]
                             [--mode {Complete, Incremental}]
                             [--name]
                             [--no-prompt {false, true}]
                             [--parameters]
                             [--query-string]
                             [--rollback-on-error]
                             [--template-file]
                             [--template-spec]
                             [--template-uri]

Exempel

Kontrollera om en mall är giltig i resursgruppen.

az deployment group validate --resource-group testrg --template-file {template-file}

Kontrollera om en mall är giltig i resursgruppen. (automatiskt genererad)

az deployment group validate --parameters MyValue=This MyArray=@array.json --resource-group testrg --template-file azuredeploy.json

Obligatoriska parametrar

--resource-group -g

Resursgruppen som du vill skapa distribution på.

Valfria parametrar

--handle-extended-json-format -j
Inaktuell

Alternativet "--handle-extended-json-format/-j" har blivit inaktuellt och tas bort i en framtida version.

Stöd för att hantera utökat mallinnehåll, inklusive flera ledningar och kommentarer i distributionen.

--mode

Distributionsläget.

Godkända värden: Complete, Incremental
Standardvärde: Incremental
--name -n

Distributionsnamnet.

--no-prompt

Alternativet för att inaktivera frågan om saknade parametrar för ARM-mallen. När värdet är sant ignoreras uppmaningen som kräver att användarna anger en parameter som saknas. Standardvärdet är "false".

Godkända värden: false, true
Standardvärde: False
--parameters -p

Ange parametervärden för distribution.

Parametrar kan anges från en fil med hjälp av syntaxen @{path} , en JSON-sträng eller som <KEY=VALUE-par> . Parametrar utvärderas i ordning, så när ett värde tilldelas två gånger används det senare värdet. Vi rekommenderar att du anger parameterfilen först och sedan åsidosätter selektivt med hjälp av KEY=VALUE-syntax.

--query-string -q

Frågesträngen (en SAS-token) som ska användas med mall-uri när det gäller länkade mallar.

--rollback-on-error

Namnet på en distribution som ska återställas till vid fel, eller använd som en flagga för att återställa till den senaste lyckade distributionen.

--template-file -f

Sökvägen till mallfilen eller Bicep-filen.

--template-spec -s

Resurs-ID:t för mallspecifikationen.

--template-uri -u

URI:n till mallfilen.

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 deployment group wait

Redigera

Placera CLI i vänteläge tills ett distributionsvillkor uppfylls.

az deployment group wait --name
                         --resource-group
                         [--created]
                         [--custom]
                         [--deleted]
                         [--exists]
                         [--interval]
                         [--timeout]
                         [--updated]

Exempel

Placera CLI i vänteläge tills ett distributionsvillkor uppfylls. (automatiskt genererad)

az deployment group wait --created --name MyDeployment --resource-group MyResourceGroup

Obligatoriska parametrar

--name -n

Distributionsnamnet.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

Valfria parametrar

--created

Vänta tills du har skapat med "provisioningState" på "Lyckades".

Standardvärde: False
--custom

Vänta tills villkoret uppfyller en anpassad JMESPath-fråga. T.ex. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Vänta tills den har tagits bort.

Standardvärde: False
--exists

Vänta tills resursen finns.

Standardvärde: False
--interval

Avsökningsintervall i sekunder.

Standardvärde: 30
--timeout

Maximal väntetid i sekunder.

Standardvärde: 3600
--updated

Vänta tills det har uppdaterats med provisioningState på Lyckades.

Standardvärde: False
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 deployment group what-if

Redigera

Kör en distributionsåtgärd med vad händer om i resursgruppens omfång.

Ange endast en av --template-file FILE | --template-uri URI | --template-spec för att mata in ARM-mallen.

az deployment group what-if --resource-group
                            [--aux-tenants]
                            [--exclude-change-types {Create, Delete, Deploy, Ignore, Modify, NoChange, Unsupported}]
                            [--mode {Complete, Incremental}]
                            [--name]
                            [--no-pretty-print]
                            [--no-prompt {false, true}]
                            [--parameters]
                            [--query-string]
                            [--result-format {FullResourcePayloads, ResourceIdOnly}]
                            [--template-file]
                            [--template-spec]
                            [--template-uri]

Exempel

Kör en distributionsåtgärd för konsekvens i en resursgrupp.

az deployment group what-if --resource-group testrg --name rollout01 --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json

Kör en distributionsåtgärd för konsekvensanalys i en resursgrupp med ResourceIdOnly-format.

az deployment group what-if --resource-group testrg --name rollout01 --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json --result-format ResourceIdOnly

Kör en distributionsåtgärd för Konsekvens i en resursgrupp utan att skriva ut resultatet på ett snyggt sätt.

az deployment group what-if --resource-group testrg --name rollout01 --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json --no-pretty-print

Obligatoriska parametrar

--resource-group -g

Resursgruppen som ska köra distributionsåtgärden What-If på.

Valfria parametrar

--aux-tenants

Hjälpklienter som ska användas under distributionen mellan klientorganisationer.

--exclude-change-types -x

Blankstegsavgränsad lista över resursändringstyper som ska undantas från konsekvensresultat.

Godkända värden: Create, Delete, Deploy, Ignore, Modify, NoChange, Unsupported
--mode

Distributionsläget.

Godkända värden: Complete, Incremental
Standardvärde: Incremental
--name -n

Distributionsnamnet.

--no-pretty-print

Inaktivera ganska skrivskyddade resultat för konsekvensanalys. När den anges används formattypen för utdata.

--no-prompt

Alternativet för att inaktivera frågan om saknade parametrar för ARM-mallen. När värdet är sant ignoreras uppmaningen som kräver att användarna anger en parameter som saknas. Standardvärdet är "false".

Godkända värden: false, true
Standardvärde: False
--parameters -p

Ange parametervärden för distribution.

Parametrar kan anges från en fil med hjälp av syntaxen @{path} , en JSON-sträng eller som <KEY=VALUE-par> . Parametrar utvärderas i ordning, så när ett värde tilldelas två gånger används det senare värdet. Vi rekommenderar att du anger parameterfilen först och sedan åsidosätter selektivt med hjälp av KEY=VALUE-syntax.

--query-string -q

Frågesträngen (en SAS-token) som ska användas med mall-uri när det gäller länkade mallar.

--result-format -r

Formatet för Konsekvensresultat.

Godkända värden: FullResourcePayloads, ResourceIdOnly
Standardvärde: FullResourcePayloads
--template-file -f

Sökvägen till mallfilen eller Bicep-filen.

--template-spec -s

Resurs-ID:t för mallspecifikationen.

--template-uri -u

URI:n till mallfilen.

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.