Pemicu Azure Queue Storage untuk Azure Functions

Pemicu penyimpanan antrean menjalankan fungsi saat pesan ditambahkan ke Azure Queue storage.

Keputusan penskalaan penyimpanan Azure Queue untuk paket Konsumsi dan Premium dilakukan melalui penskalaan berbasis target. Untuk informasi selengkapnya, lihat Penskalaan berbasis target.

Penting

Artikel ini menggunakan tab untuk mendukung beberapa versi model pemrograman Node.js. Model v4 umumnya tersedia dan dirancang untuk memiliki pengalaman yang lebih fleksibel dan intuitif untuk pengembang JavaScript dan TypeScript. Untuk detail selengkapnya tentang cara kerja model v4, lihat panduan pengembang Node.js Azure Functions. Untuk mempelajari selengkapnya tentang perbedaan antara v3 dan v4, lihat panduan migrasi.

Azure Functions mendukung dua model pemrograman untuk Python. Cara Anda menentukan pengikatan tergantung pada model pemrograman yang Anda pilih.

v2

Model pemrograman Python v2 memungkinkan Anda menentukan pengikatan menggunakan dekorator langsung dalam kode fungsi Python Anda. Untuk informasi selengkapnya, lihat panduan pengembang Python.

v1

Model pemrograman Python v1 mengharuskan Anda menentukan pengikatan dalam file function.json terpisah di folder fungsi. Untuk informasi selengkapnya, lihat panduan pengembang Python.

Artikel ini mendukung kedua model pemrograman.

Contoh

Dukungan Go saat ini tidak tersedia untuk pengikatan ini.

Gunakan pemicu antrean untuk memulai fungsi saat item baru diterima di antrean. Pesan antrean disediakan sebagai masukan ke fungsi.

Fungsi C# dapat dibuat dengan menggunakan salah satu mode C# berikut:

• Model pekerja terisolasi: Fungsi C# terkompilasi yang berjalan dalam proses pekerja yang terisolasi dari runtime. Proses pekerja terisolasi diperlukan untuk mendukung fungsi C# yang berjalan pada versi LTS dan non-LTS .NET dan .NET Framework. Ekstensi untuk fungsi proses pekerja yang terisolasi menggunakan Microsoft.Azure.Functions.Worker.Extensions.* namespace layanan.
• Model dalam proses: Fungsi C# yang dikompilasi yang berjalan dalam proses yang sama dengan runtime Functions. Dalam variasi model ini, Functions dapat dijalankan menggunakan scripting C#, yang didukung terutama untuk pengeditan portal C#. Ekstensi untuk fungsi dalam proses menggunakan Microsoft.Azure.WebJobs.Extensions.* namespace layanan.

Penting

Dukungan akan berakhir untuk model dalam proses pada 10 November 2026. Kami sangat menyarankan Agar Anda memigrasikan aplikasi Anda ke model pekerja yang terisolasi untuk dukungan penuh.

Model pekerja terisolasi

Contoh berikut menunjukkan fungsi C# yang memilih antrean input-queue dan menulis log ke antrean output setiap kali item antrean diproses.

[Function(nameof(QueueInputOutputFunction))]
[QueueOutput("output-queue")]
public string[] QueueInputOutputFunction([QueueTrigger("input-queue")] Album myQueueItem, FunctionContext context)
{
    // Use a string array to return more than one message.
    string[] messages = {
        $"Album name = {myQueueItem.Name}",
        $"Album songs = {myQueueItem.Songs}"};

    _logger.LogInformation("{msg1},{msg2}", messages[0], messages[1]);

    // Queue Output messages
    return messages;
}

Model dalam proses

Contoh berikut menunjukkan fungsi C# yang memilih myqueue-items antrean dan menulis log setiap kali item antrean diproses.

public static class QueueFunctions
{
    [FunctionName("QueueTrigger")]
    public static void QueueTrigger(
        [QueueTrigger("myqueue-items")] string myQueueItem, 
        ILogger log)
    {
        log.LogInformation($"C# function processed: {myQueueItem}");
    }
}

Contoh Java berikut menunjukkan fungsi pemicu antrean penyimpanan, yang mencatat pesan yang dipicu ditempatkan ke dalam antrean myqueuename.

@FunctionName("queueprocessor")
public void run(
    @QueueTrigger(name = "msg",
                queueName = "myqueuename",
                connection = "myconnvarname") String message,
    final ExecutionContext context
) {
    context.getLogger().info(message);
}

Model v4

Contoh berikut menunjukkan fungsi TypeScript pemicu antrean. Fungsi ini memilih myqueue-items antrean dan menulis log setiap kali item antrean diproses.

import { app, InvocationContext } from '@azure/functions';

export async function storageQueueTrigger1(queueItem: unknown, context: InvocationContext): Promise<void> {
    context.log('Storage queue function processed work item:', queueItem);
    context.log('expirationTime =', context.triggerMetadata.expirationTime);
    context.log('insertionTime =', context.triggerMetadata.insertionTime);
    context.log('nextVisibleTime =', context.triggerMetadata.nextVisibleTime);
    context.log('id =', context.triggerMetadata.id);
    context.log('popReceipt =', context.triggerMetadata.popReceipt);
    context.log('dequeueCount =', context.triggerMetadata.dequeueCount);
}

app.storageQueue('storageQueueTrigger1', {
    queueName: 'myqueue-items',
    connection: 'MyStorageConnectionAppSetting',
    handler: storageQueueTrigger1,
});

Tip

Untuk menghindari jenis default unknown pada input antrean, gunakan parameter jenis generik (misalnya, app.storageQueue<string>(...)). Ini memerlukan @azure/functions versi 4.11.0 atau yang lebih baru. Untuk informasi selengkapnya, lihat Penggunaan.

Bagian metadata pesan menjelaskan semua variabel lain yang ditampilkan.

Model v3

Sampel TypeScript tidak didokumenkan untuk model v3.

Model v4

Contoh berikut menunjukkan antrean memicu fungsi JavaScript. Fungsi ini memilih myqueue-items antrean dan menulis log setiap kali item antrean diproses.

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

app.storageQueue('storageQueueTrigger1', {
    queueName: 'myqueue-items',
    connection: 'MyStorageConnectionAppSetting',
    handler: (queueItem, context) => {
        context.log('Storage queue function processed work item:', queueItem);
        context.log('expirationTime =', context.triggerMetadata.expirationTime);
        context.log('insertionTime =', context.triggerMetadata.insertionTime);
        context.log('nextVisibleTime =', context.triggerMetadata.nextVisibleTime);
        context.log('id =', context.triggerMetadata.id);
        context.log('popReceipt =', context.triggerMetadata.popReceipt);
        context.log('dequeueCount =', context.triggerMetadata.dequeueCount);
    },
});

Bagian penggunaan menjelaskan queueItem. Bagian metadata pesan menjelaskan semua variabel lain yang ditampilkan.

Model v3

Contoh berikut menunjukkan pengikatan pemicu antrean di file function.json dan fungsi JavaScript yang menggunakan pengikatan tersebut. Fungsi ini memilih myqueue-items antrean dan menulis log setiap kali item antrean diproses.

Berikut adalah file function.json:

{
    "disabled": false,
    "bindings": [
        {
            "type": "queueTrigger",
            "direction": "in",
            "name": "myQueueItem",
            "queueName": "myqueue-items",
            "connection":"MyStorageConnectionAppSetting"
        }
    ]
}

Bagian konfigurasi menjelaskan properti ini.

Catatan

Parameter nama mencerminkan seperti context.bindings.<name> di kode JavaScript yang berisi payload item antrean. Payload ini juga diteruskan sebagai parameter kedua bagi fungsi.

Berikut kode JavaScript:

module.exports = async function (context, message) {
    context.log('Node.js queue trigger function processed work item', message);
    // OR access using context.bindings.<name>
    // context.log('Node.js queue trigger function processed work item', context.bindings.myQueueItem);
    context.log('expirationTime =', context.bindingData.expirationTime);
    context.log('insertionTime =', context.bindingData.insertionTime);
    context.log('nextVisibleTime =', context.bindingData.nextVisibleTime);
    context.log('id =', context.bindingData.id);
    context.log('popReceipt =', context.bindingData.popReceipt);
    context.log('dequeueCount =', context.bindingData.dequeueCount);
};

Bagian penggunaan menjelaskan myQueueItem, yang dinamai oleh name properti function.json. Bagian metadata pesan menjelaskan semua variabel lain yang ditampilkan.

Contoh berikut menunjukkan cara membaca pesan antrean yang diteruskan ke fungsi melalui pemicu.

Pemicu Storage queue didefinisikan dalam file function.json ketika type diatur ke queueTrigger.

{
  "bindings": [
    {
      "name": "QueueItem",
      "type": "queueTrigger",
      "direction": "in",
      "queueName": "messages",
      "connection": "MyStorageConnectionAppSetting"
    }
  ]
}

Kode di file Run.ps1 menyatakan parameter sebagai $QueueItem, yang memungkinkan Anda untuk membaca pesan antrean dalam fungsi Anda.

# Input bindings are passed in via param block.
param([string] $QueueItem, $TriggerMetadata)

# Write out the queue message and metadata to the information log.
Write-Host "PowerShell queue trigger function processed work item: $QueueItem"
Write-Host "Queue item expiration time: $($TriggerMetadata.ExpirationTime)"
Write-Host "Queue item insertion time: $($TriggerMetadata.InsertionTime)"
Write-Host "Queue item next visible time: $($TriggerMetadata.NextVisibleTime)"
Write-Host "ID: $($TriggerMetadata.Id)"
Write-Host "Pop receipt: $($TriggerMetadata.PopReceipt)"
Write-Host "Dequeue count: $($TriggerMetadata.DequeueCount)"

Contoh berikut menunjukkan cara membaca pesan antrean yang diteruskan ke fungsi melalui pemicu. Contohnya tergantung pada apakah Anda menggunakan model pemrograman Python v1 atau v2.

v2

import logging
import azure.functions as func

app = func.FunctionApp()

@app.function_name(name="QueueFunc")
@app.queue_trigger(arg_name="msg", queue_name="inputqueue",
                   connection="storageAccountConnectionString")  # Queue trigger
@app.queue_output(arg_name="outputQueueItem", queue_name="outqueue",
                 connection="storageAccountConnectionString")  # Queue output binding
def test_function(msg: func.QueueMessage,
                  outputQueueItem: func.Out[str]) -> None:
    logging.info('Python queue trigger function processed a queue item: %s',
                 msg.get_body().decode('utf-8'))
    outputQueueItem.set('hello')

v1

Pemicu Storage queue didefinisikan di file function.json tempat tipe diatur ke queueTrigger.

{
  "scriptFile": "__init__.py",
  "bindings": [
    {
      "name": "msg",
      "type": "queueTrigger",
      "direction": "in",
      "queueName": "messages",
      "connection": "AzureStorageQueuesConnectionString"
    }
  ]
}

Kode _init_.py menyatakan parameter sebagai func.QueueMessage, yang memungkinkan Anda untuk membaca pesan antrean dalam fungsi Anda.

import logging
import json

import azure.functions as func

def main(msg: func.QueueMessage):
    logging.info('Python queue trigger function processed a queue item.')

    result = json.dumps({
        'id': msg.id,
        'body': msg.get_body().decode('utf-8'),
        'expiration_time': (msg.expiration_time.isoformat()
                            if msg.expiration_time else None),
        'insertion_time': (msg.insertion_time.isoformat()
                           if msg.insertion_time else None),
        'time_next_visible': (msg.time_next_visible.isoformat()
                              if msg.time_next_visible else None),
        'pop_receipt': msg.pop_receipt,
        'dequeue_count': msg.dequeue_count
    })

    logging.info(result)

Atribut

Pustaka C# proses dalam proses dan terisolasi menggunakan QueueTriggerAttribute untuk menentukan fungsi. Skrip C# sebagai gantinya menggunakan file konfigurasi function.json seperti yang dijelaskan dalam panduan pembuatan skrip C#.

Model pekerja terisolasi

Pada pustaka kelas C#, konstruktor atribut mengambil nama antrean untuk dipantau, seperti yang ditunjukkan dalam contoh berikut:

[Function(nameof(QueueInputOutputFunction))]
[QueueOutput("output-queue")]
public string[] QueueInputOutputFunction([QueueTrigger("input-queue")] Album myQueueItem, FunctionContext context)

Contoh ini juga menunjukkan pengaturan string koneksi di atribut itu sendiri.

Model dalam proses

Pada pustaka kelas C#, konstruktor atribut mengambil nama antrean untuk dipantau, seperti yang ditunjukkan dalam contoh berikut:

[FunctionName("QueueTrigger")]
public static void Run(
    [QueueTrigger("myqueue-items")] string myQueueItem, 
    ILogger log)
{
    ...
}

Anda dapat mengatur properti Connection untuk menentukan pengaturan aplikasi yang berisi string koneksi akun penyimpanan yang akan digunakan, seperti yang ditunjukkan dalam contoh berikut:

[FunctionName("QueueTrigger")]
public static void Run(
    [QueueTrigger("myqueue-items", Connection = "StorageConnectionAppSetting")] string myQueueItem, 
    ILogger log)
{
    ....
}

Anotasi

Anotasi QueueTrigger memberi Anda akses ke antrean yang memicu fungsi. Contoh berikut membuat pesan antrean tersedia untuk fungsi melalui parameter message.

package com.function;
import com.microsoft.azure.functions.annotation.*;
import java.util.Queue;
import com.microsoft.azure.functions.*;

public class QueueTriggerDemo {
    @FunctionName("QueueTriggerDemo")
    public void run(
        @QueueTrigger(name = "message", queueName = "messages", connection = "MyStorageConnectionAppSetting") String message,
        final ExecutionContext context
    ) {
        context.getLogger().info("Queue message: " + message);
    }
}

Properti	Deskripsi
name	Menyatakan nama parameter dalam tanda tangan fungsi. Ketika fungsi dipicu, nilai parameter ini memiliki isi pesan antrean.
queueName	Menyatakan nama antrean di akun penyimpanan.
connection	Tunjuk ke string koneksi akun penyimpanan.

Dekorator

Hanya berlaku untuk model pemrograman Python v2.

Untuk fungsi Python v2 yang ditentukan menggunakan dekorator, properti berikut pada queue_trigger dekorator menentukan pemicu Queue Storage:

Properti	Deskripsi
arg_name	Menyatakan nama parameter dalam tanda tangan fungsi. Ketika fungsi dipicu, nilai parameter ini memiliki isi pesan antrean.
queue_name	Menyatakan nama antrean di akun penyimpanan.
connection	Tunjuk ke string koneksi akun penyimpanan.

Untuk fungsi Python yang ditentukan dengan menggunakan function.json, lihat bagian Konfigurasi.

Konfigurasi

Hanya berlaku untuk model pemrograman Python v1.

Model v4

Tabel berikut menjelaskan properti yang bisa Anda atur pada objek yang options diteruskan ke app.storageQueue() metode .

Properti	Deskripsi
queueName	Nama antrean untuk polling.
koneksi	Nama pengaturan aplikasi atau koleksi pengaturan yang menentukan cara terhubung ke Azure Queue. Lihat Koneksi.

Model v3

Tabel berikut menjelaskan properti konfigurasi pengikatan yang Anda atur di file function.json.

Properti	Deskripsi
jenis	Harus diatur ke queueTrigger. Properti ini diatur secara otomatis saat Anda membuat pemicu di portal Microsoft Azure.
arah	Hanya di file function.json. Harus diatur ke in. Properti ini diatur secara otomatis saat Anda membuat pemicu di portal Microsoft Azure.
nama	Nama variabel yang berisi payload item antrean dalam kode fungsi.
queueName	Nama antrean untuk polling.
koneksi	Nama pengaturan aplikasi atau koleksi pengaturan yang menentukan cara terhubung ke Azure Queue. Lihat Koneksi.

Tabel berikut menjelaskan properti konfigurasi pengikatan yang Anda tetapkan di file function.json dan QueueTrigger atributnya.

Properti function.json	Deskripsi
jenis	Harus diatur ke queueTrigger. Properti ini diatur secara otomatis saat Anda membuat pemicu di portal Microsoft Azure.
arah	Hanya di file function.json. Harus diatur ke in. Properti ini diatur secara otomatis saat Anda membuat pemicu di portal Microsoft Azure.
nama	Nama variabel yang berisi payload item antrean dalam kode fungsi.
queueName	Nama antrean untuk polling.
koneksi	Nama pengaturan aplikasi atau koleksi pengaturan yang menentukan cara terhubung ke Azure Queue. Lihat Koneksi.

Lihat Bagian contoh untuk contoh lengkapnya.

Ketika Anda mengembangkan secara lokal, tambahkan pengaturan aplikasi di file local.settings.json dalam koleksi Values.

Penggunaan

Catatan

Fungsi mengharapkan string yang dikodekan base64. Setiap penyesuaian pada jenis pengodean (untuk menyiapkan data sebagai string yang dikodekan base64) perlu diimplementasikan dalam layanan panggilan.

Penggunaan pemicu Antrean tergantung pada versi paket ekstensi, dan modalitas C# yang digunakan di aplikasi fungsi Anda, yang dapat menjadi salah satu mode ini:

Model pekerja terisolasi

Pustaka kelas proses pekerja terisolasi yang dikompilasi fungsi C# berjalan dalam proses yang diisolasi dari runtime.

Pustaka kelas .NET Framework yang berada dalam proses

Pustaka kelas dalam proses adalah kompilasi fungsi #C yang berjalan pada proses yang sama seperti runtime Functions.

Pilih versi guna melihat detail penggunaan untuk mode dan versi.

Ekstensi 5.x+

Akses data pesan dengan menggunakan parameter metode seperti string paramName. paramName adalah nilai yang ditentukan dalam QueueTriggerAttribute. Anda bisa mengikat salah satu tipe berikut:

• Objek .NET CLR (POCO) berumur biasa
• string
• byte[]
• QueueMessage

Saat mengikat ke objek, runtime Functions mencoba mendeserialisasi payload JSON ke dalam instans kelas arbitrer yang ditentukan dalam kode Anda. Untuk contoh yang menggunakan QueueMessage, lihat repositori GitHub untuk ekstensi tersebut.

Saat atribut mengambil properti Connection, Anda juga dapat menggunakan StorageAccountAttribute untuk menentukan koneksi akun penyimpanan. Anda dapat menentukan koneksi ketika Anda perlu menggunakan akun penyimpanan yang berbeda dari fungsi lain di pustaka. Konstruktor menggunakan nama pengaturan aplikasi yang berisi string koneksi penyimpanan. Atribut dapat diterapkan pada parameter, metode, atau tingkat kelas. Contoh berikut menunjukkan tingkat kelas dan tingkat metode:

[StorageAccount("ClassLevelStorageAppSetting")]
public static class AzureFunctions
{
    [FunctionName("StorageTrigger")]
    [StorageAccount("FunctionLevelStorageAppSetting")]
    public static void Run( //...
{
    ...
}

Akun penyimpanan yang akan digunakan ditentukan dalam urutan berikut:

• Properti Connection atribut pemicu atau pengikatan.
• StorageAccount atribut yang diterapkan ke parameter yang sama dengan atribut pemicu atau pengikatan.
• Atribut StorageAccount yang diterapkan ke fungsi.
• StorageAccountAtribut yang diterapkan ke kelas.
• Akun penyimpanan default untuk aplikasi fungsi, yang ditentukan dalam pengaturan aplikasi AzureWebJobsStorage.

Ekstensi 2.x+

Akses data pesan dengan menggunakan parameter metode seperti string paramName. paramName adalah nilai yang ditentukan dalam QueueTriggerAttribute. Anda bisa mengikat salah satu tipe berikut:

• Objek CLR biasa yang sudah lama (POCO)
• string
• byte[]
• CloudQueueMessage

Saat mengikat ke objek, runtime Functions mencoba mendeserialisasi payload JSON ke dalam instans kelas arbitrer yang ditentukan dalam kode Anda. Jika Anda mencoba mengikat ke CloudQueueMessage dan mendapatkan pesan kesalahan, pastikan Anda memiliki referensi ke versi SDK Storage yang benar.

Saat atribut mengambil properti Connection, Anda juga dapat menggunakan StorageAccountAttribute untuk menentukan koneksi akun penyimpanan. Anda dapat menentukan koneksi ketika Anda perlu menggunakan akun penyimpanan yang berbeda dari fungsi lain di pustaka. Konstruktor menggunakan nama pengaturan aplikasi yang berisi string koneksi penyimpanan. Atribut dapat diterapkan pada parameter, metode, atau tingkat kelas. Contoh berikut menunjukkan tingkat kelas dan tingkat metode:

[StorageAccount("ClassLevelStorageAppSetting")]
public static class AzureFunctions
{
    [FunctionName("StorageTrigger")]
    [StorageAccount("FunctionLevelStorageAppSetting")]
    public static void Run( //...
{
    ...
}

Akun penyimpanan yang akan digunakan ditentukan dalam urutan berikut:

• Properti Connection atribut pemicu atau pengikatan.
• StorageAccount atribut yang diterapkan ke parameter yang sama dengan atribut pemicu atau pengikatan.
• Atribut StorageAccount yang diterapkan ke fungsi.
• StorageAccountAtribut yang diterapkan ke kelas.
• Akun penyimpanan default untuk aplikasi fungsi, yang ditentukan dalam pengaturan aplikasi AzureWebJobsStorage.

Ekstensi 5.x+

Pemicu antrean dapat mengikat ke jenis berikut:

Tipe	Deskripsi
string	Konten pesan sebagai string. Gunakan saat pesan adalah teks sederhana..
byte[]	Byte pesan.
Jenis yang bisa diserialisasikan JSON	Saat pesan antrean berisi data JSON, Functions mencoba mendeserialisasi data JSON ke dalam jenis objek CLR (POCO) yang sudah lama.
QueueMessage1	Pesannya.
BinaryData1	Byte pesan.

¹ Untuk menggunakan jenis ini, Anda perlu mereferensikan Microsoft.Azure.Functions.Worker.Extensions.Storage.Queues 5.2.0 atau yang lebih baru dan dependensi umum untuk pengikatan jenis SDK.

Ekstensi 2.x+

Versi ekstensi ini sebelumnya dalam proses pekerja yang terisolasi hanya mendukung pengikatan ke string. Opsi lainnya tersedia untuk Ekstensi 5.x+.

Anotasi QueueTrigger memberi Anda akses ke pesan antrean yang memicu fungsi.

Model v4

Akses item antrean sebagai argumen pertama ke fungsi Anda. Jika payload adalah JSON, nilai serinya dibatalkan menjadi objek.

Gunakan parameter jenis generik aktif app.storageQueue<string>(...) untuk mengetik input pemicu antrean. Tanpa generik, parameter input default ke unknown, yang memerlukan penyempitan jenis eksplisit sebelum Anda dapat menggunakan nilai . Dukungan jenis generik memerlukan @azure/functions versi 4.11.0 atau yang lebih baru.

Model v3

Akses item antrean menggunakan context.bindings.<NAME> di mana <NAME> cocok dengan nilai yang ditentukan dalam function.json. Jika payload adalah JSON, nilai serinya dibatalkan menjadi objek.

Model v4

Akses item antrean sebagai argumen pertama ke fungsi Anda. Jika payload adalah JSON, nilai serinya dibatalkan menjadi objek.

Model v3

Akses item antrean menggunakan context.bindings.<NAME> di mana <NAME> cocok dengan nilai yang ditentukan dalam function.json. Jika payload adalah JSON, nilai serinya dibatalkan menjadi objek.

Mengakses pesan antrean melalui parameter string yang cocok dengan nama yang ditunjuk oleh parameter pengikatan name dalam file function.json.

Mengakses pesan antrean melalui parameter yang diketik sebagai QueueMessage.

Metadata

Pemicu antrean menyediakan beberapa properti metadata. Properti ini dapat digunakan sebagai bagian dari ekspresi pengikatan dalam pengikatan lain atau sebagai parameter dalam kode Anda, untuk pekerja bahasa yang menyediakan akses ini ke metadata pesan.

Properti metadata pesan adalah anggota kelas CloudQueueMessage .

Properti metadata pesan dapat diakses dari context.triggerMetadata.

Properti metadata pesan dapat diakses dari parameter yang diteruskan $TriggerMetadata .

Properti	Tipe	Deskripsi
QueueTrigger	string	Payload antrean (jika string valid). Jika payload pesan antrean merupakan string, QueueTrigger memiliki nilai yang sama dengan variabel yang dinamai oleh propertiname di function.json.
DequeueCount	long	Berapa kali pesan ini telah dibatalkan antreannya.
ExpirationTime	DateTimeOffset	Saat pesan kedaluwarsa.
Id	string	ID pesan antrean.
InsertionTime	DateTimeOffset	Waktu pesan ditambahkan ke antrean.
NextVisibleTime	DateTimeOffset	Waktu pesan berikutnya akan ditampilkan.
PopReceipt	string	Tanda terima pop pesan.

Properti metadata pesan berikut dapat diakses dari parameter pengikatan yang diteruskan (msg dalam contoh sebelumnya).

Properti	Deskripsi
body	Antrean payload sebagai string.
dequeue_count	Berapa kali pesan ini telah dibatalkan antreannya.
expiration_time	Saat pesan kedaluwarsa.
id	ID pesan antrean.
insertion_time	Waktu pesan ditambahkan ke antrean.
time_next_visible	Waktu pesan berikutnya akan ditampilkan.
pop_receipt	Tanda terima pop pesan.

Koneksi

Properti diatur connection ke kunci dalam pengaturan aplikasi yang mengembalikan nilai yang digunakan oleh runtime Functions untuk terhubung ke akun penyimpanan yang digunakan oleh ekstensi. Nilai pengaturan properti koneksi bergantung pada jenis koneksi:

• Koneksi identitas terkelola: Properti ini connection dibagikan <CONNECTION_NAME_PREFIX> oleh sekelompok pengaturan yang bersama-sama menentukan koneksi berbasis identitas ke akun penyimpanan. Untuk informasi selengkapnya, lihat Menentukan koneksi identitas.
• Referensi Key Vault: Pengaturan connection properti mengembalikan referensi Azure Key Vault ke lokasi tempat string koneksi dipelihara secara terpusat. Untuk informasi selengkapnya, lihat Menentukan koneksi Key Vault.
• Referensi Konfigurasi Aplikasi: Pengaturan connection properti mengembalikan referensi Azure App Configuration yang mengembalikan string koneksi atau referensi Key Vault. Untuk informasi selengkapnya, lihat Azure App Configuration di artikel koneksi.
• Connection string: Pengaturan connection properti mengembalikan string koneksi akun penyimpanan aktual. Karena string koneksi berisi kunci rahasia bersama, Anda harus mempertimbangkan untuk menggunakan koneksi identitas terkelola, jika memungkinkan. Untuk informasi selengkapnya, lihat Menentukan koneksi.

Untuk mempelajari selengkapnya tentang koneksi pengikatan, lihat Mengelola koneksi di Azure Functions. Untuk mendapatkan string koneksi, ikuti langkah-langkah yang ditunjukkan di Mengelola kunci akses akun penyimpanan.

Saat Anda mengatur connection ke kunci atau awalan kunci bernama AzureWebJobsStorage atau ke string kosong, ekstensi pengikatan menggunakan akun penyimpanan host default. Untuk informasi selengkapnya, lihat Mengoptimalkan performa penyimpanan.

Pesan racun

Ketika fungsi pemicu antrean gagal, Azure Functions mencoba kembali fungsi hingga lima kali (termasuk percobaan pertama) untuk pesan antrean tertentu. Jika kelima upaya gagal, runtime fungsi akan menambahkan pesan ke antrean bernama <originalqueuename>-poison. Anda dapat menulis fungsi untuk memproses pesan dari antrean racun dengan mencatatnya atau mengirim pemberitahuan bahwa tindakan manual diperlukan.

Untuk menangani pesan racun secara manual, periksa dequeueCount dari pesan antrean.

Kunci intip

Pola peek-lock terjadi secara otomatis untuk pemicu antrean, menggunakan mekanika visibilitas yang disediakan oleh layanan penyimpanan. Saat pesan dihentikan antreannya oleh fungsi yang dipicu, pesan ditandai sebagai tidak terlihat. Eksekusi fungsi yang dipicu antrean dapat memiliki salah satu hasil ini pada pesan dalam antrean:

• Eksekusi fungsi berhasil diselesaikan dan pesan dihapus dari antrean.
• Eksekusi fungsi gagal dan host Functions memperbarui visibilitas pesan berdasarkan visibilityTimeoutpengaturan dalam file host.json. Batas waktu visibilitas default adalah nol, yang berarti bahwa pesan segera muncul kembali dalam antrean untuk pemrosesan ulang. visibilityTimeout Gunakan pengaturan untuk menunda pemrosesan ulang pesan yang gagal diproses. Pengaturan batas waktu ini berlaku untuk semua fungsi yang dipicu antrean di aplikasi fungsi.
• Host Functions mengalami crash selama eksekusi fungsi. Ketika peristiwa yang jarang terjadi ini terjadi, host tidak dapat menerapkan ke visibilityTimeout pesan yang sedang diproses. Sebagai gantinya, pesan dibiarkan dengan batas waktu default 10 menit yang ditetapkan oleh layanan penyimpanan. Setelah 10 menit, pesan muncul kembali dalam antrean untuk pemrosesan ulang. Batas waktu default yang ditentukan layanan ini tidak dapat diubah.

Algoritma polling

Pemicu antrean mengimplementasikan algoritma back-off eksponensial acak untuk mengurangi efek polling antrean menganggur pada biaya transaksi penyimpanan.

Algoritma menggunakan logika berikut:

• Ketika pesan ditemukan, runtime menunggu 100 milidetik lalu memeriksa pesan lain.
• Ketika tidak ada pesan yang ditemukan, runtime menunggu sekitar 200 milidetik sebelum mencoba lagi.
• Setelah upaya gagal berikutnya untuk mendapatkan pesan antrean, waktu tunggu terus meningkat sampai mencapai waktu tunggu maksimum default, yaitu satu menit.
• Waktu tunggu maksimum dapat dikonfigurasi melalui properti maxPollingInterval di file host.json.

Selama pengembangan lokal, interval polling maksimum default menjadi dua detik.

Catatan

Sehubungan dengan penagihan saat menghosting aplikasi fungsi dalam paket Konsumsi, Anda tidak dikenakan biaya untuk waktu yang dihabiskan untuk polling pada saat runtime.

Konkurensi

Ketika beberapa pesan antrean menunggu, pemicu antrean mengambil batch pesan dan memanggil instans fungsi secara bersamaan untuk memprosesnya. Secara default, ukuran batch adalah 16. Ketika nomor yang sedang diproses turun ke 8, runtime mendapatkan batch lain dan mulai memproses pesan tersebut. Jadi, jumlah maksimum pesan serentak yang diproses per fungsi pada satu komputer virtual (VM) adalah 24. Batas ini berlaku secara terpisah untuk setiap fungsi yang dipicu antrean pada setiap VM. Jika aplikasi fungsi Anda menskalakan ke beberapa VM, setiap VM menunggu pemicu dan mencoba menjalankan fungsi. Misalnya, jika aplikasi fungsi menskalakan hingga 3 VM, jumlah maksimum default dari instans bersamaan dari satu fungsi yang dipicu antrean adalah 72.

Ukuran batch dan ambang batas untuk mendapatkan batch baru dapat dikonfigurasi di file host.json. Jika Anda ingin meminimalkan eksekusi paralel untuk fungsi yang dipicu antrean di aplikasi fungsi, atur ukuran batch menjadi 1. Pengaturan ini menghilangkan konkurensi hanya selama aplikasi fungsi Anda berjalan pada satu komputer virtual (VM).

Pemicu antrean secara otomatis mencegah fungsi memproses pesan antrean beberapa kali secara bersamaan.

properti host.json

Terdapat setelan file host.json yang mengontrol perilaku pemicu antrean. Lihat bagian pengaturan host.json untuk detail pengaturan yang tersedia.

Langkah berikutnya

• Menulis pesan penyimpanan antrean (Pengikatan output)