az apic metadata

Note

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

Команды для управления схемами метаданных в Центре API.

Команды

Имя	Описание	Тип	Состояние
az apic metadata create	Создайте новую схему метаданных или обновите существующую схему метаданных.	Extension	GA
az apic metadata delete	Удалите указанную схему метаданных.	Extension	GA
az apic metadata export	Экспортирует схему метаданных.	Extension	GA
az apic metadata list	Перечислить коллекцию схем метаданных.	Extension	GA
az apic metadata show	Получение сведений о схеме метаданных.	Extension	GA
az apic metadata update	Обновите существующую схему метаданных.	Extension	GA

az apic metadata create

Создайте новую схему метаданных или обновите существующую схему метаданных.

az apic metadata create --assignments
                        --metadata-name
                        --resource-group
                        --schema
                        --service-name

Примеры

Создание примера метаданных 1

az apic metadata create --resource-group api-center-test --service-name contoso --metadata-name "test1" --schema '{"type":"string", "title":"First name", "pattern": "^[a-zA-Z0-9]+$"}' --assignments '[{entity:api,required:true,deprecated:false}]'

Создание примера метаданных 2

az apic metadata create --resource-group api-center-test --service-name contoso  --metadata-name testregion --schema '{"type":"string","title":"testregion","oneOf":[{"const":"Region1","description":""},{"const":"Region2","description":""},{"const":"Region3","description":""}]}' --assignments '[{entity:api,required:true,deprecated:false},{entity:environment,required:true,deprecated:false}]'

Создание метаданных с помощью схемы и назначений json

az apic metadata create --resource-group api-center-test --service-name contoso --metadata-name "test" --schema '@schema.json' --assignments '@assignments.json'

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

--assignments

Определяет область назначения для пользовательских метаданных, например "[{entity:api,required:true,deprecated:false}]". Доступные значения сущностей: API, развертывание, среда. Поддержка сокращенного синтаксиса, json-file и yaml-file. Попробуйте "??", чтобы показать больше.

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

--metadata-name

Имя схемы метаданных.

--resource-group -g

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

--schema

Схема JSON, определяющая тип.

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

--service-name -n

Имя службы Центра API Azure.

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

--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 apic metadata delete

Удалите указанную схему метаданных.

az apic metadata delete [--ids]
                        [--metadata-name]
                        [--resource-group]
                        [--service-name]
                        [--subscription]
                        [--yes]

Примеры

Удаление схемы метаданных

az apic metadata delete --resource-group api-center-test --service-name contoso --metadata-name "test1"

Удалить схему

az apic metadata delete -g api-center-test -n contosoeuap --metadata-name "approver"

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

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

--ids

Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие параметры 'Resource Id'.

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

--metadata-name

Имя схемы метаданных.

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

--resource-group -g

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

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

--service-name -n

Имя службы Центра API Azure.

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

--subscription

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

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

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

--verbose

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

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

az apic metadata export

Экспортирует схему метаданных.

az apic metadata export --assignments {api, deployment, environment}
                        --file-name
                        [--custom-metadata-only {0, 1, f, false, n, no, t, true, y, yes}]
                        [--ids]
                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                        [--resource-group]
                        [--service-name]
                        [--subscription]

Примеры

Экспорт схемы метаданных, назначенных API

az apic metadata export -g api-center-test -n contosoeuap --assignments api --file-name filename.json

Экспорт схемы метаданных, назначенной развертыванию

az apic metadata export -g api-center-test -n contosoeuap --assignments deployment --file-name filename.json

Экспорт схемы метаданных, назначенной среде

az apic metadata export -g api-center-test -n contosoeuap --assignments environment --file-name filename.json

Экспорт пользовательской схемы метаданных только

az apic metadata export -g api-center-test -n contosoeuap --assignments api --file-name filename.json --custom-metadata-only

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

--assignments

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

Свойство	Значение
Группа параметров:	Payload Arguments
Допустимые значения:	api, deployment, environment

--file-name

Имя файла, в который нужно экспортировать схему метаданных.

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

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

--custom-metadata-only

Экспортируйте только пользовательские метаданные.

Свойство	Значение
Допустимые значения:	0, 1, f, false, n, no, t, true, y, yes

--ids

Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие параметры 'Resource Id'.

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

--no-wait

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

Свойство	Значение
Допустимые значения:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

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

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

--service-name -n

Имя службы Центра API.

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

--subscription

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

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

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

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

--verbose

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

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

az apic metadata list

Перечислить коллекцию схем метаданных.

az apic metadata list --resource-group
                      --service-name
                      [--filter]
                      [--max-items]
                      [--next-token]

Примеры

Перечисление схем

az apic metadata list -g api-center-test -n contosoeuap

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

--resource-group -g

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

--service-name -n

Имя службы Центра API Azure.

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

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

--filter

Параметр фильтра OData.

--max-items

Общее количество элементов, возвращаемых в выходных данных команды. Если общее количество доступных элементов превышает указанное значение, маркер предоставляется в выходных данных команды. Чтобы возобновить разбиение на страницы, укажите значение маркера в --next-token аргументе последующей команды.

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

--next-token

Маркер, чтобы указать, где начать разбиение на страницы. Это значение маркера из ранее усеченного ответа.

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

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

--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 apic metadata show

Получение сведений о схеме метаданных.

az apic metadata show [--ids]
                      [--metadata-name]
                      [--resource-group]
                      [--service-name]
                      [--subscription]

Примеры

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

az apic metadata show -g api-center-test -n contosoeuap --metadata-name approver

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

az apic metadata show --resource-group api-center-test --service-name contoso --metadata-name "testchoices"

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

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

--ids

Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие параметры 'Resource Id'.

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

--metadata-name

Имя схемы метаданных.

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

--resource-group -g

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

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

--service-name -n

Имя службы Центра API Azure.

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

--subscription

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

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

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

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

--verbose

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

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

az apic metadata update

Обновите существующую схему метаданных.

az apic metadata update [--add]
                        [--assignments]
                        [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                        [--ids]
                        [--metadata-name]
                        [--remove]
                        [--resource-group]
                        [--schema]
                        [--service-name]
                        [--set]
                        [--subscription]

Примеры

Обновление схемы

az apic metadata update --resource-group api-center-test --service-name contoso --metadata-name "test1" --schema '{"type":"string", "title":"Last name", "pattern": "^[a-zA-Z0-9]+$"}'

Обновление схемы с помощью json-файла схемы

az apic metadata update --resource-group api-center-test --service-name contoso --metadata-name "test1" --schema '@schema.json'

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

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

--add

Добавьте объект в список объектов, указав пары пути и значения ключа. Пример: --add property.listProperty <key=value, string or JSON string>.

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

--assignments

Определяет область назначения для пользовательских метаданных, например "[{entity:api,required:true,deprecated:false}]". Доступные значения сущностей: API, развертывание, среда. Поддержка сокращенного синтаксиса, json-file и yaml-file. Попробуйте "??", чтобы показать больше.

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

--force-string

При использовании "set" или "add" сохраняйте строковые литералы вместо попытки преобразовать в JSON.

Свойство	Значение
Группа параметров:	Generic Update Arguments
Допустимые значения:	0, 1, f, false, n, no, t, true, y, yes

--ids

Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие параметры 'Resource Id'.

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

--metadata-name

Имя схемы метаданных.

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

--remove

Удалите свойство или элемент из списка. Пример: --remove property.list <indexToRemove> OR --remove propertyToRemove.

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

--resource-group -g

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

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

--schema

Схема YAML, определяющая тип.

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

--service-name -n

Имя службы Центра API Azure.

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

--set

Обновите объект, указав путь к свойству и значение для задания. Пример: --set property1.property2=<value>.

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

--subscription

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

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

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

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

--verbose

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

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