Partilhar via

az iot central user

Note

Essa referência faz parte da extensão azure-iot para a CLI do Azure (versão 2.67.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.

Gerencie e configure usuários do IoT Central.

Comandos

Nome Descrição Tipo Estado
az iot central user create

Adicione um usuário ao aplicativo.

 Extension disponibilidade geral
az iot central user delete

Exclua um usuário do aplicativo.

 Extension disponibilidade geral
az iot central user list

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

 Extension disponibilidade geral
az iot central user show

Obtenha os detalhes de um usuário por ID.

 Extension disponibilidade geral
az iot central user update

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

 Extension disponibilidade geral

az iot central user create

Adicione um usuário ao aplicativo.

az iot central user create --app-id
                           --assignee --user-id
                           --role
                           [--api-version --av {2022-06-30-preview, 2022-07-31}]
                           [--central-api-uri --central-dns-suffix]
                           [--email]
                           [--object-id --oid]
                           [--org-id --organization-id]
                           [--tenant-id --tnid]
                           [--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 Obrigatórios

--app-id -n

A ID do aplicativo 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 utilizador.

--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 da função de uma função personalizada. Veja mais em https://aka.ms/iotcentral-customrolesdocs.

Parâmetros Opcionais

Os parâmetros seguintes são opcionais, mas dependendo do contexto, podem ser necessários um ou mais para que o comando seja executado com sucesso.

--api-version --av
Descontinuado

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

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

Propriedade Valor
Valor padrão: 2022-07-31
Valores aceites: 2022-06-30-preview, 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Propriedade Valor
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. O ID do locatário também deve ser especificado. 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ê pode 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 a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az iot central user delete

Exclua um usuário do aplicativo.

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

Exemplos

Excluir um usuário

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

Parâmetros Obrigatórios

--app-id -n

A ID do aplicativo 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 utilizador.

Parâmetros Opcionais

Os parâmetros seguintes são opcionais, mas dependendo do contexto, podem ser necessários um ou mais para que o comando seja executado com sucesso.

--api-version --av
Descontinuado

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

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

Propriedade Valor
Valor padrão: 2022-07-31
Valores aceites: 2022-06-30-preview, 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Propriedade Valor
Valor padrão: azureiotcentral.com
--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você pode 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 a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

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 --av {2022-06-30-preview, 2022-07-31}]
                         [--central-api-uri --central-dns-suffix]
                         [--token]

Exemplos

Lista de utilizadores

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

Parâmetros Obrigatórios

--app-id -n

A ID do aplicativo 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

Os parâmetros seguintes são opcionais, mas dependendo do contexto, podem ser necessários um ou mais para que o comando seja executado com sucesso.

--api-version --av
Descontinuado

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

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

Propriedade Valor
Valor padrão: 2022-07-31
Valores aceites: 2022-06-30-preview, 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Propriedade Valor
Valor padrão: azureiotcentral.com
--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você pode 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 a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az iot central user show

Obtenha os detalhes de um usuário por ID.

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

Exemplos

Obter detalhes do usuário

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

Parâmetros Obrigatórios

--app-id -n

A ID do aplicativo 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 utilizador.

Parâmetros Opcionais

Os parâmetros seguintes são opcionais, mas dependendo do contexto, podem ser necessários um ou mais para que o comando seja executado com sucesso.

--api-version --av
Descontinuado

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

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

Propriedade Valor
Valor padrão: 2022-07-31
Valores aceites: 2022-06-30-preview, 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Propriedade Valor
Valor padrão: azureiotcentral.com
--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você pode 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 a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

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 principal 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 --user-id
                           [--api-version --av {2022-06-30-preview, 2022-07-31}]
                           [--central-api-uri --central-dns-suffix]
                           [--email]
                           [--object-id --oid]
                           [--roles]
                           [--tenant-id --tnid]
                           [--token]

Exemplos

Atualize as funções de um usuário por e-mail ou entidade de serviço no aplicativo.

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

Parâmetros Obrigatórios

--app-id -n

A ID do aplicativo 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 utilizador.

Parâmetros Opcionais

Os parâmetros seguintes são opcionais, mas dependendo do contexto, podem ser necessários um ou mais para que o comando seja executado com sucesso.

--api-version --av
Descontinuado

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

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

Propriedade Valor
Valor padrão: 2022-07-31
Valores aceites: 2022-06-30-preview, 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Propriedade Valor
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. O ID do locatário também deve ser especificado. 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 este usuário. Você pode especificar uma das funções internas ou especificar a ID da 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 executar com a versão da API == 1.1-preview. Por exemplo, "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ê pode 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 a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False