Краткое руководство. Создание нового экземпляра Azure Управление API с помощью PowerShell
ОБЛАСТЬ ПРИМЕНЕНИЯ: Потребление | Разработчик | Базовый | Стандартный | Премиум
В этом кратком руководстве вы создадите новый экземпляр Управление API с помощью командлетов Azure PowerShell. После создания экземпляра можно использовать командлеты Azure PowerShell для распространенных действий управления, таких как импорт API в экземпляре Управление API.
Azure Управление API помогает организациям публиковать API для внешних, партнерских и внутренних разработчиков, чтобы разблокировать потенциал своих данных и служб. Служба управления API предоставляет базовые возможности для успешного выполнения программы API за счет привлечения разработчиков, бизнес-аналитики, анализа, безопасности и защищенности. С помощью Управление API создайте современные шлюзы API и управляйте ими для существующих внутренних служб, размещенных в любом месте.
Если у вас еще нет подписки Azure, создайте бесплатную учетную запись Azure, прежде чем начинать работу.
Необходимые компоненты
- Если вы решили использовать Azure PowerShell локально:
- Установите последнюю версию модуля Az PowerShell.
- Подключитесь к учетной записи Azure с помощью командлета Connect-AzAccount.
- Если вы решили использовать Azure Cloud Shell:
- Дополнительные сведения см. в статье Общие сведения об Azure Cloud Shell.
Создать группу ресурсов
Создайте группу ресурсов Azure с помощью командлета New-AzResourceGroup. Группа ресурсов — это логический контейнер, в котором происходит развертывание ресурсов Azure и управление ими.
В следующей команде создается группа ресурсов с именем myResourceGroup в расположении "западная часть США".
New-AzResourceGroup -Name myResourceGroup -Location WestUS
Создание экземпляра управления API
Теперь, когда у вас есть группа ресурсов, можно создать экземпляр службы "Управление API". Создайте его с помощью команды New-AzApiManagement, а также укажите имя службы и сведения об издателе. Имя пользователя должно быть уникальным в пределах Azure.
В следующем примере для имени службы используется myapim. Замените его уникальным значением. Также обновите имя организации издателя API и адрес электронной почты администратора для получения уведомлений.
По умолчанию команда создает экземпляр на уровне разработчика, экономичный вариант для оценки службы "Управление API Azure". Этот уровень не предназначен для использования в рабочей среде. Дополнительные сведения о уровнях Управление API см. в сравнении уровней Управление API Azure на основе функций.
Совет
Это длительное действие. Обычно создание и активация службы "Управление API" на этом уровне занимает от 30 до 40 минут.
New-AzApiManagement -Name "myapim" -ResourceGroupName "myResourceGroup" `
-Location "West US" -Organization "Contoso" -AdminEmail "admin@contoso.com"
При возвращении команды выполните команду Get-AzApiManagement, чтобы просмотреть свойства службы "Управление API Azure". После активации ProvisioningState экземпляр успешно выполнен и имеет несколько связанных URL-адресов. Например:
Get-AzApiManagement -Name "myapim" -ResourceGroupName "myResourceGroup"
Пример результата:
PublicIPAddresses : {203.0.113.1}
PrivateIPAddresses :
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ApiManagement/service/myapim
Name : myapim
Location : West US
Sku : Developer
Capacity : 1
CreatedTimeUtc : 9/9/2022 9:07:43 PM
ProvisioningState : Succeeded
RuntimeUrl : https://myapim.azure-api.net
RuntimeRegionalUrl : https://myapi-westus-01.regional.azure-api.net
PortalUrl : https://myapim.portal.azure-api.net
DeveloperPortalUrl : https://myapim.developer.azure-api.net
ManagementApiUrl : https://myapim.management.azure-api.net
ScmUrl : https://myapim.scm.azure-api.net
PublisherEmail : admin@contoso.com
OrganizationName : Contoso
NotificationSenderEmail : apimgmt-noreply@mail.windowsazure.com
VirtualNetwork :
VpnType : None
PortalCustomHostnameConfiguration :
ProxyCustomHostnameConfiguration : {myapim.azure-api.net}
ManagementCustomHostnameConfiguration :
ScmCustomHostnameConfiguration :
DeveloperPortalHostnameConfiguration :
SystemCertificates :
Tags : {}
AdditionalRegions : {}
SslSetting : Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSslSetting
Identity :
EnableClientCertificate :
EnableClientCertificate :
Zone :
DisableGateway : False
MinimalControlPlaneApiVersion :
PublicIpAddressId :
PlatformVersion : stv2
PublicNetworkAccess : Enabled
PrivateEndpointConnections :
ResourceGroupName : myResourceGroup
Когда экземпляр службы "Управление API" будет развернут, его можно использовать. Изучите сведения из учебника, чтобы импортировать и опубликовать первый API.
Очистка ресурсов
Вы можете удалить ставшие ненужными группу ресурсов и все связанные с ней ресурсы, выполнив команду Remove-AzResourceGroup.
Remove-AzResourceGroup -Name myResourceGroup