Visão geral: Terminologia e níveis de suporte da CLI do Azure
Este artigo explica as terminologias da CLI do Azure. Há componentes de sintaxe, tipos de referência e status.
Componentes de sintaxe da CLI do Azure
A sintaxe da CLI do Azure é uma combinação de grupos, referências, comandos e parâmetros. Muitas vezes, o comando de referência completa é referido como comando.
| Serviço do Azure | Grupo de referência | Subgrupo(s) de referência | Comando | Comando de referência completa | Exemplos de parâmetros |
|---|---|---|---|---|---|
| CLI do Azure | az config | az config | --local, --output -o | ||
| Rede do Azure | Rede AZ | application-gateway | criar | az network application-gateway create | --name, --resource-group, --capacity |
| Azure DevOps | Condutas AZ | agente | list | Lista de agentes de pipelines AZ | --pool-id, --agent-name, --demandas |
Um subgrupo de referência pode ter vários níveis, tais como: az network application-gateway private-link ip-config add
| Grupo de Referência | Subgrupo 1 | Subgrupo 2 | Subgrupo 3 | Comando |
|---|---|---|---|---|
| network | application-gateway | private-link | ip-config | adicionar |
Consulte Lista de referência de A a Z para obter uma lista completa de comandos de referência.
O que é o tipo de referência?
Os comandos da CLI do Azure fazem parte do serviço principal da CLI do Azure ou são uma extensão. As extensões são complementos opcionais. O tipo de referência determina o cronograma de lançamento, o status e o método de instalação conforme descrito aqui:
| Termo | Principal | Extensão |
|---|---|---|
| Referências | Fazem parte do serviço principal da CLI do Azure | São comandos de referência opcionais que devem ser instalados |
| Instalar | Em conjunto com o instalador MSI | Individualmente com az extensão adicionar |
| Lançamento | De acordo com um cronograma | À medida que novos recursos ou atualizações ficam disponíveis |
| Status | Pode ser GA (Geralmente Disponível), pré-visualização ou preterido | Também pode ser GA, pré-visualização ou preterido |
Para obter uma lista de grupos de comandos, execute az. Para obter uma lista de extensões, use az extension list-available --output table commands.
# Get list of all command groups
az
# Get list of extensions
az extension list-available --output table
Principal
As referências da CLI do Azure que foram publicadas como parte permanente da CLI são chamadas de referências principais. Todas as referências principais são instaladas com a CLI do Azure e você não pode escolher um subconjunto de referências. Se você executar a CLI por meio do Azure Cloud Shell, as referências principais estarão sempre atualizadas.
Extensão
As extensões não são enviadas como parte da CLI, mas executadas como comandos da CLI. Algumas extensões são uma parte permanente da CLI do Azure, mas, muitas vezes, uma extensão dá acesso a comandos experimentais e de visualização. Um único grupo de referência, como az iot hub, pode ter comandos core e extension. Veja a seguir dois exemplos:
| Comando de referência completa | É o núcleo | É Extensão |
|---|---|---|
| Lista de Hub AZ IoT | sim | |
| Lista de empregos do AZ IoT Hub | sim |
Você será solicitado a instalar uma extensão na primeira utilização. Você também pode instalar uma extensão executando o comando az extension add .
Você pode saber mais sobre referências de extensão, incluindo instalação e atualização em Usar extensões com a CLI do Azure. Consulte Extensões disponíveis para a CLI do Azure para obter uma lista completa de comandos de referência de extensão.
O que é o estatuto de referência?
Independentemente do tipo de referência, as referências da CLI do Azure se enquadram em três categorias de status: GA (Geralmente Disponível), visualização pública ou preterida. É o status do comando de referência (não o tipo) que determina a estabilidade.
| GA | Pré-visualização pública | Preterido | |
|---|---|---|---|
| Estabilidade | Permanente | Pode mudar em resposta ao feedback dos clientes. Está sujeito aos termos das Visualizações do Microsoft Azure. | Será removido. |
Nota
Os avisos que indicam visualização pública ou preterida fazem parte da saída do comando da CLI do Azure e devem ser esperados.
A maioria dos comandos e parâmetros para uma única referência tem um único status, mas nem sempre. Uma referência GA que está sendo construída para oferecer mais comandos pode ter comandos de referência GA e visualização. À medida que novos parâmetros são adicionados para aumentar a funcionalidade, um único comando também pode ter parâmetros que se enquadram em diferentes categorias de status. Aqui estão exemplos de referências que têm status diferentes:
| Comando de referência completa | Parâmetros | Type | GA | Pré-visualização pública | Preterido |
|---|---|---|---|---|---|
| Lista de zonas DNS da rede AZ | Todos | Principal | sim | ||
| az network dns zone create | --name, --resource-group, --if-none-match, --parent-name | Principal | sim | ||
| --existingParameter5 | Principal | sim | |||
| --newParameter6 | Principal | sim | |||
| Lista VHUB de rede AZ | Todos | Extension | sim | ||
| az network vhub criar | --prefixo-endereço, --nome, --resource-group, -vwan, --location, --sku | Extension | sim | ||
| --exsitingParameter7 | Extension | sim | |||
| --newParameter8 | Extension | sim | |||
| az network firewall criar | Todos | Extension | sim |
A tabela acima é apenas um exemplo e não é representativa dos status de referência atuais do az network.
