az iot ops schema

Note

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

Реестр схем и управление схемами.

Схемы — это документы, описывающие данные для включения обработки и контекстуализации. Схемы сообщений описывают формат сообщения и его содержимое. Реестр схем требуется для создания схем и управления ими.

Команды

Имя	Описание	Тип	Состояние
az iot ops schema create	Создайте схему в реестре схем.	Extension	GA
az iot ops schema delete	Удаление целевой схемы в реестре схем.	Extension	GA
az iot ops schema list	Вывод списка схем в реестре схем.	Extension	GA
az iot ops schema registry	Управление реестром схем.	Extension	GA
az iot ops schema registry create	Создайте реестр схем.	Extension	GA
az iot ops schema registry delete	Удаление реестра целевой схемы.	Extension	GA
az iot ops schema registry list	Вывод списка реестров схем в группе ресурсов или подписке.	Extension	GA
az iot ops schema registry show	Отображение сведений о реестре схем.	Extension	GA
az iot ops schema show	Отображение сведений о схеме в реестре схем.	Extension	GA
az iot ops schema show-dataflow-refs	Отображение ссылок на схему, используемых для потоков данных.	Extension	Experimental
az iot ops schema version	Управление версиями схемы.	Extension	GA
az iot ops schema version add	Добавьте версию схемы в схему.	Extension	GA
az iot ops schema version list	Вывод списка версий схемы для конкретной схемы.	Extension	GA
az iot ops schema version remove	Удалите целевую версию схемы.	Extension	GA
az iot ops schema version show	Отображение сведений о версии схемы.	Extension	GA

az iot ops schema create

Создайте схему в реестре схем.

Для этой операции требуется предварительно созданный реестр схем и будет добавлена версия схемы. Чтобы создать схему и добавить версию, связанная учетная запись хранения должна иметь доступ к общедоступной сети. Дополнительные сведения о разностном формате файла см. в aka.ms/lakehouse-delta-sample.

az iot ops schema create --format {delta, json}
                         --name
                         --registry
                         --resource-group
                         --type {message}
                         --vc --version-content
                         [--acquire-policy-token]
                         [--change-reference]
                         [--desc]
                         [--display-name]
                         [--vd --version-desc]
                         [--ver --version]

Примеры

Создайте схему с именем myschema в реестре myregistry с минимальными входными данными. Схема версии 1 будет создана для этой схемы с содержимым файла.

az iot ops schema create -n myschema -g myresourcegroup --registry myregistry --format json --type message --version-content myschema.json

Создайте схему с именем myschema с дополнительной настройкой. Схема версии 14 будет создана для этой схемы. Встроенное содержимое — это пример синтаксиса bash. Дополнительные примеры см. в https://aka.ms/inline-json-examples

az iot ops schema create -n myschema -g myresourcegroup --registry myregistry --format delta --type message --desc "Schema for Assets" --display-name myassetschema --version-content '{"hello": "world"}' --ver 14 --vd "14th version"

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

--format

Формат схемы.

Свойство	Значение
Допустимые значения:	delta, json

--name -n

Имя схемы.

--registry

Имя реестра схем.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

--type

Тип схемы.

Свойство	Значение
Допустимые значения:	message

--vc --version-content

Путь к файлу, содержащий или встроенное содержимое для версии.

Свойство	Значение
Группа параметров:	Version Arguments

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

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

--acquire-policy-token

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

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

--change-reference

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

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

--desc

Описание схемы.

--display-name

Отображаемое имя схемы.

--vd --version-desc

Описание версии.

Свойство	Значение
Группа параметров:	Version Arguments

--ver --version

Имя версии схемы.

Свойство	Значение
Группа параметров:	Version Arguments
Default value:	1

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

--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 ops schema delete

Удаление целевой схемы в реестре схем.

az iot ops schema delete --name
                         --registry
                         --resource-group
                         [--acquire-policy-token]
                         [--change-reference]
                         [--yes {false, true}]

Примеры

Удалите целевую схему myschema в реестре схем myregistry.

az iot ops schema delete --name myschema --registry myregistry -g myresourcegroup

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

--name -n

Имя схемы.

--registry

Имя реестра схем.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

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

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

--acquire-policy-token

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

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

--change-reference

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

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

--yes -y

Подтвердите [y]es без запроса. Полезно для сценариев CI и автоматизации.

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

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

--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 ops schema list

Вывод списка схем в реестре схем.

az iot ops schema list --registry
                       --resource-group

Примеры

Вывод списка регистров схемы в реестре схем myregistry.

az iot ops schema list -g myresourcegroup --registry myregistry

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

--registry

Имя реестра схем.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью 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 iot ops schema show

Отображение сведений о схеме в реестре схем.

az iot ops schema show --name
                       --registry
                       --resource-group

Примеры

Отображение сведений о целевой схеме myschema в реестре схем myregistry.

az iot ops schema show --name myschema --registry myregistry -g myresourcegroup

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

--name -n

Имя схемы.

--registry

Имя реестра схем.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью 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 iot ops schema show-dataflow-refs

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

Эта команда является экспериментальной и в стадии разработки. Уровни справки и поддержки: https://aka.ms/CLI_refstatus

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

az iot ops schema show-dataflow-refs --registry
                                     --resource-group
                                     [--acquire-policy-token]
                                     [--change-reference]
                                     [--latest {false, true}]
                                     [--schema]
                                     [--ver --version]

Примеры

Отображение ссылки на схему "myschema" и версии 1.

az iot ops schema show-dataflow-refs --version 1 --schema myschema --registry myregistry -g myresourcegroup

Отображение ссылки на схему для всех версий в схеме myschema.

az iot ops schema show-dataflow-refs --schema myschema --registry myregistry -g myresourcegroup

Отображение ссылки на схему для всех версий и схем в реестре схем myregistry.

az iot ops schema show-dataflow-refs --registry myregistry -g myresourcegroup

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

az iot ops schema show-dataflow-refs --registry myregistry -g myresourcegroup --latest

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

--registry

Имя реестра схем.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

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

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

--acquire-policy-token

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

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

--change-reference

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

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

--latest

Пометка для отображения только последних версий.

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

--schema

Имя схемы. Требуется, если используется --version.

--ver --version

Имя версии схемы. Если используется, --latest будет игнорироваться.

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

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