az iot central user

Observação

Essa referência faz parte da extensão azure-iot para a CLI do Azure (versão 2.46.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando az iot central user . Saiba mais sobre extensões.

Gerenciar e configurar usuários do IoT Central.

Comandos

Nome	Description	Tipo	Status
az iot central user create	Adicione um usuário ao aplicativo.	Extensão	GA
az iot central user delete	Exclua um usuário do aplicativo.	Extensão	GA
az iot central user list	Obtenha uma lista de usuários para um aplicativo do IoT Central.	Extensão	GA
az iot central user show	Obtenha os detalhes de um usuário por ID.	Extensão	GA
az iot central user update	Atualizar funções para um usuário no aplicativo.	Extensão	GA

az iot central user create

Adicione um usuário ao aplicativo.

az iot central user create --app-id
                           --assignee
                           --role
                           [--api-version {2022-06-30-preview, 2022-07-31}]
                           [--central-api-uri]
                           [--email]
                           [--object-id]
                           [--org-id]
                           [--tenant-id]
                           [--token]

Exemplos

Adicionar um usuário por e-mail ao aplicativo

az iot central user create --user-id {userId} --app-id {appId} --email {emailAddress} --role admin

Adicionar uma entidade de serviço ao aplicativo

az iot central user create --user-id {userId} --app-id {appId} --tenant-id {tenantId} --object-id {objectId} --role operator

Parâmetros Exigidos

--app-id -n

A ID do aplicativo do IoT Central que você deseja gerenciar. Você pode encontrar o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

--assignee --user-id

ID associado ao usuário.

--role -r

A função que será associada a esse token ou usuário. Você pode especificar uma das funções internas ou especificar a ID de função de uma função personalizada. Veja mais em https://aka.ms/iotcentral-customrolesdocs.

Parâmetros Opcionais

--api-version --av

Preterido

O argumento 'api_version' foi preterido e será removido em uma versão futura.

Esse parâmetro de comando foi preterido e será ignorado. Na versão futura, só daremos suporte às APIs do IoT Central da versão mais recente do GA. Se alguma API ainda não for GA, chamaremos a versão de visualização mais recente.

Valores aceitos: 2022-06-30-preview, 2022-07-31

Valor padrão: 2022-07-31

--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Valor padrão: azureiotcentral.com

--email

Endereço de e-mail do usuário a ser adicionado ao aplicativo. Se isso for especificado, os parâmetros da entidade de serviço (tenant_id e object_id) serão ignorados.

--object-id --oid

ID do objeto para a entidade de serviço a ser adicionada ao aplicativo. A ID do locatário também deve ser especificada. Se o e-mail for especificado, isso será ignorado e o usuário não será um usuário principal do serviço, mas um usuário padrão de "e-mail".

--org-id --organization-id

A ID da organização para a atribuição de função de usuário. Disponível apenas para api-versão == 1.1-preview.

--tenant-id --tnid

ID do locatário para a entidade de serviço a ser adicionada ao aplicativo. A ID do objeto também deve ser especificada. Se o e-mail for especificado, isso será ignorado e o usuário não será um usuário principal do serviço, mas um usuário padrão de "e-mail".

--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você poderá especificar um token de usuário válido para autenticar sua solicitação. Você deve especificar o tipo de chave como parte da solicitação. Saiba mais em https://aka.ms/iotcentraldocsapi.

Parâmetros Globais

--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc

Valor padrão: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az iot central user delete

Exclua um usuário do aplicativo.

az iot central user delete --app-id
                           --assignee
                           [--api-version {2022-06-30-preview, 2022-07-31}]
                           [--central-api-uri]
                           [--token]

Exemplos

Excluir um usuário

az iot central user delete --app-id {appid} --user-id {userId}

Parâmetros Exigidos

--app-id -n

A ID do aplicativo do IoT Central que você deseja gerenciar. Você pode encontrar o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

--assignee --user-id

ID associado ao usuário.

Parâmetros Opcionais

--api-version --av

Preterido

O argumento 'api_version' foi preterido e será removido em uma versão futura.

Esse parâmetro de comando foi preterido e será ignorado. Na versão futura, só daremos suporte às APIs do IoT Central da versão mais recente do GA. Se alguma API ainda não for GA, chamaremos a versão de visualização mais recente.

Valores aceitos: 2022-06-30-preview, 2022-07-31

Valor padrão: 2022-07-31

--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Valor padrão: azureiotcentral.com

--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você poderá especificar um token de usuário válido para autenticar sua solicitação. Você deve especificar o tipo de chave como parte da solicitação. Saiba mais em https://aka.ms/iotcentraldocsapi.

Parâmetros Globais

--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc

Valor padrão: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az iot central user list

Obtenha uma lista de usuários para um aplicativo do IoT Central.

az iot central user list --app-id
                         [--api-version {2022-06-30-preview, 2022-07-31}]
                         [--central-api-uri]
                         [--token]

Exemplos

Lista de usuários

az iot central user list --app-id {appid}

Parâmetros Exigidos

--app-id -n

A ID do aplicativo do IoT Central que você deseja gerenciar. Você pode encontrar o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

Parâmetros Opcionais

--api-version --av

Preterido

O argumento 'api_version' foi preterido e será removido em uma versão futura.

Esse parâmetro de comando foi preterido e será ignorado. Na versão futura, só daremos suporte às APIs do IoT Central da versão mais recente do GA. Se alguma API ainda não for GA, chamaremos a versão de visualização mais recente.

Valores aceitos: 2022-06-30-preview, 2022-07-31

Valor padrão: 2022-07-31

--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Valor padrão: azureiotcentral.com

--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você poderá especificar um token de usuário válido para autenticar sua solicitação. Você deve especificar o tipo de chave como parte da solicitação. Saiba mais em https://aka.ms/iotcentraldocsapi.

Parâmetros Globais

--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc

Valor padrão: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az iot central user show

Obtenha os detalhes de um usuário por ID.

az iot central user show --app-id
                         --assignee
                         [--api-version {2022-06-30-preview, 2022-07-31}]
                         [--central-api-uri]
                         [--token]

Exemplos

Obter detalhes do usuário

az iot central user show --app-id {appid} --user-id {userId}

Parâmetros Exigidos

--app-id -n

A ID do aplicativo do IoT Central que você deseja gerenciar. Você pode encontrar o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

--assignee --user-id

ID associado ao usuário.

Parâmetros Opcionais

--api-version --av

Preterido

O argumento 'api_version' foi preterido e será removido em uma versão futura.

Esse parâmetro de comando foi preterido e será ignorado. Na versão futura, só daremos suporte às APIs do IoT Central da versão mais recente do GA. Se alguma API ainda não for GA, chamaremos a versão de visualização mais recente.

Valores aceitos: 2022-06-30-preview, 2022-07-31

Valor padrão: 2022-07-31

--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Valor padrão: azureiotcentral.com

--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você poderá especificar um token de usuário válido para autenticar sua solicitação. Você deve especificar o tipo de chave como parte da solicitação. Saiba mais em https://aka.ms/iotcentraldocsapi.

Parâmetros Globais

--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc

Valor padrão: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az iot central user update

Atualizar funções para um usuário no aplicativo.

Atualize um usuário com funções diferentes. Não é permitido atualizar o tenantId ou objectId para um usuário da entidade de serviço. Não é permitido atualizar o endereço de e-mail de um usuário de e-mail.

az iot central user update --app-id
                           --assignee
                           [--api-version {2022-06-30-preview, 2022-07-31}]
                           [--central-api-uri]
                           [--email]
                           [--object-id]
                           [--roles]
                           [--tenant-id]
                           [--token]

Exemplos

Atualize funções para um usuário por email ou entidade de serviço no aplicativo.

az iot central user update --user-id {userId} --app-id {appId} --roles "org1\admin"

Parâmetros Exigidos

--app-id -n

A ID do aplicativo do IoT Central que você deseja gerenciar. Você pode encontrar o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

--assignee --user-id

ID associado ao usuário.

Parâmetros Opcionais

--api-version --av

Preterido

O argumento 'api_version' foi preterido e será removido em uma versão futura.

Esse parâmetro de comando foi preterido e será ignorado. Na versão futura, só daremos suporte às APIs do IoT Central da versão mais recente do GA. Se alguma API ainda não for GA, chamaremos a versão de visualização mais recente.

Valores aceitos: 2022-06-30-preview, 2022-07-31

Valor padrão: 2022-07-31

--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Valor padrão: azureiotcentral.com

--email

Endereço de e-mail do usuário a ser adicionado ao aplicativo. Se isso for especificado, os parâmetros da entidade de serviço (tenant_id e object_id) serão ignorados.

--object-id --oid

ID do objeto para a entidade de serviço a ser adicionada ao aplicativo. A ID do locatário também deve ser especificada. Se o e-mail for especificado, isso será ignorado e o usuário não será um usuário principal do serviço, mas um usuário padrão de "e-mail".

--roles

Lista separada por vírgulas de funções que serão associadas a esse usuário. Você pode especificar uma das funções internas ou especificar a ID de função de uma função personalizada. Veja mais em https://aka.ms/iotcentral-customrolesdocs. As organizações podem ser especificadas ao lado de funções ao serem executadas com a versão da API == 1.1-preview. Ex.: "organization_id\role".

--tenant-id --tnid

ID do locatário para a entidade de serviço a ser adicionada ao aplicativo. A ID do objeto também deve ser especificada. Se o e-mail for especificado, isso será ignorado e o usuário não será um usuário principal do serviço, mas um usuário padrão de "e-mail".

--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você poderá especificar um token de usuário válido para autenticar sua solicitação. Você deve especificar o tipo de chave como parte da solicitação. Saiba mais em https://aka.ms/iotcentraldocsapi.

Parâmetros Globais

--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc

Valor padrão: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.