az iot central device twin

Note

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

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

Команды

Имя Описание Тип Состояние
az iot central device twin replace

Замените значения доступных для записи свойств устройства, компонента устройства или модуля устройства или компонента модуля устройства.

 Extension GA
az iot central device twin show

Получение всех значений свойств устройства, компонента устройства, модуля устройства или компонента модуля устройства.

 Extension GA
az iot central device twin update

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

 Extension GA

az iot central device twin replace

Замените значения доступных для записи свойств устройства, компонента устройства или модуля устройства или компонента модуля устройства.

Предоставление --component-name, --module-name или обоих из них для замены свойств компонента устройства, свойств модуля устройства или свойств компонента модуля устройства.

az iot central device twin replace --app-id
                                   --content
                                   --device-id
                                   [--acquire-policy-token]
                                   [--api-version --av {2022-06-30-preview, 2022-07-31}]
                                   [--central-api-uri --central-dns-suffix]
                                   [--change-reference]
                                   [--co --component-name]
                                   [--mn --module-name]
                                   [--token]

Примеры

Замена свойств устройства

az iot central device twin replace --app-id {appid} --device-id {deviceid} -k {content}

Замена свойств компонента устройства

az iot central device twin replace --app-id {appid} --device-id {deviceid} --co {componentname} -k {content}

Замена свойств компонента модуля устройства

az iot central device twin replace --app-id {appid} --device-id {deviceid} --mn {modulename} --co {componentname} -k {content}

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

--app-id -n

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

--content -k

Конфигурация запроса. Укажите путь к JSON-файлу или необработанным строкам JSON. [Пример пути к файлу: ./path/to/file.json] [Пример json stringified: {'a': 'b'}].

--device-id -d

Идентификатор устройства целевого устройства. Идентификатор устройства можно найти, нажав кнопку "Подключить" на странице сведений об устройстве.

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

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Azure Policy для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--api-version --av
Не рекомендуется

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

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

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

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

Свойство Значение
Default value: azureiotcentral.com
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--co --component-name

Имя компонента устройства.

--mn --module-name

Имя модуля устройства.

--token

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

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

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

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

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

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

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

--subscription

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

--verbose

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

Свойство Значение
Default value: False

az iot central device twin show

Получение всех значений свойств устройства, компонента устройства, модуля устройства или компонента модуля устройства.

Предоставление --component-name, --module-name или обоих из них для получения свойств компонента устройства, свойств модуля устройства или свойств компонента модуля устройства.

az iot central device twin show --app-id
                                --device-id
                                [--api-version --av {2022-06-30-preview, 2022-07-31}]
                                [--central-api-uri --central-dns-suffix]
                                [--co --component-name]
                                [--mn --module-name]
                                [--token]

Примеры

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

az iot central device twin show --app-id {appid} --device-id {deviceid}

Получение свойств компонента устройства

az iot central device twin show --app-id {appid} --device-id {deviceid} --co {componentname}

Получение свойств компонента модуля устройства

az iot central device twin show --app-id {appid} --device-id {deviceid} --mn {modulename} --co {componentname}

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

--app-id -n

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

--device-id -d

Идентификатор устройства целевого устройства. Идентификатор устройства можно найти, нажав кнопку "Подключить" на странице сведений об устройстве.

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

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

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

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

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

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

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

Свойство Значение
Default value: azureiotcentral.com
--co --component-name

Имя компонента устройства.

--mn --module-name

Имя модуля устройства.

--token

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

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

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

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

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

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

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

--subscription

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

--verbose

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

Свойство Значение
Default value: False

az iot central device twin update

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

Предоставление --component-name, --module-name или обоих из них для обновления свойств компонента устройства, свойств модуля устройства или свойств компонента модуля устройства.

az iot central device twin update --app-id
                                  --content
                                  --device-id
                                  [--acquire-policy-token]
                                  [--api-version --av {2022-06-30-preview, 2022-07-31}]
                                  [--central-api-uri --central-dns-suffix]
                                  [--change-reference]
                                  [--co --component-name]
                                  [--mn --module-name]
                                  [--token]

Примеры

Обновление свойств устройства

az iot central device twin update --app-id {appid} --device-id {deviceid} -k {content}

Обновление свойств компонента устройства

az iot central device twin update --app-id {appid} --device-id {deviceid} --co {componentname} -k {content}

Обновление свойств компонента модуля устройства

az iot central device twin update --app-id {appid} --device-id {deviceid} --mn {modulename} --co {componentname} -k {content}

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

--app-id -n

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

--content -k

Конфигурация запроса. Укажите путь к JSON-файлу или необработанным строкам JSON. [Пример пути к файлу: ./path/to/file.json] [Пример json stringified: {'a': 'b'}].

--device-id -d

Идентификатор устройства целевого устройства. Идентификатор устройства можно найти, нажав кнопку "Подключить" на странице сведений об устройстве.

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

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Azure Policy для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--api-version --av
Не рекомендуется

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

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

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

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

Свойство Значение
Default value: azureiotcentral.com
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--co --component-name

Имя компонента устройства.

--mn --module-name

Имя модуля устройства.

--token

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

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

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

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

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

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

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

--subscription

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

--verbose

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

Свойство Значение
Default value: False