Azure Web PubSub hizmetinde olay işleyicisini yapılandırma

Olay işleyicisi gelen istemci olaylarını işler. Olay işleyicileri Azure portalı veya Azure CLI aracılığıyla hizmete kaydedilir ve yapılandırılır. bir istemci olayı tetiklendiğinde, hizmet olayı uygun olay işleyicisine gönderebilir. Web PubSub hizmeti artık olay işleyicisini sunucu tarafı olarak desteklemektedir ve bu da olay tetiklendiğinde hizmetin çağrılmak üzere genel olarak erişilebilen uç noktasını kullanıma sunar. Başka bir deyişle, bir web kancası işlevi görür.

Web PubSub hizmeti, Azure Web PubSub olay işleyicisi için CloudEvents uzantısıyla CloudEvents HTTP protokolunu kullanarak istemci olaylarını yapılandırılan yukarı akış web kancasına teslim eder.

Web PubSub hizmeti olay tetikleyicisinin ekran görüntüsü.

Olay işleyici ayarları

İstemci her zaman bir hub'a bağlanır ve hub için birden çok olay işleyicisi ayarı yapılandırabilirsiniz. Olay işleyicisi ayarlarının sırası önemlidir ve öncekinin önceliği daha yüksektir. bir istemci bağlandığında ve bir olay tetiklendiğinde, Web PubSub yapılandırılan olay işleyicilerini öncelik sırasına göre geçirir ve ilk eşleşen kazanır. Olay işleyicisini yapılandırırken aşağıdaki özellikleri ayarlayın:

Özellik adı Açıklama
Url şablonu Web PubSub'un yukarı akış web kancası URL'nizi değerlendirmek için kullandığı şablonu tanımlar.
Kullanıcı olayları Geçerli olay işleyici ayarının önem verdiği kullanıcı olaylarını tanımlar.
Sistem olayları Geçerli olay işleyici ayarının önem verdiği sistem olaylarını tanımlar.
Kimlik Doğrulaması Web PubSub hizmeti ile yukarı akış sunucunuz arasındaki kimlik doğrulama yöntemini tanımlar.

Ekinlikler

Olaylar kullanıcı olaylarını ve sistem olaylarını içerir. Sistem olayları, istemcinin ömrü boyunca tetiklenen önceden tanımlanmış olaylardır. İstemci veri gönderdiğinde kullanıcı olayları tetiklenir, kullanıcı olay adı istemci protokolleri kullanılarak özelleştirilebilir, burada ayrıntılı açıklama yer alır.

Olay türü Desteklenen değerler
Sistem olayları connect, connected ve disconnected
Kullanıcı olayları messageveya istemci protokollerini izleyen özel olay adı

URL şablonu

URL şablonu, çalışma zamanı sırasında değerlendirilebilecek çeşitli parametreleri destekler. Bu özellik sayesinde farklı hub'ları veya olayları tek bir ayar ile farklı yukarı akış sunucularına yönlendirmek kolaydır. Verilerin Azure Key Vault'ta güvenli bir şekilde depolanabilmesi için KeyVault başvuru söz dizimi de destekleniyor.

Not URL etki alanı adı parametre söz dizimi içermemelidir, örneğin geçerli http://{hub}.com bir URL şablonu değildir.

Desteklenen parametreler Sözdizimi Açıklama Örnekler
Hub parametresi {hub} Değer, istemcinin bağlandığını hub'dır. bir istemci öğesine client/hubs/chatbağlandığında, bu istemci için hub olduğundan chatURL şablonu http://host.com/api/{hub} olarak değerlendirilirhttp://host.com/api/chat.
Olay parametresi {event} Tetiklenen olayın değeri. eventdeğerleri burada listelenmiştir. Kötüye kullanım koruma isteklerinin olay değeri burada açıklandığı gibidirvalidate. olayı connectiçin yapılandırılmış bir URL şablonu http://host.com/api/{hub}/{event} varsa, bir istemci öğesine bağlandığındaclient/hubs/chat, bu istemci olayı için hub chat ve bu olay işleyici ayarını connecttetikleyen olay olduğundan, Web PubSub istemci bağlanırken değerlendirilen URL'ye http://host.com/api/chat/connect bir POST isteği başlatır.
KeyVault başvuru parametresi {@Microsoft.KeyVault(SecretUri=<secretUri>)} SecretUri, isteğe bağlı olarak veya https://myvault.vault.azure.net/secrets/mysecret/ec96f02080254f109c51a1f14cdb1931gibi bir sürüm de dahil olmak üzere kasadaki bir gizli dizinin tam veri düzlemi URI'si https://myvault.vault.azure.net/secrets/mysecret/ olmalıdır. KeyVault başvurusunu kullanırken, Web PubSub hizmetinizle KeyVault hizmetiniz arasında kimlik doğrulamasını da yapılandırmanız gerekir. Ayrıntılı adımlar için buraya bakın. @Microsoft.KeyVault(SecretUri=https://myvault.vault.azure.net/secrets/mysecret/)

Hizmet ve web kancası arasında kimlik doğrulaması

Hizmet ve web kancası arasında kimlik doğrulaması yapmak için bu yöntemlerden herhangi birini kullanabilirsiniz.

  • Anonim mod
  • ile ?code=<code> basit kimlik doğrulaması, yapılandırılan Web kancası URL'si aracılığıyla sorgu parametresi olarak sağlanır.
  • Microsoft Entra yetkilendirmesi. Daha fazla bilgi için bkz . İstemci olaylarında yönetilen kimlik kullanma.

Yukarı akış ve Doğrulama

Azure portalı veya CLI aracılığıyla olay işleyici web kancasını ayarlarken hizmet, yukarı akış web kancasını doğrulamak için CloudEvents Kötüye Kullanım Koruması'nı izler. Bu mekanizma, her kayıtlı yukarı akış web kancası URL'sini doğrular. WebHook-Request-Origin İstek üst bilgisi hizmet etki alanı adına xxx.webpubsub.azure.comayarlanır ve yanıtın WebHook-Allowed-Origin bu etki alanı adını veya *içermesini bekler.

Doğrulama {event} yapılırken parametresi olarak validateçözümlenir. Örneğin, URL'yi http://host.com/api/{event}olarak ayarlamaya çalışırken, hizmet options bir isteği olarak http://host.com/api/validatedener. Yalnızca yanıt geçerli olduğunda yapılandırma başarıyla ayarlanabilir.

Şimdilik WebHook-Request-Rate ve WebHook-Request-Callback'i desteklemiyoruz.

Olay işleyicisini yapılandırma

Azure portalı aracılığıyla yapılandırma

Yeni bir hub'a olay işleyicisi ekleyebilir veya var olan bir hub'ı düzenleyebilirsiniz.

Yeni bir hub'da olay işleyicisi yapılandırmak için:

  1. Azure portalında Azure Web PubSub hizmeti sayfanıza gidin.

  2. Menüden Ayarlar'ı seçin.

  3. Ekle'yi seçerek bir hub oluşturun ve sunucu tarafı web kancası URL'nizi yapılandırın. Not: Var olan bir hub'a olay işleyicisi eklemek için hub'ı ve ardından Düzenle'yi seçin.

    Olay işleyicisini ayarlama işleminin ekran görüntüsü.

  4. Hub adınızı girin.

  5. Çift İşleyicileri Yapılandır'ın altında Ekle'yi seçin.

  6. Olay işleyicisi sayfasında aşağıdaki alanları yapılandırın: 1. URL Şablonu alanına sunucu web kancası URL'sini girin. 1. Abone olmak istediğiniz Sistem olaylarını seçin. 1. Abone olmak istediğiniz Kullanıcı olayları'nı seçin. 1. Yukarı akış isteklerinin kimliğini doğrulamak için Kimlik doğrulama yöntemi'ne tıklayın. 1. Onayla'yı seçin. Azure Web PubSub Yapılandırma Olay İşleyicisi'nin ekran görüntüsü.

  7. Hub Ayarlarını Yapılandır sayfasının üst kısmındaki Kaydet'i seçin.

    Azure Web PubSub Hub Ayarlarını Yapılandır'ın ekran görüntüsü.

Azure CLI aracılığıyla yapılandırma

Olay işleyicisi ayarlarını yapılandırmak için Azure CLI az webpubsub hub group komutlarını kullanın.

Komutlar Açıklama
create WebPubSub Hizmeti için hub ayarları oluşturun.
delete WebPubSub Hizmeti için hub ayarlarını silin.
list WebPubSub Hizmeti için tüm hub ayarlarını listeleyin.
show WebPubSub Hizmeti için hub ayarlarını gösterin.
update WebPubSub Hizmeti için hub ayarlarını güncelleştirin.

Kaynak hub'ı MyHub için iki web kancası URL'sini oluşturma örneği aşağıda verilmişti MyWebPubSub :

az webpubsub hub create -n "MyWebPubSub" -g "MyResourceGroup" --hub-name "MyHub" --event-handler url-template="http://host.com" user-event-pattern="*" --event-handler url-template="http://host2.com" system-event="connected" system-event="disconnected" auth-type="ManagedIdentity" auth-resource="uri://myUri"

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

Öğretici: İstemci akışı için hizmet tarafından desteklenen bir alt protokol kullanma

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

Öğretici: Olay dinleyicisi yapılandırma

Canlı tanıtımlarla oynama

Diğer Azure Web PubSub örneklerini keşfedin

  • Last updated on