az apic api definition

Note

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

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

Команды

Имя	Описание	Тип	Состояние
az apic api definition create	Создайте новое определение API или обновите существующее определение API.	Extension	GA
az apic api definition delete	Удаление указанного определения API.	Extension	GA
az apic api definition export-specification	Экспортирует спецификацию API.	Extension	GA
az apic api definition import-specification	Импортирует спецификацию API.	Extension	GA
az apic api definition list	Вывод списка определений API.	Extension	GA
az apic api definition show	Получение сведений об определении API.	Extension	GA
az apic api definition update	Обновление существующего определения API.	Extension	GA

az apic api definition create

Создайте новое определение API или обновите существующее определение API.

az apic api definition create --api-id
                              --definition-id
                              --resource-group
                              --service-name
                              --title
                              --version-id
                              [--acquire-policy-token]
                              [--change-reference]
                              [--description]

Примеры

Создание определения API

az apic api definition create -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi" --title "OpenAPI"

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

--api-id

Идентификатор API.

--definition-id

Идентификатор определения API.

--resource-group -g

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

--service-name -n

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

--title

Версия API.

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

--version-id

Идентификатор версии API.

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

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

--acquire-policy-token

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

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

--change-reference

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

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

--description

Описание определения API.

Свойство	Значение
Группа параметров:	Properties 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 api definition delete

Удаление указанного определения API.

az apic api definition delete [--acquire-policy-token]
                              [--api-id]
                              [--change-reference]
                              [--definition-id]
                              [--ids]
                              [--resource-group]
                              [--service-name]
                              [--subscription]
                              [--version-id]
                              [--yes]

Примеры

Удаление определения API

az apic api definition delete -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi"

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

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

--acquire-policy-token

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

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

--api-id

Идентификатор API.

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

--change-reference

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

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

--definition-id

Идентификатор определения API.

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

--ids

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

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

--version-id

Идентификатор версии API.

Свойство	Значение
Группа параметров:	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 api definition export-specification

Экспортирует спецификацию API.

az apic api definition export-specification --file-name
                                            [--acquire-policy-token]
                                            [--api-id]
                                            [--change-reference]
                                            [--definition-id]
                                            [--ids]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--resource-group]
                                            [--service-name]
                                            [--subscription]
                                            [--version-id]

Примеры

Спецификация экспорта

az apic api definition export-specification -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id default --file-name filename.json

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

--file-name

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

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

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

--acquire-policy-token

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

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

--api-id

Идентификатор API.

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

--change-reference

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

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

--definition-id

Идентификатор определения API.

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

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

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

--subscription

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

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

--version-id

Идентификатор версии API.

Свойство	Значение
Группа параметров:	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 api definition import-specification

Импортирует спецификацию API.

az apic api definition import-specification --format {inline, link}
                                            --specification
                                            --value
                                            [--acquire-policy-token]
                                            [--api-id]
                                            [--change-reference]
                                            [--definition-id]
                                            [--ids]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--resource-group]
                                            [--service-name]
                                            [--subscription]
                                            [--version-id]

Примеры

Пример спецификации импорта 1

az apic api definition import-specification -g api-center-test -n contosoeuap --api-id echo-api-2 --version-id 2023-08-01 --definition-id openapi3 --format "inline" --value '{"openapi":"3.0.1","info":{"title":"httpbin.org","description":"API Management facade for a very handy and free online HTTP tool.","version":"1.0"}}' --specification '{"name":"openapi","version":"3.0.0"}'

Пример спецификации импорта 2

az apic api definition import-specification -g api-center-test -n contoso --api-id echo-api --version-id 2023-11-01 --definition-id openapi --format "link" --value 'https://petstore3.swagger.io/api/v3/openapi.json' --specification '{"name":"openapi","version":"3.0.0"}'

Спецификация импорта из примера файла

az apic api definition import-specification -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-08-01 --definition-id openapi --format "inline" --value '@petstore.json'

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

--format

Формат источника спецификации API.

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

--specification

Сведения о спецификации API. Поддержка сокращенного синтаксиса, json-file и yaml-file. Попробуйте "??", чтобы показать больше.

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

--value

Значение источника спецификации API.

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

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

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

--acquire-policy-token

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

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

--api-id

Идентификатор API.

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

--change-reference

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

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

--definition-id

Идентификатор определения API.

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

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

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

--subscription

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

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

--version-id

Идентификатор версии API.

Свойство	Значение
Группа параметров:	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 api definition list

Вывод списка определений API.

az apic api definition list --api-id
                            --resource-group
                            --service-name
                            --version-id
                            [--filter]
                            [--max-items]
                            [--next-token]

Примеры

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

az apic api definition list -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01

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

--api-id

Идентификатор API.

--resource-group -g

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

--service-name -n

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

--version-id

Идентификатор версии API.

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

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

--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 api definition show

Получение сведений об определении API.

az apic api definition show [--api-id]
                            [--definition-id]
                            [--ids]
                            [--resource-group]
                            [--service-name]
                            [--subscription]
                            [--version-id]

Примеры

Отображение сведений об определении API

az apic api definition show -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi"

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

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

--api-id

Идентификатор API.

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

--definition-id

Идентификатор определения API.

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

--ids

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

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

--version-id

Идентификатор версии API.

Свойство	Значение
Группа параметров:	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 api definition update

Обновление существующего определения API.

az apic api definition update [--acquire-policy-token]
                              [--add]
                              [--api-id]
                              [--change-reference]
                              [--definition-id]
                              [--description]
                              [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                              [--ids]
                              [--remove]
                              [--resource-group]
                              [--service-name]
                              [--set]
                              [--subscription]
                              [--title]
                              [--version-id]

Примеры

Обновление определения API

az apic api definition update -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi" --title "OpenAPI"

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

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

--acquire-policy-token

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

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

--add

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

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

--api-id

Идентификатор API.

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

--change-reference

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

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

--definition-id

Идентификатор определения API.

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

--description

Описание определения API.

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

--remove

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

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

--resource-group -g

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

Свойство	Значение
Группа параметров:	Resource Id 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

--title

Название версии API.

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

--version-id

Идентификатор версии API.

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