az iot edge devices

  • Odwołanie

Uwaga

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

Polecenia do zarządzania urządzeniami usługi IoT Edge.

Polecenia

Nazwa Opis Typ Stan
az iot edge devices create

Tworzenie i konfigurowanie wielu urządzeń brzegowych w usłudze IoT Hub.

 Numer wewnętrzny Eksperymentalne

az iot edge devices create

Eksperymentalne

To polecenie jest eksperymentalne i opracowywane. Poziomy odwołań i pomocy technicznej: https://aka.ms/CLI_refstatus

Tworzenie i konfigurowanie wielu urządzeń brzegowych w usłudze IoT Hub.

Ta operacja akceptuje wbudowane argumenty urządzeń lub plik konfiguracji urządzeń brzegowych w formacie YAML lub JSON. Wbudowane polecenia args (na przykład "--device-auth") będą miały pierwszeństwo i zastąpią właściwości pliku konfiguracji, jeśli zostaną podane. Przykładowy plik konfiguracji można znaleźć tutaj: https://aka.ms/aziotcli-edge-devices-config Przejrzyj przykłady i opisy parametrów, aby uzyskać szczegółowe informacje na temat pełnego wykorzystania tej operacji.

az iot edge devices create [--auth-type {key, login}]
                           [--cfg]
                           [--clean {false, true}]
                           [--dct]
                           [--dea]
                           [--device]
                           [--device-auth {shared_private_key, x509_thumbprint}]
                           [--hub-name]
                           [--login]
                           [--out]
                           [--rc]
                           [--resource-group]
                           [--rk]
                           [--root-pass]
                           [--vis {false, true}]
                           [--yes {false, true}]

Przykłady

Tworzenie kilku urządzeń brzegowych przy użyciu uwierzytelniania klucza symetrycznego (ustawienie domyślne)

az iot edge devices create -n {hub_name} --device id=device_1 --device id=device_2

Utwórz płaską listę urządzeń brzegowych przy użyciu uwierzytelniania certyfikatu z podpisem własnym z różnymi konfiguracjami właściwości brzegowych przy użyciu wbudowanych argumentów.

az iot edge devices create -n {hub_name} --device-auth x509_thumbprint --default-edge-agent "mcr.microsoft.com/azureiotedge-agent:1.4"
--device id=device_1 hostname={FQDN}
--device id=device_2 edge_agent={agent_image}
--device id=parent hostname={FQDN} edge_agent={agent_image} container_auth={path_or_json_string}

Usuń wszystkie istniejące tożsamości urządzeń w centrum i utwórz nowe urządzenia na podstawie pliku konfiguracji (z paskami postępu i danymi wyjściowymi wizualizacji).

az iot edge devices create -n {hub_name} --cfg path/to/config_yml_or_json -c -v

Utwórz grupę zagnieżdżonych urządzeń brzegowych z niestandardowymi wdrożeniami modułów — zawierającą 2 urządzenia nadrzędne z 1 urządzeniem podrzędnym, przy użyciu wbudowanych argumentów. Określa również ścieżkę wyjściową dla pakietów certyfikatów urządzenia.

az iot edge devices create -n {hub_name} --out {device_bundle_path}
--device id=parent_1 deployment=/path/to/parentDeployment_1.json
--device id=child_1 parent=parent_1 deployment=/path/to/child_deployment_1.json
--device id=parent_2 deployment=/path/to/parentDeployment_2.json
--device id=child_2 parent=parent_2 deployment=/path/to/child_deployment_2.json

Utwórz prostą konfigurację urządzenia brzegowego zagnieżdżonych przy użyciu istniejącego głównego urzędu certyfikacji przy użyciu uwierzytelniania x509 i określ niestandardową ścieżkę wyjściową pakietu urządzeń.

az iot edge devices create -n {hub_name} --out {device_bundle_path}
--root-cert "root_cert.pem" --root-key "root_key.pem" --device-auth x509_thumbprint
--device id=parent1
--device id=child1 parent=parent1

Parametry opcjonalne

--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 polecenia az configure --defaults iothub-data-auth-type=<auth-type-value>.

akceptowane wartości: key, login
wartość domyślna: key
--cfg --config --config-file

Ścieżka do pliku konfiguracji urządzeń. Przykładowy plik konfiguracji: https://aka.ms/aziotcli-edge-devices-config.

--clean -c

Usuwa wszystkie urządzenia w centrum docelowym przed utworzeniem nowych urządzeń.

akceptowane wartości: false, true
wartość domyślna: False
--dct --device-config-template

Ścieżka do pliku config.toml usługi IoT Edge do użycia jako podstawa konfiguracji urządzeń brzegowych.

--dea --default-agent --default-edge-agent

Domyślny agent brzegowy dla utworzonych urządzeń brzegowych, jeśli nie zostanie określony indywidualnie.

--device -d

Pary klucz=wartość rozdzielane spacjami odpowiadające właściwościom urządzenia brzegowego do utworzenia. Obsługiwane są następujące wartości klucza: id (device_id), deployment (wbudowany kod json lub ścieżka do pliku), hostname, parent (device_id), edge_agent (adres URL obrazu) i container_auth (wbudowany kod json lub ścieżka do pliku). --urządzenie może być używane 1 lub więcej razy. Zapoznaj się z przykładami pomocy dotyczącymi pełnego użycia parametrów — te parametry odnoszą się również do odpowiednich wartości w naszym przykładowym pliku konfiguracji: https://aka.ms/aziotcli-edge-devices-config.

--device-auth --device-auth-type

Mechanizm autoryzacji urządzenia do centrum.

akceptowane wartości: shared_private_key, x509_thumbprint
--hub-name -n

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

--login -l

To polecenie obsługuje jednostkę parametry połączenia z uprawnieniami do wykonania akcji. Użyj polecenia , aby uniknąć logowania do sesji za pomocą polecenia "az login". Jeśli zarówno jednostka parametry połączenia, jak i nazwa są podane, parametry połączenia ma priorytet. Wymagane, jeśli nie podano --hub-name.

--out --output-path

Ścieżka katalogu do pakietów konfiguracji urządzenia wyjściowego. Jeśli ta wartość nie zostanie określona, żadne dane wyjściowe pliku nie zostaną utworzone.

--rc --root-cert

Ścieżka do certyfikatu głównego klucza publicznego w celu podpisania zagnieżdżonych certyfikatów urządzeń brzegowych.

--resource-group -g

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

--rk --root-key

Ścieżka do głównego klucza prywatnego w celu podpisania zagnieżdżonych certyfikatów urządzeń brzegowych.

--root-pass --rp

Hasło klucza głównego.

--vis --visualize -v

Przedstawia wizualizacje urządzeń i postęp różnych zadań (tworzenie urządzenia, ustawianie elementów nadrzędnych, aktualizowanie konfiguracji itp.).

akceptowane wartości: false, true
wartość domyślna: False
--yes -y

Nie monituj o potwierdzenie, gdy do usunięcia istniejących urządzeń koncentratora jest używany przełącznik --clean.

akceptowane wartości: false, true
wartość domyślna: False
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.

akceptowane wartości: json, jsonc, none, table, tsv, yaml, yamlc
wartość domyślna: json
--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 polecenia az account set -s NAME_OR_ID.

--verbose

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