Visão geral da extensão do Azure Sphere para CLI do Azure

  • Artigo

A ferramenta de linha de comando para gerenciar dispositivos anexados do Azure Sphere e implantações de nuvem é distribuída como uma extensão da CLI do Azure.

Instalar a CLI do Azure e a extensão do Azure Sphere

Para adquirir a extensão do Azure Sphere para a CLI do Azure:

  1. Instale a CLI do Azure se você ainda não tiver feito isso.

  2. Para adicionar a extensão do Azure Sphere, execute o seguinte comando:

    az extension add --name azure-sphere

Você deve entrar com a CLI do Azure para fazer logon na assinatura do Azure que deseja usar para gerenciar dispositivos do Azure Sphere.

Depois que uma extensão é instalada, sua localização é encontrada sob o valor da variável shell $AZURE_EXTENSION_DIR . Se essa variável tiver sua definição removida, por padrão, o valor é $HOME/.azure/cliextensions no Linux e macOS e %USERPROFILE%\.azure\cliextensions no Windows.

Dica

Depois de fazer logon, você verá uma lista de assinaturas associadas à sua conta do Azure. Certifique-se de selecionar a assinatura com as permissões necessárias usando o az account set comando para que a extensão do Azure Sphere funcione corretamente. Para obter mais informações sobre a seleção da assinatura, confira Usar várias assinaturas do Azure.

Gerenciando a extensão do Azure Sphere

Para ver as versões instaladas das extensões da CLI do Azure, use o comando:

az version

Para atualizar a extensão do Azure Sphere para a versão mais recente, use:

az extension update --name azure-sphere

Para desinstalar a extensão do Azure Sphere, use:

az extension remove --name azure-sphere

Comandos comuns da CLI do Azure Sphere

Você pode usar comandos do Azure Sphere digitando az sphere no prompt de comando do Windows ou no PowerShell. No Linux, você pode usar qualquer interface de linha de comando (CLI). A CLI tem o preenchimento completo de guia para comandos sob o shell do Bash.

Esta tabela lista alguns comandos comuns do Azure Sphere e links para sua documentação de referência.

Comando Descrição
az sphere catalog Gerencie seu catálogo.
az sphere ca-certificate Gerencie certificados em seu catálogo.
az sphere deployment Gerencie implantações em seu catálogo.
az sphere device Gerenciar dispositivos do Azure Sphere.
az sphere device-group Gerencie grupos de dispositivos em seu catálogo.
az sphere image Gerencie imagens em seu catálogo.
az sphere product Gerencie produtos em seu catálogo.
az sphere get-support-data Reúna dados de diagnóstico sobre as configurações do sistema, da nuvem e do dispositivo.

A CLI do Azure permite que você defina opções de configuração que simplificam o uso de comandos da CLI do Azure Sphere, fornecendo padrões para parâmetros como , --resource-group--subscription, ou --catalog.

Comandos dependentes do dispositivo

O comando funciona com um dispositivo do Azure Sphere anexado localmente. Se você tentar executar o comando sem um dispositivo anexado, receberá um erro. Para obter mais informações sobre comandos de dispositivo, consulte az sphere device

  • az sphere device claim
  • az sphere device recover
  • az sphere device restart
  • az sphere device show-attached
  • az sphere device show-os-version
  • az sphere device app show-memory-status
  • az sphere device app show-quota
  • az sphere device app show-status
  • az sphere device app start
  • az sphere device app stop
  • az sphere device capability show-attached
  • az sphere device capability update
  • az sphere device certificate add
  • az sphere device certificate delete
  • az sphere device certificate list
  • az sphere device certificate show
  • az sphere device certificate show-quota
  • az sphere device image list-installed
  • az sphere image-package show
  • az sphere device manufacturing-state show
  • az sphere device manufacturing-state update
  • az sphere device network proxy apply
  • az sphere device network proxy delete
  • az sphere device network proxy show
  • az sphere device network disable
  • az sphere device network enable
  • az sphere device network list-firewall-rules
  • az sphere device network list-interfaces
  • az sphere device network show-diagnostics
  • az sphere device network show-status
  • az sphere device network update-interface
  • az sphere device sideload delete
  • az sphere device sideload deploy
  • az sphere device wifi add
  • az sphere device wifi disable
  • az sphere device wifi enable
  • az sphere device wifi forget
  • az sphere device wifi list
  • az sphere device wifi reload-config
  • az sphere device wifi scan
  • az sphere device wifi show
  • az sphere device wifi show-status

Argumentos disponíveis globalmente

Os seguintes parâmetros globais estão disponíveis para a extensão do Azure Sphere:

Parâmetro Descrição
--debug Aumente o detalhamento do log para mostrar todos os logs de depuração.
--help -h Mostra a mensagem de ajuda.
--only-show-errors Mostra apenas erros, suprimindo avisos.
--output -o Formato de saída. Valores permitidos: json, jsonc, nonetable, , tsv, yaml, . yamlc Padrão: json.
--query Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
--subscription : Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
--verbose Aumentar o detalhamento do log. Use --debug para logs de depuração completos.