Compartir a través de


az iot dps enrollment

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

Extension GA
az iot dps enrollment delete

Elimine una inscripción de dispositivos individuales en un servicio Azure IoT Hub Device Provisioning.

Extension GA
az iot dps enrollment list

Enumere las inscripciones de dispositivos individuales en un servicio Azure IoT Hub Device Provisioning.

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

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

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

Extension GA
az iot dps enrollment show

Obtenga los detalles de inscripción de dispositivos individuales en un servicio Azure IoT Hub Device Provisioning.

Extension GA
az iot dps enrollment update

Actualice una inscripción de dispositivos individuales en un servicio Azure IoT Hub Device Provisioning.

Extension 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 --attestation-type {symmetricKey, tpm, x509}
                             --eid --enrollment-id
                             [--allocation-policy --ap {custom, geoLatency, hashed, static}]
                             [--api-version --av]
                             [--auth-type {key, login}]
                             [--certificate-path --cp]
                             [--cpn --credential-policy-name]
                             [--device-id]
                             [--device-information --info]
                             [--dps-name]
                             [--edge-enabled --ee {false, true}]
                             [--ek --endorsement-key]
                             [--ih --iot-hubs]
                             [--initial-twin-properties --props]
                             [--initial-twin-tags --tags]
                             [--login]
                             [--pk --primary-key]
                             [--provisioning-status --ps {disabled, enabled}]
                             [--reprovision-policy --rp {never, reprovisionandmigratedata, reprovisionandresetdata}]
                             [--resource-group]
                             [--scp --secondary-certificate-path]
                             [--secondary-key --sk]
                             [--webhook-url --wh]

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-information "{'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}

Cree una inscripción con una directiva de credenciales de espacio de nombres de ADR personalizada especificada.

az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type symmetrickey --credential-policy-name {policy_name}

Parámetros requeridos

--at --attestation-type

Mecanismo de atestación usado para la autenticación en DPS.

Propiedad Valor
Grupo de parámetros: Authentication Arguments
Valores aceptados: symmetricKey, tpm, x509
--eid --enrollment-id

Identificador de inscripción de dispositivos individuales.

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.

--allocation-policy --ap

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.

Propiedad Valor
Grupo de parámetros: Allocation Policy Arguments
Valores aceptados: custom, geoLatency, hashed, static
--api-version --av

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.

Propiedad Valor
Grupo de parámetros: Allocation Policy Arguments
--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 iotdps-data-auth-type={auth-type-value}.

Propiedad Valor
Grupo de parámetros: Access Control Arguments
Valor predeterminado: key
Valores aceptados: key, login
--certificate-path --cp

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.

Propiedad Valor
Grupo de parámetros: Authentication Arguments
--cpn --credential-policy-name

Nombre de la directiva de credenciales del espacio de nombres de ADR.

Propiedad Valor
Grupo de parámetros: ADR Credential Policy Arguments
--device-id -d

Identificador de dispositivo registrado en IoT Hub.

--device-information --info

Información opcional del dispositivo.

--dps-name -n

Nombre o nombre de host del servicio Azure IoT Hub Device Provisioning. Obligatorio si no se proporciona --login.

Propiedad Valor
Grupo de parámetros: Device Provisioning Service Identifier Arguments
--edge-enabled --ee

Marca que indica la habilitación del borde.

Propiedad Valor
Valor predeterminado: False
Valores aceptados: false, true
--ek --endorsement-key

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.

Propiedad Valor
Grupo de parámetros: Authentication Arguments
--ih --iot-hubs

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.

Propiedad Valor
Grupo de parámetros: Allocation Policy Arguments
--initial-twin-properties --props

Propiedades iniciales del dispositivo gemelo.

--initial-twin-tags --tags

Etiquetas de dispositivo gemelo iniciales.

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

Propiedad Valor
Grupo de parámetros: Device Provisioning Service Identifier Arguments
--pk --primary-key

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

Propiedad Valor
Grupo de parámetros: Authentication Arguments
--provisioning-status --ps

Habilite o deshabilite la entrada de inscripción.

Propiedad Valor
Valores aceptados: disabled, enabled
--reprovision-policy --rp

Directiva para determinar cómo se deben controlar los datos del dispositivo al volver a aprovisionar en otra instancia de IoT Hub.

Propiedad Valor
Valores aceptados: never, reprovisionandmigratedata, reprovisionandresetdata
--resource-group -g

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

--scp --secondary-certificate-path

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.

Propiedad Valor
Grupo de parámetros: Authentication Arguments
--secondary-key --sk

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

Propiedad Valor
Grupo de parámetros: Authentication Arguments
--webhook-url --wh

La dirección URL del webhook de Azure Functions que se usa para las solicitudes de asignación personalizadas.

Propiedad Valor
Grupo de parámetros: Allocation Policy 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

Formato de salida.

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 dps enrollment delete

Elimine una inscripción de dispositivos individuales en un servicio Azure IoT Hub Device Provisioning.

az iot dps enrollment delete --eid --enrollment-id
                             [--auth-type {key, login}]
                             [--dps-name]
                             [--etag]
                             [--login]
                             [--resource-group]

Parámetros requeridos

--eid --enrollment-id

Identificador de inscripción de dispositivos individuales.

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.

--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 iotdps-data-auth-type={auth-type-value}.

Propiedad Valor
Grupo de parámetros: Access Control Arguments
Valor predeterminado: key
Valores aceptados: key, login
--dps-name -n

Nombre o nombre de host del servicio Azure IoT Hub Device Provisioning. Obligatorio si no se proporciona --login.

Propiedad Valor
Grupo de parámetros: Device Provisioning Service Identifier Arguments
--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 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.

Propiedad Valor
Grupo de parámetros: Device Provisioning Service 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

Formato de salida.

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

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.

--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 iotdps-data-auth-type={auth-type-value}.

Propiedad Valor
Grupo de parámetros: Access Control Arguments
Valor predeterminado: key
Valores aceptados: key, login
--dps-name -n

Nombre o nombre de host del servicio Azure IoT Hub Device Provisioning. Obligatorio si no se proporciona --login.

Propiedad Valor
Grupo de parámetros: Device Provisioning Service 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 --dps-name.

Propiedad Valor
Grupo de parámetros: Device Provisioning Service 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.

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

Formato de salida.

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 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 --enrollment-id
                           [--auth-type {key, login}]
                           [--dps-name]
                           [--keys --show-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

--eid --enrollment-id

Identificador de inscripción de dispositivos individuales.

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.

--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 iotdps-data-auth-type={auth-type-value}.

Propiedad Valor
Grupo de parámetros: Access Control Arguments
Valor predeterminado: key
Valores aceptados: key, login
--dps-name -n

Nombre o nombre de host del servicio Azure IoT Hub Device Provisioning. Obligatorio si no se proporciona --login.

Propiedad Valor
Grupo de parámetros: Device Provisioning Service Identifier Arguments
--keys --show-keys

Incluya claves de atestación e información en los resultados de la inscripción.

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

Propiedad Valor
Grupo de parámetros: Device Provisioning Service 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

Formato de salida.

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 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 --enrollment-id
                             [--allocation-policy --ap {custom, geoLatency, hashed, static}]
                             [--api-version --av]
                             [--auth-type {key, login}]
                             [--certificate-path --cp]
                             [--cpn --credential-policy-name]
                             [--device-id]
                             [--device-information --info]
                             [--dps-name]
                             [--edge-enabled --ee {false, true}]
                             [--ek --endorsement-key]
                             [--etag]
                             [--ih --iot-hubs]
                             [--initial-twin-properties --props]
                             [--initial-twin-tags --tags]
                             [--login]
                             [--pk --primary-key]
                             [--provisioning-status --ps {disabled, enabled}]
                             [--rc --remove-certificate {false, true}]
                             [--remove-secondary-certificate --rsc {false, true}]
                             [--reprovision-policy --rp {never, reprovisionandmigratedata, reprovisionandresetdata}]
                             [--resource-group]
                             [--scp --secondary-certificate-path]
                             [--secondary-key --sk]
                             [--webhook-url --wh]

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-information "{'color':'red'}"

Actualice la inscripción '{enrollment_id}' en azure IoT Device Provisioning Service '{dps_name}' para usar una directiva de credenciales de espacio de nombres de ADR personalizada.

az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --credential-policy-name {my_policy}

Parámetros requeridos

--eid --enrollment-id

Identificador de inscripción de dispositivos individuales.

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.

--allocation-policy --ap

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.

Propiedad Valor
Grupo de parámetros: Allocation Policy Arguments
Valores aceptados: custom, geoLatency, hashed, static
--api-version --av

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.

Propiedad Valor
Grupo de parámetros: Allocation Policy Arguments
--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 iotdps-data-auth-type={auth-type-value}.

Propiedad Valor
Grupo de parámetros: Access Control Arguments
Valor predeterminado: key
Valores aceptados: key, login
--certificate-path --cp

Ruta de acceso al archivo que contiene el certificado principal.

Propiedad Valor
Grupo de parámetros: Authentication Arguments
--cpn --credential-policy-name

Nombre de la directiva de credenciales del espacio de nombres de ADR.

Propiedad Valor
Grupo de parámetros: ADR Credential Policy Arguments
--device-id -d

Identificador de dispositivo registrado en IoT Hub.

--device-information --info

Información opcional del dispositivo.

--dps-name -n

Nombre o nombre de host del servicio Azure IoT Hub Device Provisioning. Obligatorio si no se proporciona --login.

Propiedad Valor
Grupo de parámetros: Device Provisioning Service Identifier Arguments
--edge-enabled --ee

Marca que indica la habilitación del borde.

Propiedad Valor
Valores aceptados: false, true
--ek --endorsement-key

Clave de aprobación de TPM para un dispositivo TPM.

--etag -e

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

--ih --iot-hubs

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.

Propiedad Valor
Grupo de parámetros: Allocation Policy Arguments
--initial-twin-properties --props

Propiedades iniciales del dispositivo gemelo.

--initial-twin-tags --tags

Etiquetas de dispositivo gemelo iniciales.

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

Propiedad Valor
Grupo de parámetros: Device Provisioning Service Identifier Arguments
--pk --primary-key

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

Propiedad Valor
Grupo de parámetros: Authentication Arguments
--provisioning-status --ps

Habilite o deshabilite la entrada de inscripción.

Propiedad Valor
Valores aceptados: disabled, enabled
--rc --remove-certificate

Marca para quitar el certificado principal actual.

Propiedad Valor
Grupo de parámetros: Authentication Arguments
Valores aceptados: false, true
--remove-secondary-certificate --rsc

Marca para quitar el certificado secundario actual.

Propiedad Valor
Grupo de parámetros: Authentication Arguments
Valores aceptados: false, true
--reprovision-policy --rp

Directiva para determinar cómo se deben controlar los datos del dispositivo al volver a aprovisionar en otra instancia de IoT Hub.

Propiedad Valor
Valores aceptados: never, reprovisionandmigratedata, reprovisionandresetdata
--resource-group -g

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

--scp --secondary-certificate-path

Ruta de acceso al archivo que contiene el certificado secundario.

Propiedad Valor
Grupo de parámetros: Authentication Arguments
--secondary-key --sk

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

Propiedad Valor
Grupo de parámetros: Authentication Arguments
--webhook-url --wh

La dirección URL del webhook de Azure Functions que se usa para las solicitudes de asignación personalizadas.

Propiedad Valor
Grupo de parámetros: Allocation Policy 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

Formato de salida.

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