az iot hub device-identity

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 hub device-identity . Dowiedz się więcej o rozszerzeniach.

Zarządzanie urządzeniami IoT.

Polecenia

Nazwa	Opis	Typ	Stan
az iot hub device-identity children	Zarządzanie relacjami urządzeń podrzędnych dla urządzeń usługi IoT Edge.	Numer wewnętrzny	Ogólna dostępność
az iot hub device-identity children add	Dodaj urządzenia jako elementy podrzędne do docelowego urządzenia brzegowego.	Numer wewnętrzny	Ogólna dostępność
az iot hub device-identity children list	Zwraca kolekcję przypisanych urządzeń podrzędnych.	Numer wewnętrzny	Ogólna dostępność
az iot hub device-identity children remove	Usuń urządzenia podrzędne z docelowego urządzenia brzegowego.	Numer wewnętrzny	Ogólna dostępność
az iot hub device-identity connection-string	Zarządzanie parametry połączenia urządzenia IoT.	Numer wewnętrzny	Ogólna dostępność
az iot hub device-identity connection-string show	Pokaż dane parametry połączenia urządzenia usługi IoT Hub.	Numer wewnętrzny	Ogólna dostępność
az iot hub device-identity create	Tworzenie urządzenia w usłudze IoT Hub.	Numer wewnętrzny	Ogólna dostępność
az iot hub device-identity delete	Usuwanie urządzenia usługi IoT Hub.	Numer wewnętrzny	Ogólna dostępność
az iot hub device-identity export	Wyeksportuj wszystkie tożsamości urządzeń z usługi IoT Hub do kontenera obiektów blob usługi Azure Storage.	Numer wewnętrzny	Ogólna dostępność
az iot hub device-identity import	Zaimportuj tożsamości urządzeń do usługi IoT Hub z obiektu blob kontenera magazynu.	Numer wewnętrzny	Ogólna dostępność
az iot hub device-identity list	Wyświetlanie listy urządzeń w usłudze IoT Hub.	Numer wewnętrzny	Ogólna dostępność
az iot hub device-identity parent	Zarządzanie relacjami urządzeń nadrzędnych dla urządzeń IoT.	Numer wewnętrzny	Ogólna dostępność
az iot hub device-identity parent set	Ustaw urządzenie nadrzędne urządzenia docelowego.	Numer wewnętrzny	Ogólna dostępność
az iot hub device-identity parent show	Pobierz urządzenie nadrzędne urządzenia docelowego.	Numer wewnętrzny	Ogólna dostępność
az iot hub device-identity renew-key	Odnów klucze docelowe urządzenia usługi IoT Hub przy użyciu uwierzytelniania sas.	Numer wewnętrzny	Ogólna dostępność
az iot hub device-identity show	Uzyskaj szczegółowe informacje o urządzeniu usługi IoT Hub.	Numer wewnętrzny	Ogólna dostępność
az iot hub device-identity update	Aktualizowanie urządzenia usługi IoT Hub.	Numer wewnętrzny	Ogólna dostępność

az iot hub device-identity create

Tworzenie urządzenia w usłudze IoT Hub.

W przypadku korzystania z metody uwierzytelniania shared_private_key (nazywanej również kluczami symetrycznymi), jeśli usługa nie zostanie dostarczona, usługa wygeneruje je dla urządzenia.

Jeśli dla urządzenia brzegowego zostanie podany zakres urządzenia brzegowego, wartość zostanie automatycznie przekonwertowana na zakres nadrzędny.

az iot hub device-identity create --device-id
                                  [--am {shared_private_key, x509_ca, x509_thumbprint}]
                                  [--auth-type {key, login}]
                                  [--device-scope]
                                  [--edge-enabled {false, true}]
                                  [--hub-name]
                                  [--login]
                                  [--od]
                                  [--pk]
                                  [--primary-thumbprint]
                                  [--resource-group]
                                  [--secondary-key]
                                  [--secondary-thumbprint]
                                  [--sta {disabled, enabled}]
                                  [--star]
                                  [--valid-days]

Przykłady

Utwórz urządzenie IoT z włączoną krawędzią z domyślną autoryzacją (klucz prywatny udostępniony).

az iot hub device-identity create -n {iothub_name} -d {device_id} --ee

Utwórz urządzenie IoT z autoryzacją certyfikatu z podpisem własnym, wygeneruj certyfikat ważny przez 10 dni, a następnie użyj jego odcisku palca.

az iot hub device-identity create -n {iothub_name} -d {device_id} --am x509_thumbprint --valid-days 10

Utwórz urządzenie IoT z autoryzacją certyfikatu z podpisem własnym, wygeneruj certyfikat domyślnego wygaśnięcia (365 dni) i dane wyjściowe do katalogu docelowego.

az iot hub device-identity create -n {iothub_name} -d {device_id} --am x509_thumbprint --output-dir /path/to/output

Utwórz urządzenie IoT z autoryzacją certyfikatu z podpisem własnym i jawnie podaj podstawowe i pomocnicze odciski palca.

az iot hub device-identity create -n {iothub_name} -d {device_id} --am x509_thumbprint --ptp {thumbprint_1} --stp {thumbprint_2}

Utwórz urządzenie IoT z autoryzacją głównego urzędu certyfikacji z wyłączonym stanem i przyczyną.

az iot hub device-identity create -n {iothub_name} -d {device_id} --am x509_ca --status disabled --status-reason 'for reasons'

Utwórz urządzenie IoT z zakresem urządzenia.

az iot hub device-identity create -n {iothub_name} -d {device_id} --device-scope 'ms-azure-iot-edge://edge0-123456789123456789'

Parametry wymagane

--device-id -d

Identyfikator urządzenia docelowego.

Parametry opcjonalne

--am --auth-method

Metoda autoryzacji, za pomocą której 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 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

--device-scope

Zakres urządzenia. W przypadku urządzeń brzegowych jest to generowane automatycznie i niezmienne. W przypadku urządzeń liścia ustaw tę opcję, aby utworzyć relację podrzędną/nadrzędną.

--edge-enabled --ee

Flaga wskazująca włączenie krawędzi.

akceptowane wartości: false, true

wartość domyślna: False

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

--od --output-dir

Wygeneruj certyfikat z podpisem własnym i użyj jego odcisku palca. Dane wyjściowe do 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 w podstawowym 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 w pomocniczym odcisku palca.

--sta --status

Ustaw stan urządzenia podczas tworzenia.

akceptowane wartości: disabled, enabled

wartość domyślna: enabled

--star --status-reason

Opis stanu urządzenia.

--valid-days --vd

Wygeneruj certyfikat z podpisem własnym i użyj jego 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.

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.

az iot hub device-identity delete

Usuwanie urządzenia usługi IoT Hub.

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

Parametry wymagane

--device-id -d

Identyfikator urządzenia docelowego.

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

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

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

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

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.

az iot hub device-identity export

Wyeksportuj wszystkie tożsamości urządzeń z usługi IoT Hub do kontenera obiektów blob usługi Azure Storage.

Wyjściowy obiekt blob zawierający tożsamości urządzeń jest plikiem tekstowym o nazwie "devices.txt".

Wymagane uprawnienia — zasady dostępu współdzielonego usługi IoT Hub obsługujące "Zapis rejestru i zapis rejestru" lub podmiot z główną rolą "Współautor danych usługi IoT Hub" w usłudze IoT Hub.

Parametry nazwy konta magazynu i nazwy kontenera obiektów blob mogą być używane tylko wtedy, gdy konto magazynu znajduje się w tej samej subskrypcji co dane wejściowe usługi IoT Hub. W przypadku wbudowanych danych wejściowych identyfikatora URI sygnatury dostępu współdzielonego kontenera obiektów blob zapoznaj się z regułami wejściowymi środowiska.

W celu uzyskania więcej informacji, zobacz następujący temat: https://aka.ms/iothub-device-exportimport.

az iot hub device-identity export [--auth-type {key, login}]
                                  [--bc]
                                  [--bcu]
                                  [--hub-name]
                                  [--identity]
                                  [--ik {false, true}]
                                  [--login]
                                  [--resource-group]
                                  [--sa]

Przykłady

Wyeksportuj wszystkie tożsamości urządzeń do skonfigurowanego kontenera obiektów blob i dołącz klucze urządzeń. Nazwa kontenera obiektów blob i nazwa konta magazynu są podawane jako parametry polecenia .

az iot hub device-identity export -n {iothub_name} --ik --bc {blob_container_name} --sa {storage_account_name}

Wyeksportuj wszystkie tożsamości urządzeń do skonfigurowanego kontenera obiektów blob i dołącz klucze urządzeń. Używa wbudowanego przykładu identyfikatora URI sygnatury dostępu współdzielonego.

az iot hub device-identity export -n {iothub_name} --ik --bcu 'https://mystorageaccount.blob.core.windows.net/devices?sv=2019-02-02&st=2020-08-23T22%3A35%3A00Z&se=2020-08-24T22%3A35%3A00Z&sr=c&sp=rwd&sig=VrmJ5sQtW3kLzYg10VqmALGCp4vtYKSLNjZDDJBSh9s%3D'

Wyeksportuj wszystkie tożsamości urządzeń do skonfigurowanego kontenera obiektów blob przy użyciu ścieżki pliku zawierającej identyfikator URI sygnatury dostępu współdzielonego.

az iot hub device-identity export -n {iothub_name} --bcu {sas_uri_filepath}

Wyeksportuj wszystkie tożsamości urządzeń do skonfigurowanego kontenera obiektów blob i dołącz klucze urządzeń. Używa tożsamości przypisanej przez system, która ma role współautora danych obiektu blob usługi Storage dla konta magazynu. Nazwa kontenera obiektów blob i nazwa konta magazynu są podawane jako parametry polecenia .

az iot hub device-identity export -n {iothub_name} --ik --bc {blob_container_name} --sa {storage_account_name} --identity [system]

Wyeksportuj wszystkie tożsamości urządzeń do skonfigurowanego kontenera obiektów blob i dołącz klucze urządzeń. Używa tożsamości przypisanej przez system, która ma role współautora danych obiektu blob usługi Storage dla konta magazynu. Identyfikator URI kontenera obiektów blob nie wymaga tokenu SAS obiektu blob.

az iot hub device-identity export -n {iothub_name} --ik --bcu 'https://mystorageaccount.blob.core.windows.net/devices' --identity [system]

Wyeksportuj wszystkie tożsamości urządzeń do skonfigurowanego kontenera obiektów blob i dołącz klucze urządzeń. Używa tożsamości zarządzanej przypisanej przez użytkownika, która ma rolę Współautor danych obiektu blob usługi Storage dla konta magazynu. Nazwa kontenera obiektów blob i nazwa konta magazynu są podawane jako parametry polecenia .

az iot hub device-identity export -n {iothub_name} --ik --bc {blob_container_name} --sa {storage_account_name} --identity {managed_identity_resource_id}

Wyeksportuj wszystkie tożsamości urządzeń do skonfigurowanego kontenera obiektów blob i dołącz klucze urządzeń. Używa tożsamości zarządzanej przypisanej przez użytkownika, która ma rolę Współautor danych obiektu blob usługi Storage dla konta magazynu. Identyfikator URI kontenera obiektów blob nie wymaga tokenu SAS obiektu blob.

az iot hub device-identity export -n {iothub_name} --ik --bcu 'https://mystorageaccount.blob.core.windows.net/devices' --identity {managed_identity_resource_id}

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

--bc --blob-container

Ten kontener obiektów blob służy do wyprowadzania stanu zadania importowania tożsamości urządzenia i wyników. Parametr jest ignorowany po podaniu blob_container_uri. Dla tego kontenera obiektów blob wymagany jest dostęp do zapisu, odczytu i usuwania.

--bcu --blob-container-uri

Identyfikator URI sygnatury dostępu współdzielonego obiektu blob z dostępem do kontenera obiektów blob z dostępem do zapisu, odczytu i usuwania. Służy do wyprowadzania stanu zadania i wyników. Uwaga: w przypadku korzystania z uwierzytelniania opartego na tożsamości identyfikator URI https:// jest nadal wymagany — ale nie jest wymagany żaden token SAS. Dane wejściowe dla tego argumentu mogą być wbudowane lub ze ścieżki pliku.

--hub-name -n

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

--identity

Typ tożsamości zarządzanej w celu określenia, czy jest używana tożsamość zarządzana przypisana przez system lub tożsamość zarządzana przypisana przez użytkownika. W przypadku tożsamości zarządzanej przypisanej przez system użyj polecenia [system]. W przypadku tożsamości zarządzanej przypisanej przez użytkownika podaj identyfikator zasobu tożsamości zarządzanej przypisanej przez użytkownika. Ta tożsamość wymaga ról współautora danych obiektu blob usługi Storage dla konta magazynu.

--ik --include-keys

W przypadku ustawienia klucze są eksportowane normalnie. W przeciwnym razie klucze są ustawione na wartość null w danych wyjściowych eksportu.

akceptowane wartości: false, true

wartość domyślna: False

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

--resource-group -g

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

--sa --storage-account

Nazwa konta usługi Azure Storage zawierającego wyjściowy kontener obiektów blob. Parametr jest ignorowany po podaniu blob_container_uri. Wymagany jest dostęp do zapisu, odczytu i usuwania.

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.

az iot hub device-identity import

Zaimportuj tożsamości urządzeń do usługi IoT Hub z obiektu blob kontenera magazynu.

Oczekiwany plik wejściowy zawierający tożsamości urządzeń powinien mieć nazwę "devices.txt". Plik dziennika wyjściowego "importErrors.log" jest pusty, gdy importowanie zakończy się pomyślnie i zawiera dzienniki błędów w przypadku niepowodzenia importu.

Wymagane uprawnienia — zasady dostępu współdzielonego usługi IoT Hub obsługujące "Zapis rejestru i zapis rejestru" lub podmiot z główną rolą "Współautor danych usługi IoT Hub" w usłudze IoT Hub.

Parametry nazwy konta magazynu i nazwy kontenera obiektów blob mogą być używane tylko wtedy, gdy konto magazynu znajduje się w tej samej subskrypcji co dane wejściowe usługi IoT Hub. W przypadku wbudowanych danych wejściowych identyfikatora URI sygnatury dostępu współdzielonego kontenera obiektów blob zapoznaj się z regułami wejściowymi środowiska.

W celu uzyskania więcej informacji, zobacz następujący temat: https://aka.ms/iothub-device-exportimport.

az iot hub device-identity import [--auth-type {key, login}]
                                  [--hub-name]
                                  [--ibc]
                                  [--ibcu]
                                  [--identity]
                                  [--input-storage-account]
                                  [--login]
                                  [--obc]
                                  [--obcu]
                                  [--osa]
                                  [--resource-group]

Przykłady

Zaimportuj wszystkie tożsamości urządzeń z obiektu blob, podając parametry polecenia dla wejściowego kontenera obiektów blob i konta magazynu, a także wyjściowego kontenera obiektów blob i konta magazynu.

az iot hub device-identity import -n {iothub_name} --ibc {input_blob_container_name} --isa {input_storage_account_name} --obc {output_blob_container_name} --osa {output_storage_account_name}

Zaimportuj wszystkie tożsamości urządzeń z obiektu blob przy użyciu wbudowanego identyfikatora URI sygnatury dostępu współdzielonego.

az iot hub device-identity import -n {iothub_name} --ibcu {input_sas_uri} --obcu {output_sas_uri}

Zaimportuj wszystkie tożsamości urządzeń z obiektu blob przy użyciu ścieżki pliku zawierającej identyfikator URI sygnatury dostępu współdzielonego.

az iot hub device-identity import -n {iothub_name} --ibcu {input_sas_uri_filepath} --obcu {output_sas_uri_filepath}

Zaimportuj wszystkie tożsamości urządzeń z obiektu blob przy użyciu tożsamości przypisanej przez system, która ma role Współautor danych obiektu blob usługi Storage dla obu kont magazynu. Wejściowy kontener obiektów blob i konto magazynu, a także wyjściowy kontener obiektów blob i konto magazynu są dostarczane jako parametry polecenia

az iot hub device-identity import -n {iothub_name} --ibc {input_blob_container_name} --isa {input_storage_account_name} --obc {output_blob_container_name} --osa {output_storage_account_name} --identity [system]

Zaimportuj wszystkie tożsamości urządzeń z obiektu blob przy użyciu tożsamości przypisanej przez system, która ma role Współautor danych obiektu blob usługi Storage dla obu kont magazynu. Identyfikator URI kontenera obiektów blob nie wymaga tokenu SAS obiektu blob.

az iot hub device-identity import -n {iothub_name} --ibcu {input_sas_uri} --obcu {output_sas_uri} --identity [system]

Zaimportuj wszystkie tożsamości urządzeń z obiektu blob przy użyciu tożsamości zarządzanej przypisanej przez użytkownika, która ma role Współautor danych obiektu blob usługi Storage dla obu kont magazynu. Wejściowy kontener obiektów blob i konto magazynu, a także wyjściowy kontener obiektów blob i konto magazynu są dostarczane jako parametry polecenia

az iot hub device-identity import -n {iothub_name} --ibc {input_blob_container_name} --isa {input_storage_account_name} --obc {output_blob_container_name} --osa {output_storage_account_name} --identity {managed_identity_resource_id}

Zaimportuj wszystkie tożsamości urządzeń z obiektu blob przy użyciu tożsamości zarządzanej przypisanej przez użytkownika, która ma role Współautor danych obiektu blob usługi Storage dla obu kont magazynu. Identyfikator URI kontenera obiektów blob nie wymaga tokenu SAS obiektu blob.

az iot hub device-identity import -n {iothub_name} --ibcu {input_sas_uri} --obcu {output_sas_uri} --identity {managed_identity_resource_id}

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

--hub-name -n

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

--ibc --input-blob-container

Ten kontener obiektów blob przechowuje plik, który definiuje operacje do wykonania w rejestrze tożsamości. Parametr jest ignorowany po podaniu input_blob_container_uri. Dostęp do odczytu jest wymagany dla tego kontenera obiektów blob.

--ibcu --input-blob-container-uri

Identyfikator URI sygnatury dostępu współdzielonego obiektu blob z dostępem do odczytu do kontenera obiektów blob. Ten obiekt blob zawiera operacje do wykonania w rejestrze tożsamości. Uwaga: w przypadku korzystania z uwierzytelniania opartego na tożsamości identyfikator URI https:// jest nadal wymagany — ale nie jest wymagany żaden token SAS. Dane wejściowe dla tego argumentu mogą być wbudowane lub ze ścieżki pliku.

--identity

Typ tożsamości zarządzanej w celu określenia, czy jest używana tożsamość zarządzana przypisana przez system lub tożsamość zarządzana przypisana przez użytkownika. W przypadku tożsamości zarządzanej przypisanej przez system użyj polecenia [system]. W przypadku tożsamości zarządzanej przypisanej przez użytkownika podaj identyfikator zasobu tożsamości zarządzanej przypisanej przez użytkownika. Ta tożsamość wymaga roli Współautor danych obiektu blob usługi Storage dla docelowego konta magazynu i roli Współautor w usłudze IoT Hub.

--input-storage-account --isa

Nazwa konta usługi Azure Storage zawierającego wejściowy kontener obiektów blob. Wymagane tylko wtedy, gdy nie podano input_blob_container_uri. Wymagany jest dostęp do odczytu.

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

--obc --output-blob-container

Ten kontener obiektów blob służy do wyprowadzania stanu zadania importowania tożsamości urządzenia i wyników. Wymagane tylko wtedy, gdy nie podano input_blob_container_uri. Dostęp do zapisu jest wymagany dla tego kontenera obiektów blob.

--obcu --output-blob-container-uri

Identyfikator URI sygnatury dostępu współdzielonego obiektu blob z dostępem do zapisu w kontenerze obiektów blob. Służy do wyprowadzania stanu zadania i wyników. Uwaga: w przypadku korzystania z uwierzytelniania opartego na tożsamości identyfikator URI https:// bez tokenu SAS jest nadal wymagany. Dane wejściowe dla tego argumentu mogą być wbudowane lub ze ścieżki pliku.

--osa --output-storage-account

Nazwa konta usługi Azure Storage zawierającego wyjściowy kontener obiektów blob. Parametr jest ignorowany po podaniu output_blob_container_uri. Wymagany jest dostęp do zapisu.

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

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.

az iot hub device-identity list

Wyświetlanie listy urządzeń w usłudze IoT Hub.

To polecenie jest aliasem dla az iot hub device-twin listpolecenia , który jest zdecydowanie zalecany w tym poleceniu. W przyszłości to az iot hub device-identity list polecenie może zostać zmienione lub przestarzałe.

az iot hub device-identity list [--auth-type {key, login}]
                                [--edge-enabled {false, true}]
                                [--hub-name]
                                [--login]
                                [--resource-group]
                                [--top]

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

--edge-enabled --ee

Flaga wskazująca włączenie krawędzi.

akceptowane wartości: false, true

wartość domyślna: False

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

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

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.

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.

az iot hub device-identity renew-key

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

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

Przykłady

Odnów klucz podstawowy.

az iot hub device-identity renew-key -d {device_id} -n {iothub_name} --kt primary

Zamień klucze podstawowe i pomocnicze.

az iot hub device-identity renew-key -d {device_id} -n {iothub_name} --kt swap

Parametry wymagane

--device-id -d

Identyfikator urządzenia docelowego.

--hub-name -n

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

--key-type --kt

Typ klucza docelowego do ponownego wygenerowania.

akceptowane wartości: primary, secondary, swap

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

--etag -e

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

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

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

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.

az iot hub device-identity show

Uzyskaj szczegółowe informacje o urządzeniu usługi IoT Hub.

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

Parametry wymagane

--device-id -d

Identyfikator urządzenia docelowego.

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

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

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

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.

az iot hub device-identity update

Aktualizowanie urządzenia usługi IoT Hub.

Użyj parametru --set, a następnie przypisań właściwości do aktualizowania urządzenia. Skorzystaj z parametrów zwracanych z "iot hub device-identity show".

az iot hub device-identity update --device-id
                                  [--add]
                                  [--am {shared_private_key, x509_ca, x509_thumbprint}]
                                  [--auth-type {key, login}]
                                  [--edge-enabled {false, true}]
                                  [--etag]
                                  [--force-string]
                                  [--hub-name]
                                  [--login]
                                  [--pk]
                                  [--primary-thumbprint]
                                  [--remove]
                                  [--resource-group]
                                  [--secondary-key]
                                  [--secondary-thumbprint]
                                  [--set]
                                  [--sta {disabled, enabled}]
                                  [--star]

Przykłady

Włączanie możliwości brzegowych dla urządzenia

az iot hub device-identity update -d {device_id} -n {iothub_name} --set capabilities.iotEdge=true

Włącz możliwości brzegowe dla urządzenia przy użyciu argumentu wygody.

az iot hub device-identity update -d {device_id} -n {iothub_name} --ee

Wyłączanie stanu urządzenia

az iot hub device-identity update -d {device_id} -n {iothub_name} --set status=disabled

Wyłącz stan urządzenia przy użyciu argumentu wygody.

az iot hub device-identity update -d {device_id} -n {iothub_name} --status disabled

W jednym poleceniu

az iot hub device-identity update -d {device_id} -n {iothub_name} --set status=disabled capabilities.iotEdge=true

Parametry wymagane

--device-id -d

Identyfikator urządzenia docelowego.

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

wartość domyślna: []

--am --auth-method

Metoda autoryzacji, za pomocą której ma zostać utworzona jednostka.

akceptowane wartości: shared_private_key, x509_ca, x509_thumbprint

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

--edge-enabled --ee

Flaga wskazująca włączenie krawędzi.

akceptowane wartości: false, true

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

wartość domyślna: False

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

--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 w podstawowym odcisku palca.

--remove

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

wartość domyślna: []

--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 w pomocniczym odcisku palca.

--set

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

wartość domyślna: []

--sta --status

Ustaw stan urządzenia podczas tworzenia.

akceptowane wartości: disabled, enabled

--star --status-reason

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

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.