Freigeben über


az vm extension

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.

Core GA
az vm extension image

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

Core GA
az vm extension image list

Listet die Informationen zu den verfügbaren Erweiterungen auf.

Core GA
az vm extension image list-names

Listet die Namen der verfügbaren Erweiterungen auf.

Core GA
az vm extension image list-versions

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

Core GA
az vm extension image show

Anzeigen von Informationen für eine Erweiterung.

Core GA
az vm extension list

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

Core GA
az vm extension set

Legen Sie Erweiterungen für einen virtuellen Computer fest.

Core GA
az vm extension show

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

Core GA
az vm extension wait

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

Core GA

az vm extension delete

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Eigenschaft Wert
Parameter group: Resource Id Arguments
--name --vm-extension-name -n

Der Name der Erweiterung des virtuellen Computers.

Eigenschaft Wert
Parameter group: Resource Id Arguments
--no-wait

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

Eigenschaft Wert
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.

Eigenschaft Wert
Parameter group: Resource Id Arguments
--subscription

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

Eigenschaft Wert
Parameter group: Resource Id Arguments
--vm-name

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

Eigenschaft Wert
Parameter group: Resource Id Arguments
Globale Parameter
--debug

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

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Output format.

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

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

--verbose

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

Eigenschaft Wert
Standardwert: False

az vm extension list

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Eigenschaft Wert
Parameter group: Resource Id Arguments
--resource-group -g

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

Eigenschaft Wert
Parameter group: Resource Id Arguments
--subscription

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

Eigenschaft Wert
Parameter group: Resource Id Arguments
--vm-name

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

Eigenschaft Wert
Parameter group: Resource Id Arguments
Globale Parameter
--debug

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

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Output format.

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

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

--verbose

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

Eigenschaft Wert
Standardwert: False

az vm extension set

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.

Eigenschaft Wert
Wert aus: az vm extension image list
--publisher

Der Name des Erweiterungsherausgebers.

Optionale Parameter

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Eigenschaft Wert
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.

Eigenschaft Wert
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.

Eigenschaft Wert
Parameter group: Resource Id Arguments
--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.

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

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

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

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

Eigenschaft Wert
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.

Eigenschaft Wert
Parameter group: Resource Id Arguments
--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.

Eigenschaft Wert
Parameter group: Resource Id Arguments
--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>.

Eigenschaft Wert
Parameter group: Resource Id Arguments
Globale Parameter
--debug

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

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Output format.

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

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

--verbose

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

Eigenschaft Wert
Standardwert: False

az vm extension show

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Eigenschaft Wert
Parameter group: Resource Id Arguments
--instance-view

Die Instanzansicht einer Erweiterung eines virtuellen Computers.

Eigenschaft Wert
Standardwert: False
--name -n

Name der Erweiterung.

Eigenschaft Wert
Parameter group: Resource Id Arguments
--resource-group -g

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

Eigenschaft Wert
Parameter group: Resource Id Arguments
--subscription

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

Eigenschaft Wert
Parameter group: Resource Id Arguments
--vm-name

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

Eigenschaft Wert
Parameter group: Resource Id Arguments
Globale Parameter
--debug

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

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Output format.

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

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

--verbose

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

Eigenschaft Wert
Standardwert: False

az vm extension wait

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

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

Eigenschaft Wert
Parameter group: Wait Condition Arguments
Standardwert: False
--custom

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

Eigenschaft Wert
Parameter group: Wait Condition Arguments
--deleted

Warten Sie, bis sie gelöscht wurde.

Eigenschaft Wert
Parameter group: Wait Condition Arguments
Standardwert: False
--exists

Warten Sie, bis die Ressource vorhanden ist.

Eigenschaft Wert
Parameter group: Wait Condition Arguments
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.

Eigenschaft Wert
Parameter group: Resource Id Arguments
--interval

Abrufintervall in Sekunden.

Eigenschaft Wert
Parameter group: Wait Condition Arguments
Standardwert: 30
--name --vm-extension-name -n

Der Name der Erweiterung des virtuellen Computers.

Eigenschaft Wert
Parameter group: Resource Id Arguments
--resource-group -g

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

Eigenschaft Wert
Parameter group: Resource Id Arguments
--subscription

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

Eigenschaft Wert
Parameter group: Resource Id Arguments
--timeout

Maximale Wartezeit in Sekunden.

Eigenschaft Wert
Parameter group: Wait Condition Arguments
Standardwert: 3600
--updated

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

Eigenschaft Wert
Parameter group: Wait Condition Arguments
Standardwert: False
--vm-name

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

Eigenschaft Wert
Parameter group: Resource Id Arguments
Globale Parameter
--debug

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

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Output format.

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

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

--verbose

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

Eigenschaft Wert
Standardwert: False