az apic api

  • Ссылка

Примечание.

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

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

Команды

Имя Описание Тип Состояние
az apic api create

Зарегистрируйте новый API или обновите существующий API.

 Расширение Общедоступная версия
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 delete

Удалите указанный API.

 Расширение Общедоступная версия
az apic api deployment

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

 Расширение Общедоступная версия
az apic api deployment create

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

 Расширение Общедоступная версия
az apic api deployment delete

Удаление развертывания API.

 Расширение Общедоступная версия
az apic api deployment list

Перечисление коллекции развертываний API.

 Расширение Общедоступная версия
az apic api deployment show

Получение сведений о развертывании API.

 Расширение Общедоступная версия
az apic api deployment update

Обновление существующего развертывания API.

 Расширение Общедоступная версия
az apic api list

Перечисление коллекции API.

 Расширение Общедоступная версия
az apic api register

Регистрирует новый API с версией, определением и связанными развертываниями, используя файл спецификации в качестве источника истины.

 Расширение Предварительный просмотр
az apic api show

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

 Расширение Общедоступная версия
az apic api update

Обновите существующий API.

 Расширение Общедоступная версия
az apic api version

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

 Расширение Общедоступная версия
az apic api version create

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

 Расширение Общедоступная версия
az apic api version delete

Удалите указанную версию API.

 Расширение Общедоступная версия
az apic api version list

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

 Расширение Общедоступная версия
az apic api version show

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

 Расширение Общедоступная версия
az apic api version update

Обновите существующую версию API.

 Расширение Общедоступная версия

az apic api create

Зарегистрируйте новый API или обновите существующий API.

az apic api create --api-id
                   --resource-group
                   --service
                   --title
                   --type {graphql, grpc, rest, soap, webhook, websocket}
                   [--contacts]
                   [--custom-properties]
                   [--description]
                   [--external-documentation]
                   [--license]
                   [--summary]

Примеры

Создание API

az apic api create -g contoso-resources -s contoso --api-id echo-api --title "Echo API" --type REST

Создание API с настраиваемыми свойствами

az apic api create -g contoso-resources -s contoso --api-id echo-api --title "Echo API" --type REST --custom-properties '{"public-facing":true}'

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

--api-id

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

--resource-group -g

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

--service --service-name -s

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

--title

Заголовок API.

--type

Тип API.

допустимые значения: graphql, grpc, rest, soap, webhook, websocket

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

--contacts

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

--custom-properties

Пользовательские метаданные, определенные для сущностей каталога API. Поддержка json-file и yaml-file.

--description

Описание API.

--external-documentation

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

--license

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

--summary

Краткое описание API.

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

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

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

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

--output -o

Формат вывода.

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

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

--verbose

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

az apic api delete

Удалите указанный API.

az apic api delete [--api-id]
                   [--ids]
                   [--resource-group]
                   [--service]
                   [--subscription]
                   [--yes]

Примеры

Удаление API

az apic api delete -g contoso-resources -s contoso --api-id echo-api

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

--api-id

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

--ids

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

--resource-group -g

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

--service --service-name -s

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

--subscription

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

--yes -y

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

значение по умолчанию: False
Глобальные параметры
--debug

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

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

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

--output -o

Формат вывода.

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

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

--verbose

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

az apic api list

Перечисление коллекции API.

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

Примеры

Список API-интерфейсов

az apic api list -g contoso-resources -s contoso

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

--resource-group -g

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

--service --service-name -s

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

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

--filter

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

--max-items

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

--next-token

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

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

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

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

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

--output -o

Формат вывода.

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

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

--verbose

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

az apic api register

Предварительный просмотр

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

Регистрирует новый API с версией, определением и связанными развертываниями, используя файл спецификации в качестве источника истины.

az apic api register --api-location
                     --resource-group
                     --service
                     [--environment-name]

Примеры

Зарегистрируйте API, предоставив файл спецификации.

az apic api register -g api-center-test -s contosoeuap --api-location "examples/cli-examples/spec-examples/openai.json" --environment-name public
az apic api register -g api-center-test -s contosoeuap --api-location "examples/cli-examples/spec-examples/openai.yml" --environment-name public

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

--api-location -l

Расположение файла спецификации.

--resource-group -g

Имя группы ресурсов.

--service -s

Каталог APICenter или имя службы.

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

--environment-name -e

Имя среды, созданной ранее.

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

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

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

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

--output -o

Формат вывода.

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

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

--verbose

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

az apic api show

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

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

Примеры

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

az apic api show -g contoso-resources -s contoso --api-id echo-api

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

--api-id

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

--ids

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

--resource-group -g

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

--service --service-name -s

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

--subscription

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

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

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

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

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

--output -o

Формат вывода.

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

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

--verbose

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

az apic api update

Обновите существующий API.

az apic api update [--add]
                   [--api-id]
                   [--contacts]
                   [--custom-properties]
                   [--description]
                   [--external-documentation]
                   [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                   [--ids]
                   [--license]
                   [--remove]
                   [--resource-group]
                   [--service]
                   [--set]
                   [--subscription]
                   [--summary]
                   [--title]
                   [--type {graphql, grpc, rest, soap, webhook, websocket}]

Примеры

Обновление API

az apic api update -g contoso-resources -s contoso --api-id echo-api --summary "Basic REST API service"

Обновление настраиваемых свойств

az apic api update -g contoso-resources -s contoso --api-id echo-api --custom-properties '{"public-facing":true}'

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

--add

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

--api-id

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

--contacts

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

--custom-properties

Пользовательские метаданные, определенные для сущностей каталога API. Поддержка json-file и yaml-file.

--description

Описание API.

--external-documentation

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

--force-string

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

допустимые значения: 0, 1, f, false, n, no, t, true, y, yes
--ids

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

--license

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

--remove

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

--resource-group -g

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

--service --service-name -s

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

--set

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

--subscription

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

--summary

Краткое описание API.

--title

Заголовок API.

--type

Тип API.

допустимые значения: graphql, grpc, rest, soap, webhook, websocket
Глобальные параметры
--debug

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

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

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

--output -o

Формат вывода.

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

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

--verbose

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