az iot central api-token

Note

This reference is part of the azure-iot extension for the Azure CLI (version 2.59.0 or higher). A extensão instalará automaticamente na primeira vez que você executar um comando az iot central api-token. Learn more about extensions.

Gerencie tokens de API para seu aplicativo IoT Central.

O IoT Central permite gerar e gerenciar tokens de API a serem usados para acessar a API do IoT Central. Mais informações sobre APIs podem ser encontradas em https://aka.ms/iotcentraldocsapi.

Comandos

Nome	Description	Tipo	Status
az iot central api-token create	Gere um token de API associado ao seu aplicativo do IoT Central.	Extension	GA
az iot central api-token delete	Exclua um token de API associado ao seu aplicativo IoT Central.	Extension	GA
az iot central api-token list	Obtenha a lista de tokens de API associados ao seu aplicativo IoT Central.	Extension	GA
az iot central api-token show	Obtenha detalhes de um token de API associado ao seu aplicativo IoT Central.	Extension	GA

az iot central api-token create

Gere um token de API associado ao seu aplicativo do IoT Central.

Observação: anote seu token depois de gerado, pois você não poderá recuperá-lo novamente.

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

Exemplos

Adicionar novo token de API

az iot central api-token create --token-id {tokenId} --app-id {appId} --role 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.

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

--tkid --token-id

A ID do IoT Central associada a esse token, [0-9a-zA-Z-] permitido, limite máximo de comprimento para 40. Especifique uma ID que você usará ao modificar ou excluir esse token posteriormente por meio da CLI ou da API.

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

--org-id --organization-id

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

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

Output format.

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 api-token delete

Exclua um token de API associado ao seu aplicativo IoT Central.

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

Exemplos

Excluir um token de API

az iot central api-token delete --app-id {appid} --token-id {tokenId}

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.

--tkid --token-id

A ID do IoT Central associada a esse token, [0-9a-zA-Z-] permitido, limite máximo de comprimento para 40. Especifique uma ID que você usará ao modificar ou excluir esse token posteriormente por meio da CLI ou da API.

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Output format.

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 api-token list

Obtenha a lista de tokens de API associados ao seu aplicativo IoT Central.

As informações na lista contêm informações básicas sobre os tokens no aplicativo e não incluem valores de token.

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

Exemplos

Lista de tokens de API

az iot central api-token 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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Output format.

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 api-token show

Obtenha detalhes de um token de API associado ao seu aplicativo IoT Central.

Liste detalhes, como sua função associada, para um token de API em seu aplicativo do IoT Central.

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

Exemplos

Obter token de API

az iot central api-token show --app-id {appid} --token-id {tokenId}

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.

--tkid --token-id

A ID do IoT Central associada a esse token, [0-9a-zA-Z-] permitido, limite máximo de comprimento para 40. Especifique uma ID que você usará ao modificar ou excluir esse token posteriormente por meio da CLI ou da API.

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Output format.

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