Overzicht: Azure CLI-terminologie en ondersteuningsniveaus

In dit artikel worden azure CLI-terminologieën uitgelegd. Er zijn syntaxisonderdelen, verwijzingstypen en statussen. Het is de status die het ondersteuningsniveau bepaalt.

Azure CLI-syntaxisonderdelen

De Azure CLI-syntaxis is een combinatie van groepen, verwijzingen, opdrachten en parameters. Vaak wordt de volledige verwijzingsopdracht aangeduid als opdracht.

Azure-service Referentiegroep Verwijzingssubgroep(en) Opdracht Volledige verwijzingsopdracht Voorbeelden van parameters
Azure CLI az config az config --local, --output -o
Azure-netwerk az network application-gateway maken az network application-gateway create --name, --resource-group, --capacity
Azure DevOps az pipelines agent list az pipelines agent list --pool-id, --agent-name, --demands

Een referentiesubgroep kan meerdere niveaus hebben, zoals az network application-gateway private-link ip-config add

Referentiegroep Subgroep 1 Subgroep 2 Subgroep 3 Opdracht
network application-gateway private-link ip-config add

Zie Referentielijst van A tot Z voor een volledige lijst met verwijzingsopdrachten.

Wat is verwijzingstype?

Azure CLI-opdrachten maken deel uit van de Azure CLI-kernservice of ze zijn een extensie. Extensies zijn optionele invoegtoepassingen. Het referentietype bepaalt het releaseschema, de status en de installatiemethode, zoals hier wordt beschreven:

Termijn Kern Extensie
Referenties Deel uitmaken van de primaire Azure CLI-service Zijn optionele referentieopdrachten die moeten worden geïnstalleerd
Installeren Samen met het MSI-installatieprogramma Afzonderlijk met az extension add
Vrijgegeven Volgens een schema Naarmate er nieuwe functies of updates beschikbaar komen
Status Kan GA (algemeen beschikbaar), preview of experimenteel zijn Kan ook GA, preview of experimenteel zijn

Voer uit om een lijst met opdrachtgroepen op te halen az. Gebruik az extension list-available --output table-opdrachten voor een lijst met extensies.

# Get list of all command groups
az

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

Kern

Azure CLI-verwijzingen die zijn gepubliceerd als een permanent onderdeel van de CLI, worden kernverwijzingen genoemd. Alle kernverwijzingen worden geïnstalleerd met de Azure CLI en u kunt geen subset van verwijzingen kiezen. Als u de CLI uitvoert via Azure Cloud Shell, zijn kernverwijzingen altijd up-to-date.

Extensie

Extensies worden niet verzonden als onderdeel van de CLI, maar worden uitgevoerd als CLI-opdrachten. Sommige extensies zijn een permanent onderdeel van de Azure CLI, maar vaak geeft een extensie u toegang tot preview- en experimentele opdrachten. Een enkele referentiegroep, zoals az iot hub, kan zowel kern- als extensieopdrachten hebben. Hier volgen twee voorbeelden:

Volledige verwijzingsopdracht Is kern Is extensie
az iot hub list ja
az iot hub job list ja

Bij het eerste gebruik wordt u gevraagd een extensie te installeren. U kunt ook een extensie installeren door de opdracht az extension add uit te voeren.

Meer informatie over extensieverwijzingen, waaronder installatie en bijwerken, vindt u in Extensies gebruiken met de Azure CLI. Zie Beschikbare extensies voor de Azure CLI voor een volledige lijst met extensieverwijzingsopdrachten.

Wat is referentiestatus?

Ongeacht het referentietype kunnen Azure CLI-verwijzingen in drie statuscategorieën worden onderverdeeld: GA (algemeen beschikbaar), openbare preview of experimenteel. Het is de status van de referentieopdracht (niet het type) die de stabiliteit en het ondersteuningsniveau bepaalt.

Algemene beschikbaarheid Openbare preview Experimenteel
Stabiliteit Permanent Kan worden gewijzigd als reactie op feedback van klanten. Is onderhevig aan de voorwaarden van Microsoft Azure Previews. Kan worden gewijzigd als reactie op feedback van klanten. Vaak gemigreerd naar openbare preview. Kan worden verwijderd.
Ondersteuningsniveau Volledig Gedeeltelijk Geen

Notitie

Waarschuwingen die aangeven dat de openbare preview of experimenteel is, maken deel uit van de uitvoer van de Azure CLI-opdracht en moeten worden verwacht.

De meeste opdrachten en parameters voor één verwijzing hebben één status, maar niet altijd. Een GA-verwijzing die wordt gebouwd om meer opdrachten te bieden, kan algemene beschikbaarheids-, preview- en experimentele verwijzingsopdrachten hebben. Naarmate er nieuwe parameters worden toegevoegd om de functionaliteit te vergroten, kan één opdracht ook parameters bevatten die onder verschillende statuscategorieën vallen. Hier volgen voorbeelden van verwijzingen met verschillende statussen:

Volledige verwijzingsopdracht Parameters Type Algemene beschikbaarheid Openbare preview Experimenteel
az network dns zone list Alles Kern ja
az network dns zone create --name, --resource-group, --if-none-match, --parent-name Kern ja
--newFutureParameter1 Kern ja
--newFutureParameter2 Kern ja
az network vhub list Alles Extensie ja
az network vhub create --address-prefix, --name, --resource-group, -vwan, --location, --sku Extensie ja
--newFutureParameter1 Extensie ja
--newFutureParameter2 Extensie ja
az network firewall create Alles Extensie ja

De bovenstaande tabel is slechts een voorbeeld en is niet representatief voor de huidige referentiestatus voor voorbeelden.

Zie ook