Freigeben über

az devcenter admin devbox-definition

  • Referenz

Hinweis

Diese Referenz ist Teil der Devcenter-Erweiterung für die Azure CLI (Version 2.51.0 oder höher). Die Erweiterung wird automatisch installiert, wenn Sie einen az devcenter admin devbox-definition-Befehl zum ersten Mal ausführen. Weitere Informationen zu Erweiterungen

Verwalten von Dev Box-Definitionen.

Befehle

Name Beschreibung Typ Status
az devcenter admin devbox-definition create

Erstellen Sie eine Dev Box-Definition.

 Durchwahl Allgemein verfügbar
az devcenter admin devbox-definition delete

Löschen sie eine Dev Box-Definition.

 Durchwahl Allgemein verfügbar
az devcenter admin devbox-definition list

Listen von Dev Box-Definitionen, die für ein Dev Center oder Projekt konfiguriert sind.

 Durchwahl Allgemein verfügbar
az devcenter admin devbox-definition show

Rufen Sie eine Dev Box-Definition ab, die für ein Dev Center oder ein Projekt konfiguriert ist.

 Durchwahl Allgemein verfügbar
az devcenter admin devbox-definition update

Aktualisieren einer Dev Box-Definition.

 Durchwahl Allgemein verfügbar
az devcenter admin devbox-definition wait

Platzieren Sie die CLI in einem Wartezustand, bis eine Bedingung erfüllt ist.

 Durchwahl Allgemein verfügbar

az devcenter admin devbox-definition create

Erstellen Sie eine Dev Box-Definition.

az devcenter admin devbox-definition create --dev-center
                                            --devbox-definition-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]

Beispiele

Erstellen

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"

Erforderliche Parameter

--dev-center --dev-center-name -d

Der Name des Dev Centers. Wird az configure -d dev-center=<dev_center_name> verwendet, um einen Standardwert zu konfigurieren.

--devbox-definition-name --name -n

Der Name der Dev Box-Definition.

--image-reference

Bildreferenzinformationen. Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen.

--os-storage-type

Der Speichertyp, der für den Betriebssystemdatenträger von Entwicklungsfeldern verwendet wird, die mit dieser Definition erstellt wurden.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

--sku

Die SKU für Entwicklerfelder, die mit dieser Definition erstellt wurden. Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen.

Optionale Parameter

--hibernate-support

Gibt an, ob mit dieser Definition erstellte Entwicklungsfelder in der Lage sind, ruhen zu können. Nicht alle Bilder sind in der Lage, den Ruhezustand zu unterstützen. Weitere Informationen finden Sie unter https://aka.ms/devbox/hibernate.

Zulässige Werte: Disabled, Enabled
--location -l

Der geografische Standort, an dem sich die Ressource befindet. Werte aus: az account list-locations. Sie können den standardmäßig verwendeten Standort mit az configure --defaults location=<location> konfigurieren. Wenn nicht angegeben, wird der Speicherort der Ressourcengruppe verwendet.

--no-wait

Nicht auf den Abschluss lang andauernder Vorgänge warten

Zulässige Werte: 0, 1, f, false, n, no, t, true, y, yes
--tags

Ressourcentags. Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az devcenter admin devbox-definition delete

Löschen sie eine Dev Box-Definition.

az devcenter admin devbox-definition delete [--dev-center]
                                            [--devbox-definition-name]
                                            [--ids]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--resource-group]
                                            [--subscription]
                                            [--yes]

Beispiele

Entf

az devcenter admin devbox-definition delete --name "WebDevBox" --dev-center-name "Contoso" --resource-group "rg1"

Optionale Parameter

--dev-center --dev-center-name -d

Der Name des Dev Centers. Wird az configure -d dev-center=<dev_center_name> verwendet, um einen Standardwert zu konfigurieren.

--devbox-definition-name --name -n

Der Name der Dev Box-Definition.

--ids

Eine oder mehrere Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.

--no-wait

Nicht auf den Abschluss lang andauernder Vorgänge warten

Zulässige Werte: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--yes -y

Nicht zur Bestätigung auffordern

Standardwert: False
Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az devcenter admin devbox-definition list

Listen von Dev Box-Definitionen, die für ein Dev Center oder Projekt konfiguriert sind.

az devcenter admin devbox-definition list --resource-group
                                          [--dev-center]
                                          [--max-items]
                                          [--next-token]
                                          [--project]

Beispiele

Nach Dev Center auflisten

az devcenter admin devbox-definition list --dev-center-name "Contoso" --resource-group "rg1"

Nach Projekt auflisten

az devcenter admin devbox-definition list --project-name "ContosoProject" --resource-group "rg1"

Erforderliche Parameter

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

Optionale Parameter

--dev-center --dev-center-name -d

Der Name des Dev Centers. Wird az configure -d dev-center=<dev_center_name> verwendet, um einen Standardwert zu konfigurieren.

--max-items

Die Gesamtanzahl der Elemente, die in der Ausgabe des Befehls zurückgegeben werden sollen. Wenn die Gesamtanzahl der verfügbaren Elemente größer als der angegebene Wert ist, wird ein Token in der Ausgabe des Befehls bereitgestellt. Um die Paginierung fortzusetzen, geben Sie den Tokenwert im --next-token Argument eines nachfolgenden Befehls an.

--next-token

Token, das angibt, wo die Paginierung beginnen soll. Dies ist der Tokenwert aus einer zuvor abgeschnittenen Antwort.

--project --project-name

Der Name des Projekts. Wird az configure -d project=<project_name> verwendet, um einen Standardwert zu konfigurieren.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az devcenter admin devbox-definition show

Rufen Sie eine Dev Box-Definition ab, die für ein Dev Center oder ein Projekt konfiguriert ist.

az devcenter admin devbox-definition show [--dev-center]
                                          [--devbox-definition-name]
                                          [--ids]
                                          [--project]
                                          [--resource-group]
                                          [--subscription]

Beispiele

Abrufen einer Dev Center-Dev-Box-Definition

az devcenter admin devbox-definition show --name "WebDevBox" --dev-center-name "Contoso" --resource-group "rg1"

Abrufen einer Projektentwicklungsfelddefinition

az devcenter admin devbox-definition show --name "WebDevBox" --project-name "ContosoProject" --resource-group "rg1"

Optionale Parameter

--dev-center --dev-center-name -d

Der Name des Dev Centers. Wird az configure -d dev-center=<dev_center_name> verwendet, um einen Standardwert zu konfigurieren.

--devbox-definition-name --name -n

Der Name der Dev Box-Definition.

--ids

Eine oder mehrere Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.

--project --project-name

Der Name des Projekts. Wird az configure -d project=<project_name> verwendet, um einen Standardwert zu konfigurieren.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az devcenter admin devbox-definition update

Aktualisieren einer Dev Box-Definition.

az devcenter admin devbox-definition update [--add]
                                            [--dev-center]
                                            [--devbox-definition-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]

Beispiele

Aktualisieren

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"

Optionale Parameter

--add

Fügen Sie einer Liste von Objekten ein Objekt hinzu, indem Sie ein Pfad- und Schlüsselwertpaar angeben. Beispiel: --add property.listProperty <key=value, string or JSON string>.

--dev-center --dev-center-name -d

Der Name des Dev Centers. Wird az configure -d dev-center=<dev_center_name> verwendet, um einen Standardwert zu konfigurieren.

--devbox-definition-name --name -n

Der Name der Dev Box-Definition.

--force-string

Wenn Sie "set" oder "add" verwenden, behalten Sie Zeichenfolgenliterale bei, anstatt zu versuchen, in JSON zu konvertieren.

Zulässige Werte: 0, 1, f, false, n, no, t, true, y, yes
--hibernate-support
Vorschau

Gibt an, ob mit dieser Definition erstellte Entwicklungsfelder in der Lage sind, ruhen zu können. Nicht alle Bilder sind in der Lage, den Ruhezustand zu unterstützen. Weitere Informationen finden Sie unter https://aka.ms/devbox/hibernate.

Zulässige Werte: Disabled, Enabled
--ids

Eine oder mehrere Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.

--image-reference

Bildreferenzinformationen. Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen.

--no-wait

Nicht auf den Abschluss lang andauernder Vorgänge warten

Zulässige Werte: 0, 1, f, false, n, no, t, true, y, yes
--os-storage-type

Der Speichertyp, der für den Betriebssystemdatenträger von Entwicklungsfeldern verwendet wird, die mit dieser Definition erstellt wurden.

--remove

Entfernen sie eine Eigenschaft oder ein Element aus einer Liste. Beispiel: --remove property.list OR --remove propertyToRemove.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

--set

Aktualisieren Sie ein Objekt, indem Sie einen festzulegenden Eigenschaftspfad und -wert angeben. Beispiel: --set property1.property2=.

--sku

Die SKU für Entwicklerfelder, die mit dieser Definition erstellt wurden. Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--tags

Ressourcentags. Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az devcenter admin devbox-definition wait

Platzieren Sie die CLI in einem Wartezustand, bis eine Bedingung erfüllt ist.

az devcenter admin devbox-definition wait [--created]
                                          [--custom]
                                          [--deleted]
                                          [--dev-center]
                                          [--devbox-definition-name]
                                          [--exists]
                                          [--ids]
                                          [--interval]
                                          [--resource-group]
                                          [--subscription]
                                          [--timeout]
                                          [--updated]

Optionale Parameter

--created

Warten Sie, bis sie mit 'provisioningState' unter 'Succeeded' erstellt wurde.

Standardwert: False
--custom

Warten Sie, bis die Bedingung eine benutzerdefinierte JMESPath-Abfrage erfüllt. Beispiel: provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Warten Sie, bis sie gelöscht wurde.

Standardwert: False
--dev-center --dev-center-name -d

Der Name des Dev Centers. Wird az configure -d dev-center=<dev_center_name> verwendet, um einen Standardwert zu konfigurieren.

--devbox-definition-name --name -n

Der Name der Dev Box-Definition.

--exists

Warten Sie, bis die Ressource vorhanden ist.

Standardwert: False
--ids

Eine oder mehrere Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.

--interval

Abrufintervall in Sekunden.

Standardwert: 30
--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--timeout

Maximale Wartezeit in Sekunden.

Standardwert: 3600
--updated

Warten Sie, bis sie mit provisioningState unter 'Succeeded' aktualisiert wurde.

Standardwert: False
Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.