Migrar da CLI clássica para a CLI do Azure Sphere

  • Artigo

Se ainda estiver a utilizar a CLI clássica do Azure Sphere, recomendamos que migre para a nova CLI do Azure Sphere. Atualmente, ambas as versões da CLI podem ser instaladas e utilizadas lado a lado, mas a CLI clássica já não é atualizada ou mantida e será removida do SDK numa data futura (não antes do final de 2022). Recomendamos que se familiarize com estas diferenças e migre os seus processos e scripts antes do final de 2022 para evitar interrupções.

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

Para utilizar a CLI do Azure Sphere no Windows, utilize o PowerShell ou uma Linha de Comandos padrão do Windows. Para Linux, utilize qualquer shell de comandos. Para obter mais informações, veja Executar a CLI do Azure Sphere.

No Windows, a linha de comandos do Programador Clássico do Azure Sphere (disponível como atalho no menu Iniciar no Azure Sphere) só pode ser utilizada com a CLI clássica do Azure Sphere. Para obter mais informações, veja Executar a CLI clássica do Azure Sphere.

Principais diferenças

  • Na CLI clássica do Azure Sphere, podem ser utilizados vários parâmetros para identificar cada tipo de objeto. Na CLI do Azure Sphere, é utilizado um único parâmetro para identificar cada tipo de objeto. Isto significa que pode utilizar o nome ou o ID para especificar o valor do parâmetro. Isto foi implementado para os --deviceparâmetros , --tenant, --producte --device-group .

    Tipo de objeto Azure Sphere CLI CLI clássica do Azure Sphere (descontinuação)
    Dispositivo --device --deviceid, --deviceipou --devicelocation
    Grupo de dispositivos --device-group --devicegroupid ou --devicegroupname
    Produto --product --productid ou --productname
    Inquilino --tenant --tenantid

  • O formato abreviado para comandos é suportado na versão clássica. Na CLI do Azure Sphere, recomendamos que utilize a funcionalidade interativa ou conclusão da Tabulação para ver a lista de comandos disponíveis. Por exemplo, na CLI clássica, pode utilizar um azsphere device enable-development ou azsphere dev edv um comando, enquanto na nova CLI do Azure Sphere pode utilizar a conclusão automática para escrever rapidamente o azsphere device enable-development comando.

  • Alguns comandos permitem vários valores para um único parâmetro. Na CLI do Azure Sphere, pode fornecer um único parâmetro seguido de 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

  • Na nova CLI, o inquilino predefinido não é selecionado automaticamente quando um inquilino é criado. Tem de executar o comando azsphere tenant select para selecionar o inquilino predefinido a utilizar para o utilizador atual no PC. Isto é para garantir que o inquilino predefinido é o correto a utilizar ao executar uma operação única que não pode anular como reclamar o dispositivo.

    Ao utilizar scripts, pode selecionar o inquilino predefinido com o --tenant <tenant ID or tenant name> parâmetro .

    Defina o inquilino predefinido no início do script com:

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

    Também pode substituir o inquilino predefinido ou especificar o inquilino 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. O ID do grupo de dispositivos fornece um GUID, que identifica exclusivamente o grupo de dispositivos em todos os produtos. Em alternativa, pode utilizar o nome do produto e o par de nomes do grupo de dispositivos no <formato product-name>/<device-group-name> . Este par de nomes identifica exclusivamente um grupo de dispositivos para um determinado produto.

  • Os seguintes comandos eram comandos compostos na CLI clássica. Isto significa que um comando executou várias tarefas. Na nova CLI, tem de executar os dois comandos.

  • Na CLI clássica, o -o parâmetro ou --output é utilizado para especificar um caminho e um nome de ficheiro para guardar um ficheiro. Na nova CLI do Azure Sphere, são utilizados parâmetros específicos do contexto, como --destination para especificar caminhos de entrada e saída.

  • Na CLI clássica, o -d parâmetro ou --debug é utilizado no comando azsphere device app start para iniciar a aplicação no modo de depuração. Na nova CLI do Azure Sphere, o --debug-mode parâmetro é utilizado para iniciar a aplicação no modo de depuração e o --debug parâmetro é utilizado como um parâmetro global para aumentar a verbosidade do registo para mostrar todos os registos de depuração.

  • Na CLI clássica, não existe controlo sobre o formato de saída. Na CLI do Azure Sphere, o -o parâmetro ou --output é utilizado 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 produtos da CLI do Azure Sphere. Esta alteração elimina a confusão ao referir-se às diferentes versões do produto.

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

  • Se estiver a utilizar scripts, estes poderão 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.

Consulte também