Partilhar via

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 um comando.

Serviço do Azure Grupo de referência Subgrupo de referência Command Comando de referência completa Exemplos de parâmetros
Azure CLI az config az config --local, --output, -o
Azure Network Rede AZ 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 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:

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 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.

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

Extension

As extensões não são fornecidas como parte da CLI do Azure, mas são executadas como comandos da CLI do Azure. 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 É Núcleo É Extensão
Lista de Hub AZ IoT yes
Lista de empregos do AZ IoT Hub yes

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.

disponibilidade geral Pré-visualização pública Deprecated
Stability Permanent Pode mudar em resposta ao feedback dos clientes. Está sujeito aos termos das Versões de Avaliação do Microsoft Azure. Será removido.

Note

Os avisos que indicam pré-visualização pública ou obsoleto 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 é esse o caso. Uma referência GA que está sendo construída para oferecer mais comandos pode incluir 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 Parameters Tipo disponibilidade geral Pré-visualização 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 do az network.

Consulte também

  • Last updated on