ConfigurationOperations Osztály

ConfigurationOperations-műveletek.

Öröklődés

builtins.object

ConfigurationOperations

Konstruktor

ConfigurationOperations(client, config, serializer, deserializer)

Paraméterek

client

Kötelező

Ügyfél a szolgáltatáskérésekhez.

config

Kötelező

A szolgáltatásügyfél konfigurálása.

serializer

Kötelező

Egy objektummodell szerializálója.

deserializer

Kötelező

Objektummodell-deszerializáló.

Változók

api_version

Az API verziója. Állandó érték: "2021-04-12".

Metódusok

apply_on_edge_device	A konfigurációs tartalmat egy peremeszközre alkalmazza.
create_or_update	Létrehoz vagy frissít egy konfigurációt a IoT Hub az automatikus eszköz-/modulkezeléshez. A konfigurációazonosító és a tartalom nem frissíthető.
delete	Törli a konfigurációt az automatikus eszköz-/modulkezelés IoT Hub.
get	Beolvas egy konfigurációt az automatikus eszköz-/modulkezelés IoT Hub.
get_configurations	Konfigurációkat kér le az automatikus eszköz-/modulkezelés IoT Hub. A tördelés nem támogatott.
test_queries	Ellenőrzi a célfeltételt és az egyéni metrika-lekérdezéseket a IoT Hub konfiguráláshoz.

apply_on_edge_device

A konfigurációs tartalmat egy peremeszközre alkalmazza.

apply_on_edge_device(id, content, custom_headers=None, raw=False, **operation_config)

Paraméterek

id

str

Kötelező

A peremeszköz egyedi azonosítója.

content

ConfigurationContent

Kötelező

A konfiguráció tartalma.

custom_headers

dict

alapértelmezett érték: None

a kérelemhez hozzáadandó fejlécek

raw

bool

alapértelmezett érték: False

a deszerializált válasz mellett a közvetlen választ adja vissza

operation_config

Kötelező

Műveleti konfiguráció felülbírálásai.

Válaszok

Nincs vagy ClientRawResponse, ha raw=true

Visszatérési típus

None,

ClientRawResponse

Kivételek

HttpOperationError

create_or_update

Létrehoz vagy frissít egy konfigurációt a IoT Hub az automatikus eszköz-/modulkezeléshez. A konfigurációazonosító és a tartalom nem frissíthető.

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

Paraméterek

id

str

Kötelező

A konfiguráció egyedi azonosítója.

configuration

Configuration

Kötelező

A létrehozandó vagy frissítendő konfiguráció.

if_match

str

alapértelmezett érték: None

A konfiguráció gyenge ETag-jének megfelelő sztring, az RFC7232 szerint. Ezt nem szabad beállítani konfiguráció létrehozásakor, de konfiguráció frissítésekor lehet beállítani.

custom_headers

dict

alapértelmezett érték: None

a kérelemhez hozzáadandó fejlécek

raw

bool

alapértelmezett érték: False

a deszerializált válasz mellett a közvetlen választ adja vissza

operation_config

Kötelező

Műveleti konfiguráció felülbírálásai.

Válaszok

Konfiguráció vagy ClientRawResponse, ha raw=true

Visszatérési típus

Configuration,

ClientRawResponse

Kivételek

HttpOperationError

delete

Törli a konfigurációt az automatikus eszköz-/modulkezelés IoT Hub.

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

Paraméterek

id

str

Kötelező

A konfiguráció egyedi azonosítója.

if_match

str

alapértelmezett érték: None

A konfiguráció gyenge ETag-jének megfelelő sztring, az RFC7232 szerint. A törlési műveletet csak akkor hajtja végre a rendszer, ha ez az ETag megegyezik a kiszolgáló által fenntartott értékkel, ami azt jelzi, hogy a konfiguráció nem lett módosítva a legutóbbi lekérése óta. Feltétel nélküli törlés kényszerítéséhez állítsa a If-Match helyettesítő karakterre (*).

custom_headers

dict

alapértelmezett érték: None

a kérelemhez hozzáadandó fejlécek

raw

bool

alapértelmezett érték: False

a deszerializált válasz mellett a közvetlen választ adja vissza

operation_config

Kötelező

Műveleti konfiguráció felülbírálásai.

Válaszok

Nincs vagy ClientRawResponse, ha raw=true

Visszatérési típus

None,

ClientRawResponse

Kivételek

HttpOperationError

get

Beolvas egy konfigurációt az automatikus eszköz-/modulkezelés IoT Hub.

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

Paraméterek

id

str

Kötelező

A konfiguráció egyedi azonosítója.

custom_headers

dict

alapértelmezett érték: None

a kérelemhez hozzáadandó fejlécek

raw

bool

alapértelmezett érték: False

a deszerializált válasz mellett a közvetlen választ adja vissza

operation_config

Kötelező

Műveleti konfiguráció felülbírálásai.

Válaszok

Konfiguráció vagy ClientRawResponse, ha raw=true

Visszatérési típus

Configuration,

ClientRawResponse

Kivételek

HttpOperationError

get_configurations

Konfigurációkat kér le az automatikus eszköz-/modulkezelés IoT Hub. A tördelés nem támogatott.

get_configurations(top=None, custom_headers=None, raw=False, **operation_config)

Paraméterek

top

int

alapértelmezett érték: None

A lekérendő konfigurációk száma. Az érték felül lesz bírálva, ha nagyobb, mint a IoT Hub maximális üzembehelyezési száma.

custom_headers

dict

alapértelmezett érték: None

a kérelemhez hozzáadandó fejlécek

raw

bool

alapértelmezett érték: False

a deszerializált válasz mellett a közvetlen választ adja vissza

operation_config

Kötelező

Műveleti konfiguráció felülbírálásai.

Válaszok

list vagy ClientRawResponse if raw=true

Visszatérési típus

list[Configuration],

ClientRawResponse

Kivételek

HttpOperationError

test_queries

Ellenőrzi a célfeltételt és az egyéni metrika-lekérdezéseket a IoT Hub konfiguráláshoz.

test_queries(input, custom_headers=None, raw=False, **operation_config)

Paraméterek

input

ConfigurationQueriesTestInput

Kötelező

A célfeltételek és az egyéni metrika-lekérdezések konfigurációja.

custom_headers

dict

alapértelmezett érték: None

a kérelemhez hozzáadandó fejlécek

raw

bool

alapértelmezett érték: False

a deszerializált válasz mellett a közvetlen választ adja vissza

operation_config

Kötelező

Műveleti konfiguráció felülbírálásai.

Válaszok

ConfigurationQueriesTestResponse vagy ClientRawResponse if raw=true

Visszatérési típus

ConfigurationQueriesTestResponse,

ClientRawResponse

Kivételek

HttpOperationError

Attribútumok

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