az iot central device-template

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

Zarządzanie i konfigurowanie szablonów urządzeń usługi IoT Central.

Polecenia

Nazwa Opis Typ Stan
az iot central device-template create

Utwórz szablon urządzenia w usłudze IoT Central.

Numer wewnętrzny Ogólna dostępność
az iot central device-template delete

Usuń szablon urządzenia z usługi IoT Central.

Numer wewnętrzny Ogólna dostępność
az iot central device-template list

Pobierz listę szablonów urządzeń dla aplikacji usługi IoT Central.

Numer wewnętrzny Ogólna dostępność
az iot central device-template show

Pobierz szablon urządzenia z usługi IoT Central.

Numer wewnętrzny Ogólna dostępność
az iot central device-template update

Aktualizowanie szablonu urządzenia w usłudze IoT Central.

Numer wewnętrzny Ogólna dostępność

az iot central device-template create

Utwórz szablon urządzenia w usłudze IoT Central.

az iot central device-template create --app-id
                                      --content
                                      --device-template-id
                                      [--api-version {2022-06-30-preview, 2022-07-31}]
                                      [--central-api-uri]
                                      [--token]

Przykłady

Tworzenie szablonu urządzenia z ładunkiem odczytanym z pliku

az iot central device-template create --app-id {appid} --content {pathtofile} --device-template-id {devicetemplateid}

Tworzenie szablonu urządzenia z ładunkiem odczytanym z nieprzetworzonego pliku json

az iot central device-template create --app-id {appid} --content {json} --device-template-id {devicetemplateid}

Parametry wymagane

--app-id -n

Identyfikator aplikacji usługi IoT Central, którą chcesz zarządzać. Identyfikator aplikacji można znaleźć na stronie "Informacje" dla aplikacji w menu pomocy.

--content -k

Definicja szablonu urządzenia. Podaj ścieżkę do pliku JSON lub nieprzetworzonego ciągu JSON. [Przykład ścieżki pliku: ./path/to/file.json] [Przykład ciąguified JSON: {}]. Treść żądania musi zawierać element CapabilityModel.

--device-template-id --dtid

Identyfikator modelu usługi Digital Twin szablonu urządzenia. Dowiedz się więcej na https://aka.ms/iotcentraldtmi.

Parametry opcjonalne

--api-version --av
Przestarzałe

Argument "api_version" został wycofany i zostanie usunięty w przyszłej wersji.

Ten parametr polecenia został przestarzały i zostanie zignorowany. W przyszłej wersji będziemy obsługiwać tylko interfejsy API usługi IoT Central z najnowszej wersji ogólnie dostępnej. Jeśli jakikolwiek interfejs API nie jest jeszcze ogólnie dostępny, wywołamy najnowszą wersję zapoznawcza.

akceptowane wartości: 2022-06-30-preview, 2022-07-31
wartość domyślna: 2022-07-31
--central-api-uri --central-dns-suffix

Sufiks DNS usługi IoT Central skojarzony z aplikacją.

wartość domyślna: azureiotcentral.com
--token

Jeśli wolisz przesłać żądanie bez uwierzytelniania w interfejsie wiersza polecenia platformy Azure, możesz określić prawidłowy token użytkownika w celu uwierzytelnienia żądania. Musisz określić typ klucza w ramach żądania. Dowiedz się więcej na https://aka.ms/iotcentraldocsapi.

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 central device-template delete

Usuń szablon urządzenia z usługi IoT Central.

Uwaga: oczekuje się, że nie powiedzie się, jeśli jakiekolwiek urządzenia nadal są skojarzone z tym szablonem.

az iot central device-template delete --app-id
                                      --device-template-id
                                      [--api-version {2022-06-30-preview, 2022-07-31}]
                                      [--central-api-uri]
                                      [--token]

Przykłady

Usuwanie szablonu urządzenia z usługi IoT Central

az iot central device-template delete --app-id {appid} --device-template-id {devicetemplateid}

Parametry wymagane

--app-id -n

Identyfikator aplikacji usługi IoT Central, którą chcesz zarządzać. Identyfikator aplikacji można znaleźć na stronie "Informacje" dla aplikacji w menu pomocy.

--device-template-id --dtid

Identyfikator szablonu urządzenia docelowego. Przykład: somedevicetemplate.

Parametry opcjonalne

--api-version --av
Przestarzałe

Argument "api_version" został wycofany i zostanie usunięty w przyszłej wersji.

Ten parametr polecenia został przestarzały i zostanie zignorowany. W przyszłej wersji będziemy obsługiwać tylko interfejsy API usługi IoT Central z najnowszej wersji ogólnie dostępnej. Jeśli jakikolwiek interfejs API nie jest jeszcze ogólnie dostępny, wywołamy najnowszą wersję zapoznawcza.

akceptowane wartości: 2022-06-30-preview, 2022-07-31
wartość domyślna: 2022-07-31
--central-api-uri --central-dns-suffix

Sufiks DNS usługi IoT Central skojarzony z aplikacją.

wartość domyślna: azureiotcentral.com
--token

Jeśli wolisz przesłać żądanie bez uwierzytelniania w interfejsie wiersza polecenia platformy Azure, możesz określić prawidłowy token użytkownika w celu uwierzytelnienia żądania. Musisz określić typ klucza w ramach żądania. Dowiedz się więcej na https://aka.ms/iotcentraldocsapi.

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 central device-template list

Pobierz listę szablonów urządzeń dla aplikacji usługi IoT Central.

az iot central device-template list --app-id
                                    [--api-version {2022-06-30-preview, 2022-07-31}]
                                    [--central-api-uri]
                                    [--compact]
                                    [--token]

Przykłady

Wyświetlanie listy wszystkich szablonów urządzeń w aplikacji posortowanych według identyfikatora szablonu (ustawienie domyślne)

az iot central device-template list --app-id {appid}

Parametry wymagane

--app-id -n

Identyfikator aplikacji usługi IoT Central, którą chcesz zarządzać. Identyfikator aplikacji można znaleźć na stronie "Informacje" dla aplikacji w menu pomocy.

Parametry opcjonalne

--api-version --av
Przestarzałe

Argument "api_version" został wycofany i zostanie usunięty w przyszłej wersji.

Ten parametr polecenia został przestarzały i zostanie zignorowany. W przyszłej wersji będziemy obsługiwać tylko interfejsy API usługi IoT Central z najnowszej wersji ogólnie dostępnej. Jeśli jakikolwiek interfejs API nie jest jeszcze ogólnie dostępny, wywołamy najnowszą wersję zapoznawcza.

akceptowane wartości: 2022-06-30-preview, 2022-07-31
wartość domyślna: 2022-07-31
--central-api-uri --central-dns-suffix

Sufiks DNS usługi IoT Central skojarzony z aplikacją.

wartość domyślna: azureiotcentral.com
--compact -c

Pokaż szablony w trybie kompaktowym. Dla każdego szablonu będą wyświetlane tylko identyfikatory, nazwy i typy modeli.

wartość domyślna: False
--token

Jeśli wolisz przesłać żądanie bez uwierzytelniania w interfejsie wiersza polecenia platformy Azure, możesz określić prawidłowy token użytkownika w celu uwierzytelnienia żądania. Musisz określić typ klucza w ramach żądania. Dowiedz się więcej na https://aka.ms/iotcentraldocsapi.

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 central device-template show

Pobierz szablon urządzenia z usługi IoT Central.

az iot central device-template show --app-id
                                    --device-template-id
                                    [--api-version {2022-06-30-preview, 2022-07-31}]
                                    [--central-api-uri]
                                    [--token]

Przykłady

Pobieranie szablonu urządzenia

az iot central device-template show --app-id {appid} --device-template-id {devicetemplateid}

Parametry wymagane

--app-id -n

Identyfikator aplikacji usługi IoT Central, którą chcesz zarządzać. Identyfikator aplikacji można znaleźć na stronie "Informacje" dla aplikacji w menu pomocy.

--device-template-id --dtid

Identyfikator szablonu urządzenia docelowego. Przykład: somedevicetemplate.

Parametry opcjonalne

--api-version --av
Przestarzałe

Argument "api_version" został wycofany i zostanie usunięty w przyszłej wersji.

Ten parametr polecenia został przestarzały i zostanie zignorowany. W przyszłej wersji będziemy obsługiwać tylko interfejsy API usługi IoT Central z najnowszej wersji ogólnie dostępnej. Jeśli jakikolwiek interfejs API nie jest jeszcze ogólnie dostępny, wywołamy najnowszą wersję zapoznawcza.

akceptowane wartości: 2022-06-30-preview, 2022-07-31
wartość domyślna: 2022-07-31
--central-api-uri --central-dns-suffix

Sufiks DNS usługi IoT Central skojarzony z aplikacją.

wartość domyślna: azureiotcentral.com
--token

Jeśli wolisz przesłać żądanie bez uwierzytelniania w interfejsie wiersza polecenia platformy Azure, możesz określić prawidłowy token użytkownika w celu uwierzytelnienia żądania. Musisz określić typ klucza w ramach żądania. Dowiedz się więcej na https://aka.ms/iotcentraldocsapi.

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 central device-template update

Aktualizowanie szablonu urządzenia w usłudze IoT Central.

az iot central device-template update --app-id
                                      --content
                                      --device-template-id
                                      [--api-version {2022-06-30-preview, 2022-07-31}]
                                      [--central-api-uri]
                                      [--token]

Przykłady

Aktualizowanie szablonu urządzenia za pomocą ładunku odczytanego z pliku

az iot central device-template update --app-id {appid} --content {pathtofile} --device-template-id {devicetemplateid}

Aktualizowanie szablonu urządzenia przy użyciu ładunku odczytanego z nieprzetworzonego pliku json

az iot central device-template update --app-id {appid} --content {json} --device-template-id {devicetemplateid}

Parametry wymagane

--app-id -n

Identyfikator aplikacji usługi IoT Central, którą chcesz zarządzać. Identyfikator aplikacji można znaleźć na stronie "Informacje" dla aplikacji w menu pomocy.

--content -k

Definicja szablonu urządzenia. Podaj ścieżkę do pliku JSON lub nieprzetworzonego ciągu JSON. [Przykład ścieżki pliku: ./path/to/file.json] [Przykład ciąguified JSON: {}]. Treść żądania musi zawierać element CapabilityModel.

--device-template-id --dtid

Identyfikator szablonu urządzenia docelowego. Przykład: somedevicetemplate.

Parametry opcjonalne

--api-version --av
Przestarzałe

Argument "api_version" został wycofany i zostanie usunięty w przyszłej wersji.

Ten parametr polecenia został przestarzały i zostanie zignorowany. W przyszłej wersji będziemy obsługiwać tylko interfejsy API usługi IoT Central z najnowszej wersji ogólnie dostępnej. Jeśli jakikolwiek interfejs API nie jest jeszcze ogólnie dostępny, wywołamy najnowszą wersję zapoznawcza.

akceptowane wartości: 2022-06-30-preview, 2022-07-31
wartość domyślna: 2022-07-31
--central-api-uri --central-dns-suffix

Sufiks DNS usługi IoT Central skojarzony z aplikacją.

wartość domyślna: azureiotcentral.com
--token

Jeśli wolisz przesłać żądanie bez uwierzytelniania w interfejsie wiersza polecenia platformy Azure, możesz określić prawidłowy token użytkownika w celu uwierzytelnienia żądania. Musisz określić typ klucza w ramach żądania. Dowiedz się więcej na https://aka.ms/iotcentraldocsapi.

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.