az dt model

Примечание.

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

Управление моделями и определениями DTDL в экземпляре Digital Twins.

Команды

Имя	Описание	Тип	Состояние
az dt model create	Отправляет одну или несколько моделей.	Расширение	Общедоступная версия
az dt model delete	Удалить модель. Модель можно удалить только в том случае, если другие модели не ссылаются на нее.	Расширение	Общедоступная версия
az dt model delete-all	Удалите все модели в экземпляре Digital Twins.	Расширение	Общедоступная версия
az dt model list	Перечисление метаданных модели, определений и зависимостей.	Расширение	Общедоступная версия
az dt model show	Получение целевой модели или определения модели.	Расширение	Общедоступная версия
az dt model update	Обновляет метаданные для модели. В настоящее время модель может быть выведена только из эксплуатации.	Расширение	Общедоступная версия

az dt model create

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

--models может быть встроенным json или путь к файлу. Размер набора входных моделей (ontology) ограничен максимальным числом моделей, которые экземпляр DT может хранить (по умолчанию — 10000 моделей).

az dt model create --dt-name
                   [--failure-policy {None, Rollback}]
                   [--fd]
                   [--max-models-per-batch]
                   [--models]
                   [--resource-group]

Примеры

Массовая отправка всех файлов модели .json или DTDL из целевого каталога. Обработка модели рекурсивна.

az dt model create -n {instance_or_hostname} --from-directory {directory_path}

Отправка встроенной модели json или из пути к файлу.

az dt model create -n {instance_or_hostname} --models {file_path_or_inline_json}

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

--dt-name --dtn -n

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

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

--failure-policy --fp

Указывает политику сбоя при возникновении ошибки при обработке пакета моделей. В режиме отката все модели, созданные в предыдущих пакетах, удаляются одновременно. При выборе в качестве "Нет" модели, созданные в предыдущих пакетах, не удаляются из экземпляра DT.

допустимые значения: None, Rollback

значение по умолчанию: Rollback

--fd --from-directory

Файлы модели JSON каталога будут проанализированы. Обратите внимание: модели создаются атомарно, если каталог содержит 250 или менее моделей, поэтому в случае ошибки ни одна из созданных моделей не создается. Набор входных моделей является блоком и создается в пакетах, если каталог имеет более 250 моделей (ограничение API). В случае ошибки при обработке пакета поведение определяется параметром --failure-policy.

--max-models-per-batch --mmpb

Экспериментальный

Максимальный размер модели на пакет при создании более 250 моделей. Уменьшите это число, чтобы предотвратить ошибку DTDLParser.

значение по умолчанию: 30

--models

Встроенная модель JSON или путь к файлу для модели JSON. Обратите внимание: модели создаются атомарным образом, если модель JSON содержит 250 или менее моделей, поэтому в случае ошибки ни одна из созданных моделей не создается. Набор входных моделей является блоком и создается в пакетах, когда модель JSON имеет более 250 моделей (ограничение API). В случае ошибки при обработке пакета поведение определяется параметром --failure-policy.

--resource-group -g

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

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

--debug

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

--help -h

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

--only-show-errors

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

--output -o

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

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc

значение по умолчанию: json

--query

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

--subscription

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

--verbose

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

az dt model delete

Удалить модель. Модель можно удалить только в том случае, если другие модели не ссылаются на нее.

az dt model delete --dt-name
                   --dtmi
                   [--resource-group]

Примеры

Удаление целевой модели.

az dt model delete -n {instance_or_hostname} --dtmi "dtmi:com:example:Floor;1"

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

--dt-name --dtn -n

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

--dtmi --model-id -m

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

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

--resource-group -g

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

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

--debug

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

--help -h

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

--only-show-errors

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

--output -o

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

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc

значение по умолчанию: json

--query

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

--subscription

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

--verbose

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

az dt model delete-all

Удалите все модели в экземпляре Digital Twins.

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

az dt model delete-all --dt-name
                       [--resource-group]
                       [--yes]

Примеры

Удалите все модели.

az dt model delete-all -n {instance_or_hostname}

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

--dt-name --dtn -n

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

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

--resource-group -g

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

--yes -y

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

значение по умолчанию: False

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

--debug

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

--help -h

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

--only-show-errors

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

--output -o

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

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc

значение по умолчанию: json

--query

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

--subscription

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

--verbose

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

az dt model list

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

az dt model list --dt-name
                 [--def {false, true}]
                 [--dependencies-for]
                 [--resource-group]

Примеры

Перечисление метаданных модели

az dt model list -n {instance_or_hostname}

Перечисление определений модели

az dt model list -n {instance_or_hostname} --definition

Перечисление зависимостей определенных уже существующих моделей. Пробелы разделяют значения dtmi.

az dt model list -n {instance_or_hostname} --dependencies-for {model_id0} {model_id1}

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

--dt-name --dtn -n

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

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

--def --definition

Операция извлекает определение модели.

допустимые значения: false, true

значение по умолчанию: False

--dependencies-for

Набор моделей, которые будут получать их зависимости. Если опущено, извлекаются все модели. Формат — это разделенный пробелами список.

--resource-group -g

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

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

--debug

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

--help -h

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

--only-show-errors

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

--output -o

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

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc

значение по умолчанию: json

--query

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

--subscription

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

--verbose

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

az dt model show

Получение целевой модели или определения модели.

az dt model show --dt-name
                 --dtmi
                 [--def {false, true}]
                 [--resource-group]

Примеры

Отображение метаданных модели

az dt model show -n {instance_or_hostname} --dtmi "dtmi:com:example:Floor;1"

Отображение метаданных и определений модели

az dt model show -n {instance_or_hostname} --dtmi "dtmi:com:example:Floor;1" --definition

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

--dt-name --dtn -n

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

--dtmi --model-id -m

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

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

--def --definition

Операция извлекает определение модели.

допустимые значения: false, true

значение по умолчанию: False

--resource-group -g

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

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

--debug

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

--help -h

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

--only-show-errors

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

--output -o

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

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc

значение по умолчанию: json

--query

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

--subscription

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

--verbose

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

az dt model update

Обновляет метаданные для модели. В настоящее время модель может быть выведена только из эксплуатации.

az dt model update --dt-name
                   --dtmi
                   [--decommission {false, true}]
                   [--resource-group]

Примеры

Вывод целевой модели

az dt model update -n {instance_or_hostname} --dtmi "dtmi:com:example:Floor;1" --decommission

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

--dt-name --dtn -n

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

--dtmi --model-id -m

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

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

--decommission

Указывает намерение вывести из эксплуатации целевую модель.

допустимые значения: false, true

--resource-group -g

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

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

--debug

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

--help -h

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

--only-show-errors

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

--output -o

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

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc

значение по умолчанию: json

--query

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

--subscription

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

--verbose

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