ProvisioningDeviceClient Classe

Client qui peut être utilisé pour exécuter l’inscription d’un appareil auprès du service d’approvisionnement à l’aide de la clé symétrique ou de l’authentification X509.

Initialise le client d’approvisionnement.

REMARQUE : Cet initialiseur ne doit pas être appelé directement. Au lieu de cela, les méthodes de classe qui commencent par create_from_ doivent être utilisées pour créer un objet client.

Héritage

azure.iot.device.provisioning.abstract_provisioning_device_client.AbstractProvisioningDeviceClient

ProvisioningDeviceClient

Constructeur

ProvisioningDeviceClient(pipeline)

Paramètres

Nom	Description
pipeline Obligatoire	<xref:azure.iot.device.provisioning.pipeline.MQTTPipeline> Instance de l’objet de pipeline d’approvisionnement.

Méthodes

create_from_symmetric_key	Créez un client qui peut être utilisé pour exécuter l’inscription d’un appareil auprès du service d’approvisionnement à l’aide de l’authentification par clé symétrique.
create_from_x509_certificate	Créez un client qui peut être utilisé pour exécuter l’inscription d’un appareil avec le service d’approvisionnement à l’aide de l’authentification par certificat X509.
register	Inscrire l’appareil auprès du service d’approvisionnement Il s’agit d’un appel synchrone, ce qui signifie que cette fonction ne retourne pas tant que le processus d’inscription n’est pas terminé ou que la tentative n’a pas abouti à un échec. Avant de revenir, le client se déconnecte également du service d’approvisionnement. Si une tentative d’inscription est effectuée alors qu’une inscription précédente est en cours, elle peut générer une erreur. Une fois l’appareil inscrit, le client n’est plus opérable.

create_from_symmetric_key

Créez un client qui peut être utilisé pour exécuter l’inscription d’un appareil auprès du service d’approvisionnement à l’aide de l’authentification par clé symétrique.

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

Paramètres

Nom	Description
provisioning_host Obligatoire	str Hôte exécutant le service Device Provisioning. Vous trouverez la Portail Azure sous l’onglet Vue d’ensemble en tant que chaîne Point de terminaison d’appareil global.
registration_id Obligatoire	str ID d’inscription utilisé pour identifier de manière unique un appareil dans le service Device Provisioning. L’ID d’inscription est alphanumérique, une chaîne minuscule et peut contenir des traits d’union.
id_scope Obligatoire	str Étendue de l’ID utilisée pour identifier de manière unique le service d’approvisionnement spécifique par lequel l’appareil s’inscrit. L’étendue de l’ID est affectée à un service Device Provisioning lorsqu’il est créé par l’utilisateur, qu’il est généré par le service et qu’il est immuable, ce qui garantit l’unicité.
symmetric_key Obligatoire	str Clé qui sera utilisée pour créer le jeton de signature d’accès partagé afin d’authentifier l’appareil auprès du service Device Provisioning. Par défaut, le service Device Provisioning crée des clés symétriques avec une longueur par défaut de 32 octets quand de nouvelles inscriptions sont enregistrées avec l’option Générer automatiquement les clés activée. Les utilisateurs peuvent fournir leurs propres clés symétriques pour les inscriptions en désactivant cette option dans les 16 octets et 64 octets et dans un format Base64 valide.
server_verification_cert Obligatoire	str Option de configuration. Chaîne de certificats approuvée. Nécessaire lors de l’utilisation de la connexion à un point de terminaison qui a une racine d’approbation non standard, telle qu’une passerelle de protocole.
gateway_hostname Obligatoire	str Option de configuration. Nom d’hôte de la passerelle pour l’appareil de passerelle.
websockets Obligatoire	bool Option de configuration. La valeur par défaut est FALSE. Définissez sur true si vous utilisez MQTT sur des websockets.
cipher Obligatoire	str ou list(str) Option de configuration. Suite de chiffrement pour TLS/SSL, sous forme de chaîne au « format de liste de chiffrement OpenSSL » ou de liste de chaînes de suite de chiffrement.
proxy_options Obligatoire	ProxyOptions Options d’envoi du trafic via des serveurs proxy.
keepalive Obligatoire	int Période maximale en secondes entre les communications avec le répartiteur. Si aucun autre message n’est échangé, cela contrôle la vitesse à laquelle le client envoie des messages ping au répartiteur. S’il n’est pas fourni, la valeur par défaut de 60 secondes est utilisée.

Retours

Type	Description
	ProvisioningDeviceClient instance qui peut s’inscrire via une clé symétrique.

Exceptions

Type	Description
TypeError if given an unrecognized parameter.

create_from_x509_certificate

Créez un client qui peut être utilisé pour exécuter l’inscription d’un appareil avec le service d’approvisionnement à l’aide de l’authentification par certificat X509.

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

Paramètres

Nom	Description
provisioning_host Obligatoire	str Hôte exécutant le service Device Provisioning. Vous trouverez la Portail Azure sous l’onglet Vue d’ensemble en tant que chaîne Point de terminaison d’appareil global.
registration_id Obligatoire	str ID d’inscription utilisé pour identifier de manière unique un appareil dans le service Device Provisioning. L’ID d’inscription est alphanumérique, une chaîne minuscule et peut contenir des traits d’union.
id_scope Obligatoire	str L’étendue de l’ID est utilisée pour identifier de manière unique le service d’approvisionnement spécifique par lequel l’appareil s’inscrit. L’étendue de l’ID est affectée à un service Device Provisioning lorsqu’il est créé par l’utilisateur, qu’il est généré par le service et qu’il est immuable, ce qui garantit l’unicité.
x509 Obligatoire	X509 Le certificat x509, Pour utiliser le certificat, l’objet d’inscription doit contenir le certificat (le certificat racine ou l’un des certificats d’autorité de certification intermédiaires). Si le certificat provient d’un fichier CER, il doit être encodé en base64.
server_verification_cert Obligatoire	str Option de configuration. Chaîne de certificats approuvée. Nécessaire lors de l’utilisation de la connexion à un point de terminaison qui a une racine d’approbation non standard, telle qu’une passerelle de protocole.
gateway_hostname Obligatoire	str Option de configuration. Nom d’hôte de la passerelle pour l’appareil de passerelle.
websockets Obligatoire	bool Option de configuration. La valeur par défaut est FALSE. Définissez sur true si vous utilisez MQTT sur des websockets.
cipher Obligatoire	str ou list(str) Option de configuration. Suite de chiffrement pour TLS/SSL, sous forme de chaîne au « format de liste de chiffrement OpenSSL » ou de liste de chaînes de suite de chiffrement.
proxy_options Obligatoire	ProxyOptions Options d’envoi du trafic via des serveurs proxy.
keepalive Obligatoire	int Période maximale en secondes entre les communications avec le répartiteur. Si aucun autre message n’est échangé, cela contrôle la vitesse à laquelle le client envoie des messages ping au répartiteur. S’il n’est pas fourni, la valeur par défaut de 60 secondes est utilisée.

Retours

Type	Description
	ProvisioningDeviceClient qui peut s’inscrire via des certificats clients X509.

Exceptions

Type	Description
TypeError if given an unrecognized parameter.

register

Inscrire l’appareil auprès du service d’approvisionnement

Il s’agit d’un appel synchrone, ce qui signifie que cette fonction ne retourne pas tant que le processus d’inscription n’est pas terminé ou que la tentative n’a pas abouti à un échec. Avant de revenir, le client se déconnecte également du service d’approvisionnement. Si une tentative d’inscription est effectuée alors qu’une inscription précédente est en cours, elle peut générer une erreur.

Une fois l’appareil inscrit, le client n’est plus opérable.

register()

Retours

Type	Description
RegistrationResult	RegistrationResult indiquant le résultat de l’inscription.

Exceptions

Type	Description
CredentialError	si les informations d’identification ne sont pas valides et qu’une connexion ne peut pas être établie.
ConnectionFailedError	si l’établissement d’une connexion entraîne un échec.
ConnectionDroppedError	si la connexion est perdue pendant l’exécution.
OperationTimeout	si la connexion expire.
ClientError	en cas de défaillance inattendue lors de l’exécution.

Attributs

provisioning_payload