IoTHubRegistryManager Osztály
Az automatikusan létrehozott IotHub REST API-kon alapuló, az IoTHub Registry Manager műveleteihez használható kényelmi API-kat biztosító osztály
Registry Manager-szolgáltatásügyfél Inicializálója.
A felhasználók ezt nem hívhatják meg közvetlenül. Ehelyett a from_connection_string() vagy from_token_credential() gyári metódusokat kell használniuk.
A sikeres létrehozás után az osztály hitelesítése megtörtént az IoTHubon, és készen áll arra, hogy meghívja a tag API-kat az IoTHubbal való kommunikációhoz.
- Öröklődés
-
builtins.objectIoTHubRegistryManager
Konstruktor
IoTHubRegistryManager(connection_string=None, host=None, token_credential=None)Paraméterek
| Name | Description |
|---|---|
|
connection_string
|
Az IoTHub kapcsolati sztring az IoTHubtal való kapcsolat hitelesítésére, ha connection_str hitelesítést használunk. Alapértelmezett érték: Nincs alapértelmezett érték: None
|
|
host
|
Az Azure-szolgáltatás URL-címe, ha token hitelesítő adatokat használunk. Alapértelmezett érték: Nincs alapértelmezett érték: None
|
|
auth
Kötelező
|
Az Azure-hitelesítési objektum, ha token hitelesítő adatokat használunk. Alapértelmezett érték: Nincs |
|
token_credential
|
alapértelmezett érték: None
|
Metódusok
| bulk_create_or_update_devices |
Több eszköz identitásainak létrehozása, frissítése vagy törlése az IoTHub-identitásjegyzékből. Több eszköz identitásainak létrehozása, frissítése vagy törlése az IoTHub-identitásjegyzékből. Az eszközidentitás csak egyszer adható meg a listában. Különböző eszközökön különböző műveletek (létrehozás, frissítés, törlés) engedélyezettek. Hívásonként legfeljebb 100 eszköz adható meg. Nagy léptékű műveletek esetén fontolja meg az importálási funkció használatát a Blob Storage()https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities használatával. |
| create_device_with_certificate_authority |
Létrehoz egy eszközidentitást az IoTHubon hitelesítésszolgáltató használatával. |
| create_device_with_sas |
Eszközidentitást hoz létre az IoTHubon SAS-hitelesítéssel. |
| create_device_with_x509 |
Létrehoz egy eszközidentitást az IoTHubon X509-hitelesítéssel. |
| create_module_with_certificate_authority |
Modulidentitást hoz létre egy eszközhöz az IoTHubon hitelesítésszolgáltató használatával. |
| create_module_with_sas |
Létrehoz egy modulidentitást egy eszközhöz az IoTHubon SAS-hitelesítéssel. |
| create_module_with_x509 |
X509-hitelesítéssel létrehoz egy modulidentitást egy eszközhöz az IoTHubon. |
| delete_device |
Eszközidentitás törlése az IoTHubról. |
| delete_module |
Törli az eszköz modulidentitását az IoTHubról. |
| from_connection_string |
Classmethod initializer egy Registry Manager-szolgáltatásügyfélhez. Létrehozza a Registry Manager osztályt kapcsolati sztring. A sikeres létrehozás után az osztály hitelesítése megtörtént az IoTHubon, és készen áll arra, hogy meghívja a tag API-kat az IoTHubbal való kommunikációhoz. |
| from_token_credential |
Classmethod initializer egy Registry Manager-szolgáltatásügyfélhez. Létrehozza a Registry Manager-osztályt a gazdagépnév URL-címéből és az Azure-jogkivonat hitelesítő adataiból. A sikeres létrehozás után az osztály hitelesítése megtörtént az IoTHubon, és készen áll arra, hogy meghívja a tag API-kat az IoTHubbal való kommunikációhoz. |
| get_device |
Lekéri az eszközidentitást az IoTHubról. |
| get_device_registry_statistics |
Lekéri az IoTHub-eszközregisztrációs adatbázis statisztikáit. |
| get_devices |
Több eszköz identitásának lekérése az IoTHub-identitásjegyzékből. Nem ajánlott. Az IoTHub lekérdezési nyelv használatával lekérheti az ikereszköz- és eszközidentitás-adatokat. További információt a és https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language a című témakörben https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub talál. |
| get_module |
Lekéri egy eszköz modulidentitását az IoTHubról. |
| get_module_twin |
Lekér egy ikermodult. |
| get_modules |
Lekéri az eszköz összes modulidentitását. |
| get_service_statistics |
Lekéri az IoTHub szolgáltatásstatisztikáit. |
| get_twin |
Lekér egy ikereszközt. |
| invoke_device_method |
Közvetlen metódus meghívása egy eszközön. |
| invoke_device_module_method |
Közvetlen metódus meghívása egy eszközön. |
| query_iot_hub |
IoTHub lekérdezése az ikereszközökkel kapcsolatos információk SQL-szerű nyelv használatával történő lekéréséhez. További információ: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language. Az eredmények lapozása támogatott. Ez csak az ikereszközökkel kapcsolatos információkat adja vissza. |
| replace_module_twin |
Lecseréli egy modul ikerpéldány címkéit és kívánt tulajdonságait. |
| replace_twin |
Lecseréli egy ikereszköz címkéit és kívánt tulajdonságait. |
| send_c2d_message |
C2D-üzenet küldése IoTHub-eszközre. |
| update_device_with_certificate_authority |
Frissítések egy eszközidentitást az IoTHubon hitelesítésszolgáltató használatával. |
| update_device_with_sas |
Frissítések eszközidentitást az IoTHubon SAS-hitelesítéssel. |
| update_device_with_x509 |
X509-hitelesítéssel Frissítések eszközidentitást az IoTHubon. |
| update_module_twin |
Frissítések ikermodul címkéinek és kívánt tulajdonságainak. |
| update_module_with_certificate_authority |
Frissítések egy eszköz modulidentitását az IoTHubon hitelesítésszolgáltató használatával. |
| update_module_with_sas |
Frissítések egy eszköz modulidentitását az IoTHubon SAS-hitelesítéssel. |
| update_module_with_x509 |
X509-hitelesítéssel Frissítések egy eszköz modulidentitását az IoTHubon. |
| update_twin |
Frissítések ikereszköz címkéinek és kívánt tulajdonságainak. |
bulk_create_or_update_devices
Több eszköz identitásainak létrehozása, frissítése vagy törlése az IoTHub-identitásjegyzékből.
Több eszköz identitásainak létrehozása, frissítése vagy törlése az IoTHub-identitásjegyzékből. Az eszközidentitás csak egyszer adható meg a listában. Különböző eszközökön különböző műveletek (létrehozás, frissítés, törlés) engedélyezettek. Hívásonként legfeljebb 100 eszköz adható meg. Nagy léptékű műveletek esetén fontolja meg az importálási funkció használatát a Blob Storage()https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities használatával.
bulk_create_or_update_devices(devices)Paraméterek
| Name | Description |
|---|---|
|
devices
Kötelező
|
A működtetni kívánt eszközobjektumok listája. |
Válaszok
| Típus | Description |
|---|---|
|
A BulkRegistryOperationResult objektum. |
Kivételek
| Típus | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
create_device_with_certificate_authority
Létrehoz egy eszközidentitást az IoTHubon hitelesítésszolgáltató használatával.
create_device_with_certificate_authority(device_id, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)Paraméterek
| Name | Description |
|---|---|
|
device_id
Kötelező
|
Az eszköz neve (azonosítója). |
|
status
Kötelező
|
A létrehozott eszköz kezdeti állapota. (Lehetséges értékek: "engedélyezve" vagy "letiltva"). |
|
iot_edge
|
Azt jelzi, hogy a létrehozott eszköz IoT Edge-e. Alapértelmezett érték: Hamis alapértelmezett érték: False
|
|
status_reason
|
Az eszközidentitás állapotának oka. Alapértelmezett érték: Nincs alapértelmezett érték: None
|
|
device_scope
|
Az eszköz hatóköre. Alapértelmezett érték: Nincs automatikusan létrehozott és nem módosítható a peremeszközökhöz, és módosítható a levéleszközökben a gyermek-szülő kapcsolat létrehozásához. Levéleszközök esetén a szülő éleszköz beállításának értéke lekérhető a szülő peremeszköz device_scope tulajdonságából. alapértelmezett érték: None
|
|
parent_scopes
|
A felső szintű peremeszközök hatókörei, ha vannak. Alapértelmezett érték: Nincs A peremhálózati eszközök esetében a szülő peremhálózati eszköz beállításának értéke lekérhető a szülő peremhálózati eszköz device_scope tulajdonságából. A levéleszközök esetében ez a device_scope értékre állítható be, vagy a szolgáltatás átmásolásához balra. alapértelmezett érték: None
|
Válaszok
| Típus | Description |
|---|---|
|
A létrehozott eszközt tartalmazó eszközobjektum. |
Kivételek
| Típus | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
create_device_with_sas
Eszközidentitást hoz létre az IoTHubon SAS-hitelesítéssel.
create_device_with_sas(device_id, primary_key, secondary_key, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)Paraméterek
| Name | Description |
|---|---|
|
device_id
Kötelező
|
Az eszköz neve (azonosítója). |
|
primary_key
Kötelező
|
Elsődleges hitelesítési kulcs. |
|
secondary_key
Kötelező
|
Másodlagos hitelesítési kulcs. |
|
status
Kötelező
|
A létrehozott eszköz kezdeti állapota. (Lehetséges értékek: "engedélyezve" vagy "letiltva") |
|
iot_edge
|
Azt jelzi, hogy a létrehozott eszköz IoT Edge-e. Alapértelmezett érték: Hamis alapértelmezett érték: False
|
|
status_reason
|
Az eszközidentitás állapotának oka. Alapértelmezett érték: Nincs alapértelmezett érték: None
|
|
device_scope
|
Az eszköz hatóköre. Alapértelmezett érték: Nincs automatikusan létrehozott és nem módosítható a peremeszközökhöz, és módosítható a levéleszközökben a gyermek-szülő kapcsolat létrehozásához. Levéleszközök esetén a szülő éleszköz beállításának értéke lekérhető a szülő peremeszköz device_scope tulajdonságából. alapértelmezett érték: None
|
|
parent_scopes
|
A felső szintű peremeszközök hatókörei, ha vannak. Alapértelmezett érték: Nincs A peremhálózati eszközök esetében a szülő peremhálózati eszköz beállításának értéke lekérhető a szülő peremhálózati eszköz device_scope tulajdonságából. A levéleszközök esetében ez a device_scope értékre állítható be, vagy a szolgáltatás átmásolásához balra. alapértelmezett érték: None
|
Válaszok
| Típus | Description |
|---|---|
|
A létrehozott eszközt tartalmazó eszközobjektum. |
Kivételek
| Típus | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
create_device_with_x509
Létrehoz egy eszközidentitást az IoTHubon X509-hitelesítéssel.
create_device_with_x509(device_id, primary_thumbprint, secondary_thumbprint, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)Paraméterek
| Name | Description |
|---|---|
|
device_id
Kötelező
|
Az eszköz neve (azonosítója). |
|
primary_thumbprint
Kötelező
|
Elsődleges X509 ujjlenyomat. |
|
secondary_thumbprint
Kötelező
|
Másodlagos X509 ujjlenyomat. |
|
status
Kötelező
|
A létrehozott eszköz kezdeti állapota. (Lehetséges értékek: "engedélyezve" vagy "letiltva") |
|
iot_edge
|
Azt jelzi, hogy a létrehozott eszköz IoT Edge-e. Alapértelmezett érték: Hamis alapértelmezett érték: False
|
|
status_reason
|
Az eszközidentitás állapotának oka. Alapértelmezett érték: Nincs alapértelmezett érték: None
|
|
device_scope
|
Az eszköz hatóköre. Alapértelmezett érték: Nincs automatikusan létrehozott és nem módosítható a peremeszközökhöz, és módosítható a levéleszközökben a gyermek-szülő kapcsolat létrehozásához. Levéleszközök esetén a szülő éleszköz beállításának értéke lekérhető a szülő peremeszköz device_scope tulajdonságából. alapértelmezett érték: None
|
|
parent_scopes
|
A felső szintű peremeszközök hatókörei, ha vannak. Alapértelmezett érték: Nincs A peremhálózati eszközök esetében a szülő peremhálózati eszköz beállításának értéke lekérhető a szülő peremhálózati eszköz device_scope tulajdonságából. A levéleszközök esetében ez a device_scope értékre állítható be, vagy a szolgáltatás átmásolásához balra. alapértelmezett érték: None
|
Válaszok
| Típus | Description |
|---|---|
|
A létrehozott eszközt tartalmazó eszközobjektum. |
Kivételek
| Típus | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
create_module_with_certificate_authority
Modulidentitást hoz létre egy eszközhöz az IoTHubon hitelesítésszolgáltató használatával.
create_module_with_certificate_authority(device_id, module_id, managed_by)Paraméterek
| Name | Description |
|---|---|
|
device_id
Kötelező
|
Az eszköz neve (azonosítója). |
|
module_id
Kötelező
|
A modul neve (azonosítója). |
|
managed_by
Kötelező
|
A kezelőeszköz neve (edge). |
Válaszok
| Típus | Description |
|---|---|
|
A létrehozott modult tartalmazó modulobjektum. |
Kivételek
| Típus | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
create_module_with_sas
Létrehoz egy modulidentitást egy eszközhöz az IoTHubon SAS-hitelesítéssel.
create_module_with_sas(device_id, module_id, managed_by, primary_key, secondary_key)Paraméterek
| Name | Description |
|---|---|
|
device_id
Kötelező
|
Az eszköz neve (azonosítója). |
|
module_id
Kötelező
|
A modul neve (azonosítója). |
|
managed_by
Kötelező
|
A kezelőeszköz neve (edge). |
|
primary_key
Kötelező
|
Elsődleges hitelesítési kulcs. |
|
secondary_key
Kötelező
|
Másodlagos hitelesítési kulcs. |
Válaszok
| Típus | Description |
|---|---|
|
A létrehozott modult tartalmazó modulobjektum. |
Kivételek
| Típus | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
create_module_with_x509
X509-hitelesítéssel létrehoz egy modulidentitást egy eszközhöz az IoTHubon.
create_module_with_x509(device_id, module_id, managed_by, primary_thumbprint, secondary_thumbprint)Paraméterek
| Name | Description |
|---|---|
|
device_id
Kötelező
|
Az eszköz neve (azonosítója). |
|
module_id
Kötelező
|
A modul neve (azonosítója). |
|
managed_by
Kötelező
|
A kezelőeszköz neve (edge). |
|
primary_thumbprint
Kötelező
|
Elsődleges X509 ujjlenyomat. |
|
secondary_thumbprint
Kötelező
|
Másodlagos X509 ujjlenyomat. |
Válaszok
| Típus | Description |
|---|---|
|
A létrehozott modult tartalmazó modulobjektum. |
Kivételek
| Típus | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
delete_device
Eszközidentitás törlése az IoTHubról.
delete_device(device_id, etag=None)Paraméterek
| Name | Description |
|---|---|
|
device_id
Kötelező
|
Az eszköz neve (azonosítója). |
|
etag
|
A törlési művelethez használandó etag (if_match) érték. alapértelmezett érték: None
|
Válaszok
| Típus | Description |
|---|---|
|
Nincsenek. |
Kivételek
| Típus | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
delete_module
Törli az eszköz modulidentitását az IoTHubról.
delete_module(device_id, module_id, etag=None)Paraméterek
| Name | Description |
|---|---|
|
device_id
Kötelező
|
Az eszköz neve (azonosítója). |
|
module_id
Kötelező
|
A modul neve (azonosítója). |
|
etag
|
A törlési művelethez használandó etag (if_match) érték. alapértelmezett érték: None
|
Válaszok
| Típus | Description |
|---|---|
|
Nincsenek. |
Kivételek
| Típus | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
from_connection_string
Classmethod initializer egy Registry Manager-szolgáltatásügyfélhez. Létrehozza a Registry Manager osztályt kapcsolati sztring.
A sikeres létrehozás után az osztály hitelesítése megtörtént az IoTHubon, és készen áll arra, hogy meghívja a tag API-kat az IoTHubbal való kommunikációhoz.
from_connection_string(connection_string)Paraméterek
| Name | Description |
|---|---|
|
connection_string
Kötelező
|
Az IoTHub kapcsolati sztring az IoTHubbal való kapcsolat hitelesítésére szolgál. |
Válaszok
| Típus | Description |
|---|---|
Kivételek
| Típus | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
from_token_credential
Classmethod initializer egy Registry Manager-szolgáltatásügyfélhez. Létrehozza a Registry Manager-osztályt a gazdagépnév URL-címéből és az Azure-jogkivonat hitelesítő adataiból.
A sikeres létrehozás után az osztály hitelesítése megtörtént az IoTHubon, és készen áll arra, hogy meghívja a tag API-kat az IoTHubbal való kommunikációhoz.
from_token_credential(url, token_credential)Paraméterek
| Name | Description |
|---|---|
|
url
Kötelező
|
Az Azure-szolgáltatás URL-címe (állomásnév). |
|
token_credential
Kötelező
|
<xref:azure.core.TokenCredential>
Az Azure-jogkivonat hitelesítőadat-objektuma |
Válaszok
| Típus | Description |
|---|---|
Kivételek
| Típus | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
get_device
Lekéri az eszközidentitást az IoTHubról.
get_device(device_id)Paraméterek
| Name | Description |
|---|---|
|
device_id
Kötelező
|
Az eszköz neve (azonosítója). |
Válaszok
| Típus | Description |
|---|---|
|
A kért eszközt tartalmazó Eszköz objektum. |
Kivételek
| Típus | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
get_device_registry_statistics
Lekéri az IoTHub-eszközregisztrációs adatbázis statisztikáit.
get_device_registry_statistics()Válaszok
| Típus | Description |
|---|---|
|
A RegistryStatistics objektum. |
Kivételek
| Típus | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
get_devices
Több eszköz identitásának lekérése az IoTHub-identitásjegyzékből. Nem ajánlott. Az IoTHub lekérdezési nyelv használatával lekérheti az ikereszköz- és eszközidentitás-adatokat. További információt a és https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language a című témakörben https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub talál.
get_devices(max_number_of_devices=None)Paraméterek
| Name | Description |
|---|---|
|
max_number_of_devices
|
Ez a paraméter adja meg a visszaadott eszközidentitások maximális számát. Az 1–1000 tartományon kívüli értékek 1000-nek minősülnek alapértelmezett érték: None
|
Válaszok
| Típus | Description |
|---|---|
|
Eszközadatok listája. |
Kivételek
| Típus | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
get_module
Lekéri egy eszköz modulidentitását az IoTHubról.
get_module(device_id, module_id)Paraméterek
| Name | Description |
|---|---|
|
device_id
Kötelező
|
Az eszköz neve (azonosítója). |
|
module_id
Kötelező
|
A modul neve (azonosítója). |
Válaszok
| Típus | Description |
|---|---|
|
A kért modult tartalmazó Modul objektum. |
Kivételek
| Típus | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
get_module_twin
Lekér egy ikermodult.
get_module_twin(device_id, module_id)Paraméterek
| Name | Description |
|---|---|
|
device_id
Kötelező
|
Az eszköz neve (azonosítója). |
|
module_id
Kötelező
|
A modul neve (azonosítója). |
Válaszok
| Típus | Description |
|---|---|
|
Az ikerobjektum. |
Kivételek
| Típus | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
get_modules
Lekéri az eszköz összes modulidentitását.
get_modules(device_id)Paraméterek
| Name | Description |
|---|---|
|
device_id
Kötelező
|
Az eszköz neve (azonosítója). |
Válaszok
| Típus | Description |
|---|---|
|
Az eszközön található összes modult tartalmazó lista[Modul]. |
Kivételek
| Típus | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
get_service_statistics
Lekéri az IoTHub szolgáltatásstatisztikáit.
get_service_statistics()Válaszok
| Típus | Description |
|---|---|
|
A ServiceStatistics objektum. |
Kivételek
| Típus | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
get_twin
Lekér egy ikereszközt.
get_twin(device_id)Paraméterek
| Name | Description |
|---|---|
|
device_id
Kötelező
|
Az eszköz neve (azonosítója). |
Válaszok
| Típus | Description |
|---|---|
|
Az ikerobjektum. |
Kivételek
| Típus | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
invoke_device_method
Közvetlen metódus meghívása egy eszközön.
invoke_device_method(device_id, direct_method_request)Paraméterek
| Name | Description |
|---|---|
|
device_id
Kötelező
|
Az eszköz neve (azonosítója). |
|
direct_method_request
Kötelező
|
A metóduskérés. |
Válaszok
| Típus | Description |
|---|---|
|
A CloudToDeviceMethodResult objektum. |
Kivételek
| Típus | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
invoke_device_module_method
Közvetlen metódus meghívása egy eszközön.
invoke_device_module_method(device_id, module_id, direct_method_request)Paraméterek
| Name | Description |
|---|---|
|
device_id
Kötelező
|
Az eszköz neve (azonosítója). |
|
module_id
Kötelező
|
A modul neve (azonosítója). |
|
direct_method_request
Kötelező
|
A metóduskérés. |
Válaszok
| Típus | Description |
|---|---|
|
A CloudToDeviceMethodResult objektum. |
Kivételek
| Típus | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
query_iot_hub
IoTHub lekérdezése az ikereszközökkel kapcsolatos információk SQL-szerű nyelv használatával történő lekéréséhez. További információ: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language. Az eredmények lapozása támogatott. Ez csak az ikereszközökkel kapcsolatos információkat adja vissza.
query_iot_hub(query_specification, continuation_token=None, max_item_count=None)Paraméterek
| Name | Description |
|---|---|
|
query
Kötelező
|
A lekérdezés specifikációja. |
|
continuation_token
|
Folytatási jogkivonat lapozáshoz alapértelmezett érték: None
|
|
max_item_count
|
A kért ikereszközök maximális száma alapértelmezett érték: None
|
|
query_specification
Kötelező
|
|
Válaszok
| Típus | Description |
|---|---|
|
A QueryResult objektum. |
Kivételek
| Típus | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
replace_module_twin
Lecseréli egy modul ikerpéldány címkéit és kívánt tulajdonságait.
replace_module_twin(device_id, module_id, module_twin, etag=None)Paraméterek
| Name | Description |
|---|---|
|
device_id
Kötelező
|
Az eszköz neve (azonosítója). |
|
module_id
Kötelező
|
A modul neve (azonosítója). |
|
module_twin
Kötelező
|
A modul ikeradatai. |
|
etag
|
A csereművelethez használandó etag (if_match) érték. alapértelmezett érték: None
|
Válaszok
| Típus | Description |
|---|---|
|
Az ikerobjektum. |
Kivételek
| Típus | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
replace_twin
Lecseréli egy ikereszköz címkéit és kívánt tulajdonságait.
replace_twin(device_id, device_twin, etag=None)Paraméterek
| Name | Description |
|---|---|
|
device_id
Kötelező
|
Az eszköz neve (azonosítója). |
|
device_twin
Kötelező
|
Az eszköz ikeradatai. |
|
etag
|
A csereművelethez használandó etag (if_match) érték. alapértelmezett érték: None
|
Válaszok
| Típus | Description |
|---|---|
|
Az ikerobjektum. |
Kivételek
| Típus | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
send_c2d_message
C2D-üzenet küldése IoTHub-eszközre.
send_c2d_message(device_id, message, properties={})Paraméterek
| Name | Description |
|---|---|
|
device_id
Kötelező
|
Az eszköz neve (azonosítója). |
|
message
Kötelező
|
Az eszközre kézbesítendő üzenet. |
|
properties
|
Az üzenettel elküldendő tulajdonságok. Tartalmazhat alkalmazástulajdonságokat és rendszertulajdonságokat alapértelmezett érték: {}
|
Kivételek
| Típus | Description |
|---|---|
|
Exception if the Send command is not able to send the message
|
update_device_with_certificate_authority
Frissítések egy eszközidentitást az IoTHubon hitelesítésszolgáltató használatával.
update_device_with_certificate_authority(device_id, etag, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)Paraméterek
| Name | Description |
|---|---|
|
device_id
Kötelező
|
Az eszköz neve (azonosítója). |
|
etag
Kötelező
|
A frissítési művelethez használandó etag (if_match) érték. |
|
status
Kötelező
|
A létrehozott eszköz kezdeti állapota. (Lehetséges értékek: "engedélyezve" vagy "letiltva"). |
|
iot_edge
|
Azt jelzi, hogy a létrehozott eszköz IoT Edge-e. Alapértelmezett érték: Hamis alapértelmezett érték: False
|
|
status_reason
|
Az eszközidentitás állapotának oka. Alapértelmezett érték: Nincs alapértelmezett érték: None
|
|
device_scope
|
Az eszköz hatóköre. Alapértelmezett érték: Nincs automatikusan generálva és nem módosítható a peremeszközökhöz, és módosítható a levéleszközökben a gyermek-szülő kapcsolat létrehozásához. Levéleszközök esetén a szülő peremeszköz beállításának értéke lekérhető a szülő peremeszköz device_scope tulajdonságából. alapértelmezett érték: None
|
|
parent_scopes
|
A felső szintű peremeszközök hatókörei, ha vannak. Alapértelmezett érték: Nincs A peremhálózati eszközök esetében a szülő peremeszköz beállításának értéke lekérhető a szülő peremeszköz device_scope tulajdonságából. Levéleszközök esetén ez a device_scope értékkel megegyező értékre állítható be, vagy a szolgáltatás átmásolásához balra. alapértelmezett érték: None
|
Válaszok
| Típus | Description |
|---|---|
|
A létrehozott eszközt tartalmazó frissített Eszköz objektum. |
Kivételek
| Típus | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
update_device_with_sas
Frissítések eszközidentitást az IoTHubon SAS-hitelesítéssel.
update_device_with_sas(device_id, etag, primary_key, secondary_key, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)Paraméterek
| Name | Description |
|---|---|
|
device_id
Kötelező
|
Az eszköz neve (azonosítója). |
|
etag
Kötelező
|
A frissítési művelethez használandó etag (if_match) érték. |
|
primary_key
Kötelező
|
Elsődleges hitelesítési kulcs. |
|
secondary_key
Kötelező
|
Másodlagos hitelesítési kulcs. |
|
status
Kötelező
|
A létrehozott eszköz kezdeti állapota. (Lehetséges értékek: "engedélyezve" vagy "letiltva"). |
|
iot_edge
|
Azt jelzi, hogy a létrehozott eszköz IoT Edge-e. Alapértelmezett érték: Hamis alapértelmezett érték: False
|
|
status_reason
|
Az eszközidentitás állapotának oka. Alapértelmezett érték: Nincs alapértelmezett érték: None
|
|
device_scope
|
Az eszköz hatóköre. Alapértelmezett érték: Nincs automatikusan generálva és nem módosítható a peremeszközökhöz, és módosítható a levéleszközökben a gyermek-szülő kapcsolat létrehozásához. Levéleszközök esetén a szülő peremeszköz beállításának értéke lekérhető a szülő peremeszköz device_scope tulajdonságából. alapértelmezett érték: None
|
|
parent_scopes
|
A felső szintű peremeszközök hatókörei, ha vannak. Alapértelmezett érték: Nincs A peremhálózati eszközök esetében a szülő peremeszköz beállításának értéke lekérhető a szülő peremeszköz device_scope tulajdonságából. Levéleszközök esetén ez a device_scope értékkel megegyező értékre állítható be, vagy a szolgáltatás átmásolásához balra. alapértelmezett érték: None
|
Válaszok
| Típus | Description |
|---|---|
|
A létrehozott eszközt tartalmazó frissített Eszköz objektum. |
Kivételek
| Típus | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
update_device_with_x509
X509-hitelesítéssel Frissítések eszközidentitást az IoTHubon.
update_device_with_x509(device_id, etag, primary_thumbprint, secondary_thumbprint, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)Paraméterek
| Name | Description |
|---|---|
|
device_id
Kötelező
|
Az eszköz neve (azonosítója). |
|
etag
Kötelező
|
A frissítési művelethez használandó etag (if_match) érték. |
|
primary_thumbprint
Kötelező
|
Elsődleges X509 ujjlenyomat. |
|
secondary_thumbprint
Kötelező
|
Másodlagos X509 ujjlenyomat. |
|
status
Kötelező
|
A létrehozott eszköz kezdeti állapota. (Lehetséges értékek: "engedélyezve" vagy "letiltva"). |
|
iot_edge
|
Azt jelzi, hogy a létrehozott eszköz IoT Edge-e. Alapértelmezett érték: Hamis alapértelmezett érték: False
|
|
status_reason
|
Az eszközidentitás állapotának oka. Alapértelmezett érték: Nincs alapértelmezett érték: None
|
|
device_scope
|
Az eszköz hatóköre. Alapértelmezett érték: Nincs automatikusan generálva és nem módosítható a peremeszközökhöz, és módosítható a levéleszközökben a gyermek-szülő kapcsolat létrehozásához. Levéleszközök esetén a szülő peremeszköz beállításának értéke lekérhető a szülő peremeszköz device_scope tulajdonságából. alapértelmezett érték: None
|
|
parent_scopes
|
A felső szintű peremeszközök hatókörei, ha vannak. Alapértelmezett érték: Nincs A peremhálózati eszközök esetében a szülő peremeszköz beállításának értéke lekérhető a szülő peremeszköz device_scope tulajdonságából. Levéleszközök esetén ez a device_scope értékkel megegyező értékre állítható be, vagy a szolgáltatás átmásolásához balra. alapértelmezett érték: None
|
Válaszok
| Típus | Description |
|---|---|
|
A létrehozott eszközt tartalmazó frissített Eszköz objektum. |
Kivételek
| Típus | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
update_module_twin
Frissítések ikermodul címkéinek és kívánt tulajdonságainak.
update_module_twin(device_id, module_id, module_twin, etag=None)Paraméterek
| Name | Description |
|---|---|
|
device_id
Kötelező
|
Az eszköz neve (azonosítója). |
|
module_id
Kötelező
|
A modul neve (azonosítója). |
|
module_twin
Kötelező
|
A modul ikeradatai. |
|
etag
|
A frissítési művelethez használandó etag (if_match) érték. alapértelmezett érték: None
|
Válaszok
| Típus | Description |
|---|---|
|
Az ikerobjektum. |
Kivételek
| Típus | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
update_module_with_certificate_authority
Frissítések egy eszköz modulidentitását az IoTHubon hitelesítésszolgáltató használatával.
update_module_with_certificate_authority(device_id, module_id, managed_by, etag)Paraméterek
| Name | Description |
|---|---|
|
device_id
Kötelező
|
Az eszköz neve (azonosítója). |
|
module_id
Kötelező
|
A modul neve (azonosítója). |
|
managed_by
Kötelező
|
A kezelőeszköz neve (edge). |
|
etag
Kötelező
|
A frissítési művelethez használandó etag (if_match) érték. |
Válaszok
| Típus | Description |
|---|---|
|
A létrehozott modult tartalmazó frissített Modul objektum. |
Kivételek
| Típus | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
update_module_with_sas
Frissítések egy eszköz modulidentitását az IoTHubon SAS-hitelesítéssel.
update_module_with_sas(device_id, module_id, managed_by, etag, primary_key, secondary_key)Paraméterek
| Name | Description |
|---|---|
|
device_id
Kötelező
|
Az eszköz neve (azonosítója). |
|
module_id
Kötelező
|
A modul neve (azonosítója). |
|
managed_by
Kötelező
|
A kezelőeszköz neve (edge). |
|
etag
Kötelező
|
A frissítési művelethez használandó etag (if_match) érték. |
|
primary_key
Kötelező
|
Elsődleges hitelesítési kulcs. |
|
secondary_key
Kötelező
|
Másodlagos hitelesítési kulcs. |
Válaszok
| Típus | Description |
|---|---|
|
A létrehozott modult tartalmazó frissített Modul objektum. |
Kivételek
| Típus | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
update_module_with_x509
X509-hitelesítéssel Frissítések egy eszköz modulidentitását az IoTHubon.
update_module_with_x509(device_id, module_id, managed_by, etag, primary_thumbprint, secondary_thumbprint)Paraméterek
| Name | Description |
|---|---|
|
device_id
Kötelező
|
Az eszköz neve (azonosítója). |
|
module_id
Kötelező
|
A modul neve (azonosítója). |
|
managed_by
Kötelező
|
A kezelőeszköz neve (edge). |
|
etag
Kötelező
|
A frissítési művelethez használandó etag (if_match) érték. |
|
primary_thumbprint
Kötelező
|
Elsődleges X509 ujjlenyomat. |
|
secondary_thumbprint
Kötelező
|
Másodlagos X509 ujjlenyomat. |
Válaszok
| Típus | Description |
|---|---|
|
A létrehozott modult tartalmazó frissített Modul objektum. |
Kivételek
| Típus | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
update_twin
Frissítések ikereszköz címkéinek és kívánt tulajdonságainak.
update_twin(device_id, device_twin, etag=None)Paraméterek
| Name | Description |
|---|---|
|
device_id
Kötelező
|
Az eszköz neve (azonosítója). |
|
device_twin
Kötelező
|
Az eszköz ikeradatai. |
|
etag
|
A frissítési művelethez használandó etag (if_match) érték. alapértelmezett érték: None
|
Válaszok
| Típus | Description |
|---|---|
|
Az ikerobjektum. |
Kivételek
| Típus | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
Azure SDK for Python
Visszajelzés
Hamarosan elérhető: 2024-ben fokozatosan kivezetjük a GitHub-problémákat a tartalom visszajelzési mechanizmusaként, és lecseréljük egy új visszajelzési rendszerre. További információ: https://aka.ms/ContentUserFeedback.
Visszajelzés küldése és megtekintése a következőhöz: