tenant
Importante
Esta é a documentação do Azure Sphere (Legado). O Azure Sphere (Legado) 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).
Gerencia um locatário do Azure Sphere.
Importante
Os comandos azsphere tenant download-ca-certificate, azsphere tenant download-ca-certificate-chaine azsphere tenant download-validation-certificate são obsoletos. Use azsphere ca-certificate download, azsphere ca-certificate download-chain, azsphere ca-certificate download-proof, e azsphere ca-certificate list em vez 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 PC. 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.
| Operation | Description |
|---|---|
| criar | Cria um novo locatário. |
| download-erro-relatório | Retorna informações de erro para dispositivos dentro do locatário atual. |
| list | Lista os locatários disponíveis do Azure Sphere. |
| selecione | Seleciona o locatário padrão do Azure Sphere a ser usado neste computador. |
| mostrar-selecionado | Mostra o locatário padrão do Azure Sphere para este computador. |
| atualizar | Atualiza os detalhes do locatário, como o nome do locatário. |
criar
Cria um novo locatário do Azure Sphere. É necessário um dispositivo anexado para executar este comando. Para obter mais informações, consulte Criar um locatário do Azure Sphere.
Se você já tem um locatário e tem certeza de que deseja outro, use o --force-additional parâmetro. Atualmente, não é possível excluir um locatário do Azure Sphere.
Depois que o locatário for criado, execute azsphere tenant select para selecionar o locatário padrão a ser usado para o usuário atual neste 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 conectado localmente. Se você tentar o comando sem um dispositivo conectado, você receberá um erro. O ID do dispositivo é registrado quando você cria um locatário e apenas um locatário pode ser criado por dispositivo.
Parâmetros obrigatórios
| Parâmetro | Tipo | Description |
|---|---|---|
| -n, --nome | String | Especifica um nome para o locatário. Ao nomear seu locatário, use caracteres alfanuméricos. Não são permitidos caracteres especiais. O nome não deve exceder 50 caracteres e diferencia maiúsculas de minúsculas. |
Parâmetros opcionais
| Parâmetro | Tipo | Description |
|---|---|---|
| -d, --dispositivo | String | Especifica o dispositivo no qual executar o comando quando vários dispositivos são conectados. Este parâmetro é necessário quando vários dispositivos são conectados. O dispositivo atualmente conectado é usado por padrão. Você pode especificar o ID do dispositivo, o endereço IP ou o ID de conexão local do dispositivo conectado. A CLI do Azure Sphere dá suporte a vários dispositivos MT3620 no Windows, mas você pode conectar apenas um dispositivo de cada vez no Linux. Por esse motivo, esse parâmetro é suportado para Windows, mas não para Linux. Um erro será retornado se você usar esse parâmetro com o comando no Linux. |
| --força-adicional | Boolean | Força a criação de um novo locatário do Azure Sphere. Use este 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. |
| --desativar-confirmar-prompt | Boolean | Desativa o prompt de confirmação do usuário. |
Parâmetros globais
Os seguintes parâmetros globais estão disponíveis para a CLI do Azure Sphere:
| Parâmetro | Description |
|---|---|
| --depuração | Aumenta a verbosidade do registro para mostrar todos os logs de depuração. Se detetar um erro, forneça o resultado gerado com o sinalizador --debug ativado quando enviar um relatório de erros. |
| -h, --ajuda | Imprime informações de referência da CLI sobre comandos e seus argumentos e lista subgrupos e comandos disponíveis. |
| --only-show-errors | Mostra apenas erros, suprimindo avisos. |
| -o, --saída | Altera o formato de saída. Os formatos de saída disponíveis são json, jsonc (JSON colorido), tsv (Tab-Separated Values), table (tabelas ASCII legíveis por humanos) e yaml. Por predefinição, a CLI produz table. Para saber mais sobre os formatos de saída disponíveis, consulte Formato de saída para comandos da CLI do Azure Sphere. |
| --consulta | Usa a linguagem de consulta JMESPath para filtrar a saída retornada dos Serviços de Segurança do Azure Sphere. Consulte o tutorial JMESPath e a saída do comando Query Azure CLI para obter mais informações e exemplos. |
| --verborrágico | Imprime informações sobre recursos criados no Azure Sphere durante uma operação e outras informações úteis. Utilize --debug para os registos 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 os --force-additional parâmetros e --disable-confirm-prompt 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 tenha sido 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.
Gorjeta
Depois de criar um locatário, certifique-se de executar azsphere tenant select para selecionar o locatário padrão a ser usado para o usuário atual neste PC.
download-erro-relatório
Retorna informações sobre erros relatados por dispositivos dentro do locatário atual.
Este comando extrai dados de eventos 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 azsphere tenant download-error-report funciona no contexto do locatário atual e retorna relatórios de erros para todos os dispositivos dentro desse locatário.
Nota
Pode levar até 24 horas para que os eventos relatados recentemente estejam disponíveis para download. Para obter mais informações, consulte Coletar e interpretar dados de erro.
Parâmetros opcionais
| Parâmetro | Tipo | Description |
|---|---|---|
| --destino | String | Especifica o caminho e o nome do arquivo de saída. |
| -t, --inquilino | GUID ou nome | Especifica o locatário no qual executar essa operação. Substitui o locatário selecionado padrão. Você pode especificar o ID do locatário ou o nome do locatário. |
Parâmetros globais
Os seguintes parâmetros globais estão disponíveis para a CLI do Azure Sphere:
| Parâmetro | Description |
|---|---|
| --depuração | Aumenta a verbosidade do registro para mostrar todos os logs de depuração. Se detetar um erro, forneça o resultado gerado com o sinalizador --debug ativado quando enviar um relatório de erros. |
| -h, --ajuda | Imprime informações de referência da CLI sobre comandos e seus argumentos e lista subgrupos e comandos disponíveis. |
| --only-show-errors | Mostra apenas erros, suprimindo avisos. |
| -o, --saída | Altera o formato de saída. Os formatos de saída disponíveis são json, jsonc (JSON colorido), tsv (Tab-Separated Values), table (tabelas ASCII legíveis por humanos) e yaml. Por predefinição, a CLI produz table. Para saber mais sobre os formatos de saída disponíveis, consulte Formato de saída para comandos da CLI do Azure Sphere. |
| --consulta | Usa a linguagem de consulta JMESPath para filtrar a saída retornada dos Serviços de Segurança do Azure Sphere. Consulte o tutorial JMESPath e a saída do comando Query Azure CLI para obter mais informações e exemplos. |
| --verborrágico | Imprime informações sobre recursos criados no Azure Sphere durante uma operação e outras informações úteis. Utilize --debug para os registos 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
list
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 | Description |
|---|---|
| --depuração | Aumenta a verbosidade do registro para mostrar todos os logs de depuração. Se detetar um erro, forneça o resultado gerado com o sinalizador --debug ativado quando enviar um relatório de erros. |
| -h, --ajuda | Imprime informações de referência da CLI sobre comandos e seus argumentos e lista subgrupos e comandos disponíveis. |
| --only-show-errors | Mostra apenas erros, suprimindo avisos. |
| -o, --saída | Altera o formato de saída. Os formatos de saída disponíveis são json, jsonc (JSON colorido), tsv (Tab-Separated Values), table (tabelas ASCII legíveis por humanos) e yaml. Por predefinição, a CLI produz table. Para saber mais sobre os formatos de saída disponíveis, consulte Formato de saída para comandos da CLI do Azure Sphere. |
| --consulta | Usa a linguagem de consulta JMESPath para filtrar a saída retornada dos Serviços de Segurança do Azure Sphere. Consulte o tutorial JMESPath e a saída do comando Query Azure CLI para obter mais informações e exemplos. |
| --verborrágico | Imprime informações sobre recursos criados no Azure Sphere durante uma operação e outras informações úteis. Utilize --debug para os registos 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
------------------------------------ --------------------- -------------
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 obrigatórios
| Parâmetro | Tipo | Description |
|---|---|---|
| -t, --inquilino | GUID ou nome | Especifica o locatário no qual executar essa operação. Substitui o locatário selecionado padrão. Você pode especificar o ID do locatário ou o nome do locatário. |
Parâmetros globais
Os seguintes parâmetros globais estão disponíveis para a CLI do Azure Sphere:
| Parâmetro | Description |
|---|---|
| --depuração | Aumenta a verbosidade do registro para mostrar todos os logs de depuração. Se detetar um erro, forneça o resultado gerado com o sinalizador --debug ativado quando enviar um relatório de erros. |
| -h, --ajuda | Imprime informações de referência da CLI sobre comandos e seus argumentos e lista subgrupos e comandos disponíveis. |
| --only-show-errors | Mostra apenas erros, suprimindo avisos. |
| -o, --saída | Altera o formato de saída. Os formatos de saída disponíveis são json, jsonc (JSON colorido), tsv (Tab-Separated Values), table (tabelas ASCII legíveis por humanos) e yaml. Por predefinição, a CLI produz table. Para saber mais sobre os formatos de saída disponíveis, consulte Formato de saída para comandos da CLI do Azure Sphere. |
| --consulta | Usa a linguagem de consulta JMESPath para filtrar a saída retornada dos Serviços de Segurança do Azure Sphere. Consulte o tutorial JMESPath e a saída do comando Query Azure CLI para obter mais informações e exemplos. |
| --verborrágico | Imprime informações sobre recursos criados no Azure Sphere durante uma operação e outras informações úteis. Utilize --debug para os registos 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
------------------------------------ --------------------- -------------
mostrar-selecionado
Exibe os detalhes do locatário padrão do Azure Sphere para o usuário atual neste computador.
Este é 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 | Description |
|---|---|
| --depuração | Aumenta a verbosidade do registro para mostrar todos os logs de depuração. Se detetar um erro, forneça o resultado gerado com o sinalizador --debug ativado quando enviar um relatório de erros. |
| -h, --ajuda | Imprime informações de referência da CLI sobre comandos e seus argumentos e lista subgrupos e comandos disponíveis. |
| --only-show-errors | Mostra apenas erros, suprimindo avisos. |
| -o, --saída | Altera o formato de saída. Os formatos de saída disponíveis são json, jsonc (JSON colorido), tsv (Tab-Separated Values), table (tabelas ASCII legíveis por humanos) e yaml. Por predefinição, a CLI produz table. Para saber mais sobre os formatos de saída disponíveis, consulte Formato de saída para comandos da CLI do Azure Sphere. |
| --consulta | Usa a linguagem de consulta JMESPath para filtrar a saída retornada dos Serviços de Segurança do Azure Sphere. Consulte o tutorial JMESPath e a saída do comando Query Azure CLI para obter mais informações e exemplos. |
| --verborrágico | Imprime informações sobre recursos criados no Azure Sphere durante uma operação e outras informações úteis. Utilize --debug para os registos 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
------------------------------------ --------------------- -------------
update
Atualiza os detalhes de um locatário, como o nome do locatário.
Parâmetros obrigatórios
| Parâmetro | Tipo | Description |
|---|---|---|
| -n, --novo-nome | String | Especifica um novo nome para o locatário. Ao nomear seu locatário, use caracteres alfanuméricos. Não são permitidos caracteres especiais. O nome não deve exceder 50 caracteres e diferencia maiúsculas de minúsculas. |
Parâmetros opcionais
| Parâmetro | Tipo | Description |
|---|---|---|
| -t, --inquilino | GUID ou nome | Especifica o locatário no qual executar essa operação. Substitui o locatário selecionado padrão. Você pode especificar o ID do locatário ou o nome do locatário. |
Parâmetros globais
Os seguintes parâmetros globais estão disponíveis para a CLI do Azure Sphere:
| Parâmetro | Description |
|---|---|
| --depuração | Aumenta a verbosidade do registro para mostrar todos os logs de depuração. Se detetar um erro, forneça o resultado gerado com o sinalizador --debug ativado quando enviar um relatório de erros. |
| -h, --ajuda | Imprime informações de referência da CLI sobre comandos e seus argumentos e lista subgrupos e comandos disponíveis. |
| --only-show-errors | Mostra apenas erros, suprimindo avisos. |
| -o, --saída | Altera o formato de saída. Os formatos de saída disponíveis são json, jsonc (JSON colorido), tsv (Tab-Separated Values), table (tabelas ASCII legíveis por humanos) e yaml. Por predefinição, a CLI produz table. Para saber mais sobre os formatos de saída disponíveis, consulte Formato de saída para comandos da CLI do Azure Sphere. |
| --consulta | Usa a linguagem de consulta JMESPath para filtrar a saída retornada dos Serviços de Segurança do Azure Sphere. Consulte o tutorial JMESPath e a saída do comando Query Azure CLI para obter mais informações e exemplos. |
| --verborrágico | Imprime informações sobre recursos criados no Azure Sphere durante uma operação e outras informações úteis. Utilize --debug para os registos 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
------------------------------------ --------------------- -------------
Gorjeta
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.