Dela via

IoTHubConfigurationManager Klass

  • Referens

En klass för att tillhandahålla bekvämlighets-API:er för IoTHub-Configuration Manager åtgärder, baserat på de automatiskt genererade IotHub REST-API:erna

Initierare för en Configuration Manager Service-klient.

När klassen har skapats har den autentiserats med IoTHub och är redo att anropa medlems-API:erna för att kommunicera med IoTHub.

Arv
builtins.object
IoTHubConfigurationManager

Konstruktor

IoTHubConfigurationManager(connection_string=None, host=None, auth=None)

Parametrar

Name Description
connection_string
str

IoTHub-anslutningssträngen som används för att autentisera anslutningen med IoTHub om vi använder connection_str autentisering. Standardvärde: Ingen

standardvärde: None
host
str

Azure-tjänstens URL om vi använder autentisering med tokenautentiseringsuppgifter. Standardvärde: Ingen

standardvärde: None
auth
str

Azure-autentiseringsobjektet om vi använder autentisering med tokenautentiseringsuppgifter. Standardvärde: Ingen

standardvärde: None

Metoder

apply_configuration_on_edge_device

Tillämpar det angivna konfigurationsinnehållet på den angivna gränsenheten. Modulinnehåll är obligatoriskt.
create_configuration

Skapar en konfiguration för enheter eller moduler i en IoTHub.
delete_configuration

Tar bort en konfiguration från en IoTHub.
from_connection_string

Classmethod-initierare för en IoTHubConfigurationManager Service-klient. Skapar IoTHubConfigurationManager-klassen från anslutningssträngen.

När klassen har skapats har den autentiserats med IoTHub och är redo att anropa medlems-API:erna för att kommunicera med IoTHub.
from_token_credential

Classmethod-initierare för en IoTHubConfigurationManager Service-klient. Skapar IoTHubConfigurationManager-klassen från värdnamns-URL och autentiseringsuppgifter för Azure-token.

När klassen har skapats har den autentiserats med IoTHub och är redo att anropa medlems-API:erna för att kommunicera med IoTHub.
get_configuration

Hämtar IoTHub-konfigurationen för en viss enhet.
get_configurations

Hämtar flera konfigurationer för enheter och moduler i en IoTHub. Returnerar det angivna antalet konfigurationer. Sidnumrering stöds inte.
test_configuration_queries

Validerar målvillkorsfrågan och anpassade måttfrågor för en konfiguration.
update_configuration

Uppdateringar en konfiguration för enheter eller moduler på en IoTHub. Obs! Konfigurations-ID och Innehåll kan inte uppdateras av användaren.

apply_configuration_on_edge_device

Tillämpar det angivna konfigurationsinnehållet på den angivna gränsenheten. Modulinnehåll är obligatoriskt.

apply_configuration_on_edge_device(device_id, configuration_content)

Parametrar

Name Description
configuration_content
Obligatorisk
ConfigurationContent

Namnet (ID) på gränsenheten.
device_id
Obligatorisk

Returer

Typ Description

Ett objekt.

Undantag

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

create_configuration

Skapar en konfiguration för enheter eller moduler i en IoTHub.

create_configuration(configuration)

Parametrar

Name Description
configuration_id
Obligatorisk
str

ID:t för konfigurationen.
configuration
Obligatorisk
Configuration

Konfigurationen som ska skapas.

Returer

Typ Description

Konfigurationsobjekt som innehåller den skapade konfigurationen.

Undantag

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

delete_configuration

Tar bort en konfiguration från en IoTHub.

delete_configuration(configuration_id, etag=None)

Parametrar

Name Description
configuration_id
Obligatorisk
str

ID:t för konfigurationen.
configuration
Obligatorisk
Configuration

Konfigurationen som ska skapas.
etag
str

Etag-värdet (if_match) som ska användas för borttagningsåtgärden.

standardvärde: None

Returer

Typ Description

Konfigurationsobjekt som innehåller den uppdaterade konfigurationen.

Undantag

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

from_connection_string

Classmethod-initierare för en IoTHubConfigurationManager Service-klient. Skapar IoTHubConfigurationManager-klassen från anslutningssträngen.

När klassen har skapats har den autentiserats med IoTHub och är redo att anropa medlems-API:erna för att kommunicera med IoTHub.

from_connection_string(connection_string)

Parametrar

Name Description
connection_string
Obligatorisk
str

IoTHub-anslutningssträngen som används för att autentisera anslutningen till IoTHub.

Returer

Typ Description
IoTHubConfigurationManager

Undantag

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

from_token_credential

Classmethod-initierare för en IoTHubConfigurationManager Service-klient. Skapar IoTHubConfigurationManager-klassen från värdnamns-URL och autentiseringsuppgifter för Azure-token.

När klassen har skapats har den autentiserats med IoTHub och är redo att anropa medlems-API:erna för att kommunicera med IoTHub.

from_token_credential(url, token_credential)

Parametrar

Name Description
url
Obligatorisk
str

Azure-tjänstens URL (värdnamn).
token_credential
Obligatorisk
<xref:azure.core.TokenCredential>

Autentiseringsobjektet för Azure-token

Returer

Typ Description
IoTHubConfigurationManager

Undantag

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

get_configuration

Hämtar IoTHub-konfigurationen för en viss enhet.

get_configuration(configuration_id)

Parametrar

Name Description
configuration_id
Obligatorisk
str

ID:t för konfigurationen.

Returer

Typ Description

Konfigurationsobjektet.

Undantag

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

get_configurations

Hämtar flera konfigurationer för enheter och moduler i en IoTHub. Returnerar det angivna antalet konfigurationer. Sidnumrering stöds inte.

get_configurations(max_count=None)

Parametrar

Name Description
max_count
int

Det maximala antalet konfigurationer som begärs.

standardvärde: None

Returer

Typ Description

List[Configuration]-objektet.

Undantag

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

test_configuration_queries

Validerar målvillkorsfrågan och anpassade måttfrågor för en konfiguration.

test_configuration_queries(configuration_queries_test_input)

Parametrar

Name Description
configuration_queries_test_input
Obligatorisk
ConfigurationQueriesTestInput

Frågorna testar indata.

Returer

Typ Description

ConfigurationQueriesTestResponse-objektet.

Undantag

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

update_configuration

Uppdateringar en konfiguration för enheter eller moduler på en IoTHub. Obs! Konfigurations-ID och Innehåll kan inte uppdateras av användaren.

update_configuration(configuration, etag)

Parametrar

Name Description
configuration_id
Obligatorisk
str

ID:t för konfigurationen.
configuration
Obligatorisk
Configuration

Konfigurationen innehåller den uppdaterade konfigurationen.
etag
Obligatorisk
str

Etag-värdet (if_match) som ska användas för uppdateringsåtgärden.

Returer

Typ Description

Konfigurationsobjekt som innehåller den uppdaterade konfigurationen.

Undantag

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