Aracılığıyla paylaş

DevicesOperations Sınıf

  • Başvuru

DevicesOperations işlemleri.

Devralma
builtins.object
DevicesOperations

Oluşturucu

DevicesOperations(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 kimlik kayıt defterinde bir cihazın kimliğini oluşturur veya güncelleştirir.
delete_identity

Bir cihazın kimliğini IoT Hub kimlik kayıt defterinden siler.
get_devices

IoT Hub kimlik kayıt defterinden birden çok cihazın kimliklerini alır. Önerilmez. Cihaz ikizi ve cihaz kimliği bilgilerini almak için IoT Hub sorgu API'sini 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_identity

IoT Hub kimlik kayıt defterinden bir cihaz alır.
get_twin

Cihaz 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 cihazda 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

Cihaz 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

Cihaz 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 kimlik kayıt defterinde bir cihazın kimliğini oluşturur veya güncelleştirir.

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

Parametreler

id
str
Gerekli

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

device
Device
Gerekli

Cihaz kimliğinin içeriği.

if_match
str
varsayılan değer: None

RFC7232'ye göre cihaz kimliği için zayıf bir ETag'i temsil eden dize. Bu ayar cihaz oluşturulurken ayarlanmamalıdır, ancak bir cihaz 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

Device veya ClientRawResponse if raw=true

Dönüş türü

Device,
ClientRawResponse

Özel durumlar

HttpOperationError

delete_identity

Bir cihazın kimliğini IoT Hub kimlik kayıt defterinden siler.

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

Parametreler

id
str
Gerekli

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

if_match
str
varsayılan değer: None

RFC7232'ye göre cihaz kimliği 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 cihaz kimliğinin son alınmasından bu yana değiştirilmediğini gösterir. Koşulsuz silmeyi zorlamak için If-Match joker karakter (*) 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_devices

IoT Hub kimlik kayıt defterinden birden çok cihazın kimliklerini alır. Önerilmez. Cihaz ikizi ve cihaz kimliği bilgilerini almak için IoT Hub sorgu API'sini 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(top=None, custom_headers=None, raw=False, **operation_config)

Parametreler

top
int
varsayılan değer: None

Sorgu tarafından döndürülen en fazla cihaz kimliği sayısı. 1-1000 aralığındaki tüm değerler 1000 olarak kabul edilir.

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[Device],
ClientRawResponse

Özel durumlar

HttpOperationError

get_identity

IoT Hub kimlik kayıt defterinden bir cihaz alır.

get_identity(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

Device veya ClientRawResponse if raw=true

Dönüş türü

Device,
ClientRawResponse

Özel durumlar

HttpOperationError

get_twin

Cihaz 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, 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

Raw=true ise Twin veya ClientRawResponse

Dönüş türü

Twin,
ClientRawResponse

Özel durumlar

HttpOperationError

invoke_method

Bir cihazda 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, direct_method_request, custom_headers=None, raw=False, **operation_config)

Parametreler

device_id
str
Gerekli

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

direct_method_request
CloudToDeviceMethod
Gerekli

Cihazda 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

Cihaz 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, device_twin_info, if_match=None, custom_headers=None, raw=False, **operation_config)

Parametreler

id
str
Gerekli

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

device_twin_info
Twin
Gerekli

Mevcut bilgilerin yerini alacak cihaz 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

Raw=true ise Twin veya ClientRawResponse

Dönüş türü

Twin,
ClientRawResponse

Özel durumlar

HttpOperationError

update_twin

Cihaz 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, device_twin_info, if_match=None, custom_headers=None, raw=False, **operation_config)

Parametreler

id
str
Gerekli

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

device_twin_info
Twin
Gerekli

Etiketleri ve güncelleştirilecek istenen özellikleri içeren cihaz 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

Raw=true ise Twin veya ClientRawResponse

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'>