Ler em inglês

Compartilhar via

Início rápido: Criar uma instância de serviço do Gerenciamento de API do Azure usando Bicep

  • Artigo

APLICA-SE A: todas as camadas do Gerenciamento de API

Este início rápido descreve como usar um arquivo Bicep para criar uma instância do Gerenciamento de API do Azure. Você também pode usar o Bicep para tarefas 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.

O Bicep é um DSL (linguagem específica de domínio) que usa sintaxe declarativa para implantar recursos do 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 no Azure.

Pré-requisitos

Examinar o arquivo Bicep

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

Bicep 
@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, por padrão, o arquivo Bicep configura a instância de Gerenciamento de API 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.

Encontre mais amostras Bicep de Gerenciamento de API do Azure nos Modelos de Início Rápido do Azure.

Implante o arquivo Bicep

Use a CLI do Azure ou o Azure PowerShell para implantar o arquivo Bicep. Para obter mais informações sobre como implantar arquivos Bicep, consulte Implantar.

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

  2. Para implantar o arquivo Bicep, use a CLI do Azure ou o Azure PowerShell.

    CLI do Azure 
    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>

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

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

    Dica

    A criação e a ativação de um serviço de Gerenciamento de API nessa camada Desenvolvedor leva de 30 a 40 minutos. Os horários variam de acordo com a camada.

Examinar os recursos implantados

Use o portal do Azure, a CLI do Azure ou o Azure PowerShell para listar os recursos de Configuração de Aplicativos implantados no grupo de recursos.

CLI do Azure 
az resource list --resource-group exampleRG

Quando sua instância de serviço de Gerenciamento de API 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.

CLI do Azure 
az group delete --name exampleRG

Próximas etapas

Tutorial: Importar e publicar sua primeira API