IoTHubRegistryManager Sınıf
Otomatik olarak oluşturulan IotHub REST API'lerini temel alarak IoTHub Kayıt Defteri Yöneticisi işlemleri için kullanışlı API'ler sağlayan bir sınıf
Kayıt Defteri Yöneticisi Hizmeti istemcisi için Başlatıcı.
Kullanıcılar bunu doğrudan çağırmamalıdır. Bunun yerine, from_connection_string() veya from_token_credential() fabrika yöntemleri olmalıdır.
Başarılı bir oluşturma işleminden sonra sınıfın kimliği IoTHub ile doğrulanır ve IoTHub ile iletişim kurmak için üye API'leri çağırmaya hazır olur.
- Devralma
-
builtins.objectIoTHubRegistryManager
Oluşturucu
IoTHubRegistryManager(connection_string=None, host=None, token_credential=None)Parametreler
| Name | Description |
|---|---|
|
connection_string
|
connection_str kimlik doğrulaması kullanıyorsak IoTHub ile bağlantının kimliğini doğrulamak için kullanılan IoTHub bağlantı dizesi. Varsayılan değer: Yok varsayılan değer: None
|
|
host
|
Belirteç kimlik bilgisi kimlik doğrulaması kullanıyorsak Azure hizmeti URL'si. Varsayılan değer: Yok varsayılan değer: None
|
|
auth
Gerekli
|
Belirteç kimlik bilgisi kimlik doğrulaması kullanıyorsak Azure kimlik doğrulama nesnesi. Varsayılan değer: Yok |
|
token_credential
|
varsayılan değer: None
|
Yöntemler
| bulk_create_or_update_devices |
IoTHub kimlik kayıt defterinden birden çok cihazın kimliklerini oluşturun, güncelleştirin veya silin. IoTHub kimlik kayıt defterinden birden çok cihazın kimliklerini oluşturun, güncelleştirin veya silin. Cihaz kimliği listede yalnızca bir kez belirtilebilir. Farklı cihazlarda farklı işlemlere (oluşturma, güncelleştirme, silme) izin verilir. Çağrı başına en fazla 100 cihaz belirtilebilir. Büyük ölçekli işlemler için blob depolamahttps://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities() kullanarak içeri aktarma özelliğini kullanmayı göz önünde bulundurun. |
| create_device_with_certificate_authority |
Sertifika yetkilisini kullanarak IoTHub'da bir cihaz kimliği oluşturur. |
| create_device_with_sas |
SAS kimlik doğrulaması kullanarak IoTHub'da bir cihaz kimliği oluşturur. |
| create_device_with_x509 |
X509 kimlik doğrulamayı kullanarak IoTHub'da bir cihaz kimliği oluşturur. |
| create_module_with_certificate_authority |
Sertifika yetkilisini kullanarak IoTHub'da bir cihaz için modül kimliği oluşturur. |
| create_module_with_sas |
SAS kimlik doğrulamasını kullanarak IoTHub'da bir cihaz için modül kimliği oluşturur. |
| create_module_with_x509 |
X509 kimlik doğrulamasını kullanarak IoTHub'da bir cihaz için modül kimliği oluşturur. |
| delete_device |
IoTHub'dan bir cihaz kimliğini siler. |
| delete_module |
IoTHub'dan bir cihaz için modül kimliğini siler. |
| from_connection_string |
Bir Kayıt Defteri Yöneticisi Hizmeti istemcisi için Classmethod başlatıcısı. Bağlantı dizesinden Registry Manager sınıfı oluşturur. Başarılı bir oluşturma işleminden sonra sınıfın kimliği IoTHub ile doğrulanır ve IoTHub ile iletişim kurmak için üye API'leri çağırmaya hazır olur. |
| from_token_credential |
Bir Kayıt Defteri Yöneticisi Hizmeti istemcisi için Classmethod başlatıcısı. Konak adı URL'sinden ve Azure belirteci kimlik bilgisinden Registry Manager sınıfı oluşturur. Başarılı bir oluşturma işleminden sonra sınıfın kimliği IoTHub ile doğrulanır ve IoTHub ile iletişim kurmak için üye API'leri çağırmaya hazır olur. |
| get_device |
IoTHub'dan bir cihaz kimliği alır. |
| get_device_registry_statistics |
IoTHub cihaz kayıt defteri istatistiklerini alır. |
| get_devices |
IoTHub kimlik kayıt defterinden birden çok cihazın kimliklerini alın. Önerilmez. Cihaz ikizi ve cihaz kimliği bilgilerini almak için IoTHub sorgu dilini kullanın. Daha fazla bilgi için bkz https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub . ve https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language . |
| get_module |
IoTHub'dan bir cihaz için modül kimliği alır. |
| get_module_twin |
Bir modül ikizi alır. |
| get_modules |
Bir cihazdaki tüm modül kimliklerini alır. |
| get_service_statistics |
IoTHub hizmet istatistiklerini alır. |
| get_twin |
Bir cihaz ikizi alır. |
| invoke_device_method |
Bir cihazda doğrudan yöntem çağırma. |
| invoke_device_module_method |
Bir cihazda doğrudan yöntem çağırma. |
| query_iot_hub |
SQL benzeri bir dil kullanarak cihaz ikizleri ile ilgili bilgileri almak için ioTHub'ı sorgula. Daha fazla bilgi edinmek için bkz. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language. Sonuçların sayfalandırması desteklenir. Bu, yalnızca cihaz ikizleri hakkındaki bilgileri döndürür. |
| replace_module_twin |
Bir modül ikizinin etiketlerini ve istenen özelliklerini değiştirir. |
| replace_twin |
Cihaz ikizinin etiketlerini ve istenen özelliklerini değiştirir. |
| send_c2d_message |
IoTHub Cihazına C2D iletisi gönderin. |
| update_device_with_certificate_authority |
Sertifika yetkilisini kullanarak IoTHub'da bir cihaz kimliği Güncelleştirmeler. |
| update_device_with_sas |
SAS kimlik doğrulaması kullanarak IoTHub'da bir cihaz kimliği Güncelleştirmeler. |
| update_device_with_x509 |
X509 kimlik doğrulamayı kullanarak IoTHub'da bir cihaz kimliği Güncelleştirmeler. |
| update_module_twin |
Bir modül ikizinin etiketlerini ve istenen özelliklerini Güncelleştirmeler. |
| update_module_with_certificate_authority |
Sertifika yetkilisini kullanarak IoTHub'da bir cihaz için modül kimliği Güncelleştirmeler. |
| update_module_with_sas |
SAS kimlik doğrulamasını kullanarak IoTHub'da bir cihaz için modül kimliği Güncelleştirmeler. |
| update_module_with_x509 |
X509 kimlik doğrulamasını kullanarak IoTHub'da bir cihaz için modül kimliği Güncelleştirmeler. |
| update_twin |
Cihaz ikizinin etiketlerini ve istenen özelliklerini Güncelleştirmeler. |
bulk_create_or_update_devices
IoTHub kimlik kayıt defterinden birden çok cihazın kimliklerini oluşturun, güncelleştirin veya silin.
IoTHub kimlik kayıt defterinden birden çok cihazın kimliklerini oluşturun, güncelleştirin veya silin. Cihaz kimliği listede yalnızca bir kez belirtilebilir. Farklı cihazlarda farklı işlemlere (oluşturma, güncelleştirme, silme) izin verilir. Çağrı başına en fazla 100 cihaz belirtilebilir. Büyük ölçekli işlemler için blob depolamahttps://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities() kullanarak içeri aktarma özelliğini kullanmayı göz önünde bulundurun.
bulk_create_or_update_devices(devices)Parametreler
| Name | Description |
|---|---|
|
devices
Gerekli
|
Üzerinde çalışacak cihaz nesnelerinin listesi. |
Döndürülenler
| Tür | Description |
|---|---|
|
BulkRegistryOperationResult nesnesi. |
Özel durumlar
| Tür | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
create_device_with_certificate_authority
Sertifika yetkilisini kullanarak IoTHub'da bir cihaz kimliği oluşturur.
create_device_with_certificate_authority(device_id, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)Parametreler
| Name | Description |
|---|---|
|
device_id
Gerekli
|
Cihazın adı (Kimlik). |
|
status
Gerekli
|
Oluşturulan cihazın ilk durumu. (Olası değerler: "etkin" veya "devre dışı"). |
|
iot_edge
|
Oluşturulan cihazın IoT Edge bir cihaz olup olmadığı. Varsayılan değer: False varsayılan değer: False
|
|
status_reason
|
Cihaz kimliği durumunun nedeni. Varsayılan değer: Yok varsayılan değer: None
|
|
device_scope
|
Cihazın kapsamı. Varsayılan değer: Uç cihazlar için otomatik olarak oluşturulan ve sabit olmayan ve alt/üst ilişki oluşturmak için yaprak cihazlarda değiştirilebilir. Yaprak cihazlar için üst uç cihazı ayarlama değeri üst uç cihazının device_scope özelliğinden alınabilir. varsayılan değer: None
|
|
parent_scopes
|
Varsa üst düzey uç cihazların kapsamları. Varsayılan değer: Yok Uç cihazlar için üst uç cihazı ayarlama değeri üst uç cihazının device_scope özelliğinden alınabilir. Yaprak cihazlar için bu, device_scope ile aynı değere ayarlanabilir veya hizmetin kopyalaması için bırakılabilir. varsayılan değer: None
|
Döndürülenler
| Tür | Description |
|---|---|
|
Oluşturulan cihazı içeren cihaz nesnesi. |
Özel durumlar
| Tür | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
create_device_with_sas
SAS kimlik doğrulaması kullanarak IoTHub'da bir cihaz kimliği oluşturur.
create_device_with_sas(device_id, primary_key, secondary_key, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)Parametreler
| Name | Description |
|---|---|
|
device_id
Gerekli
|
Cihazın adı (Kimlik). |
|
primary_key
Gerekli
|
Birincil kimlik doğrulama anahtarı. |
|
secondary_key
Gerekli
|
İkincil kimlik doğrulama anahtarı. |
|
status
Gerekli
|
Oluşturulan cihazın ilk durumu. (Olası değerler: "etkin" veya "devre dışı") |
|
iot_edge
|
Oluşturulan cihazın IoT Edge bir cihaz olup olmadığı. Varsayılan değer: False varsayılan değer: False
|
|
status_reason
|
Cihaz kimliği durumunun nedeni. Varsayılan değer: Yok varsayılan değer: None
|
|
device_scope
|
Cihazın kapsamı. Varsayılan değer: Uç cihazlar için otomatik olarak oluşturulan ve sabit olmayan ve alt/üst ilişki oluşturmak için yaprak cihazlarda değiştirilebilir. Yaprak cihazlar için üst uç cihazı ayarlama değeri üst uç cihazının device_scope özelliğinden alınabilir. varsayılan değer: None
|
|
parent_scopes
|
Varsa üst düzey uç cihazların kapsamları. Varsayılan değer: Yok Uç cihazlar için üst uç cihazı ayarlama değeri üst uç cihazının device_scope özelliğinden alınabilir. Yaprak cihazlar için bu, device_scope ile aynı değere ayarlanabilir veya hizmetin kopyalaması için bırakılabilir. varsayılan değer: None
|
Döndürülenler
| Tür | Description |
|---|---|
|
Oluşturulan cihazı içeren cihaz nesnesi. |
Özel durumlar
| Tür | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
create_device_with_x509
X509 kimlik doğrulamayı kullanarak IoTHub'da bir cihaz kimliği oluşturur.
create_device_with_x509(device_id, primary_thumbprint, secondary_thumbprint, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)Parametreler
| Name | Description |
|---|---|
|
device_id
Gerekli
|
Cihazın adı (Kimlik). |
|
primary_thumbprint
Gerekli
|
Birincil X509 parmak izi. |
|
secondary_thumbprint
Gerekli
|
İkincil X509 parmak izi. |
|
status
Gerekli
|
Oluşturulan cihazın ilk durumu. (Olası değerler: "etkin" veya "devre dışı") |
|
iot_edge
|
Oluşturulan cihazın IoT Edge bir cihaz olup olmadığı. Varsayılan değer: False varsayılan değer: False
|
|
status_reason
|
Cihaz kimliği durumunun nedeni. Varsayılan değer: Yok varsayılan değer: None
|
|
device_scope
|
Cihazın kapsamı. Varsayılan değer: Uç cihazlar için otomatik olarak oluşturulan ve sabit olmayan ve alt/üst ilişki oluşturmak için yaprak cihazlarda değiştirilebilir. Yaprak cihazlar için üst uç cihazı ayarlama değeri üst uç cihazının device_scope özelliğinden alınabilir. varsayılan değer: None
|
|
parent_scopes
|
Varsa üst düzey uç cihazların kapsamları. Varsayılan değer: Yok Uç cihazlar için üst uç cihazı ayarlama değeri üst uç cihazının device_scope özelliğinden alınabilir. Yaprak cihazlar için bu, device_scope ile aynı değere ayarlanabilir veya hizmetin kopyalaması için bırakılabilir. varsayılan değer: None
|
Döndürülenler
| Tür | Description |
|---|---|
|
Oluşturulan cihazı içeren cihaz nesnesi. |
Özel durumlar
| Tür | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
create_module_with_certificate_authority
Sertifika yetkilisini kullanarak IoTHub'da bir cihaz için modül kimliği oluşturur.
create_module_with_certificate_authority(device_id, module_id, managed_by)Parametreler
| Name | Description |
|---|---|
|
device_id
Gerekli
|
Cihazın adı (Kimlik). |
|
module_id
Gerekli
|
Modülün adı (Kimlik). |
|
managed_by
Gerekli
|
Yönetici cihazının adı (edge). |
Döndürülenler
| Tür | Description |
|---|---|
|
Oluşturulan modülü içeren modül nesnesi. |
Özel durumlar
| Tür | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
create_module_with_sas
SAS kimlik doğrulamasını kullanarak IoTHub'da bir cihaz için modül kimliği oluşturur.
create_module_with_sas(device_id, module_id, managed_by, primary_key, secondary_key)Parametreler
| Name | Description |
|---|---|
|
device_id
Gerekli
|
Cihazın adı (Kimlik). |
|
module_id
Gerekli
|
Modülün adı (Kimlik). |
|
managed_by
Gerekli
|
Yönetici cihazının adı (edge). |
|
primary_key
Gerekli
|
Birincil kimlik doğrulama anahtarı. |
|
secondary_key
Gerekli
|
İkincil kimlik doğrulama anahtarı. |
Döndürülenler
| Tür | Description |
|---|---|
|
Oluşturulan modülü içeren modül nesnesi. |
Özel durumlar
| Tür | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
create_module_with_x509
X509 kimlik doğrulamasını kullanarak IoTHub'da bir cihaz için modül kimliği oluşturur.
create_module_with_x509(device_id, module_id, managed_by, primary_thumbprint, secondary_thumbprint)Parametreler
| Name | Description |
|---|---|
|
device_id
Gerekli
|
Cihazın adı (Kimlik). |
|
module_id
Gerekli
|
Modülün adı (Kimlik). |
|
managed_by
Gerekli
|
Yönetici cihazının adı (edge). |
|
primary_thumbprint
Gerekli
|
Birincil X509 parmak izi. |
|
secondary_thumbprint
Gerekli
|
İkincil X509 parmak izi. |
Döndürülenler
| Tür | Description |
|---|---|
|
Oluşturulan modülü içeren modül nesnesi. |
Özel durumlar
| Tür | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
delete_device
IoTHub'dan bir cihaz kimliğini siler.
delete_device(device_id, etag=None)Parametreler
| Name | Description |
|---|---|
|
device_id
Gerekli
|
Cihazın adı (Kimlik). |
|
etag
|
Silme işlemi için kullanılacak etag (if_match) değeri. varsayılan değer: None
|
Döndürülenler
| Tür | Description |
|---|---|
|
Yok. |
Özel durumlar
| Tür | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
delete_module
IoTHub'dan bir cihaz için modül kimliğini siler.
delete_module(device_id, module_id, etag=None)Parametreler
| Name | Description |
|---|---|
|
device_id
Gerekli
|
Cihazın adı (Kimlik). |
|
module_id
Gerekli
|
Modülün adı (Kimlik). |
|
etag
|
Silme işlemi için kullanılacak etag (if_match) değeri. varsayılan değer: None
|
Döndürülenler
| Tür | Description |
|---|---|
|
Yok. |
Özel durumlar
| Tür | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
from_connection_string
Bir Kayıt Defteri Yöneticisi Hizmeti istemcisi için Classmethod başlatıcısı. Bağlantı dizesinden Registry Manager sınıfı oluşturur.
Başarılı bir oluşturma işleminden sonra sınıfın kimliği IoTHub ile doğrulanır ve IoTHub ile iletişim kurmak için üye API'leri çağırmaya hazır olur.
from_connection_string(connection_string)Parametreler
| Name | Description |
|---|---|
|
connection_string
Gerekli
|
IoTHub ile bağlantı kimliğini doğrulamak için kullanılan IoTHub bağlantı dizesi. |
Döndürülenler
| Tür | Description |
|---|---|
Özel durumlar
| Tür | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
from_token_credential
Bir Kayıt Defteri Yöneticisi Hizmeti istemcisi için Classmethod başlatıcısı. Konak adı URL'sinden ve Azure belirteci kimlik bilgisinden Registry Manager sınıfı oluşturur.
Başarılı bir oluşturma işleminden sonra sınıfın kimliği IoTHub ile doğrulanır ve IoTHub ile iletişim kurmak için üye API'leri çağırmaya hazır olur.
from_token_credential(url, token_credential)Parametreler
| Name | Description |
|---|---|
|
url
Gerekli
|
Azure hizmet URL'si (ana bilgisayar adı). |
|
token_credential
Gerekli
|
<xref:azure.core.TokenCredential>
Azure belirteci kimlik bilgisi nesnesi |
Döndürülenler
| Tür | Description |
|---|---|
Özel durumlar
| Tür | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
get_device
IoTHub'dan bir cihaz kimliği alır.
get_device(device_id)Parametreler
| Name | Description |
|---|---|
|
device_id
Gerekli
|
Cihazın adı (Kimlik). |
Döndürülenler
| Tür | Description |
|---|---|
|
İstenen cihazı içeren Cihaz nesnesi. |
Özel durumlar
| Tür | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
get_device_registry_statistics
IoTHub cihaz kayıt defteri istatistiklerini alır.
get_device_registry_statistics()Döndürülenler
| Tür | Description |
|---|---|
|
RegistryStatistics nesnesi. |
Özel durumlar
| Tür | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
get_devices
IoTHub kimlik kayıt defterinden birden çok cihazın kimliklerini alın. Önerilmez. Cihaz ikizi ve cihaz kimliği bilgilerini almak için IoTHub sorgu dilini kullanın. Daha fazla bilgi için bkz https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub . ve https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language .
get_devices(max_number_of_devices=None)Parametreler
| Name | Description |
|---|---|
|
max_number_of_devices
|
Bu parametre belirtildiğinde, döndürülen en fazla cihaz kimliği sayısını tanımlar. 1-1000 aralığındaki tüm değerler 1000 olarak kabul edilir varsayılan değer: None
|
Döndürülenler
| Tür | Description |
|---|---|
|
Cihaz bilgilerinin listesi. |
Özel durumlar
| Tür | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
get_module
IoTHub'dan bir cihaz için modül kimliği alır.
get_module(device_id, module_id)Parametreler
| Name | Description |
|---|---|
|
device_id
Gerekli
|
Cihazın adı (Kimlik). |
|
module_id
Gerekli
|
Modülün adı (Kimlik). |
Döndürülenler
| Tür | Description |
|---|---|
|
İstenen modülü içeren Module nesnesi. |
Özel durumlar
| Tür | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
get_module_twin
Bir modül ikizi alır.
get_module_twin(device_id, module_id)Parametreler
| Name | Description |
|---|---|
|
device_id
Gerekli
|
Cihazın adı (Kimlik). |
|
module_id
Gerekli
|
Modülün adı (Kimlik). |
Döndürülenler
| Tür | Description |
|---|---|
|
İkiz nesnesi. |
Özel durumlar
| Tür | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
get_modules
Bir cihazdaki tüm modül kimliklerini alır.
get_modules(device_id)Parametreler
| Name | Description |
|---|---|
|
device_id
Gerekli
|
Cihazın adı (Kimlik). |
Döndürülenler
| Tür | Description |
|---|---|
|
Cihazdaki tüm modülleri içeren liste[Modül]. |
Özel durumlar
| Tür | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
get_service_statistics
IoTHub hizmet istatistiklerini alır.
get_service_statistics()Döndürülenler
| Tür | Description |
|---|---|
|
ServiceStatistics nesnesi. |
Özel durumlar
| Tür | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
get_twin
Bir cihaz ikizi alır.
get_twin(device_id)Parametreler
| Name | Description |
|---|---|
|
device_id
Gerekli
|
Cihazın adı (Kimlik). |
Döndürülenler
| Tür | Description |
|---|---|
|
İkiz nesnesi. |
Özel durumlar
| Tür | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
invoke_device_method
Bir cihazda doğrudan yöntem çağırma.
invoke_device_method(device_id, direct_method_request)Parametreler
| Name | Description |
|---|---|
|
device_id
Gerekli
|
Cihazın adı (Kimlik). |
|
direct_method_request
Gerekli
|
Yöntem isteği. |
Döndürülenler
| Tür | Description |
|---|---|
|
CloudToDeviceMethodResult nesnesi. |
Özel durumlar
| Tür | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
invoke_device_module_method
Bir cihazda doğrudan yöntem çağırma.
invoke_device_module_method(device_id, module_id, direct_method_request)Parametreler
| Name | Description |
|---|---|
|
device_id
Gerekli
|
Cihazın adı (Kimlik). |
|
module_id
Gerekli
|
Modülün adı (Kimlik). |
|
direct_method_request
Gerekli
|
Yöntem isteği. |
Döndürülenler
| Tür | Description |
|---|---|
|
CloudToDeviceMethodResult nesnesi. |
Özel durumlar
| Tür | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
query_iot_hub
SQL benzeri bir dil kullanarak cihaz ikizleri ile ilgili bilgileri almak için ioTHub'ı sorgula. Daha fazla bilgi edinmek için bkz. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language. Sonuçların sayfalandırması desteklenir. Bu, yalnızca cihaz ikizleri hakkındaki bilgileri döndürür.
query_iot_hub(query_specification, continuation_token=None, max_item_count=None)Parametreler
| Name | Description |
|---|---|
|
query
Gerekli
|
Sorgu belirtimi. |
|
continuation_token
|
Disk belleği için devamlılık belirteci varsayılan değer: None
|
|
max_item_count
|
İstenen cihaz ikizlerinin sayısı üst sınırı varsayılan değer: None
|
|
query_specification
Gerekli
|
|
Döndürülenler
| Tür | Description |
|---|---|
|
QueryResult nesnesi. |
Özel durumlar
| Tür | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
replace_module_twin
Bir modül ikizinin etiketlerini ve istenen özelliklerini değiştirir.
replace_module_twin(device_id, module_id, module_twin, etag=None)Parametreler
| Name | Description |
|---|---|
|
device_id
Gerekli
|
Cihazın adı (Kimlik). |
|
module_id
Gerekli
|
Modülün adı (Kimlik). |
|
module_twin
Gerekli
|
Modülün ikiz bilgileri. |
|
etag
|
Değiştirme işlemi için kullanılacak etag (if_match) değeri. varsayılan değer: None
|
Döndürülenler
| Tür | Description |
|---|---|
|
İkiz nesnesi. |
Özel durumlar
| Tür | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
replace_twin
Cihaz ikizinin etiketlerini ve istenen özelliklerini değiştirir.
replace_twin(device_id, device_twin, etag=None)Parametreler
| Name | Description |
|---|---|
|
device_id
Gerekli
|
Cihazın adı (Kimlik). |
|
device_twin
Gerekli
|
Cihazın ikiz bilgileri. |
|
etag
|
Değiştirme işlemi için kullanılacak etag (if_match) değeri. varsayılan değer: None
|
Döndürülenler
| Tür | Description |
|---|---|
|
İkiz nesnesi. |
Özel durumlar
| Tür | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
send_c2d_message
IoTHub Cihazına C2D iletisi gönderin.
send_c2d_message(device_id, message, properties={})Parametreler
| Name | Description |
|---|---|
|
device_id
Gerekli
|
Cihazın adı (Kimlik). |
|
message
Gerekli
|
Cihaza teslim edilecek ileti. |
|
properties
|
İletiyle birlikte gönderilecek özellikler. Uygulama özelliklerini ve sistem özelliklerini içerebilir varsayılan değer: {}
|
Özel durumlar
| Tür | Description |
|---|---|
|
Exception if the Send command is not able to send the message
|
update_device_with_certificate_authority
Sertifika yetkilisini kullanarak IoTHub'da bir cihaz kimliği Güncelleştirmeler.
update_device_with_certificate_authority(device_id, etag, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)Parametreler
| Name | Description |
|---|---|
|
device_id
Gerekli
|
Cihazın adı (Kimlik). |
|
etag
Gerekli
|
Güncelleştirme işlemi için kullanılacak etag (if_match) değeri. |
|
status
Gerekli
|
Oluşturulan cihazın ilk durumu. (Olası değerler: "etkin" veya "devre dışı"). |
|
iot_edge
|
Oluşturulan cihazın IoT Edge bir cihaz olup olmadığı. Varsayılan değer: False varsayılan değer: False
|
|
status_reason
|
Cihaz kimliği durumunun nedeni. Varsayılan değer: Yok varsayılan değer: None
|
|
device_scope
|
Cihazın kapsamı. Varsayılan değer: Uç cihazlar için otomatik olarak oluşturulan ve sabit olmayan ve alt/üst ilişki oluşturmak için yaprak cihazlarda değiştirilebilir. Yaprak cihazlar için üst uç cihazı ayarlama değeri üst uç cihazının device_scope özelliğinden alınabilir. varsayılan değer: None
|
|
parent_scopes
|
Varsa üst düzey uç cihazların kapsamları. Varsayılan değer: Yok Uç cihazlar için üst uç cihazı ayarlama değeri üst uç cihazının device_scope özelliğinden alınabilir. Yaprak cihazlar için bu, device_scope ile aynı değere ayarlanabilir veya hizmetin kopyalaması için bırakılabilir. varsayılan değer: None
|
Döndürülenler
| Tür | Description |
|---|---|
|
Oluşturulan cihazı içeren güncelleştirilmiş Device nesnesi. |
Özel durumlar
| Tür | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
update_device_with_sas
SAS kimlik doğrulaması kullanarak IoTHub'da bir cihaz kimliği Güncelleştirmeler.
update_device_with_sas(device_id, etag, primary_key, secondary_key, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)Parametreler
| Name | Description |
|---|---|
|
device_id
Gerekli
|
Cihazın adı (Kimlik). |
|
etag
Gerekli
|
Güncelleştirme işlemi için kullanılacak etag (if_match) değeri. |
|
primary_key
Gerekli
|
Birincil kimlik doğrulama anahtarı. |
|
secondary_key
Gerekli
|
İkincil kimlik doğrulama anahtarı. |
|
status
Gerekli
|
Oluşturulan cihazın ilk durumu. (Olası değerler: "etkin" veya "devre dışı"). |
|
iot_edge
|
Oluşturulan cihazın IoT Edge bir cihaz olup olmadığı. Varsayılan değer: False varsayılan değer: False
|
|
status_reason
|
Cihaz kimliği durumunun nedeni. Varsayılan değer: Yok varsayılan değer: None
|
|
device_scope
|
Cihazın kapsamı. Varsayılan değer: Uç cihazlar için otomatik olarak oluşturulan ve sabit olmayan ve alt/üst ilişki oluşturmak için yaprak cihazlarda değiştirilebilir. Yaprak cihazlar için üst uç cihazı ayarlama değeri üst uç cihazının device_scope özelliğinden alınabilir. varsayılan değer: None
|
|
parent_scopes
|
Varsa üst düzey uç cihazların kapsamları. Varsayılan değer: Yok Uç cihazlar için üst uç cihazı ayarlama değeri üst uç cihazının device_scope özelliğinden alınabilir. Yaprak cihazlar için bu, device_scope ile aynı değere ayarlanabilir veya hizmetin kopyalaması için bırakılabilir. varsayılan değer: None
|
Döndürülenler
| Tür | Description |
|---|---|
|
Oluşturulan cihazı içeren güncelleştirilmiş Cihaz nesnesi. |
Özel durumlar
| Tür | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
update_device_with_x509
X509 kimlik doğrulamayı kullanarak IoTHub'da bir cihaz kimliği Güncelleştirmeler.
update_device_with_x509(device_id, etag, primary_thumbprint, secondary_thumbprint, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)Parametreler
| Name | Description |
|---|---|
|
device_id
Gerekli
|
Cihazın adı (Kimlik). |
|
etag
Gerekli
|
Güncelleştirme işlemi için kullanılacak etag (if_match) değeri. |
|
primary_thumbprint
Gerekli
|
Birincil X509 parmak izi. |
|
secondary_thumbprint
Gerekli
|
İkincil X509 parmak izi. |
|
status
Gerekli
|
Oluşturulan cihazın ilk durumu. (Olası değerler: "etkin" veya "devre dışı"). |
|
iot_edge
|
Oluşturulan cihazın IoT Edge bir cihaz olup olmadığı. Varsayılan değer: False varsayılan değer: False
|
|
status_reason
|
Cihaz kimliği durumunun nedeni. Varsayılan değer: Yok varsayılan değer: None
|
|
device_scope
|
Cihazın kapsamı. Varsayılan değer: Uç cihazlar için otomatik olarak oluşturulan ve sabit olmayan ve alt/üst ilişki oluşturmak için yaprak cihazlarda değiştirilebilir. Yaprak cihazlar için üst uç cihazı ayarlama değeri üst uç cihazının device_scope özelliğinden alınabilir. varsayılan değer: None
|
|
parent_scopes
|
Varsa üst düzey uç cihazların kapsamları. Varsayılan değer: Yok Uç cihazlar için üst uç cihazı ayarlama değeri üst uç cihazının device_scope özelliğinden alınabilir. Yaprak cihazlar için bu, device_scope ile aynı değere ayarlanabilir veya hizmetin kopyalaması için bırakılabilir. varsayılan değer: None
|
Döndürülenler
| Tür | Description |
|---|---|
|
Oluşturulan cihazı içeren güncelleştirilmiş Cihaz nesnesi. |
Özel durumlar
| Tür | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
update_module_twin
Bir modül ikizinin etiketlerini ve istenen özelliklerini Güncelleştirmeler.
update_module_twin(device_id, module_id, module_twin, etag=None)Parametreler
| Name | Description |
|---|---|
|
device_id
Gerekli
|
Cihazın adı (Kimlik). |
|
module_id
Gerekli
|
Modülün adı (Kimlik). |
|
module_twin
Gerekli
|
Modülün ikiz bilgileri. |
|
etag
|
Güncelleştirme işlemi için kullanılacak etag (if_match) değeri. varsayılan değer: None
|
Döndürülenler
| Tür | Description |
|---|---|
|
İkiz nesnesi. |
Özel durumlar
| Tür | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
update_module_with_certificate_authority
Sertifika yetkilisini kullanarak IoTHub'da bir cihaz için modül kimliği Güncelleştirmeler.
update_module_with_certificate_authority(device_id, module_id, managed_by, etag)Parametreler
| Name | Description |
|---|---|
|
device_id
Gerekli
|
Cihazın adı (Kimlik). |
|
module_id
Gerekli
|
Modülün adı (Kimlik). |
|
managed_by
Gerekli
|
Yönetici cihazının adı (edge). |
|
etag
Gerekli
|
Güncelleştirme işlemi için kullanılacak etag (if_match) değeri. |
Döndürülenler
| Tür | Description |
|---|---|
|
Oluşturulan modülü içeren güncelleştirilmiş Module nesnesi. |
Özel durumlar
| Tür | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
update_module_with_sas
SAS kimlik doğrulamasını kullanarak IoTHub'da bir cihaz için modül kimliği Güncelleştirmeler.
update_module_with_sas(device_id, module_id, managed_by, etag, primary_key, secondary_key)Parametreler
| Name | Description |
|---|---|
|
device_id
Gerekli
|
Cihazın adı (Kimlik). |
|
module_id
Gerekli
|
Modülün adı (Kimlik). |
|
managed_by
Gerekli
|
Yönetici cihazının adı (edge). |
|
etag
Gerekli
|
Güncelleştirme işlemi için kullanılacak etag (if_match) değeri. |
|
primary_key
Gerekli
|
Birincil kimlik doğrulama anahtarı. |
|
secondary_key
Gerekli
|
İkincil kimlik doğrulama anahtarı. |
Döndürülenler
| Tür | Description |
|---|---|
|
Oluşturulan modülü içeren güncelleştirilmiş Module nesnesi. |
Özel durumlar
| Tür | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
update_module_with_x509
X509 kimlik doğrulamasını kullanarak IoTHub'da bir cihaz için modül kimliği Güncelleştirmeler.
update_module_with_x509(device_id, module_id, managed_by, etag, primary_thumbprint, secondary_thumbprint)Parametreler
| Name | Description |
|---|---|
|
device_id
Gerekli
|
Cihazın adı (Kimlik). |
|
module_id
Gerekli
|
Modülün adı (Kimlik). |
|
managed_by
Gerekli
|
Yönetici cihazının adı (edge). |
|
etag
Gerekli
|
Güncelleştirme işlemi için kullanılacak etag (if_match) değeri. |
|
primary_thumbprint
Gerekli
|
Birincil X509 parmak izi. |
|
secondary_thumbprint
Gerekli
|
İkincil X509 parmak izi. |
Döndürülenler
| Tür | Description |
|---|---|
|
Oluşturulan modülü içeren güncelleştirilmiş Module nesnesi. |
Özel durumlar
| Tür | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
update_twin
Cihaz ikizinin etiketlerini ve istenen özelliklerini Güncelleştirmeler.
update_twin(device_id, device_twin, etag=None)Parametreler
| Name | Description |
|---|---|
|
device_id
Gerekli
|
Cihazın adı (Kimlik). |
|
device_twin
Gerekli
|
Cihazın ikiz bilgileri. |
|
etag
|
Güncelleştirme işlemi için kullanılacak etag (if_match) değeri. varsayılan değer: None
|
Döndürülenler
| Tür | Description |
|---|---|
|
İkiz nesnesi. |
Özel durumlar
| Tür | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
Azure SDK for Python
Geri Bildirim
Çok yakında: 2024 boyunca, içerik için geri bildirim mekanizması olarak GitHub Sorunları’nı kullanımdan kaldıracak ve yeni bir geri bildirim sistemiyle değiştireceğiz. Daha fazla bilgi için bkz. https://aka.ms/ContentUserFeedback.
Gönderin ve geri bildirimi görüntüleyin