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

az apic

  • Ссылка

Примечание.

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

Управление службами Центра API Azure.

Команды

Имя Описание Тип Состояние
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 с версией, определением и связанными развертываниями, используя файл спецификации в качестве источника истины. Теперь мы поддерживаем только формат JSON/YAML OpenAPI.

 Расширение Предварительный просмотр
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 create

Создает экземпляр или обновляет существующий экземпляр службы Центра API Azure.

 Расширение ГА
az apic delete

Удаляет экземпляр службы Центра API Azure.

 Расширение ГА
az apic environment

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

 Расширение ГА
az apic environment create

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

 Расширение ГА
az apic environment delete

Удаление среды.

 Расширение ГА
az apic environment list

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

 Расширение ГА
az apic environment show

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

 Расширение ГА
az apic environment update

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

 Расширение ГА
az apic import

Управление службами Центра API Azure.

 Расширение ГА
az apic import-from-apim

Импортирует API из экземпляра службы управления API Azure.

 Расширение ГА
az apic import aws

Импорт источника API шлюза API Amazon.

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

Управляет интеграцией в Центре API Azure.

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

Управление службами Центра API Azure.

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

Добавьте Azure APIM в качестве источника API.

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

Добавьте Шлюз API Amazon в качестве источника API.

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

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

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

Вывод списка источников API.

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

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

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

Перечисляет службы Центра API Azure в подписке Azure.

 Расширение ГА
az apic metadata

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

 Расширение ГА
az apic metadata create

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

 Расширение ГА
az apic metadata delete

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

 Расширение ГА
az apic metadata export

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

 Расширение ГА
az apic metadata list

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

 Расширение ГА
az apic metadata show

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

 Расширение ГА
az apic metadata update

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

 Расширение ГА
az apic show

Отображение сведений о экземпляре службы Центра API Azure.

 Расширение ГА
az apic update

Обновите экземпляр службы Центра API Azure.

 Расширение ГА

az apic create

Создает экземпляр или обновляет существующий экземпляр службы Центра API Azure.

az apic create --name
               --resource-group
               [--identity]
               [--location]
               [--tags]

Примеры

Пример создания службы

az apic create -g contoso-resources -n contoso -l eastus

Пример создания службы с назначенными системой удостоверениями

az apic create -g contoso-resources -n contoso -l eastus --identity '{type:systemassigned}'

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

--name -n

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

--resource-group -g

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

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

--identity

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

--location -l

Географическое расположение, в котором находится ресурс, если он не указан, будет использоваться расположение группы ресурсов.

--tags

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

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

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

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

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

--output -o

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

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

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

--subscription

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

--verbose

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

az apic delete

Удаляет экземпляр службы Центра API Azure.

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

Примеры

Удаление службы

az apic delete -n contoso -g contoso-resources

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

--ids

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

--name -n

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

--resource-group -g

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

--subscription

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

--yes -y

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

Default value: False
Глобальные параметры
--debug

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

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

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

--output -o

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

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

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

--subscription

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

--verbose

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

az apic import-from-apim

Импортирует API из экземпляра службы управления API Azure.

az apic import-from-apim --apim-apis
                         --apim-name
                         [--apim-resource-group]
                         [--apim-subscription]
                         [--ids]
                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                         [--resource-group]
                         [--service-name]
                         [--subscription]

Примеры

Импорт всех API из APIM в одной группе ресурсов

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-name contoso-apim --apim-apis *

Импорт выбранных API из APIM в той же группе ресурсов

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-name contoso-apim --apim-apis [echo,foo]

Импорт всех API из APIM в другую подписку и группу ресурсов

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-subscription 00000000-0000-0000-0000-000000000000 --apim-resource-group apim-rg --apim-name contoso-apim --apim-apis *

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

--apim-apis

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

--apim-name

Имя исходного экземпляра APIM.

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

--apim-resource-group

Группа ресурсов исходного экземпляра APIM.

--apim-subscription

Идентификатор подписки исходного экземпляра APIM.

--ids

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

--no-wait

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

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

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

--service-name -n

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

--subscription

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

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

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

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

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

--output -o

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

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

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

--subscription

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

--verbose

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

az apic list

Перечисляет службы Центра API Azure в подписке Azure.

Существует известная проблема, из-за которой перечисление всех ресурсов в подписке не работает. Перечислите ресурсы по группе ресурсов.

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

Примеры

Перечисление служб в группе ресурсов

az apic list -g contoso-resources

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

--max-items

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

--next-token

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

--resource-group -g

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

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

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

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

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

--output -o

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

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

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

--subscription

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

--verbose

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

az apic show

Отображение сведений о экземпляре службы Центра API Azure.

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

Примеры

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

az apic show -g contoso-resources -n contoso

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

--ids

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

--name -n

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

--resource-group -g

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

--subscription

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

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

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

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

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

--output -o

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

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

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

--subscription

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

--verbose

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

az apic update

Обновите экземпляр службы Центра API Azure.

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

Примеры

Обновление сведений о службе

az apic update -g contoso-resources -n contoso

Обновление службы с помощью примера назначенных системой удостоверений

az apic update -g contoso-resources -n contoso --identity '{type:systemassigned}'

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

--add

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

--force-string

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

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

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

--ids

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

--name -n

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

--remove

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

--resource-group -g

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

--set

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

--subscription

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

--tags

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

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

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

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

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

--output -o

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

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

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

--subscription

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

--verbose

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