Udostępnij przez

az iot edge deployment

Note

Ta dokumentacja jest częścią rozszerzenia azure-iot dla interfejsu wiersza polecenia platformy Azure (wersja 2.67.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 usługi IoT Edge na dużą skalę.

Polecenia

Nazwa Opis Typ Stan
az iot edge deployment create

Utwórz wdrożenie usługi IoT Edge w docelowym centrum IoT Hub.

 Extension ogólna dostępność
az iot edge deployment delete

Usuwanie wdrożenia usługi IoT Edge.

 Extension ogólna dostępność
az iot edge deployment list

Wyświetlanie listy wdrożeń usługi IoT Edge w usłudze IoT Hub.

 Extension ogólna dostępność
az iot edge deployment show

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

 Extension ogólna dostępność
az iot edge deployment show-metric

Ocena docelowej metryki systemu zdefiniowanej we wdrożeniu usługi IoT Edge.

 Extension ogólna dostępność
az iot edge deployment update

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

 Extension ogólna dostępność

az iot edge deployment create

Utwórz wdrożenie usługi IoT Edge w docelowym centrum IoT Hub.

Zawartość wdrożenia to 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. Ta walidacja jest przeznaczona dla wdrożeń podstawowych. Jeśli odpowiedni schemat nie jest dostępny lub nie zostanie wykryty podstawowy format wdrożenia, ten krok zostanie pominięty. Walidacja schematu może zostać wyłączona przy użyciu przełącznika --no-validation.

Wdrożenie brzegowe jest klasyfikowane jako warstwowe, jeśli moduł ma zdefiniowane właściwości.desired.* Każde urządzenie brzegowe objęte wdrożeniem warstwowym wymaga najpierw zastosowania podstawowego wdrożenia.

Wszystkie wdrożenia warstwowe przeznaczone dla urządzenia muszą mieć wyższy priorytet niż wdrożenie podstawowe dla tego urządzenia.

Uwaga: Jeśli pole properties.desired bliźniaczej reprezentacji modułu jest ustawione we wdrożeniu warstwowym, właściwości.desired zastąpią żądane właściwości tego modułu we wszystkich wdrożeniach o niższym priorytcie.

az iot edge deployment create --content
                              --deployment-id
                              [--auth-type {key, login}]
                              [--cl --custom-labels]
                              [--cmq --custom-metric-queries]
                              [--hub-name]
                              [--lab --labels]
                              [--layered {false, true}]
                              [--login]
                              [--metrics]
                              [--no-validation {false, true}]
                              [--pri --priority]
                              [--resource-group]
                              [--target-condition --tc]

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). Należy pamiętać, że jest to format wdrożenia warstwowego jako properties.desired.* został zdefiniowany.

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

Utwórz wdrożenie warstwowe, które ma zastosowanie do urządzeń w "budynku 9" i środowisku "test". Zarówno metryki użytkownika, jak i zawartość modułów zdefiniowana w tekście (przykład składni bash). Należy pamiętać, że jest to format wdrożenia warstwowego jako properties.desired.* został zdefiniowany.

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

Utwórz wdrożenie, które dotyczy urządzeń w "budynku 9" i środowisku "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 ./modules_content.json --target-condition "tags.building=9 and tags.environment='test'" --metrics ./metrics_content.json

Utwórz wdrożenie, którego definicja pochodzi z pliku z niezależnymi od powłoki danymi wejściowymi etykiet i metryk.

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content ./modules_content.json --target-condition "tags.building=9 and tags.environment='test'" --custom-labels key0=value0 key1=value1 --custom-metric-queries mymetric1="select deviceId from devices where tags.location='US'" mymetric2="select *"

Parametry wymagane

--content -k

Zawartość wdrożenia usługi IoT Edge. Podaj ścieżkę pliku lub nieprzetworzone dane json.

--deployment-id -d

Nazwa wdrożenia docelowego. Małe litery i następujące znaki specjalne są dozwolone: [-+%_*!'].

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--auth-type

Wskazuje, czy operacja powinna automatycznie utworzyć klucz zasad, czy użyć bieżącej sesji usługi Azure AD. Jeśli typ uwierzytelniania to identyfikator logowania i zostanie podana nazwa hosta zasobu, wyszukiwanie zasobów zostanie pominięte, chyba że będzie to konieczne. Wartość domyślną można skonfigurować przy użyciu az configure --defaults iothub-data-auth-type={auth-type-value}.

Właściwość Wartość
Grupa parametrów: Access Control Arguments
Domyślna wartość: key
Dopuszczalne wartości: key, login
--cl --custom-labels

Alternatywny styl danych wejściowych (oddzielone spacją pary klucz=wartość) dla parametrów --labels i przeznaczony do zastąpienia go w przyszłości. Przykład formatu: key1=value1 key2="this is my value".

--cmq --custom-metric-queries

Alternatywny styl danych wejściowych (oddzielone spacją pary klucz=wartość) dla parametrów --metrics i przeznaczony do zastąpienia go w przyszłości. Przykład formatu: metric1="select deviceId from devices where tags.location='US'" metric2="select *".

--hub-name -n

Nazwa lub nazwa hosta usługi IoT Hub. Wymagane, jeśli nie podano opcji --login.

Właściwość Wartość
Grupa parametrów: IoT Hub Identifier Arguments
--lab --labels

Mapa etykiet, które mają być stosowane do wdrożenia docelowego. Użyj następującego formatu: "{"key0":"value0", "key1":"value1"}". Zalecane jest używanie etykiet --custom-labels zamiast --labels.

--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 podstawowego wdrożenia. Właściwości określone we wdrożeniu warstwowym zostaną scalone z właściwościami wdrożenia podstawowego. Właściwości z tą samą ścieżką zostaną zastąpione na podstawie priorytetu wdrożenia. Ta opcja jest aliasem dla --no-validation.

Właściwość Wartość
Domyślna wartość: False
Dopuszczalne wartości: false, true
--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.

Właściwość Wartość
Grupa parametrów: IoT Hub Identifier Arguments
--metrics -m

Definicje metryk użytkownika wdrożenia usługi IoT Edge. Podaj ścieżkę pliku lub nieprzetworzone dane json. Metryki użytkownika są w postaci {"zapytań":{...}} lub {"metrics":{"queries":{...}}}. Zaleca się używanie zapytań --custom-metric-zamiast --metrics.

--no-validation

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

Właściwość Wartość
Domyślna wartość: False
Dopuszczalne wartości: false, true
--pri --priority

Waga wdrożenia w przypadku konkurencyjnych reguł (najwyższe zwycięstwa).

Właściwość Wartość
Domyślna wartość: 0
--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu 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. Użyj następującego formatu: "tags.environment='test'".

Parametry globalne
--debug

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

Właściwość Wartość
Domyślna wartość: False
--help -h

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

--only-show-errors

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

Właściwość Wartość
Domyślna wartość: False
--output -o

Format danych wyjściowych.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Właściwość Wartość
Domyślna wartość: False

az iot edge deployment delete

Usuwanie wdrożenia usługi IoT Edge.

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

Parametry wymagane

--deployment-id -d

Nazwa wdrożenia docelowego. Małe litery i następujące znaki specjalne są dozwolone: [-+%_*!'].

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--auth-type

Wskazuje, czy operacja powinna automatycznie utworzyć klucz zasad, czy użyć bieżącej sesji usługi Azure AD. Jeśli typ uwierzytelniania to identyfikator logowania i zostanie podana nazwa hosta zasobu, wyszukiwanie zasobów zostanie pominięte, chyba że będzie to konieczne. Wartość domyślną można skonfigurować przy użyciu az configure --defaults iothub-data-auth-type={auth-type-value}.

Właściwość Wartość
Grupa parametrów: Access Control Arguments
Domyślna wartość: key
Dopuszczalne wartości: key, login
--etag -e

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

--hub-name -n

Nazwa lub nazwa hosta usługi IoT Hub. Wymagane, jeśli nie podano opcji --login.

Właściwość Wartość
Grupa parametrów: IoT Hub Identifier Arguments
--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.

Właściwość Wartość
Grupa parametrów: IoT Hub Identifier Arguments
--resource-group -g

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

Parametry globalne
--debug

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

Właściwość Wartość
Domyślna wartość: False
--help -h

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

--only-show-errors

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

Właściwość Wartość
Domyślna wartość: False
--output -o

Format danych wyjściowych.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Właściwość Wartość
Domyślna wartość: False

az iot edge deployment list

Wyświetlanie listy wdrożeń usługi IoT Edge w usłudze IoT Hub.

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

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--auth-type

Wskazuje, czy operacja powinna automatycznie utworzyć klucz zasad, czy użyć bieżącej sesji usługi Azure AD. Jeśli typ uwierzytelniania to identyfikator logowania i zostanie podana nazwa hosta zasobu, wyszukiwanie zasobów zostanie pominięte, chyba że będzie to konieczne. Wartość domyślną można skonfigurować przy użyciu az configure --defaults iothub-data-auth-type={auth-type-value}.

Właściwość Wartość
Grupa parametrów: Access Control Arguments
Domyślna wartość: key
Dopuszczalne wartości: key, login
--hub-name -n

Nazwa lub nazwa hosta usługi IoT Hub. Wymagane, jeśli nie podano opcji --login.

Właściwość Wartość
Grupa parametrów: IoT Hub Identifier Arguments
--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.

Właściwość Wartość
Grupa parametrów: IoT Hub Identifier Arguments
--resource-group -g

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

--top

Maksymalna liczba wdrożeń do zwrócenia. Domyślnie zwracane są wszystkie wdrożenia.

Parametry globalne
--debug

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

Właściwość Wartość
Domyślna wartość: False
--help -h

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

--only-show-errors

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

Właściwość Wartość
Domyślna wartość: False
--output -o

Format danych wyjściowych.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Właściwość Wartość
Domyślna wartość: False

az iot edge deployment show

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

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

Parametry wymagane

--deployment-id -d

Nazwa wdrożenia docelowego. Małe litery i następujące znaki specjalne są dozwolone: [-+%_*!'].

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--auth-type

Wskazuje, czy operacja powinna automatycznie utworzyć klucz zasad, czy użyć bieżącej sesji usługi Azure AD. Jeśli typ uwierzytelniania to identyfikator logowania i zostanie podana nazwa hosta zasobu, wyszukiwanie zasobów zostanie pominięte, chyba że będzie to konieczne. Wartość domyślną można skonfigurować przy użyciu az configure --defaults iothub-data-auth-type={auth-type-value}.

Właściwość Wartość
Grupa parametrów: Access Control Arguments
Domyślna wartość: key
Dopuszczalne wartości: key, login
--hub-name -n

Nazwa lub nazwa hosta usługi IoT Hub. Wymagane, jeśli nie podano opcji --login.

Właściwość Wartość
Grupa parametrów: IoT Hub Identifier Arguments
--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.

Właściwość Wartość
Grupa parametrów: IoT Hub Identifier Arguments
--resource-group -g

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

Parametry globalne
--debug

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

Właściwość Wartość
Domyślna wartość: False
--help -h

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

--only-show-errors

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

Właściwość Wartość
Domyślna wartość: False
--output -o

Format danych wyjściowych.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Właściwość Wartość
Domyślna wartość: False

az iot edge deployment show-metric

Ocena docelowej metryki systemu zdefiniowanej we wdrożeniu usługi IoT Edge.

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

Przykłady

Ocena metryki systemu "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

Nazwa wdrożenia docelowego. Małe litery i następujące znaki specjalne są dozwolone: [-+%_*!'].

--metric-id -m

Docelowa metryka do oceny.

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--auth-type

Wskazuje, czy operacja powinna automatycznie utworzyć klucz zasad, czy użyć bieżącej sesji usługi Azure AD. Jeśli typ uwierzytelniania to identyfikator logowania i zostanie podana nazwa hosta zasobu, wyszukiwanie zasobów zostanie pominięte, chyba że będzie to konieczne. Wartość domyślną można skonfigurować przy użyciu az configure --defaults iothub-data-auth-type={auth-type-value}.

Właściwość Wartość
Grupa parametrów: Access Control Arguments
Domyślna wartość: key
Dopuszczalne wartości: key, login
--hub-name -n

Nazwa lub nazwa hosta usługi IoT Hub. Wymagane, jeśli nie podano opcji --login.

Właściwość Wartość
Grupa parametrów: IoT Hub Identifier Arguments
--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.

Właściwość Wartość
Grupa parametrów: IoT Hub Identifier Arguments
--metric-type --mt

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

Właściwość Wartość
Domyślna wartość: user
Dopuszczalne wartości: system, user
--resource-group -g

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

Parametry globalne
--debug

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

Właściwość Wartość
Domyślna wartość: False
--help -h

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

--only-show-errors

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

Właściwość Wartość
Domyślna wartość: False
--output -o

Format danych wyjściowych.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Właściwość Wartość
Domyślna wartość: False

az iot edge deployment update

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

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

Uwaga: zawartość wdrożenia usługi IoT Edge jest niezmienna. Właściwości wdrożenia, które można zaktualizować, to "etykiety", "metryki", "priorytet" 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

Nazwa wdrożenia docelowego. Małe litery i następujące znaki specjalne są dozwolone: [-+%_*!'].

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

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

Właściwość Wartość
Grupa parametrów: Generic Update Arguments
Domyślna wartość: []
--auth-type

Wskazuje, czy operacja powinna automatycznie utworzyć klucz zasad, czy użyć bieżącej sesji usługi Azure AD. Jeśli typ uwierzytelniania to identyfikator logowania i zostanie podana nazwa hosta zasobu, wyszukiwanie zasobów zostanie pominięte, chyba że będzie to konieczne. Wartość domyślną można skonfigurować przy użyciu az configure --defaults iothub-data-auth-type={auth-type-value}.

Właściwość Wartość
Grupa parametrów: Access Control Arguments
Domyślna wartość: key
Dopuszczalne wartości: key, login
--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.

Właściwość Wartość
Grupa parametrów: Generic Update Arguments
Domyślna wartość: False
--hub-name -n

Nazwa lub nazwa hosta usługi IoT Hub. Wymagane, jeśli nie podano opcji --login.

Właściwość Wartość
Grupa parametrów: IoT Hub Identifier Arguments
--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.

Właściwość Wartość
Grupa parametrów: IoT Hub Identifier Arguments
--remove

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

Właściwość Wartość
Grupa parametrów: Generic Update Arguments
Domyślna wartość: []
--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu 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=<value>.

Właściwość Wartość
Grupa parametrów: Generic Update Arguments
Domyślna wartość: []
Parametry globalne
--debug

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

Właściwość Wartość
Domyślna wartość: False
--help -h

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

--only-show-errors

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

Właściwość Wartość
Domyślna wartość: False
--output -o

Format danych wyjściowych.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Właściwość Wartość
Domyślna wartość: False