ProvisioningDeviceClient Clase

Cliente que se puede usar para ejecutar el registro de un dispositivo con el servicio de aprovisionamiento mediante la autenticación Symmetric Key o X509.

Inicializa el cliente de aprovisionamiento.

NOTA: Este inicializador no debe llamarse directamente. En su lugar, los métodos de clase que comienzan por create_from_ deben usarse para crear un objeto de cliente.

Herencia

azure.iot.device.provisioning.abstract_provisioning_device_client.AbstractProvisioningDeviceClient

ProvisioningDeviceClient

Constructor

ProvisioningDeviceClient(pipeline)

Parámetros

Nombre	Description
pipeline Requerido	<xref:azure.iot.device.provisioning.pipeline.MQTTPipeline> Instancia del objeto de canalización de aprovisionamiento.

Métodos

create_from_symmetric_key	Cree un cliente que se pueda usar para ejecutar el registro de un dispositivo con el servicio de aprovisionamiento mediante la autenticación de clave simétrica.
create_from_x509_certificate	Cree un cliente que se pueda usar para ejecutar el registro de un dispositivo con el servicio de aprovisionamiento mediante la autenticación de certificados X509.
register	Registro del dispositivo con el servicio de aprovisionamiento Se trata de una llamada sincrónica, lo que significa que esta función no devolverá hasta que el proceso de registro se haya completado correctamente o el intento haya provocado un error. Antes de devolverlo, el cliente también se desconectará del servicio de aprovisionamiento. Si se realiza un intento de registro mientras un registro anterior está en curso, puede producir un error. Una vez que el dispositivo se haya registrado correctamente, el cliente ya no será operable.

create_from_symmetric_key

Cree un cliente que se pueda usar para ejecutar el registro de un dispositivo con el servicio de aprovisionamiento mediante la autenticación de clave simétrica.

create_from_symmetric_key(provisioning_host, registration_id, id_scope, symmetric_key, **kwargs)

Parámetros

Nombre	Description
provisioning_host Requerido	str Host que ejecuta Device Provisioning Service. Puede encontrarse en el Azure Portal de la pestaña Información general como la cadena Punto de conexión del dispositivo global.
registration_id Requerido	str Identificador de registro que se usa para identificar de forma única un dispositivo en device Provisioning Service. El identificador de registro es una cadena alfanumérica y minúscula y puede contener guiones.
id_scope Requerido	str Ámbito de identificador que se usa para identificar de forma única el servicio de aprovisionamiento específico mediante el que se registrará el dispositivo. El ámbito de identificador se asigna a un servicio Device Provisioning cuando el usuario lo crea y lo genera el servicio y es inmutable y garantiza la unicidad.
symmetric_key Requerido	str Clave que se usará para crear el token de firma de acceso compartido para autenticar el dispositivo con device Provisioning Service. De forma predeterminada, el servicio Device Provisioning crea nuevas claves simétricas con una longitud predeterminada de 32 bytes cuando se guardan nuevas inscripciones con la opción Generar claves automáticamente habilitada. Los usuarios pueden proporcionar sus propias claves simétricas para las inscripciones deshabilitando esta opción en 16 bytes y 64 bytes y en formato Base64 válido.
server_verification_cert Requerido	str Opción de configuración. Cadena de certificados de confianza. Necesario al usar la conexión a un punto de conexión que tiene una raíz de confianza no estándar, como una puerta de enlace de protocolo.
gateway_hostname Requerido	str Opción de configuración. Nombre de host de puerta de enlace para el dispositivo de puerta de enlace.
websockets Requerido	bool Opción de configuración. El valor predeterminado es False. Se establece en true si se usa MQTT sobre websockets.
cipher Requerido	str o list(str) Opción de configuración. Conjuntos de cifrado para TLS/SSL, como una cadena en "Formato de lista de cifrado OpenSSL" o como una lista de cadenas del conjunto de cifrado.
proxy_options Requerido	ProxyOptions Opciones para enviar tráfico a través de servidores proxy.
keepalive Requerido	int Período máximo en segundos entre las comunicaciones con el agente. Si no se intercambia ningún otro mensaje, controla la velocidad a la que el cliente enviará mensajes ping al agente. Si no se proporciona el valor predeterminado de 60 segundos, se usará .

Devoluciones

Tipo	Description
	Una instancia provisioningDeviceClient que se puede registrar a través de la clave simétrica.

Excepciones

Tipo	Description
TypeError if given an unrecognized parameter.

create_from_x509_certificate

Cree un cliente que se pueda usar para ejecutar el registro de un dispositivo con el servicio de aprovisionamiento mediante la autenticación de certificados X509.

create_from_x509_certificate(provisioning_host, registration_id, id_scope, x509, **kwargs)

Parámetros

Nombre	Description
provisioning_host Requerido	str Host que ejecuta Device Provisioning Service. Puede encontrarse en el Azure Portal de la pestaña Información general como la cadena Punto de conexión del dispositivo global.
registration_id Requerido	str Identificador de registro que se usa para identificar de forma única un dispositivo en device Provisioning Service. El identificador de registro es una cadena alfanumérica y minúscula y puede contener guiones.
id_scope Requerido	str El ámbito de identificador se usa para identificar de forma única el servicio de aprovisionamiento específico que registrará el dispositivo. El ámbito de identificador se asigna a un servicio Device Provisioning cuando el usuario lo crea y lo genera el servicio y es inmutable y garantiza la unicidad.
x509 Requerido	X509 El certificado x509, para usar el certificado que el objeto de inscripción debe contener el certificado (el certificado raíz o uno de los certificados de CA intermedios). Si el certificado procede de un archivo CER, debe estar codificado en base64.
server_verification_cert Requerido	str Opción de configuración. Cadena de certificados de confianza. Necesario al usar la conexión a un punto de conexión que tiene una raíz de confianza no estándar, como una puerta de enlace de protocolo.
gateway_hostname Requerido	str Opción de configuración. Nombre de host de puerta de enlace para el dispositivo de puerta de enlace.
websockets Requerido	bool Opción de configuración. El valor predeterminado es False. Se establece en true si se usa MQTT sobre websockets.
cipher Requerido	str o list(str) Opción de configuración. Conjuntos de cifrado para TLS/SSL, como una cadena en "Formato de lista de cifrado OpenSSL" o como una lista de cadenas del conjunto de cifrado.
proxy_options Requerido	ProxyOptions Opciones para enviar tráfico a través de servidores proxy.
keepalive Requerido	int Período máximo en segundos entre las comunicaciones con el agente. Si no se intercambia ningún otro mensaje, controla la velocidad a la que el cliente enviará mensajes ping al agente. Si no se proporciona el valor predeterminado de 60 segundos, se usará .

Devoluciones

Tipo	Description
	ProvisioningDeviceClient que puede registrarse a través de certificados de cliente X509.

Excepciones

Tipo	Description
TypeError if given an unrecognized parameter.

register

Registro del dispositivo con el servicio de aprovisionamiento

Se trata de una llamada sincrónica, lo que significa que esta función no devolverá hasta que el proceso de registro se haya completado correctamente o el intento haya provocado un error. Antes de devolverlo, el cliente también se desconectará del servicio de aprovisionamiento. Si se realiza un intento de registro mientras un registro anterior está en curso, puede producir un error.

Una vez que el dispositivo se haya registrado correctamente, el cliente ya no será operable.

register()

Devoluciones

Tipo	Description
RegistrationResult	RegistrationResult que indica el resultado del registro.

Excepciones

Tipo	Description
CredentialError	si las credenciales no son válidas y no se puede establecer una conexión.
ConnectionFailedError	si se establece una conexión, se produce un error.
ConnectionDroppedError	si se pierde la conexión durante la ejecución.
OperationTimeout	si se agota el tiempo de espera de la conexión.
ClientError	si se produce un error inesperado durante la ejecución.

Atributos

provisioning_payload