az iot edge deployment

Odwołanie

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 edge deployment . Dowiedz się więcej o rozszerzeniach.

Zarządzanie wdrożeniami IoT Edge na dużą skalę.

Polecenia

az iot edge deployment create	Utwórz wdrożenie IoT Edge w IoT Hub docelowym.
az iot edge deployment delete	Usuń wdrożenie IoT Edge.
az iot edge deployment list	Wyświetl listę IoT Edge wdrożeń w IoT Hub.
az iot edge deployment show	Uzyskaj szczegółowe informacje o wdrożeniu IoT Edge.
az iot edge deployment show-metric	Oceń metrykę systemu docelowego zdefiniowaną we wdrożeniu IoT Edge.
az iot edge deployment update	Zaktualizuj określone właściwości wdrożenia IoT Edge. Użyj parametru --set, a następnie przypisań właściwości do aktualizowania wdrożenia. Uwaga: IoT Edge zawartość wdrożenia jest niezmienna. Właściwości wdrożenia, które można zaktualizować, to "labels", "metrics", "priority" i "targetCondition".

az iot edge deployment create

Utwórz wdrożenie IoT Edge w IoT Hub docelowym.

Zawartość wdrożenia jest json i w postaci {"modulesContent":{...}} lub {"content":{"modulesContent":{...}}}.

Domyślnie właściwości modułów systemowych $edgeAgent i $edgeHub są weryfikowane względem schematów zainstalowanych z rozszerzeniem IoT. Można to wyłączyć za pomocą przełącznika --no-validation.

Wdrożenia brzegowe można tworzyć przy użyciu metryk zdefiniowanych przez użytkownika dla oceny na żądanie. Metryki użytkownika są json i w postaci {"zapytania":{...}} lub {"metrics":{"queries":{...}}}.

az iot edge deployment create --content
                              --deployment-id
                              [--auth-type {key, login}]
                              [--hub-name]
                              [--lab]
                              [--layered {false, true}]
                              [--login]
                              [--metrics]
                              [--no-validation {false, true}]
                              [--pri]
                              [--resource-group]
                              [--target-condition]

Przykłady

Utwórz wdrożenie z etykietami (przykład składni bash), które ma zastosowanie do urządzeń w budynku 9, a środowisko to "test".

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content modules_content.json --labels '{"key0":"value0", "key1":"value1"}' --target-condition "tags.building=9 and tags.environment='test'" --priority 3

Utwórz wdrożenie z etykietami (przykład składni programu PowerShell), które ma zastosowanie do urządzeń oznaczonych środowiskiem "dev".

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content modules_content.json --labels "{'key':'value'}" --target-condition "tags.environment='dev'"

Utwórz wdrożenie warstwowe, które ma zastosowanie dla urządzeń oznaczonych środowiskiem "dev". Zarówno metryki użytkownika, jak i zawartość modułów zdefiniowana w tekście (przykład składni programu PowerShell).

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content "{'modulesContent':{'`$edgeAgent':{'properties.desired.modules.mymodule0':{ }},'`$edgeHub':{'properties.desired.routes.myroute0':'FROM /messages/* INTO `$upstream'}}}" --target-condition "tags.environment='dev'" --priority 10 --metrics "{'queries':{'mymetrik':'SELECT deviceId from devices where properties.reported.lastDesiredStatus.code = 200'}}" --layered

Utwórz wdrożenie warstwowe, które ma zastosowanie dla urządzeń w środowisku "building 9" i "test". Zarówno metryki użytkownika, jak i zawartość modułów zdefiniowana w tekście (przykład składni bash).

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content '{"modulesContent":{"$edgeAgent":{"properties.desired.modules.mymodule0":{ }},"$edgeHub":{"properties.desired.routes.myroute0":"FROM /messages/* INTO $upstream"}}}' --target-condition "tags.building=9 and tags.environment='test'" --metrics '{"queries":{"mymetrik":"SELECT deviceId from devices where properties.reported.lastDesiredStatus.code = 200"}}' --layered

Utwórz wdrożenie warstwowe, które ma zastosowanie dla urządzeń w środowisku "building 9" i "test". Zarówno metryki użytkownika, jak i zawartość modułów zdefiniowana z pliku.

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content layered_modules_content.json --target-condition "tags.building=9 and tags.environment='test'" --metrics metrics_content.json --layered

Parametry wymagane

--content -k

IoT Edge zawartość wdrożenia. Podaj ścieżkę pliku lub nieprzetworzone dane json.

--deployment-id -d

Docelowa nazwa wdrożenia.

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 wdrożenia docelowego. Użyj następującego formatu: "{"key0":"value0", "key1":"value1"}".

--layered

Wdrożenia warstwowe umożliwiają definiowanie żądanych właściwości w $edgeAgent, $edgeHub i modułach użytkownika, które będą warstwy na podstawie wdrożenia podstawowego. Na przykład trasy określone we wdrożeniu warstwowym zostaną scalone z trasami wdrożenia podstawowego. Trasy o tej samej nazwie zostaną zastąpione na podstawie priorytetu wdrożenia.

akceptowane wartości: false, true

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

IoT Edge definicje metryk wdrożenia. Podaj ścieżkę pliku lub nieprzetworzone dane json.

--no-validation

Wyłącza walidację schematu po stronie klienta na potrzeby tworzenia wdrożenia brzegowego.

akceptowane wartości: false, true

--pri --priority

Waga wdrożenia 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 wdrożenie brzegowe. Wdrożenia bez warunku docelowego nie będą dotyczyć żadnego urządzenia.

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

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

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

az iot edge deployment delete

Usuń wdrożenie IoT Edge.

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

Parametry wymagane

--deployment-id -d

Docelowa nazwa wdrożenia.

Parametry opcjonalne

--auth-type

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

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

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

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

az iot edge deployment list

Wyświetl listę IoT Edge wdrożeń w IoT Hub.

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

Parametry opcjonalne

--auth-type

akceptowane wartości: key, login

wartość domyślna: key

--hub-name -n

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

--login -l

--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 wdrożeń do zwrócenia. Domyślnie wszystkie wdrożenia 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łady.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

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

az iot edge deployment show

Uzyskaj szczegółowe informacje o wdrożeniu IoT Edge.

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

Parametry wymagane

--deployment-id -d

Docelowa nazwa wdrożenia.

Parametry opcjonalne

--auth-type

akceptowane wartości: key, login

wartość domyślna: key

--hub-name -n

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

--login -l

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

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

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

az iot edge deployment show-metric

Oceń metrykę systemu docelowego zdefiniowaną we wdrożeniu IoT Edge.

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

Przykłady

Ocena metryki systemowej "appliedCount"

az iot edge deployment show-metric -m appliedCount -d {deployment_name} -n {iothub_name} --mt system

Ocena metryki użytkownika "myCustomMetric"

az iot edge deployment show-metric -m myCustomMetric -d {deployment_name} -n {iothub_name}

Parametry wymagane

--deployment-id -d

Docelowa nazwa wdrożenia.

--metric-id -m

Docelowa metryka do oceny.

Parametry opcjonalne

--auth-type

akceptowane wartości: key, login

wartość domyślna: key

--hub-name -n

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

--login -l

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

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

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

az iot edge deployment update

Zaktualizuj określone właściwości wdrożenia IoT Edge.

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

Uwaga: IoT Edge zawartość wdrożenia jest niezmienna. Właściwości wdrożenia, które można zaktualizować, to "labels", "metrics", "priority" i "targetCondition".

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

Przykłady

Zmienianie etykiet i warunku docelowego istniejącego wdrożenia brzegowego

az iot edge deployment update -d {deployment_name} -n {iothub_name} --set labels='{"purpose":"dev", "owners":"IoTEngineering"}' targetCondition='tags.building=9'

Parametry wymagane

--deployment-id -d

Docelowa nazwa wdrożenia.

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 ciąg JSON>.

--auth-type

Wskazuje, czy operacja powinna automatycznie wyprowadzać klucz zasad, czy używać 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ć konwertować na format JSON.

--hub-name -n

IoT Hub nazwę. Wymagane, jeśli nie podano opcji --login.

--login -l

To polecenie obsługuje parametry połączenia jednostki z uprawnieniami do wykonania akcji. Użyj polecenia , aby uniknąć logowania do 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 --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łady.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

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