Vue d’ensemble : terminologie et niveaux de support Azure CLI
Cet article explique les terminologies d’Azure CLI. Il existe des composants de syntaxe, des types de référence et des états.
Composants de la syntaxe d’Azure CLI
La syntaxe d’Azure CLI est une combinaison de groupes, de références, de commandes et de paramètres. La commande de référence complète est souvent juste appelée commande.
| Service Azure | Groupe de référence | Sous-groupe(s) de référence | Commande | Commande de référence complète | Exemples de paramètres |
|---|---|---|---|---|---|
| Azure CLI | az config | az config | --local, --output -o | ||
| Réseau Azure | 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 |
Un sous-groupe de référence peut avoir plusieurs niveaux tels que az network application-gateway private-link ip-config add
| Groupe de référence | Sous-groupe 1 | Sous-groupe 2 | Sous-groupe 3 | Commande |
|---|---|---|---|---|
| réseau | application-gateway | private-link | ip-config | add |
Consultez la liste de référence A-Z pour obtenir la liste complète des commandes de référence.
Qu’est-ce qu’un type de référence ?
Les commandes Azure CLI font partie du service Azure CLI principal ou constituent une extension. Les extensions sont des modules complémentaires facultatifs. Le type de référence détermine la planification de mise en production, l’état et la méthode d’installation, comme décrit ci-après :
| Terme | Core | Extension |
|---|---|---|
| Informations de référence | Font partie du service Azure CLI principal | Sont des commandes de références facultatives qui doivent être installées |
| Installer | Conjointement avec le programme d’installation MSI | Individuellement avec az extension add |
| Publication | Selon une planification | À mesure que de nouvelles fonctionnalités ou mises à jour sont disponibles |
| État | Peut être en disponibilité générale (en disponibilité générale), préversion ou déconseillée | Il peut également s’agir d’une disponibilité générale, d’une préversion ou d’une dépréciation |
Pour obtenir la liste des groupes de commandes, exécutez az. Pour obtenir la liste des extensions, utilisez les commandes az extension list-available --output table.
# Get list of all command groups
az
# Get list of extensions
az extension list-available --output table
Core
Les références Azure CLI qui ont été publiées en tant que partie permanente de l’interface CLI sont appelées références principales. Toutes les références principales sont installées avec l’interface Azure CLI et vous ne pouvez pas choisir un sous-ensemble de références. Si vous exécutez l’interface CLI par le biais d’Azure Cloud Shell, les références principales sont toujours à jour.
Extension
Les extensions ne sont pas fournies dans le cadre de l’interface CLI mais elles sont exécutées en tant que commandes CLI. Certaines extensions font partie intégrante de l’interface Azure CLI, mais souvent, une extension vous permet d’accéder à la une préversion et aux commandes expérimentales. Un même groupe de références, comme az iot hub, peut avoir à la fois des commandes principales et des commandes d’extension. Voici deux exemples :
| Commande de référence complète | Est une commande principale | Est une commande d’extension |
|---|---|---|
| az iot hub list | Oui | |
| az iot hub job list | Oui |
Vous êtes invité à installer une extension lors de la première utilisation. Vous pouvez également installer une extension en exécutant la commande az extension add.
Vous pouvez en savoir plus sur les références d’extension, notamment l’installation et la mise à jour dans Utiliser des extensions avec l’interface Azure CLI. Pour obtenir la liste complète des commandes de références d’extension, consultez Extensions disponibles pour Azure CLI.
Qu’est-ce qu’un état de référence ?
Quel que soit le type de référence, les références Azure CLI appartiennent à trois catégories d’état : ga (disponibilité générale), préversion publique ou déconseillée. Il s’agit de l’état de la commande de référence (et non du type) qui détermine la stabilité.
| GA | Préversion publique | Déprécié | |
|---|---|---|---|
| Stabilité | Permanent | Peut changer en réponse aux commentaires des clients. Est soumis aux conditions d’utilisation des préversions de Microsoft Azure. | Sera supprimé. |
Remarque
Les avertissements indiquant une préversion publique ou déconseillé font partie de la sortie de la commande Azure CLI et doivent être attendus.
La plupart des commandes et des paramètres d’une référence unique ont un seul état, mais pas toujours. Une référence en disponibilité générale créée pour offrir davantage de commandes peut avoir des commandes de référence en disponibilité générale et en préversion. À mesure que de nouveaux paramètres sont ajoutés pour améliorer les fonctionnalités, une même commande peut également avoir des paramètres qui appartiennent à différentes catégories d’état. Voici des exemples de références qui ont différents états :
| Commande de référence complète | Paramètres | Type | GA | Préversion publique | Déprécié |
|---|---|---|---|---|---|
| az network dns zone list | Tous | Core | Oui | ||
| az network dns zone create | --name, --resource-group, --if-none-match, --parent-name | Core | Oui | ||
| --existingParameter5 | Core | Oui | |||
| --newParameter6 | Core | Oui | |||
| az network vhub list | Tous | Extension | Oui | ||
| az network vhub create | --address-prefix, --name, --resource-group, -vwan, --location, --sku | Extension | Oui | ||
| --exsitingParameter7 | Extension | Oui | |||
| --newParameter8 | Extension | Oui | |||
| az network firewall create | Tous | Extension | Oui |
Le tableau ci-dessus n’est qu’un exemple et n’est pas représentatif des états de référence actuels pour az network.
