Compartilhar via

Visão geral: terminologia da CLI do Azure e níveis de suporte

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. Geralmente, o comando de referência completo é conhecido como um comando.

Serviço do Azure Grupo de referência Subgrupo de referência Command 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 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 Command
rede application-gateway private-link ip-config add

Consulte a 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. Extensões são complementos opcionais. O tipo de referência determina o agendamento de lançamento, o status e o método de instalação, conforme descrito aqui:

Term Core Extension
References Fazem parte do serviço principal da CLI do Azure São comandos de referência opcionais que devem ser instalados
Install Em conjunto com o Instalador MSI Individualmente com az extension add
Released Com base em um agendamento À medida que novos recursos ou atualizações ficam disponíveis
Status Pode ser GA (Disponibilidade Geral), versão prévia ou preterida Também pode ser GA, versão prévia ou descontinuada

Para obter uma lista de grupos de comandos, execute az.

# Get list of all command groups
az

Para obter uma lista de extensões, use az extension list-available --output table comandos.

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

Core

As referências da CLI do Azure publicadas como parte permanente da CLI do Azure são conhecidas como 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 do Azure por meio do Azure Cloud Shell, as referências principais estarão sempre atualizadas.

Extension

As extensões não são enviadas como parte da CLI do Azure, mas são executadas como comandos da CLI do Azure. 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 único grupo de referência, como az iot hub, pode ter comandos principais e de extensão. Veja dois exemplos:

Comando de referência completa É o Núcleo É extensão
az iot hub list yes
lista de trabalhos do az iot hub yes

Você será solicitado a instalar uma extensão após o primeiro uso. 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 Extensões de uso com a CLI do Azure. Consulte as 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 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), versão prévia pública ou preterida. É o status do comando de referência (não tipo) que determina a estabilidade.

GA Versão prévia pública Deprecated
Stability Permanent Pode mudar em resposta aos comentários dos clientes. Está sujeito aos termos de Microsoft Azure Previews. Será removido.

Note

Avisos que indicam versão prévia pública ou obsoletas fazem parte da saída dos comandos da CLI do Azure e são esperados.

A maioria dos comandos e parâmetros para uma única referência tem um único status, mas nem sempre é o caso. Uma referência de GA que está sendo criada para oferecer mais comandos pode incluir comandos GA e de referência de pré-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 as referências de exemplo que têm status diferentes:

Comando de referência completa Parameters Tipo GA Versão prévia 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

A tabela anterior é apenas um exemplo e não representa os status de referência atuais para az network.

Consulte também

  • Last updated on