Přehled: Terminologie Azure CLI a úrovně podpory
Tento článek vysvětluje terminologie Azure CLI. Existují komponenty syntaxe, odkazové typy a stavy.
Komponenty syntaxe Azure CLI
Syntaxe Azure CLI je kombinací skupin, odkazů, příkazů a parametrů. Příkaz úplné reference se často označuje jako příkaz.
| Služba Azure | Referenční skupina | Referenční podskupiny | Příkaz | Příkaz Úplné referenční informace | Příklady parametrů |
|---|---|---|---|---|---|
| Azure CLI | az config | az config | --local, --output -o | ||
| Síť Azure | az network | application-gateway | vytvoření | az network application-gateway create | --name, --resource-group, --capacity |
| Azure DevOps | az pipelines | agent | list | az pipelines agent list | --pool-id, --agent-name, --demands |
Referenční podskupina může mít více úrovní, napříkladaz network application-gateway private-link ip-config add
| Referenční skupina | Podskupina 1 | Podskupina 2 | Podskupina 3 | Příkaz |
|---|---|---|---|---|
| síť | application-gateway | private-link | ip-config | add |
Úplný seznam referenčních příkazů najdete v části Referenční seznam A až Z .
Co je typ odkazu?
Příkazy Azure CLI jsou buď součástí základní služby Azure CLI, nebo jsou rozšířením. Rozšíření jsou volitelné doplňky. Referenční typ určuje plán vydání, stav a metodu instalace, jak je popsáno zde:
| Období | Základ | Rozšíření |
|---|---|---|
| Odkazy | Jsou součástí primární služby Azure CLI. | Jsou volitelné referenční příkazy, které je potřeba nainstalovat. |
| Instalace | Společně s instalačním programem MSI | Individuálně pomocí příkazu az extension add |
| Vydáno | Podle plánu | Jakmile budou k dispozici nové funkce nebo aktualizace |
| Stav | Může být obecná dostupnost (obecně dostupná), verze Preview nebo zastaralá. | Může to být také ga, verze Preview nebo zastaralé. |
Seznam skupin příkazů získáte spuštěním azpříkazu . Seznam rozšíření zobrazíte příkazy az extension list-available --output table .
# Get list of all command groups
az
# Get list of extensions
az extension list-available --output table
Základ
Odkazy azure CLI, které byly publikovány jako trvalá část rozhraní příkazového řádku, se nazývají základní odkazy. Všechny základní odkazy se nainstalují pomocí Azure CLI a nemůžete zvolit podmnožinu odkazů. Pokud spouštíte rozhraní příkazového řádku přes Azure Cloud Shell, základní odkazy jsou vždy aktuální.
Rozšíření
Rozšíření se nedoručují jako součást rozhraní příkazového řádku, ale běží jako příkazy rozhraní příkazového řádku. Některá rozšíření jsou trvalou součástí Azure CLI, ale často poskytuje rozšíření přístup k náhledům a experimentálním příkazům. Jedna referenční skupina, například az iot hub, může obsahovat příkazy jádra i rozšíření. Zde jsou dva příklady:
| Příkaz Úplné referenční informace | Is Core | Je rozšíření |
|---|---|---|
| az iot hub list | ano | |
| az iot hub job list | ano |
Při prvním použití se zobrazí výzva k instalaci rozšíření. Rozšíření můžete nainstalovat také spuštěním příkazu az extension add .
Další informace o odkazech na rozšíření, včetně instalace a aktualizace, najdete v tématu Použití rozšíření pomocí Azure CLI. Úplný seznam referenčních příkazů rozšíření najdete v tématu Dostupná rozšíření pro Azure CLI .
Co je stav odkazu?
Bez ohledu na typ odkazu spadají odkazy Azure CLI do tří kategorií stavu: ga (obecně dostupné), verze Public Preview nebo zastaralé. Jedná se o stav referenčního příkazu (ne typu), který určuje stabilitu.
| GA | Verze Public Preview | Zastaralé | |
|---|---|---|---|
| Stability | Trvale | Může se změnit v reakci na zpětnou vazbu zákazníků. Podléhá podmínkám microsoft Azure Preview. | Odebere se. |
Poznámka:
Upozornění indikující, že verze Public Preview nebo zastaralé jsou součástí výstupu příkazu Azure CLI a měly by se očekávat.
Většina příkazů a parametrů pro jeden odkaz má jediný stav, ale ne vždy. Referenční dokumentace GA, která je sestavená tak, aby nabízela více příkazů, může obsahovat referenční příkazy GA i preview. Při přidání nových parametrů ke zvýšení funkčnosti může mít jeden příkaz také parametry, které spadají do různých kategorií stavu. Tady jsou příklady odkazů, které mají různé stavy:
| Příkaz Úplné referenční informace | Parametry | Typ | GA | Verze Public Preview | Zastaralé |
|---|---|---|---|---|---|
| az network dns zone list | Všechny | Základ | ano | ||
| az network dns zone create | --name, --resource-group, --if-none-match, --parent-name | Základ | ano | ||
| --existingParameter5 | Základ | ano | |||
| --newParameter6 | Základ | ano | |||
| az network vhub list | Všechny | Extension | ano | ||
| az network vhub create | --address-prefix, --name, --resource-group, -vwan, --location, --sku | Extension | ano | ||
| --exsitingParameter7 | Extension | ano | |||
| --newParameter8 | Extension | ano | |||
| az network firewall create | Všechny | Extension | ano |
Výše uvedená tabulka je pouze příkladem a nepředstavuje zástupce aktuálních referenčních stavů pro az network.