Inquilino
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-proofe 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 de seleção de locatário do azsphere 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.
| Operação | Descrição |
|---|---|
| Criar | Cria um novo locatário. |
| download-error-report | Retorna informações de erro para dispositivos dentro do locatário atual. |
| Lista | Lista os locatários disponíveis do Azure Sphere. |
| 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 os 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. Atualmente, você não pode excluir um locatário do Azure Sphere.
Depois que o locatário for criado, execute azsphere tenant select to 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 do 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 |
|---|---|---|
| -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 é sensível ao caso. |
Parâmetros opcionais
| Parâmetro | Tipo | Descrição |
|---|---|---|
| -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 atualmente anexado é 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. |
| --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. |
| --disable-confirm-prompt | Boolean | Desabilita 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 | Descrição |
|---|---|
| --Depurar | Aumenta a verbosidade de 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 lista 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 Guia), tabela (tabelas ASCII legíveis pelo homem) e yaml. Por padrão, a CLI gera table. Para saber mais sobre os formatos de saída disponíveis, confira 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 de comando da CLI do Azure para obter mais informações e exemplos. |
| --Verbose | Imprime informações sobre 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 os --force-additional parâmetros e --disable-confirm-prompt se você tiver certeza de que deseja usar essa conta para criar um novo locatário do Azure Sphere usando o dispositivo anexado. Um dispositivo 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 azsphere tenant select to select to select the default tenant to use for the current user on this PC.
download-error-report
Retorna informações sobre erros relatados por dispositivos no locatário atual.
Esse 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 erro para todos os dispositivos dentro desse locatário.
Nota
Pode levar até 24 horas para que 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 | Descrição |
|---|---|---|
| --Destino | String | Especifica o caminho e o nome do arquivo de saída. |
| -t, --locatário | 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. |
Parâmetros globais
Os seguintes parâmetros globais estão disponíveis para a CLI do Azure Sphere:
| Parâmetro | Descrição |
|---|---|
| --Depurar | Aumenta a verbosidade de 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 lista 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 Guia), tabela (tabelas ASCII legíveis pelo homem) e yaml. Por padrão, a CLI gera table. Para saber mais sobre os formatos de saída disponíveis, confira 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 de comando da CLI do Azure para obter mais informações e exemplos. |
| --Verbose | Imprime informações sobre 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 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 |
|---|---|
| --Depurar | Aumenta a verbosidade de 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 lista 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 Guia), tabela (tabelas ASCII legíveis pelo homem) e yaml. Por padrão, a CLI gera table. Para saber mais sobre os formatos de saída disponíveis, confira 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 de comando da CLI do Azure para obter mais informações e exemplos. |
| --Verbose | Imprime informações sobre 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
------------------------------------ --------------------- -------------
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 |
|---|---|---|
| -t, --locatário | 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. |
Parâmetros globais
Os seguintes parâmetros globais estão disponíveis para a CLI do Azure Sphere:
| Parâmetro | Descrição |
|---|---|
| --Depurar | Aumenta a verbosidade de 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 lista 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 Guia), tabela (tabelas ASCII legíveis pelo homem) e yaml. Por padrão, a CLI gera table. Para saber mais sobre os formatos de saída disponíveis, confira 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 de comando da CLI do Azure para obter mais informações e exemplos. |
| --Verbose | Imprime informações sobre 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.
Este é o locatário selecionado com o comando de seleção de locatário do azsphere .
Parâmetros globais
Os seguintes parâmetros globais estão disponíveis para a CLI do Azure Sphere:
| Parâmetro | Descrição |
|---|---|
| --Depurar | Aumenta a verbosidade de 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 lista 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 Guia), tabela (tabelas ASCII legíveis pelo homem) e yaml. Por padrão, a CLI gera table. Para saber mais sobre os formatos de saída disponíveis, confira 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 de comando da CLI do Azure para obter mais informações e exemplos. |
| --Verbose | Imprime informações sobre 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 |
|---|---|---|
| -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 é sensível ao caso. |
Parâmetros opcionais
| Parâmetro | Tipo | Descrição |
|---|---|---|
| -t, --locatário | 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. |
Parâmetros globais
Os seguintes parâmetros globais estão disponíveis para a CLI do Azure Sphere:
| Parâmetro | Descrição |
|---|---|
| --Depurar | Aumenta a verbosidade de 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 lista 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 Guia), tabela (tabelas ASCII legíveis pelo homem) e yaml. Por padrão, a CLI gera table. Para saber mais sobre os formatos de saída disponíveis, confira 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 de comando da CLI do Azure para obter mais informações e exemplos. |
| --Verbose | Imprime informações sobre 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.