Visão geral: terminologia e níveis de suporte da CLI do Azure
Este artigo explica as terminologias da CLI do Azure. Existem componentes de sintaxe, tipos de referência e status.
Componentes da sintaxe da CLI do Azure
A sintaxe da CLI do Azure é uma combinação de grupos, referências, comandos e parâmetros. Geralmente, o comando de referência completo é chamado de comando.
| Serviço do Azure | Grupo de referências | Subgrupos de referências | Comando | Comando de referência completa | Exemplos de parâmetro |
|---|---|---|---|---|---|
| CLI do Azure | az config | az config | --local, --output -o | ||
| Rede do 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 |
Um subgrupo de referências pode ter vários níveis, como az network application-gateway private-link ip-config add
| Grupo de referências | Subgrupo 1 | Subgrupo 2 | Subgrupo 3 | Comando |
|---|---|---|---|---|
| network | application-gateway | private-link | ip-config | add |
Consulte a Lista de referências A a Z para ver todos os comandos de referência.
O que é 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. Extensões são complementos opcionais. O tipo de referência determina o agendamento do lançamento, o status e o método de instalação, conforme esta descrição:
| Termo | Núcleo | Extensão |
|---|---|---|
| Referências | Fazem parte do serviço primário da CLI do Azure | São comandos de referência opcionais que devem ser instalados |
| Instalar | Em conjunto com o MSI Installer | Individualmente com az extension add |
| Lançado | Com base em um agendamento | Conforme 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, visualização ou preterido |
Para obter uma lista de grupos de comandos, execute az. Para obter uma lista de extensões, use o comando az extension list-available --output table.
# Get list of all command groups
az
# Get list of extensions
az extension list-available --output table
Núcleo
As referências da CLI do Azure que foram publicadas como parte permanente da CLI são chamadas referências principais. Todas as referências principais são instaladas com a CLI do Azure e não é possível 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 parte permanente da CLI do Azure, mas, muitas vezes, uma extensão dará a você acesso a comandos experimentais e de visualização privada. Um só grupo de referências, como az iot hub, pode conter comandos principais e de extensão. Veja dois exemplos:
| Comando de referência completa | É principal | É extensão |
|---|---|---|
| az iot hub list | sim | |
| az iot hub job list | sim |
Será solicitado que você instale uma extensão no primeiro uso. Você também pode instalar uma extensão executando o comando az extension add.
Saiba mais sobre referências de extensão, incluindo instalação e atualização em Usar extensões com a CLI do Azure. Confira Extensões disponíveis para a CLI do Azure para obter uma lista completa de comandos de referência de extensão.
O que é status 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 | Versão preliminar pública | Preterido | |
|---|---|---|---|
| Estabilidade | Permanente | Pode ser alterada em resposta aos comentários do cliente. Está sujeita aos termos das Versões prévias do Microsoft Azure. | Será removido. |
Observação
Avisos indicando visualização pública ou preterida fazem parte da saída do comando da CLI do Azure e devem ser esperados.
Embora a maioria dos comandos e parâmetros de uma única referência tenha um único status, esse nem sempre é o caso. Uma referência GA que está sendo criada para oferecer mais comandos pode ter comandos de referência GA e visualização. Conforme novos parâmetros são adicionados para aumentar as funcionalidades, um comando individual também pode ter parâmetros que se enquadram em diferentes categorias de status. Veja exemplos de referências que têm status diferentes:
| Comando de referência completa | Parâmetros | Tipo | GA | Versão preliminar pública | Preterido |
|---|---|---|---|---|---|
| az network dns zone list | Tudo | Núcleo | sim | ||
| az network dns zone create | --name, --resource-group, --if-none-match, --parent-name | Núcleo | sim | ||
| --existingParameter5 | Núcleo | sim | |||
| --newParameter6 | Núcleo | sim | |||
| az network vhub list | Tudo | Extensão | sim | ||
| az network vhub create | --address-prefix, --name, --resource-group, -vwan, --location, --sku | Extensão | sim | ||
| --exsitingParameter7 | Extensão | sim | |||
| --newParameter8 | Extensão | sim | |||
| az network firewall create | Tudo | Extensão | sim |
A tabela acima é apenas um exemplo e não é representativa dos status de referência atuais do az network.