Descriçã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 estados. é o estado que determina o nível de suporte.
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 | Subgrupos 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 | az network | application-gateway | criar | 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ência pode ter vários níveis, 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 |
Veja Lista de referências A a Z para obter uma lista completa dos 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 suplementos opcionais. O tipo de referência determina o agendamento da versão, o estado 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 têm de ser instalados |
| Instalar | Em conjunto com o instalador MSI | Individualmente com az extension add |
| Lançada | Com base numa agenda | À medida que as novas funcionalidades ou atualizações ficam disponíveis |
| Estado | Pode ser disponibilidade geral (geralmente disponível), pré-visualização ou experimental | Também pode ser disponibilidade geral, pré-visualização ou experimental |
Para obter uma lista de grupos de comandos, execute az. Para obter uma lista de extensões, utilize comandos az extension list-available --output table .
# 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 uma parte permanente da CLI são denominadas referências principais. Todas as referências principais são instaladas com a CLI do Azure e não pode escolher um subconjunto de referências. Se executar a CLI através do Azure Cloud Shell, as referências principais estão sempre atualizadas.
Extensão
As extensões não são enviadas como parte da CLI, mas são executadas como comandos da CLI. Algumas extensões são uma parte permanente da CLI do Azure, mas, muitas vezes, uma extensão dá-lhe acesso a comandos experimentais e de pré-visualização. Um único grupo de referência, como az iot hub, pode ter comandos de núcleo e de extensão. Veja a seguir dois exemplos:
| Comando de referência completa | É Núcleo | É Extensão |
|---|---|---|
| az iot hub list | sim | |
| az iot hub job list | sim |
É-lhe pedido que instale uma extensão após a primeira utilização. Também pode instalar uma extensão ao executar o comando az extension add .
Pode saber mais sobre referências de extensões, incluindo instalação e atualização em Utilizar extensões com a CLI do Azure. Veja Extensões disponíveis para a CLI do Azure para obter uma lista completa dos comandos de referência da extensão.
O que é o estado de referência?
Independentemente do tipo de referência, as referências da CLI do Azure enquadram-se em três categorias de estado: GA (Geralmente Disponível), pré-visualização pública ou experimental. É o estado do comando de referência (não o tipo) que determina a estabilidade e o nível de suporte.
| GA | Pré-visualização pública | Experimental | |
|---|---|---|---|
| Estabilidade | Permanente | Pode mudar em resposta ao feedback dos clientes. Está sujeito aos termos das Pré-visualizações do Microsoft Azure. | Pode mudar em resposta ao feedback dos clientes. Muitas vezes, migra para a pré-visualização pública. Pode ser removido. |
| Nível de suporte | Completa | Parcial | Nenhuma |
Nota
Os avisos que indicam a pré-visualização pública ou experimental fazem parte da saída do comando da CLI do Azure e devem ser esperados.
A maioria dos comandos e parâmetros de uma única referência têm um único estado, mas nem sempre. Uma referência ga que está a ser criada para oferecer mais comandos pode ter comandos de ga, pré-visualização e referência experimental. À medida que são adicionados novos parâmetros para aumentar a funcionalidade, um único comando também pode ter parâmetros que se enquadram em diferentes categorias de estado. Seguem-se referências de exemplo com estados diferentes:
| Comando de referência completa | Parâmetros | Tipo | GA | Pré-visualização pública | Experimental |
|---|---|---|---|---|---|
| az network dns zone list | Todos | Principal | sim | ||
| az network dns zone create | --name, --resource-group, --if-none-match, --parent-name | Principal | sim | ||
| --newFutureParameter1 | Principal | sim | |||
| --newFutureParameter2 | Principal | sim | |||
| az network vhub list | Todos | Extensão | sim | ||
| az network vhub create | --address-prefix, --name, --resource-group, -vwan, --location, --sku | Extensão | sim | ||
| --newFutureParameter1 | Extensão | sim | |||
| --newFutureParameter2 | Extensão | sim | |||
| az network firewall create | Todos | Extensão | sim |
A tabela acima é apenas um exemplo e não é representativa do estado de referência atual, por exemplo.