az iot hub device-identity

Note

This reference is part of the azure-iot extension for the Azure CLI (version 2.59.0 or higher). La extensión instalará automáticamente la primera vez que ejecute un comando az iot hub device-identity. Learn more about extensions.

Administre los dispositivos IoT.

Comandos

Nombre	Description	Tipo	Estado
az iot hub device-identity children	Administrar relaciones de dispositivos secundarios para dispositivos IoT Edge.	Extension	GA
az iot hub device-identity children add	Agregue dispositivos como elementos secundarios a un dispositivo perimetral de destino.	Extension	GA
az iot hub device-identity children list	Genera la colección de dispositivos secundarios asignados.	Extension	GA
az iot hub device-identity children remove	Quite los dispositivos secundarios de un dispositivo perimetral de destino.	Extension	GA
az iot hub device-identity connection-string	Administrar la cadena de conexión del dispositivo IoT.	Extension	GA
az iot hub device-identity connection-string show	Mostrar un cadena de conexión de dispositivo ioT Hub determinado.	Extension	GA
az iot hub device-identity create	Cree un dispositivo en una instancia de IoT Hub.	Extension	GA
az iot hub device-identity delete	Elimine un dispositivo ioT Hub.	Extension	GA
az iot hub device-identity export	Exporte todas las identidades de dispositivo de una instancia de IoT Hub a un contenedor de blobs de Azure Storage.	Extension	GA
az iot hub device-identity import	Importe identidades de dispositivo a IoT Hub desde un blob de contenedor de almacenamiento.	Extension	GA
az iot hub device-identity list	Enumeración de dispositivos en una instancia de IoT Hub.	Extension	GA
az iot hub device-identity parent	Administrar las relaciones de dispositivos primarios para dispositivos IoT.	Extension	GA
az iot hub device-identity parent set	Establezca el dispositivo primario de un dispositivo de destino.	Extension	GA
az iot hub device-identity parent show	Obtenga el dispositivo primario de un dispositivo de destino.	Extension	GA
az iot hub device-identity renew-key	Renueve las claves de destino de los dispositivos de IoT Hub con autenticación sas.	Extension	GA
az iot hub device-identity show	Obtenga los detalles de un dispositivo ioT Hub.	Extension	GA
az iot hub device-identity update	Actualice un dispositivo IoT Hub.	Extension	GA

az iot hub device-identity create

Cree un dispositivo en una instancia de 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 --auth-method {shared_private_key, x509_ca, x509_thumbprint}]
                                  [--auth-type {key, login}]
                                  [--device-scope]
                                  [--edge-enabled --ee {false, true}]
                                  [--hub-name]
                                  [--login]
                                  [--od --output-dir]
                                  [--pk --primary-key]
                                  [--primary-thumbprint --ptp]
                                  [--resource-group]
                                  [--secondary-key --sk]
                                  [--secondary-thumbprint --stp]
                                  [--sta --status {disabled, enabled}]
                                  [--star --status-reason]
                                  [--valid-days --vd]

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

Id. de dispositivo de destino.

Parámetros opcionales

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

--am --auth-method

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

Propiedad	Valor
Valor predeterminado:	shared_private_key
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 actual de Azure AD. Si el tipo de autenticación es login y se proporciona el nombre de host del recurso, se omitirá la búsqueda de recursos a menos que sea necesario. Puede configurar el valor predeterminado mediante az configure --defaults iothub-data-auth-type={auth-type-value}.

Propiedad	Valor
Parameter group:	Access Control Arguments
Valor predeterminado:	key
Valores aceptados:	key, login

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

Propiedad	Valor
Parameter group:	Device Scope Arguments

--edge-enabled --ee

Marca que indica la habilitación del borde.

Propiedad	Valor
Valor predeterminado:	False
Valores aceptados:	false, true

--hub-name -n

Nombre o nombre de host de IoT Hub. Obligatorio si no se proporciona --login.

Propiedad	Valor
Parameter group:	IoT Hub Identifier Arguments

--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 proporcionan las cadena de conexión y el nombre de una entidad, el cadena de conexión tiene prioridad. Obligatorio si no se proporciona --hub-name.

Propiedad	Valor
Parameter group:	IoT Hub Identifier Arguments

--od --output-dir

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

Propiedad	Valor
Parameter group:	X.509 Arguments

--pk --primary-key

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

Propiedad	Valor
Parameter group:	Symmetric Key Arguments

--primary-thumbprint --ptp

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

Propiedad	Valor
Parameter group:	X.509 Arguments

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

Propiedad	Valor
Parameter group:	Symmetric Key Arguments

--secondary-thumbprint --stp

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

Propiedad	Valor
Parameter group:	X.509 Arguments

--sta --status

Establezca el estado del dispositivo tras la creación.

Propiedad	Valor
Valor predeterminado:	enabled
Valores aceptados:	disabled, 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. Default: 365.

Propiedad	Valor
Parameter group:	X.509 Arguments

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

Output format.

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

Id. de dispositivo de destino.

Parámetros opcionales

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

--auth-type

Indica si la operación debe derivar automáticamente una clave de directiva o usar la sesión actual de Azure AD. Si el tipo de autenticación es login y se proporciona el nombre de host del recurso, se omitirá la búsqueda de recursos a menos que sea necesario. Puede configurar el valor predeterminado mediante az configure --defaults iothub-data-auth-type={auth-type-value}.

Propiedad	Valor
Parameter group:	Access Control Arguments
Valor predeterminado:	key
Valores aceptados:	key, login

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

Nombre o nombre de host de IoT Hub. Obligatorio si no se proporciona --login.

Propiedad	Valor
Parameter group:	IoT Hub Identifier Arguments

--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 proporcionan las cadena de conexión y el nombre de una entidad, el cadena de conexión tiene prioridad. Obligatorio si no se proporciona --hub-name.

Propiedad	Valor
Parameter group:	IoT Hub Identifier Arguments

--resource-group -g

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

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

Output format.

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 hub device-identity export

Exporte todas las identidades de dispositivo de una instancia de IoT Hub a un contenedor de blobs de Azure Storage.

El blob de salida que contiene identidades de dispositivo es un archivo de texto denominado "devices.txt".

Permisos necesarios: directiva de acceso compartido de IoT Hub que admite "Lectura del registro y escritura del Registro" O una entidad de seguridad con el rol "Colaborador de datos de IoT Hub" en IoT Hub.

Los parámetros de nombre de la cuenta de almacenamiento y de contenedor de blobs solo se pueden usar cuando la cuenta de almacenamiento está en la misma suscripción que ioT Hub de entrada. Para la entrada del URI de SAS del contenedor de blobs en línea, revise las reglas de entrada de su entorno.

Para obtener más información, consulte https://aka.ms/iothub-device-exportimport.

az iot hub device-identity export [--auth-type {key, login}]
                                  [--bc --blob-container]
                                  [--bcu --blob-container-uri]
                                  [--hub-name]
                                  [--identity]
                                  [--ik --include-keys {false, true}]
                                  [--login]
                                  [--resource-group]
                                  [--sa --storage-account]

Ejemplos

Exporte todas las identidades de dispositivo a un contenedor de blobs configurado e incluya claves de dispositivo. El nombre del contenedor de blobs y el nombre de la cuenta de almacenamiento se proporcionan como parámetros para el comando.

az iot hub device-identity export -n {iothub_name} --ik --bc {blob_container_name} --sa {storage_account_name}

Exporte todas las identidades de dispositivo a un contenedor de blobs configurado e incluya claves de dispositivo. Usa un ejemplo de URI de 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 roles colaborador de datos de Storage Blob para la cuenta de almacenamiento. El nombre del contenedor de blobs y el nombre de la cuenta de almacenamiento se proporcionan como parámetros para el comando.

az iot hub device-identity export -n {iothub_name} --ik --bc {blob_container_name} --sa {storage_account_name} --identity [system]

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 roles colaborador de datos de Storage Blob 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' --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 el rol Colaborador de datos de Storage Blob para la cuenta de almacenamiento. El nombre del contenedor de blobs y el nombre de la cuenta de almacenamiento se proporcionan como parámetros para el comando.

az iot hub device-identity export -n {iothub_name} --ik --bc {blob_container_name} --sa {storage_account_name} --identity {managed_identity_resource_id}

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 el rol Colaborador de datos de Storage Blob 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' --identity {managed_identity_resource_id}

Parámetros opcionales

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

--auth-type

Indica si la operación debe derivar automáticamente una clave de directiva o usar la sesión actual de Azure AD. Si el tipo de autenticación es login y se proporciona el nombre de host del recurso, se omitirá la búsqueda de recursos a menos que sea necesario. Puede configurar el valor predeterminado mediante az configure --defaults iothub-data-auth-type={auth-type-value}.

Propiedad	Valor
Parameter group:	Access Control Arguments
Valor predeterminado:	key
Valores aceptados:	key, login

--bc --blob-container

Este contenedor de blobs se usa para generar el estado del trabajo de importación de identidad del dispositivo y los resultados. El parámetro se omite cuando se proporciona blob_container_uri. El acceso de escritura, lectura y eliminación es necesario para este contenedor de blobs.

--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, se sigue necesitando 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

Nombre o nombre de host de IoT Hub. Obligatorio si no se proporciona --login.

Propiedad	Valor
Parameter group:	IoT Hub Identifier Arguments

--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. Para 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 roles de colaborador de datos de Storage Blob para la cuenta de almacenamiento.

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

Propiedad	Valor
Valor predeterminado:	False
Valores aceptados:	false, true

--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 proporcionan las cadena de conexión y el nombre de una entidad, el cadena de conexión tiene prioridad. Obligatorio si no se proporciona --hub-name.

Propiedad	Valor
Parameter group:	IoT Hub Identifier Arguments

--resource-group -g

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

--sa --storage-account

Nombre de la cuenta de Azure Storage que contiene el contenedor de blobs de salida. El parámetro se omite cuando se proporciona blob_container_uri. Se requiere acceso de escritura, lectura y eliminación.

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

Output format.

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 hub device-identity import

Importe identidades de dispositivo a IoT Hub desde un blob de contenedor de almacenamiento.

El archivo de entrada esperado que contiene identidades de dispositivo debe denominarse "devices.txt". El archivo de registro de salida "importErrors.log" está vacío cuando la importación se realiza correctamente y contiene registros de errores en caso de error de importación.

Permisos necesarios: directiva de acceso compartido de IoT Hub que admite "Lectura del registro y escritura del Registro" O una entidad de seguridad con el rol "Colaborador de datos de IoT Hub" en IoT Hub.

Los parámetros de nombre de la cuenta de almacenamiento y de contenedor de blobs solo se pueden usar cuando la cuenta de almacenamiento está en la misma suscripción que ioT Hub de entrada. Para la entrada del URI de SAS del contenedor de blobs en línea, revise las reglas de entrada de su entorno.

Para obtener más información, consulte https://aka.ms/iothub-device-exportimport.

az iot hub device-identity import [--auth-type {key, login}]
                                  [--hub-name]
                                  [--ibc --input-blob-container]
                                  [--ibcu --input-blob-container-uri]
                                  [--identity]
                                  [--input-storage-account --isa]
                                  [--login]
                                  [--obc --output-blob-container]
                                  [--obcu --output-blob-container-uri]
                                  [--osa --output-storage-account]
                                  [--resource-group]

Ejemplos

Importe todas las identidades de dispositivo desde un blob proporcionando parámetros de comando para el contenedor de blobs de entrada y la cuenta de almacenamiento, así como el contenedor de blobs de salida y la cuenta de almacenamiento.

az iot hub device-identity import -n {iothub_name} --ibc {input_blob_container_name} --isa {input_storage_account_name} --obc {output_blob_container_name} --osa {output_storage_account_name}

Importe todas las identidades de dispositivo desde un blob mediante un URI de 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 roles colaborador de datos de Storage Blob para ambas cuentas de almacenamiento. El contenedor de blobs de entrada y la cuenta de almacenamiento, así como el contenedor de blobs de salida y la cuenta de almacenamiento se proporcionan como parámetros para el comando.

az iot hub device-identity import -n {iothub_name} --ibc {input_blob_container_name} --isa {input_storage_account_name} --obc {output_blob_container_name} --osa {output_storage_account_name} --identity [system]

Importe todas las identidades de dispositivo de un blob mediante una identidad asignada por el sistema que tenga roles colaborador de datos de Storage Blob 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} --identity [system]

Importe todas las identidades de dispositivo de un blob mediante una identidad administrada asignada por el usuario que tenga roles colaborador de datos de Storage Blob para ambas cuentas de almacenamiento. El contenedor de blobs de entrada y la cuenta de almacenamiento, así como el contenedor de blobs de salida y la cuenta de almacenamiento se proporcionan como parámetros para el comando.

az iot hub device-identity import -n {iothub_name} --ibc {input_blob_container_name} --isa {input_storage_account_name} --obc {output_blob_container_name} --osa {output_storage_account_name} --identity {managed_identity_resource_id}

Importe todas las identidades de dispositivo de un blob mediante una identidad administrada asignada por el usuario que tenga roles colaborador de datos de Storage Blob 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} --identity {managed_identity_resource_id}

Parámetros opcionales

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

--auth-type

Indica si la operación debe derivar automáticamente una clave de directiva o usar la sesión actual de Azure AD. Si el tipo de autenticación es login y se proporciona el nombre de host del recurso, se omitirá la búsqueda de recursos a menos que sea necesario. Puede configurar el valor predeterminado mediante az configure --defaults iothub-data-auth-type={auth-type-value}.

Propiedad	Valor
Parameter group:	Access Control Arguments
Valor predeterminado:	key
Valores aceptados:	key, login

--hub-name -n

Nombre o nombre de host de IoT Hub. Obligatorio si no se proporciona --login.

Propiedad	Valor
Parameter group:	IoT Hub Identifier Arguments

--ibc --input-blob-container

Este contenedor de blobs almacena el archivo que define las operaciones que se van a realizar en el registro de identidades. El parámetro se omite cuando se proporciona input_blob_container_uri. El acceso de lectura es necesario para este contenedor de blobs.

--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 realizarán en el registro de identidad. Nota: cuando se usa la autenticación basada en identidades, se sigue necesitando 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.

--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. Para 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 colaborador de datos de Storage Blob para el rol de colaborador y cuenta de almacenamiento de destino para IoT Hub.

--input-storage-account --isa

Nombre de la cuenta de Azure Storage que contiene el contenedor de blobs de entrada. Solo es necesario cuando no se proporciona input_blob_container_uri. Se requiere acceso de lectura.

--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 proporcionan las cadena de conexión y el nombre de una entidad, el cadena de conexión tiene prioridad. Obligatorio si no se proporciona --hub-name.

Propiedad	Valor
Parameter group:	IoT Hub Identifier Arguments

--obc --output-blob-container

Este contenedor de blobs se usa para generar el estado del trabajo de importación de identidad del dispositivo y los resultados. Solo es necesario cuando no se proporciona input_blob_container_uri. El acceso de escritura es necesario para este contenedor de blobs.

--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: al usar 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.

--osa --output-storage-account

Nombre de la cuenta de Azure Storage que contiene el contenedor de blobs de salida. El parámetro se omite cuando se proporciona output_blob_container_uri. Se requiere acceso de escritura.

--resource-group -g

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

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

Output format.

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 hub device-identity list

Enumeración de dispositivos en una instancia de IoT Hub.

Este comando es un alias para az iot hub device-twin list, que es muy recomendable sobre este comando. En el futuro, este az iot hub device-identity list comando se puede modificar o dejar de usar.

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

Parámetros opcionales

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

--auth-type

Indica si la operación debe derivar automáticamente una clave de directiva o usar la sesión actual de Azure AD. Si el tipo de autenticación es login y se proporciona el nombre de host del recurso, se omitirá la búsqueda de recursos a menos que sea necesario. Puede configurar el valor predeterminado mediante az configure --defaults iothub-data-auth-type={auth-type-value}.

Propiedad	Valor
Parameter group:	Access Control Arguments
Valor predeterminado:	key
Valores aceptados:	key, login

--edge-enabled --ee

Marca que indica la habilitación del borde.

Propiedad	Valor
Valor predeterminado:	False
Valores aceptados:	false, true

--hub-name -n

Nombre o nombre de host de IoT Hub. Obligatorio si no se proporciona --login.

Propiedad	Valor
Parameter group:	IoT Hub Identifier Arguments

--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 proporcionan las cadena de conexión y el nombre de una entidad, el cadena de conexión tiene prioridad. Obligatorio si no se proporciona --hub-name.

Propiedad	Valor
Parameter group:	IoT Hub Identifier Arguments

--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 un límite ilimitado.

Propiedad	Valor
Valor predeterminado:	1000

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

Output format.

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 hub device-identity renew-key

Renueve las claves de destino de los dispositivos de IoT Hub con autenticación sas.

Actualmente, las etiquetas etag y el tipo swap de clave no se admiten para la regeneración masiva de claves. La regeneración masiva de claves se convertirá en un formato de salida diferente a partir de la regeneración de claves de dispositivo único.

az iot hub device-identity renew-key --device-id
                                     --hub-name
                                     --key-type --kt {both, primary, secondary, swap}
                                     [--auth-type {key, login}]
                                     [--etag]
                                     [--im --include-modules {false, true}]
                                     [--login]
                                     [--no-progress {false, true}]
                                     [--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

Renueve la clave secundaria para dos dispositivos y sus módulos.

az iot hub device-identity renew-key -d {device_id} {device_id} -n {iothub_name} --kt secondary --include-modules

Renueve las dos claves para todos los dispositivos del centro.

az iot hub device-identity renew-key -d * -n {iothub_name} --kt both

Parámetros requeridos

--device-id -d

Lista de espacios separados de los identificadores de dispositivo de destino. Use * para todos los dispositivos.

--hub-name -n

Nombre o nombre de host de IoT Hub. Obligatorio si no se proporciona --login.

Propiedad	Valor
Parameter group:	IoT Hub Identifier Arguments

--key-type --kt

Tipo de clave de destino que se va a regenerar.

Propiedad	Valor
Valores aceptados:	both, primary, secondary, swap

Parámetros opcionales

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

--auth-type

Indica si la operación debe derivar automáticamente una clave de directiva o usar la sesión actual de Azure AD. Si el tipo de autenticación es login y se proporciona el nombre de host del recurso, se omitirá la búsqueda de recursos a menos que sea necesario. Puede configurar el valor predeterminado mediante az configure --defaults iothub-data-auth-type={auth-type-value}.

Propiedad	Valor
Parameter group:	Access Control Arguments
Valor predeterminado:	key
Valores aceptados:	key, login

--etag -e

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

--im --include-modules

Marca para incluir módulos de dispositivo durante la regeneración de claves.

Propiedad	Valor
Valor predeterminado:	False
Valores aceptados:	false, true

--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 proporcionan las cadena de conexión y el nombre de una entidad, el cadena de conexión tiene prioridad. Obligatorio si no se proporciona --hub-name.

Propiedad	Valor
Parameter group:	IoT Hub Identifier Arguments

--no-progress

Oculte la barra de progreso para la regeneración masiva de claves.

Propiedad	Valor
Valor predeterminado:	False
Valores aceptados:	false, true

--resource-group -g

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

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

Output format.

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

Id. de dispositivo de destino.

Parámetros opcionales

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

--auth-type

Indica si la operación debe derivar automáticamente una clave de directiva o usar la sesión actual de Azure AD. Si el tipo de autenticación es login y se proporciona el nombre de host del recurso, se omitirá la búsqueda de recursos a menos que sea necesario. Puede configurar el valor predeterminado mediante az configure --defaults iothub-data-auth-type={auth-type-value}.

Propiedad	Valor
Parameter group:	Access Control Arguments
Valor predeterminado:	key
Valores aceptados:	key, login

--hub-name -n

Nombre o nombre de host de IoT Hub. Obligatorio si no se proporciona --login.

Propiedad	Valor
Parameter group:	IoT Hub Identifier Arguments

--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 proporcionan las cadena de conexión y el nombre de una entidad, el cadena de conexión tiene prioridad. Obligatorio si no se proporciona --hub-name.

Propiedad	Valor
Parameter group:	IoT Hub Identifier Arguments

--resource-group -g

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

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

Output format.

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 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 --auth-method {shared_private_key, x509_ca, x509_thumbprint}]
                                  [--auth-type {key, login}]
                                  [--edge-enabled --ee {false, true}]
                                  [--etag]
                                  [--force-string]
                                  [--hub-name]
                                  [--login]
                                  [--pk --primary-key]
                                  [--primary-thumbprint --ptp]
                                  [--remove]
                                  [--resource-group]
                                  [--secondary-key --sk]
                                  [--secondary-thumbprint --stp]
                                  [--set]
                                  [--sta --status {disabled, enabled}]
                                  [--star --status-reason]

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 el argumento de conveniencia.

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

Deshabilitar el estado del dispositivo

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

Deshabilite el estado del dispositivo mediante el 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

Id. de dispositivo de destino.

Parámetros opcionales

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

--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 or JSON string>.

Propiedad	Valor
Parameter group:	Generic Update Arguments
Valor predeterminado:	[]

--am --auth-method

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

Propiedad	Valor
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 actual de Azure AD. Si el tipo de autenticación es login y se proporciona el nombre de host del recurso, se omitirá la búsqueda de recursos a menos que sea necesario. Puede configurar el valor predeterminado mediante az configure --defaults iothub-data-auth-type={auth-type-value}.

Propiedad	Valor
Parameter group:	Access Control Arguments
Valor predeterminado:	key
Valores aceptados:	key, login

--edge-enabled --ee

Marca que indica la habilitación del borde.

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

Propiedad	Valor
Parameter group:	Generic Update Arguments
Valor predeterminado:	False

--hub-name -n

Nombre o nombre de host de IoT Hub. Obligatorio si no se proporciona --login.

Propiedad	Valor
Parameter group:	IoT Hub Identifier Arguments

--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 proporcionan las cadena de conexión y el nombre de una entidad, el cadena de conexión tiene prioridad. Obligatorio si no se proporciona --hub-name.

Propiedad	Valor
Parameter group:	IoT Hub Identifier Arguments

--pk --primary-key

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

Propiedad	Valor
Parameter group:	Symmetric Key Arguments

--primary-thumbprint --ptp

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

Propiedad	Valor
Parameter group:	X.509 Arguments

--remove

Quite una propiedad o un elemento de una lista. Ejemplo: --remove property.list <indexToRemove> O --remove propertyToRemove.

Propiedad	Valor
Parameter group:	Generic Update Arguments
Valor predeterminado:	[]

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

Propiedad	Valor
Parameter group:	Symmetric Key Arguments

--secondary-thumbprint --stp

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

Propiedad	Valor
Parameter group:	X.509 Arguments

--set

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

Propiedad	Valor
Parameter group:	Generic Update Arguments
Valor predeterminado:	[]

--sta --status

Establezca el estado del dispositivo tras la creación.

Propiedad	Valor
Valores aceptados:	disabled, enabled

--star --status-reason

Descripción del estado del dispositivo.

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

Output format.

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