Azure API Management'ta çalışma alanı oluşturma ve yönetme

ŞUNLAR IÇIN GEÇERLIDIR: Temel v2 | Standart v2 | Premium | Premium v2

API ekibinin kendi API'lerini yönetmesine ve ürün oluşturmasına olanak tanımak için bir çalışma alanı ayarlayın ve API platformu ekibine API Management platformunu gözlemleme, yönetme ve sürdürme araçlarını sağlayın. Çalışma alanı oluşturup izinleri atadıktan sonra, çalışma alanı ortak çalışanları kendi API'lerini, ürünlerini, aboneliklerini ve ilgili kaynaklarını oluşturabilir ve yönetebilir.

Note

  • New! Çalışma alanları özelliği artık Premium ve Premium v2 katmanlarına ek olarak Temel v2 ve Standart v2 katmanlarında da kullanılabilir. v2 katmanlarındaki çalışma alanları, varsayılan API Management yönetilen ağ geçidi veya ayrı bir çalışma alanı ağ geçidi kaynağıyla ilişkilendirilebilir ve çalışma alanlarınızı yapılandırma ve ölçeklendirme konusunda esneklik sağlar. Çalışma alanları katman desteği yol haritası hakkında bilgi için blog gönderisine bakın.
  • Fiyatlandırma konusunda dikkat edilmesi gerekenler için bkz . API Management fiyatlandırması.

Aşağıdakiler için bu makaledeki adımları izleyin:

  • Örneğin varsayılan yönetilen ağ geçidiyle veya yeni veya mevcut bir çalışma alanı ağ geçidiyle ilişkilendirilmiş bir API Management çalışma alanı oluşturun.
  • İsteğe bağlı olarak, Azure sanal ağdaki bir çalışma alanı ağ geçidini yalıtabilirsiniz.
  • Çalışma alanına izinler atayın.

Note

  • Şu anda çalışma alanı ağ geçidi oluşturmak uzun süre çalışan ve tamamlanması üç saat veya daha uzun sürebilen bir işlemdir.
  • Birden çok çalışma alanını çalışma alanı ağ geçidiyle ilişkilendirme yalnızca 15 Nisan 2025'in ardından oluşturulan çalışma alanı ağ geçitleri için kullanılabilir. Paylaşılan çalışma alanı ağ geçitleri hakkında daha fazla bilgi edinin.

Prerequisites

  • Api Management örneği. Bir tane gerekiyorsa, desteklenen bir katmanda oluşturun.
  • API Management örneğinin dağıtıldığı kaynak grubunda Sahip veya Katkıda Bulunan rolü veya bu kaynak grubunda kaynak oluşturma yetkisine eşdeğer izinlere sahip olma.
  • (İsteğe bağlı) Çalışma alanı ağ geçidinin gelen ve giden trafiğini yalıtmak için yeni veya mevcut Azure sanal ağdaki bir alt ağ. Yapılandırma seçenekleri ve gereksinimleri için bkz . Çalışma alanı ağ geçitleri için ağ kaynağı gereksinimleri.
  • (varsayılan yönetilen ağ geçidini bir çalışma alanıyla ilişkilendirmek için isteğe bağlı) API Management REST API'sini çağırmak için bir REST istemcisi.

Çalışma alanı oluşturma ve varsayılan yönetilen ağ geçidini ilişkilendirme - REST API

API trafiğini bir çalışma alanı ağ geçidi yerine hizmetin varsayılan yönetilen ağ geçidi üzerinden yönlendiren bir çalışma alanı oluşturabilirsiniz. Bu seçenek, ayrı bir ağ geçidi kaynağının ek maliyetini ve karmaşıklığını önler. API trafiği, hizmetin varsayılan ana bilgisayar adı üzerinden (örneğin, <service-name>.azure-api.net) yönlendirir.

Note

Şu anda, bir çalışma alanı oluşturmak ve varsayılan yönetilen ağ geçidini ilişkilendirmek yalnızca v2 katmanlarında ve API Management REST API aracılığıyla desteklenmektedir.

Çalışma alanı oluşturmak için Çalışma Alanı - REST API'sini Oluşturma veya Güncelleştirme'yi kullanın.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}?api-version=2024-05-01
Authorization: Bearer {token}
Content-Type: application/json

{
  "properties": {
    "displayName": "my workspace",
    "description": "Workspace using default managed gateway",
    "serveOn": "workspaceAndDefault"
  }
}

Replace:

  • {subscriptionId} Azure abonelik kimliğiniz ile
  • {resourceGroupName} API Management örneğinizin kaynak grubu adıyla
  • {serviceName} API Management örneğinizin adıyla
  • {workspaceId}, benzersiz bir çalışma alanı tanımlayıcısıyla (harf ve rakamlardan oluşan, kısa çizgi kullanılabilir)

Başarılı bir yanıt, çalışma alanı kaynağıyla HTTP 201 Created döndürür. Varsayılan olarak, çalışma alanı API trafiğini hizmetin varsayılan ana bilgisayar adı üzerinden yönlendirir.

Çalışma alanı oluşturulduktan sonra, erişim izinlerini yapılandırmak için Kullanıcıları çalışma alanına atama - portal bölümüne geçin.

Çalışma alanı oluşturma ve çalışma alanı ağ geçidini ilişkilendirme - portal

  1. Azure portalında oturum açın ve API Management örneğine gidin.

  2. Soldaki menüde, API'ler altında Çalışma Alanları

  3. Temel Bilgiler sekmesinde, çalışma alanı için açıklayıcı bir Görünen ad, kaynak Adı ve isteğe bağlı bir Açıklama girin. sonrakiseçin.

  4. Ağ Geçidi sekmesinde, çalışma alanı ağ geçidi ayarlarını yapılandırın.

    Portalda çalışma alanı ağ geçidi oluşturma işleminin ekran görüntüsü.

    • Yeni bir çalışma alanı ağ geçidi oluşturmak için Yeni oluştur veya başka çalışma alanlarının dağıtıldığı mevcut bir ağ geçidiyle çalışma alanını ilişkilendirmek için Var olanı kullan seçin.

    • Yeni bir ağ geçidi oluşturmayı seçerseniz:

      • Ağ geçidi ayrıntıları bölümünde yeni bir ağ geçidi adı girin ve ölçek Birimi sayısını seçin. Ağ geçidi maliyetleri birim sayısına bağlıdır. Daha fazla bilgi için bkz . API Management fiyatlandırması.

      • bölümünde çalışma alanı ağ geçidiniz için bir Ağ yapılandırması seçin.

        Important

        Çalışma alanınızın ağ yapılandırmasını dikkatlice planlayın. Çalışma alanını oluşturduktan sonra ağ yapılandırmasını değiştiremezsiniz.

      • Gelen genel erişim, giden özel erişim (sanal ağ tümleştirmesi) veya Gelen özel erişim, giden özel erişim (sanal ağ ekleme) seçeneklerini seçerseniz, çalışma alanı ağ geçidini yalıtmak için bir Sanal ağ ve Alt ağ seçin veya yeni bir ağ oluşturun. Ağ gereksinimleri için bkz . Çalışma alanı ağ geçitleri için ağ kaynağı gereksinimleri.

  5. sonrakiseçin. Doğrulama tamamlandıktan sonra Oluştur'u seçin.

    Note

    Seçiliyse yeni bir çalışma alanı ağ geçidi oluşturma işleminin tamamlanması birkaç saat kadar sürebilir. Azure portalında dağıtım ilerleme durumunu izlemek için ağ geçidinin kaynak grubuna gidin. Soldaki menüde, Ayarlar'ın altında Dağıtımlar'ı seçin.

Dağıtım tamamlandıktan sonra, yeni çalışma alanı Çalışma Alanları sayfasındaki listede görünür. Ayarlarını ve kaynaklarını yönetmek için çalışma alanını seçin.

Note

  • Ağ geçidi çalışma zamanı ana bilgisayar adını ve diğer ağ geçidi ayrıntılarını görüntülemek için portalda çalışma alanını seçin. Dağıtım ve altyapı altında Ağ Geçitleri'ni seçin ve çalışma alanının ağ geçidinin adını seçin.
  • Çalışma alanı ağ geçidi oluşturulurken, çalışma alanının API'lerine çalışma zamanında yapılan çağrılar başarısız olur.

Çalışma alanına kullanıcı atama - portal

Çalışma alanı oluşturduktan sonra, çalışma alanının kaynaklarını yönetmek için kullanıcılara izinler atayın. Her çalışma alanı kullanıcılarına hem hizmet kapsamlı çalışma alanı RBAC rolü hem de çalışma alanı kapsamlı RBAC rolü atanmalı veya özel roller kullanılarak eşdeğer izinler verilmelidir.

Çalışma alanı bir çalışma alanı ağ geçidi kaynağı kullanıyorsa, çalışma alanı kullanıcılarına çalışma alanı ağ geçidiyle sınırlı Azure tarafından sağlanan bir RBAC rolü de atayın.

Note

Daha kolay yönetim için Microsoft Entra gruplarını birden çok kullanıcıya çalışma alanı izinleri atayacak şekilde ayarlayın.

  • Yerleşik çalışma alanı rollerinin listesi için, API Management'ta rol tabanlı erişim denetimini kullanma konusuna bkz.
  • Rol atama adımları için Portalı kullanarak Azure rolleri atama başlığına bakın.

Belirli bir hizmet alanına özel bir rol atama

  1. Azure portalında oturum açın ve API Management örneğine gidin.

  2. Sol menüde Erişim denetimi (IAM)

  3. Çalışma alanının her üyesine aşağıdaki hizmet kapsamlı rollerden birini atayın:

    • API Management Hizmeti Çalışma Alanı API Geliştiricisi
    • API Management Hizmeti Çalışma Alanı API Ürün Yöneticisi

Çalışma alanı bazlı bir rol atama

  1. API Management örneğinizin menüsünde, API'ler altında

  2. Çalışma Alanı penceresinde Erişim denetimi (IAM).

  3. Çalışma alanı API'lerini ve diğer kaynakları yönetebilmeleri için çalışma alanı kapsamındaki aşağıdaki rollerden birini çalışma alanı üyelerine atayın:

    • API Management Çalışma Alanı Okuyucusu
    • API Management Çalışma Alanı Katılımcısı
    • API Management Çalışma Alanı API Geliştiricisi
    • API Management Çalışma Alanı API Ürün Yöneticisi

Geçit kapsamına sahip bir rol atama

  1. Azure portalında oturum açın ve API Management örneğine gidin.

  2. Soldaki menüde, API'ler'in altında

  3. Çalışma alanının sol menüsünde Ağ Geçitleri'ni ve çalışma alanı ağ geçidini seçin.

  4. Sol menüde Erişim denetimi (IAM)

  5. Çalışma alanının her üyesine aşağıdaki rollerden birini atayın. Ağ geçidi ayarlarını görüntülemek için en azından Okuyucu rolünü atayın. Sahipler ve Katkıda Bulunanlar , ağ geçidini ölçeklendirme de dahil olmak üzere ağ geçidi ayarlarını yönetebilir.

    • Owner
    • Contributor
    • Reader

Çalışma alanı API'lerini izlemek için tanılama ayarlarını etkinleştirme

Çalışma alanı için Azure İzleyici günlükleri toplamak ve bunları bir Log Analytics çalışma alanına göndermek için ayarları yapılandırın. Çalışma alanı ekibi kendi API'lerini izleyebilirken, API platformu ekibi API Management örneği için merkezi günlüklere erişebilir. Aşağıdaki diyagrama bakın:

API Yönetiminde federasyon kaydı diyagramı.

Çalışma alanının Azure İzleyici günlüklerini toplamak için hem hizmet hem de çalışma alanı düzeylerinde tanılama ayarlarına ihtiyacınız vardır:

  1. İlk olarak, bir ayar henüz etkinleştirilmemişse API Management ağ geçidi günlüklerinin toplanması için hizmet düzeyinde bir tanılama ayarını etkinleştirin. Günlükleri Log Analytics çalışma alanına gönderme. Daha fazla bilgi için bkz . API Management için tanılama ayarlarını yapılandırma.

  2. Ardından, API Management ağ geçidi günlüklerini aynı Log Analytics çalışma alanına göndermek için workspace düzeyinde bir tanılama ayarını etkinleştirin. Bu ayar, çalışma alanıyla ilişkili tüm çalışma alanı ağ geçitleri için günlükleri toplar.

    Important

    Hizmet düzeyindeki bir tanılama ayarı, çalışma alanı düzeyinde tanılama ayarının etkinleştirildiği çalışma alanları da dahil olmak üzere API Management örneği genelinde günlüğe kaydetmeyi yapılandırmaktadır. Çalışma alanı düzeyinde bir tanılama ayarını etkinleştirmezseniz, çalışma alanının ağ geçidi günlükleri toplanmaz veya Log Analytics’te birleştirilmez.

    Note

    Varsayılan olarak, yerleşik çalışma alanı RBAC rollerine atanan çalışma alanı ekibinin üyelerinin çalışma alanında tanılama ayarlarını düzenleme izinleri yoktur. API platformu ekibi bu izinlere sahiptir.

Çalışma alanı düzeyinde ağ geçidi günlüklerinin toplanması için bir çalışma alanı tanılama ayarı yapılandırmak için:

  1. Azure portalında oturum açın ve API Management örneğine gidin.

  2. Soldaki menüde, API'ler'in altında

  3. Çalışma alanlarının sol menüsündeki İzleme'nin altında Tanılama ayarları>+ Tanılama ayarı ekle'yi seçin.

  4. Tanılama ayarı bölümünde, ayara ilişkin ayrıntıları girin veya seçin:

    1. Tanılama ayarı adı: Açıklayıcı bir ad girin.
    2. Kategori grupları: İsteğe bağlı olarak senaryonuz için bir seçim yapın.
    3. Kategoriler'in altında ApiManagement Ağ Geçidi ile ilgili günlükler'i seçerek bu çalışma alanında API'ler için ağ geçidi günlüklerini toplayın.
    4. Hedef ayrıntıları'nın altında, günlükleri, hizmet düzeyi tanılama ayarında ve diğer çalışma alanı düzeyindeki tanılama ayarlarında belirtilen aynı Azure Log Analytics çalışma alanına göndermek için seçin.
    5. Kaydetseçeneğini seçin.

Note

  • Şu anda yalnızca çalışma alanları için ağ geçidi günlüklerini toplayabilirsiniz.
  • Çalışma alanının sol menüsündeki İzleme>Günlükleri'ne giderek çalışma alanı düzeyinde günlüklere erişebilirsiniz.

Çalışma alanınızı kullanmaya başlama

Çalışma alanındaki rollerine bağlı olarak, kullanıcıların API'ler, ürünler, abonelikler ve diğer kaynaklar oluşturma izinleri olabilir veya bu kaynakların bazılarına veya tümüne salt okunur erişimleri olabilir.

Bir çalışma alanında API'leri yönetmeye, korumaya ve yayımlamaya başlamak için aşağıdaki kılavuza bakın.

Resource Guide
APIs Öğretici: İlk API’nizi içeri aktarma ve yayımlama
Products Kılavuz: Bir ürün oluşturma ve yayımlama
Subscriptions Azure API Management'ta abonelikler

API Management'ta abonelik oluşturma
Policies Öğretici: API'nizi dönüştürme ve koruma

Azure API Management ilkeleri

API Management ilkelerini ayarlama veya düzenleme
Adlandırılmış değerler Adlandırılmış değerleri kullanarak gizli bilgileri yönet
Backends Azure API Management'ta arka uçları kullanma
İlke parçaları API Management ilke tanımlarınızda ilke yapılandırmalarını yeniden kullanma
Schemas İçeriği doğrulama
Groups Geliştirici hesaplarını yönetmek için grup oluşturma ve kullanma
Notifications Bildirimleri ve bildirim şablonlarını yapılandırma