Início Rápido: Criar uma instância de serviço do Gerenciamento de API do Azure usando o PowerShell
APLICA-SE A: Consumo | Desenvolvedor | Básico | Standard | Premium
Neste guida de início rápido, você criará uma nova instância de Gerenciamento de API do Azure usando os cmdlets do Azure PowerShell. Depois de criar uma instância, você pode usar cmdlets do Azure PowerShell para ações de gerenciamento comuns, 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 parceiros externos e desenvolvedores internos e a fim de viabilizar o potencial de seus dados e serviços. O Gerenciamento de API fornece as competências essenciais para garantir um programa de API de sucesso através do envolvimento do desenvolvedor, ideias de negócios, análises, segurança e proteção. O Gerenciamento de API permite que você crie e gerencie gateways de API modernos para serviços de back-end hospedados em qualquer lugar.
Caso você não tenha uma assinatura 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 do Az PowerShell.
- Conecte-se à sua conta do Azure usando o cmdlet Connect-AzAccount.
- Se você optar por usar o Azure Cloud Shell:
- Confira 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 contêiner lógico no qual os recursos do Azure são implantados e gerenciados.
O seguinte comando cria um grupo de recursos chamado myResourceGroup na localização Oeste dos EUA:
New-AzResourceGroup -Name myResourceGroup -Location WestUS
Criar uma instância de Gerenciamento de API
Agora que você tem um grupo de recursos, você pode criar uma instância de serviço do Gerenciamento de API. Crie uma usando New-AzApiManagement e forneça um nome de serviço e detalhes do editor. O nome do serviço precisa ser único no Azure.
No exemplo a seguir, myapim é usado para o nome do serviço. Atualize o nome para um valor exclusivo. Também atualize o nome da organização do editor da API e o endereço de email do administrador para receber notificações.
Por padrão, o comando cria a instância na camada Desenvolvedor, uma opção econômica para avaliar o Gerenciamento de API do Azure. Essa camada não é para uso em produção. Para obter mais informações sobre as camadas de Gerenciamento de API, confira Comparação baseada em recursos das camadas de Gerenciamento de API do Azure.
Dica
Esse é uma ação de execução prolongada. A criação e a ativação de um serviço de Gerenciamento de API nessa camada leva de 30 a 40 minutos.
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, a ProvisioningState foi Bem-sucedida e 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 tiver sido implantada, você estará pronto para usá-la. Comece com o tutorial para importar e publicar sua primeira API.
Limpar os recursos
Quando não forem mais necessários, você poderá usar o comando Remove-AzResourceGroup para remover o grupo de recursos e todos os recursos relacionados.
Remove-AzResourceGroup -Name myResourceGroup