az iot hub configuration

Megjegyzés

Ez a hivatkozás az Azure CLI Azure-iot bővítményének része (2.30.0-s vagy újabb verzió). A bővítmény automatikusan telepíti az az iot hub konfigurációs parancs 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

az iot hub configuration create	Hozzon létre egy IoT automatikus eszközfelügyeleti konfigurációt egy cél IoT Hub.
az iot hub configuration delete	IoT-eszközkonfiguráció törlése.
az iot hub configuration list	Az IoT automatikus eszközfelügyeleti konfigurációinak listázása egy IoT Hub.
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-metric	Egy IoT-eszközkonfigurációban meghatározott célfelhasználói vagy rendszermetrika kiértékelése.
az iot hub configuration update	IoT automatikus eszközfelügyeleti konfiguráció megadott tulajdonságainak frissítése. A --set és a tulajdonság-hozzárendelések használatával frissítheti a konfigurációt. 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 create

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

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

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

A modulkonfigurációk a következő formában állnak: {"moduleContent":{...}} vagy {"content":{"moduleContent":{...}}}

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

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}]
                                [--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 meg 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

Eszközkonfiguráció létrehozása címkékkel és felhasználói metrikák beágyazott biztosítása (példa bash szintaxisra)

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 biztosítása (példa cmd szintaxisra)

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 tartalommal és felhasználói metrikákkal beágyazott módon (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''\"}}}'

Kötelező paraméterek

--config-id -c

Céleszköz konfigurációjának neve.

--content -k

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

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. Az alapértelmezett beállításokat a használatával az configure --defaults iothub-data-auth-type=<auth-type-value>konfigurálhatja.

elfogadott értékek: key, login

alapértelmezett érték: key

--hub-name -n

IoT Hub nevet. Kötelező, ha a --login nincs megadva.

--lab --labels

A célkonfigurációra alkalmazandó címkék térképe. Példa formátuma: {"key0":"value0", "key1":"value1"}.

--login -l

Ez a parancs olyan entitásokat támogat, kapcsolati sztring műveletek végrehajtásához szükséges jogosultságokkal. Az "az login" használatával történő munkamenet-bejelentkezés elkerülésére használható. Ha egy entitás kapcsolati sztring és név is meg van adva, a kapcsolati sztring prioritást élvez. Kötelező, ha a --hub-name nincs megadva.

--metrics -m

Eszközkonfigurációs metrikák definíciói. Adja meg a fájl elérési útját vagy a nyers JSON-t.

--pri --priority

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

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot a használatával az configure --defaults group=<name>konfigurálhatja.

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

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.

--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 a használatával az account set -s NAME_OR_IDkonfigurálhatja.

--verbose

Növelje a naplózás részletességét. 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.

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. Az alapértelmezett beállításokat a használatával az configure --defaults iothub-data-auth-type=<auth-type-value>konfigurálhatja.

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 nevet. Kötelező, ha a --login nincs megadva.

--login -l

Ez a parancs olyan entitásokat támogat, kapcsolati sztring műveletek végrehajtásához szükséges jogosultságokkal. Az "az login" használatával történő munkamenet-bejelentkezés elkerülésére használható. Ha egy entitás kapcsolati sztring és név is meg van adva, a kapcsolati sztring prioritást élvez. Kötelező, ha a --hub-name nincs megadva.

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot a használatával az configure --defaults group=<name>konfigurálhatja.

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.

--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 a használatával az account set -s NAME_OR_IDkonfigurálhatja.

--verbose

Növelje a naplózás részletességét. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

az iot hub configuration list

Az IoT automatikus eszközfelügyeleti konfigurációinak listázása egy IoT Hub.

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

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. Az alapértelmezett beállításokat a használatával az configure --defaults iothub-data-auth-type=<auth-type-value>konfigurálhatja.

elfogadott értékek: key, login

alapértelmezett érték: key

--hub-name -n

IoT Hub nevet. Kötelező, ha a --login nincs megadva.

--login -l

Ez a parancs olyan entitásokat támogat, kapcsolati sztring műveletek végrehajtásához szükséges jogosultságokkal. Az "az login" használatával történő munkamenet-bejelentkezés elkerülésére használható. Ha egy entitás kapcsolati sztring és név is meg van adva, a kapcsolati sztring prioritást élvez. Kötelező, ha a --hub-name nincs megadva.

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot a használatával az configure --defaults group=<name>konfigurálhatja.

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

--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 a használatával az account set -s NAME_OR_IDkonfigurálhatja.

--verbose

Növelje a naplózás részletességét. 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.

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. Az alapértelmezett beállításokat a használatával az configure --defaults iothub-data-auth-type=<auth-type-value>konfigurálhatja.

elfogadott értékek: key, login

alapértelmezett érték: key

--hub-name -n

IoT Hub nevet. Kötelező, ha a --login nincs megadva.

--login -l

Ez a parancs olyan entitásokat támogat, kapcsolati sztring műveletek végrehajtásához szükséges jogosultságokkal. Az "az login" használatával történő munkamenet-bejelentkezés elkerülésére használható. Ha egy entitás kapcsolati sztring és név is meg van adva, a kapcsolati sztring prioritást élvez. Kötelező, ha a --hub-name nincs megadva.

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot a használatával az configure --defaults group=<name>konfigurálhatja.

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.

--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 a használatával az account set -s NAME_OR_IDkonfigurálhatja.

--verbose

Növelje a naplózás részletességét. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

az iot hub configuration show-metric

Egy IoT-eszközkonfigurációban meghatározott célfelhasználói vagy rendszermetrika kiértékelése.

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}

Az "appliedCount" rendszermetrika 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.

--metric-id -m

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

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. Az alapértelmezett beállításokat a használatával az configure --defaults iothub-data-auth-type=<auth-type-value>konfigurálhatja.

elfogadott értékek: key, login

alapértelmezett érték: key

--hub-name -n

IoT Hub nevet. Kötelező, ha a --login nincs megadva.

--login -l

Ez a parancs olyan entitásokat támogat, kapcsolati sztring műveletek végrehajtásához szükséges jogosultságokkal. Az "az login" használatával történő munkamenet-bejelentkezés elkerülésére használható. Ha egy entitás kapcsolati sztring és név is meg van adva, a kapcsolati sztring prioritást élvez. Kötelező, ha a --hub-name nincs megadva.

--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 a használatával az configure --defaults group=<name>konfigurálhatja.

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.

--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 a használatával az account set -s NAME_OR_IDkonfigurálhatja.

--verbose

Növelje a naplózás részletességét. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

az iot hub configuration update

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

A --set és a tulajdonság-hozzárendelések használatával frissítheti a konfigurációt.

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.

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 vagy JSON string>.

--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. Az alapértelmezett beállításokat a használatával az configure --defaults iothub-data-auth-type=<auth-type-value>konfigurálhatja.

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 az "add" használatakor őrizze meg a sztringkonstansokat ahelyett, hogy JSON-ra próbálnál konvertálni.

--hub-name -n

IoT Hub nevet. Kötelező, ha a --login nincs megadva.

--login -l

Ez a parancs olyan entitásokat támogat, kapcsolati sztring műveletek végrehajtásához szükséges jogosultságokkal. Az "az login" használatával történő munkamenet-bejelentkezés elkerülésére használható. Ha egy entitás kapcsolati sztring és név is meg van adva, a kapcsolati sztring prioritást élvez. Kötelező, ha a --hub-name nincs megadva.

--remove

Tulajdonság vagy elem eltávolítása egy listából. Példa: --remove property.list OR --remove propertyToRemove.

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot a használatával az configure --defaults group=<name>konfigurálhatja.

--set

Objektum frissítése a beállítandó tulajdonság elérési útjának és értékének megadásával. Példa: --set property1.property2=.

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.

--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 a használatával az account set -s NAME_OR_IDkonfigurálhatja.

--verbose

Növelje a naplózás részletességét. Használja a --debug parancsot a teljes hibakeresési naplókhoz.