Azure İşlevleri için Azure Event Hubs çıkış bağlaması
Bu makalede, Azure İşlevleri için Azure Event Hubs bağlamalarıyla çalışma açıklanmaktadır. Azure İşlevleri Event Hubs için tetikleyici ve çıkış bağlamalarını destekler.
Kurulum ve yapılandırma ayrıntıları hakkında bilgi için genel bakışa bakın.
Olay akışına olay yazmak için Event Hubs çıkış bağlamasını kullanın. Olay yazmak için ilgili olay hub'ında gönderme iznine sahip olmanız gerekir.
Bir çıkış bağlaması uygulamaya çalışmadan önce gerekli paket başvurularının yerinde olduğundan emin olun.
Önemli
Bu makalede, Node.js programlama modelinin birden çok sürümünü desteklemek için sekmeler kullanılır. Genel kullanıma sunulan v4 modeli, JavaScript ve TypeScript geliştiricileri için daha esnek ve sezgisel bir deneyime sahip olacak şekilde tasarlanmıştır. v4 modelinin nasıl çalıştığı hakkında daha fazla bilgi için Azure İşlevleri Node.js geliştirici kılavuzuna bakın. v3 ile v4 arasındaki farklar hakkında daha fazla bilgi edinmek için geçiş kılavuzuna bakın.
Azure İşlevleri, Python için iki programlama modelini destekler. Bağlamalarınızı tanımlama şekliniz seçtiğiniz programlama modeline bağlıdır.
Python v2 programlama modeli, doğrudan Python işlev kodunuzda dekoratörleri kullanarak bağlamaları tanımlamanıza olanak tanır. Daha fazla bilgi için bkz . Python geliştirici kılavuzu.
Bu makale her iki programlama modelini de destekler.
Örnek
Aşağıdaki örnekte, yöntem dönüş değerini çıkış olarak kullanarak bir olay hub'ına ileti dizesi yazan bir C# işlevi gösterilmektedir:
[Function(nameof(EventHubFunction))]
[FixedDelayRetry(5, "00:00:10")]
[EventHubOutput("dest", Connection = "EventHubConnection")]
public string EventHubFunction(
[EventHubTrigger("src", Connection = "EventHubConnection")] string[] input,
FunctionContext context)
{
_logger.LogInformation("First Event Hubs triggered message: {msg}", input[0]);
var message = $"Output message created at {DateTime.Now}";
return message;
}
Aşağıdaki örnekte, bir olay hub'ına tek bir ileti gönderen zamanlayıcı ile tetiklenen TypeScript işlevi gösterilmektedir:
import { app, InvocationContext, output, Timer } from '@azure/functions';
export async function timerTrigger1(myTimer: Timer, context: InvocationContext): Promise<string> {
const timeStamp = new Date().toISOString();
return `Message created at: ${timeStamp}`;
}
app.timer('timerTrigger1', {
schedule: '0 */5 * * * *',
return: output.eventHub({
eventHubName: 'myeventhub',
connection: 'MyEventHubSendAppSetting',
}),
handler: timerTrigger1,
});
Birden çok iletinin çıktısını almak için tek bir nesne yerine bir dizi döndürebilirsiniz. Örneğin:
const timeStamp = new Date().toISOString();
const message = `Message created at: ${timeStamp}`;
return [`1: ${message}`, `2: ${message}`];
Aşağıdaki örnekte, bir olay hub'ına tek bir ileti gönderen süreölçer tarafından tetiklenen JavaScript işlevi gösterilmektedir :
const { app, output } = require('@azure/functions');
const eventHubOutput = output.eventHub({
eventHubName: 'myeventhub',
connection: 'MyEventHubSendAppSetting',
});
app.timer('timerTrigger1', {
schedule: '0 */5 * * * *',
return: eventHubOutput,
handler: (myTimer, context) => {
const timeStamp = new Date().toISOString();
return `Message created at: ${timeStamp}`;
},
});
Birden çok iletinin çıktısını almak için tek bir nesne yerine bir dizi döndürebilirsiniz. Örneğin:
const timeStamp = new Date().toISOString();
const message = `Message created at: ${timeStamp}`;
return [`1: ${message}`, `2: ${message}`];
Tam PowerShell örnekleri beklemede.
Aşağıdaki örnekte bir olay hub'ı tetikleyici bağlaması ve bağlamayı kullanan bir Python işlevi gösterilmektedir. işlevi bir olay hub'ına bir ileti yazar. Örnek, v1 veya v2 Python programlama modelini kullanıp kullanmadığınıza bağlıdır.
import logging
import azure.functions as func
app = func.FunctionApp()
@app.function_name(name="eventhub_output")
@app.route(route="eventhub_output")
@app.event_hub_output(arg_name="event",
event_hub_name="<EVENT_HUB_NAME>",
connection="<CONNECTION_SETTING>")
def eventhub_output(req: func.HttpRequest, event: func.Out[str]):
body = req.get_body()
if body is not None:
event.set(body.decode('utf-8'))
else:
logging.info('req body is none')
return 'ok'
Birden çok ileti gönderen Python kodu aşağıdadır:
import logging
import azure.functions as func
from typing import List
app = func.FunctionApp()
@app.function_name(name="eventhub_output")
@app.route(route="eventhub_output")
@app.event_hub_output(arg_name="event",
event_hub_name="<EVENT_HUB_NAME>",
connection="<CONNECTION_SETTING>")
def eventhub_output(req: func.HttpRequest, event: func.Out[List[str]]) -> func.HttpResponse:
my_messages=["message1", "message2","message3"]
event.set(my_messages)
return func.HttpResponse(f"Messages sent")
Aşağıdaki örnekte, bir olay hub'ına geçerli saati içeren bir ileti yazan bir Java işlevi gösterilmektedir.
@FunctionName("sendTime")
@EventHubOutput(name = "event", eventHubName = "samples-workitems", connection = "AzureEventHubConnection")
public String sendTime(
@TimerTrigger(name = "sendTimeTrigger", schedule = "0 */5 * * * *") String timerInfo) {
return LocalDateTime.now().toString();
}
Java işlevleri çalışma zamanı kitaplığında, değeri Event Hubs'a yayımlanacak parametrelerde ek açıklamayı kullanın@EventHubOutput
. parametresi, POJO veya herhangi bir yerel Java türü olan T
türünde olmalıdır OutputBinding<T>
.
Özellikler
Hem işlem içi hem de yalıtılmış çalışan işlemi C# kitaplıkları bağlamayı yapılandırmak için özniteliğini kullanır. Bunun yerine C# betiği, C# betik kılavuzunda açıklandığı gibi bir function.json yapılandırma dosyası kullanır.
Aşağıdaki özellikleri destekleyen bir olay hub'ına çıkış bağlaması tanımlamak için [EventHubOutputAttribute] kullanın.
Parametreler | Açıklama |
---|---|
EventHubName | Olay hub'ının adı. olay hub'ı adı da bağlantı dizesi mevcut olduğunda, bu değer çalışma zamanında bu özelliği geçersiz kılar. |
Bağlantı | Event Hubs'a nasıl bağlanıldığını belirten bir uygulama ayarının veya ayar koleksiyonunun adı. Daha fazla bilgi için bkz . Bağlantılar. |
Dekoratörler
Yalnızca Python v2 programlama modeli için geçerlidir.
Bir dekoratör kullanılarak tanımlanan Python v2 işlevleri için bu özellikler için event_hub_output
desteklenir:
Özellik | Açıklama |
---|---|
arg_name |
Olayı temsil eden işlev kodunda kullanılan değişken adı. |
event_hub_name |
olay hub'ının adıdır. olay hub'ı adı da bağlantı dizesi mevcut olduğunda, bu değer çalışma zamanında bu özelliği geçersiz kılar. |
connection |
Event Hubs'a nasıl bağlanıldığını belirten bir uygulama ayarının veya ayar koleksiyonunun adı. Daha fazla bilgi için bkz . Bağlantılar. |
function.json kullanılarak tanımlanan Python işlevleri için Yapılandırma bölümüne bakın.
Ek Açıklamalar
Java işlevleri çalışma zamanı kitaplığında, değeri Event Hubs'a yayımlanacak parametrelerde EventHubOutput ek açıklamasını kullanın. Ek açıklama üzerinde aşağıdaki ayarlar desteklenir:
Yapılandırma
Yalnızca Python v1 programlama modeli için geçerlidir.
Aşağıdaki tabloda, yöntemine geçirilen output.eventHub()
nesnede options
ayarlayabileceğiniz özellikler açıklanmaktadır.
Özellik | Açıklama |
---|---|
eventHubName | Olay hub'ının adı. olay hub'ı adı da bağlantı dizesi mevcut olduğunda, bu değer çalışma zamanında bu özelliği geçersiz kılar. |
bağlantı | Event Hubs'a nasıl bağlanıldığını belirten bir uygulama ayarının veya ayar koleksiyonunun adı. Daha fazla bilgi için bkz . Bağlantılar. |
Aşağıdaki tabloda, çalışma zamanı sürümüne göre farklılık gösteren function.json dosyasında ayarladığınız bağlama yapılandırma özellikleri açıklanmaktadır.
function.json özelliği | Açıklama |
---|---|
type | olarak ayarlanmalıdır eventHub . |
direction | olarak ayarlanmalıdır out . Bağlamayı Azure portalında oluşturduğunuzda bu parametre otomatik olarak ayarlanır. |
ad | Olayı temsil eden işlev kodunda kullanılan değişken adı. |
eventHubName | İşlevler 2.x ve üzeri. Olay hub'ının adı. olay hub'ı adı da bağlantı dizesi mevcut olduğunda, bu değer çalışma zamanında bu özelliği geçersiz kılar. |
bağlantı | Event Hubs'a nasıl bağlanıldığını belirten bir uygulama ayarının veya ayar koleksiyonunun adı. Daha fazla bilgi için bkz . Bağlantılar. |
Yerel olarak geliştirme yaparken uygulama ayarlarınızı koleksiyondaki local.settings.json dosyasına Values
ekleyin.
Kullanım
Event Hubs çıkış bağlaması tarafından desteklenen parametre türü İşlevler çalışma zamanı sürümüne, uzantı paketi sürümüne ve kullanılan C# modalitesine bağlıdır.
İşlevin tek bir olay yazmasını istediğinizde Event Hubs çıkış bağlaması aşağıdaki türlere bağlanabilir:
Type | Açıklama |
---|---|
string |
Dize olarak olay. Olay basit bir metin olduğunda kullanın. |
byte[] |
Olayın baytları. |
JSON serileştirilebilir türler | Olayı temsil eden bir nesne. İşlevler, düz eski bir CLR nesnesi (POCO) türünü JSON verilerine seri hale getirmeye çalışır. |
İşlevin birden çok olay yazmasını istediğinizde Event Hubs çıkış bağlaması aşağıdaki türlere bağlanabilir:
Type | Açıklama |
---|---|
T[] burada T tek olay türlerinden biridir |
Birden çok olay içeren bir dizi. Her girdi bir olayı temsil eder. |
Diğer çıkış senaryoları için doğrudan Azure.Messaging.EventHubs'daki diğer türlerle bir EventHubProducerClient oluşturun ve kullanın. Azure SDK'dan bir istemci türü oluşturmak için bağımlılık ekleme kullanma örneği için bkz . Azure istemcilerini kaydetme.
EventHubOutput ek açıklamasını kullanarak bir işlevden Event Hubs iletisi çıkarmak için iki seçenek vardır:
Dönüş değeri: Ek açıklamayı işlevin kendisine uygulayarak işlevin dönüş değeri Event Hubs iletisi olarak kalıcı hale getirilir.
Kesinlik: İleti değerini açıkça ayarlamak için ek açıklamayı, pojo veya herhangi bir yerel Java türü olan
T
türündekiOutputBinding<T>
belirli bir parametreye uygulayın. Bu yapılandırmayla, yönteminesetValue
bir değer geçirilmesi, değerin Event Hubs iletisi olarak kalıcı olmasını sağlar.
Tam PowerShell örnekleri beklemede.
Bir işlevden Event Hubs iletisi çıkarmak için iki seçenek vardır:
Dönüş değeri: function.json özelliğini olarak
$return
ayarlayınname
. Bu yapılandırmayla işlevin dönüş değeri Event Hubs iletisi olarak kalıcı hale getirilir.Kesinlik: Out türü olarak bildirilen parametrenin set yöntemine bir değer geçirin. 'a
set
geçirilen değer, Event Hubs iletisi olarak kalıcıdır.
Bağlantılar
connection
özelliği, uygulamanın Event Hubs'a nasıl bağlanması gerektiğini belirten bir ortam yapılandırması başvurusudur. Şunları belirtebilir:
- bağlantı dizesi içeren bir uygulama ayarının adı
- Birden çok uygulama ayarı için paylaşılan ön ekin adı ve birlikte kimlik tabanlı bağlantı tanımlama.
Yapılandırılan değer hem tek bir ayar için tam eşleşme hem de diğer ayarlar için bir ön ek eşleşmesiyse, tam eşleşme kullanılır.
Connection string
Olay hub'ını değil ad alanının Bağlantı Bilgileri düğmesine tıklayarak bu bağlantı dizesi alın. bağlantı dizesi, olay hub'ını değil event Hubs ad alanı için olmalıdır.
Tetikleyiciler için kullanıldığında, bağlantı dizesi işlevi etkinleştirmek için en az "okuma" izinlerine sahip olmalıdır. Çıkış bağlamaları için kullanıldığında, bağlantı dizesi olay akışına ileti göndermek için "gönderme" izinlerine sahip olmalıdır.
Bu bağlantı dizesi, bağlama yapılandırmasının özelliği tarafından connection
belirtilen değerle eşleşen bir adla bir uygulama ayarında depolanmalıdır.
Kimlik tabanlı bağlantılar
Uzantının 5.x veya üzeri bir sürümünü kullanıyorsanız, gizli dizi içeren bir bağlantı dizesi kullanmak yerine uygulamanın bir Microsoft Entra kimliği kullanmasını sağlayabilirsiniz. Bunu yapmak için, tetikleyici ve bağlama yapılandırmasındaki özelliğiyle connection
eşlenen ortak bir ön ekin altında ayarlar tanımlayabilirsiniz.
Bu modda uzantı aşağıdaki özellikleri gerektirir:
Özellik | Ortam değişkeni şablonu | Açıklama | Örnek değer |
---|---|---|---|
Tam Ad Alanı | <CONNECTION_NAME_PREFIX>__fullyQualifiedNamespace |
Tam Event Hubs ad alanı. | myeventhubns.servicebus.windows.net |
Bağlantıyı özelleştirmek için ek özellikler ayarlanabilir. Bkz. Kimlik tabanlı bağlantılar için ortak özellikler.
Not
Yönetilen Kimlik bağlantıları için ayarlar sağlamak üzere Azure Uygulaması Yapılandırması veya Key Vault kullanılırken, adların doğru çözümlendiğinden __
emin olmak için adların yerine veya /
gibi :
geçerli bir anahtar ayırıcı kullanılmalıdır.
Örneğin, <CONNECTION_NAME_PREFIX>:fullyQualifiedNamespace
.
Azure İşlevleri hizmetinde barındırıldığında, kimlik tabanlı bağlantılar yönetilen kimlik kullanır. Ve özellikleriyle credential
clientID
kullanıcı tarafından atanan bir kimlik belirtilse de, sistem tarafından atanan kimlik varsayılan olarak kullanılır. Kullanıcı tarafından atanan kimliği kaynak kimliğiyle yapılandırmanın desteklenmediğini unutmayın. Yerel geliştirme gibi diğer bağlamlarda çalıştırıldığında, bunun yerine geliştirici kimliğiniz kullanılır, ancak bu özelleştirilebilir. Bkz. Kimlik tabanlı bağlantılarla yerel geliştirme.
Kimliğe izin verme
Hangi kimlik kullanılıyorsa, hedeflenen eylemleri gerçekleştirmek için izinlere sahip olmalıdır. Çoğu Azure hizmeti için bu, bu izinleri sağlayan yerleşik veya özel rolleri kullanarak Azure RBAC'de bir rol atamanız gerektiği anlamına gelir.
Önemli
Bazı izinler, tüm bağlamlar için gerekli olmayan hedef hizmet tarafından gösterilebilir. Mümkün olduğunda, kimliğe yalnızca gerekli ayrıcalıkları sağlayarak en az ayrıcalık ilkesine uyun. Örneğin, uygulamanın yalnızca bir veri kaynağından okuyabilmesi gerekiyorsa, yalnızca okuma izni olan bir rol kullanın. Okuma işlemi için aşırı izin olduğundan, bu hizmete yazmaya da izin veren bir rol atamak uygun olmaz. Benzer şekilde, rol atamasının kapsamının yalnızca okunması gereken kaynaklara göre ayarlandığından emin olmak istersiniz.
Çalışma zamanında olay hub'ınıza erişim sağlayan bir rol ataması oluşturmanız gerekir. Rol atamasının kapsamı bir Event Hubs ad alanı veya olay hub'ının kendisi için olabilir. Sahip gibi yönetim rolleri yeterli değildir. Aşağıdaki tabloda, Event Hubs uzantısı normal işlemde kullanılırken önerilen yerleşik roller gösterilmektedir. Uygulamanız, yazdığınız koda göre ek izinler gerektirebilir.
Bağlama türü | Örnek yerleşik roller |
---|---|
Tetikleyici | Azure Event Hubs Veri Alıcısı, Azure Event Hubs Veri Sahibi |
Çıkış bağlaması | Azure Event Hubs Veri Göndereni |
Özel durumlar ve dönüş kodları
Bağlama | Başvuru |
---|---|
Event Hubs | İşlemler Kılavuzu |