Inquilino

Gerencia um locatário do Azure Sphere.

Importante

Os comandos azsphere tenant download-ca-certificatee azsphere tenant download-ca-certificate-chainestão azsphere tenant download-validation-certificate obsoletos. Use azsphere ca-certificate download, azsphere ca-certificate download-chain, azsphere ca-certificate download-proofe em vez azsphere ca-certificate list disso.

Na CLI do Azure Sphere, 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 declarar o dispositivo.

Operação Descrição
Criar Cria um novo locatário. Use a CLI clássica do Azure Sphere para executar esse comando.
download-error-report Retorna informações de erro para dispositivos dentro do locatário atual.
Lista Lista os locatários do Azure Sphere disponíveis.
Migrar Sem suporte.
Selecione Seleciona o locatário padrão do Azure Sphere a ser usado neste computador.
show-selected Mostra o locatário padrão do Azure Sphere para este computador.
Atualização Atualizações detalhes do locatário, como o nome do locatário.

Criar

Cria um novo locatário do Azure Sphere. Um dispositivo anexado é necessário para executar esse comando. Para obter mais informações, consulte Criar um locatário do Azure Sphere.

Se você já tiver um locatário e tiver certeza de que deseja outro, use o --force-additional parâmetro. No momento, não é possível excluir um locatário do Azure Sphere. Depois que o locatário for criado, execute azsphere tenant select to select the default tenant to use for the current user on this PC. Você pode adicionar funções para usuários no locatário atual do Azure Sphere usando o comando azsphere role add .

O comando azsphere tenant create funciona com um dispositivo Azure Sphere anexado localmente. Se você tentar o comando sem um dispositivo anexado, receberá um erro. A ID do dispositivo é registrada quando você cria um locatário e apenas um locatário pode ser criado por dispositivo.

Parâmetros necessários

Parâmetro Tipo Descrição Versão com suporte
-n, --name String Especifica um nome para o locatário. Ao nomear seu locatário, use caracteres alfanuméricos. Caracteres especiais não são permitidos. O nome não deve exceder 50 caracteres e diferencia maiúsculas de minúsculas. – CLI do Azure Sphere
– CLI clássica do Azure Sphere

Parâmetros opcionais

Parâmetro Tipo Descrição Versão com suporte
-d, --device String Especifica o dispositivo no qual executar o comando quando vários dispositivos são anexados. Esse parâmetro é necessário quando vários dispositivos são anexados. O dispositivo anexado no momento é usado por padrão. Você pode especificar a ID do dispositivo, o endereço IP ou a ID de Conexão Local do dispositivo anexado.
A CLI do Azure Sphere dá suporte a vários dispositivos MT3620 no Windows, mas você pode conectar apenas um dispositivo por vez no Linux. Por esse motivo, esse parâmetro tem suporte para Windows, mas não para Linux. Um erro será retornado se você usar esse parâmetro com o comando no Linux.
Azure Sphere CLI
--force-additional Boolean Força a criação de um novo locatário do Azure Sphere. Use esse comando somente se tiver certeza de que deseja usar a conta atual para criar um novo locatário do Azure Sphere usando o dispositivo anexado. Azure Sphere CLI
--disable-confirm-prompt Boolean Desabilita o prompt de confirmação do usuário. Azure Sphere CLI
-ip, --deviceip String (Vários dispositivos, somente Windows) Especifica o endereço IP do dispositivo a ser usado para esta operação.
Isso só é necessário quando vários dispositivos são anexados. Você pode especificar um IP do dispositivo ou o local do dispositivo.
CLI clássica do Azure Sphere
-l, --devicelocation String (Vários dispositivos, somente Windows) Especifica a ID de localização FTDI do dispositivo a ser usado para esta operação.
Isso só é necessário quando vários dispositivos são anexados. Você pode especificar um IP do dispositivo ou o local do dispositivo.
CLI clássica do Azure Sphere
--force Boolean Força a criação de um novo locatário do Azure Sphere. Use esse comando somente se tiver certeza de que deseja usar a conta atual para criar um novo locatário do Azure Sphere usando o dispositivo anexado. CLI clássica do Azure Sphere
Parâmetros globais

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

Parâmetro Descrição
--debug Aumenta o detalhamento do log para mostrar todos os logs de depuração. Se você encontrar um bug, forneça a saída gerada com o --debug sinalizador ativado ao enviar um relatório de bugs.
-h, --help Imprime informações de referência da CLI sobre comandos e seus argumentos e listas de subgrupos e comandos disponíveis.
--only-show-errors Mostra apenas erros, suprimindo avisos.
-o, --output Altera o formato de saída. Os formatos de saída disponíveis são json, jsonc (JSON colorido), tsv (valores separados por tabulação), tabela (tabelas ASCII legíveis por humanos) e yaml. Por padrão, a CLI gera saídas table. Para saber mais sobre os formatos de saída disponíveis, consulte o formato de saída para comandos da CLI do Azure Sphere.
--query Usa a linguagem de consulta JMESPath para filtrar a saída retornada dos Serviços de Segurança do Azure Sphere. Consulte o tutorial do JMESPathe consulte a saída do comando da CLI do Azure para obter mais informações e exemplos.
--verbose Imprime informações sobre os recursos criados no Azure Sphere durante uma operação e outras informações úteis. Use --debug para logs de depuração completos.

Nota

Se você estiver usando a CLI clássica do Azure Sphere, consulte Parâmetros globais para obter mais informações sobre as opções disponíveis.

Exemplo

azsphere tenant create --name MyTenant

Use o --force-additional e os --disable-confirm-prompt parâmetros se tiver certeza de que deseja usar essa conta para criar um novo locatário do Azure Sphere usando o dispositivo anexado. Um dispositivo que foi usado anteriormente para criar um locatário do Azure Sphere não pode ser usado para criar um novo locatário.

azsphere tenant create --name MyTenant --force-additional
You have logged in with the following account:
bob@contoso.com
Do you want to use this account to create a new Azure Sphere tenant using the attached device?
You cannot change the tenant name 'MyTenant1' once it has been created.
Enter 'yes' to continue. Enter anything else to exit.
yes
> verbose: TraceId: c761ba73-761e-4df2-94f5-3f87384d71b7
Created a new Azure Sphere tenant:
 --> Tenant Name: MyTenant1
 --> Tenant ID:   768c2cd6-059a-49ad-9f53-89f5271cea15
Please use 'azsphere tenant select --tenant MyTenant' to select the created tenant.

Ponta

Depois de criar um locatário, verifique se você executa o locatário do azsphere para selecionar o locatário padrão a ser usado para o usuário atual neste computador.

download-error-report

Retorna informações sobre erros relatados por dispositivos dentro do locatário atual.

Esse comando extrai dados de evento da nuvem do Serviço de Segurança do Azure Sphere e não requer uma conexão física com um dispositivo específico. O comando download-error-report do locatário do azsphere funciona no contexto do locatário atual e retorna relatórios de erro para todos os dispositivos dentro desse locatário.

Nota

Pode levar até 24 horas para que os eventos relatados recentemente sejam disponibilizados para download. Para obter mais informações, consulte Coletar e interpretar dados de erro.

Parâmetros opcionais

Parâmetro Tipo Descrição Versão com suporte
--destination String Especifica o caminho e o nome do arquivo de saída. Azure Sphere CLI
-t, --tenant GUID ou nome Especifica o locatário no qual executar essa operação. Substitui o locatário selecionado padrão. Você pode especificar a ID do locatário ou o nome do locatário. Azure Sphere CLI
-o, --output String Especifica o caminho e o nome do arquivo de saída. CLI clássica do Azure Sphere
Parâmetros globais

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

Parâmetro Descrição
--debug Aumenta o detalhamento do log para mostrar todos os logs de depuração. Se você encontrar um bug, forneça a saída gerada com o --debug sinalizador ativado ao enviar um relatório de bugs.
-h, --help Imprime informações de referência da CLI sobre comandos e seus argumentos e listas de subgrupos e comandos disponíveis.
--only-show-errors Mostra apenas erros, suprimindo avisos.
-o, --output Altera o formato de saída. Os formatos de saída disponíveis são json, jsonc (JSON colorido), tsv (valores separados por tabulação), tabela (tabelas ASCII legíveis por humanos) e yaml. Por padrão, a CLI gera saídas table. Para saber mais sobre os formatos de saída disponíveis, consulte o formato de saída para comandos da CLI do Azure Sphere.
--query Usa a linguagem de consulta JMESPath para filtrar a saída retornada dos Serviços de Segurança do Azure Sphere. Consulte o tutorial do JMESPathe consulte a saída do comando da CLI do Azure para obter mais informações e exemplos.
--verbose Imprime informações sobre os recursos criados no Azure Sphere durante uma operação e outras informações úteis. Use --debug para logs de depuração completos.

Nota

Se você estiver usando a CLI clássica do Azure Sphere, consulte Parâmetros globais para obter mais informações sobre as opções disponíveis.

Exemplo

azsphere tenant download-error-report --destination c:\error-report.csv --tenant 143adbc9-1bf0-4be2-84a2-084a331d81cb

Lista

Lista os locatários do Azure Sphere.

Parâmetros globais

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

Parâmetro Descrição
--debug Aumenta o detalhamento do log para mostrar todos os logs de depuração. Se você encontrar um bug, forneça a saída gerada com o --debug sinalizador ativado ao enviar um relatório de bugs.
-h, --help Imprime informações de referência da CLI sobre comandos e seus argumentos e listas de subgrupos e comandos disponíveis.
--only-show-errors Mostra apenas erros, suprimindo avisos.
-o, --output Altera o formato de saída. Os formatos de saída disponíveis são json, jsonc (JSON colorido), tsv (valores separados por tabulação), tabela (tabelas ASCII legíveis por humanos) e yaml. Por padrão, a CLI gera saídas table. Para saber mais sobre os formatos de saída disponíveis, consulte o formato de saída para comandos da CLI do Azure Sphere.
--query Usa a linguagem de consulta JMESPath para filtrar a saída retornada dos Serviços de Segurança do Azure Sphere. Consulte o tutorial do JMESPathe consulte a saída do comando da CLI do Azure para obter mais informações e exemplos.
--verbose Imprime informações sobre os recursos criados no Azure Sphere durante uma operação e outras informações úteis. Use --debug para logs de depuração completos.

Nota

Se você estiver usando a CLI clássica do Azure Sphere, consulte Parâmetros globais para obter mais informações sobre as opções disponíveis.

Exemplo

azsphere tenant list
 ------------------------------------ --------------------- -------------
 Id                                   Name                  Roles
 ========================================================================
 143adbc9-1bf0-4be2-84a2-084a331d81cb MyTenant               Administrator
                                                            Contributor
 ------------------------------------ --------------------- -------------

Migrar

Nota

Não há suporte para esse comando.

Selecione

Seleciona o locatário padrão do Azure Sphere a ser usado para o usuário atual neste computador.

Para exibir o locatário padrão atual, use azsphere tenant show-selected.

Parâmetros necessários

Parâmetro Tipo Descrição Versão com suporte
-t, --tenant GUID ou nome Especifica o locatário no qual executar essa operação. Substitui o locatário selecionado padrão. Você pode especificar a ID do locatário ou o nome do locatário. Azure Sphere CLI
-i, --tenantid GUID Especifica a ID do locatário do Azure Sphere a ser selecionado como o padrão neste computador. CLI clássica do Azure Sphere
Parâmetros globais

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

Parâmetro Descrição
--debug Aumenta o detalhamento do log para mostrar todos os logs de depuração. Se você encontrar um bug, forneça a saída gerada com o --debug sinalizador ativado ao enviar um relatório de bugs.
-h, --help Imprime informações de referência da CLI sobre comandos e seus argumentos e listas de subgrupos e comandos disponíveis.
--only-show-errors Mostra apenas erros, suprimindo avisos.
-o, --output Altera o formato de saída. Os formatos de saída disponíveis são json, jsonc (JSON colorido), tsv (valores separados por tabulação), tabela (tabelas ASCII legíveis por humanos) e yaml. Por padrão, a CLI gera saídas table. Para saber mais sobre os formatos de saída disponíveis, consulte o formato de saída para comandos da CLI do Azure Sphere.
--query Usa a linguagem de consulta JMESPath para filtrar a saída retornada dos Serviços de Segurança do Azure Sphere. Consulte o tutorial do JMESPathe consulte a saída do comando da CLI do Azure para obter mais informações e exemplos.
--verbose Imprime informações sobre os recursos criados no Azure Sphere durante uma operação e outras informações úteis. Use --debug para logs de depuração completos.

Nota

Se você estiver usando a CLI clássica do Azure Sphere, consulte Parâmetros globais para obter mais informações sobre as opções disponíveis.

Exemplo

azsphere tenant select --tenant 143adbc9-1bf0-4be2-84a2-084a331d81cb
 ------------------------------------ --------------------- -------------
 Id                                   Name                  Roles
 ========================================================================
 143adbc9-1bf0-4be2-84a2-084a331d81cb MyTenant               Administrator
                                                            Contributor
 ------------------------------------ --------------------- -------------

show-selected

Exibe os detalhes do locatário padrão do Azure Sphere para o usuário atual neste computador.

Esse é o locatário selecionado com o comando azsphere tenant select .

Parâmetros globais

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

Parâmetro Descrição
--debug Aumenta o detalhamento do log para mostrar todos os logs de depuração. Se você encontrar um bug, forneça a saída gerada com o --debug sinalizador ativado ao enviar um relatório de bugs.
-h, --help Imprime informações de referência da CLI sobre comandos e seus argumentos e listas de subgrupos e comandos disponíveis.
--only-show-errors Mostra apenas erros, suprimindo avisos.
-o, --output Altera o formato de saída. Os formatos de saída disponíveis são json, jsonc (JSON colorido), tsv (valores separados por tabulação), tabela (tabelas ASCII legíveis por humanos) e yaml. Por padrão, a CLI gera saídas table. Para saber mais sobre os formatos de saída disponíveis, consulte o formato de saída para comandos da CLI do Azure Sphere.
--query Usa a linguagem de consulta JMESPath para filtrar a saída retornada dos Serviços de Segurança do Azure Sphere. Consulte o tutorial do JMESPathe consulte a saída do comando da CLI do Azure para obter mais informações e exemplos.
--verbose Imprime informações sobre os recursos criados no Azure Sphere durante uma operação e outras informações úteis. Use --debug para logs de depuração completos.

Nota

Se você estiver usando a CLI clássica do Azure Sphere, consulte Parâmetros globais para obter mais informações sobre as opções disponíveis.

Exemplo

azsphere tenant show-selected
 ------------------------------------ --------------------- -------------
 Id                                   Name                  Roles
 ========================================================================
 143adbc9-1bf0-4be2-84a2-084a331d81cb MyTenant               Administrator
                                                            Contributor
 ------------------------------------ --------------------- -------------

Atualização

Atualizações detalhes de um locatário, como o nome do locatário.

Parâmetros necessários

Parâmetro Tipo Descrição Versão com suporte
-n, --new-name String Especifica um novo nome para o locatário. Ao nomear seu locatário, use caracteres alfanuméricos. Caracteres especiais não são permitidos. O nome não deve exceder 50 caracteres e diferencia maiúsculas de minúsculas. Azure Sphere CLI

Parâmetros opcionais

Parâmetro Tipo Descrição Versão com suporte
-t, --tenant GUID ou nome Especifica o locatário no qual executar essa operação. Substitui o locatário selecionado padrão. Você pode especificar a ID do locatário ou o nome do locatário. Azure Sphere CLI
Parâmetros globais

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

Parâmetro Descrição
--debug Aumenta o detalhamento do log para mostrar todos os logs de depuração. Se você encontrar um bug, forneça a saída gerada com o --debug sinalizador ativado ao enviar um relatório de bugs.
-h, --help Imprime informações de referência da CLI sobre comandos e seus argumentos e listas de subgrupos e comandos disponíveis.
--only-show-errors Mostra apenas erros, suprimindo avisos.
-o, --output Altera o formato de saída. Os formatos de saída disponíveis são json, jsonc (JSON colorido), tsv (valores separados por tabulação), tabela (tabelas ASCII legíveis por humanos) e yaml. Por padrão, a CLI gera saídas table. Para saber mais sobre os formatos de saída disponíveis, consulte o formato de saída para comandos da CLI do Azure Sphere.
--query Usa a linguagem de consulta JMESPath para filtrar a saída retornada dos Serviços de Segurança do Azure Sphere. Consulte o tutorial do JMESPathe consulte a saída do comando da CLI do Azure para obter mais informações e exemplos.
--verbose Imprime informações sobre os recursos criados no Azure Sphere durante uma operação e outras informações úteis. Use --debug para logs de depuração completos.

Nota

Se você estiver usando a CLI clássica do Azure Sphere, consulte Parâmetros globais para obter mais informações sobre as opções disponíveis.

Exemplo

azsphere tenant update --tenant a323c263-2aa3-2559-aabb-a3fc32631900 --new-name Tenant2
 ------------------------------------ --------------------- -------------
 Id                                   Name                  Roles
 ========================================================================
 a323c263-2aa3-2559-aabb-a3fc32631900 Tenant2               Administrator
                                                            Contributor
 ------------------------------------ --------------------- -------------

Ponta

Se você não tiver selecionado um locatário padrão, uma lista de locatários disponíveis será exibida. Defina seu locatário padrão selecionando uma das opções.