Översikt: Azure CLI-terminologi och supportnivåer

I den här artikeln beskrivs Azure CLI-terminologi. Det finns syntaxkomponenter, referenstyper och statusar.

Azure CLI-syntaxkomponenter

Azure CLI-syntaxen är en kombination av grupper, referenser, kommandon och parametrar. Ofta kallas det fullständiga referenskommandot för ett kommando.

Azure-tjänst Referensgrupp Referensundergrupp Command Fullständigt referenskommando Parameterexempel
Azure CLI az config az config --local, --output-o
Azure Network 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

En referensundergrupp kan ha flera nivåer, till exempel az network application-gateway private-link ip-config add.

Referensgrupp Undergrupp 1 Undergrupp 2 Undergrupp 3 Command
network application-gateway private-link ip-config add

En fullständig lista över referenskommandon finns i Referenslista A till Z .

Vad är referenstyp?

Azure CLI-kommandon är antingen en del av azure CLI-kärntjänsten eller så är de ett tillägg. Tillägg är valfria extrafunktioner. Referenstypen bestämmer versionsschemat, statusen och installationsmetoden enligt beskrivningen här:

Term Core Extension
References Ingår i den primära Azure CLI-tjänsten Är valfria referenskommandon som kan installeras om så önskas
Install Tillsammans med MSI-installationsprogrammet Individuellt med az extension add
Released Enligt ett schema När nya funktioner eller uppdateringar blir tillgängliga
Status Kan vara GA (allmänt tillgänglig), förhandsversion eller inaktuell Kan också vara GA, förhandsversion eller inaktuell

Om du vill hämta en lista över kommandogrupper kör du az.

# Get list of all command groups
az

För en lista över tillägg, använd kommandon az extension list-available --output table.

# Get list of extensions
az extension list-available --output table

Core

Azure CLI-referenser som publiceras som en permanent del av Azure CLI kallas kärnreferenser. Alla kärnreferenser installeras med Azure CLI och du kan inte välja en delmängd referenser. Om du kör Azure CLI via Azure Cloud Shell är huvudreferenserna alltid uppdaterade.

Extension

Tillägg levereras inte som en del av Azure CLI utan körs som Azure CLI-kommandon. Vissa tillägg är en permanent del av Azure CLI, men ofta ger ett tillägg dig åtkomst till förhandsversioner och experimentella kommandon. En enda referensgrupp, till exempel az iot hub, kan ha både kärn- och tilläggskommandon. Nedan följer två exempel:

Fullständigt referenskommando Är Kärna Är detta ett tillägg?
az iot hub list yes
az iot-hubb-jobblista yes

Du uppmanas att installera ett tillägg vid första användningen. Du kan också installera ett tillägg genom att köra kommandot az extension add .

Du kan lära dig mer om tilläggsreferenser, inklusive installation och uppdatering i Använda tillägg med Azure CLI. En fullständig lista över tilläggsreferenskommandon finns i Tillgängliga tillägg för Azure CLI .

Vad är referensstatus?

Oavsett referenstyp finns Azure CLI-referenser i tre statuskategorier: GA (allmänt tillgänglig), offentlig förhandsversion eller inaktuell. Det är referenskommandostatusen (inte typen) som avgör stabiliteten.

GA Offentlig förhandsversion Deprecated
Stability Permanent Kan ändras som svar på kundfeedback. Omfattas av villkoren i Förhandsversioner av Microsoft Azure. Kommer att tas bort.

Note

Varningar som anger offentlig förhandsversion eller inaktuell är en del av Azure CLI-kommandoutdata och bör förväntas.

De flesta kommandon och parametrar för en enda referens har en enda status, men så är inte alltid fallet. En GA-referens som byggs ut för att erbjuda fler kommandon kan innehålla referenskommandon för både ga och förhandsversion. När nya parametrar läggs till för att öka funktionaliteten kan ett enda kommando också ha parametrar som faller under olika statuskategorier. Här är exempelreferenser som har olika statusar:

Fullständigt referenskommando Parameters Type GA Offentlig förhandsversion 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

Den föregående tabellen är bara ett exempel och representerar inte de aktuella referensstatusarna för az network.

Se även