Compartir a través de

Información general: terminología de la CLI de Azure y niveles de soporte técnico

En este artículo se explican las terminologías de la CLI de Azure. Hay componentes de sintaxis, tipos de referencia y estados.

Componentes de sintaxis de la CLI de Azure

La sintaxis de la CLI de Azure es una combinación de grupos, referencias, comandos y parámetros. A menudo, el comando de referencia completa se conoce como un comando.

Servicio de Azure Grupo de referencia Subgrupo de referencia Command Comando de referencia completa Ejemplos de parámetros
Azure CLI az config az config --local, , --output, -o
Red de 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 subgrupo de referencia puede tener varios niveles, como az network application-gateway private-link ip-config add.

Grupo de referencias Subgrupo 1 Subgrupo 2 Subgrupo 3 Command
network application-gateway private-link ip-config add

Consulte Lista de referencia A a Z para obtener una lista completa de comandos de referencia.

¿Qué es el tipo de referencia?

Los comandos de la CLI de Azure forman parte del servicio principal de la CLI de Azure o son una extensión. Las extensiones son complementos opcionales. El tipo de referencia determina la programación de versión, el estado y el método de instalación como se describe aquí:

Term Core Extension
References Forman parte del servicio principal de la CLI de Azure Son comandos de referencia opcionales que se deben instalar.
Install Conjuntamente con el instalador MSI Individualmente con az extension add
Released Según una programación A medida que las nuevas características o actualizaciones estén disponibles
Status Puede ser GA (generalmente disponible), versión preliminar o en desuso. También puede ser GA, en versión preliminar o en desuso.

Para obtener una lista de grupos de comandos, ejecute az.

# Get list of all command groups
az

Para obtener una lista de extensiones, use az extension list-available --output table comandos.

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

Core

Las referencias de la CLI de Azure publicadas como parte permanente de la CLI de Azure se conocen como referencias principales. Todas las referencias principales se instalan con la CLI de Azure y no puede elegir un subconjunto de referencias. Si ejecuta la CLI de Azure a través de Azure Cloud Shell, las referencias principales siempre están actualizadas.

Extension

Las extensiones no se incluyen como parte de la CLI de Azure, pero se ejecutan como comandos de la CLI de Azure. Algunas extensiones son una parte permanente de la CLI de Azure, pero a menudo, una extensión le da acceso a comandos de vista previa y experimentales. Un único grupo de referencia, como az iot hub, puede tener comandos de núcleo y extensión. Estos son dos ejemplos:

Comando de referencia completa Es núcleo ¿Es una extensión?
az iot hub list (lista los centros IoT) yes
az lista de tareas del concentrador de iot yes

Se le pedirá que instale una extensión al usarse por primera vez. También puede instalar una extensión ejecutando el comando az extension add .

Puede obtener más información sobre las referencias de extensión, incluida la instalación y actualización en Uso de extensiones con la CLI de Azure. Consulte Extensiones disponibles para la CLI de Azure para obtener una lista completa de los comandos de referencia de extensión.

¿Qué es el estado de referencia?

Independientemente del tipo de referencia, las referencias de la CLI de Azure se dividen en tres categorías de estado: GA (disponible con carácter general), versión preliminar pública o en desuso. Es el estado del comando de referencia (no tipo) que determina la estabilidad.

GA Versión preliminar pública Deprecated
Stability Permanent Puede cambiar en respuesta a los comentarios de los clientes. Está sujeto a los términos de las versiones preliminares de Microsoft Azure. Se quitará.

Note

Las advertencias que indican la versión preliminar pública o en desuso forman parte de la salida del comando de la CLI de Azure y deben esperarse.

La mayoría de los comandos y parámetros de una sola referencia tienen un único estado, pero esto no siempre es el caso. Una referencia GA que se está desarrollando para ofrecer más comandos puede incluir comandos de referencia GA y de vista previa. A medida que se agregan nuevos parámetros para aumentar la funcionalidad, un único comando también puede tener parámetros que se encuentran en diferentes categorías de estado. Estas son las referencias de ejemplo que tienen diferentes estados:

Comando de referencia completa Parameters Type GA Versión preliminar pública 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

La tabla anterior es solo un ejemplo y no representa los estados de referencia actuales para az network.

Consulte también

  • Last updated on