Início Rápido: Criar uma nova instância de Azure API Management usando o Bicep

APLICA-SE A: todas as camadas do API Management

Este início rápido descreve como usar um arquivo Bicep para criar uma instância de Azure API Management. Você também pode usar o Bicep para tarefas de gerenciamento comuns, como importar APIs em sua instância de API Management.

Azure API Management ajuda as organizações a publicar APIs em desenvolvedores externos, parceiros e internos para desbloquear o potencial de seus dados e serviços. API Management fornece as principais competências para garantir um programa de API bem-sucedido por meio do envolvimento do desenvolvedor, insights de negócios, análise, segurança e proteção. Com API Management, crie e gerencie gateways de API modernos para serviços de back-end existentes hospedados em qualquer lugar.

Bicep é uma DSL (linguagem específica do domínio) que usa sintaxe declarativa para implantar recursos Azure. Ele fornece sintaxe concisa, segurança de tipos confiável e suporte para reutilização de código. O Bicep oferece a melhor experiência de criação para suas soluções de infraestrutura como código em Azure.

Pré-requisitos

Examinar o arquivo Bicep

O arquivo Bicep usado neste início rápido é proveniente dos Modelos de início rápido do Azure.

@description('The name of the API Management service instance')
param apiManagementServiceName string = 'apiservice${uniqueString(resourceGroup().id)}'

@description('The email address of the owner of the service')
@minLength(1)
param publisherEmail string

@description('The name of the owner of the service')
@minLength(1)
param publisherName string

@description('The pricing tier of this API Management service')
@allowed([
  'Consumption'
  'Developer'
  'Basic'
  'Basicv2'
  'Standard'
  'Standardv2'
  'Premium'
])
param sku string = 'Developer'

@description('The instance size of this API Management service.')
@allowed([
  0
  1
  2
])
param skuCount int = 1

@description('Location for all resources.')
param location string = resourceGroup().location

resource apiManagementService 'Microsoft.ApiManagement/service@2023-05-01-preview' = {
  name: apiManagementServiceName
  location: location
  sku: {
    name: sku
    capacity: skuCount
  }
  properties: {
    publisherEmail: publisherEmail
    publisherName: publisherName
  }
}

O seguinte recurso é definido no arquivo Bicep:

Neste exemplo, o arquivo Bicep, por padrão, configura a instância API Management na camada Desenvolvedor, uma opção econômica para avaliar Azure API Management. Essa camada não é para uso em produção.

Mais amostras de Azure API Management Bicep podem ser encontradas nos modelos de início rápido do Azure.

Implante o arquivo Bicep

Você pode usar Azure CLI ou Azure PowerShell para implantar o arquivo Bicep. Para obter mais informações sobre como implantar arquivos Bicep, consulte Implantar arquivos Bicep usando o Azure CLI.

  1. Salve o arquivo Bicep como main.bicep em seu computador local.

  2. Implante o arquivo Bicep usando Azure CLI ou Azure PowerShell.

    Substitua <publisher-name> e <publisher-email> pelo nome da sua organização e seu endereço de email para receber notificações.

    az group create --name exampleRG --location eastus

az deployment group create --resource-group exampleRG --template-file main.bicep --parameters publisherEmail=<publisher-email> publisherName=<publisher-name>

    Quando a implantação for concluída, você deverá ver uma mensagem indicando que ela foi bem-sucedida.

    Dica

    Pode levar entre 30 e 40 minutos para criar e ativar um serviço API Management na camada Desenvolvedor. Os horários variam de acordo com a camada.

Examinar os recursos implantados

Use o Azure portal, Azure CLI ou Azure PowerShell para listar o recurso de App Configuration implantado no grupo de recursos.

az resource list --resource-group exampleRG

Quando sua instância de serviço API Management estiver online, você estará pronto para usá-la. Comece com o tutorial para importar e publicar sua primeira API.

Limpar os recursos

Se você planeja continuar trabalhando com tutoriais subsequentes, é interessante manter a instância do Gerenciamento de API onde está. Quando não for mais necessário, exclua o grupo de recursos, que excluirá os recursos no grupo de recursos.

az group delete --name exampleRG

Próxima etapa

Tutorial: Importar e publicar sua primeira API

  • Last updated on