az dt model

Note

This reference is part of the azure-iot extension for the Azure CLI (version 2.59.0 or higher). Расширение автоматически установит первый раз, когда вы запускаете команду az dt model. Learn more about extensions.

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

Команды

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

az dt model create

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

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

az dt model create --dt-name --dtn
                   [--failure-policy --fp {None, Rollback}]
                   [--fd --from-directory]
                   [--max-models-per-batch --mmpb]
                   [--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 или имя узла. Если указано имя экземпляра, подписка пользователя сначала запрашивается для целевого экземпляра, чтобы получить имя узла. Если указано имя узла, запрос подписки пропускается, а предоставленное значение используется для последующего взаимодействия.

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--failure-policy --fp

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

Свойство	Значение
Parameter group:	Models Input Arguments
Default value:	Rollback
Допустимые значения:	None, Rollback

--fd --from-directory

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

Свойство	Значение
Parameter group:	Models Input Arguments

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

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

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

Свойство	Значение
Parameter group:	Models Input Arguments
Default value:	30

--models

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

Свойство	Значение
Parameter group:	Models Input Arguments

--resource-group -g

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

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

--debug

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

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

--help -h

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

--only-show-errors

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

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

--output -o

Output format.

Свойство	Значение
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 model delete

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

az dt model delete --dt-name --dtn
                   --dtmi --model-id
                   [--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.

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--resource-group -g

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

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

--debug

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

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

--help -h

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

--only-show-errors

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

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

--output -o

Output format.

Свойство	Значение
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 model delete-all

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

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

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

Примеры

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

az dt model delete-all -n {instance_or_hostname}

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

--dt-name --dtn -n

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

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Output format.

Свойство	Значение
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 model list

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

az dt model list --dt-name --dtn
                 [--def --definition {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 или имя узла. Если указано имя экземпляра, подписка пользователя сначала запрашивается для целевого экземпляра, чтобы получить имя узла. Если указано имя узла, запрос подписки пропускается, а предоставленное значение используется для последующего взаимодействия.

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--def --definition

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

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

--dependencies-for

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

--resource-group -g

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

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

--debug

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

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

--help -h

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

--only-show-errors

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

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

--output -o

Output format.

Свойство	Значение
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 model show

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

az dt model show --dt-name --dtn
                 --dtmi --model-id
                 [--def --definition {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.

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--def --definition

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

Свойство	Значение
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

Output format.

Свойство	Значение
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 model update

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

az dt model update --dt-name --dtn
                   --dtmi --model-id
                   [--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.

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--decommission

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

Свойство	Значение
Допустимые значения:	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

Output format.

Свойство	Значение
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