az iot central user

Nota:

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

Administrar y configurar usuarios de IoT Central.

Comandos

Nombre	Description	Tipo	Estado
az iot central user create	Agregue un usuario a la aplicación.	Extensión	GA
az iot central user delete	Elimine un usuario de la aplicación.	Extensión	GA
az iot central user list	Obtenga la lista de usuarios de una aplicación de IoT Central.	Extensión	GA
az iot central user show	Obtenga los detalles de un usuario por identificador.	Extensión	GA
az iot central user update	Actualice los roles de un usuario de la aplicación.	Extensión	GA

az iot central user create

Agregue un usuario a la aplicación.

az iot central user create --app-id
                           --assignee
                           --role
                           [--api-version {2022-06-30-preview, 2022-07-31}]
                           [--central-api-uri]
                           [--email]
                           [--object-id]
                           [--org-id]
                           [--tenant-id]
                           [--token]

Ejemplos

Adición de un usuario por correo electrónico a la aplicación

az iot central user create --user-id {userId} --app-id {appId} --email {emailAddress} --role admin

Adición de una entidad de servicio a la aplicación

az iot central user create --user-id {userId} --app-id {appId} --tenant-id {tenantId} --object-id {objectId} --role operator

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.

--assignee --user-id

Identificador asociado al usuario.

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

Parámetros opcionales

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

valores aceptados: 2022-06-30-preview, 2022-07-31

valor predeterminado: 2022-07-31

--central-api-uri --central-dns-suffix

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

valor predeterminado: azureiotcentral.com

--email

Dirección de correo electrónico del usuario que se va a agregar a la aplicación. Si se especifica esto, se omitirán los parámetros de la entidad de servicio (tenant_id y object_id).

--object-id --oid

Id. de objeto de la entidad de servicio que se va a agregar a la aplicación. También se debe especificar el identificador de inquilino. Si se especifica el correo electrónico, se omite y el usuario no será un usuario de entidad de servicio, sino un usuario estándar de "correo electrónico".

--org-id --organization-id

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

--tenant-id --tnid

Identificador de inquilino de la entidad de servicio que se va a agregar a la aplicación. También se debe especificar el identificador de objeto. Si se especifica el correo electrónico, se omite y el usuario no será un usuario de entidad de servicio, sino un usuario estándar de "correo electrónico".

--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 de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc

valor predeterminado: json

--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--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 de registro. Use --debug para obtener registros de depuración completos.

az iot central user delete

Elimine un usuario de la aplicación.

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

Ejemplos

Eliminar un usuario

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

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.

--assignee --user-id

Identificador asociado al usuario.

Parámetros opcionales

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

valores aceptados: 2022-06-30-preview, 2022-07-31

valor predeterminado: 2022-07-31

--central-api-uri --central-dns-suffix

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

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 de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc

valor predeterminado: json

--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--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 de registro. Use --debug para obtener registros de depuración completos.

az iot central user list

Obtenga la lista de usuarios de una aplicación de IoT Central.

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

Ejemplos

Lista de usuarios

az iot central user 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

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

valores aceptados: 2022-06-30-preview, 2022-07-31

valor predeterminado: 2022-07-31

--central-api-uri --central-dns-suffix

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

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 de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc

valor predeterminado: json

--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--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 de registro. Use --debug para obtener registros de depuración completos.

az iot central user show

Obtenga los detalles de un usuario por identificador.

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

Ejemplos

Obtención de detalles del usuario

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

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.

--assignee --user-id

Identificador asociado al usuario.

Parámetros opcionales

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

valores aceptados: 2022-06-30-preview, 2022-07-31

valor predeterminado: 2022-07-31

--central-api-uri --central-dns-suffix

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

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 de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc

valor predeterminado: json

--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--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 de registro. Use --debug para obtener registros de depuración completos.

az iot central user update

Actualice los roles de un usuario de la aplicación.

Actualice un usuario con otros roles. No se permite actualizar tenantId o objectId para un usuario de entidad de servicio. No se permite actualizar la dirección de correo electrónico de un usuario de correo electrónico.

az iot central user update --app-id
                           --assignee
                           [--api-version {2022-06-30-preview, 2022-07-31}]
                           [--central-api-uri]
                           [--email]
                           [--object-id]
                           [--roles]
                           [--tenant-id]
                           [--token]

Ejemplos

Actualice los roles de un usuario por correo electrónico o entidad de servicio en la aplicación.

az iot central user update --user-id {userId} --app-id {appId} --roles "org1\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.

--assignee --user-id

Identificador asociado al usuario.

Parámetros opcionales

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

valores aceptados: 2022-06-30-preview, 2022-07-31

valor predeterminado: 2022-07-31

--central-api-uri --central-dns-suffix

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

valor predeterminado: azureiotcentral.com

--email

Dirección de correo electrónico del usuario que se va a agregar a la aplicación. Si se especifica esto, se omitirán los parámetros de la entidad de servicio (tenant_id y object_id).

--object-id --oid

Id. de objeto de la entidad de servicio que se va a agregar a la aplicación. También se debe especificar el identificador de inquilino. Si se especifica el correo electrónico, se omite y el usuario no será un usuario de entidad de servicio, sino un usuario estándar de "correo electrónico".

--roles

Lista separada por comas de roles que se asociarán a este 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. Las organizaciones se pueden especificar junto con roles al ejecutar con la versión de API == 1.1-preview. Por ejemplo, "organization_id\role".

--tenant-id --tnid

Identificador de inquilino de la entidad de servicio que se va a agregar a la aplicación. También se debe especificar el identificador de objeto. Si se especifica el correo electrónico, se omite y el usuario no será un usuario de entidad de servicio, sino un usuario estándar de "correo electrónico".

--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 de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc

valor predeterminado: json

--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--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 de registro. Use --debug para obtener registros de depuración completos.