função
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 funções de usuário em locatários para controle de acesso baseado em função (RBAC).
| Operation | descrição |
|---|---|
| adicionar | Adiciona uma função para um usuário. |
| eliminar | Remove uma função de usuário. |
| list | Exibe uma lista de usuários e suas funções. |
| programa | Retorna funções atribuídas a uma conta de usuário específica. |
| Tipos de exibição | Exibe uma lista de funções suportadas para este locatário. |
adicionar
Adiciona uma função a um usuário.
- Um Administrador tem acesso total a todos os dispositivos e operações dentro do locatário, incluindo a permissão para adicionar ou excluir outros usuários. A função Administrador é atribuída por padrão ao usuário que cria o locatário.
- Um Colaborador pode adicionar dispositivos e criar e alterar implantações. Os desenvolvedores de software e hardware que criam aplicativos, gerenciam dispositivos conectados e atualizam implantações, mas não são responsáveis por gerenciar o acesso do locatário, devem ter a função de Colaborador.
- Um leitor tem acesso a informações sobre o locatário, incluindo os dispositivos reivindicados, implantações e, quando disponíveis, quaisquer dados de relatório de erros dos dispositivos. Essa função é apropriada para o pessoal de manutenção e operações que é responsável por rastrear o desempenho do dispositivo conectado nas instalações do usuário final.
Nota
Este comando registará automaticamente a conta Microsoft do utilizador no Azure Sphere, se ainda não estiver registado. Anteriormente, o comando register-user era usado para registrar um novo usuário no Azure Sphere, agora isso é feito automaticamente ao adicionar um usuário a uma nova função dentro de um locatário existente, e o comando register-user agora foi preterido.
Parâmetros obrigatórios
| Parâmetro | Tipo | Description |
|---|---|---|
| -u, --utilizador | String | Especifica o nome do usuário (endereço de e-mail). |
| -r, --papel | String | Especifica a função a ser atribuída ao usuário selecionado. As funções possíveis são: Administrador, Colaborador e Leitor. |
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 role add --user john@contoso.com --role Administrator
delete
Remove uma função de um usuário no locatário atual ou selecionado do Azure Sphere.
Parâmetros obrigatórios
| Parâmetro | Tipo | Description |
|---|---|---|
| -u, --utilizador | String | Especifica o ID ou email do usuário para identificar o usuário do qual a função está sendo excluída. |
| -r, --papel | Enumeração | Especifica a função a ser excluída. As funções possíveis são: Administrador, Colaborador e Leitor. |
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. |
Nota
A função Administrador do usuário atual só pode ser excluída por outro administrador.
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 role delete --user bob@contoso.com --role contributor --tenant 143adbc9-1bf0-4be2-84a2-084a331d81cb
list
Exibe uma lista de funções de usuário no locatário atual ou selecionado.
A lista será truncada após as primeiras 500 entradas.
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 role list --tenant 143adbc9-1bf0-4be2-84a2-084a331d81cb
--------------------- -------------
Name Roles
===================================
bob@contoso.com Administrator
Contributor
--------------------- -------------
mostrar
Exibe informações de função para um usuário selecionado.
Parâmetros obrigatórios
| Parâmetro | Tipo | Description |
|---|---|---|
| -u, --utilizador | String | Nome de usuário a ser exibido (endereço de e-mail). |
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 role show --user john@contoso.com --tenant 143adbc9-1bf0-4be2-84a2-084a331d81cb
-------------
Roles
=============
Administrator
Contributor
-------------
Tipos de exibição
Exibe funções que podem ser atribuídas neste 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 role show-types
-------------
Result
=============
Administrator
-------------
Contributor
-------------
Reader
-------------