Aracı SDK'sı (Önizleme)

Bot Framework / Microsoft Aracıları SDK Etkinlik yüklerini kullanıcı tarafından sağlanan aracı uç noktasına iletir. Aracı uç noktası URL'si çağrı başına giriş parametresi olarak sağlanır. Bağlantı oluşturulurken kimlik doğrulaması seçilir: kimlik doğrulaması yok, statik API anahtarı veya Microsoft Entra ID OAuth (client_credentials). OAuth seçildiğinde taşıyıcı belirteç hedef kitlesinin (bağlantıda yapılandırılan Kaynak URL'si) hedef aracı tarafından beklenen hedef kitleyle eşleşmesi gerekir.

Bu bağlayıcı aşağıdaki ürün ve bölgelerde kullanılabilir:

Hizmet Class Regions
Copilot Studio Standart Aşağıdakiler dışında tüm Power Automate bölgeleri:
     - ABD Kamu (GCC)
     - US Government (GCC High)
     - 21Vianet tarafından işletilen Çin Bulutu
     - ABD Savunma Bakanlığı (DoD)
Logic Apps Standart Aşağıdakiler dışında tüm Logic Apps bölgeleri :
     - Azure Kamu bölgeleri
     - Azure Çin bölgeleri
     - ABD Savunma Bakanlığı (DoD)
Power Apps Standart Aşağıdakiler dışında tüm Power Apps bölgeleri:
     - ABD Kamu (GCC)
     - US Government (GCC High)
     - 21Vianet tarafından işletilen Çin Bulutu
     - ABD Savunma Bakanlığı (DoD)
Power Automate Standart Aşağıdakiler dışında tüm Power Automate bölgeleri:
     - ABD Kamu (GCC)
     - US Government (GCC High)
     - 21Vianet tarafından işletilen Çin Bulutu
     - ABD Savunma Bakanlığı (DoD)
Contact
İsim Microsoft
URL https://support.microsoft.com
Bağlayıcı Meta Verileri
Publisher Microsoft
Web Sitesi https://www.microsoft.com
Gizlilik ilkesi https://privacy.microsoft.com/
Kategoriler Verimli -lik

Aracı SDK bağlayıcısı, Bot Framework /Microsoft Aracılar SDK Etkinlik yüklerini kullanıcı tarafından sağlanan aracı uç noktasına iletir. Aracı uç noktası URL'si çağrı başına giriş parametresi olarak sağlanır; OAuth belirteçleri, platform tarafından kullanıcı tarafından sağlanan Microsoft Entra ID bağlantıda yapılandırılan uygulama kimlik bilgileriyle oluşturulur ve her giden isteğe Taşıyıcı belirteci olarak eklenir. Taşıyıcı belirteci hedef kitlesi (bağlantıda yapılandırılan Kaynak URL'si), hedef aracı tarafından beklenen hedef kitleyle eşleşmelidir.

Prerequisites

  • DAĞıTılan Microsoft Aracıları SDK'sı / Bot Framework aracısı HTTPS üzerinden erişilebilir.
  • Aracıyı barındıran kiracıda kayıtlı, hedef aracıyı çağırma izni ve izniyle client_credentials yapılandırılmış bir Microsoft Entra ID uygulaması.
  • Aracının beklenen belirteç hedef kitlesi (genellikle aracının Microsoft Uygulama Kimliği, örneğin api://<appId>).

Kimlik bilgilerinizi alma

API isteklerinizin kimliğini doğrulamak için şunları yapmanız gerekir:

  1. Microsoft Entra ID uygulamasının Kiracı Kimliği.
  2. Microsoft Entra ID uygulamasının İstemci Kimliği (Uygulama Kimliği).
  3. Bu uygulama için İstemci Gizli Anahtarı .
  4. Hedef aracı tarafından beklenen hedef kitleyle eşleşen Kaynak URL'si (Bot Framework beceri kimlik doğrulaması deseni).

Bağlantı oluştururken bu değerleri sağlayın. hedef kitleler farklıysa aracı başına bir bağlantı oluşturun.

Bilinen sorunlar ve sınırlamalar

  • Giriş agentEndpoint tam bir HTTPS URL'si olmalıdır (örneğin, https://my-agent.azurewebsites.net). Bağlayıcı Etkinlik yükünü ekler /api/messages ve iletir.
  • Bağlayıcı Etkinlik yükü as-is iletir ve ayarlanmaz deliveryMode. Aracı, yanıt etkinliklerini gelen etkinlikte sağlanana geri serviceUrl göndererek zaman uyumsuz (normal teslim) yanıtlar (örneğin, Microsoft Copilot Studio, SAS anahtarlı bir geri serviceUrlçağırma sağlar).
  • Bu bağlayıcı önizleme aşamasındadır. Kullanılabilirlik ve özellikler değiştirilebilir.

Bağlantı oluşturma

Bağlayıcı aşağıdaki kimlik doğrulama türlerini destekler:

API anahtarı Özel bir HTTP üst bilgisinde hedef aracının beklediği statik BIR API anahtarıyla kimlik doğrulaması yapın. Hem üst bilgi adını (örneğin, x-api-key) hem de değerini belirtin. Tüm bölgeler Paylaşılamaz
Microsoft Entra ID (istemci kimlik bilgileri) client_credentials akışını kullanan bir Microsoft Entra ID uygulamasından nane OAuth taşıyıcı belirteçleri. Taşıyıcı belirteç hedef kitlesi (Kaynak URL'si), hedef aracı tarafından beklenen hedef kitleyle eşleşmelidir. Tüm bölgeler Paylaşılamaz
Kimlik doğrulaması yok Herhangi bir kimlik doğrulama üst bilgisi olmadan hedef aracı uç noktasını çağırın. Bunu yalnızca anonim çağrıları açıkça kabul eden aracılarla kullanın. Tüm bölgeler Paylaşılabilir
Varsayılan [KULLANIM DIŞI] Bu seçenek yalnızca açık kimlik doğrulama türü olmayan eski bağlantılar içindir ve yalnızca geriye dönük uyumluluk için sağlanır. Tüm bölgeler Paylaşılamaz

API anahtarı

Kimlik Doğrulama Kimliği: apiKey

Geçerli: Tüm bölgeler

Özel bir HTTP üst bilgisinde hedef aracının beklediği statik BIR API anahtarıyla kimlik doğrulaması yapın. Hem üst bilgi adını (örneğin, x-api-key) hem de değerini belirtin.

Bu, paylaşılabilir bir bağlantı değildir. Power app başka bir kullanıcıyla paylaşılıyorsa, başka bir kullanıcıdan açıkça yeni bağlantı oluşturması istenir.

İsim Türü Description Zorunlu
API anahtarı üst bilgi adı string Hedef aracının API anahtarını beklediği HTTP üst bilgisinin adı (örneğin, x-api-key veya Ocp-Apim-Subscription-Key). True
API anahtar değeri securestring Hedef aracı uç noktasına gönderilen her istekte gönderilen statik API anahtar değeri. True

Microsoft Entra ID (istemci kimlik bilgileri)

Kimlik Doğrulama Kimliği: oauthClientCredentials

Geçerli: Tüm bölgeler

client_credentials akışını kullanan bir Microsoft Entra ID uygulamasından nane OAuth taşıyıcı belirteçleri. Taşıyıcı belirteç hedef kitlesi (Kaynak URL'si), hedef aracı tarafından beklenen hedef kitleyle eşleşmelidir.

Bu, paylaşılabilir bir bağlantı değildir. Power app başka bir kullanıcıyla paylaşılıyorsa, başka bir kullanıcıdan açıkça yeni bağlantı oluşturması istenir.

İsim Türü Description Zorunlu
Tenant string Microsoft Entra ID uygulamasının kiracı kimliği True
Müşteri Kimliği string Microsoft Entra ID uygulamasının istemci (veya uygulama) kimliği. True
İstemci Parolası securestring Microsoft Entra ID uygulamasının istemci gizli dizisi. True
Kaynak URL string OAuth belirtecinin hedef kitlesi. Genellikle hedef aracının Microsoft Uygulama Kimliği (örneğin, api://< appId> veya Uygulama Kimliği GUID'si). True

Kimlik doğrulaması yok

Kimlik Doğrulama Kimliği: anonim

Geçerli: Tüm bölgeler

Herhangi bir kimlik doğrulama üst bilgisi olmadan hedef aracı uç noktasını çağırın. Bunu yalnızca anonim çağrıları açıkça kabul eden aracılarla kullanın.

Bu, paylaşılabilir bir bağlantıdır. Power app başka bir kullanıcıyla paylaşılıyorsa, bağlantı da paylaşılır. Daha fazla bilgi için bkz. tuval uygulamaları için Connectors'a genel bakış - Power Apps | Microsoft Docs

Varsayılan [KULLANIM DIŞI]

Geçerli: Tüm bölgeler

Bu seçenek yalnızca açık kimlik doğrulama türü olmayan eski bağlantılar içindir ve yalnızca geriye dönük uyumluluk için sağlanır.

Bu, paylaşılabilir bir bağlantı değildir. Power app başka bir kullanıcıyla paylaşılıyorsa, başka bir kullanıcıdan açıkça yeni bağlantı oluşturması istenir.

Eylemler

Aracıya etkinlik gönderme

Etkinlik Protokolü yükünü {agentEndpoint}/api/messages konumundaki aracı uç noktasına iletir. Bağlantı Microsoft Entra ID OAuth kullandığında, belirteç hedef kitlesi (bağlantıdaki Kaynak URL'si) hedef aracı tarafından beklenen hedef kitleye eşit olmalıdır (Bot Framework beceri kimlik doğrulaması düzeni); hedef kitleler farklıysa aracı başına bir bağlantı oluşturun. Bağlayıcı Etkinlik yükünü as-is iletir ve 'deliveryMode' öğesini ayarlamaz; aracı, gelen etkinlikte sağlanan 'serviceUrl' öğesine yanıt etkinlikleri sunarak zaman uyumsuz (normal teslim) yanıtlar.

Aracıya etkinlik gönderme

Etkinlik Protokolü yükünü {agentEndpoint}/api/messages konumundaki aracı uç noktasına iletir. Bağlantı Microsoft Entra ID OAuth kullandığında, belirteç hedef kitlesi (bağlantıdaki Kaynak URL'si) hedef aracı tarafından beklenen hedef kitleye eşit olmalıdır (Bot Framework beceri kimlik doğrulaması düzeni); hedef kitleler farklıysa aracı başına bir bağlantı oluşturun. Bağlayıcı Etkinlik yükünü as-is iletir ve 'deliveryMode' öğesini ayarlamaz; aracı, gelen etkinlikte sağlanan 'serviceUrl' öğesine yanıt etkinlikleri sunarak zaman uyumsuz (normal teslim) yanıtlar.

Parametreler

Name Anahtar Gerekli Tür Description
Aracı uç noktası URL'si
agentEndpoint True string

Hedef Microsoft Aracıları SDK'sının / Bot Framework uç noktasının temel URL'si (örneğin, https://my-agent.azurewebsites.net). Bağlayıcı /api/messages ekler.

object

Döndürülenler

response
object

Tanımlar

Obje

Bu , 'object' türüdür.