az devcenter admin devbox-definition
Note
Den här referensen är en del av devcenter-tillägget för Azure CLI (version 2.67.0 eller senare). Tillägget installeras automatiskt första gången du kör ett kommandot az devcenter admin devbox-definition. Läs mer om tillägg.
Hantera dev box-definitioner.
Kommandon
| Name | Description | Typ | Status |
|---|---|---|---|
| az devcenter admin devbox-definition create |
Skapa en dev box-definition. |
Extension | GA |
| az devcenter admin devbox-definition delete |
Ta bort en dev box-definition. |
Extension | GA |
| az devcenter admin devbox-definition list |
Lista dev box-definitioner som konfigurerats för ett dev center eller projekt. |
Extension | GA |
| az devcenter admin devbox-definition show |
Hämta en dev box-definition som konfigurerats för ett utvecklingscenter eller ett projekt. |
Extension | GA |
| az devcenter admin devbox-definition update |
Uppdatera en dev box-definition. |
Extension | GA |
| az devcenter admin devbox-definition wait |
Placera CLI i vänteläge tills ett villkor uppfylls. |
Extension | GA |
az devcenter admin devbox-definition create
Skapa en dev box-definition.
az devcenter admin devbox-definition create --dev-center --dev-center-name
--devbox-definition-name --name
--image-reference
--os-storage-type
--resource-group
--sku
[--hibernate-support {Disabled, Enabled}]
[--location]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--tags]
Exempel
Create
az devcenter admin devbox-definition create --location "eastus" --image-reference id="/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0" --os-storage-type "ssd_1024gb" --sku name="general_a_8c32gb_v1" --name "WebDevBox" --dev-center-name "Contoso" --resource-group "rg1"
Obligatoriska parametrar
Namnet på utvecklingscentret. Använd az configure -d dev-center=<dev_center_name> för att konfigurera ett standardvärde.
Namnet på dev box-definitionen.
Bildreferensinformation. Stöd för shorthand-syntax, json-file och yaml-file. Prova "??" för att visa mer.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Properties Arguments |
Lagringstypen som används för operativsystemdisken för dev-rutor som skapats med den här definitionen.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Properties Arguments |
Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.
SKU:n för dev-rutor som skapats med den här definitionen. Stöd för shorthand-syntax, json-file och yaml-file. Prova "??" för att visa mer.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Properties Arguments |
Valfria parametrar
Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.
Anger om dev-rutor som skapats med den här definitionen kan viloläge. Alla bilder kan inte stödja viloläge. Mer information finns i https://aka.ms/devbox/hibernate.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Properties Arguments |
| Godkända värden: | Disabled, Enabled |
Den geo-plats där resursen finns. Värden från: az account list-locations. Du kan konfigurera standardplatsen med hjälp av az configure --defaults location=<location>. När det inte anges används platsen för resursgruppen.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Body Arguments |
Vänta inte tills den långvariga åtgärden har slutförts.
| Egenskap | Värde |
|---|---|
| Godkända värden: | 0, 1, f, false, n, no, t, true, y, yes |
Resursetiketter. Stöd för shorthand-syntax, json-file och yaml-file. Prova "??" för att visa mer.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Body Arguments |
Globala parametrar
Öka loggningsverositeten för att visa alla felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Visa det här hjälpmeddelandet och avsluta.
Visa bara fel och ignorera varningar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Utdataformat.
| Egenskap | Värde |
|---|---|
| Standardvärde: | json |
| Godkända värden: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.
Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.
Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
az devcenter admin devbox-definition delete
Ta bort en dev box-definition.
az devcenter admin devbox-definition delete [--dev-center --dev-center-name]
[--devbox-definition-name --name]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--yes]
Exempel
Delete
az devcenter admin devbox-definition delete --name "WebDevBox" --dev-center-name "Contoso" --resource-group "rg1"
Valfria parametrar
Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.
Namnet på utvecklingscentret. Använd az configure -d dev-center=<dev_center_name> för att konfigurera ett standardvärde.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Resource Id Arguments |
Namnet på dev box-definitionen.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Resource Id Arguments |
Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om 'resurs-ID' argumenten. Du bör ange antingen --id eller andra "Resurs-ID"-argument.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Resource Id Arguments |
Vänta inte tills den långvariga åtgärden har slutförts.
| Egenskap | Värde |
|---|---|
| Godkända värden: | 0, 1, f, false, n, no, t, true, y, yes |
Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Resource Id Arguments |
Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Resource Id Arguments |
Fråga inte efter bekräftelse.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Globala parametrar
Öka loggningsverositeten för att visa alla felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Visa det här hjälpmeddelandet och avsluta.
Visa bara fel och ignorera varningar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Utdataformat.
| Egenskap | Värde |
|---|---|
| Standardvärde: | json |
| Godkända värden: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.
Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
az devcenter admin devbox-definition list
Lista dev box-definitioner som konfigurerats för ett dev center eller projekt.
az devcenter admin devbox-definition list --resource-group
[--dev-center --dev-center-name]
[--max-items]
[--next-token]
[--project --project-name]
Exempel
Lista efter utvecklingscenter
az devcenter admin devbox-definition list --dev-center-name "Contoso" --resource-group "rg1"
Lista efter projekt
az devcenter admin devbox-definition list --project-name "ContosoProject" --resource-group "rg1"
Obligatoriska parametrar
Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.
Valfria parametrar
Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.
Namnet på utvecklingscentret. Använd az configure -d dev-center=<dev_center_name> för att konfigurera ett standardvärde.
Totalt antal objekt som ska returneras i kommandots utdata. Om det totala antalet tillgängliga objekt är mer än det angivna värdet anges en token i kommandots utdata. Om du vill återuppta sidnumreringen anger du tokenvärdet i --next-token argument för ett efterföljande kommando.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Pagination Arguments |
Token för att ange var sidnumrering ska börja. Detta är tokenvärdet från ett tidigare trunkerat svar.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Pagination Arguments |
Namnet på projektet. Använd az configure -d project=<project_name> för att konfigurera ett standardvärde.
Globala parametrar
Öka loggningsverositeten för att visa alla felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Visa det här hjälpmeddelandet och avsluta.
Visa bara fel och ignorera varningar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Utdataformat.
| Egenskap | Värde |
|---|---|
| Standardvärde: | json |
| Godkända värden: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.
Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.
Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
az devcenter admin devbox-definition show
Hämta en dev box-definition som konfigurerats för ett utvecklingscenter eller ett projekt.
az devcenter admin devbox-definition show [--dev-center --dev-center-name]
[--devbox-definition-name --name]
[--ids]
[--project --project-name]
[--resource-group]
[--subscription]
Exempel
Hämta en dev center dev box-definition
az devcenter admin devbox-definition show --name "WebDevBox" --dev-center-name "Contoso" --resource-group "rg1"
Hämta en projekt dev box-definition
az devcenter admin devbox-definition show --name "WebDevBox" --project-name "ContosoProject" --resource-group "rg1"
Valfria parametrar
Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.
Namnet på utvecklingscentret. Använd az configure -d dev-center=<dev_center_name> för att konfigurera ett standardvärde.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Resource Id Arguments |
Namnet på dev box-definitionen.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Resource Id Arguments |
Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om 'resurs-ID' argumenten. Du bör ange antingen --id eller andra "Resurs-ID"-argument.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Resource Id Arguments |
Namnet på projektet. Använd az configure -d project=<project_name> för att konfigurera ett standardvärde.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Resource Id Arguments |
Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Resource Id Arguments |
Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Resource Id Arguments |
Globala parametrar
Öka loggningsverositeten för att visa alla felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Visa det här hjälpmeddelandet och avsluta.
Visa bara fel och ignorera varningar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Utdataformat.
| Egenskap | Värde |
|---|---|
| Standardvärde: | json |
| Godkända värden: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.
Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
az devcenter admin devbox-definition update
Uppdatera en dev box-definition.
az devcenter admin devbox-definition update [--add]
[--dev-center --dev-center-name]
[--devbox-definition-name --name]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--hibernate-support {Disabled, Enabled}]
[--ids]
[--image-reference]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--os-storage-type]
[--remove]
[--resource-group]
[--set]
[--sku]
[--subscription]
[--tags]
Exempel
Update
az devcenter admin devbox-definition update --image-reference id="/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/2.0.0" --name "WebDevBox" --dev-center-name "Contoso" --resource-group "rg1"
Valfria parametrar
Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.
Lägg till ett objekt i en lista över objekt genom att ange en sökväg och nyckelvärdepar. Exempel: --add property.listProperty <key=value, string or JSON string>.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Generic Update Arguments |
Namnet på utvecklingscentret. Använd az configure -d dev-center=<dev_center_name> för att konfigurera ett standardvärde.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Resource Id Arguments |
Namnet på dev box-definitionen.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Resource Id Arguments |
När du använder "set" eller "add" bevarar du strängliteraler i stället för att försöka konvertera till JSON.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Generic Update Arguments |
| Godkända värden: | 0, 1, f, false, n, no, t, true, y, yes |
Anger om dev-rutor som skapats med den här definitionen kan viloläge. Alla bilder kan inte stödja viloläge. Mer information finns i https://aka.ms/devbox/hibernate.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Properties Arguments |
| Godkända värden: | Disabled, Enabled |
Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om 'resurs-ID' argumenten. Du bör ange antingen --id eller andra "Resurs-ID"-argument.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Resource Id Arguments |
Bildreferensinformation. Stöd för shorthand-syntax, json-file och yaml-file. Prova "??" för att visa mer.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Properties Arguments |
Vänta inte tills den långvariga åtgärden har slutförts.
| Egenskap | Värde |
|---|---|
| Godkända värden: | 0, 1, f, false, n, no, t, true, y, yes |
Lagringstypen som används för operativsystemdisken för dev-rutor som skapats med den här definitionen.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Properties Arguments |
Ta bort en egenskap eller ett element från en lista. Exempel: --remove property.list <indexToRemove> ELLER --remove propertyToRemove.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Generic Update Arguments |
Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Resource Id Arguments |
Uppdatera ett objekt genom att ange en egenskapssökväg och ett värde som ska anges. Exempel: --set property1.property2=<value>.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Generic Update Arguments |
SKU:n för dev-rutor som skapats med den här definitionen. Stöd för shorthand-syntax, json-file och yaml-file. Prova "??" för att visa mer.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Properties Arguments |
Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Resource Id Arguments |
Resursetiketter. Stöd för shorthand-syntax, json-file och yaml-file. Prova "??" för att visa mer.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Body Arguments |
Globala parametrar
Öka loggningsverositeten för att visa alla felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Visa det här hjälpmeddelandet och avsluta.
Visa bara fel och ignorera varningar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Utdataformat.
| Egenskap | Värde |
|---|---|
| Standardvärde: | json |
| Godkända värden: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.
Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
az devcenter admin devbox-definition wait
Placera CLI i vänteläge tills ett villkor uppfylls.
az devcenter admin devbox-definition wait [--created]
[--custom]
[--deleted]
[--dev-center --dev-center-name]
[--devbox-definition-name --name]
[--exists]
[--ids]
[--interval]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
Valfria parametrar
Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.
Vänta tills du har skapat med "provisioningState" på "Lyckades".
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Wait Condition Arguments |
| Standardvärde: | False |
Vänta tills villkoret uppfyller en anpassad JMESPath-fråga. T.ex. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Wait Condition Arguments |
Vänta tills den har tagits bort.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Wait Condition Arguments |
| Standardvärde: | False |
Namnet på utvecklingscentret. Använd az configure -d dev-center=<dev_center_name> för att konfigurera ett standardvärde.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Resource Id Arguments |
Namnet på dev box-definitionen.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Resource Id Arguments |
Vänta tills resursen finns.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Wait Condition Arguments |
| Standardvärde: | False |
Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om 'resurs-ID' argumenten. Du bör ange antingen --id eller andra "Resurs-ID"-argument.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Resource Id Arguments |
Avsökningsintervall i sekunder.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Wait Condition Arguments |
| Standardvärde: | 30 |
Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Resource Id Arguments |
Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Resource Id Arguments |
Maximal väntetid i sekunder.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Wait Condition Arguments |
| Standardvärde: | 3600 |
Vänta tills det har uppdaterats med provisioningState på Lyckades.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Wait Condition Arguments |
| Standardvärde: | False |
Globala parametrar
Öka loggningsverositeten för att visa alla felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Visa det här hjälpmeddelandet och avsluta.
Visa bara fel och ignorera varningar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Utdataformat.
| Egenskap | Värde |
|---|---|
| Standardvärde: | json |
| Godkända värden: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.
Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |