az iot dps enrollment
Nota:
Esta referencia forma parte de la extensión azure-iot para la CLI de Azure (versión 2.46.0 o posterior). La extensión se instalará automáticamente la primera vez que ejecute un comando az iot dps enrollment . Obtenga más información sobre las extensiones.
Administre las inscripciones de dispositivos individuales en una instancia de Azure IoT Hub Device Provisioning Service.
Comandos
Nombre | Description | Tipo | Estado |
---|---|---|---|
az iot dps enrollment create |
Cree una inscripción de dispositivos individuales en un servicio Azure IoT Hub Device Provisioning. |
Extensión | GA |
az iot dps enrollment delete |
Elimine una inscripción de dispositivos individuales en un servicio Azure IoT Hub Device Provisioning. |
Extensión | GA |
az iot dps enrollment list |
Enumere las inscripciones de dispositivos individuales en un servicio Azure IoT Hub Device Provisioning. |
Extensión | GA |
az iot dps enrollment registration |
Administrar registros de dispositivos del lado del servicio para una inscripción individual en un servicio Azure IoT Hub Device Provisioning. |
Extensión | GA |
az iot dps enrollment registration delete |
Elimine un registro de dispositivos para una inscripción individual en un servicio Azure IoT Hub Device Provisioning. |
Extensión | GA |
az iot dps enrollment registration show |
Obtenga un registro de dispositivos para una inscripción individual en un servicio Azure IoT Hub Device Provisioning. |
Extensión | GA |
az iot dps enrollment show |
Obtenga los detalles de inscripción de dispositivos individuales en un servicio Azure IoT Hub Device Provisioning. |
Extensión | GA |
az iot dps enrollment update |
Actualice una inscripción de dispositivos individuales en un servicio Azure IoT Hub Device Provisioning. |
Extensión | GA |
az iot dps enrollment create
Cree una inscripción de dispositivos individuales en un servicio Azure IoT Hub Device Provisioning.
Proporcione el formato de certificado mediante la codificación ASCII base64 y el certificado debe tener segmentos BEGIN y END coincidentes, por ejemplo: comience con "-----BEGIN CERTIFICATE-----" y termine con "-----END CERTIFICATE-----".
az iot dps enrollment create --at {symmetricKey, tpm, x509}
--eid
[--allocation-policy {custom, geoLatency, hashed, static}]
[--api-version]
[--auth-type {key, login}]
[--certificate-path]
[--device-id]
[--device-information]
[--dps-name]
[--edge-enabled {false, true}]
[--ek]
[--ih]
[--initial-twin-properties]
[--initial-twin-tags]
[--login]
[--pk]
[--provisioning-status {disabled, enabled}]
[--reprovision-policy {never, reprovisionandmigratedata, reprovisionandresetdata}]
[--resource-group]
[--scp]
[--secondary-key]
[--webhook-url]
Ejemplos
Cree una inscripción '{enrollment_id}' con el tipo de atestación 'x509' en azure IoT Device Provisioning Service '{dps_name}' en el grupo de recursos '{resource_group_name}' con el estado de aprovisionamiento 'deshabilitado', id. de dispositivo '{device_id}', propiedades del gemelo inicial '{"location":{"region":"US"}}', etiquetas de gemelo inicial '{"version":"1"}' e información del dispositivo '{"color":"red"}'.
az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type x509 --certificate-path /certificates/Certificate.pem --provisioning-status disabled --initial-twin-properties "{'location':{'region':'US'}}" --initial-twin-tags "{'version':'1'}" --device-info "{'color':'red'}" --device-id {device_id}
Cree una inscripción "MyEnrollment" con el tipo de atestación "tpm" en azure IoT Device Provisioning Service '{dps_name}' en el grupo de recursos '{resource_group_name}'.
az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type tpm --endorsement-key 14963E8F3BA5B3984110B3C1CA8E8B89
Cree una inscripción "MyEnrollment" con el tipo de atestación "symmetrickey" en el servicio Azure IoT Device Provisioning '{dps_name}' en el grupo de recursos '{resource_group_name}'.
az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type symmetrickey --primary-key {primary_key} --secondary-key {secondary_key}
Cree una inscripción "MyEnrollment" con el reaprovisionamiento en el servicio Azure IoT Device Provisioning '{dps_name}' en el grupo de recursos '{resource_group_name}'.
az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type tpm --reprovision-policy {reprovision_type} --endorsement-key 14963E8F3BA5B3984110B3C1CA8E8B89
Cree una inscripción "MyEnrollment" con una directiva de asignación estática en el servicio Azure IoT Device Provisioning '{dps_name}' en el grupo de recursos '{resource_group_name}'.
az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type tpm --allocation-policy static --endorsement-key 14963E8F3BA5B3984110B3C1CA8E8B89 --iot-hubs {iot_hub_host_name}
Cree una inscripción "MyEnrollment" con una directiva de asignación hash y varios centros en el servicio Azure IoT Device Provisioning '{dps_name}' en el grupo de recursos '{resource_group_name}'.
az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type tpm --allocation-policy hashed --endorsement-key 14963E8F3BA5B3984110B3C1CA8E8B89 --iot-hubs {iot_hub_host_name1} {iot_hub_host_name2}
Crear una inscripción "MyEnrollment" con la directiva de asignación personalizada,
az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type symmetrickey --allocation-policy custom --webhook-url {webhook_url} --api-version {api_version}
Parámetros requeridos
Mecanismo de atestación usado para la autenticación en DPS.
Identificador de inscripción de dispositivos individuales.
Parámetros opcionales
Tipo de directiva de asignación para determinar cómo se asigna un dispositivo a una instancia de IoT Hub. Si no se proporciona, la directiva de asignación será el valor predeterminado de la directiva de asignación actual establecida para la instancia de Device Provisioning Service.
La versión de API de los tipos de servicio de aprovisionamiento enviados en la solicitud de asignación personalizada. Versión mínima admitida: 2018-09-01-preview.
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 iotdps-data-auth-type=<auth-type-value>
.
Ruta de acceso al archivo que contiene el certificado principal. Obligatorio al elegir x509 como tipo de atestación y no se proporciona la ruta de acceso del certificado secundario.
Identificador de dispositivo registrado en IoT Hub.
Información opcional del dispositivo.
Nombre o nombre de host del servicio Azure IoT Hub Device Provisioning. Obligatorio si no se proporciona --login.
Marca que indica la habilitación del borde.
Clave de aprobación de TPM para un dispositivo TPM. Al elegir tpm como tipo de atestación, se requiere la clave de aprobación.
Nombre de host de IoT Hub de destino asociado a la directiva de asignación. Use la lista separada por espacios para varias instancias de IoT Hub.
Propiedades iniciales del dispositivo gemelo.
Etiquetas de dispositivo gemelo iniciales.
Este comando admite una entidad cadena de conexión 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 --dps-name.
Clave de acceso compartido simétrica principal almacenada en formato base64.
Habilite o deshabilite la entrada de inscripción.
Directiva para determinar cómo se deben controlar los datos del dispositivo al volver a aprovisionar en otra instancia de IoT Hub.
Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>
.
Ruta de acceso al archivo que contiene el certificado secundario. Se requiere al elegir x509 como tipo de atestación y no se proporciona la ruta de acceso del certificado principal.
Clave de acceso compartido simétrica secundaria almacenada en formato base64.
La dirección URL del webhook de Azure Functions que se usa para las solicitudes de asignación personalizadas.
Parámetros globales
Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.
Muestre este mensaje de ayuda y salga.
Mostrar solo los errores y suprimir las advertencias.
Formato de salida.
Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.
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 de registro. Use --debug para obtener registros de depuración completos.
az iot dps enrollment delete
Elimine una inscripción de dispositivos individuales en un servicio Azure IoT Hub Device Provisioning.
az iot dps enrollment delete --eid
[--auth-type {key, login}]
[--dps-name]
[--etag]
[--login]
[--resource-group]
Parámetros requeridos
Identificador de inscripción de dispositivos individuales.
Parámetros opcionales
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 iotdps-data-auth-type=<auth-type-value>
.
Nombre o nombre de host del servicio Azure IoT Hub Device Provisioning. Obligatorio si no se proporciona --login.
Etag o etiqueta de entidad correspondiente al último estado del recurso. Si no se proporciona ninguna etag, se usa el valor '*'.
Este comando admite una entidad cadena de conexión 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 --dps-name.
Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>
.
Parámetros globales
Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.
Muestre este mensaje de ayuda y salga.
Mostrar solo los errores y suprimir las advertencias.
Formato de salida.
Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.
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 de registro. Use --debug para obtener registros de depuración completos.
az iot dps enrollment list
Enumere las inscripciones de dispositivos individuales en un servicio Azure IoT Hub Device Provisioning.
az iot dps enrollment list [--auth-type {key, login}]
[--dps-name]
[--login]
[--resource-group]
[--top]
Parámetros opcionales
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 iotdps-data-auth-type=<auth-type-value>
.
Nombre o nombre de host del servicio Azure IoT Hub Device Provisioning. Obligatorio si no se proporciona --login.
Este comando admite una entidad cadena de conexión 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 --dps-name.
Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>
.
Número máximo de elementos que se van a devolver. Use -1 para ilimitado.
Parámetros globales
Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.
Muestre este mensaje de ayuda y salga.
Mostrar solo los errores y suprimir las advertencias.
Formato de salida.
Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.
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 de registro. Use --debug para obtener registros de depuración completos.
az iot dps enrollment show
Obtenga los detalles de inscripción de dispositivos individuales en un servicio Azure IoT Hub Device Provisioning.
az iot dps enrollment show --eid
[--auth-type {key, login}]
[--dps-name]
[--keys {false, true}]
[--login]
[--resource-group]
Ejemplos
Uso básico
az iot dps enrollment show --dps-name {dps_name} -g {resource_group} --enrollment-id {enrollment_id}
Incluir información de atestación completa en los resultados de una inscripción de clave simétrica
az iot dps enrollment show --dps-name {dps_name} -g {resource_group} --enrollment-id {symmetric_key_enrollment_id} --show-keys
Parámetros requeridos
Identificador de inscripción de dispositivos individuales.
Parámetros opcionales
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 iotdps-data-auth-type=<auth-type-value>
.
Nombre o nombre de host del servicio Azure IoT Hub Device Provisioning. Obligatorio si no se proporciona --login.
Incluya claves de atestación e información en los resultados de la inscripción.
Este comando admite una entidad cadena de conexión 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 --dps-name.
Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>
.
Parámetros globales
Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.
Muestre este mensaje de ayuda y salga.
Mostrar solo los errores y suprimir las advertencias.
Formato de salida.
Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.
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 de registro. Use --debug para obtener registros de depuración completos.
az iot dps enrollment update
Actualice una inscripción de dispositivos individuales en un servicio Azure IoT Hub Device Provisioning.
Proporcione el formato de certificado mediante la codificación ASCII base64 y el certificado debe tener segmentos BEGIN y END coincidentes, por ejemplo: comience con "-----BEGIN CERTIFICATE-----" y termine con "-----END CERTIFICATE-----".
az iot dps enrollment update --eid
[--allocation-policy {custom, geoLatency, hashed, static}]
[--api-version]
[--auth-type {key, login}]
[--certificate-path]
[--device-id]
[--device-information]
[--dps-name]
[--edge-enabled {false, true}]
[--ek]
[--etag]
[--ih]
[--initial-twin-properties]
[--initial-twin-tags]
[--login]
[--pk]
[--provisioning-status {disabled, enabled}]
[--rc {false, true}]
[--remove-secondary-certificate {false, true}]
[--reprovision-policy {never, reprovisionandmigratedata, reprovisionandresetdata}]
[--resource-group]
[--scp]
[--secondary-key]
[--webhook-url]
Ejemplos
Actualice la inscripción '{enrollment_id}' con un nuevo certificado x509 en azure IoT Device Provisioning Service '{dps_name}' en el grupo de recursos '{resource_group_name}'.
az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --certificate-path /certificates/NewCertificate.pem --etag AAAAAAAAAAA=
Actualice la inscripción '{enrollment_id}' con una nueva clave de aprobación en azure IoT Device Provisioning Service '{dps_name}' en el grupo de recursos '{resource_group_name}'.
az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --endorsement-key 14963E8F3BA5B3984110B3C1CA8E8B89 --etag AAAAAAAAAAA=
Actualice la inscripción '{enrollment_id}' con una nueva clave principal en azure IoT Device Provisioning Service '{dps_name}' en el grupo de recursos '{resource_group_name}'.
az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --primary-key {new_primary_key} --etag AAAAAAAAAAA=
Actualice la inscripción '{enrollment_id}' con un nuevo tipo de reaprovisionamiento en azure IoT Device Provisioning Service '{dps_name}' en el grupo de recursos '{resource_group_name}'.
az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --reprovision-policy {reprovision_type} --etag AAAAAAAAAAA=
Actualice la inscripción '{enrollment_id}' con una nueva directiva de asignación en azure IoT Device Provisioning Service '{dps_name}' en el grupo de recursos '{resource_group_name}'.
az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --allocation-policy geolatency --etag AAAAAAAAAAA= --iot-hubs {iot_hub_host_name1} {iot_hub_host_name2} {iot_hub_host_name3}
Actualice la inscripción '{enrollment_id}' en azure IoT Device Provisioning Service '{dps_name}' del grupo de recursos '{resource_group_name}' con las propiedades iniciales del gemelo '{"location":{"region":"USA"}}', las etiquetas de gemelo iniciales '{"version":"2"}' y la información del dispositivo '{"color":"red"}'.
az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --initial-twin-properties "{'location':{'region':'USA'}}" --initial-twin-tags "{'version1':'2'}" --device-info "{'color':'red'}"
Parámetros requeridos
Identificador de inscripción de dispositivos individuales.
Parámetros opcionales
Tipo de directiva de asignación para determinar cómo se asigna un dispositivo a una instancia de IoT Hub. Si no se proporciona, la directiva de asignación será el valor predeterminado de la directiva de asignación actual establecida para la instancia de Device Provisioning Service.
La versión de API de los tipos de servicio de aprovisionamiento enviados en la solicitud de asignación personalizada. Versión mínima admitida: 2018-09-01-preview.
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 iotdps-data-auth-type=<auth-type-value>
.
Ruta de acceso al archivo que contiene el certificado principal.
Identificador de dispositivo registrado en IoT Hub.
Información opcional del dispositivo.
Nombre o nombre de host del servicio Azure IoT Hub Device Provisioning. Obligatorio si no se proporciona --login.
Marca que indica la habilitación del borde.
Clave de aprobación de TPM para un dispositivo TPM.
Etag o etiqueta de entidad correspondiente al último estado del recurso. Si no se proporciona ninguna etag, se usa el valor '*'.
Nombre de host de IoT Hub de destino asociado a la directiva de asignación. Use la lista separada por espacios para varias instancias de IoT Hub.
Propiedades iniciales del dispositivo gemelo.
Etiquetas de dispositivo gemelo iniciales.
Este comando admite una entidad cadena de conexión 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 --dps-name.
Clave de acceso compartido simétrica principal almacenada en formato base64.
Habilite o deshabilite la entrada de inscripción.
Marca para quitar el certificado principal actual.
Marca para quitar el certificado secundario actual.
Directiva para determinar cómo se deben controlar los datos del dispositivo al volver a aprovisionar en otra instancia de IoT Hub.
Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>
.
Ruta de acceso al archivo que contiene el certificado secundario.
Clave de acceso compartido simétrica secundaria almacenada en formato base64.
La dirección URL del webhook de Azure Functions que se usa para las solicitudes de asignación personalizadas.
Parámetros globales
Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.
Muestre este mensaje de ayuda y salga.
Mostrar solo los errores y suprimir las advertencias.
Formato de salida.
Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.
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 de registro. Use --debug para obtener registros de depuración completos.