Guia de início rápido: criar uma nova instância de Gerenciamento de API do Azure usando o PowerShell
APLICA-SE A: Consumo | Programador | Básico | Padrão | Prémio
Neste início rápido, você cria uma nova instância de Gerenciamento de API usando cmdlets do Azure PowerShell. Depois de criar uma instância, você pode usar cmdlets do Azure PowerShell para ações comuns de gerenciamento, como importar APIs em sua instância de Gerenciamento de API.
O Gerenciamento de API do Azure ajuda as organizações a publicar APIs para desenvolvedores externos, parceiros e internos para desbloquear o potencial de seus dados e serviços. A Gestão de API fornece as competências essenciais para garantir um programa de API bem-sucedido através do envolvimento dos programadores, das informações de negócio, da análise, da segurança e da proteção. Com o Gerenciamento de API, crie e gerencie gateways de API modernos para serviços de back-end existentes hospedados em qualquer lugar.
Se não tiver uma subscrição do Azure, crie uma conta gratuita do Azure antes de começar.
Pré-requisitos
- Se você optar por usar o Azure PowerShell localmente:
- Instale a versão mais recente do módulo Az PowerShell.
- Conecte-se à sua conta do Azure usando o cmdlet Connect-AzAccount .
- Se você optar por usar o Azure Cloud Shell:
- Consulte Visão geral do Azure Cloud Shell para obter mais informações.
Criar grupo de recursos
Crie um grupo de recursos do Azure com New-AzResourceGroup. Um grupo de recursos é um contentor lógico no qual os recursos do Azure são implementados e geridos.
O comando a seguir cria um grupo de recursos chamado myResourceGroup no local Oeste dos EUA:
New-AzResourceGroup -Name myResourceGroup -Location WestUS
Criar uma instância da Gestão de API
Agora que você tem um grupo de recursos, pode criar uma instância de serviço de Gerenciamento de API. Crie um usando New-AzApiManagement e forneça um nome de serviço e detalhes do editor. O nome do serviço deve ser exclusivo no Azure.
No exemplo a seguir, myapim é usado para o nome do serviço. Atualize o nome para um valor exclusivo. Além disso, atualize o nome da organização do editor da API e o endereço de e-mail do administrador para receber notificações.
Por padrão, o comando cria a instância na camada de desenvolvedor, uma opção econômica para avaliar o Gerenciamento de API do Azure. Esta camada não é para uso em produção. Para obter mais informações sobre as camadas de Gerenciamento de API, consulte Comparação baseada em recursos das camadas de Gerenciamento de API do Azure.
Gorjeta
Trata-se de uma ação de longa duração. Pode levar entre 30 e 40 minutos para criar e ativar um serviço de Gerenciamento de API nessa camada.
New-AzApiManagement -Name "myapim" -ResourceGroupName "myResourceGroup" `
-Location "West US" -Organization "Contoso" -AdminEmail "admin@contoso.com"
Quando o comando retornar, execute Get-AzApiManagement para exibir as propriedades do serviço de Gerenciamento de API do Azure. Após a ativação, o ProvisioningState é Successful e a instância tem várias URLs associadas. Por exemplo:
Get-AzApiManagement -Name "myapim" -ResourceGroupName "myResourceGroup"
Saída de exemplo:
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
Depois que sua instância de serviço de Gerenciamento de API for implantada, você estará pronto para usá-la. Comece com o tutorial para importar e publicar sua primeira API.
Clean up resources (Limpar recursos)
Quando não for mais necessário, você poderá usar o comando Remove-AzResourceGroup para remover o grupo de recursos e todos os recursos relacionados.
Remove-AzResourceGroup -Name myResourceGroup