Introducción: 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. es el estado el que determina el nivel de apoyo.
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 completo se conoce como comando.
| Servicio de Azure | Grupo de referencia | Subgrupos de referencia | Get-Help | Comando de referencia completo | Ejemplos de parámetros |
|---|---|---|---|---|---|
| CLI de Azure | 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 | agente | list | az pipelines agent list | --pool-id, --agent-name, --demands |
Un subgrupo de referencia puede tener varios niveles, por ejemplo, az network application-gateway private-link ip-config add.
| Grupo de referencia | Subgrupo 1 | Subgrupo 2 | Subgrupo 3 | Get-Help |
|---|---|---|---|---|
| red | application-gateway | private-link | ip-config | add |
Consulte la Lista de referencia de la A a la Z para obtener una lista completa de los 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, tal y como se describe aquí:
| Término | Core | Extensión |
|---|---|---|
| Referencias | Forman parte del servicio principal de la CLI de Azure | Son comandos de referencia opcionales que se deben instalar |
| Instalación | De forma conjunta con el instalador MSI | De forma individual con az extension add |
| Publicado | Según una programación | A medida que estén disponibles nuevas características o actualizaciones |
| Estado | Puede ser GA (disponibilidad general), versión preliminar o experimental. | También puede ser disponibilidad general (GA), versión preliminar o experimental |
Para obtener una lista de grupos de comandos, ejecute az. Para obtener una lista de extensiones, use los comandos az extension list-available --output table.
# Get list of all command groups
az
# 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 se llaman referencias principales. Todas las referencias principales se instalan con la CLI de Azure y no se puede elegir un subconjunto de referencias. Si ejecuta la CLI desde Azure Cloud Shell, las referencias principales estarán siempre actualizadas.
Extensión
Las extensiones no se incluyen como parte de la CLI, pero se ejecutan como comandos de la CLI. 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 solo grupo de referencia, como az iot hub, puede tener tanto comandos principales como de extensión. Estos son dos ejemplos:
| Comando de referencia completo | Principal | Extensión |
|---|---|---|
| az iot hub list | sí | |
| az iot hub job list | sí |
Se le pedirá que instale una extensión la primera vez que la utilice. También puede instalar una extensión mediante la ejecución del comando az extension add.
Para más información sobre las referencias de extensión, incluidas la instalación y la actualización, consulte 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 (disponibilidad general), versión preliminar pública y experimental. Es el estado del comando de referencia (no el tipo) lo que determina la estabilidad y el nivel de soporte.
| Disponibilidad general | Versión preliminar pública | Habilitación de características | |
|---|---|---|---|
| Estabilidad | Permanente | Puede cambiar en respuesta a los comentarios de los clientes. Está sujeta a los términos de las versiones preliminares de Microsoft Azure. | Puede cambiar en respuesta a los comentarios de los clientes. A menudo se migra a la versión preliminar pública. Se puede quitar. |
| Nivel de compatibilidad | Completo | Parcial | Ninguno |
Nota
Las advertencias que indican versión preliminar pública o experimental forman parte de la salida del comando de la CLI de Azure y se debe esperar su existencia.
La mayoría de los comandos y parámetros para una única referencia tienen un único estado, pero no siempre. Una referencia de disponibilidad general que está en desarrollo para ofrecer más comandos puede tener comandos de referencia de disponibilidad general, en versión preliminar y experimentales. 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 distintas categorías de estado. A continuación se muestran referencias de ejemplo que tienen estados diferentes:
| Comando de referencia completo | Parámetros | Tipo | Disponibilidad general | Versión preliminar pública | Habilitación de características |
|---|---|---|---|---|---|
| az network dns zone list | Todo | Core | sí | ||
| az network dns zone create | --name, --resource-group, --if-none-match, --parent-name | Core | sí | ||
| --nuevoParámetroFuturo1 | Core | sí | |||
| --nuevoParámetroFuturo2 | Core | sí | |||
| az network vhub list | Todo | Extensión | sí | ||
| az network vhub create | --address-prefix, --name, --resource-group, -vwan, --location, --sku | Extensión | sí | ||
| --nuevoParámetroFuturo1 | Extensión | sí | |||
| --nuevoParámetroFuturo2 | Extensión | sí | |||
| az network firewall create | Todo | Extensión | sí |
La tabla anterior es solo un ejemplo y no es representativa del estado de referencia actual de los ejemplos.