Hinweis
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, sich anzumelden oder das Verzeichnis zu wechseln.
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, das Verzeichnis zu wechseln.
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. Häufig wird der vollständige Verweisbefehl als Befehl bezeichnet.
| Azure-Dienst | Referenzgruppe | Referenzuntergruppe | Command | Vollständiger Referenzbefehl | Parameterbeispiele |
|---|---|---|---|---|---|
| Azure CLI | az config | az config |
--local, --output-o |
||
| Azure Network | az-Netzwerk | 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 aufweisen, wie z. B. az network application-gateway private-link ip-config add.
| Referenzgruppe | Untergruppe 1 | Untergruppe 2 | Untergruppe 3 | Command |
|---|---|---|---|---|
| network | 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 Referenztyp bestimmt den Veröffentlichungszeitplan, den Status und die Installationsmethode, wie hier beschrieben:
| Term | Core | Extension |
|---|---|---|
| References | Teil des primären Azure CLI-Diensts | Optionale Verweisbefehle, die installiert werden müssen |
| Install | Gemeinsam mit dem MSI-Installationsprogramm | Individuell mit az extension add |
| Released | Nach einem Zeitplan | Wenn neue Features oder Updates verfügbar werden |
| Status | Kann allgemein verfügbar (GA) sein, sich in der Vorschau befinden oder veraltet sein | Es kann sich auch um GA, eine Vorschau oder eine veraltete Version handeln |
Führen Sie zum Abrufen einer Liste mit Befehlsgruppen az aus.
# Get list of all command groups
az
Verwenden Sie die Befehle az extension list-available --output table für eine Liste von Erweiterungen.
# Get list of extensions
az extension list-available --output table
Core
Azure CLI-Verweise, die als dauerhafter Bestandteil der Azure CLI veröffentlicht werden, werden als Kernverweise bezeichnet. Alle Kernverweise werden mit der Azure CLI installiert, und Sie können keine Teilmenge von Verweisen auswählen. Wenn Sie die Azure CLI über Azure Cloud Shell ausführen, sind Kernverweise immer auf dem neuesten Stand.
Extension
Erweiterungen werden nicht als Teil der Azure CLI ausgeliefert, sondern als Azure CLI-Befehle ausgeführt. 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, z. B. az iot hub, kann sowohl Kern- als auch Erweiterungsbefehle enthalten. Zwei Beispiele:
| Vollständiger Referenzbefehl | Ist Kern | Ist Erweiterung |
|---|---|---|
| az IoT-Hub-Liste anzeigen | yes | |
| az IoT Hub-Auftragsliste | yes |
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.
| GA | Öffentliche Vorschau | Deprecated | |
|---|---|---|---|
| Stability | Permanent | Kann als Reaktion auf Kundenfeedback geändert werden. Unterliegt den Bedingungen für Microsoft Azure-Vorschauversionen. | Wird entfernt. |
Note
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 weisen einen einzelnen Status auf, dies ist jedoch nicht immer der Fall. 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 Referenzbefehl | Parameters | Type | GA | Öffentliche Vorschau | Deprecated |
|---|---|---|---|---|---|
az network dns zone list |
All | Core | yes | ||
az network dns zone create |
--name
--resource-group
--if-none-match
--parent-name
|
Core | yes | ||
--existingParameter5 |
Core | yes | |||
--newParameter6 |
Core | yes | |||
az network vhub list |
All | Extension | yes | ||
az network vhub create |
--address-prefix, , --name--resource-group, -vwan, , --location--sku |
Extension | yes | ||
--existingParameter7 |
Extension | yes | |||
--newParameter8 |
Extension | yes | |||
az network firewall create |
All | Extension | yes |
Die vorherige Tabelle ist nur ein Beispiel und stellt nicht den aktuellen Referenzstatus für az network dar.