Übersicht: Azure CLI-Terminologie und Supportebenen
In diesem Artikel wird die Azure CLI-Terminologie erläutert. Es gibt Syntaxkomponenten, Verweistypen und Status.
Komponenten der Azure CLI-Syntax
Die Azure CLI-Syntax ist eine Kombination aus Gruppen, Verweisen, Befehlen und Parametern. Der gesamte Verweisbefehl wird häufig als Befehl bezeichnet.
| Azure-Dienst | Verweisgruppe | Verweisuntergruppe(n) | Get-Help | Vollständiger Verweisbefehl | Parameterbeispiele |
|---|---|---|---|---|---|
| Azure CLI | az config | az config | --local, --output -o | ||
| Azure-Netzwerk | az network | application-gateway | create | az network application-gateway create | --name, --resource-group, --capacity |
| Azure DevOps | az pipelines | Agent | list | az pipelines agent list | --pool-id, --agent-name, --demands |
Eine Referenzuntergruppe kann mehrere Ebenen haben, etwa az network application-gateway private-link ip-config add.
| Verweisgruppe | Untergruppe 1 | Untergruppe 2 | Untergruppe 3 | Get-Help |
|---|---|---|---|---|
| Netzwerk | application-gateway | private-link | ip-config | add |
Eine vollständige Liste der Referenzbefehle finden Sie in der Referenzliste A bis Z.
Was ist ein Verweistyp?
Azure CLI-Befehle sind entweder Teil des zentralen Azure CLI-Diensts oder eine Erweiterung. Erweiterungen sind optionale Add-Ons. Der Verweistyp bestimmt den Releaseplan, den Status und die Installationsmethode wie hier beschrieben:
| Begriff | Core | Durchwahl |
|---|---|---|
| Referenzen | Teil des primären Azure CLI-Diensts | Optionale Verweisbefehle, die installiert werden müssen |
| Installieren | Gemeinsam mit dem MSI-Installationsprogramm | Einzeln mit az extension add |
| Veröffentlicht | Nach einem Zeitplan | Wenn neue Features oder Updates verfügbar werden |
| Status | Kann GA (allgemein verfügbar), Vorschau oder veraltet sein | Kann auch GA, Vorschau oder veraltet sein |
Führen Sie zum Abrufen einer Liste mit Befehlsgruppen az aus. Verwenden Sie die Befehle az extension list-available --output table, um eine Liste der Erweiterungen anzuzeigen.
# Get list of all command groups
az
# Get list of extensions
az extension list-available --output table
Core
Azure CLI-Verweise, die als ständiger Teil der CLI veröffentlicht wurden, werden als Kernverweise bezeichnet. Alle Kernverweise werden zusammen mit der Azure CLI installiert, und Sie können keine Teilmenge von Verweisen auswählen. Wenn Sie die CLI über Azure Cloud Shell ausführen, sind die Kernverweise immer auf dem neuesten Stand.
Durchwahl
Erweiterungen werden nicht zusammen mit der CLI bereitgestellt, können aber als CLI-Befehle ausgeführt werden. Einige Erweiterungen sind fester Bestandteil der Azure CLI, aber oft erhalten Sie mit einer Erweiterung Zugriff auf eine Vorschau und experimentelle Befehle. Eine einzelne Referenzgruppe wie etwa az iot hub kann sowohl Kern- als auch Erweiterungsbefehle enthalten. Zwei Beispiele:
| Vollständiger Verweisbefehl | Kern | Erweiterung |
|---|---|---|
| az iot hub list | ja | |
| az iot hub job list | ja |
Sie werden bei der ersten Verwendung einer Erweiterung zur Installation aufgefordert. Sie können eine Erweiterung auch installieren, indem Sie den Befehl az extension add ausführen.
Weitere Informationen zu Erweiterungsverweisen (einschließlich Installation und Aktualisierung) finden Sie unter Verwenden von Erweiterungen mit der Azure CLI. Unter Verfügbare Erweiterungen für die Azure CLI finden Sie eine vollständige Liste der Erweiterungsverweisbefehle.
Was ist der Verweisstatus?
Unabhängig vom Referenztyp fallen Azure CLI-Verweise in drei Statuskategorien: GA (Allgemein verfügbar), öffentliche Vorschau oder veraltet. Es ist der Referenzbefehlsstatus (nicht typ), der die Stabilität bestimmt.
| Allgemein verfügbar | Öffentliche Vorschauversion | Als veraltet markiert | |
|---|---|---|---|
| Stabilität | Dauerhaft | Kann als Reaktion auf Kundenfeedback geändert werden. Unterliegt den Bedingungen für Microsoft Azure-Vorschauversionen. | Wird entfernt. |
Hinweis
Warnungen, die angeben, dass die öffentliche Vorschau oder veraltet ist, sind Teil der Azure CLI-Befehlsausgabe und sollten erwartet werden.
Die meisten Befehle und Parameter für einen einzelnen Verweis haben einen einzelnen Status, aber nicht immer. Eine GA-Referenz, die erstellt wird, um weitere Befehle anzubieten, können sowohl GA- als auch Vorschaureferenzbefehle enthalten. Darüber hinaus kann ein einzelner Befehl über Parameter verfügen, die in unterschiedliche Statuskategorien fallen. Dies ist der Fall, wenn neue Parameter hinzugefügt werden, um den Funktionsumfang zu erweitern. Die folgende Tabelle enthält Beispiele für Verweise mit verschiedenen Statuswerten:
| Vollständiger Verweisbefehl | Parameter | type | Allgemein verfügbar | Öffentliche Vorschauversion | Als veraltet markiert |
|---|---|---|---|---|---|
| az network dns zone list | Alle | Core | ja | ||
| az network dns zone create | --name, --resource-group, --if-none-match, --parent-name | Core | ja | ||
| --existingParameter5 | Core | ja | |||
| --newParameter6 | Core | ja | |||
| az network vhub list | Alle | Durchwahl | ja | ||
| az network vhub create | --address-prefix, --name, --resource-group, -vwan, --location, --sku | Durchwahl | ja | ||
| --exsitingParameter7 | Erweiterung | ja | |||
| --newParameter8 | Erweiterung | ja | |||
| az network firewall create | Alle | Durchwahl | ja |
Die obige Tabelle ist nur ein Beispiel und ist nicht repräsentativ für die aktuellen Referenzstatus für az network.
