az connectedmachine extension

Hinweis

Diese Referenz ist Teil der ConnectedMachine-Erweiterung für die Azure CLI (Version 2.57.0 oder höher). Die Erweiterung wird automatisch installiert, wenn Sie einen Az connectedmachine Erweiterungsbefehl zum ersten Mal ausführen. Weitere Informationen zu Erweiterungen

Verwalten sie eine VM-Erweiterung auf einem Azure Arc-Enabled-Server.

Befehle

Name	Beschreibung	Typ	Status
az connectedmachine extension create	Eine Erweiterung erstellen	Erweiterung	Allgemein verfügbar
az connectedmachine extension delete	Löschen sie eine Erweiterung.	Erweiterung	Allgemein verfügbar
az connectedmachine extension image	Verwalten von VM-Erweiterungsmetadaten, die für Azure Arc-Enabled-Server verfügbar sind.	Erweiterung	Allgemein verfügbar
az connectedmachine extension image list	Auflisten aller Erweiterungsversionen basierend auf Standort, Herausgeber, extensionType.	Erweiterung	Allgemein verfügbar
az connectedmachine extension image show	Abrufen einer Erweiterungsmetadaten basierend auf Standort, Herausgeber, ExtensionType und Version.	Erweiterung	Allgemein verfügbar
az connectedmachine extension list	Rufen Sie alle Erweiterungen eines Nicht-Azure-Computers ab.	Erweiterung	Allgemein verfügbar
az connectedmachine extension show	Zeigen Sie eine Erweiterung eines Nicht-Azure-Computers an.	Erweiterung	Allgemein verfügbar
az connectedmachine extension update	Aktualisieren sie eine Erweiterung.	Erweiterung	Allgemein verfügbar
az connectedmachine extension wait	Platzieren Sie die CLI in einem Wartezustand, bis eine Bedingung erfüllt ist.	Erweiterung	Allgemein verfügbar

az connectedmachine extension create

Eine Erweiterung erstellen

az connectedmachine extension create --extension-name
                                     --machine-name
                                     --resource-group
                                     [--auto-upgrade-min {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--enable-auto-upgrade {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--force-update-tag]
                                     [--instance-view]
                                     [--location]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--protected-settings]
                                     [--publisher]
                                     [--settings]
                                     [--tags]
                                     [--type]
                                     [--type-handler-version]

Beispiele

Beispielbefehl zum Erstellen von Erweiterungen

az connectedmachine extension create --name CustomScriptExtension --location eastus2euap --type CustomScriptExtension --publisher Microsoft.Compute --type-handler-version 1.10 --machine-name myMachine --resource-group myResourceGroup

Erforderliche Parameter

--extension-name --name -n

Der Name der Computererweiterung.

--machine-name

Der Name des Computers, auf dem die Erweiterung erstellt oder aktualisiert werden soll.

--resource-group -g

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

Optionale Parameter

--auto-upgrade-min --auto-upgrade-minor-version

Gibt an, ob die Erweiterung eine neuere Nebenversion verwenden soll, wenn sie zur Bereitstellungszeit verfügbar ist. Abgesehen von erneuten Bereitstellungen führt die Erweiterung nach der Bereitstellung jedoch keine Upgrades für Nebenversionen aus, selbst wenn diese Eigenschaft auf „true“ festgelegt ist.

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

--enable-auto-upgrade --enable-automatic-upgrade

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

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

--force-update-tag

Wie der Erweiterungshandler aktualisiert werden soll, auch wenn sich die Erweiterungskonfiguration nicht geändert hat.

--instance-view

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

--location -l

Der geografische Standort, an dem sich die Ressource befindet, wenn nicht angegeben, wird der Standort 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

--protected-settings

Die Erweiterung kann entweder protectedSettings oder protectedSettingsFromKeyVault oder gar keine geschützten Einstellungen enthalten. Unterstützen Sie json-file und yaml-file.

--publisher

Der Name des Herausgebers des Erweiterungshandlers.

--settings

Json formatierte öffentliche Einstellungen für die Erweiterung. Unterstützen Sie json-file und yaml-file.

--tags

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

--type

Gibt den Typ der Erweiterung an; Ein Beispiel ist "CustomScriptExtension".

--type-handler-version

Gibt die Version des Skripthandlers an.

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 connectedmachine extension delete

Löschen sie eine Erweiterung.

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

Beispiele

Beispielbefehl für erweiterungslöschen

az connectedmachine extension delete --name myName --machine-name myMachine --resource-group myResourceGroup

Optionale Parameter

--extension-name --name -n

Der Name der Computererweiterung.

--ids

Eine oder mehrere Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der „Ressource id“-Argumente handeln. Sie sollten entweder „--ids“ oder andere „Resource Id“-Argumente angeben.

--machine-name

Der Name des Computers, auf dem die Erweiterung gelöscht werden soll.

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

Rufen Sie alle Erweiterungen eines Nicht-Azure-Computers ab.

az connectedmachine extension list --machine-name
                                   --resource-group
                                   [--expand]
                                   [--max-items]
                                   [--next-token]

Beispiele

Beispielbefehl für Erweiterungsliste

az connectedmachine extension list --machine-name myMachine --resource-group myResourceGroup

Erforderliche Parameter

--machine-name

Der Name des Computers, der die Erweiterung enthält.

--resource-group -g

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

Optionale Parameter

--expand

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

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

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

Zeigen Sie eine Erweiterung eines Nicht-Azure-Computers an.

az connectedmachine extension show [--extension-name]
                                   [--ids]
                                   [--machine-name]
                                   [--resource-group]
                                   [--subscription]

Beispiele

Beispielbefehl für Erweiterungspräsentation

az connectedmachine extension show --name CustomScriptExtension --machine-name myMachine --resource-group myResourceGroup

Optionale Parameter

--extension-name --name -n

Der Name der Computererweiterung.

--ids

Eine oder mehrere Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der „Ressource id“-Argumente handeln. Sie sollten entweder „--ids“ oder andere „Resource Id“-Argumente angeben.

--machine-name

Der Name des Computers, der die Erweiterung enthält.

--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 connectedmachine extension update

Aktualisieren sie eine Erweiterung.

az connectedmachine extension update [--add]
                                     [--auto-upgrade-min {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--enable-auto-upgrade {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--extension-name]
                                     [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--force-update-tag]
                                     [--ids]
                                     [--instance-view]
                                     [--machine-name]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--protected-settings]
                                     [--publisher]
                                     [--remove]
                                     [--resource-group]
                                     [--set]
                                     [--settings]
                                     [--subscription]
                                     [--tags]
                                     [--type]
                                     [--type-handler-version]

Beispiele

Beispielbefehl für Erweiterungsupdates

az connectedmachine extension update --name CustomScriptExtension --type CustomScriptExtension --publisher Microsoft.Compute --type-handler-version 1.10 --machine-name myMachine --resource-group myResourceGroup

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

--auto-upgrade-min --auto-upgrade-minor-version

Gibt an, ob die Erweiterung eine neuere Nebenversion verwenden soll, wenn sie zur Bereitstellungszeit verfügbar ist. Abgesehen von erneuten Bereitstellungen führt die Erweiterung nach der Bereitstellung jedoch keine Upgrades für Nebenversionen aus, selbst wenn diese Eigenschaft auf „true“ festgelegt ist.

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

--enable-auto-upgrade --enable-automatic-upgrade

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

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

--extension-name --name -n

Der Name der Computererweiterung.

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

--force-update-tag

Wie der Erweiterungshandler aktualisiert werden soll, auch wenn sich die Erweiterungskonfiguration nicht geändert hat.

--ids

Eine oder mehrere Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der „Ressource id“-Argumente handeln. Sie sollten entweder „--ids“ oder andere „Resource Id“-Argumente angeben.

--instance-view

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

--machine-name

Der Name des Computers, der die Erweiterung enthält.

--no-wait

Nicht auf den Abschluss lang andauernder Vorgänge warten

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

--protected-settings

Die Erweiterung kann entweder protectedSettings oder protectedSettingsFromKeyVault oder gar keine geschützten Einstellungen enthalten. Unterstützen Sie json-file und yaml-file.

--publisher

Der Name des Herausgebers des Erweiterungshandlers.

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

--settings

Json formatierte öffentliche Einstellungen für die Erweiterung. Unterstützen Sie json-file und yaml-file.

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

--type

Gibt den Typ der Erweiterung an; Ein Beispiel ist "CustomScriptExtension".

--type-handler-version

Gibt die Version des Skripthandlers an.

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

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

az connectedmachine extension wait [--created]
                                   [--custom]
                                   [--deleted]
                                   [--exists]
                                   [--extension-name]
                                   [--ids]
                                   [--interval]
                                   [--machine-name]
                                   [--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

--exists

Warten Sie, bis die Ressource vorhanden ist.

Standardwert: False

--extension-name --name -n

Der Name der Computererweiterung.

--ids

Eine oder mehrere Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der „Ressource id“-Argumente handeln. Sie sollten entweder „--ids“ oder andere „Resource Id“-Argumente angeben.

--interval

Abrufintervall in Sekunden.

Standardwert: 30

--machine-name

Der Name des Computers, der die Erweiterung enthält.

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