Compartir a través de

az iot central api-token

Note

Esta referencia forma parte de la extensión azure-iot para la CLI de Azure (versión 2.67.0 o posterior). La extensión se instalará automáticamente la primera vez que ejecute un comando az iot central api-token. Obtenga más información sobre las extensiones.

Administrar tokens de API para la aplicación de IoT Central.

IoT Central permite generar y administrar tokens de API que se usarán para acceder a la API de IoT Central. Puede encontrar más información sobre las API en https://aka.ms/iotcentraldocsapi.

Comandos

Nombre Description Tipo Estado
az iot central api-token create

Genere un token de API asociado a la aplicación de IoT Central.

 Extension GA
az iot central api-token delete

Elimine un token de API asociado a la aplicación de IoT Central.

 Extension GA
az iot central api-token list

Obtenga la lista de tokens de API asociados a la aplicación de IoT Central.

 Extension GA
az iot central api-token show

Obtenga detalles de un token de API asociado a la aplicación de IoT Central.

 Extension GA

az iot central api-token create

Genere un token de API asociado a la aplicación de IoT Central.

Nota: Anote el token una vez que se haya generado, ya que no podrá recuperarlo de nuevo.

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]

Ejemplos

Adición de un nuevo token de API

az iot central api-token create --token-id {tokenId} --app-id {appId} --role admin

Parámetros requeridos

--app-id -n

El identificador de aplicación de la aplicación de IoT Central que quiere administrar. Puede encontrar el identificador de aplicación en la página "Acerca de" de la aplicación en el menú de ayuda.

--role -r

Rol que se asociará a este token o usuario. Puede especificar uno de los roles integrados o especificar el identificador de rol de un rol personalizado. Vea más en https://aka.ms/iotcentral-customrolesdocs.

--tkid --token-id

El identificador de IoT Central asociado a este token, [0-9a-zA-Z-] permitido, límite máximo de longitud a 40. Especifique un identificador que usará al modificar o eliminar este token más adelante a través de la CLI o la API.

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--api-version --av
Obsoleto

El argumento "api_version" está en desuso y se quitará en una versión futura.

Este parámetro de comando está en desuso y se omitirá. En la versión futura, solo se admitirán las API de IoT Central desde la versión más reciente de disponibilidad general. Si alguna API aún no está disponible, llamaremos a la versión preliminar más reciente.

Propiedad Valor
Valor predeterminado: 2022-07-31
Valores aceptados: 2022-06-30-preview, 2022-07-31
--central-api-uri --central-dns-suffix

Sufijo DNS de IoT Central asociado a la aplicación.

Propiedad Valor
Valor predeterminado: azureiotcentral.com
--org-id --organization-id

Identificador de la organización para la asignación de roles de token. Solo está disponible para api-version == 1.1-preview.

--token

Si prefiere enviar la solicitud sin autenticarse en la CLI de Azure, puede especificar un token de usuario válido para autenticar la solicitud. Debe especificar el tipo de clave como parte de la solicitud. Obtenga más información en https://aka.ms/iotcentraldocsapi.

Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Formato de salida.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az iot central api-token delete

Elimine un token de API asociado a la aplicación de 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]

Ejemplos

Eliminación de un token de API

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

Parámetros requeridos

--app-id -n

El identificador de aplicación de la aplicación de IoT Central que quiere administrar. Puede encontrar el identificador de aplicación en la página "Acerca de" de la aplicación en el menú de ayuda.

--tkid --token-id

El identificador de IoT Central asociado a este token, [0-9a-zA-Z-] permitido, límite máximo de longitud a 40. Especifique un identificador que usará al modificar o eliminar este token más adelante a través de la CLI o la API.

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--api-version --av
Obsoleto

El argumento "api_version" está en desuso y se quitará en una versión futura.

Este parámetro de comando está en desuso y se omitirá. En la versión futura, solo se admitirán las API de IoT Central desde la versión más reciente de disponibilidad general. Si alguna API aún no está disponible, llamaremos a la versión preliminar más reciente.

Propiedad Valor
Valor predeterminado: 2022-07-31
Valores aceptados: 2022-06-30-preview, 2022-07-31
--central-api-uri --central-dns-suffix

Sufijo DNS de IoT Central asociado a la aplicación.

Propiedad Valor
Valor predeterminado: azureiotcentral.com
--token

Si prefiere enviar la solicitud sin autenticarse en la CLI de Azure, puede especificar un token de usuario válido para autenticar la solicitud. Debe especificar el tipo de clave como parte de la solicitud. Obtenga más información en https://aka.ms/iotcentraldocsapi.

Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Formato de salida.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az iot central api-token list

Obtenga la lista de tokens de API asociados a la aplicación de IoT Central.

La información de la lista contiene información básica sobre los tokens de la aplicación y no incluye 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]

Ejemplos

Lista de tokens de API

az iot central api-token list --app-id {appid}

Parámetros requeridos

--app-id -n

El identificador de aplicación de la aplicación de IoT Central que quiere administrar. Puede encontrar el identificador de aplicación en la página "Acerca de" de la aplicación en el menú de ayuda.

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--api-version --av
Obsoleto

El argumento "api_version" está en desuso y se quitará en una versión futura.

Este parámetro de comando está en desuso y se omitirá. En la versión futura, solo se admitirán las API de IoT Central desde la versión más reciente de disponibilidad general. Si alguna API aún no está disponible, llamaremos a la versión preliminar más reciente.

Propiedad Valor
Valor predeterminado: 2022-07-31
Valores aceptados: 2022-06-30-preview, 2022-07-31
--central-api-uri --central-dns-suffix

Sufijo DNS de IoT Central asociado a la aplicación.

Propiedad Valor
Valor predeterminado: azureiotcentral.com
--token

Si prefiere enviar la solicitud sin autenticarse en la CLI de Azure, puede especificar un token de usuario válido para autenticar la solicitud. Debe especificar el tipo de clave como parte de la solicitud. Obtenga más información en https://aka.ms/iotcentraldocsapi.

Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Formato de salida.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az iot central api-token show

Obtenga detalles de un token de API asociado a la aplicación de IoT Central.

Enumere los detalles, como su rol asociado, para un token de API en la aplicación de 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]

Ejemplos

Obtención del token de API

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

Parámetros requeridos

--app-id -n

El identificador de aplicación de la aplicación de IoT Central que quiere administrar. Puede encontrar el identificador de aplicación en la página "Acerca de" de la aplicación en el menú de ayuda.

--tkid --token-id

El identificador de IoT Central asociado a este token, [0-9a-zA-Z-] permitido, límite máximo de longitud a 40. Especifique un identificador que usará al modificar o eliminar este token más adelante a través de la CLI o la API.

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--api-version --av
Obsoleto

El argumento "api_version" está en desuso y se quitará en una versión futura.

Este parámetro de comando está en desuso y se omitirá. En la versión futura, solo se admitirán las API de IoT Central desde la versión más reciente de disponibilidad general. Si alguna API aún no está disponible, llamaremos a la versión preliminar más reciente.

Propiedad Valor
Valor predeterminado: 2022-07-31
Valores aceptados: 2022-06-30-preview, 2022-07-31
--central-api-uri --central-dns-suffix

Sufijo DNS de IoT Central asociado a la aplicación.

Propiedad Valor
Valor predeterminado: azureiotcentral.com
--token

Si prefiere enviar la solicitud sin autenticarse en la CLI de Azure, puede especificar un token de usuario válido para autenticar la solicitud. Debe especificar el tipo de clave como parte de la solicitud. Obtenga más información en https://aka.ms/iotcentraldocsapi.

Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Formato de salida.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False