Fazer a migração da CLI clássica para a CLI do Azure Sphere

Se você ainda estiver usando a CLI clássica do Azure Sphere, recomendamos que você migre para a nova CLI do Azure Sphere. Atualmente, ambas as versões da CLI podem ser instaladas e usadas lado a lado, mas a CLI clássica não é mais atualizada nem mantida e será removida do SDK em uma data futura (não antes do final de 2022). Recomendamos que você se familiarize com essas diferenças e migre seus processos e scripts antes do final de 2022 para evitar interrupções.

Para atualizar para o SDK mais recente, confira Instalar o SDK do Azure Sphere no Linux ou Instalar o SDK do Azure Sphere para Windows.

Para usar a CLI do Azure Sphere no Windows, use o PowerShell ou um Prompt de Comando padrão do Windows. Para Linux, use qualquer shell de comando. Para obter mais informações, consulte Executar a CLI do Azure Sphere.

No Windows, o Prompt de Comando do Desenvolvedor Clássico do Azure Sphere personalizado e desativado (disponível como um atalho no menu Iniciar no Azure Sphere) pode ser usado somente com a CLI clássica do Azure Sphere. Para obter mais informações, consulte Executar a CLI clássica do Azure Sphere.

Principais diferenças

• Na CLI clássica do Azure Sphere, vários parâmetros podem ser usados para identificar cada tipo de objeto. Na CLI do Azure Sphere, um único parâmetro é usado para identificar cada tipo de objeto. Isso significa que você pode usar o nome ou a ID para especificar o valor do parâmetro. Isso foi implementado para os --deviceparâmetros , --tenant, --product, e --device-group .

  Tipo de objeto	Azure Sphere CLI	CLI clássica do Azure Sphere (está sendo desativada)
  Dispositivo	--device	--deviceid, --deviceip ou --devicelocation
  Grupo de dispositivos	--device-group	--devicegroupid ou --devicegroupname
  Product	--product	--productid ou --productname
  Locatário	--tenant	--tenantid

• A forma abreviada para comandos é suportada na versão clássica. Na CLI do Azure Sphere, recomendamos que você use o recurso Preenchimento de tabulação ou interativo para exibir a lista de comandos disponíveis. Por exemplo, na CLI clássica, você pode usar azsphere device enable-development o comando ou azsphere dev edv , enquanto na nova CLI do Azure Sphere você pode usar o preenchimento automático para digitar rapidamente o azsphere device enable-development comando.

• 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:

  • Azure Sphere CLI
  • CLI clássica do Azure Sphere

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

• Na nova CLI, o locatário padrão não é selecionado automaticamente quando um locatário é criado. Você precisa executar o comando azsphere tenant select para selecionar o locatário padrão a ser usado para o usuário atual no computador. Isso é para garantir que o locatário padrão seja o correto a ser usado ao executar uma operação única que você não pode desfazer, como reivindicar o dispositivo.

  Ao usar scripts, você pode selecionar o locatário padrão usando o --tenant <tenant ID or tenant name> parâmetro.

  Defina o locatário padrão no início do script usando:

  azsphere tenant select --tenant <tenant ID or tenant name>
  

  Você também pode substituir o locatário padrão ou especificar o locatário necessário ao executar o comando. Por exemplo:

  azsphere get-support-data --destination logs.zip --tenant <tenant ID or tenant name>
  

• O --device-group parâmetro identifica o grupo de dispositivos. A ID do grupo de dispositivos fornece um GUID, que identifica exclusivamente o grupo de dispositivos em todos os produtos. Como alternativa, você pode usar o par de nome do produto e nome do grupo de dispositivos no <formato product-name>/<device-group-name> . Esse par de nomes identifica exclusivamente um grupo de dispositivos para um produto específico.

• Os comandos a seguir eram comandos compostos na CLI clássica. Isso significa que um comando executou várias tarefas. Na nova CLI, você precisa executar os dois comandos.

  • Na CLI clássica, o comando azsphere device-group deployment create carregou o pacote de imagem e criou uma nova implantação.

    Na nova CLI, você precisa:

    1. Carregue o pacote de imagem em seu locatário do Azure Sphere usando azsphere image add.
    2. Crie uma nova implantação para um grupo de dispositivos para as imagens carregadas usando azsphere device-group deployment create.

  • Na CLI clássica, o comando azsphere device capability download --select baixou e selecionou temporariamente a configuração de funcionalidade do dispositivo para o dispositivo anexado.

    Na nova CLI, você precisa:

    1. Baixe o arquivo de funcionalidade usando o download de funcionalidade do dispositivo azsphere.
    2. Selecione a funcionalidade usando azsphere device capability select.

  • Na CLI clássica, o comando azsphere device capability download --apply baixou e aplicou a configuração de funcionalidade do dispositivo para o dispositivo anexado.

    Na nova CLI, você precisa:

    1. Baixe o arquivo de funcionalidade usando o download de funcionalidade do dispositivo azsphere.
    2. Aplique a funcionalidade usando a atualização de funcionalidade do dispositivo azsphere.

• Na CLI clássica, o -o parâmetro or --output é usado para especificar um caminho e um nome de arquivo no qual salvar um arquivo. Na nova CLI do Azure Sphere, parâmetros específicos do contexto são usados, como --destination especificar caminhos de entrada e saída.

• Na CLI clássica, o -d parâmetro or --debug é usado no comando azsphere device app start para iniciar o aplicativo no modo de depuração. Na nova CLI do Azure Sphere, o --debug-mode parâmetro é usado para iniciar o aplicativo no modo de depuração e o --debug parâmetro é usado como um parâmetro global para aumentar o detalhamento do log para mostrar todos os logs de depuração.

• Na CLI clássica, não há controle sobre o formato de saída. Na CLI do Azure Sphere, o -o parâmetro or --output é usado para especificar o formato de saída no qual formatar a saída da CLI.

• A partir da versão 21.02, os números de versão explícitos foram removidos dos nomes de produto da CLI do Azure Sphere. Essa alteração elimina a confusão ao se referir às diferentes versões do produto.

  • A CLI do Azure Sphere v2 e posterior agora são chamadas apenas de "CLI do Azure Sphere".
  • As versões anteriores da CLI do Azure Sphere (CLI v1 e inferior) agora são chamadas de "CLI clássica do Azure Sphere".

• Se você estiver usando scripts, eles podem não ser compatíveis com a nova CLI do Azure Sphere devido às diferenças explicadas acima. Faça as atualizações necessárias para que os scripts sejam executados corretamente na nova CLI.

Confira também

• Introdução à CLI do Azure Sphere
• CLI clássica do Azure Sphere (está sendo desativada)