ModulesOperations Sınıf

ModulesOperations işlemleri.

Devralma

builtins.object

ModulesOperations

Oluşturucu

ModulesOperations(client, config, serializer, deserializer)

Parametreler

client

Gerekli

Hizmet istekleri için istemci.

config

Gerekli

Hizmet istemcisi yapılandırması.

serializer

Gerekli

Nesne modeli seri hale getirici.

deserializer

Gerekli

Nesne modeli seri durumdan çıkarıcı.

Değişkenler

api_version

Api sürümü. Sabit değer: "2021-04-12".

Yöntemler

create_or_update_identity	IoT Hub bir cihaz için modül kimliğini oluşturur veya güncelleştirir. moduleId ve generationId kullanıcı tarafından güncelleştirilemez.
delete_identity	IoT Hub bir cihazın modül kimliğini siler.
get_identity	Cihazda bir modül kimliği alır.
get_modules_on_device	Cihazdaki tüm modül kimliklerini alır.
get_twin	Modül ikizini alır. Daha fazla bilgi edinmek için bkz. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins.
invoke_method	Bir cihazın modülünde doğrudan yöntem çağırır. Daha fazla bilgi edinmek için bkz. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-direct-methods.
replace_twin	Bir modül ikizinin etiketlerini ve istenen özelliklerini değiştirir. Daha fazla bilgi edinmek için bkz. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins.
update_twin	Bir modül ikizinin etiketlerini ve istenen özelliklerini Güncelleştirmeler. Daha fazla bilgi edinmek için bkz. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins.

create_or_update_identity

IoT Hub bir cihaz için modül kimliğini oluşturur veya güncelleştirir. moduleId ve generationId kullanıcı tarafından güncelleştirilemez.

create_or_update_identity(id, mid, module, if_match=None, custom_headers=None, raw=False, **operation_config)

Parametreler

id

str

Gerekli

Cihazın benzersiz tanımlayıcısı.

mid

str

Gerekli

Modülün benzersiz tanımlayıcısı.

module

Module

Gerekli

Modül kimliği.

if_match

str

varsayılan değer: None

RFC7232'ye göre modül için zayıf bir ETag'i temsil eden dize. Bu, modül oluşturulurken ayarlanmamalıdır, ancak modül güncelleştirilirken ayarlanabilir.

custom_headers

dict

varsayılan değer: None

isteğe eklenecek üst bilgiler

raw

bool

varsayılan değer: False

seri durumdan çıkarılmış yanıtla birlikte doğrudan yanıtı döndürür

operation_config

Gerekli

İşlem yapılandırması geçersiz kılmaları.

Döndürülenler

Module veya ClientRawResponse if raw=true

Dönüş türü

Module,

ClientRawResponse

Özel durumlar

HttpOperationError

delete_identity

IoT Hub bir cihazın modül kimliğini siler.

delete_identity(id, mid, if_match=None, custom_headers=None, raw=False, **operation_config)

Parametreler

id

str

Gerekli

Aldatıcının benzersiz tanımlayıcısı.

mid

str

Gerekli

Modülün benzersiz tanımlayıcısı.

if_match

str

varsayılan değer: None

RFC7232'ye göre modül için zayıf bir ETag'i temsil eden dize. Silme işlemi yalnızca bu ETag sunucu tarafından tutulan değerle eşleşirse gerçekleştirilir ve bu da modülün son alınmasından bu yana değiştirilmediğini gösterir. Koşulsuz silmeyi zorlamak için If-Match joker karakteri (*) olarak ayarlayın.

custom_headers

dict

varsayılan değer: None

isteğe eklenecek üst bilgiler

raw

bool

varsayılan değer: False

seri durumdan çıkarılmış yanıtla birlikte doğrudan yanıtı döndürür

operation_config

Gerekli

İşlem yapılandırması geçersiz kılmaları.

Döndürülenler

None veya ClientRawResponse if raw=true

Dönüş türü

None,

ClientRawResponse

Özel durumlar

HttpOperationError

get_identity

Cihazda bir modül kimliği alır.

get_identity(id, mid, custom_headers=None, raw=False, **operation_config)

Parametreler

id

str

Gerekli

Cihazın benzersiz tanımlayıcısı.

mid

str

Gerekli

Modülün benzersiz tanımlayıcısı.

custom_headers

dict

varsayılan değer: None

isteğe eklenecek üst bilgiler

raw

bool

varsayılan değer: False

seri durumdan çıkarılmış yanıtla birlikte doğrudan yanıtı döndürür

operation_config

Gerekli

İşlem yapılandırması geçersiz kılmaları.

Döndürülenler

Module veya ClientRawResponse if raw=true

Dönüş türü

Module,

ClientRawResponse

Özel durumlar

HttpOperationError

get_modules_on_device

Cihazdaki tüm modül kimliklerini alır.

get_modules_on_device(id, custom_headers=None, raw=False, **operation_config)

Parametreler

id

str

Gerekli

Cihazın benzersiz tanımlayıcısı.

custom_headers

dict

varsayılan değer: None

isteğe eklenecek üst bilgiler

raw

bool

varsayılan değer: False

seri durumdan çıkarılmış yanıtla birlikte doğrudan yanıtı döndürür

operation_config

Gerekli

İşlem yapılandırması geçersiz kılmaları.

Döndürülenler

list veya ClientRawResponse if raw=true

Dönüş türü

list[Module],

ClientRawResponse

Özel durumlar

HttpOperationError

get_twin

Modül ikizini alır. Daha fazla bilgi edinmek için bkz. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins.

get_twin(id, mid, custom_headers=None, raw=False, **operation_config)

Parametreler

id

str

Gerekli

Cihazın benzersiz tanımlayıcısı.

mid

str

Gerekli

Modülün benzersiz tanımlayıcısı.

custom_headers

dict

varsayılan değer: None

isteğe eklenecek üst bilgiler

raw

bool

varsayılan değer: False

seri durumdan çıkarılmış yanıtla birlikte doğrudan yanıtı döndürür

operation_config

Gerekli

İşlem yapılandırması geçersiz kılmaları.

Döndürülenler

Twin veya ClientRawResponse if raw=true

Dönüş türü

Twin,

ClientRawResponse

Özel durumlar

HttpOperationError

invoke_method

Bir cihazın modülünde doğrudan yöntem çağırır. Daha fazla bilgi edinmek için bkz. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-direct-methods.

invoke_method(device_id, module_id, direct_method_request, custom_headers=None, raw=False, **operation_config)

Parametreler

device_id

str

Gerekli

Cihazın benzersiz tanımlayıcısı.

module_id

str

Gerekli

Modülün benzersiz tanımlayıcısı.

direct_method_request

CloudToDeviceMethod

Gerekli

Modülde doğrudan yöntem yürütme parametreleri.

custom_headers

dict

varsayılan değer: None

isteğe eklenecek üst bilgiler

raw

bool

varsayılan değer: False

seri durumdan çıkarılmış yanıtla birlikte doğrudan yanıtı döndürür

operation_config

Gerekli

İşlem yapılandırması geçersiz kılmaları.

Döndürülenler

CloudToDeviceMethodResult veya ClientRawResponse if raw=true

Dönüş türü

CloudToDeviceMethodResult,

ClientRawResponse

Özel durumlar

HttpOperationError

replace_twin

Bir modül ikizinin etiketlerini ve istenen özelliklerini değiştirir. Daha fazla bilgi edinmek için bkz. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins.

replace_twin(id, mid, device_twin_info, if_match=None, custom_headers=None, raw=False, **operation_config)

Parametreler

id

str

Gerekli

Cihazın benzersiz tanımlayıcısı.

mid

str

Gerekli

Modülün benzersiz tanımlayıcısı.

device_twin_info

Twin

Gerekli

Mevcut bilgilerin yerini alacak modül ikizi bilgileri.

if_match

str

varsayılan değer: None

RFC7232'ye göre cihaz ikizi için zayıf bir ETag'i temsil eden dize. Değiştirme işleminin gerçekleştirilmesi gerekip gerekmediğini belirler.

custom_headers

dict

varsayılan değer: None

isteğe eklenecek üst bilgiler

raw

bool

varsayılan değer: False

seri durumdan çıkarılmış yanıtla birlikte doğrudan yanıtı döndürür

operation_config

Gerekli

İşlem yapılandırması geçersiz kılmaları.

Döndürülenler

Twin veya ClientRawResponse if raw=true

Dönüş türü

Twin,

ClientRawResponse

Özel durumlar

HttpOperationError

update_twin

Bir modül ikizinin etiketlerini ve istenen özelliklerini Güncelleştirmeler. Daha fazla bilgi edinmek için bkz. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins.

update_twin(id, mid, device_twin_info, if_match=None, custom_headers=None, raw=False, **operation_config)

Parametreler

id

str

Gerekli

Cihazın benzersiz tanımlayıcısı.

mid

str

Gerekli

Modülün benzersiz tanımlayıcısı.

device_twin_info

Twin

Gerekli

Etiketleri ve güncelleştirilecek istenen özellikleri içeren modül ikizi bilgileri.

if_match

str

varsayılan değer: None

RFC7232'ye göre cihaz ikizi için zayıf bir ETag'i temsil eden dize. Güncelleştirme işleminin gerçekleştirilmesi gerekip gerekmediğini belirler.

custom_headers

dict

varsayılan değer: None

isteğe eklenecek üst bilgiler

raw

bool

varsayılan değer: False

seri durumdan çıkarılmış yanıtla birlikte doğrudan yanıtı döndürür

operation_config

Gerekli

İşlem yapılandırması geçersiz kılmaları.

Döndürülenler

Twin veya ClientRawResponse if raw=true

Dönüş türü

Twin,

ClientRawResponse

Özel durumlar

HttpOperationError

Öznitelikler

models

models = <module 'azure.iot.hub.protocol.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\iot\\hub\\protocol\\models\\__init__.py'>