az iot hub configuration

Uwaga

Ta dokumentacja jest częścią rozszerzenia azure-iot dla interfejsu wiersza polecenia platformy Azure (wersja 2.30.0 lub nowsza). Rozszerzenie zostanie automatycznie zainstalowane przy pierwszym uruchomieniu polecenia az iot hub configuration . Dowiedz się więcej o rozszerzeniach.

Zarządzanie konfiguracją automatycznego zarządzania urządzeniami IoT na dużą skalę.

Polecenia

az iot hub configuration create	Utwórz konfigurację automatycznego zarządzania urządzeniami IoT w IoT Hub docelowym.
az iot hub configuration delete	Usuń konfigurację urządzenia IoT.
az iot hub configuration list	Wyświetl listę konfiguracji automatycznego zarządzania urządzeniami IoT w IoT Hub.
az iot hub configuration show	Uzyskaj szczegółowe informacje o konfiguracji automatycznego zarządzania urządzeniami IoT.
az iot hub configuration show-metric	Oceń docelową metrykę użytkownika lub systemu zdefiniowaną w konfiguracji urządzenia IoT.
az iot hub configuration update	Zaktualizuj określone właściwości konfiguracji automatycznego zarządzania urządzeniami IoT. Użyj parametru --set, a następnie przypisań właściwości do aktualizowania konfiguracji. Uwaga: zawartość konfiguracji jest niezmienna. Właściwości konfiguracji, które można zaktualizować, to "etykiety", "metryki", "priorytet" i "targetCondition".

az iot hub configuration create

Utwórz konfigurację automatycznego zarządzania urządzeniami IoT w IoT Hub docelowym.

Zawartość konfiguracji jest json i nieznacznie różni się w zależności od intencji urządzenia lub modułu.

Konfiguracje urządzeń są w postaci {"deviceContent":{...}} lub {"content":{"deviceContent":{...}}}

Konfiguracje modułów są w postaci {"moduleContent":{...}} lub {"content":{"moduleContent":{...}}}

Konfiguracje można zdefiniować przy użyciu metryk dostarczonych przez użytkownika do oceny na żądanie. Metryki użytkownika są json i w postaci {"zapytania":{...}} lub {"metrics":{"queries":{...}}}.

Uwaga: Warunek docelowy modułów musi zaczynać się od "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]

Przykłady

Utwórz konfigurację urządzenia z priorytetem 3, który ma zastosowanie pod warunkiem, że urządzenie jest oznaczone w budynku 9, a środowisko jest "testowe".

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

Utwórz konfigurację urządzenia z etykietami i podaj wbudowane metryki użytkownika (przykład składni bash)

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

Utwórz konfigurację modułu z etykietami i podaj wbudowane metryki użytkownika (przykład składni cmd)

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'\"}}}"

Tworzenie konfiguracji modułu z zawartością i metrykami użytkownika w tekście (przykład składni programu PowerShell)

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''\"}}}'

Parametry wymagane

--config-id -c

Docelowa nazwa konfiguracji urządzenia.

--content -k

Zawartość konfiguracji urządzenia. Podaj ścieżkę pliku lub nieprzetworzone dane json.

Parametry opcjonalne

--auth-type

Wskazuje, czy operacja powinna automatycznie uzyskać klucz zasad, czy użyć bieżącej sesji Azure AD. Wartość domyślną można skonfigurować przy użyciu polecenia az configure --defaults iothub-data-auth-type=<auth-type-value>.

akceptowane wartości: key, login

wartość domyślna: key

--hub-name -n

IoT Hub nazwa. Wymagane, jeśli nie podano --login.

--lab --labels

Mapa etykiet, które mają być stosowane do konfiguracji docelowej. Przykład formatu: {"key0":"value0", "key1":"value1"}.

--login -l

To polecenie obsługuje parametry połączenia jednostki z prawami do wykonania akcji. Użyj polecenia , aby uniknąć logowania sesji za pomocą polecenia "az login". Jeśli parametry połączenia jednostki i nazwa są podane parametry połączenia mają priorytet. Wymagane, jeśli nie podano nazwy --hub-name.

--metrics -m

Definicje metryk konfiguracji urządzenia. Podaj ścieżkę pliku lub nieprzetworzone dane json.

--pri --priority

Waga konfiguracji urządzenia w przypadku konkurencyjnych reguł (najwyższe zwycięstwa).

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

--target-condition --tc -t

Warunek docelowy, w którym ma zastosowanie konfiguracja urządzenia lub modułu. Konfiguracje bez warunku docelowego nie będą dotyczyć żadnego urządzenia ani modułu.

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Możesz skonfigurować domyślną subskrypcję przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj polecenia --debug, aby uzyskać pełne dzienniki debugowania.

az iot hub configuration delete

Usuń konfigurację urządzenia IoT.

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

Parametry wymagane

--config-id -c

Docelowa nazwa konfiguracji urządzenia.

Parametry opcjonalne

--auth-type

Wskazuje, czy operacja powinna automatycznie uzyskać klucz zasad, czy użyć bieżącej sesji Azure AD. Wartość domyślną można skonfigurować przy użyciu polecenia az configure --defaults iothub-data-auth-type=<auth-type-value>.

akceptowane wartości: key, login

wartość domyślna: key

--etag -e

Etag lub tag jednostki odpowiadający ostatniemu stanowi zasobu. Jeśli nie podano elementu etag, zostanie użyta wartość "*".

--hub-name -n

IoT Hub nazwa. Wymagane, jeśli nie podano --login.

--login -l

To polecenie obsługuje parametry połączenia jednostki z prawami do wykonania akcji. Użyj polecenia , aby uniknąć logowania sesji za pomocą polecenia "az login". Jeśli parametry połączenia jednostki i nazwa są podane parametry połączenia mają priorytet. Wymagane, jeśli nie podano nazwy --hub-name.

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Możesz skonfigurować domyślną subskrypcję przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj polecenia --debug, aby uzyskać pełne dzienniki debugowania.

az iot hub configuration list

Wyświetl listę konfiguracji automatycznego zarządzania urządzeniami IoT w IoT Hub.

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

Parametry opcjonalne

--auth-type

Wskazuje, czy operacja powinna automatycznie uzyskać klucz zasad, czy użyć bieżącej sesji Azure AD. Wartość domyślną można skonfigurować przy użyciu polecenia az configure --defaults iothub-data-auth-type=<auth-type-value>.

akceptowane wartości: key, login

wartość domyślna: key

--hub-name -n

IoT Hub nazwa. Wymagane, jeśli nie podano --login.

--login -l

To polecenie obsługuje parametry połączenia jednostki z prawami do wykonania akcji. Użyj polecenia , aby uniknąć logowania sesji za pomocą polecenia "az login". Jeśli parametry połączenia jednostki i nazwa są podane parametry połączenia mają priorytet. Wymagane, jeśli nie podano nazwy --hub-name.

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

--top

Maksymalna liczba konfiguracji do zwrócenia. Domyślnie wszystkie konfiguracje są zwracane.

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Możesz skonfigurować domyślną subskrypcję przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj polecenia --debug, aby uzyskać pełne dzienniki debugowania.

az iot hub configuration show

Uzyskaj szczegółowe informacje o konfiguracji automatycznego zarządzania urządzeniami IoT.

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

Parametry wymagane

--config-id -c

Docelowa nazwa konfiguracji urządzenia.

Parametry opcjonalne

--auth-type

Wskazuje, czy operacja powinna automatycznie uzyskać klucz zasad, czy użyć bieżącej sesji Azure AD. Wartość domyślną można skonfigurować przy użyciu polecenia az configure --defaults iothub-data-auth-type=<auth-type-value>.

akceptowane wartości: key, login

wartość domyślna: key

--hub-name -n

IoT Hub nazwa. Wymagane, jeśli nie podano --login.

--login -l

To polecenie obsługuje parametry połączenia jednostki z prawami do wykonania akcji. Użyj polecenia , aby uniknąć logowania sesji za pomocą polecenia "az login". Jeśli parametry połączenia jednostki i nazwa są podane parametry połączenia mają priorytet. Wymagane, jeśli nie podano nazwy --hub-name.

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Możesz skonfigurować domyślną subskrypcję przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj polecenia --debug, aby uzyskać pełne dzienniki debugowania.

az iot hub configuration show-metric

Oceń docelową metrykę użytkownika lub systemu zdefiniowaną w konfiguracji urządzenia IoT.

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

Przykłady

Ocena metryki "warningLimit" zdefiniowanej przez użytkownika

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

Ocena metryki "appliedCount" systemu

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

Parametry wymagane

--config-id -c

Docelowa nazwa konfiguracji urządzenia.

--metric-id -m

Docelowa metryka do oceny.

Parametry opcjonalne

--auth-type

Wskazuje, czy operacja powinna automatycznie uzyskać klucz zasad, czy użyć bieżącej sesji Azure AD. Wartość domyślną można skonfigurować przy użyciu polecenia az configure --defaults iothub-data-auth-type=<auth-type-value>.

akceptowane wartości: key, login

wartość domyślna: key

--hub-name -n

IoT Hub nazwa. Wymagane, jeśli nie podano --login.

--login -l

To polecenie obsługuje parametry połączenia jednostki z prawami do wykonania akcji. Użyj polecenia , aby uniknąć logowania sesji za pomocą polecenia "az login". Jeśli parametry połączenia jednostki i nazwa są podane parametry połączenia mają priorytet. Wymagane, jeśli nie podano nazwy --hub-name.

--metric-type --mt

Wskazuje, która kolekcja metryk powinna być używana do wyszukiwania metryki.

akceptowane wartości: system, user

wartość domyślna: user

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Możesz skonfigurować domyślną subskrypcję przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj polecenia --debug, aby uzyskać pełne dzienniki debugowania.

az iot hub configuration update

Zaktualizuj określone właściwości konfiguracji automatycznego zarządzania urządzeniami IoT.

Użyj parametru --set, a następnie przypisań właściwości do aktualizowania konfiguracji.

Uwaga: zawartość konfiguracji jest niezmienna. Właściwości konfiguracji, które można zaktualizować, to "etykiety", "metryki", "priorytet" i "targetCondition".

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

Przykłady

Zmienianie priorytetu konfiguracji urządzenia i aktualizowanie jego warunku docelowego

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

Parametry wymagane

--config-id -c

Docelowa nazwa konfiguracji urządzenia.

Parametry opcjonalne

--add

Dodaj obiekt do listy obiektów, określając pary ścieżki i wartości klucza. Przykład: --add property.listProperty <key=value, string lub JSON string>.

--auth-type

Wskazuje, czy operacja powinna automatycznie uzyskać klucz zasad, czy użyć bieżącej sesji Azure AD. Wartość domyślną można skonfigurować przy użyciu polecenia az configure --defaults iothub-data-auth-type=<auth-type-value>.

akceptowane wartości: key, login

wartość domyślna: key

--etag -e

Etag lub tag jednostki odpowiadający ostatniemu stanowi zasobu. Jeśli nie podano elementu etag, zostanie użyta wartość "*".

--force-string

W przypadku używania polecenia "set" lub "add" zachowaj literały ciągu zamiast próbować przekonwertować na kod JSON.

--hub-name -n

IoT Hub nazwa. Wymagane, jeśli nie podano --login.

--login -l

To polecenie obsługuje parametry połączenia jednostki z prawami do wykonania akcji. Użyj polecenia , aby uniknąć logowania sesji za pomocą polecenia "az login". Jeśli parametry połączenia jednostki i nazwa są podane parametry połączenia mają priorytet. Wymagane, jeśli nie podano nazwy --hub-name.

--remove

Usuń właściwość lub element z listy. Przykład: --remove property.list OR --remove propertyToRemove.

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

--set

Zaktualizuj obiekt, określając ścieżkę właściwości i wartość do ustawienia. Przykład: --set property1.property2=.

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Możesz skonfigurować domyślną subskrypcję przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj polecenia --debug, aby uzyskać pełne dzienniki debugowania.