Compartilhar via


Visão geral da CLI do Azure Sphere

Importante

Esta é a documentação do Azure Sphere (herdado). O Azure Sphere (herdado) será desativado em 27 de setembro de 2027 e os usuários devem migrar para o Azure Sphere (integrado) até esse momento. Use o seletor de versão localizado acima do sumário para exibir a documentação do Azure Sphere (Integrado).

A CLI do Azure Sphere é um conjunto de comandos usados para gerenciar seus recursos do Azure Sphere.

Os seguintes comandos estão disponíveis:

Observação

O comando register-user agora está obsoleto.

CLI do Azure Sphere e CLI clássica do Azure Sphere

A CLI do Azure Sphere é instalada junto com a CLI existente no Windows e no Linux, para que você tenha acesso a qualquer uma das interfaces. A CLI clássica do Azure Sphere continua funcionando como sempre.

Para usar a CLI do Azure Sphere:

  • No Windows, use o PowerShell ou um prompt de comando padrão do Windows.
  • No Linux, use qualquer shell de comando. Especifique o comando azsphere se você definir a CLI do Azure Sphere como o padrão durante a instalação do SDK ou o comando azsphere_v2 se você definir a CLI clássica do Azure Sphere como o padrão.

Consulte a CLI do Azure Sphere para obter detalhes sobre os recursos e comandos compatíveis com a CLI do Azure Sphere.

Importante

  • No Windows, o atalho do Prompt de Comando do Desenvolvedor Clássico do Azure Sphere desativado só pode ser usado com a CLI clássica do Azure Sphere.

Formato de linha de comando

A linha de comando azsphere tem o seguinte formato:

azsphere [command] [subcommand] operation [parameters]

Em geral, comando e subcomando são substantivos e operação é um verbo, de modo que a combinação identifica uma ação e o objeto da ação. A maioria dos comandos e operações têm um nome completo e uma abreviação. Por exemplo, o comando device é abreviado como d.

A maioria dos parâmetros tem um nome longo e uma abreviação. Na linha de comando, insira o nome longo com dois hifens e a abreviação com um hífen. Por exemplo, os dois comandos a seguir são equivalentes:

azsphere device wifi add --ssid MyNetwork --psk mynetworkkey
azsphere device wifi add -s MyNetwork -p mynetworkkey

Alguns comandos permitem vários valores para um único parâmetro. Na CLI do Azure Sphere, você pode fornecer um único parâmetro seguido por uma lista de valores separados por espaços e, na CLI clássica do Azure Sphere, a lista de valores é separada por vírgulas. Por exemplo:

azsphere image-package pack-application --package-directory myDirectory --destination myImagePackage --executables filepath-1 filepath-2

Aspas e caracteres de escape

Ao trabalhar com comandos da CLI do Azure Sphere, lembre-se de como o shell usa aspas e caracteres de escape. Se você der suporte a scripts usados em shells diferentes, precisará entender a diferença entre eles.

Por exemplo:

Comandos dependentes de nuvem

Os comandos azsphere a seguir exigem uma conexão de nuvem e o logon no serviço de segurança do Azure Sphere:

  • ca-certificate
  • device-group
  • get-support-data
  • imagem
  • login
  • logout
  • produto
  • role
  • mostrar usuário
  • locatário

Além disso, os seguintes comandos azsphere device também exigem uma conexão de nuvem:

Comando azsphere device Comentários
capability Requer o serviço de segurança do Azure Sphere para download da capacidade do dispositivo
claim
enable-cloud-test
enable-development
imagem
lista
recover Exige conectividade com a Internet, mas não exige logon no Serviço de Segurança do Azure Sphere
show
show-count
show-deployment-status
show-os-version Exige conectividade com a Internet, mas não exige logon no Serviço de Segurança do Azure Sphere
update

Comandos dependentes da funcionalidade do dispositivo

Os seguintes comandos de dispositivo azsphere exigem que uma funcionalidade de dispositivo seja usada para dispositivos no estado de fabricação DeviceComplete:

Operação Descrição
app Gerencia aplicativos no dispositivo anexado.
capability Gerencia as configurações de funcionalidade do dispositivo. Necessário para atualização de funcionalidade.
certificate Gerencia o repositório de certificados do dispositivo.
imagem Gerencia as imagens do dispositivo.
estado de fabricação Gerencia o estado de fabricação dos dispositivos anexados. Necessário para atualização do estado de fabricação.
restart Reinicia o dispositivo anexado.
show-deployment-status Mostra o status de implantação do sistema operacional e dos aplicativos no dispositivo anexado.
show-os-version Mostre a versão do sistema operacional no dispositivo conectado.
carregamento lateral Implanta e gerencia aplicativos no dispositivo anexado. Necessário para implantação de sideload e exclusão de sideload.
wifi Gerencia as configurações de Wi-Fi do dispositivo anexado.

Se você tentar executar esses comandos sem um recurso, receberá uma mensagem de erro solicitando que você execute azsphere device enable-development ou use azsphere device capability para baixar e selecionar um arquivo de recurso para o dispositivo.