az iot hub configuration

Referencia

Feljegyzés

Ez a hivatkozás az Azure CLI azure-iot bővítményének része (2.46.0-s vagy újabb verzió). A bővítmény automatikusan telepíti az az iot hub konfigurációs parancsának első futtatásakor. További információ a bővítményekről.

Nagy méretekben történő automatikus IoT-eszközfelügyelet konfigurációjának kezelése.

Parancsok

Name	Description	Típus	Állapot
az iot hub configuration create	Hozzon létre egy IoT automatikus eszközfelügyeleti konfigurációt egy cél IoT Hubban.	Mellék	FE
az iot hub configuration delete	IoT-eszközkonfiguráció törlése.	Mellék	FE
az iot hub configuration list	IoT-alapú automatikus eszközfelügyeleti konfigurációk listázása egy IoT Hubon.	Mellék	FE
az iot hub configuration show	Az IoT automatikus eszközfelügyeleti konfigurációjának részleteinek lekérése.	Mellék	FE
az iot hub configuration show-metric	Értékelje ki az IoT-eszközkonfigurációban definiált célfelhasználói vagy rendszermetrikát.	Mellék	FE
az iot hub configuration update	Az IoT automatikus eszközfelügyeleti konfiguráció megadott tulajdonságainak frissítése.	Mellék	FE

az iot hub configuration create

Hozzon létre egy IoT automatikus eszközfelügyeleti konfigurációt egy cél IoT Hubban.

A konfigurációs tartalom json, és az eszköz vagy a modul szándékától függően kismértékben változik.

Az eszközkonfigurációk {"deviceContent":{...}} formában vannak vagy {"content":{"deviceContent":{...}}}

A modulkonfigurációk {"moduleContent":{...}} formában vannak vagy {"content":{"moduleContent":{...}}}

A konfigurációk igény szerinti kiértékeléshez a felhasználó által megadott metrikákkal határozhatók meg. A felhasználói metrikák json típusúak, és {"lekérdezések":{...}} vagy {"metrics":{"lekérdezések":{...}}}.

Megjegyzés: A modulok célfeltételének a következővel kell kezdődnie: "from devices.modules where".

az iot hub configuration create --config-id
                                --content
                                [--auth-type {key, login}]
                                [--cl]
                                [--cmq]
                                [--hub-name]
                                [--lab]
                                [--login]
                                [--metrics]
                                [--pri]
                                [--resource-group]
                                [--target-condition]

Példák

Hozzon létre egy 3-as prioritású eszközkonfigurációt, amely akkor érvényes, ha egy eszköz fel van címkézve a 9. épületben, és a környezet "teszt".

az iot hub configuration create -c {config_name} -n {iothub_name} --content device_content.json --target-condition "tags.building=9 and tags.environment='test'" --priority 3

Hozzon létre egy eszközkonfigurációt címkékkel, és adja meg a felhasználói metrikákat beágyazottan (bash szintaxis példája).

az iot hub configuration create -c {config_name} -n {iothub_name} --content device_content.json --target-condition "tags.building=9" --labels '{"key0":"value0", "key1":"value1"}' --priority 10 --metrics '{"metrics": {"queries": {"mymetric": "select deviceId from devices where tags.location='US'"}}}'

Modulkonfiguráció létrehozása címkékkel és felhasználói metrikák beágyazott megadása (példa a parancsmag szintaxisára)

az iot hub configuration create -c {config_name} -n {iothub_name} --content module_content.json --target-condition "from devices.modules where tags.building=9" --labels "{\"key0\":\"value0\", \"key1\":\"value1\"}" --metrics "{\"metrics\": {\"queries\": {\"mymetric\": \"select moduleId from devices.modules where tags.location='US'\"}}}"

Modulkonfiguráció létrehozása beágyazott tartalommal és felhasználói metrikákkal (példa PowerShell-szintaxisra).

az iot hub configuration create -c {config_name} -n {iothub_name} --content '{\"moduleContent\": {\"properties.desired.chillerWaterSettings\": {\"temperature\": 38, \"pressure\": 78}}}' --target-condition "from devices.modules where tags.building=9" --priority 1 --metrics '{\"metrics\": {\"queries\": {\"mymetric\":\"select moduleId from devices.modules where tags.location=''US''\"}}}'

Hozzon létre egy eszközkonfigurációt címkék és metrikák alternatív beviteli stílusával (shell agnostic).

az iot hub configuration create -c {config_name} -n {iothub_name} --content device_content.json --target-condition "from devices.modules where tags.building=9" --custom-labels key0="value0" key1="value1" --priority 10 --custom-metric-queries mymetric1="select deviceId from devices where tags.location='US'" mymetric2="select *"

Kötelező paraméterek

--config-id -c

Céleszköz konfigurációjának neve. Kisbetűs és a következő speciális karakterek engedélyezettek: [-+%_*!].

--content -k

Eszközkonfiguráció tartalma. Adja meg a fájl elérési útját vagy a nyers jsont.

Opcionális paraméterek

--auth-type

Azt jelzi, hogy a műveletnek automatikusan le kell-e származtatnia egy szabályzatkulcsot, vagy az aktuális Azure AD-munkamenetet kell-e használnia. Ha a hitelesítési típus bejelentkezés, és az erőforrás-állomásnév meg van adva, az erőforrás-keresés kihagyva lesz, hacsak nem szükséges. Az alapértelmezett beállítást a következővel az configure --defaults iothub-data-auth-type=<auth-type-value>konfigurálhatja: .

Elfogadott értékek: key, login

Alapértelmezett érték: key

--cl --custom-labels

Alternatív beviteli stílus (szóközzel elválasztott kulcs=értékpárok) a --labelshez, és a jövőben szeretné lecserélni. Példa formázása: key1=value1 key2="ez az én értékem".

--cmq --custom-metric-queries

Alternatív beviteli stílus (szóközzel elválasztott kulcs=értékpárok) a --metrikákhoz, és a jövőben szeretné lecserélni. Példa formázása: metric1="select deviceId from devices where tags.location='US'" metric2="select *".

--hub-name -n

IoT Hub neve vagy állomásneve. Kötelező, ha a --login nincs megadva.

--lab --labels

A célkonfigurációra alkalmazni kívánt címkék térképe. A --custom-labels használata ajánlott a --labels helyett. Példa formázása: {"key0":"value0", "key1":"value1"}.

--login -l

Ez a parancs egy művelet végrehajtására jogosult entitást kapcsolati sztring támogat. Az "az login" használatával elkerülheti a munkamenet-bejelentkezést. Ha egy entitás kapcsolati sztring és név is meg van adva, a kapcsolati sztring elsőbbséget élvez. Ha a --hub-name nincs megadva, kötelező megadni.

--metrics -m

Eszközkonfigurációs metrikadefiníciók. Adja meg a fájl elérési útját vagy a nyers jsont. A --custom-metric-lekérdezések használata ajánlott a --metrics helyett.

--pri --priority

Az eszközkonfiguráció súlya versengő szabályok esetén (a legmagasabb nyer).

Alapértelmezett érték: 0

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>: .

--target-condition --tc -t

Célfeltétel, amelyre egy eszköz- vagy modulkonfiguráció vonatkozik. A célfeltétel nélküli konfigurációk egyetlen eszközt vagy modult sem céloznak meg. Használja a következő formátumot: "tags.environment='test".

Globális paraméterek

--debug

Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.

--help -h

Jelenítse meg ezt a súgóüzenetet, és lépjen ki.

--only-show-errors

Csak a hibák megjelenítése, a figyelmeztetések mellőzése.

--output -o

Kimeneti formátum.

Elfogadott értékek: json, jsonc, none, table, tsv, yaml, yamlc

Alapértelmezett érték: json

--query

JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést konfigurálhatja a következővel az account set -s NAME_OR_ID: .

--verbose

A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

az iot hub configuration delete

IoT-eszközkonfiguráció törlése.

az iot hub configuration delete --config-id
                                [--auth-type {key, login}]
                                [--etag]
                                [--hub-name]
                                [--login]
                                [--resource-group]

Kötelező paraméterek

--config-id -c

Céleszköz konfigurációjának neve. Kisbetűs és a következő speciális karakterek engedélyezettek: [-+%_*!].

Opcionális paraméterek

--auth-type

Elfogadott értékek: key, login

Alapértelmezett érték: key

--etag -e

Az erőforrás utolsó állapotának megfelelő etag vagy entitáscímke. Ha nincs megadva etag, a rendszer a "*" értéket használja.

--hub-name -n

IoT Hub neve vagy állomásneve. Kötelező, ha a --login nincs megadva.

--login -l

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>: .

Globális paraméterek

--debug

Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.

--help -h

Jelenítse meg ezt a súgóüzenetet, és lépjen ki.

--only-show-errors

Csak a hibák megjelenítése, a figyelmeztetések mellőzése.

--output -o

Kimeneti formátum.

Elfogadott értékek: json, jsonc, none, table, tsv, yaml, yamlc

Alapértelmezett érték: json

--query

JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést konfigurálhatja a következővel az account set -s NAME_OR_ID: .

--verbose

A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

az iot hub configuration list

IoT-alapú automatikus eszközfelügyeleti konfigurációk listázása egy IoT Hubon.

az iot hub configuration list [--auth-type {key, login}]
                              [--hub-name]
                              [--login]
                              [--resource-group]
                              [--top]

Opcionális paraméterek

--auth-type

Elfogadott értékek: key, login

Alapértelmezett érték: key

--hub-name -n

IoT Hub neve vagy állomásneve. Kötelező, ha a --login nincs megadva.

--login -l

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>: .

--top

A visszaadandó konfigurációk maximális száma. Alapértelmezés szerint a rendszer minden konfigurációt visszaad.

Globális paraméterek

--debug

Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.

--help -h

Jelenítse meg ezt a súgóüzenetet, és lépjen ki.

--only-show-errors

Csak a hibák megjelenítése, a figyelmeztetések mellőzése.

--output -o

Kimeneti formátum.

Elfogadott értékek: json, jsonc, none, table, tsv, yaml, yamlc

Alapértelmezett érték: json

--query

JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést konfigurálhatja a következővel az account set -s NAME_OR_ID: .

--verbose

A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

az iot hub configuration show

Az IoT automatikus eszközfelügyeleti konfigurációjának részleteinek lekérése.

az iot hub configuration show --config-id
                              [--auth-type {key, login}]
                              [--hub-name]
                              [--login]
                              [--resource-group]

Kötelező paraméterek

--config-id -c

Céleszköz konfigurációjának neve. Kisbetűs és a következő speciális karakterek engedélyezettek: [-+%_*!].

Opcionális paraméterek

--auth-type

Elfogadott értékek: key, login

Alapértelmezett érték: key

--hub-name -n

IoT Hub neve vagy állomásneve. Kötelező, ha a --login nincs megadva.

--login -l

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>: .

Globális paraméterek

--debug

Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.

--help -h

Jelenítse meg ezt a súgóüzenetet, és lépjen ki.

--only-show-errors

Csak a hibák megjelenítése, a figyelmeztetések mellőzése.

--output -o

Kimeneti formátum.

Elfogadott értékek: json, jsonc, none, table, tsv, yaml, yamlc

Alapértelmezett érték: json

--query

JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést konfigurálhatja a következővel az account set -s NAME_OR_ID: .

--verbose

A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

az iot hub configuration show-metric

Értékelje ki az IoT-eszközkonfigurációban definiált célfelhasználói vagy rendszermetrikát.

az iot hub configuration show-metric --config-id
                                     --metric-id
                                     [--auth-type {key, login}]
                                     [--hub-name]
                                     [--login]
                                     [--metric-type {system, user}]
                                     [--resource-group]

Példák

A felhasználó által definiált "warningLimit" metrika kiértékelése

az iot hub configuration show-metric -m warningLimit -c {configuration_name} -n {iothub_name}

A rendszer "appliedCount" metrikájának kiértékelése

az iot hub configuration show-metric --metric-id appliedCount -c {configuration_name} -n {iothub_name} --metric-type system

Kötelező paraméterek

--config-id -c

Céleszköz konfigurációjának neve. Kisbetűs és a következő speciális karakterek engedélyezettek: [-+%_*!].

--metric-id -m

A kiértékelés célmetrikája.

Opcionális paraméterek

--auth-type

Elfogadott értékek: key, login

Alapértelmezett érték: key

--hub-name -n

IoT Hub neve vagy állomásneve. Kötelező, ha a --login nincs megadva.

--login -l

--metric-type --mt

Azt jelzi, hogy melyik metrikagyűjteményt kell használni a metrikák kereséséhez.

Elfogadott értékek: system, user

Alapértelmezett érték: user

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>: .

Globális paraméterek

--debug

Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.

--help -h

Jelenítse meg ezt a súgóüzenetet, és lépjen ki.

--only-show-errors

Csak a hibák megjelenítése, a figyelmeztetések mellőzése.

--output -o

Kimeneti formátum.

Elfogadott értékek: json, jsonc, none, table, tsv, yaml, yamlc

Alapértelmezett érték: json

--query

JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést konfigurálhatja a következővel az account set -s NAME_OR_ID: .

--verbose

A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

az iot hub configuration update

Az IoT automatikus eszközfelügyeleti konfiguráció megadott tulajdonságainak frissítése.

A konfiguráció frissítéséhez használja a --set és a tulajdonság-hozzárendeléseket.

Megjegyzés: A konfigurációs tartalom nem módosítható. A frissíthető konfigurációs tulajdonságok a következők: "címkék", "metrikák", "prioritás" és "targetCondition".

az iot hub configuration update --config-id
                                [--add]
                                [--auth-type {key, login}]
                                [--etag]
                                [--force-string]
                                [--hub-name]
                                [--login]
                                [--remove]
                                [--resource-group]
                                [--set]

Példák

Az eszközkonfiguráció prioritásának módosítása és a célfeltétel frissítése

az iot hub configuration update -c {configuration_name} -n {iothub_name} --set priority=10 targetCondition="tags.building=43 and tags.environment='dev'"

Kötelező paraméterek

--config-id -c

Céleszköz konfigurációjának neve. Kisbetűs és a következő speciális karakterek engedélyezettek: [-+%_*!].

Opcionális paraméterek

--add

Adjon hozzá egy objektumot az objektumok listájához egy elérési út és egy kulcsértékpár megadásával. Példa: --add property.listProperty <key=value, string or JSON string>

Alapértelmezett érték: []

--auth-type

Elfogadott értékek: key, login

Alapértelmezett érték: key

--etag -e

Az erőforrás utolsó állapotának megfelelő etag vagy entitáscímke. Ha nincs megadva etag, a rendszer a "*" értéket használja.

--force-string

A "set" vagy a "add" használata esetén a JSON-ra való konvertálás helyett őrizze meg a sztringkonstansokat.

Alapértelmezett érték: False

--hub-name -n

IoT Hub neve vagy állomásneve. Kötelező, ha a --login nincs megadva.

--login -l

--remove

Tulajdonság vagy elem eltávolítása a listából. Példa: --remove property.list <indexToRemove> VAGY --remove propertyToRemove.

Alapértelmezett érték: []

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>: .

--set

Frissítsen egy objektumot egy beállítandó tulajdonság elérési útjának és értékének megadásával. Példa: --set property1.property2=<value>

Alapértelmezett érték: []

Globális paraméterek

--debug

Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.

--help -h

Jelenítse meg ezt a súgóüzenetet, és lépjen ki.

--only-show-errors

Csak a hibák megjelenítése, a figyelmeztetések mellőzése.

--output -o

Kimeneti formátum.

Elfogadott értékek: json, jsonc, none, table, tsv, yaml, yamlc

Alapértelmezett érték: json

--query

JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést konfigurálhatja a következővel az account set -s NAME_OR_ID: .

--verbose

A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

Megosztás a következőn keresztül:

az iot hub configuration

Parancsok

az iot hub configuration create

Példák

Kötelező paraméterek

Opcionális paraméterek

az iot hub configuration delete

Kötelező paraméterek

Opcionális paraméterek

az iot hub configuration list

Opcionális paraméterek

az iot hub configuration show

Kötelező paraméterek

Opcionális paraméterek

az iot hub configuration show-metric

Példák

Kötelező paraméterek

Opcionális paraméterek

az iot hub configuration update

Példák

Kötelező paraméterek

Opcionális paraméterek

További források