IoTHubConfigurationManager Classe

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

Initialiseur pour un client Configuration Manager Service.

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

IoTHubConfigurationManager

Constructeur

IoTHubConfigurationManager(connection_string=None, host=None, auth=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 des informations d’identification de jeton. Valeur par défaut : Aucun valeur par défaut: None
auth	str Objet d’authentification Azure si nous utilisons l’authentification des informations d’identification de jeton. Valeur par défaut : Aucun valeur par défaut: None

Méthodes

apply_configuration_on_edge_device	Applique le contenu de configuration fourni à l’appareil edge spécifié. Le contenu des modules est obligatoire.
create_configuration	Crée une configuration pour les appareils ou modules d’un IoTHub.
delete_configuration	Supprime une configuration d’un IoTHub.
from_connection_string	Initialiseur classmethod pour un client du service IoTHubConfigurationManager. Crée la classe IoTHubConfigurationManager à partir de la 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 du service IoTHubConfigurationManager. Crée la classe IoTHubConfigurationManager à 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_configuration	Récupère la configuration IoTHub pour un appareil particulier.
get_configurations	Récupère plusieurs configurations pour l’appareil et les modules d’un IoTHub. Retourne le nombre spécifié de configurations. La pagination n’est pas prise en charge.
test_configuration_queries	Valide la requête de condition cible et les requêtes de métrique personnalisées pour une configuration.
update_configuration	Mises à jour une configuration pour les appareils ou modules d’un IoTHub. Remarque : l’ID de configuration et le contenu ne peuvent pas être mis à jour par l’utilisateur.

apply_configuration_on_edge_device

Applique le contenu de configuration fourni à l’appareil edge spécifié. Le contenu des modules est obligatoire.

apply_configuration_on_edge_device(device_id, configuration_content)

Paramètres

Nom	Description
configuration_content Obligatoire	ConfigurationContent Nom (ID) de l’appareil edge.
device_id Obligatoire

Retours

Type	Description
	Objet.

Exceptions

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

create_configuration

Crée une configuration pour les appareils ou modules d’un IoTHub.

create_configuration(configuration)

Paramètres

Nom	Description
configuration_id Obligatoire	str ID de la configuration.
configuration Obligatoire	Configuration Configuration à créer.

Retours

Type	Description
	Objet de configuration contenant la configuration créée.

Exceptions

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

delete_configuration

Supprime une configuration d’un IoTHub.

delete_configuration(configuration_id, etag=None)

Paramètres

Nom	Description
configuration_id Obligatoire	str ID de la configuration.
configuration Obligatoire	Configuration Configuration à créer.
etag	str Valeur etag (if_match) à utiliser pour l’opération de suppression. valeur par défaut: None

Retours

Type	Description
	Objet de configuration contenant la configuration mise à jour.

Exceptions

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

from_connection_string

Initialiseur classmethod pour un client du service IoTHubConfigurationManager. Crée la classe IoTHubConfigurationManager à partir de la 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
IoTHubConfigurationManager

Exceptions

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

from_token_credential

Initialiseur classmethod pour un client du service IoTHubConfigurationManager. Crée la classe IoTHubConfigurationManager à 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
IoTHubConfigurationManager

Exceptions

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

get_configuration

Récupère la configuration IoTHub pour un appareil particulier.

get_configuration(configuration_id)

Paramètres

Nom	Description
configuration_id Obligatoire	str ID de la configuration.

Retours

Type	Description
	Objet Configuration.

Exceptions

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

get_configurations

Récupère plusieurs configurations pour l’appareil et les modules d’un IoTHub. Retourne le nombre spécifié de configurations. La pagination n’est pas prise en charge.

get_configurations(max_count=None)

Paramètres

Nom	Description
max_count	int Nombre maximal de configurations demandées. valeur par défaut: None

Retours

Type	Description
	Objet list[Configuration].

Exceptions

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

test_configuration_queries

Valide la requête de condition cible et les requêtes de métrique personnalisées pour une configuration.

test_configuration_queries(configuration_queries_test_input)

Paramètres

Nom	Description
configuration_queries_test_input Obligatoire	ConfigurationQueriesTestInput Entrée de test des requêtes.

Retours

Type	Description
	Objet ConfigurationQueriesTestResponse.

Exceptions

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

update_configuration

Mises à jour une configuration pour les appareils ou modules d’un IoTHub. Remarque : l’ID de configuration et le contenu ne peuvent pas être mis à jour par l’utilisateur.

update_configuration(configuration, etag)

Paramètres

Nom	Description
configuration_id Obligatoire	str ID de la configuration.
configuration Obligatoire	Configuration La configuration contient la configuration mise à jour.
etag Obligatoire	str Valeur etag (if_match) à utiliser pour l’opération de mise à jour.

Retours

Type	Description
	Objet de configuration contenant la configuration mise à jour.

Exceptions

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