az vm extension

Referenz

Verwalten von Erweiterungen auf VMs.

Erweiterungen sind kleine Anwendungen, die Konfigurations- und Automatisierungsaufgaben nach der Bereitstellung auf virtuellen Azure-Computern bereitstellen. Wenn z.B. Software auf einem virtuellen Computer installiert werden muss, Virenschutz oder eine Docker-Konfiguration erforderlich ist, kann eine VM-Erweiterung zum Ausführen dieser Aufgaben verwendet werden. Erweiterungen können mit einer neuen Bereitstellung für virtuelle Computer gebündelt oder in Bezug auf ein bestehendes System ausgeführt werden.

Befehle

az vm extension delete	Entfernen Sie eine Erweiterung, die an einen virtuellen Computer angefügt ist.
az vm extension image	Suchen Sie die verfügbaren VM-Erweiterungen für ein Abonnement und eine Region.
az vm extension image list	Listen Sie die Informationen zu verfügbaren Erweiterungen auf.
az vm extension image list-names	Listet die Namen der verfügbaren Erweiterungen auf.
az vm extension image list-versions	Listet die Versionen für verfügbare Erweiterungen auf.
az vm extension image show	Anzeigen von Informationen für eine Erweiterung.
az vm extension list	Listet die Erweiterungen auf, die an einen virtuellen Computer angefügt sind.
az vm extension set	Festlegen von Erweiterungen für einen virtuellen Computer.
az vm extension show	Zeigt Informationen zu Erweiterungen an, die an einen virtuellen Computer angefügt sind.
az vm extension wait	Versetzen Sie die CLI in einen Wartezustand, bis eine Bedingung einer VM-Erweiterung erfüllt ist.

az vm extension delete

Bearbeiten

Entfernen Sie eine Erweiterung, die an einen virtuellen Computer angefügt ist.

az vm extension delete [--ids]
                       [--name]
                       [--no-wait]
                       [--resource-group]
                       [--subscription]
                       [--vm-name]

Beispiele

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

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

Löschen Sie Erweiterungen mit IDs, die die Zeichenfolge "MyExtension" enthalten, von einem virtuellen Computer.

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

Optionale Parameter

--ids

Eine oder mehrere Ressourcen-IDs (durch Leerzeichen getrennt). Es sollte sich um eine vollständige Ressourcen-ID handeln, die alle Informationen der Argumente "Ressourcen-ID" enthält. Sie sollten entweder --ids oder andere "Ressourcen-ID"-Argumente angeben.

--name -n

Name der Erweiterung.

--no-wait

Nicht auf den Abschluss lang andauernder Vorgänge warten

Standardwert: False

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

--vm-name

Der Name des virtuellen Computers. Sie können die Standardeinstellung mit az configure --defaults vm=<name>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.

--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 vm extension list

Bearbeiten

Listet die Erweiterungen auf, die an einen virtuellen Computer angefügt sind.

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

Beispiele

Listet angefügte Erweiterungen an einen benannten virtuellen Computer auf.

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

Optionale Parameter

--ids

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

--vm-name

Der Name des virtuellen Computers. Sie können die Standardeinstellung mit az configure --defaults vm=<name>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.

--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 vm extension set

Bearbeiten

Festlegen von Erweiterungen für einen virtuellen Computer.

Rufen Sie Erweiterungsdetails von ab 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 customScript-Erweiterung zu virtuellen Computern hinzu, die von --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 automatisch von der Plattform 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

Aktualisierung erzwingen, auch wenn sich die Erweiterungskonfiguration nicht geändert hat.

Standardwert: False

--ids

--no-auto-upgrade

Wenn diese Einstellung festgelegt ist, wird der Erweiterungsdienst nicht automatisch die neueste Nebenversion auswählen oder auf diese aktualisieren, auch wenn die Erweiterung erneut bereitgestellt wird.

Zulässige Werte: false, true

Standardwert: False

--no-auto-upgrade-minor-version

Zulässige Werte: false, true

Standardwert: False

--no-wait

Nicht auf den Abschluss lang andauernder Vorgänge warten

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

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

--version

Die Version der Erweiterung. Um die Erweiterungsversion an diesen Wert anzuheften, geben Sie --no-auto-upgrade-minor-version an.

--vm-name

Der Name des virtuellen Computers. Sie können die Standardeinstellung mit az configure --defaults vm=<name>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.

--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 vm extension show

Bearbeiten

Zeigt 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 an einen virtuellen Computer angefügten Erweiterungen anzuzeigen.

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

Optionale Parameter

--ids

--instance-view

Die Instanzansicht einer VM-Erweiterung.

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

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

--vm-name

Der Name des virtuellen Computers. Sie können die Standardeinstellung mit az configure --defaults vm=<name>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.

--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 vm extension wait

Bearbeiten

Versetzen Sie die CLI in einen Wartezustand, bis eine Bedingung einer VM-Erweiterung erfüllt ist.

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

Beispiele

Versetzen Sie die CLI in einen Wartezustand, bis eine Bedingung einer VM-Erweiterung erfüllt ist. (automatisch generiert)

az vm extension wait --created --name MyExtension --resource-group MyResourceGroup --vm-name MyVm

Versetzen Sie die CLI in einen Wartezustand, bis eine Bedingung einer VM-Erweiterung erfüllt ist. (automatisch generiert)

az vm extension wait --exists --name MyExtension --resource-group MyResourceGroup --vm-name MyVm

Versetzen Sie die CLI in einen Wartezustand, bis eine Bedingung einer VM-Erweiterung erfüllt ist. (automatisch generiert)

az vm extension wait --ids @- --name MyExtension --subscription MySubscription --updated --vm-name MyVm

Optionale Parameter

--created

Warten Sie, bis mit "provisioningState" bei "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

--ids

--interval

Abrufintervall in Sekunden.

Standardwert: 30

--name -n

Name der Erweiterung.

--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 die Aktualisierung mit provisioningState bei "Succeeded" angezeigt wird.

Standardwert: False

--vm-name

Der Name des virtuellen Computers. Sie können die Standardeinstellung mit az configure --defaults vm=<name>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.

--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 vm extension

Befehle

az vm extension delete

Beispiele

Optionale Parameter

az vm extension list

Beispiele

Optionale Parameter

az vm extension set

Beispiele

Erforderliche Parameter

Optionale Parameter

az vm extension show

Beispiele

Optionale Parameter

az vm extension wait

Beispiele

Optionale Parameter

Feedback

Zusätzliche Ressourcen