az iot hub module-identity

Odwołanie

Uwaga

Ta dokumentacja jest częścią rozszerzenia azure-iot dla interfejsu wiersza polecenia platformy Azure (wersja 2.30.0 lub nowsza). Rozszerzenie automatycznie zainstaluje polecenie az iot hub module-identity po raz pierwszy. Dowiedz się więcej o rozszerzeniach.

Zarządzanie modułami urządzeń IoT.

Polecenia

az iot hub module-identity connection-string	Zarządzanie parametrami połączenia modułu urządzenia IoT.
az iot hub module-identity connection-string show	Pokaż docelowe parametry połączenia modułu urządzenia IoT.
az iot hub module-identity create	Utwórz moduł na docelowym urządzeniu IoT w IoT Hub.
az iot hub module-identity delete	Usuń urządzenie w IoT Hub.
az iot hub module-identity list	Wyświetlanie listy modułów znajdujących się na urządzeniu IoT w IoT Hub.
az iot hub module-identity renew-key	Odnów klucze docelowe modułu urządzenia IoT Hub przy użyciu uwierzytelniania sas.
az iot hub module-identity show	Uzyskaj szczegółowe informacje o module urządzenia IoT w IoT Hub.
az iot hub module-identity update	Zaktualizuj moduł urządzenia IoT Hub.

az iot hub module-identity create

Utwórz moduł na docelowym urządzeniu IoT w IoT Hub.

W przypadku korzystania z metody uwierzytelniania shared_private_key (znanej również jako klucze symetryczne), jeśli usługa nie zostanie dostarczona, usługa wygeneruje je dla modułu.

az iot hub module-identity create --device-id
                                  --module-id
                                  [--am {shared_private_key, x509_ca, x509_thumbprint}]
                                  [--auth-type {key, login}]
                                  [--hub-name]
                                  [--login]
                                  [--od]
                                  [--pk]
                                  [--primary-thumbprint]
                                  [--resource-group]
                                  [--secondary-key]
                                  [--secondary-thumbprint]
                                  [--valid-days]

Parametry wymagane

--device-id -d

Urządzenie docelowe.

--module-id -m

Moduł docelowy.

Parametry opcjonalne

--am --auth-method

Metoda autoryzacji, z którą ma zostać utworzona jednostka.

akceptowane wartości: shared_private_key, x509_ca, x509_thumbprint

wartość domyślna: shared_private_key

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

--od --output-dir

Wygeneruj certyfikat z podpisem własnym i użyj odcisku palca. Dane wyjściowe określonego katalogu docelowego.

--pk --primary-key

Podstawowy symetryczny klucz dostępu współdzielonego przechowywany w formacie base64.

--primary-thumbprint --ptp

Odcisk palca certyfikatu z podpisem własnym do użycia na potrzeby podstawowego odcisku palca.

--resource-group -g

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

--secondary-key --sk

Pomocniczy symetryczny klucz dostępu współdzielonego przechowywany w formacie base64.

--secondary-thumbprint --stp

Odcisk palca certyfikatu z podpisem własnym do użycia na potrzeby pomocniczego odcisku palca.

--valid-days --vd

Wygeneruj certyfikat z podpisem własnym i użyj odcisku palca. Prawidłowa dla określonej liczby dni. Wartość domyślna: 365.

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 module-identity delete

Usuń urządzenie w IoT Hub.

az iot hub module-identity delete --device-id
                                  --module-id
                                  [--auth-type {key, login}]
                                  [--etag]
                                  [--hub-name]
                                  [--login]
                                  [--resource-group]

Parametry wymagane

--device-id -d

Urządzenie docelowe.

--module-id -m

Moduł docelowy.

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ł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 module-identity list

Wyświetlanie listy modułów znajdujących się na urządzeniu IoT w IoT Hub.

az iot hub module-identity list --device-id
                                [--auth-type {key, login}]
                                [--hub-name]
                                [--login]
                                [--resource-group]
                                [--top]

Parametry wymagane

--device-id -d

Urządzenie docelowe.

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 elementów do zwrócenia. Użyj -1, aby uzyskać nieograniczoną liczbę.

wartość domyślna: 1000

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 module-identity renew-key

Odnów klucze docelowe modułu urządzenia IoT Hub przy użyciu uwierzytelniania sas.

az iot hub module-identity renew-key --device-id
                                     --hub-name
                                     --key-type {primary, secondary, swap}
                                     --module-id
                                     [--auth-type {key, login}]
                                     [--etag]
                                     [--login]
                                     [--resource-group]

Przykłady

Odnów klucz podstawowy.

az iot hub module-identity renew-key -m {module_name} -d {device_id} -n {iothub_name} --kt primary

Zamień klucze podstawowe i pomocnicze.

az iot hub module-identity renew-key -m {module_name} -d {device_id} -n {iothub_name} --kt swap

Parametry wymagane

--device-id -d

Urządzenie docelowe.

--hub-name -n

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

--key-type --kt

Typ klucza docelowego do ponownego wygenerowania.

akceptowane wartości: primary, secondary, swap

--module-id -m

Moduł docelowy.

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ść "*".

--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ł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 module-identity show

Uzyskaj szczegółowe informacje o module urządzenia IoT w IoT Hub.

az iot hub module-identity show --device-id
                                --module-id
                                [--auth-type {key, login}]
                                [--hub-name]
                                [--login]
                                [--resource-group]

Parametry wymagane

--device-id -d

Urządzenie docelowe.

--module-id -m

Moduł docelowy.

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ł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 module-identity update

Zaktualizuj moduł urządzenia IoT Hub.

Użyj parametru --set, a następnie przypisań właściwości do aktualizowania modułu. Skorzystaj z właściwości zwróconych z pokazu tożsamości modułu usługi iot hub.

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

Przykłady

Ponowne generowanie kluczy uwierzytelniania symetrycznego modułu

az iot hub module-identity update -m {module_name} -d {device_id} -n {iothub_name} --set authentication.symmetricKey.primaryKey="" authentication.symmetricKey.secondaryKey=""

Parametry wymagane

--device-id -d

Urządzenie docelowe.

--module-id -m

Moduł docelowy.

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

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

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