Поделиться через

az apic api

Note

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

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

Команды

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

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

 Extension GA
az apic api definition

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

 Extension GA
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 delete

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

 Extension GA
az apic api deployment

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

 Extension GA
az apic api deployment create

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

 Extension GA
az apic api deployment delete

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

 Extension GA
az apic api deployment list

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

 Extension GA
az apic api deployment show

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

 Extension GA
az apic api deployment update

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

 Extension GA
az apic api list

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

 Extension GA
az apic api register

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

 Extension Preview
az apic api show

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

 Extension GA
az apic api update

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

 Extension GA
az apic api version

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

 Extension GA
az apic api version create

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

 Extension GA
az apic api version delete

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

 Extension GA
az apic api version list

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

 Extension GA
az apic api version show

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

 Extension GA
az apic api version update

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

 Extension GA

az apic api create

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

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

Примеры

Создание API

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

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

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

Создание API с настраиваемыми свойствами с помощью json-файла

az apic api create -g contoso-resources -n contoso --api-id echo-api --title "Echo API" --type REST --custom-properties '@customProperties.json'

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

--api-id

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

--resource-group -g

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

--service-name -n

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

--title

Заголовок API.

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

Тип API.

Свойство Значение
Группа параметров: Properties Arguments
Допустимые значения: graphql, grpc, rest, soap, webhook, websocket

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

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

--contacts

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

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

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

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

Описание API.

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

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

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

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

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

Краткое описание 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 delete

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

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

Примеры

Удаление API

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

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

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

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

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

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

Примеры

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

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

Вывод списка API с фильтром

az apic api list -g contoso-resources -n contoso --filter "kind eq 'rest'"

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

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

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

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

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

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

Примеры

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

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

Зарегистрируйте API, указав URL-адрес спецификации.

az apic api register -g api-center-test -n contosoeuap --api-location "https://petstore.swagger.io/v2/swagger.json" --environment-id public
az apic api register -g api-center-test -n contosoeuap --api-location "https://petstore.swagger.io/v2/swagger.yaml" --environment-id public

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

--api-location -l

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

--resource-group -g

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

--service-name -n

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

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

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

--environment-id

Идентификатор среды, созданной ранее.

Глобальные параметры
--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 show

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

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

Примеры

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

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

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

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

--api-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
Глобальные параметры
--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 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-name]
                   [--set]
                   [--subscription]
                   [--summary]
                   [--title]
                   [--type {graphql, grpc, rest, soap, webhook, websocket}]

Примеры

Обновление API

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

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

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

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

az apic api update -g contoso-resources -n contoso --api-id echo-api --custom-properties '@customProperities.json'

Обновление отдельных пользовательских метаданных

az apic api update -g contoso-resources -n contoso --api-id echo-api --set customProperties.internal=false

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

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

--add

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

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

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

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

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

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

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

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

Описание API.

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

Дополнительная внешняя документация по 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
--license

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

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

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

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

Заголовок API.

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

Тип API.

Свойство Значение
Группа параметров: Properties Arguments
Допустимые значения: graphql, grpc, rest, soap, webhook, websocket
Глобальные параметры
--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