az apic api definition
Заметка
Эта ссылка является частью расширения apic-extension для Azure CLI (версия 2.57.0 или более поздней). Расширение автоматически установит первый раз, когда вы запускаете команду az apic api definition. Узнайте больше о расширениях.
Команды для управления определениями API в Центре API.
Команды
Имя | Описание | Тип | Состояние |
---|---|---|---|
az apic api definition create |
Создайте новое определение API или обновите существующее определение API. |
Расширение | ГА |
az apic api definition delete |
Удаление указанного определения API. |
Расширение | ГА |
az apic api definition export-specification |
Экспортирует спецификацию API. |
Расширение | ГА |
az apic api definition import-specification |
Импортирует спецификацию API. |
Расширение | ГА |
az apic api definition list |
Вывод списка определений API. |
Расширение | ГА |
az apic api definition show |
Получение сведений об определении API. |
Расширение | ГА |
az apic api definition update |
Обновление существующего определения API. |
Расширение | ГА |
az apic api definition create
Создайте новое определение API или обновите существующее определение API.
az apic api definition create --api-id
--definition-id
--resource-group
--service-name
--title
--version-id
[--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.
Идентификатор определения API.
Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>
.
Имя службы Центра API Azure.
Версия API.
Идентификатор версии API.
Необязательные параметры
Описание определения API.
Глобальные параметры
Увеличьте детализацию ведения журнала, чтобы отобразить все журналы отладки.
Отображение этого сообщения справки и выхода.
Отображаются только ошибки, подавляющие предупреждения.
Формат вывода.
Строка запроса JMESPath. Дополнительные сведения и примеры см. в http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Увеличьте детализацию ведения журнала. Используйте --debug для полных журналов отладки.
az apic api definition delete
Удаление указанного определения API.
az apic api definition delete [--api-id]
[--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"
Необязательные параметры
Идентификатор API.
Идентификатор определения API.
Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие аргументы Resource Id.
Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>
.
Имя службы Центра API Azure.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Идентификатор версии API.
Не запрашивайте подтверждение.
Глобальные параметры
Увеличьте детализацию ведения журнала, чтобы отобразить все журналы отладки.
Отображение этого сообщения справки и выхода.
Отображаются только ошибки, подавляющие предупреждения.
Формат вывода.
Строка запроса JMESPath. Дополнительные сведения и примеры см. в http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Увеличьте детализацию ведения журнала. Используйте --debug для полных журналов отладки.
az apic api definition export-specification
Экспортирует спецификацию API.
az apic api definition export-specification --file-name
[--api-id]
[--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
Обязательные параметры
Имя файла, в который нужно экспортировать спецификацию.
Необязательные параметры
Идентификатор API.
Идентификатор определения API.
Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие аргументы Resource Id.
Не дождитесь завершения длительной операции.
Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>
.
Имя службы Центра API Azure.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Идентификатор версии API.
Глобальные параметры
Увеличьте детализацию ведения журнала, чтобы отобразить все журналы отладки.
Отображение этого сообщения справки и выхода.
Отображаются только ошибки, подавляющие предупреждения.
Формат вывода.
Строка запроса JMESPath. Дополнительные сведения и примеры см. в http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Увеличьте детализацию ведения журнала. Используйте --debug для полных журналов отладки.
az apic api definition import-specification
Импортирует спецификацию API.
az apic api definition import-specification --format {inline, link}
--specification
--value
[--api-id]
[--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'
Обязательные параметры
Формат источника спецификации API.
Сведения о спецификации API. Поддержка сокращенного синтаксиса, json-file и yaml-file. Попробуйте "??", чтобы показать больше.
Значение источника спецификации API.
Необязательные параметры
Идентификатор API.
Идентификатор определения API.
Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие аргументы Resource Id.
Не дождитесь завершения длительной операции.
Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>
.
Имя службы Центра API Azure.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Идентификатор версии API.
Глобальные параметры
Увеличьте детализацию ведения журнала, чтобы отобразить все журналы отладки.
Отображение этого сообщения справки и выхода.
Отображаются только ошибки, подавляющие предупреждения.
Формат вывода.
Строка запроса JMESPath. Дополнительные сведения и примеры см. в http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Увеличьте детализацию ведения журнала. Используйте --debug для полных журналов отладки.
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.
Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>
.
Имя службы Центра API Azure.
Идентификатор версии API.
Необязательные параметры
Параметр фильтра OData.
Общее количество элементов, возвращаемых в выходных данных команды. Если общее количество доступных элементов превышает указанное значение, маркер предоставляется в выходных данных команды. Чтобы возобновить разбиение на страницы, укажите значение маркера в --next-token
аргументе последующей команды.
Маркер, чтобы указать, где начать разбиение на страницы. Это значение маркера из ранее усеченного ответа.
Глобальные параметры
Увеличьте детализацию ведения журнала, чтобы отобразить все журналы отладки.
Отображение этого сообщения справки и выхода.
Отображаются только ошибки, подавляющие предупреждения.
Формат вывода.
Строка запроса JMESPath. Дополнительные сведения и примеры см. в http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Увеличьте детализацию ведения журнала. Используйте --debug для полных журналов отладки.
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.
Идентификатор определения API.
Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие аргументы Resource Id.
Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>
.
Имя службы Центра API Azure.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Идентификатор версии API.
Глобальные параметры
Увеличьте детализацию ведения журнала, чтобы отобразить все журналы отладки.
Отображение этого сообщения справки и выхода.
Отображаются только ошибки, подавляющие предупреждения.
Формат вывода.
Строка запроса JMESPath. Дополнительные сведения и примеры см. в http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Увеличьте детализацию ведения журнала. Используйте --debug для полных журналов отладки.
az apic api definition update
Обновление существующего определения API.
az apic api definition update [--add]
[--api-id]
[--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"
Необязательные параметры
Добавьте объект в список объектов, указав пары пути и значения ключа. Пример: --add property.listProperty <key=value, string or JSON string>
.
Идентификатор API.
Идентификатор определения API.
Описание определения API.
При использовании "set" или "add" сохраняйте строковые литералы вместо попытки преобразовать в JSON.
Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие аргументы Resource Id.
Удалите свойство или элемент из списка. Пример: --remove property.list <indexToRemove>
ИЛИ --remove propertyToRemove
.
Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>
.
Имя службы Центра API Azure.
Обновите объект, указав путь к свойству и значение для задания. Пример: --set property1.property2=<value>
.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Название версии API.
Идентификатор версии API.
Глобальные параметры
Увеличьте детализацию ведения журнала, чтобы отобразить все журналы отладки.
Отображение этого сообщения справки и выхода.
Отображаются только ошибки, подавляющие предупреждения.
Формат вывода.
Строка запроса JMESPath. Дополнительные сведения и примеры см. в http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Увеличьте детализацию ведения журнала. Используйте --debug для полных журналов отладки.