az iot device registration
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 instalará automáticamente la primera vez que ejecute un comando az iot device registration. Obtenga más información sobre las extensiones.
Este grupo de comandos está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus
Administrar registros de dispositivos IoT para ioT Device Provisioning Service.
Use az iot dps enrollment registration o az iot dps enrollment-group registration para ver y eliminar registros.
Comandos
| Nombre | Description | Tipo | Estado |
|---|---|---|---|
| az iot device registration create |
Registre un dispositivo IoT con el servicio IoT Device Provisioning. |
Extension | Preview |
az iot device registration create
El grupo de comandos "iot device registration" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus
Registre un dispositivo IoT con el servicio IoT Device Provisioning.
Se admiten los siguientes mecanismos de atestación:
- Clave simétrica
- Certificado x509 Si usa métodos de autenticación x509, se deben proporcionar los archivos de certificado y clave (y la frase de contraseña si es necesario).
az iot device registration create --registration-id --rid
[--auth-type {key, login}]
[--certificate-file-path --cp]
[--ck --compute-key]
[--dps-name]
[--enrollment-group-id --gid --group-id]
[--host --provisioning-host]
[--id-scope --scope]
[--key --symmetric-key]
[--key-file-path --kp]
[--login]
[--pass --passphrase]
[--payload]
[--resource-group]
Ejemplos
Registre un dispositivo IoT mediante una inscripción individual.
az iot device registration create -n {dps_name} --rid {registration_id}
Registre un dispositivo IoT mediante una inscripción de grupo.
az iot device registration create -n {dps_name} --rid {registration_id} --gid {group_enrollment_id}
Registre un dispositivo IoT mediante una inscripción individual, el ámbito de identificador del servicio Device Provisioning y una clave simétrica determinada. Esto omitirá la recuperación del ámbito de identificador y la clave simétrica de inscripción individal.
az iot device registration create --id-scope {id_scope} --rid {registration_id} --key {symmetric_key}
Registre un dispositivo IoT mediante una inscripción de grupo, el ámbito de identificador del servicio Device Provisioning y una clave simétrica de grupo de inscripción determinada. Esto omitirá la recuperación del ámbito de identificador y la clave simétrica del grupo de inscripción. La clave simétrica usada para el registro de dispositivos se calculará a partir de la clave simétrica especificada.
az iot device registration create --id-scope {id_scope} --rid {registration_id} --gid {group_enrollment_id} --key {symmetric_key} --ck
Registre un dispositivo IoT mediante una inscripción de grupo, el ámbito de identificador del servicio Device Provisioning y una clave simétrica determinada. Esto omitirá la recuperación del ámbito de identificador. Tenga en cuenta que, dado que la clave simétrica debe ser la clave de dispositivo calculada, no se necesita el identificador del grupo de inscripción.
az iot device registration create --id-scope {id_scope} --rid {registration_id} --key {symmetric_key}
Registre un dispositivo IoT mediante una inscripción individual, el ámbito de identificador del servicio Device Provisioning y los archivos de certificado y clave especificados. Esto omitirá la recuperación del ámbito de identificador.
az iot device registration create --id-scope {id_scope} --rid {registration_id} --cp {certificate_file} --kp {key_file}
Registre un dispositivo IoT mediante una inscripción individual, el ámbito del identificador del servicio Device Provisioning y los archivos de certificado y clave y la frase de contraseña para el archivo de clave. Esto omitirá la recuperación del ámbito de identificador.
az iot device registration create --id-scope {id_scope} --rid {registration_id} --cp {certificate_file} --kp {key_file} --pass {passphrase}
Registre un dispositivo IoT mediante una inscripción de grupo, el ámbito de identificador del servicio Device Provisioning y los archivos de certificado y clave especificados. Esto omitirá la recuperación del ámbito de identificador. Tenga en cuenta que el identificador de inscripción de grupo no es necesario para las atestaciones x509 y el asunto del archivo de certificado es el identificador de registro.
az iot device registration create --id-scope {id_scope} --rid {registration_id} --cp {certificate_file} --kp {key_file}
Parámetros requeridos
Identificador de registro de dispositivo o identificador de inscripción individual.
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.
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 |
|---|---|
| Grupo de parámetros: | Access Control Arguments |
| Valor predeterminado: | key |
| Valores aceptados: | key, login |
Ruta de acceso al archivo PEM de certificado. Necesario para los registros x509.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | x509 Authentication Arguments |
Marca para indicar que la clave simétrica para el registro del dispositivo debe calcularse desde la clave especificada con --symmetric-key.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Symmetric Key Authentication Arguments |
| Valor predeterminado: | False |
Nombre del servicio Azure IoT Hub Device Provisioning. Obligatorio si --login no se proporciona o no se proporcionan argumentos authenticaton y no se proporciona el ámbito --id-scope.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | DPS Identifier Arguments |
Identificador del grupo de inscripción. Solo es necesario para recuperar argumentos de autenticación.
Punto de conexión que apunta al host de aprovisionamiento que se va a usar.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | global.azure-devices-provisioning.net |
Ámbito de identificador del servicio Azure IoT Hub Device Provisioning. Si se proporciona con argumentos de autenticación, evitará el inicio de sesión de sesión.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | DPS Identifier Arguments |
Clave de acceso compartido simétrica para el registro del dispositivo.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Symmetric Key Authentication Arguments |
Ruta de acceso al archivo PEM de clave. Necesario para los registros x509.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | x509 Authentication Arguments |
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 proporcionan argumentos --dps-name o authenticaton y --id-scope no se proporcionan.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | DPS Identifier Arguments |
Frase de contraseña para el certificado.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | x509 Authentication Arguments |
Carga de asignación personalizada como JSON. Específicamente para su uso con directivas de asignación personalizadas mediante Azure Functions.
Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.
Parámetros globales
Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Mostrar este mensaje de ayuda y salir.
Solo se muestran errores, suprimiendo advertencias.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Formato de salida.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | json |
| Valores aceptados: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.
Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.
Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |