az apim
Управление службами Azure Управление API.
Команды
Имя | Описание | Тип | Состояние |
---|---|---|---|
az apim api |
Управление API управления API Azure. |
Ядро | ГА |
az apim api create |
Создайте API управления API. |
Ядро | ГА |
az apim api delete |
Удаление API управления API. |
Ядро | ГА |
az apim api export |
Экспорт API управления API. |
Ядро | ГА |
az apim api import |
Импорт API управления API. |
Ядро | ГА |
az apim api list |
Перечисление API управления API. |
Ядро | ГА |
az apim api operation |
Управление операциями API управления API Azure. |
Ядро | ГА |
az apim api operation create |
Создает новую операцию в API. |
Ядро | ГА |
az apim api operation delete |
Удаляет указанную операцию в API. |
Ядро | ГА |
az apim api operation list |
Перечислить коллекцию операций для указанного API. |
Ядро | ГА |
az apim api operation show |
Возвращает сведения о операции API, указанной его идентификатором. |
Ядро | ГА |
az apim api operation update |
Обновляет сведения об операции в API, указанной его идентификатором. |
Ядро | ГА |
az apim api release |
Управление выпуском API управления API Azure. |
Ядро | ГА |
az apim api release create |
Создает новый выпуск для API. |
Ядро | ГА |
az apim api release delete |
Удаляет указанный выпуск в API. |
Ядро | ГА |
az apim api release list |
Выводит список всех выпусков API. |
Ядро | ГА |
az apim api release show |
Возвращает сведения о выпуске API. |
Ядро | ГА |
az apim api release update |
Обновляет сведения о выпуске API, указанного его идентификатором. |
Ядро | ГА |
az apim api revision |
Управление редакцией API управления API Azure. |
Ядро | ГА |
az apim api revision create |
Создание редакции API. |
Ядро | ГА |
az apim api revision list |
Выводит список всех редакций API. |
Ядро | ГА |
az apim api schema |
Управление схемой API управления API Azure. |
Ядро | ГА |
az apim api schema create |
Создайте схему API управления API. |
Ядро | ГА |
az apim api schema delete |
Удаление схемы API управления API. |
Ядро | ГА |
az apim api schema get-etag |
Получение etag схемы API управления API. |
Ядро | ГА |
az apim api schema list |
Вывод списка схем API управления API. |
Ядро | ГА |
az apim api schema show |
Отображение сведений о схеме API управления API. |
Ядро | ГА |
az apim api schema wait |
Поместите интерфейс командной строки в состояние ожидания, пока не будет выполнено условие схемы API api. |
Ядро | ГА |
az apim api show |
Отображение сведений об API управления API. |
Ядро | ГА |
az apim api update |
Обновите API управления API. |
Ядро | ГА |
az apim api versionset |
Управление набором версий API управления API Azure. |
Ядро | ГА |
az apim api versionset create |
Создает набор версий API. |
Ядро | ГА |
az apim api versionset delete |
Удаляет определенный набор версий API. |
Ядро | ГА |
az apim api versionset list |
Содержит коллекцию наборов версий API в указанном экземпляре службы. |
Ядро | ГА |
az apim api versionset show |
Возвращает сведения о наборе версий API, заданном его идентификатором. |
Ядро | ГА |
az apim api versionset update |
Обновляет сведения о наборе версий API, заданном его идентификатором. |
Ядро | ГА |
az apim api wait |
Поместите интерфейс командной строки в состояние ожидания, пока не будет выполнено условие API. |
Ядро | ГА |
az apim apply-network-updates |
Обновите ресурс управления API, работающий в виртуальной сети, чтобы выбрать обновленные параметры сети. |
Ядро | ГА |
az apim backup |
Создает резервную копию службы управления API в указанную учетную запись хранения Azure. Это длительная операция и может занять несколько минут. |
Ядро | ГА |
az apim check-name |
Проверяет, доступен ли для использования имя службы. |
Ядро | ГА |
az apim create |
Создайте экземпляр службы управления API. |
Ядро | ГА |
az apim delete |
Удаляет службу управления API. |
Ядро | ГА |
az apim deletedservice |
Управление службами управления API Azure с обратимым удалением. |
Ядро | ГА |
az apim deletedservice list |
Перечислите все экземпляры служб управления API, доступные для отмены удаления для данной подписки. |
Ядро | ГА |
az apim deletedservice purge |
Очистка экземпляра службы управления API обратимого удаления (удаляет его без возможности отмены). |
Ядро | ГА |
az apim deletedservice show |
Получение экземпляров службы управления API с обратимым удалением, доступных для отмены по имени. |
Ядро | ГА |
az apim graphql |
Управление API GraphQL для управления API Azure. |
Ядро | ГА |
az apim graphql resolver |
Управление разрешениями API GraphQL для управления API Azure. |
Ядро | ГА |
az apim graphql resolver create |
Создайте новый сопоставитель в API GraphQL или обновите существующий. |
Ядро | ГА |
az apim graphql resolver delete |
Удалите указанный сопоставитель в API GraphQL. |
Ядро | ГА |
az apim graphql resolver list |
Перечислить коллекцию сопоставителей для указанного API GraphQL. |
Ядро | ГА |
az apim graphql resolver policy |
Управление политиками сопоставителей API GraphQL для управления API Azure. |
Ядро | ГА |
az apim graphql resolver policy create |
Создание или обновление конфигурации политики для уровня сопоставителя API GraphQL. |
Ядро | ГА |
az apim graphql resolver policy delete |
Удалите конфигурацию политики в сопоставитель API GraphQL. |
Ядро | ГА |
az apim graphql resolver policy list |
Получите список конфигурации политики на уровне сопоставителя API GraphQL. |
Ядро | ГА |
az apim graphql resolver policy show |
Получите конфигурацию политики на уровне сопоставителя API GraphQL. |
Ядро | ГА |
az apim graphql resolver show |
Получите сведения о сопоставитель API GraphQL, указанный его идентификатором. |
Ядро | ГА |
az apim list |
Вывод списка экземпляров службы управления API. |
Ядро | ГА |
az apim nv |
Управление именованными значениями управления API Azure. |
Ядро | ГА |
az apim nv create |
Создайте именованное значение управления API. |
Ядро | ГА |
az apim nv delete |
Удаление именованного значения управления API. |
Ядро | ГА |
az apim nv list |
Вывод списка именованных значений управления API. |
Ядро | ГА |
az apim nv show |
Отображение сведений об именованном значении управления API. |
Ядро | ГА |
az apim nv show-secret |
Возвращает секрет именованного значения управления API. |
Ядро | ГА |
az apim nv update |
Обновите именованное значение управления API. |
Ядро | ГА |
az apim nv wait |
Поместите интерфейс командной строки в состояние ожидания до тех пор, пока не будет выполнено условие именованного значения APIM. |
Ядро | ГА |
az apim product |
Управление продуктом управления API Azure. |
Ядро | ГА |
az apim product api |
Управление API-интерфейсами продукта управления API Azure. |
Ядро | ГА |
az apim product api add |
Добавьте API в указанный продукт. |
Ядро | ГА |
az apim product api check |
Проверяет, что сущность API, указанная идентификатором, связана с сущностью Product. |
Ядро | ГА |
az apim product api delete |
Удаляет указанный API из указанного продукта. |
Ядро | ГА |
az apim product api list |
Перечисляет коллекцию API, связанных с продуктом. |
Ядро | ГА |
az apim product create |
Создает продукт. |
Ядро | ГА |
az apim product delete |
Удаление продукта. |
Ядро | ГА |
az apim product list |
Перечисляет коллекцию продуктов в указанном экземпляре службы. |
Ядро | ГА |
az apim product show |
Возвращает сведения о продукте, указанном его идентификатором. |
Ядро | ГА |
az apim product update |
Обновите существующие сведения о продукте. |
Ядро | ГА |
az apim product wait |
Поместите интерфейс командной строки в состояние ожидания до тех пор, пока не будет выполнено условие продукта APIM. |
Ядро | ГА |
az apim restore |
Восстанавливает резервную копию службы управления API, созданной с помощью операции ApiManagementService_Backup текущей службы. Это длительная операция и может занять несколько минут. |
Ядро | ГА |
az apim show |
Отображение сведений об экземпляре службы управления API. |
Ядро | ГА |
az apim update |
Обновите экземпляр службы управления API. |
Ядро | ГА |
az apim wait |
Поместите интерфейс командной строки в состояние ожидания, пока не будет выполнено условие API. |
Ядро | ГА |
az apim apply-network-updates
Обновите ресурс управления API, работающий в виртуальной сети, чтобы выбрать обновленные параметры сети.
az apim apply-network-updates --name
--resource-group
[--location]
[--no-wait]
Примеры
Обновление параметров виртуальной сети экземпляра службы управления API
az apim apply-network-updates --name MyApim -g MyResourceGroup
Обязательные параметры
Имя экземпляра службы управления API.
Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>
.
Необязательные параметры
Местоположение. Значения из az account list-locations
. Расположение по умолчанию можно настроить с помощью az configure --defaults location=<location>
.
Не ожидать завершения длительной операции.
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
Показать это сообщение справки и выйти.
Отображать только ошибки, не показывая предупреждения.
Формат вывода.
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
az apim backup
Создает резервную копию службы управления API в указанную учетную запись хранения Azure. Это длительная операция и может занять несколько минут.
az apim backup --backup-name
--container-name
--name
--resource-group
--storage-account-key
--storage-account-name
[--no-wait]
Примеры
Создание резервной копии экземпляра службы управления API
az apim backup --name MyApim -g MyResourceGroup --backup-name myBackup --storage-account-name mystorageaccount --storage-account-container backups --storage-account-key Ay2ZbdxLnD4OJPT29F6jLPkB6KynOzx85YCObhrw==
Обязательные параметры
Имя создаваемого файла резервной копии.
Имя контейнера учетной записи хранения, используемого для размещения резервной копии.
Имя экземпляра службы управления API.
Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>
.
Ключ доступа учетной записи хранения, используемой для размещения резервной копии.
Имя учетной записи хранения, используемой для размещения резервной копии.
Необязательные параметры
Не ожидать завершения длительной операции.
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
Показать это сообщение справки и выйти.
Отображать только ошибки, не показывая предупреждения.
Формат вывода.
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
az apim check-name
Проверяет, доступен ли для использования имя службы.
az apim check-name --name
Обязательные параметры
Имя экземпляра службы управления API.
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
Показать это сообщение справки и выйти.
Отображать только ошибки, не показывая предупреждения.
Формат вывода.
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
az apim create
Создайте экземпляр службы управления API.
az apim create --name
--publisher-email
--publisher-name
--resource-group
[--disable-gateway {false, true}]
[--enable-client-certificate {false, true}]
[--enable-managed-identity {false, true}]
[--location]
[--no-wait]
[--public-network-access {false, true}]
[--sku-capacity]
[--sku-name {Basic, Consumption, Developer, Isolated, Premium, Standard}]
[--tags]
[--virtual-network {External, Internal, None}]
Примеры
Создайте службу управления API уровня разработчика.
az apim create --name MyApim -g MyResourceGroup -l eastus --publisher-email [email protected] --publisher-name Microsoft
Создайте службу управления API уровня потребления.
az apim create --name MyApim -g MyResourceGroup -l eastus --sku-name Consumption --enable-client-certificate \
--publisher-email [email protected] --publisher-name Microsoft
Обязательные параметры
Уникальное имя создаваемого экземпляра службы.
Имя должно быть глобально уникальным, так как оно будет включено в качестве имени узла шлюза, например" https://my-api-servicename.azure-api.net". См. примеры:
Адрес электронной почты для получения всех системных уведомлений.
Имя вашей организации для использования на портале разработчика и уведомлениях по электронной почте.
Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>
.
Необязательные параметры
Отключите шлюз в главном регионе. Допустимо только для службы управления API, развернутой в нескольких расположениях.
Принудительно предоставляет сертификат клиента для каждого запроса шлюзу, а также позволяет выполнять проверку подлинности сертификата в политике в шлюзе.
Создайте управляемое удостоверение для службы управления API для доступа к другим ресурсам Azure. Предназначено только для использования для службы SKU потребления.
Местоположение. Значения из az account list-locations
. Расположение по умолчанию можно настроить с помощью az configure --defaults location=<location>
.
Не ожидать завершения длительной операции.
Допускается ли доступ к общедоступной конечной точке для этой службы управления API. Если задано значение true, частные конечные точки являются эксклюзивным методом доступа.
Количество развернутых единиц SKU.
SKU экземпляра управления API.
Теги, разделенные пробелами: key[=value] [key[=value] ...]. Используйте "" для очистки существующих тегов.
Тип виртуальной сети.
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
Показать это сообщение справки и выйти.
Отображать только ошибки, не показывая предупреждения.
Формат вывода.
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
az apim delete
Удаляет службу управления API.
az apim delete --name
--resource-group
[--no-wait]
[--yes]
Примеры
Удаление службы управления API.
az apim delete -n MyApim -g MyResourceGroup
Обязательные параметры
Имя экземпляра службы управления API.
Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>
.
Необязательные параметры
Не ожидать завершения длительной операции.
Не запрашивать подтверждение.
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
Показать это сообщение справки и выйти.
Отображать только ошибки, не показывая предупреждения.
Формат вывода.
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
az apim list
Вывод списка экземпляров службы управления API.
az apim list [--resource-group]
Необязательные параметры
Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>
.
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
Показать это сообщение справки и выйти.
Отображать только ошибки, не показывая предупреждения.
Формат вывода.
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
az apim restore
Восстанавливает резервную копию службы управления API, созданной с помощью операции ApiManagementService_Backup текущей службы. Это длительная операция и может занять несколько минут.
az apim restore --backup-name
--container-name
--name
--resource-group
--storage-account-key
--storage-account-name
[--no-wait]
Примеры
Восстановление резервной копии экземпляра службы управления API
az apim restore --name MyApim -g MyResourceGroup --backup-name myBackup --storage-account-name mystorageaccount --storage-account-container backups --storage-account-key Ay2ZbdxLnD4OJPT29F6jLPkB6KynOzx85YCObhrw==
Обязательные параметры
Имя файла резервной копии для восстановления.
Имя контейнера учетной записи хранения, используемого для получения резервной копии.
Имя экземпляра службы управления API.
Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>
.
Ключ доступа учетной записи хранения, используемой для получения резервной копии.
Имя учетной записи хранения, используемой для получения резервной копии.
Необязательные параметры
Не ожидать завершения длительной операции.
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
Показать это сообщение справки и выйти.
Отображать только ошибки, не показывая предупреждения.
Формат вывода.
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
az apim show
Отображение сведений об экземпляре службы управления API.
az apim show --name
--resource-group
Обязательные параметры
Имя экземпляра службы управления API.
Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>
.
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
Показать это сообщение справки и выйти.
Отображать только ошибки, не показывая предупреждения.
Формат вывода.
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
az apim update
Обновите экземпляр службы управления API.
az apim update --name
--resource-group
[--add]
[--disable-gateway {false, true}]
[--enable-client-certificate {false, true}]
[--enable-managed-identity {false, true}]
[--force-string]
[--no-wait]
[--public-network-access {false, true}]
[--publisher-email]
[--publisher-name]
[--remove]
[--set]
[--sku-capacity]
[--sku-name {Basic, Consumption, Developer, Isolated, Premium, Standard}]
[--tags]
[--virtual-network {External, Internal, None}]
Обязательные параметры
Имя экземпляра службы управления API.
Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>
.
Необязательные параметры
Добавьте объект в список объектов, указав пары пути и значения ключа. Пример: --add property.listProperty <key=value, string or JSON string>
.
Отключите шлюз в главном регионе. Допустимо только для службы управления API, развернутой в нескольких расположениях.
Принудительно предоставляет сертификат клиента для каждого запроса шлюзу, а также позволяет выполнять проверку подлинности сертификата в политике в шлюзе.
Создайте управляемое удостоверение для службы управления API для доступа к другим ресурсам Azure. Предназначено только для использования для службы SKU потребления.
При использовании "set" или "add" сохраняйте строковые литералы вместо попытки преобразовать в JSON.
Не ожидать завершения длительной операции.
Допускается ли доступ к общедоступной конечной точке для этой службы управления API. Если задано значение true, частные конечные точки являются эксклюзивным методом доступа.
Адрес электронной почты для получения всех системных уведомлений.
Имя вашей организации для использования на портале разработчика и уведомлениях по электронной почте.
Удалите свойство или элемент из списка. Пример: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Обновите объект, указав путь к свойству и значение для задания. Пример: --set property1.property2=<value>
.
Количество развернутых единиц SKU.
SKU экземпляра управления API.
Теги, разделенные пробелами: key[=value] [key[=value] ...]. Используйте "" для очистки существующих тегов.
Тип виртуальной сети.
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
Показать это сообщение справки и выйти.
Отображать только ошибки, не показывая предупреждения.
Формат вывода.
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
az apim wait
Поместите интерфейс командной строки в состояние ожидания, пока не будет выполнено условие API.
az apim wait --name
--resource-group
[--created]
[--custom]
[--deleted]
[--exists]
[--interval]
[--timeout]
[--updated]
Примеры
Поместите интерфейс командной строки в состояние ожидания до выполнения условия APIM. (автоматическое создание)
az apim wait --created --name MyApim --resource-group MyResourceGroup
Обязательные параметры
Имя экземпляра службы управления API.
Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>
.
Необязательные параметры
Подождите, пока не будет создано с помощью provisioningState по адресу "Успешно".
Подождите, пока условие не будет удовлетворено пользовательским запросом JMESPath. Например, provisioningState!='InProgress', instanceView.statuses[?code='PowerState/running'].
Дождитесь удаления.
Подождите, пока ресурс не существует.
Интервал опроса в секундах.
Максимальное ожидание в секундах.
Подождите, пока не будет обновлено с помощью provisioningState по адресу "Успешно".
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
Показать это сообщение справки и выйти.
Отображать только ошибки, не показывая предупреждения.
Формат вывода.
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.