Hızlı Başlangıç: Bicep kullanarak yeni bir Azure API Management örneği oluşturma

APPLIES TO: Tüm API Yönetimi katmanları

Bu hızlı başlangıçta Azure API Management örneği oluşturmak için Bicep dosyasının nasıl kullanılacağı açıklanmaktadır. Bicep'i API Management örneğinizdeki API'leri içeri aktarma gibi yaygın yönetim görevleri için de kullanabilirsiniz.

Azure API Management kuruluşların veri ve hizmetlerinin potansiyelini ortaya çıkarmaları için api'leri dış, iş ortağı ve iç geliştiricilere yayımlamasına yardımcı olur. API Management geliştirici katılımı, iş içgörüleri, analiz, güvenlik ve koruma aracılığıyla başarılı bir API programı sağlamak için temel yetkinlikler sağlar. API Management ile her yerde barındırılan mevcut arka uç hizmetleri için modern API ağ geçitleri oluşturun ve yönetin.

Bicep Azure kaynaklarını dağıtmak için bildirim temelli söz dizimi kullanan etki alanına özgü bir dildir (DSL). Kısa sözdizimi, güvenilir tür güvenliği ve kod yeniden kullanımı için destek sağlar. Bicep, Azure kod olarak altyapı çözümleriniz için en iyi yazma deneyimini sunar.

Önkoşullar

• Azure aboneliğiniz yoksa başlamadan önce free hesabı oluşturun.

• Azure CLI için:

  • bash ortamını Azure Cloud Shell kullanın. Daha fazla bilgi için bkz. Azure Cloud Shell ile Başlarken.

    

  • CLI referans komutlarını yerel olarak çalıştırmayı tercih ediyorsanız, Azure CLI'yi yükleyin. Windows veya macOS üzerinde çalıştırıyorsanız, Azure CLI bir Docker kapsayıcısında çalıştırmayı göz önünde bulundurun. Daha fazla bilgi için bkz. Docker kapsayıcısında Azure CLI çalıştırma.

    • Yerel yükleme kullanıyorsanız az login komutunu kullanarak Azure CLI oturum açın. Kimlik doğrulama işlemini tamamlamak için terminalinizde görüntülenen adımları izleyin. Diğer oturum açma seçenekleri için bkz. Azure CLI kullanarak Azure'a Kimlik Doğrulama.

    • İstendiğinde, ilk kullanımda Azure CLI uzantısını yükleyin. Uzantılar hakkında daha fazla bilgi için bkz. Azure CLI ile uzantıları kullanma ve yönetme.

    • Yüklü sürümü ve bağımlı kitaplıkları bulmak için az version komutunu çalıştırın. En son sürüme yükseltmek için az upgrade çalıştırın.

• Azure PowerShell için:

  • Azure PowerShell yerel olarak kullanmayı seçerseniz:
    • Az PowerShell modülünün en son sürümünü yükleyin.
    • Connect-AzAccount cmdlet'ini kullanarak Azure hesabınıza bağlanın.
  • Azure Cloud Shell kullanmayı seçerseniz:
    • Daha fazla bilgi için bkz. Azure Cloud Shell'e Genel Bakış.

Bicep dosyasını gözden geçirme

Bu hızlı başlangıçta kullanılan Bicep dosyası Azure hızlı başlangıç şablonları'dan alınmıştı.

@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
  }
}

Aşağıdaki kaynak Bicep dosyasında tanımlanır:

• Microsoft.ApiManagement/service

Bu örnekte, Bicep dosyası varsayılan olarak Geliştirici katmanındaki API Management örneğini yapılandırarak Azure API Management değerlendirmek için ekonomik bir seçenektir. Bu katman üretim kullanımı için değildir.

daha fazla Azure API Management Bicep örneğine Azure hızlı başlangıç şablonlarınde ulaşabilirsiniz.

Bicep dosyasını dağıtın

bicep dosyasını dağıtmak için Azure CLI veya Azure PowerShell kullanabilirsiniz. Bicep dosyalarını dağıtma hakkında daha fazla bilgi için Azure CLI ile Bicep Dosyalarını Dağıtın sayfasına bakın.

1. Bicep dosyasını main.bicep olarak yerel bilgisayarınıza kaydedin.

2. Azure CLI veya Azure PowerShell kullanarak Bicep dosyasını dağıtın.

   <publisher-name> ve <publisher-email> yerine kuruluşunuzun adını ve bildirimleri almak için e-posta adresinizi yazın.

   • CLI
   • PowerShell

   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>
   

   Dağıtım tamamlandığında, dağıtımın başarılı olduğunu belirten bir ileti görmeniz gerekir.

   İpucu

   Geliştirici katmanında bir API Management hizmeti oluşturmak ve etkinleştirmek 30 ila 40 dakika arasında sürebilir. Süreler katmana göre değişir.

Dağıtılan kaynakları gözden geçirme

Kaynak grubundaki dağıtılan App Configuration kaynağını listelemek için Azure portal, Azure CLI veya Azure PowerShell kullanın.

az resource list --resource-group exampleRG

Get-AzResource -ResourceGroupName exampleRG

API Management hizmet örneğiniz çevrimiçi olduğunda kullanmaya hazır olursunuz. İlk API'nizi içeri aktarma ve yayımlama öğreticisiyle başlayın.

Kaynakları temizleme

Sonraki öğreticilerle çalışmaya devam etmek istiyorsanız, API Management örneğini yerinde bırakmak isteyebilirsiniz. Artık gerekli olmadığında kaynak grubunu silin; bu da kaynak grubundaki kaynakları siler.

az group delete --name exampleRG

Remove-AzResourceGroup -Name exampleRG

Sonraki adım