Partager via

IoTHubRegistryManager Classe

  • Référence

Classe permettant de fournir des API pratiques pour les opérations IoTHub Registry Manager, basées sur les API REST IotHub générées automatiquement

Initialiseur pour un client du service Registry Manager.

Les utilisateurs ne doivent pas l’appeler directement. Au lieu de cela, ils doivent les méthodes d’usine from_connection_string() ou from_token_credential().

Après une création réussie, la classe a été authentifiée auprès d’IoTHub et elle est prête à appeler les API membres pour communiquer avec IoTHub.

Héritage
builtins.object
IoTHubRegistryManager

Constructeur

IoTHubRegistryManager(connection_string=None, host=None, token_credential=None)

Paramètres

Nom Description
connection_string
str

Chaîne de connexion IoTHub utilisée pour authentifier la connexion avec IoTHub si nous utilisons l’authentification connection_str. Valeur par défaut : Aucun

valeur par défaut: None
host
str

URL du service Azure si nous utilisons l’authentification par jeton. Valeur par défaut : Aucun

valeur par défaut: None
auth
Obligatoire
str

Objet d’authentification Azure si nous utilisons l’authentification par jeton. Valeur par défaut : Aucun
token_credential
valeur par défaut: None

Méthodes

bulk_create_or_update_devices

Créez, mettez à jour ou supprimez les identités de plusieurs appareils du registre d’identités IoTHub.

Créez, mettez à jour ou supprimez les identités de plusieurs appareils du registre d’identités IoTHub. Une identité d’appareil ne peut être spécifiée qu’une seule fois dans la liste. Différentes opérations (créer, mettre à jour, supprimer) sur différents appareils sont autorisées. Un maximum de 100 appareils peuvent être spécifiés par appel. Pour les opérations à grande échelle, envisagez d’utiliser la fonctionnalité d’importation à l’aide de blob storage(https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities).
create_device_with_certificate_authority

Crée une identité d’appareil sur IoTHub à l’aide de l’autorité de certification.
create_device_with_sas

Crée une identité d’appareil sur IoTHub à l’aide de l’authentification SAS.
create_device_with_x509

Crée une identité d’appareil sur IoTHub à l’aide de l’authentification X509.
create_module_with_certificate_authority

Crée une identité de module pour un appareil sur IoTHub à l’aide de l’autorité de certification.
create_module_with_sas

Crée une identité de module pour un appareil sur IoTHub à l’aide de l’authentification SAS.
create_module_with_x509

Crée une identité de module pour un appareil sur IoTHub à l’aide de l’authentification X509.
delete_device

Supprime une identité d’appareil d’IoTHub.
delete_module

Supprime une identité de module pour un appareil d’IoTHub.
from_connection_string

Initialiseur classmethod pour un client de service Registry Manager. Crée une classe Registry Manager à partir d’une chaîne de connexion.

Après une création réussie, la classe a été authentifiée auprès d’IoTHub et elle est prête à appeler les API membres pour communiquer avec IoTHub.
from_token_credential

Initialiseur classmethod pour un client de service Registry Manager. Crée une classe Registry Manager à partir de l’URL du nom d’hôte et des informations d’identification de jeton Azure.

Après une création réussie, la classe a été authentifiée auprès d’IoTHub et elle est prête à appeler les API membres pour communiquer avec IoTHub.
get_device

Récupère une identité d’appareil à partir d’IoTHub.
get_device_registry_statistics

Récupère les statistiques du registre d’appareils IoTHub.
get_devices

Obtenez les identités de plusieurs appareils à partir du registre d’identités IoTHub. Non recommandé. Utilisez le langage de requête IoTHub pour récupérer les informations de jumeau d’appareil et d’identité de l’appareil. Pour plus d'informations, consultez https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub et https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language.
get_module

Récupère une identité de module pour un appareil à partir d’IoTHub.
get_module_twin

Obtient un jumeau de module.
get_modules

Récupère toutes les identités de module sur un appareil.
get_service_statistics

Récupère les statistiques du service IoTHub.
get_twin

Obtient un jumeau d’appareil.
invoke_device_method

Appelez une méthode directe sur un appareil.
invoke_device_module_method

Appelez une méthode directe sur un appareil.
query_iot_hub

Interrogez un IoTHub pour récupérer des informations sur les jumeaux d’appareil à l’aide d’un langage de type SQL. Consultez la rubrique https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language (éventuellement en anglais) pour plus d'informations. La pagination des résultats est prise en charge. Cela retourne des informations sur les jumeaux d’appareil uniquement.
replace_module_twin

Remplace les balises et les propriétés souhaitées d’un jumeau de module.
replace_twin

Remplace les balises et les propriétés souhaitées d’un jumeau d’appareil.
send_c2d_message

Envoyer un message C2D à un appareil IoTHub.
update_device_with_certificate_authority

Mises à jour une identité d’appareil sur IoTHub à l’aide d’une autorité de certification.
update_device_with_sas

Mises à jour une identité d’appareil sur IoTHub à l’aide de l’authentification SAP.
update_device_with_x509

Mises à jour une identité d’appareil sur IoTHub à l’aide de l’authentification X509.
update_module_twin

Mises à jour balises et les propriétés souhaitées d’un jumeau de module.
update_module_with_certificate_authority

Mises à jour une identité de module pour un appareil sur IoTHub à l’aide d’une autorité de certification.
update_module_with_sas

Mises à jour une identité de module pour un appareil sur IoTHub à l’aide de l’authentification SAP.
update_module_with_x509

Mises à jour une identité de module pour un appareil sur IoTHub à l’aide de l’authentification X509.
update_twin

Mises à jour balises et les propriétés souhaitées d’un jumeau d’appareil.

bulk_create_or_update_devices

Créez, mettez à jour ou supprimez les identités de plusieurs appareils du registre d’identités IoTHub.

Créez, mettez à jour ou supprimez les identités de plusieurs appareils du registre d’identités IoTHub. Une identité d’appareil ne peut être spécifiée qu’une seule fois dans la liste. Différentes opérations (créer, mettre à jour, supprimer) sur différents appareils sont autorisées. Un maximum de 100 appareils peuvent être spécifiés par appel. Pour les opérations à grande échelle, envisagez d’utiliser la fonctionnalité d’importation à l’aide de blob storage(https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities).

bulk_create_or_update_devices(devices)

Paramètres

Nom Description
devices
Obligatoire
list[ExportImportDevice]

Liste des objets d’appareil sur lesquels opérer.

Retours

Type Description

Objet BulkRegistryOperationResult.

Exceptions

Type Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

create_device_with_certificate_authority

Crée une identité d’appareil sur IoTHub à l’aide de l’autorité de certification.

create_device_with_certificate_authority(device_id, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)

Paramètres

Nom Description
device_id
Obligatoire
str

Nom (Id) de l’appareil.
status
Obligatoire
str

État initial de l’appareil créé. (Valeurs possibles : « enabled » ou « disabled »).
iot_edge
bool

Indique si l’appareil créé est un appareil IoT Edge. Valeur par défaut : False

valeur par défaut: False
status_reason
str

Raison de l’identité de l’appareil status. Valeur par défaut : Aucun

valeur par défaut: None
device_scope
str

Portée de l’appareil. Valeur par défaut : Aucun Généré automatiquement et immuable pour les appareils de périphérie et modifiable dans les appareils feuille pour créer une relation enfant/parent. Pour les appareils feuilles, la valeur permettant de définir un périphérique de périphérie parent peut être récupérée à partir de la propriété device_scope de l’appareil de périphérie parent.

valeur par défaut: None
parent_scopes
Union[list[str], str]

Étendues des périphériques de niveau supérieur, le cas échéant. Valeur par défaut : Aucune Pour les appareils périphériques, la valeur permettant de définir un appareil de périphérie parent peut être récupérée à partir de la propriété device_scope de l’appareil de périphérie parent. Pour les appareils feuilles, cette valeur peut être définie sur la même valeur que device_scope ou être laissée au service à copier.

valeur par défaut: None

Retours

Type Description

Objet d’appareil contenant l’appareil créé.

Exceptions

Type Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

create_device_with_sas

Crée une identité d’appareil sur IoTHub à l’aide de l’authentification SAS.

create_device_with_sas(device_id, primary_key, secondary_key, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)

Paramètres

Nom Description
device_id
Obligatoire
str

Nom (Id) de l’appareil.
primary_key
Obligatoire
str

Clé d’authentification primaire.
secondary_key
Obligatoire
str

Clé d’authentification secondaire.
status
Obligatoire
str

État initial de l’appareil créé. (Valeurs possibles : « enabled » ou « disabled »)
iot_edge
bool

Indique si l’appareil créé est un appareil IoT Edge. Valeur par défaut : False

valeur par défaut: False
status_reason
str

Raison de l’identité de l’appareil status. Valeur par défaut : Aucun

valeur par défaut: None
device_scope
str

Portée de l’appareil. Valeur par défaut : Aucun Généré automatiquement et immuable pour les appareils de périphérie et modifiable dans les appareils feuille pour créer une relation enfant/parent. Pour les appareils feuilles, la valeur permettant de définir un périphérique de périphérie parent peut être récupérée à partir de la propriété device_scope de l’appareil de périphérie parent.

valeur par défaut: None
parent_scopes
Union[list[str], str]

Étendues des périphériques de niveau supérieur, le cas échéant. Valeur par défaut : Aucune Pour les appareils périphériques, la valeur permettant de définir un appareil de périphérie parent peut être récupérée à partir de la propriété device_scope de l’appareil de périphérie parent. Pour les appareils feuilles, cette valeur peut être définie sur la même valeur que device_scope ou être laissée au service à copier.

valeur par défaut: None

Retours

Type Description

Objet d’appareil contenant l’appareil créé.

Exceptions

Type Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

create_device_with_x509

Crée une identité d’appareil sur IoTHub à l’aide de l’authentification X509.

create_device_with_x509(device_id, primary_thumbprint, secondary_thumbprint, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)

Paramètres

Nom Description
device_id
Obligatoire
str

Nom (Id) de l’appareil.
primary_thumbprint
Obligatoire
str

Empreinte numérique X509 principale.
secondary_thumbprint
Obligatoire
str

Empreinte X509 secondaire.
status
Obligatoire
str

État initial de l’appareil créé. (Valeurs possibles : « enabled » ou « disabled »)
iot_edge
bool

Indique si l’appareil créé est un appareil IoT Edge. Valeur par défaut : False

valeur par défaut: False
status_reason
str

Raison de l’identité de l’appareil status. Valeur par défaut : Aucun

valeur par défaut: None
device_scope
str

Portée de l’appareil. Valeur par défaut : Aucun Généré automatiquement et immuable pour les appareils de périphérie et modifiable dans les appareils feuille pour créer une relation enfant/parent. Pour les appareils feuilles, la valeur permettant de définir un périphérique de périphérie parent peut être récupérée à partir de la propriété device_scope de l’appareil de périphérie parent.

valeur par défaut: None
parent_scopes
Union[list[str], str]

Étendues des périphériques de niveau supérieur, le cas échéant. Valeur par défaut : Aucune Pour les appareils périphériques, la valeur permettant de définir un appareil de périphérie parent peut être récupérée à partir de la propriété device_scope de l’appareil de périphérie parent. Pour les appareils feuilles, cette valeur peut être définie sur la même valeur que device_scope ou être laissée au service à copier.

valeur par défaut: None

Retours

Type Description

Objet d’appareil contenant l’appareil créé.

Exceptions

Type Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

create_module_with_certificate_authority

Crée une identité de module pour un appareil sur IoTHub à l’aide de l’autorité de certification.

create_module_with_certificate_authority(device_id, module_id, managed_by)

Paramètres

Nom Description
device_id
Obligatoire
str

Nom (Id) de l’appareil.
module_id
Obligatoire
str

Nom (Id) du module.
managed_by
Obligatoire
str

Nom de l’appareil de gestion (edge).

Retours

Type Description

Objet module contenant le module créé.

Exceptions

Type Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

create_module_with_sas

Crée une identité de module pour un appareil sur IoTHub à l’aide de l’authentification SAS.

create_module_with_sas(device_id, module_id, managed_by, primary_key, secondary_key)

Paramètres

Nom Description
device_id
Obligatoire
str

Nom (Id) de l’appareil.
module_id
Obligatoire
str

Nom (Id) du module.
managed_by
Obligatoire
str

Nom de l’appareil de gestion (edge).
primary_key
Obligatoire
str

Clé d’authentification primaire.
secondary_key
Obligatoire
str

Clé d’authentification secondaire.

Retours

Type Description

Objet module contenant le module créé.

Exceptions

Type Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

create_module_with_x509

Crée une identité de module pour un appareil sur IoTHub à l’aide de l’authentification X509.

create_module_with_x509(device_id, module_id, managed_by, primary_thumbprint, secondary_thumbprint)

Paramètres

Nom Description
device_id
Obligatoire
str

Nom (Id) de l’appareil.
module_id
Obligatoire
str

Nom (Id) du module.
managed_by
Obligatoire
str

Nom de l’appareil de gestion (edge).
primary_thumbprint
Obligatoire
str

Empreinte numérique X509 principale.
secondary_thumbprint
Obligatoire
str

Empreinte X509 secondaire.

Retours

Type Description

Objet module contenant le module créé.

Exceptions

Type Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

delete_device

Supprime une identité d’appareil d’IoTHub.

delete_device(device_id, etag=None)

Paramètres

Nom Description
device_id
Obligatoire
str

Nom (Id) de l’appareil.
etag
str

Valeur etag (if_match) à utiliser pour l’opération de suppression.

valeur par défaut: None

Retours

Type Description

Aucun.

Exceptions

Type Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

delete_module

Supprime une identité de module pour un appareil d’IoTHub.

delete_module(device_id, module_id, etag=None)

Paramètres

Nom Description
device_id
Obligatoire
str

Nom (Id) de l’appareil.
module_id
Obligatoire
str

Nom (Id) du module.
etag
str

Valeur etag (if_match) à utiliser pour l’opération de suppression.

valeur par défaut: None

Retours

Type Description

Aucun.

Exceptions

Type Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

from_connection_string

Initialiseur classmethod pour un client de service Registry Manager. Crée une classe Registry Manager à partir d’une chaîne de connexion.

Après une création réussie, la classe a été authentifiée auprès d’IoTHub et elle est prête à appeler les API membres pour communiquer avec IoTHub.

from_connection_string(connection_string)

Paramètres

Nom Description
connection_string
Obligatoire
str

Chaîne de connexion IoTHub utilisée pour authentifier la connexion avec IoTHub.

Retours

Type Description
IoTHubRegistryManager

Exceptions

Type Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

from_token_credential

Initialiseur classmethod pour un client de service Registry Manager. Crée une classe Registry Manager à partir de l’URL du nom d’hôte et des informations d’identification de jeton Azure.

Après une création réussie, la classe a été authentifiée auprès d’IoTHub et elle est prête à appeler les API membres pour communiquer avec IoTHub.

from_token_credential(url, token_credential)

Paramètres

Nom Description
url
Obligatoire
str

URL du service Azure (nom d’hôte).
token_credential
Obligatoire
<xref:azure.core.TokenCredential>

Objet d’informations d’identification de jeton Azure

Retours

Type Description
IoTHubRegistryManager

Exceptions

Type Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

get_device

Récupère une identité d’appareil à partir d’IoTHub.

get_device(device_id)

Paramètres

Nom Description
device_id
Obligatoire
str

Nom (ID) de l’appareil.

Retours

Type Description

Objet Device contenant l’appareil demandé.

Exceptions

Type Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

get_device_registry_statistics

Récupère les statistiques du registre d’appareils IoTHub.

get_device_registry_statistics()

Retours

Type Description

Objet RegistryStatistics.

Exceptions

Type Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

get_devices

Obtenez les identités de plusieurs appareils à partir du registre d’identités IoTHub. Non recommandé. Utilisez le langage de requête IoTHub pour récupérer les informations de jumeau d’appareil et d’identité de l’appareil. Pour plus d'informations, consultez https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub et https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language.

get_devices(max_number_of_devices=None)

Paramètres

Nom Description
max_number_of_devices
int

Ce paramètre, lorsqu’il est spécifié, définit le nombre maximal d’identités d’appareil retournées. Toute valeur située en dehors de la plage de 1 à 1000 est considérée comme 1000

valeur par défaut: None

Retours

Type Description

Liste des informations sur l’appareil.

Exceptions

Type Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

get_module

Récupère une identité de module pour un appareil à partir d’IoTHub.

get_module(device_id, module_id)

Paramètres

Nom Description
device_id
Obligatoire
str

Nom (ID) de l’appareil.
module_id
Obligatoire
str

Nom (ID) du module.

Retours

Type Description

Objet Module contenant le module demandé.

Exceptions

Type Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

get_module_twin

Obtient un jumeau de module.

get_module_twin(device_id, module_id)

Paramètres

Nom Description
device_id
Obligatoire
str

Nom (ID) de l’appareil.
module_id
Obligatoire
str

Nom (ID) du module.

Retours

Type Description

Objet Twin.

Exceptions

Type Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

get_modules

Récupère toutes les identités de module sur un appareil.

get_modules(device_id)

Paramètres

Nom Description
device_id
Obligatoire
str

Nom (ID) de l’appareil.

Retours

Type Description

Liste[Module] contenant tous les modules sur l’appareil.

Exceptions

Type Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

get_service_statistics

Récupère les statistiques du service IoTHub.

get_service_statistics()

Retours

Type Description

Objet ServiceStatistics.

Exceptions

Type Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

get_twin

Obtient un jumeau d’appareil.

get_twin(device_id)

Paramètres

Nom Description
device_id
Obligatoire
str

Nom (ID) de l’appareil.

Retours

Type Description

Objet Twin.

Exceptions

Type Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

invoke_device_method

Appelez une méthode directe sur un appareil.

invoke_device_method(device_id, direct_method_request)

Paramètres

Nom Description
device_id
Obligatoire
str

Nom (ID) de l’appareil.
direct_method_request
Obligatoire
CloudToDeviceMethod

Demande de méthode.

Retours

Type Description

Objet CloudToDeviceMethodResult.

Exceptions

Type Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

invoke_device_module_method

Appelez une méthode directe sur un appareil.

invoke_device_module_method(device_id, module_id, direct_method_request)

Paramètres

Nom Description
device_id
Obligatoire
str

Nom (ID) de l’appareil.
module_id
Obligatoire
str

Nom (ID) du module.
direct_method_request
Obligatoire
CloudToDeviceMethod

Demande de méthode.

Retours

Type Description

Objet CloudToDeviceMethodResult.

Exceptions

Type Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

query_iot_hub

Interrogez un IoTHub pour récupérer des informations sur les jumeaux d’appareil à l’aide d’un langage de type SQL. Consultez la rubrique https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language (éventuellement en anglais) pour plus d'informations. La pagination des résultats est prise en charge. Cela retourne des informations sur les jumeaux d’appareil uniquement.

query_iot_hub(query_specification, continuation_token=None, max_item_count=None)

Paramètres

Nom Description
query
Obligatoire
QuerySpecification

Spécification de requête.
continuation_token
str

Jeton de continuation pour la pagination

valeur par défaut: None
max_item_count
str

Nombre maximal de jumeaux d’appareil demandés

valeur par défaut: None
query_specification
Obligatoire

Retours

Type Description

Objet QueryResult.

Exceptions

Type Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

replace_module_twin

Remplace les balises et les propriétés souhaitées d’un jumeau de module.

replace_module_twin(device_id, module_id, module_twin, etag=None)

Paramètres

Nom Description
device_id
Obligatoire
str

Nom (ID) de l’appareil.
module_id
Obligatoire
str

Nom (ID) du module.
module_twin
Obligatoire
Twin

Informations de jumeau du module.
etag
str

Valeur etag (if_match) à utiliser pour l’opération de remplacement.

valeur par défaut: None

Retours

Type Description

Objet Twin.

Exceptions

Type Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

replace_twin

Remplace les balises et les propriétés souhaitées d’un jumeau d’appareil.

replace_twin(device_id, device_twin, etag=None)

Paramètres

Nom Description
device_id
Obligatoire
str

Nom (ID) de l’appareil.
device_twin
Obligatoire
Twin

Informations de jumeau de l’appareil.
etag
str

Valeur etag (if_match) à utiliser pour l’opération de remplacement.

valeur par défaut: None

Retours

Type Description

Objet Twin.

Exceptions

Type Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

send_c2d_message

Envoyer un message C2D à un appareil IoTHub.

send_c2d_message(device_id, message, properties={})

Paramètres

Nom Description
device_id
Obligatoire
str

Nom (ID) de l’appareil.
message
Obligatoire
str

Message à remettre à l’appareil.
properties
dict

Propriétés à envoyer avec le message. Peut contenir des propriétés d’application et des propriétés système

valeur par défaut: {}

Exceptions

Type Description
Exception if the Send command is not able to send the message

update_device_with_certificate_authority

Mises à jour une identité d’appareil sur IoTHub à l’aide d’une autorité de certification.

update_device_with_certificate_authority(device_id, etag, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)

Paramètres

Nom Description
device_id
Obligatoire
str

Nom (ID) de l’appareil.
etag
Obligatoire
str

Valeur etag (if_match) à utiliser pour l’opération de mise à jour.
status
Obligatoire
str

État initial de l’appareil créé. (Valeurs possibles : « enabled » ou « disabled »).
iot_edge
bool

Indique si l’appareil créé est ou non un appareil IoT Edge. Valeur par défaut : False

valeur par défaut: False
status_reason
str

Raison de l’status d’identité de l’appareil. Valeur par défaut : Aucun

valeur par défaut: None
device_scope
str

Portée de l’appareil. Valeur par défaut : Aucune généré automatiquement et immuable pour les appareils edge et modifiable dans les appareils feuilles pour créer une relation enfant/parent. Pour les appareils feuilles, la valeur permettant de définir un appareil edge parent peut être récupérée à partir de la propriété device_scope de l’appareil edge parent.

valeur par défaut: None
parent_scopes
Union[list[str], str]

Étendues des périphériques de niveau supérieur, le cas échéant. Valeur par défaut : Aucune Pour les appareils edge, la valeur permettant de définir un appareil edge parent peut être récupérée à partir de la propriété device_scope de l’appareil edge parent. Pour les appareils feuilles, cette valeur peut être définie sur la même valeur que device_scope ou être laissée au service à copier.

valeur par défaut: None

Retours

Type Description

Objet Device mis à jour contenant l’appareil créé.

Exceptions

Type Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

update_device_with_sas

Mises à jour une identité d’appareil sur IoTHub à l’aide de l’authentification SAP.

update_device_with_sas(device_id, etag, primary_key, secondary_key, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)

Paramètres

Nom Description
device_id
Obligatoire
str

Nom (ID) de l’appareil.
etag
Obligatoire
str

Valeur etag (if_match) à utiliser pour l’opération de mise à jour.
primary_key
Obligatoire
str

Clé d’authentification primaire.
secondary_key
Obligatoire
str

Clé d’authentification secondaire.
status
Obligatoire
str

État initial de l’appareil créé. (Valeurs possibles : « enabled » ou « disabled »).
iot_edge
bool

Indique si l’appareil créé est ou non un appareil IoT Edge. Valeur par défaut : False

valeur par défaut: False
status_reason
str

Raison de l’status d’identité de l’appareil. Valeur par défaut : Aucun

valeur par défaut: None
device_scope
str

Portée de l’appareil. Valeur par défaut : Aucune généré automatiquement et immuable pour les appareils edge et modifiable dans les appareils feuilles pour créer une relation enfant/parent. Pour les appareils feuilles, la valeur permettant de définir un appareil edge parent peut être récupérée à partir de la propriété device_scope de l’appareil edge parent.

valeur par défaut: None
parent_scopes
Union[list[str], str]

Étendues des périphériques de niveau supérieur, le cas échéant. Valeur par défaut : Aucune Pour les appareils edge, la valeur permettant de définir un appareil edge parent peut être récupérée à partir de la propriété device_scope de l’appareil edge parent. Pour les appareils feuilles, cette valeur peut être définie sur la même valeur que device_scope ou être laissée au service à copier.

valeur par défaut: None

Retours

Type Description

Objet Device mis à jour contenant l’appareil créé.

Exceptions

Type Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

update_device_with_x509

Mises à jour une identité d’appareil sur IoTHub à l’aide de l’authentification X509.

update_device_with_x509(device_id, etag, primary_thumbprint, secondary_thumbprint, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)

Paramètres

Nom Description
device_id
Obligatoire
str

Nom (ID) de l’appareil.
etag
Obligatoire
str

Valeur etag (if_match) à utiliser pour l’opération de mise à jour.
primary_thumbprint
Obligatoire
str

Empreinte X509 principale.
secondary_thumbprint
Obligatoire
str

Empreinte X509 secondaire.
status
Obligatoire
str

État initial de l’appareil créé. (Valeurs possibles : « enabled » ou « disabled »).
iot_edge
bool

Indique si l’appareil créé est ou non un appareil IoT Edge. Valeur par défaut : False

valeur par défaut: False
status_reason
str

Raison de l’status d’identité de l’appareil. Valeur par défaut : Aucun

valeur par défaut: None
device_scope
str

Portée de l’appareil. Valeur par défaut : Aucune généré automatiquement et immuable pour les appareils edge et modifiable dans les appareils feuilles pour créer une relation enfant/parent. Pour les appareils feuilles, la valeur permettant de définir un appareil edge parent peut être récupérée à partir de la propriété device_scope de l’appareil edge parent.

valeur par défaut: None
parent_scopes
Union[list[str], str]

Étendues des périphériques de niveau supérieur, le cas échéant. Valeur par défaut : Aucune Pour les appareils edge, la valeur permettant de définir un appareil edge parent peut être récupérée à partir de la propriété device_scope de l’appareil edge parent. Pour les appareils feuilles, cette valeur peut être définie sur la même valeur que device_scope ou être laissée au service à copier.

valeur par défaut: None

Retours

Type Description

Objet Device mis à jour contenant l’appareil créé.

Exceptions

Type Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

update_module_twin

Mises à jour balises et les propriétés souhaitées d’un jumeau de module.

update_module_twin(device_id, module_id, module_twin, etag=None)

Paramètres

Nom Description
device_id
Obligatoire
str

Nom (ID) de l’appareil.
module_id
Obligatoire
str

Nom (ID) du module.
module_twin
Obligatoire
Twin

Informations de jumeau du module.
etag
str

Valeur etag (if_match) à utiliser pour l’opération de mise à jour.

valeur par défaut: None

Retours

Type Description

Objet Twin.

Exceptions

Type Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

update_module_with_certificate_authority

Mises à jour une identité de module pour un appareil sur IoTHub à l’aide d’une autorité de certification.

update_module_with_certificate_authority(device_id, module_id, managed_by, etag)

Paramètres

Nom Description
device_id
Obligatoire
str

Nom (ID) de l’appareil.
module_id
Obligatoire
str

Nom (ID) du module.
managed_by
Obligatoire
str

Nom de l’appareil de gestionnaire (edge).
etag
Obligatoire
str

Valeur etag (if_match) à utiliser pour l’opération de mise à jour.

Retours

Type Description

Objet Module mis à jour contenant le module créé.

Exceptions

Type Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

update_module_with_sas

Mises à jour une identité de module pour un appareil sur IoTHub à l’aide de l’authentification SAP.

update_module_with_sas(device_id, module_id, managed_by, etag, primary_key, secondary_key)

Paramètres

Nom Description
device_id
Obligatoire
str

Nom (ID) de l’appareil.
module_id
Obligatoire
str

Nom (ID) du module.
managed_by
Obligatoire
str

Nom de l’appareil de gestionnaire (edge).
etag
Obligatoire
str

Valeur etag (if_match) à utiliser pour l’opération de mise à jour.
primary_key
Obligatoire
str

Clé d’authentification primaire.
secondary_key
Obligatoire
str

Clé d’authentification secondaire.

Retours

Type Description

Objet Module mis à jour contenant le module créé.

Exceptions

Type Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

update_module_with_x509

Mises à jour une identité de module pour un appareil sur IoTHub à l’aide de l’authentification X509.

update_module_with_x509(device_id, module_id, managed_by, etag, primary_thumbprint, secondary_thumbprint)

Paramètres

Nom Description
device_id
Obligatoire
str

Nom (ID) de l’appareil.
module_id
Obligatoire
str

Nom (ID) du module.
managed_by
Obligatoire
str

Nom de l’appareil de gestionnaire (edge).
etag
Obligatoire
str

Valeur etag (if_match) à utiliser pour l’opération de mise à jour.
primary_thumbprint
Obligatoire
str

Empreinte X509 principale.
secondary_thumbprint
Obligatoire
str

Empreinte X509 secondaire.

Retours

Type Description

Objet Module mis à jour contenant le module créé.

Exceptions

Type Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

update_twin

Mises à jour balises et les propriétés souhaitées d’un jumeau d’appareil.

update_twin(device_id, device_twin, etag=None)

Paramètres

Nom Description
device_id
Obligatoire
str

Nom (ID) de l’appareil.
device_twin
Obligatoire
Twin

Informations de jumeau de l’appareil.
etag
str

Valeur etag (if_match) à utiliser pour l’opération de mise à jour.

valeur par défaut: None

Retours

Type Description

Objet Twin.

Exceptions

Type Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>