Поделиться через

az iot central device-template

  • Ссылка

Примечание.

Эта ссылка является частью расширения Azure-iot для Azure CLI (версия 2.46.0 или более поздней). Расширение будет автоматически устанавливаться при первом запуске команды az iot central device-template . Подробнее о расширениях.

Управление и настройка шаблонов устройств IoT Central.

Команды

Имя Описание Тип Состояние
az iot central device-template create

Создайте шаблон устройства в IoT Central.

 Расширение Общедоступная версия
az iot central device-template delete

Удалите шаблон устройства из IoT Central.

 Расширение Общедоступная версия
az iot central device-template list

Получите список шаблонов устройств для приложения IoT Central.

 Расширение Общедоступная версия
az iot central device-template show

Получите шаблон устройства из IoT Central.

 Расширение Общедоступная версия
az iot central device-template update

Обновление шаблона устройства в IoT Central.

 Расширение Общедоступная версия

az iot central device-template create

Создайте шаблон устройства в 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]

Примеры

Создание шаблона устройства с полезными данными из файла

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

Создание шаблона устройства с полезными данными из необработанного json

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

Обязательные параметры

--app-id -n

Идентификатор приложения IoT Central, которым требуется управлять. Идентификатор приложения можно найти на странице "О" для приложения в меню справки.

--content -k

Определение шаблона устройства. Укажите путь к JSON-файлу или необработанным строкам JSON. [Пример пути к файлу: ./path/to/file.json] [Пример строкифицированного JSON: {}]. Текст запроса должен содержать CapabilityModel.

--device-template-id --dtid

Идентификатор модели цифрового двойника шаблона устройства. Узнайте больше по адресу https://aka.ms/iotcentraldtmi.

Необязательные параметры

--api-version --av
Не рекомендуется

Аргумент "api_version" устарел и будет удален в будущем выпуске.

Этот параметр команды не рекомендуется использовать и будет игнорироваться. В будущем выпуске мы будем поддерживать только API IoT Central из последней версии общедоступной версии. Если любой API еще не является общедоступной, мы вызовем последнюю предварительную версию.

Допустимые значения: 2022-06-30-preview, 2022-07-31
Default value: 2022-07-31
--central-api-uri --central-dns-suffix

Суффикс DNS IoT Central, связанный с приложением.

Default value: azureiotcentral.com
--token

Если вы хотите отправить запрос без проверки подлинности в Azure CLI, можно указать действительный маркер пользователя для проверки подлинности запроса. Необходимо указать тип ключа в рамках запроса. Узнайте больше по адресу https://aka.ms/iotcentraldocsapi.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az iot central device-template delete

Удалите шаблон устройства из IoT Central.

Примечание. Ожидается, что это завершится ошибкой, если какие-либо устройства по-прежнему связаны с этим шаблоном.

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

Примеры

Удаление шаблона устройства из IoT Central

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

Обязательные параметры

--app-id -n

Идентификатор приложения IoT Central, которым требуется управлять. Идентификатор приложения можно найти на странице "О" для приложения в меню справки.

--device-template-id --dtid

Идентификатор шаблона целевого устройства. Пример: somedevicetemplate.

Необязательные параметры

--api-version --av
Не рекомендуется

Аргумент "api_version" устарел и будет удален в будущем выпуске.

Этот параметр команды не рекомендуется использовать и будет игнорироваться. В будущем выпуске мы будем поддерживать только API IoT Central из последней версии общедоступной версии. Если любой API еще не является общедоступной, мы вызовем последнюю предварительную версию.

Допустимые значения: 2022-06-30-preview, 2022-07-31
Default value: 2022-07-31
--central-api-uri --central-dns-suffix

Суффикс DNS IoT Central, связанный с приложением.

Default value: azureiotcentral.com
--token

Если вы хотите отправить запрос без проверки подлинности в Azure CLI, можно указать действительный маркер пользователя для проверки подлинности запроса. Необходимо указать тип ключа в рамках запроса. Узнайте больше по адресу https://aka.ms/iotcentraldocsapi.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az iot central device-template list

Получите список шаблонов устройств для приложения IoT Central.

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

Примеры

Вывод списка всех шаблонов устройств в приложении, отсортированных по идентификатору шаблона (по умолчанию)

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

Обязательные параметры

--app-id -n

Идентификатор приложения IoT Central, которым требуется управлять. Идентификатор приложения можно найти на странице "О" для приложения в меню справки.

Необязательные параметры

--api-version --av
Не рекомендуется

Аргумент "api_version" устарел и будет удален в будущем выпуске.

Этот параметр команды не рекомендуется использовать и будет игнорироваться. В будущем выпуске мы будем поддерживать только API IoT Central из последней версии общедоступной версии. Если любой API еще не является общедоступной, мы вызовем последнюю предварительную версию.

Допустимые значения: 2022-06-30-preview, 2022-07-31
Default value: 2022-07-31
--central-api-uri --central-dns-suffix

Суффикс DNS IoT Central, связанный с приложением.

Default value: azureiotcentral.com
--compact -c

Отображение шаблонов в компактном режиме. Для каждого шаблона отображаются только идентификаторы, имена и типы моделей.

Default value: False
--token

Если вы хотите отправить запрос без проверки подлинности в Azure CLI, можно указать действительный маркер пользователя для проверки подлинности запроса. Необходимо указать тип ключа в рамках запроса. Узнайте больше по адресу https://aka.ms/iotcentraldocsapi.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az iot central device-template show

Получите шаблон устройства из 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]

Примеры

Получение шаблона устройства

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

Обязательные параметры

--app-id -n

Идентификатор приложения IoT Central, которым требуется управлять. Идентификатор приложения можно найти на странице "О" для приложения в меню справки.

--device-template-id --dtid

Идентификатор шаблона целевого устройства. Пример: somedevicetemplate.

Необязательные параметры

--api-version --av
Не рекомендуется

Аргумент "api_version" устарел и будет удален в будущем выпуске.

Этот параметр команды не рекомендуется использовать и будет игнорироваться. В будущем выпуске мы будем поддерживать только API IoT Central из последней версии общедоступной версии. Если любой API еще не является общедоступной, мы вызовем последнюю предварительную версию.

Допустимые значения: 2022-06-30-preview, 2022-07-31
Default value: 2022-07-31
--central-api-uri --central-dns-suffix

Суффикс DNS IoT Central, связанный с приложением.

Default value: azureiotcentral.com
--token

Если вы хотите отправить запрос без проверки подлинности в Azure CLI, можно указать действительный маркер пользователя для проверки подлинности запроса. Необходимо указать тип ключа в рамках запроса. Узнайте больше по адресу https://aka.ms/iotcentraldocsapi.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az iot central device-template update

Обновление шаблона устройства в 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]

Примеры

Обновление шаблона устройства с полезными данными из файла

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

Обновление шаблона устройства с полезными данными из необработанного json

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

Обязательные параметры

--app-id -n

Идентификатор приложения IoT Central, которым требуется управлять. Идентификатор приложения можно найти на странице "О" для приложения в меню справки.

--content -k

Определение шаблона устройства. Укажите путь к JSON-файлу или необработанным строкам JSON. [Пример пути к файлу: ./path/to/file.json] [Пример строкифицированного JSON: {}]. Текст запроса должен содержать CapabilityModel.

--device-template-id --dtid

Идентификатор шаблона целевого устройства. Пример: somedevicetemplate.

Необязательные параметры

--api-version --av
Не рекомендуется

Аргумент "api_version" устарел и будет удален в будущем выпуске.

Этот параметр команды не рекомендуется использовать и будет игнорироваться. В будущем выпуске мы будем поддерживать только API IoT Central из последней версии общедоступной версии. Если любой API еще не является общедоступной, мы вызовем последнюю предварительную версию.

Допустимые значения: 2022-06-30-preview, 2022-07-31
Default value: 2022-07-31
--central-api-uri --central-dns-suffix

Суффикс DNS IoT Central, связанный с приложением.

Default value: azureiotcentral.com
--token

Если вы хотите отправить запрос без проверки подлинности в Azure CLI, можно указать действительный маркер пользователя для проверки подлинности запроса. Необходимо указать тип ключа в рамках запроса. Узнайте больше по адресу https://aka.ms/iotcentraldocsapi.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.