az apic

Note

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

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

Команды

Имя	Описание	Тип	Состояние
az apic api	Команды для управления API в Центре API.	Extension	GA
az apic api-analysis	Управление функциями анализа API Центра API Azure.	Extension	Preview
az apic api-analysis create	Создайте новую или обновляет существующую конфигурацию анализатора API.	Extension	Preview
az apic api-analysis delete	Удаление удаляет конфигурацию анализатора API.	Extension	Preview
az apic api-analysis export-ruleset	Экспорт набора правил анализатора API.	Extension	Preview
az apic api-analysis import-ruleset	Импортирует набор правил анализатора API.	Extension	Preview
az apic api-analysis list	Вывод списка конфигураций анализатора API.	Extension	Preview
az apic api-analysis show	Получение сведений о конфигурации анализатора API.	Extension	Preview
az apic api-analysis update	Обновите новую или обновляет существующую конфигурацию анализатора API.	Extension	Preview
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 create	Создает экземпляр или обновляет существующий экземпляр службы Центра API Azure.	Extension	GA
az apic delete	Удаляет экземпляр службы Центра API Azure.	Extension	GA
az apic environment	Команды для управления средами в Центре API.	Extension	GA
az apic environment create	Создайте новую среду или обновите существующую среду.	Extension	GA
az apic environment delete	Удаление среды.	Extension	GA
az apic environment list	Перечисление коллекции сред.	Extension	GA
az apic environment show	Получение сведений об среде.	Extension	GA
az apic environment update	Обновите существующую среду.	Extension	GA
az apic integration	Управляет интеграцией в Центре API Azure.	Extension	GA
az apic integration create	Управление службами Центра API Azure.	Extension	GA
az apic integration create apim	Добавьте Azure APIM в качестве источника API.	Extension	GA
az apic integration create aws	Добавьте Шлюз API Amazon в качестве источника API.	Extension	GA
az apic integration delete	Удалите указанный источник API.	Extension	GA
az apic integration list	Вывод списка источников API.	Extension	GA
az apic integration show	Получение сведений об источнике API.	Extension	GA
az apic list	Перечисляет службы Центра API Azure в подписке Azure.	Extension	GA
az apic metadata	Команды для управления схемами метаданных в Центре API.	Extension	GA
az apic metadata create	Создайте новую схему метаданных или обновите существующую схему метаданных.	Extension	GA
az apic metadata delete	Удалите указанную схему метаданных.	Extension	GA
az apic metadata export	Экспортирует схему метаданных.	Extension	GA
az apic metadata list	Перечислить коллекцию схем метаданных.	Extension	GA
az apic metadata show	Получение сведений о схеме метаданных.	Extension	GA
az apic metadata update	Обновите существующую схему метаданных.	Extension	GA
az apic show	Отображение сведений о экземпляре службы Центра API Azure.	Extension	GA
az apic update	Обновите экземпляр службы Центра API Azure.	Extension	GA

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

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

Свойство	Значение
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 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'.

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

--name -n

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

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

--resource-group -g

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

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

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

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

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

Примеры

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

az apic list -g contoso-resources

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

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

--max-items

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

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

--next-token

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

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

--resource-group -g

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

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

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

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

--name -n

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

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

--resource-group -g

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

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

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

--force-string

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

Свойство	Значение
Группа параметров:	Generic Update Arguments
Допустимые значения:	0, 1, f, false, n, no, t, true, y, yes

--identity

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

--ids

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

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

--name -n

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

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

--set

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

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

--subscription

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

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

--tags

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

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

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