Freigeben über

az vm extension

  • Referenz

Verwalten von Erweiterungen auf virtuellen Computern.

Erweiterungen sind kleine Anwendungen, die Konfiguration und Automatisierungsaufgaben nach der Bereitstellung auf virtuellen Azure-Computern bereitstellen. Wenn beispielsweise ein virtueller Computer Softwareinstallation, Virenschutz oder Docker-Konfiguration erfordert, kann eine VM-Erweiterung verwendet werden, um diese Aufgaben auszuführen. Erweiterungen können mit einer neuen Bereitstellung virtueller Computer gebündelt oder für jedes vorhandene System ausgeführt werden.

Befehle

Name Beschreibung Typ Status
az vm extension delete

Löschvorgang zum Löschen der Erweiterung.

 Kern GA
az vm extension image

Suchen Sie die verfügbaren VM-Erweiterungen für ein Abonnement und eine Region.

 Kern GA
az vm extension image list

Listet die Informationen zu den verfügbaren Erweiterungen auf.

 Kern GA
az vm extension image list-names

Listet die Namen der verfügbaren Erweiterungen auf.

 Kern GA
az vm extension image list-versions

Listet die Versionen für verfügbare Erweiterungen auf.

 Kern GA
az vm extension image show

Anzeigen von Informationen für eine Erweiterung.

 Kern GA
az vm extension list

Auflisten der Erweiterungen, die an einen virtuellen Computer angefügt sind.

 Kern GA
az vm extension set

Legen Sie Erweiterungen für einen virtuellen Computer fest.

 Kern GA
az vm extension show

Zeigen Sie Informationen zu Erweiterungen an, die an einen virtuellen Computer angefügt sind.

 Kern GA
az vm extension wait

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

 Kern GA

az vm extension delete

Bearbeiten

Löschvorgang zum Löschen der Erweiterung.

az vm extension delete [--ids]
                       [--name --vm-extension-name]
                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                       [--resource-group]
                       [--subscription]
                       [--vm-name]

Beispiele

Verwenden Sie einen VIRTUELLEN Namen und eine Erweiterung, um eine Erweiterung von einem virtuellen Computer zu löschen.

az vm extension delete -g MyResourceGroup --vm-name MyVm -n MyExtensionName

Löschen Sie Erweiterungen mit IDs, die die Zeichenfolge "MyExtension" von einer VM enthalten.

az vm extension delete --ids $(az resource list --query "[?contains(name, 'MyExtension')].id" -o tsv)

Optionale Parameter

--ids

Mindestens eine 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.

--name --vm-extension-name -n

Der Name der Erweiterung des virtuellen Computers.

--no-wait

Warten Sie nicht, bis der lange ausgeführte Vorgang abgeschlossen ist.

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

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--vm-name

Der Name des virtuellen Computers. Sie können die Standardeinstellung mithilfe von az configure --defaults vm=<name>.

Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, 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

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

az vm extension list

Bearbeiten

Auflisten der Erweiterungen, die an einen virtuellen Computer angefügt sind.

az vm extension list [--ids]
                     [--resource-group]
                     [--subscription]
                     [--vm-name]

Beispiele

Auflisten angefügter Erweiterungen an einen benannten virtuellen Computer.

az vm extension list -g MyResourceGroup --vm-name MyVm

Optionale Parameter

--ids

Mindestens eine 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.

--resource-group -g

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

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--vm-name

Der Name des virtuellen Computers. Sie können die Standardeinstellung mithilfe von az configure --defaults vm=<name>.

Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, 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

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

az vm extension set

Bearbeiten

Legen Sie Erweiterungen für einen virtuellen Computer fest.

Abrufen von Erweiterungsdetails von az vm extension image list.

az vm extension set --name
                    --publisher
                    [--enable-auto-upgrade {false, true}]
                    [--extension-instance-name]
                    [--force-update]
                    [--ids]
                    [--no-auto-upgrade {false, true}]
                    [--no-auto-upgrade-minor-version {false, true}]
                    [--no-wait]
                    [--protected-settings]
                    [--resource-group]
                    [--settings]
                    [--subscription]
                    [--version]
                    [--vm-name]

Beispiele

Fügen Sie einem virtuellen Linux-Computer ein Benutzerkonto hinzu.

az vm extension set -n VMAccessForLinux --publisher Microsoft.OSTCExtensions --version 1.4 \
    --vm-name MyVm --resource-group MyResourceGroup \
    --protected-settings '{"username":"user1", "ssh_key":"ssh_rsa ..."}'

Fügen Sie eine benutzerdefinierteScript-Erweiterung zu virtuellen Computern hinzu, die durch --ids angegeben werden.

az vm extension set -n customScript --publisher Microsoft.Azure.Extensions --ids {vm_id}

Fügen Sie eine Erweiterung hinzu, und aktivieren Sie das automatische Upgrade durch die Plattform, wenn eine neuere Version der Erweiterung verfügbar ist.

az vm extension set -n extName --publisher publisher --vm-name MyVM -g MyResourceGroup \
--enable-auto-upgrade true

Erforderliche Parameter

--name -n

Name der Erweiterung.

Wert aus: az vm extension image list
--publisher

Der Name des Erweiterungsherausgebers.

Optionale Parameter

--enable-auto-upgrade

Geben Sie an, dass die Erweiterung von der Plattform automatisch aktualisiert werden soll, wenn eine neuere Version der Erweiterung verfügbar ist.

Zulässige Werte: false, true
--extension-instance-name

Name der Erweiterungsinstanz, die angepasst werden kann. Standard: Name der Erweiterung.

--force-update

Erzwingen Sie das Aktualisieren, auch wenn sich die Erweiterungskonfiguration nicht geändert hat.

Standardwert: False
--ids

Mindestens eine 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-auto-upgrade
Als veraltet markiert

Option "--no-auto-upgrade" ist veraltet und wird in einer zukünftigen Version entfernt. Verwenden Sie stattdessen "---no-auto-upgrade-minor-version".

Bei Festlegung wählt der Erweiterungsdienst nicht automatisch die neueste Nebenversion aus, auch wenn die Erweiterung erneut bereitgestellt wird.

Zulässige Werte: false, true
Standardwert: False
--no-auto-upgrade-minor-version

Bei Festlegung wählt der Erweiterungsdienst nicht automatisch die neueste Nebenversion aus, auch wenn die Erweiterung erneut bereitgestellt wird.

Zulässige Werte: false, true
Standardwert: False
--no-wait

Warten Sie nicht, bis der lange ausgeführte Vorgang abgeschlossen ist.

Standardwert: False
--protected-settings

Geschützte Einstellungen im JSON-Format für vertrauliche Informationen wie Anmeldeinformationen. Ein JSON-Dateipfad wird ebenfalls akzeptiert.

--resource-group -g

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

--settings

Erweiterungseinstellungen im JSON-Format. Ein JSON-Dateipfad wird ebenfalls akzeptiert.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--version

Die Version der Erweiterung. Zum Anheften der Erweiterungsversion an diesen Wert geben Sie bitte "--no-auto-upgrade-minor-version" an.

--vm-name

Der Name des virtuellen Computers. Sie können die Standardeinstellung mithilfe von az configure --defaults vm=<name>.

Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, 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

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

az vm extension show

Bearbeiten

Zeigen Sie Informationen zu Erweiterungen an, die an einen virtuellen Computer angefügt sind.

az vm extension show [--ids]
                     [--instance-view]
                     [--name]
                     [--resource-group]
                     [--subscription]
                     [--vm-name]

Beispiele

Verwenden Sie vm-Name und Erweiterungsname, um die Erweiterungen anzuzeigen, die an eine VM angefügt sind.

az vm extension show -g MyResourceGroup --vm-name MyVm -n extension_name

Optionale Parameter

--ids

Mindestens eine 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.

--instance-view

Die Instanzansicht einer Erweiterung eines virtuellen Computers.

Standardwert: False
--name -n

Name der Erweiterung.

--resource-group -g

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

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--vm-name

Der Name des virtuellen Computers. Sie können die Standardeinstellung mithilfe von az configure --defaults vm=<name>.

Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, 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

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

az vm extension wait

Bearbeiten

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

az vm extension wait [--created]
                     [--custom]
                     [--deleted]
                     [--exists]
                     [--expand]
                     [--ids]
                     [--interval]
                     [--name --vm-extension-name]
                     [--resource-group]
                     [--subscription]
                     [--timeout]
                     [--updated]
                     [--vm-name]

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
--exists

Warten Sie, bis die Ressource vorhanden ist.

Standardwert: False
--expand

Der erweiterungsausdruck, der für den Vorgang angewendet werden soll.

--ids

Mindestens eine 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
--name --vm-extension-name -n

Der Name der Erweiterung des virtuellen Computers.

--resource-group -g

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

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--timeout

Maximale Wartezeit in Sekunden.

Standardwert: 3600
--updated

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

Standardwert: False
--vm-name

Der Name des virtuellen Computers. Sie können die Standardeinstellung mithilfe von az configure --defaults vm=<name>.

Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, 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

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.