Azure İşlevleri için Azure Web PubSub tetikleyicisi ve bağlamaları

Bu başvuru, Azure İşlevleri'da Web PubSub olaylarının nasıl işleneceğini açıklar.

Web PubSub, geliştiricilerin gerçek zamanlı özellikler ve yayımlama-abone olma düzeniyle kolayca web uygulamaları oluşturmalarına yardımcı olan Azure tarafından yönetilen bir hizmettir.

Eylem	Tür
İletiler hizmetten geldiğinde işlev çalıştırma	Tetikleyici bağlama
Anlaşma ve yukarı akış istekleri için HTTP tetikleyicisi altında hedef nesneye bağlama isteği	Giriş bağlaması
Hizmeti çağır ve eylemleri gerçekleştir	Çıkış bağlaması

Kaynak kodu | Paket | API'si başvuru belgeleri | Ürün belgeleri Örnekleri |

İşlev uygulamanıza ekleme

Tetikleyici ve bağlamalarla çalışmak için uygun pakete başvurmanız gerekir. NuGet paketi .NET sınıf kitaplıkları için kullanılırken, diğer tüm uygulama türleri için bir uzantı paketi kullanılır.

Dil	Göre Ekle...
C# (programlama dili)	NuGet paketini yükleme, belirli bir sürümü hedefleme
JavaScript, Python, PowerShell, C# betiği (Azure portalına özel)	Uzantı paketlerini kullanma (önerilen), uzantıları açıkça yükleme

Temel kavramlar

İşlev Uygulamaları ile çalışan Azure Web PubSub hizmetinin iş akışını gösteren diyagram.

(1)-(2) WebPubSubConnection istemci bağlantısını oluşturmak için HttpTrigger kullanarak giriş bağı.

(3)-(4) WebPubSubTrigger hizmet isteğini işlemek için HttpTrigger ile bağlamayı veya WebPubSubContext giriş bağlamasını tetikler.

(5)-(6) WebPubSub istek hizmetine bağlanarak bir işlemi gerçekleştirme amacıyla çıkış bağlaması.

Tetikleyici bağlama

Azure Web PubSub hizmetinden gelen istekleri işlemek için işlev tetikleyicisini kullanın.

WebPubSubTrigger , hizmet tarafından gelen istekleri işlemeniz gerektiğinde kullanılır. Tetikleyici uç noktası deseni, Web PubSub hizmeti tarafında ayarlanması gereken aşağıdaki gibi olacaktır (Portal: ayarlar -> olay işleyicisi -> URL Şablonu). Uç nokta düzeninde, güvenlik nedeniyle Azure İşlev Uygulaması'nı kullanırken sorgu bölümü code=<API_KEY> GEREKLİ olur. Anahtar Azure portalında bulunabilir. İşlev uygulaması kaynağınızı bulun ve işlev uygulamasını Azure'a dağıttıktan sonra İşlevler ->Uygulama anahtarları ->Sistem anahtarları ->webpubsub_extension öğesine gidin. Ancak, yerel işlevlerle çalışırken bu anahtar gerekli değildir.

<Function_App_Url>/runtime/webhooks/webpubsub?code=<API_KEY>

İşlev sistemi anahtarlarını alma seçeneğinin ekran görüntüsü.

Örnek

[FunctionName("WebPubSubTrigger")]
public static void Run(
    [WebPubSubTrigger("<hub>", WebPubSubEventType.User, "message")] UserEventRequest request, ILogger log)
{
    log.LogInformation($"Request from: {request.ConnectionContext.UserId}");
    log.LogInformation($"Request message data: {request.Data}");
    log.LogInformation($"Request message dataType: {request.DataType}");
}

WebPubSubTrigger bağlama, sunucu istemci isteğini denetleyip reddedebildiği veya doğrudan arayana ileti gönderebildiği sistem ve kullanıcı olayı gibi Connect eşitleme senaryolarında dönüş değerini de destekler. Connect olay ConnectEventResponse ve EventErrorResponse saygı gösterir, ve kullanıcı olayı UserEventResponse ve EventErrorResponse saygı gösterir, geçerli senaryoyla eşleşmeyen diğer türler yoksayılır. Ve EventErrorResponse döndürülürse, servis istemcinin bağlantısını keser.

[FunctionName("WebPubSubTriggerReturnValueFunction")]
public static UserEventResponse Run(
    [WebPubSubTrigger("hub", WebPubSubEventType.User, "message")] UserEventRequest request)
{
    return request.CreateResponse(BinaryData.FromString("ack"), WebPubSubDataType.Text);
}

Aşağıdaki örnekte Web PubSub tetikleyicisi JavaScript işlevi gösterilmektedir.

const { app, trigger } = require('@azure/functions');

const wpsTrigger = trigger.generic({
    type: 'webPubSubTrigger',
    name: 'request',
    hub: '<hub>',
    eventName: 'message',
    eventType: 'user'
});

app.generic('message', {
    trigger: wpsTrigger,
    handler: async (request, context) => {
        context.log('Request from: ', request.connectionContext.userId);
        context.log('Request message data: ', request.data);
        context.log('Request message dataType: ', request.dataType);
    }
});

WebPubSubTrigger bağlama, sunucu istemci isteğini denetleyip reddedebildiği veya doğrudan istek istemcisine ileti gönderebildiği sistem ve kullanıcı olayı gibi Connect eşitleme senaryolarında dönüş değerini de destekler. JavaScript gibi zayıf türlendirilmiş bir dilde, seri durumdan çıkarma işlemi nesne anahtarlarına göre yapılır. Ayrıca, EventErrorResponse diğer nesnelerle karşılaştırıldığında en yüksek önceliğe sahiptir. Eğer code geri dönüşte varsa, EventErrorResponse'ye ayrıştırılır ve istemci bağlantısı kesilir.

app.generic('message', {
    trigger: wpsTrigger,
    handler: async (request, context) => {
          return { 
              "data": "ack",
              "dataType" : "text"
          };
    }
});

function.json içindeki tetikleyici bağlamasını tanımlayın.

{
  "disabled": false,
  "bindings": [
    {
      "type": "webPubSubTrigger",
      "direction": "in",
      "name": "data",
      "hub": "<hub>",
      "eventName": "message",
      "eventType": "user"
    }
  ]
}

içinde index.jsişlevi tanımlayın.

module.exports = function (context, data) {
  context.log('Request from: ', context.bindingData.request.connectionContext.userId);
  context.log('Request message data: ', data);
  context.log('Request message dataType: ', context.bindingData.request.dataType);
}

WebPubSubTrigger bağlama, sunucu istemci isteğini denetleyip reddedebildiği veya doğrudan istek istemcisine ileti gönderebildiği sistem ve kullanıcı olayı gibi Connect eşitleme senaryolarında dönüş değerini de destekler. JavaScript'te zayıf tiplendirilmiş dilde, nesne anahtarlarına göre seri durumdan çıkarılır. Ayrıca EventErrorResponse diğer nesnelerle karşılaştırıldığında en yüksek önceliğe sahiptir. Eğer code dönüşte varsa, EventErrorResponse'ye ayrıştırılır ve istemci bağlantısı kesilir.

module.exports = async function (context) {
  return { 
    "data": "ack",
    "dataType" : "text"
  };
}

Öznitelikler ve ek açıklamalar

C# sınıf kitaplıklarında özniteliğini WebPubSubTrigger kullanın.

Yöntem WebPubSubTrigger imzasında bir öznitelik aşağıdadır:

[FunctionName("WebPubSubTrigger")]
public static void Run([WebPubSubTrigger("<hub>", <WebPubSubEventType>, "<event-name>")] 
    WebPubSubConnectionContext context, ILogger log)
{
    ...
}

Tam bir örnek için bkz. C# örneği.

Yapılandırma

Aşağıdaki tabloda, function.json dosyasında ayarladığınız bağlama yapılandırma özellikleri açıklanmaktadır.

function.json özelliği	Öznitelik özelliği	Açıklama
türü	yok	Gerekli - `webPubSubTrigger` olarak ayarlanmalıdır.
yön	yok	Gerekli - `in` olarak ayarlanmalıdır.
ad	yok	Gerekli - olay verilerini alan parametre için işlev kodunda kullanılan değişken adı.
hub	Merkez	Gerekli - değerin, işlevin tetiklenebilmesi için Web PubSub hub'ının adına ayarlanması gerekir. özniteliğindeki değeri daha yüksek öncelik olarak ayarlamayı destekliyoruz veya uygulama ayarlarında genel değer olarak ayarlanabilir.
etkinlikTürü	WebPubSubEventType	Gerekli - değerin, işlevin tetiklenebilmesi için iletilerin olay türü olarak ayarlanması gerekir. Değer ya `user` ya da `system` olmalıdır.
eventName	Etkinlik Adı	Gerekli - değerin, işlevin tetiklenebilmesi için iletilerin olayı olarak ayarlanması gerekir. Olay `system` türü için olay adı `connect`, `connected` ve `disconnected` içinde olmalıdır. Kullanıcı tanımlı altprotocol'lar için olay adı şeklindedir `message`. Sistem tarafından desteklenen altprotocol `json.webpubsub.azure.v1.`için, olay adı kullanıcı tanımlı olay adıdır.
bağlantı	Bağlantı	İsteğe bağlı - yukarı akış Azure Web PubSub hizmetini belirten bir uygulama ayarlarının veya ayar koleksiyonunun adı. Değer, imza doğrulaması için kullanılır. Ve değer varsayılan olarak "WebPubSubConnectionString" uygulama ayarlarıyla otomatik olarak çözümlenir. Ayrıca `null` doğrulamanın gerekli olmadığı ve her zaman başarılı olduğu anlamına gelir.

Kullanım

C# dilinde WebPubSubEventRequest, türüyle tanınan bir bağlama parametresidir, kalan parametreler ise isimleriyle bağlanır. Kullanılabilir parametrelerin ve türlerin altındaki tabloyu denetleyin.

JavaScript gibi zayıf türdeki bir dilde, name ile function.json, aşağıdaki eşleme tablosuna ilişkin olarak tetikleyici nesneyi bağlamak için kullanılır. Tetikleyici girdisi için bağlama nesnesi olarak ayarlandığında, dataType iletisini function.json dikkate alarak ve buna uygun şekilde dönüştürmeyi namedata unutmayın. Tüm parametreler context.bindingData.<BindingName>'den okunabilir ve JObject olarak dönüştürülebilir.

Bağlama Adı	Bağlama Türü	Açıklama	Özellikler
talep	`WebPubSubEventRequest`	Yukarı akış isteğini açıklar	Özellik, türetilmiş sınıflar `ConnectEventRequest`, `ConnectedEventRequestUserEventRequest` ve dahil olmak üzere farklı olay türlerine göre farklılık gösterir`DisconnectedEventRequest`
bağlantı bağlamı	`WebPubSubConnectionContext`	Ortak istek bilgileri	EtkinlikTürü, EtkinlikAdı, Hub, BağlantıID, KullanıcıID, Başlıklar, Kaynak, İmza, Durumlar
veriler	`BinaryData`,`string`,,`Streambyte[]`	Kullanıcı `message` olayında istemciden ileti verileri isteme	-
Veri Türü	`WebPubSubDataType`	`binary` veri türünü destekleyen istek iletisi, `textjson`	-
talepler	`IDictionary<string, string[]>`	Sistem `connect` isteğindeki Kullanıcı Talepleri	-
sorgu	`IDictionary<string, string[]>`	Sistem `connect` isteğinde kullanıcı sorgusu	-
alt protokoller	`IList<string>`	Sistem `connect` isteğinde kullanılabilir alt protokoller	-
istemci sertifikaları	`IList<ClientCertificate>`	Sistem `connect` isteğindeki istemcilerden sertifika parmak izi listesi	-
sebep	`string`	Sistem `disconnected` isteğindeki neden	-

Önemli

C# dilinde, işlevin düzgün bir şekilde bağlanabilmesi için desteklenen parametre türleri, varsayılan BinaryData türü dışında kalan , request, veya data gibi türler, ilk sıraya koyulmalıdır.

Yanıtı geri döndür

WebPubSubTrigger ve kullanıcı olayının zaman uyumlu olayları için müşteri tarafından döndürülen yanıta connect saygı gösterir. Yalnızca eşleşen yanıt hizmete geri gönderilir, aksi takdirde yoksayılır. Ayrıca, geri dönüş nesnesi WebPubSubTrigger bağlantının meta verilerini yönetmeleri için kullanıcıları SetState() ve ClearStates() destekler. Uzantı, dönüş değerinden elde ettiğiniz sonuçları istekten WebPubSubConnectionContext.Statesalınan özgün değerlerle birleştirir. Mevcut anahtardaki değer üzerine yazılır ve yeni anahtardaki değer eklenir.

Dönüş Türü	Açıklama	Özellikler
`ConnectEventResponse`	Olay yanıtı `connect`	Gruplar, Roller, UserId, Altprotocol
`UserEventResponse`	Kullanıcı olayı için yanıt	VeriTürü, Veri
`EventErrorResponse`	Eşitleme olayı için hata yanıtı	Kod, HataMesajı
`*WebPubSubEventResponse`	Belirsiz dönüş durumlarında kullanılan desteklenen yanıt türlerinin temeli	-

Giriş bağlama

Uzantımız farklı gereksinimleri hedefleyen iki giriş bağlaması sağlar.

WebPubSubConnection

İstemcinin Azure Web PubSub Hizmeti'ne bağlanmasına izin vermek için hizmet uç noktası URL'sini ve geçerli bir erişim belirtecini bilmesi gerekir. Giriş bağlaması WebPubSubConnection gerekli bilgileri üretir, bu nedenle istemcinin bu belirteç oluşturma işleminin kendisini işlemesi gerekmez. Belirteç zaman sınırlı olduğundan ve belirli bir kullanıcının bağlantı kimliğini doğrulamak için kullanılabildiğinden, belirteci önbelleğe alma veya istemciler arasında paylaşma. İstemcilerin bağlantı bilgilerini alması için bu giriş bağlamasıyla çalışan bir HTTP tetikleyicisi kullanılabilir.
WebPubSubContext

Statik Web Uygulamaları kullanılırken, HttpTrigger tek desteklenen tetikleyicidir ve Web PubSub senaryosunda, WebPubSubContext giriş bağlaması, kullanıcıların Web PubSub protokolleri altında hizmet tarafından gerçekleştirilen yukarı akış http isteğini seri durumdan çıkarmalarına yardımcı olur. Böylece müşteriler, işlevlerde kolayca işlenebilmesi için WebPubSubTrigger ile karşılaştırıldığında benzer sonuçlar elde edebilir. Aşağıdaki örneklere bakın. ile HttpTriggerkullanıldığında, müşterinin olay işleyicisinde httpTrigger tarafından kullanıma sunulan URL'yi uygun şekilde yapılandırması gerekir.

Örnek- `WebPubSubConnection`

Aşağıdaki örnekte, giriş bağlamasını kullanarak Web PubSub bağlantı bilgilerini alan ve HTTP üzerinden döndüren bir C# işlevi gösterilmektedir. Aşağıdaki örnekte, UserId?userid={User-A} gibi bir istemci isteği sorgu bölümü aracılığıyla geçirilir.

[FunctionName("WebPubSubConnectionInputBinding")]
public static WebPubSubConnection Run(
    [HttpTrigger(AuthorizationLevel.Anonymous, "get", "post")] HttpRequest req,
    [WebPubSubConnection(Hub = "<hub>", UserId = "{query.userid}")] WebPubSubConnection connection)
{
    return connection;
}

const { app, input } = require('@azure/functions');

const connection = input.generic({
    type: 'webPubSubConnection',
    name: 'connection',
    userId: '{query.userId}',
    hub: '<hub>'
});

app.http('negotiate', {
    methods: ['GET', 'POST'],
    authLevel: 'anonymous',
    extraInputs: [connection],
    handler: async (request, context) => {
        return { body: JSON.stringify(context.extraInputs.get('connection')) };
    },
});

Define input bindings in function.json içinde giriş bağlamalarını tanımlayın.

{
  "disabled": false,
  "bindings": [
    {
      "authLevel": "anonymous",
      "type": "httpTrigger",
      "direction": "in",
      "name": "req"
    },
    {
      "type": "http",
      "direction": "out",
      "name": "res"
    },
    {
      "type": "webPubSubConnection",
      "name": "connection",
      "userId": "{query.userid}",
      "hub": "<hub>",
      "direction": "in"
    }
  ]
}

içinde index.jsişlevi tanımlayın.

module.exports = function (context, req, connection) {
  context.res = { body: connection };
  context.done();
};

Kimlik doğrulaması yapılmış belirteçler

İşlev kimliği doğrulanmış bir istemci tarafından tetikleniyorsa, oluşturulan belirteçe bir kullanıcı kimliği talebi ekleyebilirsiniz. App Service Kimlik Doğrulamasını kullanarak işlev uygulamasına kolayca kimlik doğrulaması ekleyebilirsiniz.

App Service Kimlik Doğrulaması, kimliği doğrulanmış kullanıcının istemci asıl kimliğini ve adını içeren x-ms-client-principal-id ve x-ms-client-principal-name adlı HTTP üst bilgilerini belirtilir.

Bağlamanın UserId özelliğini, başlıktan değeri alarak bir bağlama ifadesi kullanarak ayarlayabilirsiniz: {headers.x-ms-client-principal-id} veya {headers.x-ms-client-principal-name}.

[FunctionName("WebPubSubConnectionInputBinding")]
public static WebPubSubConnection Run(
    [HttpTrigger(AuthorizationLevel.Anonymous, "get", "post")] HttpRequest req,
    [WebPubSubConnection(Hub = "<hub>", UserId = "{headers.x-ms-client-principal-name}")] WebPubSubConnection connection)
{
    return connection;
}

Not

Bağlama parametre türleriyle sınırlı olmak üzere, liste veya dizi geçirmenin bir yolunu desteklemez, WebPubSubConnection sunucu SDK'sının sahip olduğu tüm parametrelerle tam olarak desteklenmez, özellikle rolesve groupsexpiresAfteriçerir. Müşterinin işlevde rol eklemesi veya erişim belirtecinin oluşturulmasını geciktirmesi gerektiğinde, C# için sunucu SDK'sı ile çalışması önerilir.

[FunctionName("WebPubSubConnectionCustomRoles")]
public static async Task<Uri> Run(
    [HttpTrigger(AuthorizationLevel.Anonymous, "get", "post")] HttpRequest req)
{
    var serviceClient = new WebPubSubServiceClient(new Uri(endpoint), "<hub>", "<web-pubsub-connection-string>");
    var userId = req.Query["userid"].FirstOrDefault();
    // your method to get custom roles.
    var roles = GetRoles(userId);
    return await serviceClient.GetClientAccessUriAsync(TimeSpan.FromMinutes(5), userId, roles);
}

Not

Bağlama parametre türleriyle sınırlı olmak üzere, liste veya dizi geçirmenin bir yolunu desteklemez, WebPubSubConnection sunucu SDK'sının sahip olduğu tüm parametrelerle tam olarak desteklenmez, özellikle rolesve groupsexpiresAfteriçerir. Müşterinin işlevde rol eklemesi veya erişim belirtecinin oluşturulmasını geciktirmesi gerektiğinde JavaScript için sunucu SDK'sı ile çalışması önerilir.

const { app } = require('@azure/functions');
const { WebPubSubServiceClient } = require('@azure/web-pubsub');
app.http('negotiate', {
    methods: ['GET', 'POST'],
    authLevel: 'anonymous',
    handler: async (request, context) => {
        const serviceClient = new WebPubSubServiceClient(process.env.WebPubSubConnectionString, "<hub>");
        let token = await serviceClient.getAuthenticationToken({ userId: req.query.userid, roles: ["webpubsub.joinLeaveGroup", "webpubsub.sendToGroup"] });
        return { body: token.url };
    },
});

Not

Bağlama parametre türleriyle sınırlı olmak üzere, liste veya dizi geçirmenin bir yolunu desteklemez, WebPubSubConnection sunucu SDK'sının sahip olduğu tüm parametrelerle tam olarak desteklenmez, özellikle rolesve groupsexpiresAfteriçerir. Müşterinin işlevde rol eklemesi veya erişim belirtecinin oluşturulmasını geciktirmesi gerektiğinde JavaScript için sunucu SDK'sı ile çalışması önerilir.

function.json içinde giriş bağlamalarını tanımlayın.

{
  "disabled": false,
  "bindings": [
    {
      "authLevel": "anonymous",
      "type": "httpTrigger",
      "direction": "in",
      "name": "req"
    },
    {
      "type": "http",
      "direction": "out",
      "name": "res"
    }
  ]
}

içinde index.jsişlevi tanımlayın.

const { WebPubSubServiceClient } = require('@azure/web-pubsub');

module.exports = async function (context, req) {
  const serviceClient = new WebPubSubServiceClient(process.env.WebPubSubConnectionString, "<hub>");
  let token = await serviceClient.getAuthenticationToken({ userId: req.query.userid, roles: ["webpubsub.joinLeaveGroup", "webpubsub.sendToGroup"] });
  context.res = { body: token.url };
  context.done();
};

Örnek- `WebPubSubContext`

Aşağıdaki örnekte, olay türü altındaki connect giriş bağlamasını kullanarak Web PubSub yukarı akış isteği bilgilerini alan ve HTTP üzerinden döndüren bir C# işlevi gösterilmektedir.

[FunctionName("WebPubSubContextInputBinding")]
public static object Run(
    [HttpTrigger(AuthorizationLevel.Anonymous, "get", "post")] HttpRequest req,
    [WebPubSubContext] WebPubSubContext wpsContext)
{
    // in the case request is a preflight or invalid, directly return prebuild response by extension.
    if (wpsContext.IsPreflight || wpsContext.HasError)
    {
        return wpsContext.Response;
    }
    var request = wpsContext.Request as ConnectEventRequest;
    var response = new ConnectEventResponse
    {
        UserId = wpsContext.Request.ConnectionContext.UserId
    };
    return response;
}

const { app, input } = require('@azure/functions');

const wpsContext = input.generic({
    type: 'webPubSubContext',
    name: 'wpsContext'
});

app.http('connect', {
    methods: ['GET', 'POST'],
    authLevel: 'anonymous',
    extraInputs: [wpsContext],
    handler: async (request, context) => {
        var wpsRequest = context.extraInputs.get('wpsContext');

        return { "userId": wpsRequest.request.connectionContext.userId };
    }
});

Define input bindings in function.json içinde giriş bağlamalarını tanımlayın.

{
  "disabled": false,
  "bindings": [
    {
      "authLevel": "anonymous",
      "type": "httpTrigger",
      "direction": "in",
      "name": "req",
      "methods": ["get", "post"]
    },
    {
      "type": "http",
      "direction": "out",
      "name": "$return"
    },
    {
      "type": "webPubSubContext",
      "name": "wpsContext",
      "direction": "in"
    }
  ]
}

içinde index.jsişlevi tanımlayın.

module.exports = async function (context, req, wpsContext) {
  // in the case request is a preflight or invalid, directly return prebuild response by extension.
  if (wpsContext.hasError || wpsContext.isPreflight)
  {
    return wpsContext.response;
  }
  // return an http response with connect event response as body.
  return { body: {"userId": wpsContext.connectionContext.userId} };
};

Yapılandırma

WebPubSubConnection

Aşağıdaki tabloda, function.json dosyasında ve WebPubSubConnection özniteliğinde ayarladığınız bağlama yapılandırma özellikleri açıklanmaktadır.

function.json özelliği	Öznitelik özelliği	Açıklama
türü	yok	Şu şekilde ayarlanmalıdır: `webPubSubConnection`
yön	yok	Şu şekilde ayarlanmalıdır: `in`
ad	yok	Giriş bağlantısı bağlama nesnesi için işlev kodunda kullanılan değişken adı.
hub	Merkez	Gerekli - değerin, işlevin tetiklenebilmesi için Web PubSub hub'ının adına ayarlanması gerekir. özniteliğindeki değeri daha yüksek öncelik olarak ayarlamayı destekliyoruz veya uygulama ayarlarında genel değer olarak ayarlanabilir.
userId	Kullanıcı Kimliği	Seçmeli - erişim anahtarı belirtecinde ayarlanması gereken kullanıcı tanımlayıcı değeri.
bağlantı	Bağlantı	Gerekli - Web PubSub Hizmeti bağlantı dizesi içeren uygulama ayarının adı ("WebPubSubConnectionString" olarak varsayılandır).

WebPubSubContext

Aşağıdaki tabloda, functions.json dosyasında ve WebPubSubContext özniteliğinde ayarladığınız bağlama yapılandırma özellikleri açıklanmaktadır.

function.json özelliği	Öznitelik özelliği	Açıklama
türü	yok	olarak ayarlanmalıdır `webPubSubContext`.
yön	yok	olarak ayarlanmalıdır `in`.
ad	yok	Web PubSub isteği girişi için işlev kodunda kullanılan değişken adı.
bağlantı	Bağlantı	İsteğe bağlı - yukarı akış Azure Web PubSub hizmetini belirten bir uygulama ayarlarının veya ayar koleksiyonunun adı. Bu değer, Kötüye Kullanım Koruması ve İmza doğrulaması için kullanılır. Değer varsayılan olarak "WebPubSubConnectionString" ile otomatik olarak çözümlenir. Ayrıca `null` doğrulamanın gerekli olmadığı ve her zaman başarılı olduğu anlamına gelir.

Kullanım

WebPubSubConnection

WebPubSubConnection aşağıdaki özellikleri sağlar.

Bağlama Adı	Bağlama Türü	Açıklama
BaseUri	Uri	Web PubSub istemci bağlantı uri'si.
Uri	Uri	Web PubSub bağlantısının Uri'sinin mutlak konumu, isteğe göre oluşturulan `AccessToken` içerir.
AccessToken	Dize	İstek UserId ve hizmet bilgilerine göre oluşturulur `AccessToken` .

WebPubSubConnection aşağıdaki özellikleri sağlar.

Bağlama Adı	Açıklama
temel URL	Web PubSub istemci bağlantı uri'si.
URL	Web PubSub bağlantısının Mutlak URI'si, isteğe göre oluşturulmuş `AccessToken` bulunan URI'dir.
accessToken	Talep edilen UserId ve hizmet bilgilerine göre `AccessToken` oluşturuldu.

WebPubSubConnection aşağıdaki özellikleri sağlar.

Bağlama Adı	Açıklama
temel URL	Web PubSub istemci bağlantı uri'si.
URL	Web PubSub bağlantısının Mutlak URI'si, isteğe bağlı olarak oluşturulan `AccessToken` içerir.
accessToken	İstek UserId ve hizmet bilgilerine göre oluşturulur `AccessToken` .

WebPubSubContext

WebPubSubContext aşağıdaki özellikleri sağlar.

Bağlama Adı	Bağlama Türü	Açıklama	Özellikler
talep	`WebPubSubEventRequest`	İstemciden istek, ayrıntılar için aşağıdaki tabloya bakın.	`WebPubSubConnectionContext` istek üst bilgisinden ve istek gövdesinden seri durumdan çıkarılmış diğer özelliklerden gelen istek, örneğin için `ReasonDisconnectedEventRequest`isteği açıklar.
yanıt	`HttpResponseMessage`	Uzantı, çoğunlukla `AbuseProtection` ve hata durumları için yanıt oluşturur.	-
hata mesajı	Dize	Yukarı akış isteğini işlerken hata ayrıntılarını açıklayın.	-
hasError	boolean	Geçerli bir Web PubSub yukarı akış isteği olup olmadığını gösteren bayrak.	-
isPreflight	boolean	Bunun bir denetim öncesi isteği `AbuseProtection`olup olmadığını gösteren bayrak.	-

WebPubSubEventRequest için, istek senaryosu hakkında farklı bilgiler sağlayan farklı sınıflara seri durumdan çıkarılır. Geçerli olmayan durumlar için kullanıcı PreflightRequest bayraklarını IsPreflight kontrol edebilir ve HasError durumu öğrenebilir. Sistem derleme yanıtlarının WebPubSubContext.Response doğrudan döndürülmesi önerilir veya müşteri isteğe bağlı olarak hataları günlüğe kaydedebilir. Farklı senaryolarda müşteri istek özelliklerini aşağıdaki gibi okuyabilir.

Türetilmiş Sınıf	Açıklama	Özellikler
`PreflightRequest`	`AbuseProtection` içinde `IsPreflight`, true olduğunda kullanılır.	-
`ConnectEventRequest`	Sistem `Connect` olay türünde kullanılır	Talepler, Sorgu, Alt Protokoller, Müşteri Sertifikaları
`ConnectedEventRequest`	Sistem `Connected` olay türünde kullanılır	-
`UserEventRequest`	Kullanıcı olay türünde kullanılır	Veri, VeriTürü
`DisconnectedEventRequest`	Sistem `Disconnected` olay türünde kullanılır	Nedeni

Not

WebPubSubContext, HttpTrigger ile karşılaştırıldığında WebPubSubTrigger üzerinde benzer bir istek seri durumdan çıkarma yöntemi sağlayan bir giriş bağlaması olmasına rağmen, belirli kısıtlamalar vardır; yani, birleştirme sonrası bağlantı durumu desteklenmez. Dönüş yanıtına hizmet tarafında hala uyulsa da, kullanıcıların yanıtı kendilerinin oluşturması gerekir. Kullanıcıların olay yanıtını ayarlaması gerekiyorsa, kullanıcı olayı için bir HttpResponseMessage veya ConnectEventResponse içeren yanıt gövdesi döndürmeniz ve ce-connectionstate anahtarıyla bağlantı durumunu yanıt üst bilgisine koymanız gerekir.

Çıkış bağlantısı

Bir şey yapmak üzere Azure Web PubSub hizmetini çağırmak için Web PubSub çıkış bağlamasını kullanın. İletiyi şu şekilde yayımlayabilirsiniz:

Tüm bağlı istemciler
Belirli bir kullanıcı için kimliği doğrulanmış bağlı istemciler
Belirli bir gruba katılmış bağlı istemciler
Belirli bir istemci bağlantısı

Çıkış bağlaması ayrıca istemcileri ve grupları yönetmenize ve grupla belirli connectionId'yi hedefleyen izinler vermenizi/iptal etmenizi sağlar.

Gruba bağlantı ekleme
Gruba kullanıcı ekleme
Gruptan bağlantıyı kaldırma
Kullanıcıyı gruptan kaldırma
Kullanıcıyı tüm gruplardan kaldırma
Tüm istemci bağlantılarını kapatma
Belirli bir istemci bağlantısını kapatma
Gruptaki bağlantıları kapatma
Bağlantı izni verme
Bağlantı iznini iptal etme

Kurulum ve yapılandırma ayrıntıları hakkında bilgi için genel bakışa bakın.

Örnek

[FunctionName("WebPubSubOutputBinding")]
public static async Task RunAsync(
    [HttpTrigger(AuthorizationLevel.Anonymous, "get", "post")] HttpRequest req,
    [WebPubSub(Hub = "<hub>")] IAsyncCollector<WebPubSubAction> actions)
{
    await actions.AddAsync(WebPubSubAction.CreateSendToAllAction("Hello Web PubSub!", WebPubSubDataType.Text));
}

const { app, output } = require('@azure/functions');
const wpsMsg = output.generic({
    type: 'webPubSub',
    name: 'actions',
    hub: '<hub>',
});

app.http('message', {
    methods: ['GET', 'POST'],
    authLevel: 'anonymous',
    extraOutputs: [wpsMsg],
    handler: async (request, context) => {
        context.extraOutputs.set(wpsMsg, [{
            "actionName": "sendToAll",
            "data": `Hello world`,
            "dataType": `text`
        }]);
    }
});

Bağlamaları functions.json içinde tanımlayın.

{
  "disabled": false,
  "bindings": [
    {
      "type": "webPubSub",
      "name": "actions",
      "hub": "<hub>",
      "direction": "out"
    }
  ]
}

içinde index.jsişlevi tanımlayın.

module.exports = async function (context) {
  context.bindings.actions = {
    "actionName": "sendToAll",
    "data": "hello",
    "dataType": "text"
  };
  context.done();
}

WebPubSubAction

WebPubSubAction çıkış bağlamalarının temel soyut türüdür. Türetilmiş türler, hizmetin çağırmasını istediğiniz eylem sunucusunu temsil eder.

C# dilinde, kullanılabilir eylemleri keşfetmeye yardımcı olmak için altında WebPubSubAction birkaç statik yöntem sağlarız. Örneğin, kullanıcı çağrısıyla SendToAllActionWebPubSubAction.CreateSendToAllAction()oluşturabilir.

Türetilmiş Sınıf	Özellikler
`SendToAllAction`	Veri, Veri Türü, Hariç Tutuldu
`SendToGroupAction`	Grup, Veri, VeriTürü, Hariç Tutulan
`SendToUserAction`	Kullanıcı Kimliği, Veri, Veri Türü
`SendToConnectionAction`	BağlantıKimliği, Veri, VeriTürü
`AddUserToGroupAction`	Kullanıcı Kimliği, Grup
`RemoveUserFromGroupAction`	Kullanıcı Kimliği, Grup
`RemoveUserFromAllGroupsAction`	Kullanıcı Kimliği
`AddConnectionToGroupAction`	Bağlantı Kimliği, Grup
`RemoveConnectionFromGroupAction`	Bağlantı Kimliği, Grup
`CloseAllConnectionsAction`	Dışlandı, Neden
`CloseClientConnectionAction`	BağlantıKimliği, Neden
`CloseGroupConnectionsAction`	Grup, Dışlanan, Neden
`GrantPermissionAction`	BağlantıId, İzin, HedefAdı
`RevokePermissionAction`	BağlantıId, İzin, HedefAdı

gibi javascriptactionName zayıf yazılan dilde, türü çözümlemek için anahtar parametredir; kullanılabilir eylemler aşağıda listelenmiştir.

EylemAdı	Özellikler
`sendToAll`	Veri, Veri Türü, Hariç Tutuldu
`sendToGroup`	Grup, Veri, VeriTürü, Hariç Tutulan
`sendToUser`	Kullanıcı Kimliği, Veri, Veri Türü
`sendToConnection`	BağlantıKimliği, Veri, VeriTürü
`addUserToGroup`	Kullanıcı Kimliği, Grup
`removeUserFromGroup`	Kullanıcı Kimliği, Grup
`removeUserFromAllGroups`	Kullanıcı Kimliği
`addConnectionToGroup`	Bağlantı Kimliği, Grup
`removeConnectionFromGroup`	Bağlantı Kimliği, Grup
`closeAllConnections`	Dışlandı, Neden
`closeClientConnection`	BağlantıKimliği, Neden
`closeGroupConnections`	Grup, Dışlanan, Neden
`grantPermission`	BağlantıId, İzin, HedefAdı
`revokePermission`	BağlantıId, İzin, HedefAdı

Önemli

İleti gönderme ile ilgili eylemlerdeki ileti veri özelliği, veri türü string veya json olarak ayarlandığında veri dönüştürme belirsizliğini önlemek için text olmalıdır. Lütfen ihtiyacı olan json nesnesini dönüştürmek için kullanın JSON.stringify() . Bu, ileti özelliği kullanılarak herhangi bir yere uygulanır, örneğin UserEventResponse.Data ve WebPubSubTrigger ile çalışmak.

Veri türü binary olarak ayarlandığında, dataType ile doğal olarak desteklenen binary bağlamasından, function.json içinde yapılandırıldığı gibi faydalanmasına izin verilebilir. Ayrıntılar için bkz, Tetikleyici ve bağlama tanımları.

gibi javascriptactionName zayıf yazılan dilde, türü çözümlemek için anahtar parametredir; kullanılabilir eylemler aşağıda listelenmiştir.

EylemAdı	Özellikler
`sendToAll`	Veri, Veri Türü, Hariç Tutuldu
`sendToGroup`	Grup, Veri, VeriTürü, Hariç Tutulan
`sendToUser`	Kullanıcı Kimliği, Veri, Veri Türü
`sendToConnection`	BağlantıKimliği, Veri, VeriTürü
`addUserToGroup`	Kullanıcı Kimliği, Grup
`removeUserFromGroup`	Kullanıcı Kimliği, Grup
`removeUserFromAllGroups`	Kullanıcı Kimliği
`addConnectionToGroup`	Bağlantı Kimliği, Grup
`removeConnectionFromGroup`	Bağlantı Kimliği, Grup
`closeAllConnections`	Dışlandı, Neden
`closeClientConnection`	BağlantıKimliği, Neden
`closeGroupConnections`	Grup, Dışlanan, Neden
`grantPermission`	BağlantıId, İzin, HedefAdı
`revokePermission`	BağlantıId, İzin, HedefAdı

Önemli

Veri türü json veya text olarak ayarlandığında veri dönüştürme belirsizliğini önlemek için ileti gönderme ile ilgili eylemlerdeki ileti veri özelliği string olmalıdır. Lütfen ihtiyacı olan json nesnesini dönüştürmek için kullanın JSON.stringify() . Bu, iletişim özellikleri kullanılarak herhangi bir yere uygulanır, örneğin UserEventResponse.Data ve WebPubSubTrigger ile çalışmak için.

Veri tipi binary olarak ayarlandığında, function.json içinde yapılandırıldığı gibi doğal olarak dataType desteklenen bağlama binary üzerinden erişim sağlanmasına izin verilir. Ayrıntılar için bkz. Tetikleyici ve bağlama tanımları.

Yapılandırma

WebPubSub

Aşağıdaki tabloda, function.json dosyasında ve WebPubSub özniteliğinde ayarladığınız bağlama yapılandırma özellikleri açıklanmaktadır.

function.json özelliği	Öznitelik özelliği	Açıklama
türü	yok	Şu şekilde ayarlanmalıdır: `webPubSub`
yön	yok	Şu şekilde ayarlanmalıdır: `out`
ad	yok	Çıkış bağlama nesnesi için işlev kodunda kullanılan değişken adı.
hub	Merkez	değeri, işlevin tetiklenebilmesi için Web PubSub hub'ının adına ayarlanmalıdır. özniteliğindeki değeri daha yüksek öncelik olarak ayarlamayı destekliyoruz veya uygulama ayarlarında genel değer olarak ayarlanabilir.
bağlantı	Bağlantı	Web PubSub Hizmeti bağlantı dizesi içeren uygulama ayarının adı (varsayılan olarak "WebPubSubConnectionString" olarak adlandırılır).

Sorun giderme

Konsol günlüğünü ayarlama

Ayrıca, hizmette yaptığınız istekleri daha ayrıntılı incelemek istiyorsanız konsol günlüğünü kolayca etkinleştirebilirsiniz.

Sonraki adımlar

Kendi uygulamanızı oluşturmaya başlamak için şu kaynakları kullanın:

Öğretici: Azure Web PubSub'da iletileri yayımlama ve iletilere abone olma

Öğretici: Azure Web PubSub ile basit bir sohbet odası oluşturma

Kılavuz: İstemci akışı için hizmet tarafından desteklenen bir alt protokol kullanma

Öğretici: Azure İşlevleri ve Web PubSub ile sunucusuz sohbet oluşturma

Kılavuz: Olay dinleyicisini yapılandırma

Canlı demoları deneyin

Diğer Azure Web PubSub örneklerini keşfedin

Geri Bildirim

Bu sayfayı yararlı buldunuz mu?

Last updated on 2026-02-26

Azure İşlevleri için Azure Web PubSub tetikleyicisi ve bağlamaları

İşlev uygulamanıza ekleme

Temel kavramlar

Tetikleyici bağlama

Örnek

Öznitelikler ve ek açıklamalar

Yapılandırma

Kullanım

Yanıtı geri döndür

Giriş bağlama

Örnek- WebPubSubConnection

Kimlik doğrulaması yapılmış belirteçler

Örnek- WebPubSubContext

Yapılandırma

WebPubSubConnection

WebPubSubContext

Kullanım

WebPubSubConnection

WebPubSubContext

Çıkış bağlantısı

Örnek

WebPubSubAction

Yapılandırma

WebPubSub

Sorun giderme

Konsol günlüğünü ayarlama

Sonraki adımlar

Geri Bildirim

Ek kaynaklar

Örnek- `WebPubSubConnection`

Örnek- `WebPubSubContext`