Compartilhar via

role

  • Artigo

Importante

Esta é a documentação do Azure Sphere (herdado). O Azure Sphere (herdado) 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 as funções do usuário em locatários para RBAC (controle de acesso baseado em função).

Operação descrição
add Adiciona uma função para um usuário.
excluir Remove uma função de usuário.
lista Exibe uma lista de usuários e suas funções.
show Retorna funções atribuídas a uma conta de usuário específica.
show-types Exibe uma lista de funções com suporte para esse locatário.

add

Adiciona uma função a um usuário.

  • Um Administrador tem acesso completo a todos os dispositivos e operações no 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 Colaborador.
  • Um Leitor tem acesso a informações sobre o locatário, incluindo os dispositivos reivindicados, as implantações e, quando disponíveis, todos os dados de relatório de erros dos dispositivos. Essa função é adequada para a equipe de manutenção e de operações que é responsável por acompanhar o desempenho do dispositivo conectado em instalações de usuário final.

Observação

Esse comando registrará automaticamente a conta da Microsoft do usuário no Azure Sphere, se ele ainda não estiver registrado. Anteriormente, o comando register-user era usado para registrar um novo usuário no Azure Sphere; isso agora é feito automaticamente ao adicionar um usuário a uma nova função em um locatário existente, e o comando register-user agora foi preterido.

Parâmetros obrigatórios

Parâmetro Tipo Descrição
-u, --user String Especifica o nome do usuário (endereço de e-mail).
-r, --role 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 Descrição
-t, --inquilino GUID ou nome Especifica o locatário no qual executar essa operação. Substitui o locatário padrão selecionado. 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
--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 sinalizador --debug 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 tabulação), table (tabelas ASCII legíveis por humanos) e yaml. Por padrão, a CLI gera table. Para saber mais sobre os formatos de saída disponíveis, consulte 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 JMESPath e a saída do comando Consultar a 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.

Observação

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

excluir

Remove uma função de um usuário no locatário atual ou selecionado do Azure Sphere.

Parâmetros obrigatórios

Parâmetro Tipo Descrição
-u, --user String Especifica a ID ou o e-mail do usuário para identificar o usuário do qual a função está sendo excluída.
-r, --role Enum 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 Descrição
-t, --inquilino GUID ou nome Especifica o locatário no qual executar essa operação. Substitui o locatário padrão selecionado. Você pode especificar a ID do locatário ou o nome do locatário.

Observação

A função de 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 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 sinalizador --debug 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 tabulação), table (tabelas ASCII legíveis por humanos) e yaml. Por padrão, a CLI gera table. Para saber mais sobre os formatos de saída disponíveis, consulte 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 JMESPath e a saída do comando Consultar a 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.

Observação

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

lista

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 Descrição
-t, --inquilino GUID ou nome Especifica o locatário no qual executar essa operação. Substitui o locatário padrão selecionado. 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
--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 sinalizador --debug 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 tabulação), table (tabelas ASCII legíveis por humanos) e yaml. Por padrão, a CLI gera table. Para saber mais sobre os formatos de saída disponíveis, consulte 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 JMESPath e a saída do comando Consultar a 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.

Observação

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
 --------------------- -------------

show

Exibe as informações da função para um usuário selecionado.

Parâmetros obrigatórios

Parâmetro Tipo Descrição
-u, --user String O nome de usuário a ser exibido (endereço de email).

Parâmetros opcionais

Parâmetro Tipo Descrição
-t, --inquilino GUID ou nome Especifica o locatário no qual executar essa operação. Substitui o locatário padrão selecionado. 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
--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 sinalizador --debug 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 tabulação), table (tabelas ASCII legíveis por humanos) e yaml. Por padrão, a CLI gera table. Para saber mais sobre os formatos de saída disponíveis, consulte 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 JMESPath e a saída do comando Consultar a 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.

Observação

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
 -------------

show-types

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 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 sinalizador --debug 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 tabulação), table (tabelas ASCII legíveis por humanos) e yaml. Por padrão, a CLI gera table. Para saber mais sobre os formatos de saída disponíveis, consulte 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 JMESPath e a saída do comando Consultar a 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.

Observação

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
 -------------