Compartilhar 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 instalará automaticamente a 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 Description Tipo Status
az iot central user create

Adicione um usuário ao aplicativo.

 Extension GA
az iot central user delete

Exclua um usuário do aplicativo.

 Extension GA
az iot central user list

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

 Extension GA
az iot central user show

Obtenha os detalhes de um usuário por ID.

 Extension GA
az iot central user update

Atualize as funções de um usuário no aplicativo.

 Extension GA

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 email 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 a ID do aplicativo na página "Sobre" para seu aplicativo no menu de ajuda.

--assignee --user-id

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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--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ó ofereceremos suporte a APIs do IoT Central da versão mais recente da GA. Se alguma API ainda não for GA, chamaremos a versão prévia mais recente.

Propriedade Valor
Valor padrão: 2022-07-31
Valores aceitos: 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 email 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 email for especificado, isso será ignorado e o usuário não será um usuário da entidade de serviço, mas um usuário padrão de "email".

--org-id --organization-id

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

--tenant-id --tnid

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

--token

Se preferir enviar sua solicitação sem se 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 a verbosidade de log para mostrar todos os logs de depuração.

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

Mostre esta mensagem de ajuda e saia.

--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 aceitos: 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. 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 Exigidos

--app-id -n

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

--assignee --user-id

ID associada ao usuário.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--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ó ofereceremos suporte a APIs do IoT Central da versão mais recente da GA. Se alguma API ainda não for GA, chamaremos a versão prévia mais recente.

Propriedade Valor
Valor padrão: 2022-07-31
Valores aceitos: 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 se 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 a verbosidade de log para mostrar todos os logs de depuração.

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

Mostre esta mensagem de ajuda e saia.

--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 aceitos: 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: False

az iot central user list

Obtenha a lista de usuários de 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 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 a ID do aplicativo na página "Sobre" para seu aplicativo no menu de ajuda.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--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ó ofereceremos suporte a APIs do IoT Central da versão mais recente da GA. Se alguma API ainda não for GA, chamaremos a versão prévia mais recente.

Propriedade Valor
Valor padrão: 2022-07-31
Valores aceitos: 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 se 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 a verbosidade de log para mostrar todos os logs de depuração.

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

Mostre esta mensagem de ajuda e saia.

--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 aceitos: 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. 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 Exigidos

--app-id -n

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

--assignee --user-id

ID associada ao usuário.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--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ó ofereceremos suporte a APIs do IoT Central da versão mais recente da GA. Se alguma API ainda não for GA, chamaremos a versão prévia mais recente.

Propriedade Valor
Valor padrão: 2022-07-31
Valores aceitos: 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 se 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 a verbosidade de log para mostrar todos os logs de depuração.

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

Mostre esta mensagem de ajuda e saia.

--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 aceitos: 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: False

az iot central user update

Atualize as funções de 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 --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 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 a ID do aplicativo na página "Sobre" para seu aplicativo no menu de ajuda.

--assignee --user-id

ID associada ao usuário.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--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ó ofereceremos suporte a APIs do IoT Central da versão mais recente da GA. Se alguma API ainda não for GA, chamaremos a versão prévia mais recente.

Propriedade Valor
Valor padrão: 2022-07-31
Valores aceitos: 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 email 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 email for especificado, isso será ignorado e o usuário não será um usuário da entidade de serviço, mas um usuário padrão de "email".

--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 junto com funções ao executar com a versão de API == 1.1-preview. Por exemplo, "organization_id\role".

--tenant-id --tnid

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

--token

Se preferir enviar sua solicitação sem se 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 a verbosidade de log para mostrar todos os logs de depuração.

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

Mostre esta mensagem de ajuda e saia.

--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 aceitos: 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: False