Freigeben über

IoTHubRegistryManager Klasse

  • Referenz

Eine Klasse, um benutzerfreundliche APIs für IoTHub Registry Manager-Vorgänge bereitzustellen, die auf den automatisch generierten IotHub-REST-APIs basieren.

Initialisierer für einen Registrierungs-Manager-Dienstclient.

Benutzer sollten dies nicht direkt aufrufen. Stattdessen sollten sie die Factorymethoden from_connection_string() oder from_token_credential() verwenden.

Nach einer erfolgreichen Erstellung wurde die Klasse bei IoTHub authentifiziert und kann die Member-APIs für die Kommunikation mit IoTHub aufrufen.

Vererbung
builtins.object
IoTHubRegistryManager

Konstruktor

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

Parameter

Name Beschreibung
connection_string
str

Die IoTHub-Verbindungszeichenfolge, die zum Authentifizieren der Verbindung mit IoTHub verwendet wird, wenn wir connection_str Authentifizierung verwenden. Standardwert: Keiner

Standardwert: None
host
str

Die Azure-Dienst-URL, wenn wir die Tokenanmeldeinformationenauthentifizierung verwenden. Standardwert: Keiner

Standardwert: None
auth
Erforderlich
str

Das Azure-Authentifizierungsobjekt, wenn wir die Tokenanmeldeinformationenauthentifizierung verwenden. Standardwert: Keiner
token_credential
Standardwert: None

Methoden

bulk_create_or_update_devices

Erstellen, aktualisieren oder löschen Sie die Identitäten mehrerer Geräte aus der IoTHub-Identitätsregistrierung.

Erstellen, aktualisieren oder löschen Sie die Identitäten mehrerer Geräte aus der IoTHub-Identitätsregistrierung. Eine Geräteidentität kann nur einmal in der Liste angegeben werden. Unterschiedliche Vorgänge (Erstellen, Aktualisieren, Löschen) auf verschiedenen Geräten sind zulässig. Pro Aufruf können maximal 100 Geräte angegeben werden. Für umfangreiche Vorgänge sollten Sie das Importfeature mithilfe von Blob Storage(https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities) verwenden.
create_device_with_certificate_authority

Erstellt eine Geräteidentität in IoTHub mithilfe der Zertifizierungsstelle.
create_device_with_sas

Erstellt eine Geräteidentität in IoTHub mithilfe der SAS-Authentifizierung.
create_device_with_x509

Erstellt eine Geräteidentität in IoTHub mithilfe der X509-Authentifizierung.
create_module_with_certificate_authority

Erstellt eine Modulidentität für ein Gerät auf IoTHub mithilfe der Zertifizierungsstelle.
create_module_with_sas

Erstellt mithilfe der SAS-Authentifizierung eine Modulidentität für ein Gerät in IoTHub.
create_module_with_x509

Erstellt mithilfe der X509-Authentifizierung eine Modulidentität für ein Gerät in IoTHub.
delete_device

Löscht eine Geräteidentität aus IoTHub.
delete_module

Löscht eine Modulidentität für ein Gerät aus IoTHub.
from_connection_string

Classmethod-Initialisierer für einen Registrierungs-Manager-Dienstclient. Erstellt die Registrierungs-Manager-Klasse aus der Verbindungszeichenfolge.

Nach einer erfolgreichen Erstellung wurde die Klasse bei IoTHub authentifiziert und kann die Member-APIs für die Kommunikation mit IoTHub aufrufen.
from_token_credential

Classmethod-Initialisierer für einen Registrierungs-Manager-Dienstclient. Erstellt die Registrierungs-Manager-Klasse aus hostnamen-URL und Azure-Tokenanmeldeinformationen.

Nach einer erfolgreichen Erstellung wurde die Klasse bei IoTHub authentifiziert und kann die Member-APIs für die Kommunikation mit IoTHub aufrufen.
get_device

Ruft eine Geräteidentität aus IoTHub ab.
get_device_registry_statistics

Ruft die IoTHub-Geräteregistrierungsstatistiken ab.
get_devices

Rufen Sie die Identitäten mehrerer Geräte aus der IoTHub-Identitätsregistrierung ab. Nicht empfohlen. Verwenden Sie die IoTHub-Abfragesprache, um Gerätezwillwillungs- und Geräteidentitätsinformationen abzurufen. Weitere Informationen finden Sie unter https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub und https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language.
get_module

Ruft eine Modulidentität für ein Gerät von IoTHub ab.
get_module_twin

Ruft einen Modulzwilligen ab.
get_modules

Ruft alle Modulidentitäten auf einem Gerät ab.
get_service_statistics

Ruft die IoTHub-Dienststatistiken ab.
get_twin

Ruft einen Gerätezwilligen ab.
invoke_device_method

Rufen Sie eine direkte Methode auf einem Gerät auf.
invoke_device_module_method

Rufen Sie eine direkte Methode auf einem Gerät auf.
query_iot_hub

Fragen Sie eine IoTHub-Instanz ab, um Informationen zu Gerätezwillys mithilfe einer SQL-ähnlichen Sprache abzurufen. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language. Die Paginierung von Ergebnissen wird unterstützt. Dadurch werden nur Informationen zu Gerätezwillen zurückgegeben.
replace_module_twin

Ersetzt Tags und gewünschte Eigenschaften eines Modulzwillys.
replace_twin

Ersetzt Tags und gewünschte Eigenschaften eines Gerätezwillys.
send_c2d_message

Senden sie eine C2D-Nachricht an ein IoTHub-Gerät.
update_device_with_certificate_authority

Aktualisierungen einer Geräteidentität auf IoTHub mithilfe der Zertifizierungsstelle.
update_device_with_sas

Aktualisierungen eine Geräteidentität auf IoTHub mithilfe der SAS-Authentifizierung.
update_device_with_x509

Aktualisierungen einer Geräteidentität auf IoTHub mithilfe der X509-Authentifizierung.
update_module_twin

Aktualisierungen Tags und gewünschten Eigenschaften eines Modulzwillys.
update_module_with_certificate_authority

Aktualisierungen eine Modulidentität für ein Gerät auf IoTHub mithilfe der Zertifizierungsstelle.
update_module_with_sas

Aktualisierungen mithilfe der SAS-Authentifizierung eine Modulidentität für ein Gerät auf IoTHub.
update_module_with_x509

Aktualisierungen eine Modulidentität für ein Gerät auf IoTHub mithilfe der X509-Authentifizierung.
update_twin

Aktualisierungen Tags und gewünschten Eigenschaften eines Gerätezwillens.

bulk_create_or_update_devices

Erstellen, aktualisieren oder löschen Sie die Identitäten mehrerer Geräte aus der IoTHub-Identitätsregistrierung.

Erstellen, aktualisieren oder löschen Sie die Identitäten mehrerer Geräte aus der IoTHub-Identitätsregistrierung. Eine Geräteidentität kann nur einmal in der Liste angegeben werden. Unterschiedliche Vorgänge (Erstellen, Aktualisieren, Löschen) auf verschiedenen Geräten sind zulässig. Pro Aufruf können maximal 100 Geräte angegeben werden. Für umfangreiche Vorgänge sollten Sie das Importfeature mithilfe von Blob Storage(https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities) verwenden.

bulk_create_or_update_devices(devices)

Parameter

Name Beschreibung
devices
Erforderlich
list[ExportImportDevice]

Die Liste der Geräteobjekte, die ausgeführt werden sollen.

Gibt zurück

Typ Beschreibung

Das BulkRegistryOperationResult-Objekt.

Ausnahmen

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

create_device_with_certificate_authority

Erstellt eine Geräteidentität in IoTHub mithilfe der Zertifizierungsstelle.

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

Parameter

Name Beschreibung
device_id
Erforderlich
str

Der Name (ID) des Geräts.
status
Erforderlich
str

Anfangszustand des erstellten Geräts. (Mögliche Werte: "aktiviert" oder "deaktiviert").
iot_edge
bool

Gibt an, ob es sich bei dem erstellten Gerät um ein IoT Edge Gerät handelt. Standardwert: False

Standardwert: False
status_reason
str

Der Grund für die Geräteidentität status. Standardwert: Keiner

Standardwert: None
device_scope
str

Der Bereich des Geräts. Standardwert: None Automatisch generiert und unveränderlich für Edgegeräte und in Blattgeräten änderbar, um eine untergeordnete/übergeordnete Beziehung zu erstellen. Bei Blattgeräten kann der Wert zum Festlegen eines übergeordneten Edgegeräts aus der device_scope-Eigenschaft des übergeordneten Edgegeräts abgerufen werden.

Standardwert: None
parent_scopes
Union[list[str], str]

Die Bereiche der Edgegeräte der oberen Ebene, falls zutreffend. Standardwert: None Für Edgegeräte kann der Wert zum Festlegen eines übergeordneten Edgegeräts aus der device_scope-Eigenschaft des übergeordneten Edgegeräts abgerufen werden. Für Blattgeräte kann dies auf den gleichen Wert wie device_scope oder für den Dienst zum Kopieren festgelegt werden.

Standardwert: None

Gibt zurück

Typ Beschreibung

Geräteobjekt, das das erstellte Gerät enthält.

Ausnahmen

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

create_device_with_sas

Erstellt eine Geräteidentität in IoTHub mithilfe der SAS-Authentifizierung.

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

Parameter

Name Beschreibung
device_id
Erforderlich
str

Der Name (ID) des Geräts.
primary_key
Erforderlich
str

Primärer Authentifizierungsschlüssel.
secondary_key
Erforderlich
str

Sekundärer Authentifizierungsschlüssel.
status
Erforderlich
str

Anfangszustand des erstellten Geräts. (Mögliche Werte: "aktiviert" oder "deaktiviert")
iot_edge
bool

Gibt an, ob es sich bei dem erstellten Gerät um ein IoT Edge Gerät handelt. Standardwert: False

Standardwert: False
status_reason
str

Der Grund für die Geräteidentität status. Standardwert: Keiner

Standardwert: None
device_scope
str

Der Bereich des Geräts. Standardwert: None Automatisch generiert und unveränderlich für Edgegeräte und in Blattgeräten änderbar, um eine untergeordnete/übergeordnete Beziehung zu erstellen. Bei Blattgeräten kann der Wert zum Festlegen eines übergeordneten Edgegeräts aus der device_scope-Eigenschaft des übergeordneten Edgegeräts abgerufen werden.

Standardwert: None
parent_scopes
Union[list[str], str]

Die Bereiche der Edgegeräte der oberen Ebene, falls zutreffend. Standardwert: None Für Edgegeräte kann der Wert zum Festlegen eines übergeordneten Edgegeräts aus der device_scope-Eigenschaft des übergeordneten Edgegeräts abgerufen werden. Für Blattgeräte kann dies auf den gleichen Wert wie device_scope oder für den Dienst zum Kopieren festgelegt werden.

Standardwert: None

Gibt zurück

Typ Beschreibung

Geräteobjekt, das das erstellte Gerät enthält.

Ausnahmen

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

create_device_with_x509

Erstellt eine Geräteidentität in IoTHub mithilfe der X509-Authentifizierung.

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

Parameter

Name Beschreibung
device_id
Erforderlich
str

Der Name (ID) des Geräts.
primary_thumbprint
Erforderlich
str

Primärer X509-Fingerabdruck.
secondary_thumbprint
Erforderlich
str

Sekundärer X509-Fingerabdruck.
status
Erforderlich
str

Anfangszustand des erstellten Geräts. (Mögliche Werte: "aktiviert" oder "deaktiviert")
iot_edge
bool

Gibt an, ob es sich bei dem erstellten Gerät um ein IoT Edge Gerät handelt. Standardwert: False

Standardwert: False
status_reason
str

Der Grund für die Geräteidentität status. Standardwert: Keiner

Standardwert: None
device_scope
str

Der Bereich des Geräts. Standardwert: None Automatisch generiert und unveränderlich für Edgegeräte und in Blattgeräten änderbar, um eine untergeordnete/übergeordnete Beziehung zu erstellen. Bei Blattgeräten kann der Wert zum Festlegen eines übergeordneten Edgegeräts aus der device_scope-Eigenschaft des übergeordneten Edgegeräts abgerufen werden.

Standardwert: None
parent_scopes
Union[list[str], str]

Die Bereiche der Edgegeräte der oberen Ebene, falls zutreffend. Standardwert: None Für Edgegeräte kann der Wert zum Festlegen eines übergeordneten Edgegeräts aus der device_scope-Eigenschaft des übergeordneten Edgegeräts abgerufen werden. Für Blattgeräte kann dies auf den gleichen Wert wie device_scope oder für den Dienst zum Kopieren festgelegt werden.

Standardwert: None

Gibt zurück

Typ Beschreibung

Geräteobjekt, das das erstellte Gerät enthält.

Ausnahmen

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

create_module_with_certificate_authority

Erstellt eine Modulidentität für ein Gerät auf IoTHub mithilfe der Zertifizierungsstelle.

create_module_with_certificate_authority(device_id, module_id, managed_by)

Parameter

Name Beschreibung
device_id
Erforderlich
str

Der Name (ID) des Geräts.
module_id
Erforderlich
str

Der Name (ID) des Moduls.
managed_by
Erforderlich
str

Der Name des Managergeräts (Edge).

Gibt zurück

Typ Beschreibung

Modulobjekt, das das erstellte Modul enthält.

Ausnahmen

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

create_module_with_sas

Erstellt mithilfe der SAS-Authentifizierung eine Modulidentität für ein Gerät in IoTHub.

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

Parameter

Name Beschreibung
device_id
Erforderlich
str

Der Name (ID) des Geräts.
module_id
Erforderlich
str

Der Name (ID) des Moduls.
managed_by
Erforderlich
str

Der Name des Managergeräts (Edge).
primary_key
Erforderlich
str

Primärer Authentifizierungsschlüssel.
secondary_key
Erforderlich
str

Sekundärer Authentifizierungsschlüssel.

Gibt zurück

Typ Beschreibung

Modulobjekt, das das erstellte Modul enthält.

Ausnahmen

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

create_module_with_x509

Erstellt mithilfe der X509-Authentifizierung eine Modulidentität für ein Gerät in IoTHub.

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

Parameter

Name Beschreibung
device_id
Erforderlich
str

Der Name (ID) des Geräts.
module_id
Erforderlich
str

Der Name (ID) des Moduls.
managed_by
Erforderlich
str

Der Name des Managergeräts (Edge).
primary_thumbprint
Erforderlich
str

Primärer X509-Fingerabdruck.
secondary_thumbprint
Erforderlich
str

Sekundärer X509-Fingerabdruck.

Gibt zurück

Typ Beschreibung

Modulobjekt, das das erstellte Modul enthält.

Ausnahmen

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

delete_device

Löscht eine Geräteidentität aus IoTHub.

delete_device(device_id, etag=None)

Parameter

Name Beschreibung
device_id
Erforderlich
str

Der Name (ID) des Geräts.
etag
str

Der etag -Wert (if_match), der für den Löschvorgang verwendet werden soll.

Standardwert: None

Gibt zurück

Typ Beschreibung

Keine.

Ausnahmen

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

delete_module

Löscht eine Modulidentität für ein Gerät aus IoTHub.

delete_module(device_id, module_id, etag=None)

Parameter

Name Beschreibung
device_id
Erforderlich
str

Der Name (ID) des Geräts.
module_id
Erforderlich
str

Der Name (ID) des Moduls.
etag
str

Der etag -Wert (if_match), der für den Löschvorgang verwendet werden soll.

Standardwert: None

Gibt zurück

Typ Beschreibung

Keine.

Ausnahmen

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

from_connection_string

Classmethod-Initialisierer für einen Registrierungs-Manager-Dienstclient. Erstellt die Registrierungs-Manager-Klasse aus der Verbindungszeichenfolge.

Nach einer erfolgreichen Erstellung wurde die Klasse bei IoTHub authentifiziert und kann die Member-APIs für die Kommunikation mit IoTHub aufrufen.

from_connection_string(connection_string)

Parameter

Name Beschreibung
connection_string
Erforderlich
str

Die IoTHub-Verbindungszeichenfolge, die zum Authentifizieren der Verbindung mit IoTHub verwendet wird.

Gibt zurück

Typ Beschreibung
IoTHubRegistryManager

Ausnahmen

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

from_token_credential

Classmethod-Initialisierer für einen Registrierungs-Manager-Dienstclient. Erstellt die Registrierungs-Manager-Klasse aus hostnamen-URL und Azure-Tokenanmeldeinformationen.

Nach einer erfolgreichen Erstellung wurde die Klasse bei IoTHub authentifiziert und kann die Member-APIs für die Kommunikation mit IoTHub aufrufen.

from_token_credential(url, token_credential)

Parameter

Name Beschreibung
url
Erforderlich
str

Die Azure-Dienst-URL (Hostname).
token_credential
Erforderlich
<xref:azure.core.TokenCredential>

Das Azure-Tokenanmeldeinformationsobjekt

Gibt zurück

Typ Beschreibung
IoTHubRegistryManager

Ausnahmen

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

get_device

Ruft eine Geräteidentität aus IoTHub ab.

get_device(device_id)

Parameter

Name Beschreibung
device_id
Erforderlich
str

Der Name (ID) des Geräts.

Gibt zurück

Typ Beschreibung

Das Device-Objekt, das das angeforderte Gerät enthält.

Ausnahmen

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

get_device_registry_statistics

Ruft die IoTHub-Geräteregistrierungsstatistiken ab.

get_device_registry_statistics()

Gibt zurück

Typ Beschreibung

Das RegistryStatistics-Objekt.

Ausnahmen

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

get_devices

Rufen Sie die Identitäten mehrerer Geräte aus der IoTHub-Identitätsregistrierung ab. Nicht empfohlen. Verwenden Sie die IoTHub-Abfragesprache, um Gerätezwillwillungs- und Geräteidentitätsinformationen abzurufen. Weitere Informationen finden Sie unter https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub und https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language.

get_devices(max_number_of_devices=None)

Parameter

Name Beschreibung
max_number_of_devices
int

Dieser Parameter definiert bei Angabe die maximale Anzahl zurückgegebener Geräteidentitäten. Jeder Wert außerhalb des Bereichs von 1 bis 1000 wird als 1000 betrachtet.

Standardwert: None

Gibt zurück

Typ Beschreibung

Liste der Geräteinformationen.

Ausnahmen

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

get_module

Ruft eine Modulidentität für ein Gerät von IoTHub ab.

get_module(device_id, module_id)

Parameter

Name Beschreibung
device_id
Erforderlich
str

Der Name (ID) des Geräts.
module_id
Erforderlich
str

Der Name (ID) des Moduls.

Gibt zurück

Typ Beschreibung

Das Module-Objekt, das das angeforderte Modul enthält.

Ausnahmen

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

get_module_twin

Ruft einen Modulzwilligen ab.

get_module_twin(device_id, module_id)

Parameter

Name Beschreibung
device_id
Erforderlich
str

Der Name (ID) des Geräts.
module_id
Erforderlich
str

Der Name (ID) des Moduls.

Gibt zurück

Typ Beschreibung

Das Twin-Objekt.

Ausnahmen

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

get_modules

Ruft alle Modulidentitäten auf einem Gerät ab.

get_modules(device_id)

Parameter

Name Beschreibung
device_id
Erforderlich
str

Der Name (ID) des Geräts.

Gibt zurück

Typ Beschreibung

Die Liste[Modul] mit allen Modulen auf dem Gerät.

Ausnahmen

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

get_service_statistics

Ruft die IoTHub-Dienststatistiken ab.

get_service_statistics()

Gibt zurück

Typ Beschreibung

Das ServiceStatistics-Objekt.

Ausnahmen

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

get_twin

Ruft einen Gerätezwilligen ab.

get_twin(device_id)

Parameter

Name Beschreibung
device_id
Erforderlich
str

Der Name (ID) des Geräts.

Gibt zurück

Typ Beschreibung

Das Twin-Objekt.

Ausnahmen

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

invoke_device_method

Rufen Sie eine direkte Methode auf einem Gerät auf.

invoke_device_method(device_id, direct_method_request)

Parameter

Name Beschreibung
device_id
Erforderlich
str

Der Name (ID) des Geräts.
direct_method_request
Erforderlich
CloudToDeviceMethod

Die Methodenanforderung.

Gibt zurück

Typ Beschreibung

Das CloudToDeviceMethodResult-Objekt.

Ausnahmen

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

invoke_device_module_method

Rufen Sie eine direkte Methode auf einem Gerät auf.

invoke_device_module_method(device_id, module_id, direct_method_request)

Parameter

Name Beschreibung
device_id
Erforderlich
str

Der Name (ID) des Geräts.
module_id
Erforderlich
str

Der Name (ID) des Moduls.
direct_method_request
Erforderlich
CloudToDeviceMethod

Die Methodenanforderung.

Gibt zurück

Typ Beschreibung

Das CloudToDeviceMethodResult-Objekt.

Ausnahmen

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

query_iot_hub

Fragen Sie eine IoTHub-Instanz ab, um Informationen zu Gerätezwillys mithilfe einer SQL-ähnlichen Sprache abzurufen. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language. Die Paginierung von Ergebnissen wird unterstützt. Dadurch werden nur Informationen zu Gerätezwillen zurückgegeben.

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

Parameter

Name Beschreibung
query
Erforderlich
QuerySpecification

Die Abfragespezifikation.
continuation_token
str

Fortsetzungstoken für Paging

Standardwert: None
max_item_count
str

Maximale Anzahl angeforderter Gerätezwille

Standardwert: None
query_specification
Erforderlich

Gibt zurück

Typ Beschreibung

Das QueryResult-Objekt.

Ausnahmen

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

replace_module_twin

Ersetzt Tags und gewünschte Eigenschaften eines Modulzwillys.

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

Parameter

Name Beschreibung
device_id
Erforderlich
str

Der Name (ID) des Geräts.
module_id
Erforderlich
str

Der Name (ID) des Moduls.
module_twin
Erforderlich
Twin

Die Zwillingsinformationen des Moduls.
etag
str

Der etag-Wert (if_match), der für den Ersetzungsvorgang verwendet werden soll.

Standardwert: None

Gibt zurück

Typ Beschreibung

Das Twin-Objekt.

Ausnahmen

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

replace_twin

Ersetzt Tags und gewünschte Eigenschaften eines Gerätezwillys.

replace_twin(device_id, device_twin, etag=None)

Parameter

Name Beschreibung
device_id
Erforderlich
str

Der Name (ID) des Geräts.
device_twin
Erforderlich
Twin

Die Zwillingsinformationen des Geräts.
etag
str

Der etag-Wert (if_match), der für den Ersetzungsvorgang verwendet werden soll.

Standardwert: None

Gibt zurück

Typ Beschreibung

Das Twin-Objekt.

Ausnahmen

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

send_c2d_message

Senden sie eine C2D-Nachricht an ein IoTHub-Gerät.

send_c2d_message(device_id, message, properties={})

Parameter

Name Beschreibung
device_id
Erforderlich
str

Der Name (ID) des Geräts.
message
Erforderlich
str

Die Nachricht, die an das Gerät übermittelt werden soll.
properties
dict

Die Eigenschaften, die mit der Nachricht gesendet werden sollen. Kann Anwendungseigenschaften und Systemeigenschaften enthalten

Standardwert: {}

Ausnahmen

Typ Beschreibung
Exception if the Send command is not able to send the message

update_device_with_certificate_authority

Aktualisierungen einer Geräteidentität auf IoTHub mithilfe der Zertifizierungsstelle.

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

Parameter

Name Beschreibung
device_id
Erforderlich
str

Der Name (ID) des Geräts.
etag
Erforderlich
str

Der etag-Wert (if_match), der für den Updatevorgang verwendet werden soll.
status
Erforderlich
str

Anfangszustand des erstellten Geräts. (Mögliche Werte: "aktiviert" oder "deaktiviert").
iot_edge
bool

Gibt an, ob es sich bei dem erstellten Gerät um ein IoT Edge Gerät handelt. Standardwert: False

Standardwert: False
status_reason
str

Der Grund für die Geräteidentität status. Standardwert: Keiner

Standardwert: None
device_scope
str

Der Bereich des Geräts. Standardwert: None Automatisch generiert und unveränderlich für Edgegeräte und änderbar auf Blattgeräten, um eine untergeordnete/übergeordnete Beziehung zu erstellen. Bei Blattgeräten kann der Wert zum Festlegen eines übergeordneten Edgegeräts aus der device_scope-Eigenschaft des übergeordneten Edgegeräts abgerufen werden.

Standardwert: None
parent_scopes
Union[list[str], str]

Die Bereiche der Edgegeräte der oberen Ebene, falls zutreffend. Standardwert: None Bei Edgegeräten kann der Wert zum Festlegen eines übergeordneten Edgegeräts aus der device_scope-Eigenschaft des übergeordneten Edgegeräts abgerufen werden. Bei Blattgeräten kann dies auf denselben Wert wie device_scope festgelegt werden oder für den Dienst zum Kopieren überlassen werden.

Standardwert: None

Gibt zurück

Typ Beschreibung

Das aktualisierte Device-Objekt, das das erstellte Gerät enthält.

Ausnahmen

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

update_device_with_sas

Aktualisierungen eine Geräteidentität auf IoTHub mithilfe der SAS-Authentifizierung.

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

Parameter

Name Beschreibung
device_id
Erforderlich
str

Der Name (ID) des Geräts.
etag
Erforderlich
str

Der etag-Wert (if_match), der für den Updatevorgang verwendet werden soll.
primary_key
Erforderlich
str

Primärer Authentifizierungsschlüssel.
secondary_key
Erforderlich
str

Sekundärer Authentifizierungsschlüssel.
status
Erforderlich
str

Anfangszustand des erstellten Geräts. (Mögliche Werte: "aktiviert" oder "deaktiviert").
iot_edge
bool

Gibt an, ob es sich bei dem erstellten Gerät um ein IoT Edge Gerät handelt. Standardwert: False

Standardwert: False
status_reason
str

Der Grund für die Geräteidentität status. Standardwert: Keiner

Standardwert: None
device_scope
str

Der Bereich des Geräts. Standardwert: None Automatisch generiert und unveränderlich für Edgegeräte und änderbar auf Blattgeräten, um eine untergeordnete/übergeordnete Beziehung zu erstellen. Bei Blattgeräten kann der Wert zum Festlegen eines übergeordneten Edgegeräts aus der device_scope-Eigenschaft des übergeordneten Edgegeräts abgerufen werden.

Standardwert: None
parent_scopes
Union[list[str], str]

Die Bereiche der Edgegeräte der oberen Ebene, falls zutreffend. Standardwert: None Bei Edgegeräten kann der Wert zum Festlegen eines übergeordneten Edgegeräts aus der device_scope-Eigenschaft des übergeordneten Edgegeräts abgerufen werden. Bei Blattgeräten kann dies auf denselben Wert wie device_scope festgelegt werden oder für den Dienst zum Kopieren überlassen werden.

Standardwert: None

Gibt zurück

Typ Beschreibung

Das aktualisierte Device-Objekt, das das erstellte Gerät enthält.

Ausnahmen

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

update_device_with_x509

Aktualisierungen einer Geräteidentität auf IoTHub mithilfe der X509-Authentifizierung.

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

Parameter

Name Beschreibung
device_id
Erforderlich
str

Der Name (ID) des Geräts.
etag
Erforderlich
str

Der etag-Wert (if_match), der für den Updatevorgang verwendet werden soll.
primary_thumbprint
Erforderlich
str

Primärer X509-Fingerabdruck.
secondary_thumbprint
Erforderlich
str

Sekundärer X509-Fingerabdruck.
status
Erforderlich
str

Anfangszustand des erstellten Geräts. (Mögliche Werte: "aktiviert" oder "deaktiviert").
iot_edge
bool

Gibt an, ob es sich bei dem erstellten Gerät um ein IoT Edge Gerät handelt. Standardwert: False

Standardwert: False
status_reason
str

Der Grund für die Geräteidentität status. Standardwert: Keiner

Standardwert: None
device_scope
str

Der Bereich des Geräts. Standardwert: None Automatisch generiert und unveränderlich für Edgegeräte und änderbar auf Blattgeräten, um eine untergeordnete/übergeordnete Beziehung zu erstellen. Bei Blattgeräten kann der Wert zum Festlegen eines übergeordneten Edgegeräts aus der device_scope-Eigenschaft des übergeordneten Edgegeräts abgerufen werden.

Standardwert: None
parent_scopes
Union[list[str], str]

Die Bereiche der Edgegeräte der oberen Ebene, falls zutreffend. Standardwert: None Bei Edgegeräten kann der Wert zum Festlegen eines übergeordneten Edgegeräts aus der device_scope-Eigenschaft des übergeordneten Edgegeräts abgerufen werden. Bei Blattgeräten kann dies auf denselben Wert wie device_scope festgelegt werden oder für den Dienst zum Kopieren überlassen werden.

Standardwert: None

Gibt zurück

Typ Beschreibung

Das aktualisierte Device-Objekt, das das erstellte Gerät enthält.

Ausnahmen

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

update_module_twin

Aktualisierungen Tags und gewünschten Eigenschaften eines Modulzwillys.

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

Parameter

Name Beschreibung
device_id
Erforderlich
str

Der Name (ID) des Geräts.
module_id
Erforderlich
str

Der Name (ID) des Moduls.
module_twin
Erforderlich
Twin

Die Zwillingsinformationen des Moduls.
etag
str

Der etag-Wert (if_match), der für den Updatevorgang verwendet werden soll.

Standardwert: None

Gibt zurück

Typ Beschreibung

Das Twin-Objekt.

Ausnahmen

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

update_module_with_certificate_authority

Aktualisierungen eine Modulidentität für ein Gerät auf IoTHub mithilfe der Zertifizierungsstelle.

update_module_with_certificate_authority(device_id, module_id, managed_by, etag)

Parameter

Name Beschreibung
device_id
Erforderlich
str

Der Name (ID) des Geräts.
module_id
Erforderlich
str

Der Name (ID) des Moduls.
managed_by
Erforderlich
str

Der Name des Managergeräts (Edge).
etag
Erforderlich
str

Der etag-Wert (if_match), der für den Updatevorgang verwendet werden soll.

Gibt zurück

Typ Beschreibung

Das aktualisierte Module-Objekt, das das erstellte Modul enthält.

Ausnahmen

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

update_module_with_sas

Aktualisierungen mithilfe der SAS-Authentifizierung eine Modulidentität für ein Gerät auf IoTHub.

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

Parameter

Name Beschreibung
device_id
Erforderlich
str

Der Name (ID) des Geräts.
module_id
Erforderlich
str

Der Name (ID) des Moduls.
managed_by
Erforderlich
str

Der Name des Managergeräts (Edge).
etag
Erforderlich
str

Der etag-Wert (if_match), der für den Updatevorgang verwendet werden soll.
primary_key
Erforderlich
str

Primärer Authentifizierungsschlüssel.
secondary_key
Erforderlich
str

Sekundärer Authentifizierungsschlüssel.

Gibt zurück

Typ Beschreibung

Das aktualisierte Module-Objekt, das das erstellte Modul enthält.

Ausnahmen

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

update_module_with_x509

Aktualisierungen eine Modulidentität für ein Gerät auf IoTHub mithilfe der X509-Authentifizierung.

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

Parameter

Name Beschreibung
device_id
Erforderlich
str

Der Name (ID) des Geräts.
module_id
Erforderlich
str

Der Name (ID) des Moduls.
managed_by
Erforderlich
str

Der Name des Managergeräts (Edge).
etag
Erforderlich
str

Der etag-Wert (if_match), der für den Updatevorgang verwendet werden soll.
primary_thumbprint
Erforderlich
str

Primärer X509-Fingerabdruck.
secondary_thumbprint
Erforderlich
str

Sekundärer X509-Fingerabdruck.

Gibt zurück

Typ Beschreibung

Das aktualisierte Module-Objekt, das das erstellte Modul enthält.

Ausnahmen

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

update_twin

Aktualisierungen Tags und gewünschten Eigenschaften eines Gerätezwillens.

update_twin(device_id, device_twin, etag=None)

Parameter

Name Beschreibung
device_id
Erforderlich
str

Der Name (ID) des Geräts.
device_twin
Erforderlich
Twin

Die Zwillingsinformationen des Geräts.
etag
str

Der etag-Wert (if_match), der für den Updatevorgang verwendet werden soll.

Standardwert: None

Gibt zurück

Typ Beschreibung

Das Twin-Objekt.

Ausnahmen

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