Udostępnij przez

az iot hub state

  • Eksperymentalne

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

Ta grupa poleceń jest eksperymentalna i opracowywana. Poziomy odwołań i pomocy technicznej: https://aka.ms/CLI_refstatus

Zarządzanie stanem usługi IoT Hub.

Aby uzyskać więcej informacji, zobacz aka.ms/aziotcli-iot-hub-state.

Polecenia

Nazwa Opis Typ Stan
az iot hub state export

Wyeksportuj stan usługi IoT Hub do pliku.

 Extension Experimental
az iot hub state import

Zaimportuj stan centrum z pliku do usługi IoT Hub.

 Extension Experimental
az iot hub state migrate

Przeprowadź migrację stanu jednego koncentratora do innego centrum bez zapisywania w pliku.

 Extension Experimental

az iot hub state export

Eksperymentalne

Grupa poleceń "stan centrum iot" jest eksperymentalna i rozwijana. Poziomy odwołań i pomocy technicznej: https://aka.ms/CLI_refstatus

Wyeksportuj stan usługi IoT Hub do pliku.

Domyślnie wyeksportowany stan obejmuje: szablon arm dla centrum, konfiguracje koncentratora (w tym konfiguracje usługi ADM i wdrożenia brzegowe), informacje o urządzeniu (w tym tożsamości urządzeń, bliźniacze reprezentacje urządzeń, tożsamości modułów i bliźniacze reprezentacje modułów).

Aby uzyskać więcej informacji, zobacz aka.ms/aziotcli-iot-hub-state.

az iot hub state export --state-file
                        [--aspects {arm, configurations, devices}]
                        [--auth-type {key, login}]
                        [--hub-name]
                        [--login]
                        [--replace]
                        [--resource-group]

Przykłady

Wyeksportuj obsługiwany stan określonego centrum do określonego pliku.

az iot hub state export -n {iothub_name} -f {state_filename}

Wyeksportuj obsługiwany stan określonego centrum do określonego pliku, zastępując zawartość pliku.

az iot hub state export -n {iothub_name} -f {state_filename} -r

Eksportuj tylko urządzenia i konfiguracje określonego centrum do określonego pliku.

az iot hub state export -n {iothub_name} -f {state_filename} --aspects devices configurations

Parametry wymagane

--state-file -f

Ścieżka do pliku, w którym będą przechowywane informacje o stanie.

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.

--aspects

Aspekty centrum (oddzielone spacjami).

Właściwość Wartość
Dopuszczalne wartości: arm, configurations, devices
--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
--replace -r

Jeśli ta flaga jest ustawiona, polecenie zastąpi zawartość pliku wyjściowego.

Właściwość Wartość
Domyślna wartość: False
--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 hub state import

Eksperymentalne

Grupa poleceń "stan centrum iot" jest eksperymentalna i rozwijana. Poziomy odwołań i pomocy technicznej: https://aka.ms/CLI_refstatus

Zaimportuj stan centrum z pliku do usługi IoT Hub.

Jeśli zostanie określony aspekt ramienia, koncentrator zostanie utworzony, jeśli nie istnieje.

Domyślnie importowany stan obejmuje: szablon ramienia dla centrum, konfiguracje koncentratora (w tym konfiguracje usługi ADM i wdrożenia brzegowe), informacje o urządzeniu (w tym tożsamości urządzeń, bliźniacze reprezentacje urządzeń, tożsamości modułu i bliźniacze reprezentacje modułów).

W przypadku zaimportowanych punktów końcowych z uwierzytelnianiem tożsamości przypisanej przez system określone centrum musi mieć odpowiednie uprawnienia. W przeciwnym razie polecenie zakończy się niepowodzeniem.

Prywatne punkty końcowe zostaną zignorowane w procesie importowania.

Aby uzyskać więcej informacji, zobacz aka.ms/aziotcli-iot-hub-state.

az iot hub state import --state-file
                        [--aspects {arm, configurations, devices}]
                        [--auth-type {key, login}]
                        [--hub-name]
                        [--login]
                        [--replace]
                        [--resource-group]

Przykłady

Zaimportuj obsługiwany stan z określonego pliku do określonego centrum.

az iot hub state import -n {iothub_name} -f {state_filename}

Zaimportuj obsługiwany stan z określonego pliku do określonego centrum, zastępując poprzedni stan centrum. Wszystkie certyfikaty, konfiguracje i urządzenia zostaną usunięte przed przekazaniem nowego stanu.

az iot hub state import -n {iothub_name} -f {state_filename} -r

Zaimportuj tylko szablon arm z określonego pliku do określonego koncentratora. Należy pamiętać, że spowoduje to utworzenie nowego centrum, jeśli nie istnieje. Plik może zawierać urządzenia i konfiguracje, ale zostaną one zignorowane.

az iot hub state import -n {iothub_name} -g {resource_group} -f {state_filename} --aspects arm

Zaimportuj tylko urządzenia i konfiguracje z określonego pliku do określonego centrum. Należy pamiętać, że nie spowoduje to utworzenia nowego centrum, jeśli nie istnieje, a polecenie zakończy się niepowodzeniem. Plik może zawierać szablon arm, ale zostanie zignorowany.

az iot hub state import -n {iothub_name} -f {state_filename} --aspects devices configurations

Parametry wymagane

--state-file -f

Ścieżka do pliku, w którym będą przechowywane informacje o stanie.

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.

--aspects

Aspekty centrum (oddzielone spacjami).

Właściwość Wartość
Dopuszczalne wartości: arm, configurations, devices
--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
--replace -r

Jeśli ta flaga jest ustawiona, polecenie spowoduje usunięcie bieżących urządzeń, konfiguracji i certyfikatów centrum docelowego.

Właściwość Wartość
Domyślna wartość: False
--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 hub state migrate

Eksperymentalne

Grupa poleceń "stan centrum iot" jest eksperymentalna i rozwijana. Poziomy odwołań i pomocy technicznej: https://aka.ms/CLI_refstatus

Przeprowadź migrację stanu jednego koncentratora do innego centrum bez zapisywania w pliku.

Jeśli zostanie określony aspekt ramienia, koncentrator zostanie utworzony, jeśli nie istnieje.

Domyślnie migrowany stan obejmuje: szablon arm dla centrum, konfiguracje koncentratora (w tym konfiguracje usługi ADM i wdrożenia brzegowe), informacje o urządzeniu (w tym tożsamości urządzeń, bliźniacze reprezentacje urządzeń, tożsamości modułu i bliźniacze reprezentacje modułów).

W przypadku migrowanych punktów końcowych z uwierzytelnianiem tożsamości przypisanej przez system określone centrum musi mieć odpowiednie uprawnienia. W przeciwnym razie polecenie zakończy się niepowodzeniem.

Prywatne punkty końcowe zostaną zignorowane w procesie migracji.

Jeśli masz problemy z migracją, użyj poleceń eksportu i importu, aby utworzyć plik jako kopię zapasową.

Aby uzyskać więcej informacji, zobacz aka.ms/aziotcli-iot-hub-state.

az iot hub state migrate [--aspects {arm, configurations, devices}]
                         [--auth-type {key, login}]
                         [--destination-hub --dh]
                         [--destination-hub-login --dl]
                         [--destination-resource-group --dg]
                         [--og --origin-resource-group]
                         [--oh --origin-hub]
                         [--ol --origin-hub-login]
                         [--replace]

Przykłady

Przeprowadź migrację obsługiwanego stanu centrum pochodzenia do centrum docelowego.

az iot hub state migrate --destination-hub {dest_hub_name} --origin-hub {orig_hub_name}

Przeprowadź migrację obsługiwanego stanu centrum pochodzenia do centrum docelowego, zastępując poprzedni stan centrum. Wszystkie certyfikaty, konfiguracje i urządzenia w centrum docelowym zostaną usunięte przed przekazaniem nowego stanu.

az iot hub state migrate --destination-hub {dest_hub_name} --origin-hub {orig_hub_name} -r

Migrowanie tylko szablonu arm z centrum pochodzenia do centrum docelowego. Należy pamiętać, że spowoduje to utworzenie nowego centrum, jeśli centrum docelowe nie istnieje. Centrum pochodzenia może zawierać urządzenia i konfiguracje, ale zostaną one zignorowane.

az iot hub state migrate --destination-hub {dest_hub_name} --destination-resource-group {dest_hub_resource_group} --origin-hub {orig_hub_name} --aspects arm

Migrowanie tylko urządzeń i konfiguracji z centrum pochodzenia do centrum docelowego. Należy pamiętać, że nie spowoduje to utworzenia nowego centrum, jeśli centrum docelowe nie istnieje, a polecenie zakończy się niepowodzeniem. Szablon arm dla centrum pochodzenia zostanie zignorowany.

az iot hub state migrate --destination-hub {dest_hub_name} --origin-hub {orig_hub_name} --aspects devices configurations

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.

--aspects

Aspekty centrum (oddzielone spacjami).

Właściwość Wartość
Dopuszczalne wartości: arm, configurations, devices
--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
--destination-hub --dh

Nazwa centrum IoT Hub, do którego zostanie skopiowany stan centrum pochodzenia.

Właściwość Wartość
Grupa parametrów: IoT Hub Identifier Arguments
--destination-hub-login --dl

To polecenie obsługuje parametry połączenia jednostki z uprawnieniami do wykonywania akcji w centrum docelowym. Użyj polecenia , aby uniknąć logowania sesji za pośrednictwem az login dla tego wystąpienia usługi IoT Hub. Jeśli parametry połączenia jednostki i nazwa są podane parametry połączenia mają priorytet. Wymagane, jeśli nie podano --destination-hub.

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

Nazwa grupy zasobów usługi IoT Hub, do której zostanie skopiowany stan centrum pochodzenia. Jeśli nie zostanie podana, użyje początkowej grupy zasobów usługi IoT Hub.

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

Nazwa grupy zasobów usługi IoT Hub, która zostanie skopiowana.

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

Nazwa usługi IoT Hub, która zostanie skopiowana.

Właściwość Wartość
Grupa parametrów: IoT Hub Identifier Arguments
--ol --origin-hub-login

To polecenie obsługuje parametry połączenia jednostki z uprawnieniami do wykonywania akcji w centrum pochodzenia. Użyj polecenia , aby uniknąć logowania sesji za pośrednictwem az login dla tego wystąpienia usługi IoT Hub. Jeśli parametry połączenia jednostki i nazwa są podane parametry połączenia mają priorytet. Wymagane, jeśli nie podano opcji --origin-hub.

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

Jeśli ta flaga jest ustawiona, polecenie spowoduje usunięcie bieżących urządzeń, konfiguracji i certyfikatów centrum docelowego.

Właściwość Wartość
Domyślna wartość: False
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