az iot hub device-identity

Nota

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

Administre los dispositivos IoT.

Comandos

az iot hub device-identity children

Administrar relaciones de dispositivos secundarios para dispositivos IoT Edge.

az iot hub device-identity children add

Agregue dispositivos como elementos secundarios a un dispositivo perimetral de destino.

az iot hub device-identity children list

Genera la colección de dispositivos secundarios asignados.

az iot hub device-identity children remove

Quite los dispositivos secundarios de un dispositivo perimetral de destino.

az iot hub device-identity connection-string

Administrar la cadena de conexión del dispositivo IoT.

az iot hub device-identity connection-string show

Muestra una cadena de conexión de dispositivo IoT Hub determinada.

az iot hub device-identity create

Cree un dispositivo en un IoT Hub.

az iot hub device-identity delete

Elimine un dispositivo IoT Hub.

az iot hub device-identity export

Exporte todas las identidades de dispositivo de un IoT Hub a un contenedor de blobs de Azure Storage. Para la entrada de URI de SAS del contenedor de blobs en línea, revise las reglas de entrada de su entorno.

az iot hub device-identity import

Importe identidades de dispositivo a un IoT Hub desde un blob. Para la entrada de URI de SAS del contenedor de blobs en línea, revise las reglas de entrada de su entorno.

az iot hub device-identity list

Enumere los dispositivos de un IoT Hub.

az iot hub device-identity parent

Administrar relaciones de dispositivos primarios para dispositivos IoT.

az iot hub device-identity parent set

Establezca el dispositivo primario de un dispositivo de destino.

az iot hub device-identity parent show

Obtenga el dispositivo primario de un dispositivo de destino.

az iot hub device-identity renew-key

Renueve las claves de destino de un dispositivo IoT Hub con autenticación sas.

az iot hub device-identity show

Obtenga los detalles de un dispositivo IoT Hub.

az iot hub device-identity update

Actualice un dispositivo IoT Hub.

az iot hub device-identity create

Cree un dispositivo en un IoT Hub.

Al usar el método de autenticación de shared_private_key (también conocido como claves simétricas), si no se proporciona ninguna clave personalizada, el servicio los generará para el dispositivo.

Si se proporciona un ámbito de dispositivo para un dispositivo perimetral, el valor se convertirá automáticamente en un ámbito primario.

az iot hub device-identity create --device-id
                                  [--am {shared_private_key, x509_ca, x509_thumbprint}]
                                  [--auth-type {key, login}]
                                  [--device-scope]
                                  [--edge-enabled {false, true}]
                                  [--hub-name]
                                  [--login]
                                  [--od]
                                  [--pk]
                                  [--primary-thumbprint]
                                  [--resource-group]
                                  [--secondary-key]
                                  [--secondary-thumbprint]
                                  [--sta {disabled, enabled}]
                                  [--star]
                                  [--valid-days]

Ejemplos

Cree un dispositivo IoT habilitado para Edge con autorización predeterminada (clave privada compartida).

az iot hub device-identity create -n {iothub_name} -d {device_id} --ee

Cree un dispositivo IoT con autorización de certificado autofirmado, genere un certificado válido durante 10 días y, a continuación, use su huella digital.

az iot hub device-identity create -n {iothub_name} -d {device_id} --am x509_thumbprint --valid-days 10

Cree un dispositivo IoT con autorización de certificado autofirmado, genere un certificado de expiración predeterminada (365 días) y la salida al directorio de destino.

az iot hub device-identity create -n {iothub_name} -d {device_id} --am x509_thumbprint --output-dir /path/to/output

Cree un dispositivo IoT con autorización de certificado autofirmado y proporcione explícitamente huellas digitales principales y secundarias.

az iot hub device-identity create -n {iothub_name} -d {device_id} --am x509_thumbprint --ptp {thumbprint_1} --stp {thumbprint_2}

Cree un dispositivo IoT con autorización de entidad de certificación raíz con el estado y el motivo deshabilitados.

az iot hub device-identity create -n {iothub_name} -d {device_id} --am x509_ca --status disabled --status-reason 'for reasons'

Cree un dispositivo IoT con un ámbito de dispositivo.

az iot hub device-identity create -n {iothub_name} -d {device_id} --device-scope 'ms-azure-iot-edge://edge0-123456789123456789'

Parámetros requeridos

--device-id -d

Dispositivo de destino.

Parámetros opcionales

--am --auth-method

El método de autorización con el que se va a crear una entidad.

valores aceptados: shared_private_key, x509_ca, x509_thumbprint
valor predeterminado: shared_private_key
--auth-type

Indica si la operación debe derivar automáticamente una clave de directiva o usar la sesión de Azure AD actual. Puede configurar el valor predeterminado mediante az configure --defaults iothub-data-auth-type=<auth-type-value>.

valores aceptados: key, login
valor predeterminado: key
--device-scope

El ámbito del dispositivo. En el caso de los dispositivos perimetrales, esto se genera automáticamente e inmutable. En el caso de los dispositivos hoja, establezca esta opción para crear una relación secundaria o primaria.

--edge-enabled --ee

Marca que indica la habilitación perimetral.

valores aceptados: false, true
--hub-name -n

IoT Hub nombre. Obligatorio si no se proporciona --login.

--login -l

Este comando admite una cadena de conexión de entidad con derechos para realizar la acción. Use para evitar el inicio de sesión de sesión a través de "az login". Si se proporciona una cadena de conexión de entidad y un nombre, la cadena de conexión tiene prioridad. Obligatorio si no se proporciona --hub-name.

--od --output-dir

Genere un certificado autofirmado y use su huella digital. Salida al directorio de destino especificado.

--pk --primary-key

Clave de acceso compartido simétrica principal almacenada en formato base64.

--primary-thumbprint --ptp

Huella digital de certificado autofirmado que se va a usar para la huella digital principal.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--secondary-key --sk

Clave de acceso compartido simétrica secundaria almacenada en formato base64.

--secondary-thumbprint --stp

Huella digital de certificado autofirmado que se va a usar para la huella digital secundaria.

--sta --status

Establezca el estado del dispositivo tras la creación.

valores aceptados: disabled, enabled
valor predeterminado: enabled
--star --status-reason

Descripción del estado del dispositivo.

--valid-days --vd

Genere un certificado autofirmado y use su huella digital. Válido para el número de días especificado. Valor predeterminado: 365.

az iot hub device-identity delete

Elimine un dispositivo IoT Hub.

az iot hub device-identity delete --device-id
                                  [--auth-type {key, login}]
                                  [--etag]
                                  [--hub-name]
                                  [--login]
                                  [--resource-group]

Parámetros requeridos

--device-id -d

Dispositivo de destino.

Parámetros opcionales

--auth-type

Indica si la operación debe derivar automáticamente una clave de directiva o usar la sesión de Azure AD actual. Puede configurar el valor predeterminado mediante az configure --defaults iothub-data-auth-type=<auth-type-value>.

valores aceptados: key, login
valor predeterminado: key
--etag -e

Etag o etiqueta de entidad correspondiente al último estado del recurso. Si no se proporciona ninguna etag, se usa el valor '*'.

--hub-name -n

IoT Hub nombre. Obligatorio si no se proporciona --login.

--login -l

Este comando admite una cadena de conexión de entidad con derechos para realizar la acción. Use para evitar el inicio de sesión de sesión a través de "az login". Si se proporciona una cadena de conexión de entidad y un nombre, la cadena de conexión tiene prioridad. Obligatorio si no se proporciona --hub-name.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

az iot hub device-identity export

Exporte todas las identidades de dispositivo de un IoT Hub a un contenedor de blobs de Azure Storage. Para la entrada de URI de SAS del contenedor de blobs en línea, revise las reglas de entrada de su entorno.

Para obtener más información, vea https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

az iot hub device-identity export --bcu
                                  --hub-name
                                  [--auth-type {identity, key}]
                                  [--identity]
                                  [--ik {false, true}]
                                  [--resource-group]

Ejemplos

Exporte todas las identidades de dispositivo a un contenedor de blobs configurado e incluya claves de dispositivo. Usa un ejemplo de URI saS insertado.

az iot hub device-identity export -n {iothub_name} --ik --bcu 'https://mystorageaccount.blob.core.windows.net/devices?sv=2019-02-02&st=2020-08-23T22%3A35%3A00Z&se=2020-08-24T22%3A35%3A00Z&sr=c&sp=rwd&sig=VrmJ5sQtW3kLzYg10VqmALGCp4vtYKSLNjZDDJBSh9s%3D'

Exporte todas las identidades de dispositivo a un contenedor de blobs configurado mediante una ruta de acceso de archivo que contiene el URI de SAS.

az iot hub device-identity export -n {iothub_name} --bcu {sas_uri_filepath}

Exporte todas las identidades de dispositivo a un contenedor de blobs configurado e incluya claves de dispositivo. Usa la identidad asignada por el sistema que tiene Storage roles de colaborador de datos de blobs para la cuenta de almacenamiento. El URI del contenedor de blobs no necesita el token de SAS de blob.

az iot hub device-identity export -n {iothub_name} --ik --bcu 'https://mystorageaccount.blob.core.windows.net/devices' --auth-type identity --identity [system]

Exporte todas las identidades de dispositivo a un contenedor de blobs configurado e incluya claves de dispositivo. Usa la identidad administrada asignada por el usuario que tiene Storage roles de colaborador de datos de blobs para la cuenta de almacenamiento y el colaborador del centro de IoT. El URI del contenedor de blobs no necesita el token de SAS de blob.

az iot hub device-identity export -n {iothub_name} --ik --bcu 'https://mystorageaccount.blob.core.windows.net/devices' --auth-type identity --identity {managed_identity_resource_id}

Parámetros requeridos

--bcu --blob-container-uri

URI de firma de acceso compartido de blobs con acceso de escritura, lectura y eliminación a un contenedor de blobs. Se usa para generar el estado del trabajo y los resultados. Nota: cuando se usa la autenticación basada en identidades, todavía se requiere un URI de https://, pero no es necesario ningún token de SAS. La entrada de este argumento puede estar insertada o desde una ruta de acceso de archivo.

--hub-name -n

IoT Hub nombre. Obligatorio si no se proporciona --login.

Parámetros opcionales

--auth-type --storage-authentication-type

Tipo de autenticación para comunicarse con el contenedor de almacenamiento.

valores aceptados: identity, key
--identity

Tipo de identidad administrada para determinar si se usa la identidad administrada asignada por el sistema o la identidad administrada asignada por el usuario. En el caso de la identidad administrada asignada por el sistema, use [system]. En el caso de la identidad administrada asignada por el usuario, proporcione el identificador de recurso de identidad administrada asignada por el usuario. Esta identidad requiere un rol de colaborador de datos de blobs Storage para la cuenta de Storage.

--ik --include-keys

Si se establece, las claves se exportan normalmente. De lo contrario, las claves se establecen en NULL en la salida de exportación.

valores aceptados: false, true
--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

az iot hub device-identity import

Importe identidades de dispositivo a un IoT Hub desde un blob. Para la entrada de URI de SAS del contenedor de blobs en línea, revise las reglas de entrada de su entorno.

Para obtener más información, vea https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

az iot hub device-identity import --hub-name
                                  --ibcu
                                  --obcu
                                  [--auth-type {identity, key}]
                                  [--identity]
                                  [--resource-group]

Ejemplos

Importe todas las identidades de dispositivo desde un blob mediante un URI saS insertado.

az iot hub device-identity import -n {iothub_name} --ibcu {input_sas_uri} --obcu {output_sas_uri}

Importe todas las identidades de dispositivo desde un blob mediante una ruta de acceso de archivo que contenga el URI de SAS.

az iot hub device-identity import -n {iothub_name} --ibcu {input_sas_uri_filepath} --obcu {output_sas_uri_filepath}

Importe todas las identidades de dispositivo de un blob mediante una identidad asignada por el sistema que tenga Storage roles de colaborador de datos de blobs para ambas cuentas de almacenamiento. El URI del contenedor de blobs no necesita el token de SAS de blob.

az iot hub device-identity import -n {iothub_name} --ibcu {input_sas_uri} --obcu {output_sas_uri} --auth-type identity --identity [system]

Importe todas las identidades de dispositivo de un blob mediante una identidad administrada asignada por el usuario que tenga Storage roles de colaborador de datos de blobs para cuentas de almacenamiento y colaborador para IoT Hub. El URI del contenedor de blobs no necesita el token de SAS de blob.

az iot hub device-identity import -n {iothub_name} --ibcu {input_sas_uri} --obcu {output_sas_uri} --auth-type identity --identity {managed_identity_resource_id}

Parámetros requeridos

--hub-name -n

IoT Hub nombre. Obligatorio si no se proporciona --login.

--ibcu --input-blob-container-uri

URI de firma de acceso compartido de blobs con acceso de lectura a un contenedor de blobs. Este blob contiene las operaciones que se van a realizar en el registro de identidades. Nota: cuando se usa la autenticación basada en identidades, todavía se requiere un URI de https://, pero no es necesario ningún token de SAS. La entrada de este argumento puede estar insertada o desde una ruta de acceso de archivo.

--obcu --output-blob-container-uri

URI de firma de acceso compartido de blobs con acceso de escritura a un contenedor de blobs. Se usa para generar el estado del trabajo y los resultados. Nota: cuando se usa la autenticación basada en identidades, todavía se requiere un URI de https:// sin el token de SAS. La entrada de este argumento puede estar insertada o desde una ruta de acceso de archivo.

Parámetros opcionales

--auth-type --storage-authentication-type

Tipo de autenticación para comunicarse con el contenedor de almacenamiento.

valores aceptados: identity, key
--identity

Tipo de identidad administrada para determinar si se usa la identidad administrada asignada por el sistema o la identidad administrada asignada por el usuario. En el caso de la identidad administrada asignada por el sistema, use [system]. En el caso de la identidad administrada asignada por el usuario, proporcione el identificador de recurso de identidad administrada asignada por el usuario. Esta identidad requiere un rol de colaborador de datos de blobs Storage para el rol de colaborador y cuenta de Storage de destino para el IoT Hub.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

az iot hub device-identity list

Enumere los dispositivos de un IoT Hub.

az iot hub device-identity list [--auth-type {key, login}]
                                [--edge-enabled {false, true}]
                                [--hub-name]
                                [--login]
                                [--resource-group]
                                [--top]

Parámetros opcionales

--auth-type

Indica si la operación debe derivar automáticamente una clave de directiva o usar la sesión de Azure AD actual. Puede configurar el valor predeterminado mediante az configure --defaults iothub-data-auth-type=<auth-type-value>.

valores aceptados: key, login
valor predeterminado: key
--edge-enabled --ee

Marca que indica la habilitación perimetral.

valores aceptados: false, true
--hub-name -n

IoT Hub nombre. Obligatorio si no se proporciona --login.

--login -l

Este comando admite una cadena de conexión de entidad con derechos para realizar la acción. Use para evitar el inicio de sesión de sesión a través de "az login". Si se proporciona una cadena de conexión de entidad y un nombre, la cadena de conexión tiene prioridad. Obligatorio si no se proporciona --hub-name.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--top

Número máximo de elementos que se van a devolver. Use -1 para ilimitado.

valor predeterminado: 1000

az iot hub device-identity renew-key

Renueve las claves de destino de un dispositivo IoT Hub con autenticación sas.

az iot hub device-identity renew-key --device-id
                                     --hub-name
                                     --key-type {primary, secondary, swap}
                                     [--auth-type {key, login}]
                                     [--etag]
                                     [--login]
                                     [--resource-group]

Ejemplos

Renueve la clave principal.

az iot hub device-identity renew-key -d {device_id} -n {iothub_name} --kt primary

Cambie las claves principal y secundaria.

az iot hub device-identity renew-key -d {device_id} -n {iothub_name} --kt swap

Parámetros requeridos

--device-id -d

Dispositivo de destino.

--hub-name -n

IoT Hub nombre. Obligatorio si no se proporciona --login.

--key-type --kt

Tipo de clave de destino que se va a regenerar.

valores aceptados: primary, secondary, swap

Parámetros opcionales

--auth-type

Indica si la operación debe derivar automáticamente una clave de directiva o usar la sesión de Azure AD actual. Puede configurar el valor predeterminado mediante az configure --defaults iothub-data-auth-type=<auth-type-value>.

valores aceptados: key, login
valor predeterminado: key
--etag -e

Etag o etiqueta de entidad correspondiente al último estado del recurso. Si no se proporciona ninguna etag, se usa el valor '*'.

--login -l

Este comando admite una cadena de conexión de entidad con derechos para realizar la acción. Use para evitar el inicio de sesión de sesión a través de "az login". Si se proporciona una cadena de conexión de entidad y un nombre, la cadena de conexión tiene prioridad. Obligatorio si no se proporciona --hub-name.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

az iot hub device-identity show

Obtenga los detalles de un dispositivo IoT Hub.

az iot hub device-identity show --device-id
                                [--auth-type {key, login}]
                                [--hub-name]
                                [--login]
                                [--resource-group]

Parámetros requeridos

--device-id -d

Dispositivo de destino.

Parámetros opcionales

--auth-type

Indica si la operación debe derivar automáticamente una clave de directiva o usar la sesión de Azure AD actual. Puede configurar el valor predeterminado mediante az configure --defaults iothub-data-auth-type=<auth-type-value>.

valores aceptados: key, login
valor predeterminado: key
--hub-name -n

IoT Hub nombre. Obligatorio si no se proporciona --login.

--login -l

Este comando admite una cadena de conexión de entidad con derechos para realizar la acción. Use para evitar el inicio de sesión de sesión a través de "az login". Si se proporciona una cadena de conexión de entidad y un nombre, la cadena de conexión tiene prioridad. Obligatorio si no se proporciona --hub-name.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

az iot hub device-identity update

Actualice un dispositivo IoT Hub.

Use --set seguido de asignaciones de propiedades para actualizar un dispositivo. Aproveche los parámetros devueltos de "iot hub device-identity show".

az iot hub device-identity update --device-id
                                  [--add]
                                  [--am {shared_private_key, x509_ca, x509_thumbprint}]
                                  [--auth-type {key, login}]
                                  [--edge-enabled {false, true}]
                                  [--etag]
                                  [--force-string]
                                  [--hub-name]
                                  [--login]
                                  [--pk]
                                  [--primary-thumbprint]
                                  [--remove]
                                  [--resource-group]
                                  [--secondary-key]
                                  [--secondary-thumbprint]
                                  [--set]
                                  [--sta {disabled, enabled}]
                                  [--star]

Ejemplos

Activación de las funcionalidades perimetrales para el dispositivo

az iot hub device-identity update -d {device_id} -n {iothub_name} --set capabilities.iotEdge=true

Active las funcionalidades perimetrales para el dispositivo mediante un argumento de conveniencia.

az iot hub device-identity update -d {device_id} -n {iothub_name} --ee

Deshabilitación del estado del dispositivo

az iot hub device-identity update -d {device_id} -n {iothub_name} --set status=disabled

Deshabilite el estado del dispositivo mediante un argumento de conveniencia.

az iot hub device-identity update -d {device_id} -n {iothub_name} --status disabled

En un comando

az iot hub device-identity update -d {device_id} -n {iothub_name} --set status=disabled capabilities.iotEdge=true

Parámetros requeridos

--device-id -d

Dispositivo de destino.

Parámetros opcionales

--add

Agregue un objeto a una lista de objetos especificando una ruta de acceso y pares clave-valor. Ejemplo: --add property.listProperty <key=value, string o JSON string>.

--am --auth-method

El método de autorización con el que se va a crear una entidad.

valores aceptados: shared_private_key, x509_ca, x509_thumbprint
--auth-type

Indica si la operación debe derivar automáticamente una clave de directiva o usar la sesión de Azure AD actual. Puede configurar el valor predeterminado mediante az configure --defaults iothub-data-auth-type=<auth-type-value>.

valores aceptados: key, login
valor predeterminado: key
--edge-enabled --ee

Marca que indica la habilitación perimetral.

valores aceptados: false, true
--etag -e

Etag o etiqueta de entidad correspondiente al último estado del recurso. Si no se proporciona ninguna etag, se usa el valor '*'.

--force-string

Al usar 'set' o 'add', conserve los literales de cadena en lugar de intentar convertir en JSON.

--hub-name -n

IoT Hub nombre. Obligatorio si no se proporciona --login.

--login -l

Este comando admite una cadena de conexión de entidad con derechos para realizar la acción. Use para evitar el inicio de sesión de sesión a través de "az login". Si se proporciona una cadena de conexión de entidad y un nombre, la cadena de conexión tiene prioridad. Obligatorio si no se proporciona --hub-name.

--pk --primary-key

Clave de acceso compartido simétrica principal almacenada en formato base64.

--primary-thumbprint --ptp

Huella digital de certificado autofirmado que se va a usar para la huella digital principal.

--remove

Quite una propiedad o un elemento de una lista. Ejemplo: --remove property.list OR --remove propertyToRemove.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--secondary-key --sk

Clave de acceso compartido simétrica secundaria almacenada en formato base64.

--secondary-thumbprint --stp

Huella digital de certificado autofirmado que se va a usar para la huella digital secundaria.

--set

Actualice un objeto especificando una ruta de acceso de propiedad y un valor que se va a establecer. Ejemplo: --set property1.property2=.

--sta --status

Establezca el estado del dispositivo tras la creación.

valores aceptados: disabled, enabled
--star --status-reason

Descripción del estado del dispositivo.