Краткое руководство. Создание нового экземпляра Azure Управление API с помощью Azure CLI
ОБЛАСТЬ ПРИМЕНЕНИЯ: Потребление | Разработчик | Базовый | Стандартный | Премиум
В этом кратком руководстве описаны шаги по созданию нового экземпляра Управление API с помощью команд Azure CLI. После создания экземпляра можно использовать Azure CLI для распространенных задач управления, таких как импорт API в Управление API экземпляре.
Azure Управление API помогает организациям публиковать API для внешних, партнерских и внутренних разработчиков, чтобы разблокировать потенциал своих данных и служб. Служба управления API предоставляет базовые возможности для успешного выполнения программы API за счет привлечения разработчиков, бизнес-аналитики, анализа, безопасности и защищенности. С помощью Управление API создайте современные шлюзы API и управляйте ими для существующих внутренних служб, размещенных в любом месте.
Если у вас еще нет подписки Azure, создайте бесплатную учетную запись Azure, прежде чем начинать работу.
Необходимые компоненты
Используйте среду Bash в Azure Cloud Shell. Дополнительные сведения см . в кратком руководстве по Bash в Azure Cloud Shell.
Если вы предпочитаете выполнять справочные команды CLI локально, установите Azure CLI. Если вы работаете в Windows или macOS, Azure CLI можно запустить в контейнере Docker. Дополнительные сведения см. в статье Как запустить Azure CLI в контейнере Docker.
Если вы используете локальную установку, выполните вход в Azure CLI с помощью команды az login. Чтобы выполнить аутентификацию, следуйте инструкциям в окне терминала. Сведения о других возможностях, доступных при входе, см. в статье Вход с помощью Azure CLI.
Установите расширение Azure CLI при первом использовании, когда появится соответствующий запрос. Дополнительные сведения о расширениях см. в статье Использование расширений с Azure CLI.
Выполните команду az version, чтобы узнать установленную версию и зависимые библиотеки. Чтобы обновиться до последней версии, выполните команду az upgrade.
- Для работы с этой статьей требуется Azure CLI версии 2.11.1 или более поздней. Если вы используете Azure Cloud Shell, последняя версия уже установлена.
Создание или изменение группы ресурсов
Экземпляры службы "Управление API Azure", как и все ресурсы Azure, должны быть развернуты в группе ресурсов. Группы ресурсов позволяют организовать соответствующие ресурсы Azure и управлять ими.
Для начала создайте группу ресурсов с именем myResourceGroup в регионе "центральная часть США" с помощью следующей команды az group create:
az group create --name myResourceGroup --location centralus
Создание экземпляра управления API
Теперь, когда у вас есть группа ресурсов, можно создать экземпляр Управление API. Создайте его с помощью команды az apim create, а также укажите имя службы и сведения об издателе. Имя пользователя должно быть уникальным в пределах Azure.
В следующем примере для имени службы используется myapim. Замените его уникальным значением. Также обновите имя организации издателя API и адрес электронной почты для получения уведомлений.
az apim create --name myapim --resource-group myResourceGroup \
--publisher-name Contoso --publisher-email admin@contoso.com \
--no-wait
По умолчанию команда создает экземпляр на уровне разработчика, экономичный вариант для оценки службы "Управление API Azure". Этот уровень не предназначен для использования в рабочей среде. Дополнительные сведения о масштабировании категорий службы управления API см. в статье о повышении категории и масштабировании.
Совет
Обычно создание и активация службы "Управление API" на этом уровне занимает от 30 до 40 минут. Предыдущая команда использует параметр --no-wait
, чтобы результаты возвращались сразу же после создания службы.
Проверьте состояние развертывания, выполнив команду az apim show:
az apim show --name myapim --resource-group myResourceGroup --output table
Изначально выходные данные аналогичны приведенным ниже с состоянием Activating
:
NAME RESOURCE GROUP LOCATION GATEWAY ADDR PUBLIC IP PRIVATE IP STATUS TIER UNITS
----------- ---------------- ---------- -------------- ----------- ------------ ---------- --------- -------
myapim myResourceGroup Central US Activating Developer 1
После активации состояние изменится на Online
, а экземпляр службы получит адрес шлюза и общедоступный IP-адрес. Сейчас эти адреса не предоставляют никакого содержимого. Например:
NAME RESOURCE GROUP LOCATION GATEWAY ADDR PUBLIC IP PRIVATE IP STATUS TIER UNITS
----------- ---------------- ---------- --------------------------------- ------------ ------------ -------- --------- -------
myapim myResourceGroup Central US https://myapim.azure-api.net 203.0.113.1 Online Developer 1
Когда экземпляр службы "Управление API" находится в сети, его можно использовать. Изучите сведения из учебника, чтобы импортировать и опубликовать первый API.
Очистка ресурсов
Ненужные группу ресурсов и экземпляр службы "Управление API" можно удалить с помощью команды az group delete.
az group delete --name myResourceGroup