Compartilhar via

az iot central role

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 na primeira vez que você executar um comando az iot central role. Saiba mais sobre extensões.

Gerencie e configure funções para um aplicativo do IoT Central.

Comandos

Nome Description Tipo Status
az iot central role list

Obtenha a lista de funções para um aplicativo do IoT Central.

 Extension GA
az iot central role show

Obtenha os detalhes de uma função por ID.

 Extension GA

az iot central role list

Obtenha a lista de funções para um aplicativo do IoT Central.

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

Exemplos

Listar funções em um aplicativo

az iot central role 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 role show

Obtenha os detalhes de uma função por ID.

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

Exemplos

Obter detalhes da função

az iot central role show --app-id {appid} --role-id {roleId}

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.

--role-id -r

Identificador exclusivo para a função.

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