IoTHubRegistryManager Třída

  • Reference

Třída poskytující pohodlná rozhraní API pro operace IoTHub Registry Manageru, která jsou založená na automaticky generovaných rozhraních REST API IotHubu.

Inicializátor klienta služby Registry Manager.

Uživatelé by to neměli volat přímo. Místo toho by měly být metody from_connection_string() nebo from_token_credential().

Po úspěšném vytvoření se třída ověří pomocí IoTHubu a je připravená volat rozhraní API členů pro komunikaci s IoTHubem.

Dědičnost
builtins.object
IoTHubRegistryManager

Konstruktor

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

Parametry

Name Description
connection_string
str

Připojovací řetězec IoTHubu, který se používá k ověření připojení k IoTHubu, pokud používáme connection_str ověřování. Výchozí hodnota: Žádná

výchozí hodnota: None
host
str

Adresa URL služby Azure, pokud používáme ověřování přihlašovacích údajů tokenu. Výchozí hodnota: Žádná

výchozí hodnota: None
auth
Vyžadováno
str

Objekt ověřování Azure, pokud používáme ověřování přihlašovacích údajů tokenu. Výchozí hodnota: Žádná
token_credential
výchozí hodnota: None

Metody

bulk_create_or_update_devices

Vytvořte, aktualizujte nebo odstraňte identity více zařízení z registru identit IoTHubu.

Vytvořte, aktualizujte nebo odstraňte identity více zařízení z registru identit IoTHubu. Identitu zařízení je možné v seznamu zadat pouze jednou. Různé operace (vytvoření, aktualizace, odstranění) na různých zařízeních jsou povolené. Na jedno vyvolání je možné zadat maximálně 100 zařízení. U rozsáhlých operací škálování zvažte použití funkce importu s využitím úložiště objektů blob(https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities).
create_device_with_certificate_authority

Vytvoří identitu zařízení ve službě IoTHub pomocí certifikační autority.
create_device_with_sas

Vytvoří identitu zařízení ve službě IoTHub pomocí ověřování SAS.
create_device_with_x509

Vytvoří identitu zařízení ve službě IoTHub s využitím ověřování X509.
create_module_with_certificate_authority

Vytvoří identitu modulu pro zařízení v IoTHubu pomocí certifikační autority.
create_module_with_sas

Vytvoří identitu modulu pro zařízení na IoTHubu s využitím ověřování SAS.
create_module_with_x509

Vytvoří identitu modulu pro zařízení na IoTHubu s využitím ověřování X509.
delete_device

Odstraní identitu zařízení z IoTHubu.
delete_module

Odstraní identitu modulu pro zařízení z IoTHubu.
from_connection_string

Inicializátor classmethod pro klienta služby Správce registru. Vytvoří třídu Správce registru z připojovacího řetězce.

Po úspěšném vytvoření se třída ověří pomocí IoTHubu a je připravená volat rozhraní API členů pro komunikaci s IoTHubem.
from_token_credential

Inicializátor classmethod pro klienta služby Správce registru. Vytvoří třídu Registry Manageru z adresy URL názvu hostitele a přihlašovacích údajů tokenu Azure.

Po úspěšném vytvoření se třída ověří pomocí IoTHubu a je připravená volat rozhraní API členů pro komunikaci s IoTHubem.
get_device

Načte identitu zařízení z IoTHubu.
get_device_registry_statistics

Načte statistiku registru zařízení IoTHub.
get_devices

Získejte identity více zařízení z registru identit IoTHubu. Nedoporučuje se. K načtení informací o identitě dvojčete zařízení a informací o identitě zařízení použijte dotazovací jazyk IoTHub. Další informace najdete v tématu https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub a https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language .
get_module

Načte identitu modulu pro zařízení z IoTHubu.
get_module_twin

Získá dvojče modulu.
get_modules

Načte všechny identity modulů na zařízení.
get_service_statistics

Načte statistiku služby IoTHub.
get_twin

Získá dvojče zařízení.
invoke_device_method

Vyvolání přímé metody na zařízení
invoke_device_module_method

Vyvolání přímé metody na zařízení
query_iot_hub

Dotazem na IoTHub načtěte informace o dvojčatech zařízení pomocí jazyka podobného SQL. Další informace naleznete v tématu https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language. Stránkování výsledků je podporováno. Tím se vrátí pouze informace o dvojčatech zařízení.
replace_module_twin

Nahradí značky a požadované vlastnosti dvojčete modulu.
replace_twin

Nahradí značky a požadované vlastnosti dvojčete zařízení.
send_c2d_message

Odeslání zprávy C2D do zařízení IoTHub
update_device_with_certificate_authority

Aktualizace identitu zařízení v IoTHubu pomocí certifikační autority.
update_device_with_sas

Aktualizace identitu zařízení na IoTHubu pomocí ověřování SAS.
update_device_with_x509

Aktualizace identitu zařízení na IoTHubu pomocí ověřování X509.
update_module_twin

Aktualizace značky a požadované vlastnosti dvojčete modulu.
update_module_with_certificate_authority

Aktualizace identitu modulu pro zařízení v IoTHubu pomocí certifikační autority.
update_module_with_sas

Aktualizace identitu modulu pro zařízení na IoTHubu pomocí ověřování SAS.
update_module_with_x509

Aktualizace identitu modulu pro zařízení na IoTHubu pomocí ověřování X509.
update_twin

Aktualizace značky a požadované vlastnosti dvojčete zařízení.

bulk_create_or_update_devices

Vytvořte, aktualizujte nebo odstraňte identity více zařízení z registru identit IoTHubu.

Vytvořte, aktualizujte nebo odstraňte identity více zařízení z registru identit IoTHubu. Identitu zařízení je možné v seznamu zadat pouze jednou. Různé operace (vytvoření, aktualizace, odstranění) na různých zařízeních jsou povolené. Na jedno vyvolání je možné zadat maximálně 100 zařízení. U rozsáhlých operací škálování zvažte použití funkce importu s využitím úložiště objektů blob(https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities).

bulk_create_or_update_devices(devices)

Parametry

Name Description
devices
Vyžadováno
list[ExportImportDevice]

Seznam objektů zařízení, na kterých se má pracovat.

Návraty

Typ Description

Objekt BulkRegistryOperationResult.

Výjimky

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

create_device_with_certificate_authority

Vytvoří identitu zařízení ve službě IoTHub pomocí certifikační autority.

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

Parametry

Name Description
device_id
Vyžadováno
str

Název (ID) zařízení.
status
Vyžadováno
str

Počáteční stav vytvořeného zařízení. (Možné hodnoty: "povoleno" nebo "zakázáno").
iot_edge
bool

Jestli je vytvořené zařízení IoT Edge zařízení. Výchozí hodnota: False

výchozí hodnota: False
status_reason
str

Důvod stavu identity zařízení. Výchozí hodnota: Žádná

výchozí hodnota: None
device_scope
str

Rozsah zařízení. Výchozí hodnota: Žádná Automaticky generovaná a neměnná pro hraniční zařízení a upravitelná v zařízeních typu list, aby se vytvořil vztah podřízenosti a nadřazenosti. U zařízení typu list je možné hodnotu pro nastavení nadřazeného hraničního zařízení načíst z vlastnosti device_scope nadřazeného hraničního zařízení.

výchozí hodnota: None
parent_scopes
Union[list[str], str]

Rozsahy hraničních zařízení horní úrovně, pokud jsou k dispozici. Výchozí hodnota: Žádná U hraničních zařízení je možné hodnotu nastavení nadřazeného hraničního zařízení načíst z vlastnosti device_scope nadřazeného hraničního zařízení. U zařízení typu list to může být nastaveno na stejnou hodnotu jako device_scope nebo ponecháno na kopírování služby.

výchozí hodnota: None

Návraty

Typ Description

Objekt zařízení obsahující vytvořené zařízení.

Výjimky

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

create_device_with_sas

Vytvoří identitu zařízení ve službě IoTHub pomocí ověřování SAS.

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

Parametry

Name Description
device_id
Vyžadováno
str

Název (ID) zařízení.
primary_key
Vyžadováno
str

Primární ověřovací klíč.
secondary_key
Vyžadováno
str

Sekundární ověřovací klíč.
status
Vyžadováno
str

Počáteční stav vytvořeného zařízení. (Možné hodnoty: "povoleno" nebo "zakázáno")
iot_edge
bool

Jestli je vytvořené zařízení IoT Edge zařízení. Výchozí hodnota: False

výchozí hodnota: False
status_reason
str

Důvod stavu identity zařízení. Výchozí hodnota: Žádná

výchozí hodnota: None
device_scope
str

Rozsah zařízení. Výchozí hodnota: Žádná Automaticky generovaná a neměnná pro hraniční zařízení a upravitelná v zařízeních typu list, aby se vytvořil vztah podřízenosti a nadřazenosti. U zařízení typu list je možné hodnotu pro nastavení nadřazeného hraničního zařízení načíst z vlastnosti device_scope nadřazeného hraničního zařízení.

výchozí hodnota: None
parent_scopes
Union[list[str], str]

Rozsahy hraničních zařízení horní úrovně, pokud jsou k dispozici. Výchozí hodnota: Žádná U hraničních zařízení je možné hodnotu nastavení nadřazeného hraničního zařízení načíst z vlastnosti device_scope nadřazeného hraničního zařízení. U zařízení typu list to může být nastaveno na stejnou hodnotu jako device_scope nebo ponecháno na kopírování služby.

výchozí hodnota: None

Návraty

Typ Description

Objekt zařízení obsahující vytvořené zařízení.

Výjimky

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

create_device_with_x509

Vytvoří identitu zařízení ve službě IoTHub s využitím ověřování X509.

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

Parametry

Name Description
device_id
Vyžadováno
str

Název (ID) zařízení.
primary_thumbprint
Vyžadováno
str

Primární kryptografický otisk X509.
secondary_thumbprint
Vyžadováno
str

Sekundární kryptografický otisk X509.
status
Vyžadováno
str

Počáteční stav vytvořeného zařízení. (Možné hodnoty: "povoleno" nebo "zakázáno")
iot_edge
bool

Jestli je vytvořené zařízení IoT Edge zařízení. Výchozí hodnota: False

výchozí hodnota: False
status_reason
str

Důvod stavu identity zařízení. Výchozí hodnota: Žádná

výchozí hodnota: None
device_scope
str

Rozsah zařízení. Výchozí hodnota: Žádná Automaticky generovaná a neměnná pro hraniční zařízení a upravitelná v zařízeních typu list, aby se vytvořil vztah podřízenosti a nadřazenosti. U zařízení typu list je možné hodnotu pro nastavení nadřazeného hraničního zařízení načíst z vlastnosti device_scope nadřazeného hraničního zařízení.

výchozí hodnota: None
parent_scopes
Union[list[str], str]

Rozsahy hraničních zařízení horní úrovně, pokud jsou k dispozici. Výchozí hodnota: Žádná U hraničních zařízení je možné hodnotu nastavení nadřazeného hraničního zařízení načíst z vlastnosti device_scope nadřazeného hraničního zařízení. U zařízení typu list to může být nastaveno na stejnou hodnotu jako device_scope nebo ponecháno na kopírování služby.

výchozí hodnota: None

Návraty

Typ Description

Objekt zařízení obsahující vytvořené zařízení.

Výjimky

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

create_module_with_certificate_authority

Vytvoří identitu modulu pro zařízení v IoTHubu pomocí certifikační autority.

create_module_with_certificate_authority(device_id, module_id, managed_by)

Parametry

Name Description
device_id
Vyžadováno
str

Název (ID) zařízení.
module_id
Vyžadováno
str

Název (ID) modulu.
managed_by
Vyžadováno
str

Název zařízení správce (edge).

Návraty

Typ Description

Objekt modulu obsahující vytvořený modul.

Výjimky

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

create_module_with_sas

Vytvoří identitu modulu pro zařízení na IoTHubu s využitím ověřování SAS.

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

Parametry

Name Description
device_id
Vyžadováno
str

Název (ID) zařízení.
module_id
Vyžadováno
str

Název (ID) modulu.
managed_by
Vyžadováno
str

Název zařízení správce (edge).
primary_key
Vyžadováno
str

Primární ověřovací klíč.
secondary_key
Vyžadováno
str

Sekundární ověřovací klíč.

Návraty

Typ Description

Objekt modulu obsahující vytvořený modul.

Výjimky

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

create_module_with_x509

Vytvoří identitu modulu pro zařízení na IoTHubu s využitím ověřování X509.

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

Parametry

Name Description
device_id
Vyžadováno
str

Název (ID) zařízení.
module_id
Vyžadováno
str

Název (ID) modulu.
managed_by
Vyžadováno
str

Název zařízení správce (edge).
primary_thumbprint
Vyžadováno
str

Primární kryptografický otisk X509.
secondary_thumbprint
Vyžadováno
str

Sekundární kryptografický otisk X509.

Návraty

Typ Description

Objekt modulu obsahující vytvořený modul.

Výjimky

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

delete_device

Odstraní identitu zařízení z IoTHubu.

delete_device(device_id, etag=None)

Parametry

Name Description
device_id
Vyžadováno
str

Název (ID) zařízení.
etag
str

Hodnota etag (if_match), která se má použít pro operaci odstranění.

výchozí hodnota: None

Návraty

Typ Description

Žádné

Výjimky

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

delete_module

Odstraní identitu modulu pro zařízení z IoTHubu.

delete_module(device_id, module_id, etag=None)

Parametry

Name Description
device_id
Vyžadováno
str

Název (ID) zařízení.
module_id
Vyžadováno
str

Název (ID) modulu.
etag
str

Hodnota značky (if_match), která se má použít pro operaci odstranění.

výchozí hodnota: None

Návraty

Typ Description

Žádné

Výjimky

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

from_connection_string

Inicializátor classmethod pro klienta služby Správce registru. Vytvoří třídu Správce registru z připojovacího řetězce.

Po úspěšném vytvoření se třída ověří pomocí IoTHubu a je připravená volat rozhraní API členů pro komunikaci s IoTHubem.

from_connection_string(connection_string)

Parametry

Name Description
connection_string
Vyžadováno
str

Připojovací řetězec IoTHubu, který slouží k ověření připojení k IoTHubu.

Návraty

Typ Description
IoTHubRegistryManager

Výjimky

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

from_token_credential

Inicializátor classmethod pro klienta služby Správce registru. Vytvoří třídu Registry Manageru z adresy URL názvu hostitele a přihlašovacích údajů tokenu Azure.

Po úspěšném vytvoření se třída ověří pomocí IoTHubu a je připravená volat rozhraní API členů pro komunikaci s IoTHubem.

from_token_credential(url, token_credential)

Parametry

Name Description
url
Vyžadováno
str

Adresa URL služby Azure (název hostitele).
token_credential
Vyžadováno
<xref:azure.core.TokenCredential>

Objekt přihlašovacích údajů tokenu Azure

Návraty

Typ Description
IoTHubRegistryManager

Výjimky

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

get_device

Načte identitu zařízení z IoTHubu.

get_device(device_id)

Parametry

Name Description
device_id
Vyžadováno
str

Název (ID) zařízení.

Návraty

Typ Description

Objekt Device obsahující požadované zařízení.

Výjimky

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

get_device_registry_statistics

Načte statistiku registru zařízení IoTHub.

get_device_registry_statistics()

Návraty

Typ Description

Objekt RegistryStatistics.

Výjimky

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

get_devices

Získejte identity více zařízení z registru identit IoTHubu. Nedoporučuje se. K načtení informací o identitě dvojčete zařízení a informací o identitě zařízení použijte dotazovací jazyk IoTHub. Další informace najdete v tématu https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub a https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language .

get_devices(max_number_of_devices=None)

Parametry

Name Description
max_number_of_devices
int

Tento parametr při zadání definuje maximální počet vrácených identit zařízení. Jakákoli hodnota mimo rozsah 1–1000 se považuje za 1000.

výchozí hodnota: None

Návraty

Typ Description

Seznam informací o zařízení

Výjimky

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

get_module

Načte identitu modulu pro zařízení z IoTHubu.

get_module(device_id, module_id)

Parametry

Name Description
device_id
Vyžadováno
str

Název (ID) zařízení.
module_id
Vyžadováno
str

Název (ID) modulu.

Návraty

Typ Description

Objekt Module obsahující požadovaný modul.

Výjimky

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

get_module_twin

Získá dvojče modulu.

get_module_twin(device_id, module_id)

Parametry

Name Description
device_id
Vyžadováno
str

Název (ID) zařízení.
module_id
Vyžadováno
str

Název (ID) modulu.

Návraty

Typ Description

Objekt Twin.

Výjimky

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

get_modules

Načte všechny identity modulů na zařízení.

get_modules(device_id)

Parametry

Name Description
device_id
Vyžadováno
str

Název (ID) zařízení.

Návraty

Typ Description

Seznam[Modul] obsahující všechny moduly na zařízení.

Výjimky

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

get_service_statistics

Načte statistiku služby IoTHub.

get_service_statistics()

Návraty

Typ Description

Objekt ServiceStatistics.

Výjimky

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

get_twin

Získá dvojče zařízení.

get_twin(device_id)

Parametry

Name Description
device_id
Vyžadováno
str

Název (ID) zařízení.

Návraty

Typ Description

Objekt Twin.

Výjimky

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

invoke_device_method

Vyvolání přímé metody na zařízení

invoke_device_method(device_id, direct_method_request)

Parametry

Name Description
device_id
Vyžadováno
str

Název (ID) zařízení.
direct_method_request
Vyžadováno
CloudToDeviceMethod

Požadavek metody.

Návraty

Typ Description

Objekt CloudToDeviceMethodResult.

Výjimky

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

invoke_device_module_method

Vyvolání přímé metody na zařízení

invoke_device_module_method(device_id, module_id, direct_method_request)

Parametry

Name Description
device_id
Vyžadováno
str

Název (ID) zařízení.
module_id
Vyžadováno
str

Název (ID) modulu.
direct_method_request
Vyžadováno
CloudToDeviceMethod

Požadavek metody.

Návraty

Typ Description

Objekt CloudToDeviceMethodResult.

Výjimky

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

query_iot_hub

Dotazem na IoTHub načtěte informace o dvojčatech zařízení pomocí jazyka podobného SQL. Další informace naleznete v tématu https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language. Stránkování výsledků je podporováno. Tím se vrátí pouze informace o dvojčatech zařízení.

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

Parametry

Name Description
query
Vyžadováno
QuerySpecification

Specifikace dotazu.
continuation_token
str

Token pokračování pro stránkování

výchozí hodnota: None
max_item_count
str

Maximální počet požadovaných dvojčat zařízení

výchozí hodnota: None
query_specification
Vyžadováno

Návraty

Typ Description

The QueryResult objekt.

Výjimky

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

replace_module_twin

Nahradí značky a požadované vlastnosti dvojčete modulu.

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

Parametry

Name Description
device_id
Vyžadováno
str

Název (ID) zařízení.
module_id
Vyžadováno
str

Název (ID) modulu.
module_twin
Vyžadováno
Twin

Informace o dvojčeti modulu.
etag
str

Hodnota značky (if_match), která se má použít pro operaci nahrazení.

výchozí hodnota: None

Návraty

Typ Description

Objekt Twin.

Výjimky

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

replace_twin

Nahradí značky a požadované vlastnosti dvojčete zařízení.

replace_twin(device_id, device_twin, etag=None)

Parametry

Name Description
device_id
Vyžadováno
str

Název (ID) zařízení.
device_twin
Vyžadováno
Twin

Informace o dvojčeti zařízení.
etag
str

Hodnota značky (if_match), která se má použít pro operaci nahrazení.

výchozí hodnota: None

Návraty

Typ Description

Objekt Twin.

Výjimky

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

send_c2d_message

Odeslání zprávy C2D do zařízení IoTHub

send_c2d_message(device_id, message, properties={})

Parametry

Name Description
device_id
Vyžadováno
str

Název (ID) zařízení.
message
Vyžadováno
str

Zpráva, která se má doručit do zařízení.
properties
dict

Vlastnosti, které se mají se zprávou odeslat. Může obsahovat vlastnosti aplikace a systémové vlastnosti.

výchozí hodnota: {}

Výjimky

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

update_device_with_certificate_authority

Aktualizace identitu zařízení v IoTHubu pomocí certifikační autority.

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

Parametry

Name Description
device_id
Vyžadováno
str

Název (ID) zařízení.
etag
Vyžadováno
str

Hodnota značky (if_match), která se má použít pro operaci aktualizace.
status
Vyžadováno
str

Počáteční stav vytvořeného zařízení. (Možné hodnoty: "povoleno" nebo "zakázáno").
iot_edge
bool

Zda je vytvořené zařízení IoT Edge zařízení. Výchozí hodnota: False

výchozí hodnota: False
status_reason
str

Důvod stavu identity zařízení. Výchozí hodnota: Žádná

výchozí hodnota: None
device_scope
str

Rozsah zařízení. Výchozí hodnota: None Automaticky vygenerovaný a neměnný pro hraniční zařízení a upravitelný v zařízeních typu list, aby se vytvořil vztah podřízenosti a nadřazenosti. U zařízení typu list je možné hodnotu pro nastavení nadřazeného hraničního zařízení načíst z vlastnosti device_scope nadřazeného hraničního zařízení.

výchozí hodnota: None
parent_scopes
Union[list[str], str]

Rozsahy hraničních zařízení horní úrovně, pokud jsou k dispozici. Výchozí hodnota: Žádné U hraničních zařízení je možné hodnotu pro nastavení nadřazeného hraničního zařízení načíst z vlastnosti device_scope nadřazeného hraničního zařízení. U zařízení typu list může být tato hodnota nastavená na stejnou hodnotu jako device_scope nebo ponechána na kopírování služby.

výchozí hodnota: None

Návraty

Typ Description

Aktualizovaný objekt Device obsahující vytvořené zařízení.

Výjimky

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

update_device_with_sas

Aktualizace identitu zařízení na IoTHubu pomocí ověřování SAS.

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

Parametry

Name Description
device_id
Vyžadováno
str

Název (ID) zařízení.
etag
Vyžadováno
str

Hodnota značky (if_match), která se má použít pro operaci aktualizace.
primary_key
Vyžadováno
str

Primární ověřovací klíč.
secondary_key
Vyžadováno
str

Sekundární ověřovací klíč.
status
Vyžadováno
str

Počáteční stav vytvořeného zařízení. (Možné hodnoty: "povoleno" nebo "zakázáno").
iot_edge
bool

Zda je vytvořené zařízení IoT Edge zařízení. Výchozí hodnota: False

výchozí hodnota: False
status_reason
str

Důvod stavu identity zařízení. Výchozí hodnota: Žádná

výchozí hodnota: None
device_scope
str

Rozsah zařízení. Výchozí hodnota: None Automaticky vygenerovaný a neměnný pro hraniční zařízení a upravitelný v zařízeních typu list, aby se vytvořil vztah podřízenosti a nadřazenosti. U zařízení typu list je možné hodnotu pro nastavení nadřazeného hraničního zařízení načíst z vlastnosti device_scope nadřazeného hraničního zařízení.

výchozí hodnota: None
parent_scopes
Union[list[str], str]

Rozsahy hraničních zařízení horní úrovně, pokud jsou k dispozici. Výchozí hodnota: Žádné U hraničních zařízení je možné hodnotu pro nastavení nadřazeného hraničního zařízení načíst z vlastnosti device_scope nadřazeného hraničního zařízení. U zařízení typu list může být tato hodnota nastavená na stejnou hodnotu jako device_scope nebo ponechána na kopírování služby.

výchozí hodnota: None

Návraty

Typ Description

Aktualizovaný objekt Device obsahující vytvořené zařízení.

Výjimky

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

update_device_with_x509

Aktualizace identitu zařízení na IoTHubu pomocí ověřování 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)

Parametry

Name Description
device_id
Vyžadováno
str

Název (ID) zařízení.
etag
Vyžadováno
str

Hodnota značky (if_match), která se má použít pro operaci aktualizace.
primary_thumbprint
Vyžadováno
str

Primární kryptografický otisk X509.
secondary_thumbprint
Vyžadováno
str

Sekundární kryptografický otisk X509.
status
Vyžadováno
str

Počáteční stav vytvořeného zařízení. (Možné hodnoty: "povoleno" nebo "zakázáno").
iot_edge
bool

Zda je vytvořené zařízení IoT Edge zařízení. Výchozí hodnota: False

výchozí hodnota: False
status_reason
str

Důvod stavu identity zařízení. Výchozí hodnota: Žádná

výchozí hodnota: None
device_scope
str

Rozsah zařízení. Výchozí hodnota: None Automaticky vygenerovaný a neměnný pro hraniční zařízení a upravitelný v zařízeních typu list, aby se vytvořil vztah podřízenosti a nadřazenosti. U zařízení typu list je možné hodnotu pro nastavení nadřazeného hraničního zařízení načíst z vlastnosti device_scope nadřazeného hraničního zařízení.

výchozí hodnota: None
parent_scopes
Union[list[str], str]

Rozsahy hraničních zařízení horní úrovně, pokud jsou k dispozici. Výchozí hodnota: Žádné U hraničních zařízení je možné hodnotu pro nastavení nadřazeného hraničního zařízení načíst z vlastnosti device_scope nadřazeného hraničního zařízení. U zařízení typu list může být tato hodnota nastavená na stejnou hodnotu jako device_scope nebo ponechána na kopírování služby.

výchozí hodnota: None

Návraty

Typ Description

Aktualizovaný objekt Device obsahující vytvořené zařízení.

Výjimky

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

update_module_twin

Aktualizace značky a požadované vlastnosti dvojčete modulu.

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

Parametry

Name Description
device_id
Vyžadováno
str

Název (ID) zařízení.
module_id
Vyžadováno
str

Název (ID) modulu.
module_twin
Vyžadováno
Twin

Informace o dvojčeti modulu.
etag
str

Hodnota značky (if_match), která se má použít pro operaci aktualizace.

výchozí hodnota: None

Návraty

Typ Description

Objekt Twin.

Výjimky

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

update_module_with_certificate_authority

Aktualizace identitu modulu pro zařízení v IoTHubu pomocí certifikační autority.

update_module_with_certificate_authority(device_id, module_id, managed_by, etag)

Parametry

Name Description
device_id
Vyžadováno
str

Název (ID) zařízení.
module_id
Vyžadováno
str

Název (ID) modulu.
managed_by
Vyžadováno
str

Název zařízení správce (edge).
etag
Vyžadováno
str

Hodnota značky (if_match), která se má použít pro operaci aktualizace.

Návraty

Typ Description

Aktualizovaný objekt Module obsahující vytvořený modul.

Výjimky

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

update_module_with_sas

Aktualizace identitu modulu pro zařízení na IoTHubu pomocí ověřování SAS.

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

Parametry

Name Description
device_id
Vyžadováno
str

Název (ID) zařízení.
module_id
Vyžadováno
str

Název (ID) modulu.
managed_by
Vyžadováno
str

Název zařízení správce (edge).
etag
Vyžadováno
str

Hodnota značky (if_match), která se má použít pro operaci aktualizace.
primary_key
Vyžadováno
str

Primární ověřovací klíč.
secondary_key
Vyžadováno
str

Sekundární ověřovací klíč.

Návraty

Typ Description

Aktualizovaný objekt Module obsahující vytvořený modul.

Výjimky

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

update_module_with_x509

Aktualizace identitu modulu pro zařízení na IoTHubu pomocí ověřování X509.

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

Parametry

Name Description
device_id
Vyžadováno
str

Název (ID) zařízení.
module_id
Vyžadováno
str

Název (ID) modulu.
managed_by
Vyžadováno
str

Název zařízení správce (edge).
etag
Vyžadováno
str

Hodnota značky (if_match), která se má použít pro operaci aktualizace.
primary_thumbprint
Vyžadováno
str

Primární kryptografický otisk X509.
secondary_thumbprint
Vyžadováno
str

Sekundární kryptografický otisk X509.

Návraty

Typ Description

Aktualizovaný objekt Module obsahující vytvořený modul.

Výjimky

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

update_twin

Aktualizace značky a požadované vlastnosti dvojčete zařízení.

update_twin(device_id, device_twin, etag=None)

Parametry

Name Description
device_id
Vyžadováno
str

Název (ID) zařízení.
device_twin
Vyžadováno
Twin

Informace o dvojčeti zařízení.
etag
str

Hodnota značky (if_match), která se má použít pro operaci aktualizace.

výchozí hodnota: None

Návraty

Typ Description

Objekt Twin.

Výjimky

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