az dt twin

Note

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

Управление и настройка цифровых двойников экземпляра Digital Twins.

Команды

Имя	Описание	Тип	Состояние
az dt twin component	Отображение и обновление компонентов цифрового двойника экземпляра Digital Twins.	Extension	GA
az dt twin component show	Отображение сведений о компоненте цифрового двойника.	Extension	GA
az dt twin component update	Обновите компонент цифрового двойника с помощью спецификации исправлений JSON.	Extension	GA
az dt twin create	Создайте цифровой двойник на экземпляре.	Extension	GA
az dt twin delete	Удаление цифрового двойника. Все связи, ссылающиеся на этот двойник, уже должны быть удалены.	Extension	GA
az dt twin delete-all	Удаляет все цифровые двойники в экземпляре Digital Twins, включая все связи для этих двойников.	Extension	GA
az dt twin query	Запрос цифровых двойников экземпляра. Разрешает обход связей и фильтрацию по значениям свойств.	Extension	GA
az dt twin relationship	Управление и настройка связей цифровых двойников экземпляра Digital Twins.	Extension	GA
az dt twin relationship create	Создайте связь между исходными и целевыми цифровыми двойниками.	Extension	GA
az dt twin relationship delete	Удаление связи цифрового двойника в экземпляре Digital Twins.	Extension	GA
az dt twin relationship delete-all	Удаляет все связи цифровых двойников в экземпляре Digital Twins, включая входящие связи.	Extension	GA
az dt twin relationship list	Перечисление связей цифрового двойника.	Extension	GA
az dt twin relationship show	Отображение сведений о связи цифрового двойника.	Extension	GA
az dt twin relationship update	Обновляет свойства связи между двумя цифровыми двойниками с помощью спецификации исправления JSON.	Extension	GA
az dt twin show	Отображение сведений о цифровом двойнику.	Extension	GA
az dt twin telemetry	Проверьте и проверьте маршруты событий и конечные точки экземпляра Digital Twins.	Extension	GA
az dt twin telemetry send	Отправляет данные телеметрии от имени цифрового двойника. Если путь к компоненту указан от имени компонента, от имени компонента предоставляется генерируемая телеметрия.	Extension	GA
az dt twin update	Обновление цифрового двойника экземпляра с помощью спецификации исправлений JSON.	Extension	GA

az dt twin create

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

--properties может быть встроенным в формате JSON или пути к файлу. Примечание. Свойства --необходимы для двойников, содержащих компоненты.

az dt twin create --dt-name --dtn
                  --dtmi --model-id
                  --twin-id
                  [--if-none-match]
                  [--properties]
                  [--resource-group]

Примеры

Создание цифрового двойника на основе существующей (ранее созданной) модели.

az dt twin create -n {instance_or_hostname} --dtmi "dtmi:com:example:Room;1" --twin-id {twin_id}

Создайте цифровой двойник из существующей (предварительно созданной) модели с тегом if-none-match.

az dt twin create -n {instance_or_hostname} --dtmi "dtmi:com:example:Room;1" --twin-id {twin_id} --if-none-match

Создание цифрового двойника на основе существующей (ранее созданной) модели. Создание экземпляра со значениями свойств.

az dt twin create -n {instance_or_hostname} --dtmi "dtmi:com:example:DeviceInformation;1" --twin-id {twin_id} --properties '{"manufacturer": "Microsoft"}'

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

az dt twin create -n {instance_or_hostname} --dtmi "dtmi:com:example:TemperatureController;1" --twin-id {twin_id} --properties '{
    "Thermostat": {
        "$metadata": {},
    }
}'

Создайте цифровой двойник с компонентом из существующих (предварительно созданных) моделей. Создание экземпляра со значениями свойств.

az dt twin create -n {instance_or_hostname} --dtmi "dtmi:com:example:TemperatureController;1" --twin-id {twin_id} --properties '{
    "Temperature": 10.2,
    "Thermostat": {
        "$metadata": {},
        "setPointTemp": 23.12
    }
}'

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

--dt-name --dtn -n

Имя экземпляра Digital Twins или имя узла. Если указано имя экземпляра, подписка пользователя сначала запрашивается для целевого экземпляра, чтобы получить имя узла. Если указано имя узла, запрос подписки пропускается, а предоставленное значение используется для последующего взаимодействия.

--dtmi --model-id -m

Идентификатор модели Digital Twins. Пример: dtmi:com:example:Room;2.

--twin-id -t

Идентификатор цифрового двойника.

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

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

--if-none-match

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

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

--properties -p

Начальные значения свойств для создания экземпляра цифрового двойника или связанных компонентов. Укажите путь к файлу или встроенный JSON. Свойства необходимы для двойников, содержащих компоненты, по крайней мере необходимо предоставить пустой объект $metadata для каждого компонента.

--resource-group -g

Группа ресурсов экземпляра Digital Twins. Группу по умолчанию можно настроить с помощью az configure --defaults group={name}.

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

--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 dt twin delete

Удаление цифрового двойника. Все связи, ссылающиеся на этот двойник, уже должны быть удалены.

az dt twin delete --dt-name --dtn
                  --twin-id
                  [--etag]
                  [--resource-group]

Примеры

Удаление цифрового двойника по идентификатору.

az dt twin delete -n {instance_or_hostname} --twin-id {twin_id}

Удалите цифровой двойник по идентификатору с помощью etag.

az dt twin delete -n {instance_or_hostname} --twin-id {twin_id} --etag {etag}

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

--dt-name --dtn -n

Имя экземпляра Digital Twins или имя узла. Если указано имя экземпляра, подписка пользователя сначала запрашивается для целевого экземпляра, чтобы получить имя узла. Если указано имя узла, запрос подписки пропускается, а предоставленное значение используется для последующего взаимодействия.

--twin-id -t

Идентификатор цифрового двойника.

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

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

--etag -e

Значение тега сущности. Команда будет выполнена успешно, если etag соответствует текущему etag для ресурса.

--resource-group -g

Группа ресурсов экземпляра Digital Twins. Группу по умолчанию можно настроить с помощью az configure --defaults group={name}.

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

--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 dt twin delete-all

Удаляет все цифровые двойники в экземпляре Digital Twins, включая все связи для этих двойников.

az dt twin delete-all --dt-name --dtn
                      [--resource-group]
                      [--yes]

Примеры

Удалите все цифровые двойники. Все связи, ссылающиеся на двойники, также будут удалены.

az dt twin delete-all -n {instance_or_hostname}

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

--dt-name --dtn -n

Имя экземпляра Digital Twins или имя узла. Если указано имя экземпляра, подписка пользователя сначала запрашивается для целевого экземпляра, чтобы получить имя узла. Если указано имя узла, запрос подписки пропускается, а предоставленное значение используется для последующего взаимодействия.

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

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

--resource-group -g

Группа ресурсов экземпляра Digital Twins. Группу по умолчанию можно настроить с помощью az configure --defaults group={name}.

--yes -y

Не запрашивать подтверждение.

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

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

--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 dt twin query

Запрос цифровых двойников экземпляра. Разрешает обход связей и фильтрацию по значениям свойств.

Во многих запросах двойников символ $ используется для ссылки на свойство $dtId двойника. В оболочках bash или powershell символ $ имеет функциональное значение и должен быть экранирован в рамках входных данных запроса. Дополнительные сведения см. в документе https://learn.microsoft.com/en-us/azure/digital-twins/concepts-cli о основных понятиях интерфейса командной строки Digital Twins.

az dt twin query --dt-name --dtn
                 --query-command
                 [--cost --show-cost {false, true}]
                 [--resource-group]

Примеры

Запрос всех цифровых двойников в целевом экземпляре и отображение всех атрибутов. Также показывать стоимость в единицах запросов.

az dt twin query -n {instance_or_hostname} -q "select * from digitaltwins" --show-cost

Запрос по модели и отображение всех атрибутов.

az dt twin query -n {instance_or_hostname} -q "select * from digitaltwins T where IS_OF_MODEL(T, 'dtmi:com:example:Room;2')"

Запрос, который использует "$dtId" с совместимым синтаксисом Bash

az dt twin query -n {instance_or_hostname} --query-command "SELECT * FROM DigitalTwins T Where T.\$dtId = 'room0'"

Запрос с помощью синтаксиса, совместимого с PowerShell, с помощью $dtId

az dt twin query -n {instance_or_hostname} --query-command "SELECT * FROM DigitalTwins T Where T.`$dtId = 'room0'"

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

--dt-name --dtn -n

Имя экземпляра Digital Twins или имя узла. Если указано имя экземпляра, подписка пользователя сначала запрашивается для целевого экземпляра, чтобы получить имя узла. Если указано имя узла, запрос подписки пропускается, а предоставленное значение используется для последующего взаимодействия.

--query-command -q

Выполнение пользовательского запроса.

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

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

--cost --show-cost

Вычисляет и отображает плату за запрос.

Свойство	Значение
Default value:	False
Допустимые значения:	false, true

--resource-group -g

Группа ресурсов экземпляра Digital Twins. Группу по умолчанию можно настроить с помощью az configure --defaults group={name}.

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

--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 dt twin show

Отображение сведений о цифровом двойнику.

az dt twin show --dt-name --dtn
                --twin-id
                [--resource-group]

Примеры

Отображение сведений о цифровом двойнику.

az dt twin show -n {instance_or_hostname} --twin-id {twin_id}

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

--dt-name --dtn -n

Имя экземпляра Digital Twins или имя узла. Если указано имя экземпляра, подписка пользователя сначала запрашивается для целевого экземпляра, чтобы получить имя узла. Если указано имя узла, запрос подписки пропускается, а предоставленное значение используется для последующего взаимодействия.

--twin-id -t

Идентификатор цифрового двойника.

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

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

--resource-group -g

Группа ресурсов экземпляра Digital Twins. Группу по умолчанию можно настроить с помощью az configure --defaults group={name}.

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

--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 dt twin update

Обновление цифрового двойника экземпляра с помощью спецификации исправлений JSON.

Обновления значений свойств и $model элементов могут происходить в том же запросе. Операции ограничены добавлением, заменой и удалением.

az dt twin update --dt-name --dtn
                  --json-patch --patch
                  --twin-id
                  [--etag]
                  [--resource-group]

Примеры

Обновите цифровой двойник с помощью спецификации исправлений JSON.

az dt twin update -n {instance_or_hostname} --twin-id {twin_id} --json-patch '{"op":"replace", "path":"/Temperature", "value": 20.5}'

Обновление цифрового двойника с помощью спецификации исправлений JSON и использования etag.

az dt twin update -n {instance_or_hostname} --twin-id {twin_id} --etag {etag} --json-patch '{"op":"replace", "path":"/Temperature", "value": 20.5}'

Обновите цифровой двойник с помощью спецификации исправлений JSON.

az dt twin update -n {instance_or_hostname} --twin-id {twin_id} --json-patch '[
  {"op":"replace", "path":"/Temperature", "value": 20.5},
  {"op":"add", "path":"/Areas", "value": ["ControlSystem"]}
]'

Обновите цифровой двойник с помощью спецификации исправления JSON, определенной в файле.

az dt twin update -n {instance_or_hostname} --twin-id {twin_id} --json-patch ./my/patch/document.json

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

--dt-name --dtn -n

Имя экземпляра Digital Twins или имя узла. Если указано имя экземпляра, подписка пользователя сначала запрашивается для целевого экземпляра, чтобы получить имя узла. Если указано имя узла, запрос подписки пропускается, а предоставленное значение используется для последующего взаимодействия.

--json-patch --patch

Спецификация обновления, описанная в формате JSON-patch. Обновления значений свойств и $model элементов могут происходить в том же запросе. Операции ограничены добавлением, заменой и удалением. Укажите путь к файлу или встроенный JSON.

--twin-id -t

Идентификатор цифрового двойника.

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

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

--etag -e

Значение тега сущности. Команда будет выполнена успешно, если etag соответствует текущему etag для ресурса.

--resource-group -g

Группа ресурсов экземпляра Digital Twins. Группу по умолчанию можно настроить с помощью az configure --defaults group={name}.

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

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