Dela via

IoTHubRegistryManager Klass

  • Referens

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

Initierare för en Registry Manager-tjänstklient.

Användarna bör inte anropa detta direkt. I stället bör de from_connection_string() eller from_token_credential() fabriksmetoder.

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
IoTHubRegistryManager

Konstruktor

IoTHubRegistryManager(connection_string=None, host=None, token_credential=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
Obligatorisk
str

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

Metoder

bulk_create_or_update_devices

Skapa, uppdatera eller ta bort identiteterna för flera enheter från IoTHub-identitetsregistret.

Skapa, uppdatera eller ta bort identiteterna för flera enheter från IoTHub-identitetsregistret. En enhetsidentitet kan bara anges en gång i listan. Olika åtgärder (skapa, uppdatera, ta bort) på olika enheter tillåts. Högst 100 enheter kan anges per anrop. Överväg att använda importfunktionen med Blob Storage(https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities) för storskaliga åtgärder.
create_device_with_certificate_authority

Skapar en enhetsidentitet på IoTHub med certifikatutfärdare.
create_device_with_sas

Skapar en enhetsidentitet på IoTHub med hjälp av SAS-autentisering.
create_device_with_x509

Skapar en enhetsidentitet på IoTHub med X509-autentisering.
create_module_with_certificate_authority

Skapar en modulidentitet för en enhet på IoTHub med certifikatutfärdare.
create_module_with_sas

Skapar en modulidentitet för en enhet på IoTHub med hjälp av SAS-autentisering.
create_module_with_x509

Skapar en modulidentitet för en enhet på IoTHub med X509-autentisering.
delete_device

Tar bort en enhetsidentitet från IoTHub.
delete_module

Tar bort en modulidentitet för en enhet från IoTHub.
from_connection_string

Classmethod-initierare för en Registry Manager Service-klient. Skapar Registry Manager-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 Registry Manager Service-klient. Skapar Registry Manager-klassen från url:en för värdnamn och Azure-tokenautentiseringsuppgifter.

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_device

Hämtar en enhetsidentitet från IoTHub.
get_device_registry_statistics

Hämtar enhetsregisterstatistiken för IoTHub.
get_devices

Hämta identiteterna för flera enheter från IoTHub-identitetsregistret. Rekommenderas ej. Använd IoTHub-frågespråket för att hämta information om enhetstvillingar och enhetsidentiteter. Mer information finns i https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub och https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language .
get_module

Hämtar en modulidentitet för en enhet från IoTHub.
get_module_twin

Hämtar en modultvilling.
get_modules

Hämtar alla modulidentiteter på en enhet.
get_service_statistics

Hämtar IoTHub-tjänststatistiken.
get_twin

Hämtar en enhetstvilling.
invoke_device_method

Anropa en direktmetod på en enhet.
invoke_device_module_method

Anropa en direktmetod på en enhet.
query_iot_hub

Fråga en IoTHub för att hämta information om enhetstvillingar med ett SQL-liknande språk. Mer information finns i https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language. Sidnumrering av resultat stöds. Detta returnerar endast information om enhetstvillingar.
replace_module_twin

Ersätter taggar och önskade egenskaper för en modultvilling.
replace_twin

Ersätter taggar och önskade egenskaper för en enhetstvilling.
send_c2d_message

Skicka ett C2D-meddelande till en IoTHub-enhet.
update_device_with_certificate_authority

Uppdateringar en enhetsidentitet på IoTHub med certifikatutfärdare.
update_device_with_sas

Uppdateringar en enhetsidentitet på IoTHub med hjälp av SAS-autentisering.
update_device_with_x509

Uppdateringar en enhetsidentitet på IoTHub med X509-autentisering.
update_module_twin

Uppdateringar taggar och önskade egenskaper för en modultvilling.
update_module_with_certificate_authority

Uppdateringar en modulidentitet för en enhet på IoTHub med certifikatutfärdare.
update_module_with_sas

Uppdateringar en modulidentitet för en enhet på IoTHub med hjälp av SAS-autentisering.
update_module_with_x509

Uppdateringar en modulidentitet för en enhet på IoTHub med X509-autentisering.
update_twin

Uppdateringar taggar och önskade egenskaper för en enhetstvilling.

bulk_create_or_update_devices

Skapa, uppdatera eller ta bort identiteterna för flera enheter från IoTHub-identitetsregistret.

Skapa, uppdatera eller ta bort identiteterna för flera enheter från IoTHub-identitetsregistret. En enhetsidentitet kan bara anges en gång i listan. Olika åtgärder (skapa, uppdatera, ta bort) på olika enheter tillåts. Högst 100 enheter kan anges per anrop. Överväg att använda importfunktionen med Blob Storage(https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities) för storskaliga åtgärder.

bulk_create_or_update_devices(devices)

Parametrar

Name Description
devices
Obligatorisk
list[ExportImportDevice]

Listan över enhetsobjekt som ska användas.

Returer

Typ Description

BulkRegistryOperationResult-objektet.

Undantag

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

create_device_with_certificate_authority

Skapar en enhetsidentitet på IoTHub med certifikatutfärdare.

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

Parametrar

Name Description
device_id
Obligatorisk
str

Enhetens namn (ID).
status
Obligatorisk
str

Ursprungligt tillstånd för den skapade enheten. (Möjliga värden: "aktiverad" eller "inaktiverad").
iot_edge
bool

Om den skapade enheten är en IoT Edge enhet eller inte. Standardvärde: Falskt

standardvärde: False
status_reason
str

Orsaken till enhetens identitetsstatus. Standardvärde: Ingen

standardvärde: None
device_scope
str

Enhetens omfång. Standardvärde: Inget automatiskt genererat och oföränderligt för gränsenheter och kan ändras i lövenheter för att skapa en underordnad/överordnad relation. För lövenheter kan värdet för att ange en överordnad gränsenhet hämtas från den överordnade gränsenhetens device_scope egenskap.

standardvärde: None
parent_scopes
Union[list[str], str]

Omfången för gränsenheterna på den övre nivån om tillämpligt. Standardvärde: Inget För gränsenheter kan värdet för att ange en överordnad gränsenhet hämtas från den överordnade gränsenhetens egenskap device_scope. För lövenheter kan detta anges till samma värde som device_scope eller lämnas för tjänsten att kopiera över.

standardvärde: None

Returer

Typ Description

Enhetsobjekt som innehåller den skapade enheten.

Undantag

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

create_device_with_sas

Skapar en enhetsidentitet på IoTHub med hjälp av SAS-autentisering.

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

Parametrar

Name Description
device_id
Obligatorisk
str

Enhetens namn (ID).
primary_key
Obligatorisk
str

Primär autentiseringsnyckel.
secondary_key
Obligatorisk
str

Sekundär autentiseringsnyckel.
status
Obligatorisk
str

Ursprungligt tillstånd för den skapade enheten. (Möjliga värden: "aktiverad" eller "inaktiverad")
iot_edge
bool

Om den skapade enheten är en IoT Edge enhet eller inte. Standardvärde: Falskt

standardvärde: False
status_reason
str

Orsaken till enhetens identitetsstatus. Standardvärde: Ingen

standardvärde: None
device_scope
str

Enhetens omfång. Standardvärde: Inget automatiskt genererat och oföränderligt för gränsenheter och kan ändras i lövenheter för att skapa en underordnad/överordnad relation. För lövenheter kan värdet för att ange en överordnad gränsenhet hämtas från den överordnade gränsenhetens device_scope egenskap.

standardvärde: None
parent_scopes
Union[list[str], str]

Omfången för gränsenheterna på den övre nivån om tillämpligt. Standardvärde: Inget För gränsenheter kan värdet för att ange en överordnad gränsenhet hämtas från den överordnade gränsenhetens egenskap device_scope. För lövenheter kan detta anges till samma värde som device_scope eller lämnas för tjänsten att kopiera över.

standardvärde: None

Returer

Typ Description

Enhetsobjekt som innehåller den skapade enheten.

Undantag

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

create_device_with_x509

Skapar en enhetsidentitet på IoTHub med X509-autentisering.

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

Parametrar

Name Description
device_id
Obligatorisk
str

Enhetens namn (ID).
primary_thumbprint
Obligatorisk
str

Primärt X509-tumavtryck.
secondary_thumbprint
Obligatorisk
str

Sekundärt X509-tumavtryck.
status
Obligatorisk
str

Ursprungligt tillstånd för den skapade enheten. (Möjliga värden: "aktiverad" eller "inaktiverad")
iot_edge
bool

Om den skapade enheten är en IoT Edge enhet eller inte. Standardvärde: Falskt

standardvärde: False
status_reason
str

Orsaken till enhetens identitetsstatus. Standardvärde: Ingen

standardvärde: None
device_scope
str

Enhetens omfång. Standardvärde: Inget automatiskt genererat och oföränderligt för gränsenheter och kan ändras i lövenheter för att skapa en underordnad/överordnad relation. För lövenheter kan värdet för att ange en överordnad gränsenhet hämtas från den överordnade gränsenhetens device_scope egenskap.

standardvärde: None
parent_scopes
Union[list[str], str]

Omfången för gränsenheterna på den övre nivån om tillämpligt. Standardvärde: Inget För gränsenheter kan värdet för att ange en överordnad gränsenhet hämtas från den överordnade gränsenhetens egenskap device_scope. För lövenheter kan detta anges till samma värde som device_scope eller lämnas för tjänsten att kopiera över.

standardvärde: None

Returer

Typ Description

Enhetsobjekt som innehåller den skapade enheten.

Undantag

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

create_module_with_certificate_authority

Skapar en modulidentitet för en enhet på IoTHub med certifikatutfärdare.

create_module_with_certificate_authority(device_id, module_id, managed_by)

Parametrar

Name Description
device_id
Obligatorisk
str

Enhetens namn (ID).
module_id
Obligatorisk
str

Namnet (ID) för modulen.
managed_by
Obligatorisk
str

Namnet på hanteringsenheten (edge).

Returer

Typ Description

Modulobjekt som innehåller den skapade modulen.

Undantag

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

create_module_with_sas

Skapar en modulidentitet för en enhet på IoTHub med hjälp av SAS-autentisering.

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

Parametrar

Name Description
device_id
Obligatorisk
str

Enhetens namn (ID).
module_id
Obligatorisk
str

Namnet (ID) för modulen.
managed_by
Obligatorisk
str

Namnet på hanteringsenheten (edge).
primary_key
Obligatorisk
str

Primär autentiseringsnyckel.
secondary_key
Obligatorisk
str

Sekundär autentiseringsnyckel.

Returer

Typ Description

Modulobjekt som innehåller den skapade modulen.

Undantag

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

create_module_with_x509

Skapar en modulidentitet för en enhet på IoTHub med X509-autentisering.

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

Parametrar

Name Description
device_id
Obligatorisk
str

Enhetens namn (ID).
module_id
Obligatorisk
str

Namnet (ID) för modulen.
managed_by
Obligatorisk
str

Namnet på hanteringsenheten (edge).
primary_thumbprint
Obligatorisk
str

Primärt X509-tumavtryck.
secondary_thumbprint
Obligatorisk
str

Sekundärt X509-tumavtryck.

Returer

Typ Description

Modulobjekt som innehåller den skapade modulen.

Undantag

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

delete_device

Tar bort en enhetsidentitet från IoTHub.

delete_device(device_id, etag=None)

Parametrar

Name Description
device_id
Obligatorisk
str

Enhetens namn (ID).
etag
str

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

standardvärde: None

Returer

Typ Description

Inga.

Undantag

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

delete_module

Tar bort en modulidentitet för en enhet från IoTHub.

delete_module(device_id, module_id, etag=None)

Parametrar

Name Description
device_id
Obligatorisk
str

Enhetens namn (ID).
module_id
Obligatorisk
str

Namnet (ID) för modulen.
etag
str

Värdet för etag (if_match) som ska användas för borttagningsåtgärden.

standardvärde: None

Returer

Typ Description

Inga.

Undantag

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

from_connection_string

Classmethod-initierare för en Registry Manager Service-klient. Skapar Registry Manager-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 med IoTHub.

Returer

Typ Description
IoTHubRegistryManager

Undantag

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

from_token_credential

Classmethod-initierare för en Registry Manager Service-klient. Skapar Registry Manager-klassen från url:en för värdnamn och Azure-tokenautentiseringsuppgifter.

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
IoTHubRegistryManager

Undantag

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

get_device

Hämtar en enhetsidentitet från IoTHub.

get_device(device_id)

Parametrar

Name Description
device_id
Obligatorisk
str

Enhetens namn (ID).

Returer

Typ Description

Enhetsobjektet som innehåller den begärda enheten.

Undantag

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

get_device_registry_statistics

Hämtar enhetsregisterstatistiken för IoTHub.

get_device_registry_statistics()

Returer

Typ Description

RegistryStatistics-objektet.

Undantag

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

get_devices

Hämta identiteterna för flera enheter från IoTHub-identitetsregistret. Rekommenderas ej. Använd IoTHub-frågespråket för att hämta information om enhetstvillingar och enhetsidentiteter. Mer information finns i https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub och https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language .

get_devices(max_number_of_devices=None)

Parametrar

Name Description
max_number_of_devices
int

Den här parametern när den anges definierar det maximala antalet enhetsidentiteter som returneras. Alla värden utanför intervallet 1–1 000 anses vara 1 000

standardvärde: None

Returer

Typ Description

Lista över enhetsinformation.

Undantag

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

get_module

Hämtar en modulidentitet för en enhet från IoTHub.

get_module(device_id, module_id)

Parametrar

Name Description
device_id
Obligatorisk
str

Enhetens namn (ID).
module_id
Obligatorisk
str

Namnet (ID) för modulen.

Returer

Typ Description

Modulobjektet som innehåller den begärda modulen.

Undantag

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

get_module_twin

Hämtar en modultvilling.

get_module_twin(device_id, module_id)

Parametrar

Name Description
device_id
Obligatorisk
str

Enhetens namn (ID).
module_id
Obligatorisk
str

Namnet (ID) för modulen.

Returer

Typ Description

Tvillingobjektet.

Undantag

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

get_modules

Hämtar alla modulidentiteter på en enhet.

get_modules(device_id)

Parametrar

Name Description
device_id
Obligatorisk
str

Enhetens namn (ID).

Returer

Typ Description

Listan[Modul] som innehåller alla moduler på enheten.

Undantag

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

get_service_statistics

Hämtar IoTHub-tjänststatistiken.

get_service_statistics()

Returer

Typ Description

ServiceStatistics-objektet.

Undantag

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

get_twin

Hämtar en enhetstvilling.

get_twin(device_id)

Parametrar

Name Description
device_id
Obligatorisk
str

Enhetens namn (ID).

Returer

Typ Description

Tvillingobjektet.

Undantag

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

invoke_device_method

Anropa en direktmetod på en enhet.

invoke_device_method(device_id, direct_method_request)

Parametrar

Name Description
device_id
Obligatorisk
str

Enhetens namn (ID).
direct_method_request
Obligatorisk
CloudToDeviceMethod

Metodbegäran.

Returer

Typ Description

CloudToDeviceMethodResult-objektet.

Undantag

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

invoke_device_module_method

Anropa en direktmetod på en enhet.

invoke_device_module_method(device_id, module_id, direct_method_request)

Parametrar

Name Description
device_id
Obligatorisk
str

Enhetens namn (ID).
module_id
Obligatorisk
str

Namnet (ID) för modulen.
direct_method_request
Obligatorisk
CloudToDeviceMethod

Metodbegäran.

Returer

Typ Description

CloudToDeviceMethodResult-objektet.

Undantag

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

query_iot_hub

Fråga en IoTHub för att hämta information om enhetstvillingar med ett SQL-liknande språk. Mer information finns i https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language. Sidnumrering av resultat stöds. Detta returnerar endast information om enhetstvillingar.

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

Parametrar

Name Description
query
Obligatorisk
QuerySpecification

Frågespecifikationen.
continuation_token
str

Fortsättningstoken för växling

standardvärde: None
max_item_count
str

Maximalt antal begärda enhetstvillingar

standardvärde: None
query_specification
Obligatorisk

Returer

Typ Description

QueryResult-objektet.

Undantag

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

replace_module_twin

Ersätter taggar och önskade egenskaper för en modultvilling.

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

Parametrar

Name Description
device_id
Obligatorisk
str

Enhetens namn (ID).
module_id
Obligatorisk
str

Namnet (ID) för modulen.
module_twin
Obligatorisk
Twin

Tvillinginformationen för modulen.
etag
str

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

standardvärde: None

Returer

Typ Description

Tvillingobjektet.

Undantag

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

replace_twin

Ersätter taggar och önskade egenskaper för en enhetstvilling.

replace_twin(device_id, device_twin, etag=None)

Parametrar

Name Description
device_id
Obligatorisk
str

Enhetens namn (ID).
device_twin
Obligatorisk
Twin

Enhetens tvillinginformation.
etag
str

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

standardvärde: None

Returer

Typ Description

Tvillingobjektet.

Undantag

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

send_c2d_message

Skicka ett C2D-meddelande till en IoTHub-enhet.

send_c2d_message(device_id, message, properties={})

Parametrar

Name Description
device_id
Obligatorisk
str

Enhetens namn (ID).
message
Obligatorisk
str

Meddelandet som ska levereras till enheten.
properties
dict

De egenskaper som ska skickas med meddelandet. Kan innehålla programegenskaper och systemegenskaper

standardvärde: {}

Undantag

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

update_device_with_certificate_authority

Uppdateringar en enhetsidentitet på IoTHub med certifikatutfärdare.

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

Parametrar

Name Description
device_id
Obligatorisk
str

Enhetens namn (ID).
etag
Obligatorisk
str

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

Ursprungligt tillstånd för den skapade enheten. (Möjliga värden: "aktiverad" eller "inaktiverad").
iot_edge
bool

Om den skapade enheten är en IoT Edge enhet eller inte. Standardvärde: Falskt

standardvärde: False
status_reason
str

Orsaken till enhetens identitetsstatus. Standardvärde: Ingen

standardvärde: None
device_scope
str

Enhetens omfång. Standardvärde: Inget automatiskt genererat och oföränderligt för gränsenheter och kan ändras i lövenheter för att skapa en underordnad/överordnad relation. För lövenheter kan värdet för att ange en överordnad gränsenhet hämtas från den överordnade gränsenhetens device_scope egenskap.

standardvärde: None
parent_scopes
Union[list[str], str]

Omfången för de övre gränsenheterna om tillämpligt. Standardvärde: Inget För gränsenheter kan värdet för att ange en överordnad gränsenhet hämtas från den överordnade gränsenhetens device_scope egenskap. För lövenheter kan detta anges till samma värde som device_scope eller lämnas för tjänsten att kopiera över.

standardvärde: None

Returer

Typ Description

Det uppdaterade enhetsobjektet som innehåller den skapade enheten.

Undantag

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

update_device_with_sas

Uppdateringar en enhetsidentitet på IoTHub med hjälp av SAS-autentisering.

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

Parametrar

Name Description
device_id
Obligatorisk
str

Enhetens namn (ID).
etag
Obligatorisk
str

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

Primär autentiseringsnyckel.
secondary_key
Obligatorisk
str

Sekundär autentiseringsnyckel.
status
Obligatorisk
str

Ursprungligt tillstånd för den skapade enheten. (Möjliga värden: "aktiverad" eller "inaktiverad").
iot_edge
bool

Om den skapade enheten är en IoT Edge enhet eller inte. Standardvärde: Falskt

standardvärde: False
status_reason
str

Orsaken till enhetens identitetsstatus. Standardvärde: Ingen

standardvärde: None
device_scope
str

Enhetens omfång. Standardvärde: Inget automatiskt genererat och oföränderligt för gränsenheter och kan ändras i lövenheter för att skapa en underordnad/överordnad relation. För lövenheter kan värdet för att ange en överordnad gränsenhet hämtas från den överordnade gränsenhetens device_scope egenskap.

standardvärde: None
parent_scopes
Union[list[str], str]

Omfången för gränsenheterna på den övre nivån om tillämpligt. Standardvärde: Inget För gränsenheter kan värdet för att ange en överordnad gränsenhet hämtas från den överordnade gränsenhetens egenskap device_scope. För lövenheter kan detta anges till samma värde som device_scope eller lämnas för tjänsten att kopiera över.

standardvärde: None

Returer

Typ Description

Det uppdaterade enhetsobjektet som innehåller den skapade enheten.

Undantag

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

update_device_with_x509

Uppdateringar en enhetsidentitet på IoTHub med X509-autentisering.

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

Parametrar

Name Description
device_id
Obligatorisk
str

Enhetens namn (ID).
etag
Obligatorisk
str

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

Primärt X509-tumavtryck.
secondary_thumbprint
Obligatorisk
str

Sekundärt X509-tumavtryck.
status
Obligatorisk
str

Ursprungligt tillstånd för den skapade enheten. (Möjliga värden: "aktiverad" eller "inaktiverad").
iot_edge
bool

Om den skapade enheten är en IoT Edge enhet eller inte. Standardvärde: Falskt

standardvärde: False
status_reason
str

Orsaken till enhetens identitetsstatus. Standardvärde: Ingen

standardvärde: None
device_scope
str

Enhetens omfång. Standardvärde: Inget automatiskt genererat och oföränderligt för gränsenheter och kan ändras i lövenheter för att skapa en underordnad/överordnad relation. För lövenheter kan värdet för att ange en överordnad gränsenhet hämtas från den överordnade gränsenhetens device_scope egenskap.

standardvärde: None
parent_scopes
Union[list[str], str]

Omfången för gränsenheterna på den övre nivån om tillämpligt. Standardvärde: Inget För gränsenheter kan värdet för att ange en överordnad gränsenhet hämtas från den överordnade gränsenhetens egenskap device_scope. För lövenheter kan detta anges till samma värde som device_scope eller lämnas för tjänsten att kopiera över.

standardvärde: None

Returer

Typ Description

Det uppdaterade enhetsobjektet som innehåller den skapade enheten.

Undantag

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

update_module_twin

Uppdateringar taggar och önskade egenskaper för en modultvilling.

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

Parametrar

Name Description
device_id
Obligatorisk
str

Enhetens namn (ID).
module_id
Obligatorisk
str

Namnet (ID) för modulen.
module_twin
Obligatorisk
Twin

Tvillinginformationen för modulen.
etag
str

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

standardvärde: None

Returer

Typ Description

Tvillingobjektet.

Undantag

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

update_module_with_certificate_authority

Uppdateringar en modulidentitet för en enhet på IoTHub med certifikatutfärdare.

update_module_with_certificate_authority(device_id, module_id, managed_by, etag)

Parametrar

Name Description
device_id
Obligatorisk
str

Enhetens namn (ID).
module_id
Obligatorisk
str

Namnet (ID) för modulen.
managed_by
Obligatorisk
str

Namnet på hanteringsenheten (edge).
etag
Obligatorisk
str

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

Returer

Typ Description

Det uppdaterade modulobjektet som innehåller den skapade modulen.

Undantag

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

update_module_with_sas

Uppdateringar en modulidentitet för en enhet på IoTHub med hjälp av SAS-autentisering.

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

Parametrar

Name Description
device_id
Obligatorisk
str

Enhetens namn (ID).
module_id
Obligatorisk
str

Namnet (ID) för modulen.
managed_by
Obligatorisk
str

Namnet på hanteringsenheten (edge).
etag
Obligatorisk
str

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

Primär autentiseringsnyckel.
secondary_key
Obligatorisk
str

Sekundär autentiseringsnyckel.

Returer

Typ Description

Det uppdaterade modulobjektet som innehåller den skapade modulen.

Undantag

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

update_module_with_x509

Uppdateringar en modulidentitet för en enhet på IoTHub med X509-autentisering.

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

Parametrar

Name Description
device_id
Obligatorisk
str

Enhetens namn (ID).
module_id
Obligatorisk
str

Namnet (ID) för modulen.
managed_by
Obligatorisk
str

Namnet på hanteringsenheten (edge).
etag
Obligatorisk
str

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

Primärt X509-tumavtryck.
secondary_thumbprint
Obligatorisk
str

Sekundärt X509-tumavtryck.

Returer

Typ Description

Det uppdaterade modulobjektet som innehåller den skapade modulen.

Undantag

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

update_twin

Uppdateringar taggar och önskade egenskaper för en enhetstvilling.

update_twin(device_id, device_twin, etag=None)

Parametrar

Name Description
device_id
Obligatorisk
str

Enhetens namn (ID).
device_twin
Obligatorisk
Twin

Enhetens tvillinginformation.
etag
str

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

standardvärde: None

Returer

Typ Description

Tvillingobjektet.

Undantag

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