Partager via

Vue d’ensemble : Terminologie et niveaux de prise en charge d’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 syntaxe Azure CLI

La syntaxe Azure CLI est une combinaison de groupes, de références, de commandes et de paramètres. Souvent, la commande de référence complète est appelée commande.

Service Azure Groupe de références Sous-groupe de référence Command 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érences Sous-groupe 1 Sous-groupe 2 Sous-groupe 3 Command
network application-gateway private-link ip-config add

Pour obtenir la liste de références A à Z , consultez la liste complète des commandes de référence.

Qu’est-ce que le type de référence ?

Les commandes Azure CLI font partie du service Azure CLI principal ou sont une extension. Les extensions sont des extensions facultatives. 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 ici :

Term Core Extension
References Font partie du service Azure CLI principal Sont des commandes de référence facultatives qui doivent être installées
Install Conjointement avec le programme d’installation MSI Individuellement avec az extension add
Released Selon une planification À mesure que de nouvelles fonctionnalités ou mises à jour deviennent disponibles
Status Peut être généralement disponible, en aperçu ou déconseillée Il peut également s’agir d’une disponibilité générale, d’une version bêta ou d’un statut obsolète.

Pour obtenir la liste des groupes de commandes, exécutez az.

# Get list of all command groups
az

Pour obtenir la liste des extensions, utilisez les commandes az extension list-available --output table.

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

Core

Les références Azure CLI publiées en tant que partie permanente d’Azure CLI sont appelées références principales. Toutes les références principales s’installent avec Azure CLI et vous ne pouvez pas choisir un sous-ensemble de références. Si vous exécutez Azure CLI via Azure Cloud Shell, les références principales sont toujours à jour.

Extension

Les extensions ne sont pas fournies dans le cadre d’Azure CLI, mais s’exécutent en tant que commandes Azure CLI. Certaines extensions sont une partie permanente d’Azure CLI, mais souvent, une extension vous donne accès aux commandes d’évaluation et expérimentales. Un groupe de référence unique, tel que 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 Fondamental Est extension
az iot hub list yes
az iot hub liste des tâches yes

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 Use extensions avec Azure CLI. Consultez les extensions disponibles pour Azure CLI pour obtenir la liste complète des commandes de référence d’extension.

Qu’est-ce que l’é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 Aperçu public Deprecated
Stability Permanent Peut changer en réponse aux commentaires des clients. Est soumis aux conditions des préversions de Microsoft Azure. Sera supprimé.

Note

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 état unique, mais ce n’est pas toujours le cas. Une référence en disponibilité générale créée pour offrir davantage de commandes peut inclure 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 augmenter les fonctionnalités, une seule commande peut également avoir des paramètres qui se trouvent dans différentes catégories d’état. Voici des exemples de références qui ont des états différents :

Commande de référence complète Parameters Type GA Aperçu public 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

Le tableau précédent n’est qu’un exemple et ne représente pas les états de référence actuels pour az network.

Voir aussi

  • Last updated on