@azure/functions package
الفصول
| AppStartContext |
السياق حول تطبيق وظيفة أثناء بدء تشغيل التطبيق. |
| AppTerminateContext |
السياق على تطبيق وظيفة أثناء إنهاء التطبيق. |
| Disposable |
يمثل نوعا يمكنه تحرير الموارد، مثل الاستماع إلى الأحداث أو المؤقت. |
| HookContext |
الفئة الأساسية لجميع كائنات السياق الخطاف |
| HttpRequest |
كائن طلب HTTP. يتم توفيرها إلى الدالة عند استخدام روابط HTTP. |
| HttpResponse |
فئة استجابة HTTP |
| InvocationContext |
يحتوي على بيانات التعريف وأساليب المساعد الخاصة بهذا الاستدعاء |
| InvocationHookContext |
الفئة الأساسية لجميع كائنات سياق خطاف الاستدعاء |
| LogHookContext |
السياق على سجل |
| McpAudioContent |
كتلة محتوى صوتي في استجابة أداة MCP. |
| McpContentBlock |
فئة أساسية مجردة لكتل محتوى استجابة أداة MCP. تميز مكتبة دالات Azure بين كتل المحتوى وقيم المستخدم العادية باستخدام الأشكال الحرفية للكائنات العادية مثل التوسيع بأنواع كتل المحتوى المخصصةإذا أضافت مواصفة MCP نوعا جديدا من الكتلة — أو كان سيناريوك يحتاج إلى نوع مخصص — يمكنك شحن الفئة الفرعية الخاصة بك دون أي تغيير في المكتبة. المحول يتحقق مثال: إضافة افتراضي
|
| McpImageContent |
كتلة محتوى الصورة في استجابة أداة MCP. |
| McpPromptArgumentBuilder |
منشئ سلس لإعلان حجج MCP في خريطة على شكل بشكل افتراضي، الوسائط اختيارية؛ استدعى مثال
|
| McpResourceContent |
كتلة محتوى موارد مضمنة في استجابة أداة MCP. |
| McpResourceLinkContent |
كتلة محتوى ربط الموارد في استجابة أداة MCP. |
| McpTextContent |
كتلة محتوى نصية في استجابة أداة MCP. |
| McpToolResponse |
استجابة كاملة لأداة MCP مع كتل محتوى صريحة ومحتوى منظم اختياري.
أعد مثيلا من هذه الفئة من معالج أداة عندما تحتاج إلى تحكم كامل في كل من مصفوفة المحتوى و
|
| PostInvocationContext |
سياق الدالة بعد تنفيذها. |
| PreInvocationContext |
سياق الدالة قبل تنفيذها. |
| PromptInvocationContext |
كائن السياق المنظم يمرر إلى معالجات المطالبات MCP. يوفر وصولا مكتوبا إلى اسم المطالبة المستدعى، والوسائط (جميع القيم هي سلاسل نصية)، ومعرف الجلسة الاختياري، وبيانات النقل الاختيارية. مثال
|
الواجهات
| AppStartContextInit |
الكائن يمرر إلى منشئي AppStartContext. لأغراض الاختبار فقط |
| AppTerminateContextInit |
تم تمرير الكائن إلى منشئي AppTerminateContext. لأغراض الاختبار فقط |
| ConnectorTriggerFunctionOptions | |
| ConnectorTriggerOptions | |
| Cookie |
كائن ملف تعريف ارتباط استجابة Http إلى "Set-Cookie" |
| CosmosDBv3FunctionOptions | |
| CosmosDBv3InputOptions | |
| CosmosDBv3OutputOptions | |
| CosmosDBv3TriggerOptions | |
| CosmosDBv4AllVersionsAndDeletesFunctionOptions | |
| CosmosDBv4ChangeFeedItem |
تغيير عنصر التغذية بالدقة الكاملة المنبعث عندما |
| CosmosDBv4ChangeFeedMetadata |
البيانات الوصفية المضمنة مع كل عنصر تغيير في تغذية عند استخدام |
| CosmosDBv4InputOptions | |
| CosmosDBv4LatestVersionFunctionOptions | |
| CosmosDBv4OutputOptions | |
| CosmosDBv4TriggerOptions | |
| Duration | |
| EffectiveFunctionOptions |
الخيارات المستخدمة عند تسجيل الدالة، كما تم تمريرها إلى ملاحظة استدعاء معينة: قد تختلف هذه القيمة قليلا عن القيمة الأصلية لأنه تم التحقق من صحتها وربما تمت إضافة الإعدادات الافتراضية بشكل صريح |
| EventGridEvent | |
| EventGridFunctionOptions |
في هذه المرحلة من الوقت لا توجد خيارات خاصة بمشغل شبكة الأحداث |
| EventGridOutputConnectionOptions | |
| EventGridOutputKeyOptions | |
| EventGridPartialEvent |
رابط إلى المستندات والأمثلة هذه الواجهة "الجزئية" مخصصة للاستخدام عند إنشاء حدث بنفسك وتسمح بعدم استبعاد بعض الخصائص |
| EventGridTriggerOptions |
في هذه المرحلة من الوقت لا توجد خيارات خاصة بمشغل شبكة الأحداث |
| EventHubFunctionOptions | |
| EventHubOutputOptions | |
| EventHubTriggerOptions | |
| Exception | |
| ExponentialBackoffRetryOptions | |
| FixedDelayRetryOptions | |
| FunctionInput |
التكوين الكامل للإدخال الثانوي إلى دالة ("المشغل" هو الإدخال الأساسي): لا يمكن استخدام جميع المشغلات كمدخلات ثانوية |
| FunctionOptions |
تكوين المدخلات والمخرجات والمعالج لوظيفة Azure |
| FunctionOutput |
التكوين الكامل للإخراج إلى دالة |
| FunctionTrigger |
التكوين الكامل للإدخال الأساسي إلى دالة |
| GenericFunctionOptions |
تكوين المدخلات والمخرجات والمعالج لوظيفة Azure |
| GenericInputOptions | |
| GenericOutputOptions | |
| GenericTriggerOptions | |
| HookContextInit |
واجهة أساسية للكائنات التي تمرر إلى منشئي HookContext. لأغراض الاختبار فقط. |
| HttpFunctionOptions | |
| HttpOutputOptions |
في هذه المرحلة من الوقت لا توجد خيارات محددة لإخراج http |
| HttpRequestBodyInit |
لأغراض الاختبار فقط. سيتم إنشاء هذا دائما لك عند التشغيل في سياق وقت تشغيل دالات Azure |
| HttpRequestInit |
لأغراض الاختبار فقط. سيتم إنشاء هذا دائما لك عند التشغيل في سياق وقت تشغيل دالات Azure |
| HttpRequestUser |
كائن يمثل المستخدم الذي قام بتسجيل الدخول، إما من خلال مصادقة AppService/Functions، أو مصادقة SWA |
| HttpResponseInit | |
| HttpTrigger |
التكوين الكامل للإدخال الأساسي إلى دالة |
| HttpTriggerOptions | |
| IToolPropertyBuilder |
واجهة لمنشئ API السائق لإنشاء خصائص أداة MCP تعمل كجسر بين الإعلانات التنفيذية وإعلانات النوع |
| InvocationContextExtraInputs |
كائن يستخدم للحصول على مدخلات ثانوية |
| InvocationContextExtraOutputs |
كائن يستخدم لتعيين المخرجات الثانوية |
| InvocationContextInit |
لأغراض الاختبار فقط. سيتم إنشاء هذا دائما لك عند التشغيل في سياق وقت تشغيل دالات Azure |
| InvocationHookContextInit |
تم تمرير الكائن إلى منشئي InvocationHookContext. لأغراض الاختبار فقط |
| LogHookContextInit |
الكائن يمرر إلى منشئي LogHookContext. لأغراض الاختبار فقط |
| McpAudioContentInit |
المهيئ ل |
| McpImageContentInit |
المهيئ ل |
| McpPromptArgument |
يصف وسيطة واحدة مقبولة من قبل موجه MCP. |
| McpPromptFunctionOptions |
خيارات التكوين لوظيفة موجه MCP. يشمل ذلك خيارات خاصة بالمشغلات وخيارات الوظائف العامة. |
| McpPromptTriggerOptions |
خيارات التكوين لمحفز موجه MCP. تحدد هذه الخيارات السلوك والبيانات الوصفية للمشغل. |
| McpPromptTriggerOptionsToRpc |
خيارات تنسيق السلك المرسلة إلى مضيف الوظائف لتشغيل موجه MCP.
|
| McpResourceContentInit |
المهيئ ل |
| McpResourceFunctionOptions |
خيارات التكوين لدالة مورد MCP. يشمل ذلك خيارات خاصة بالمشغلات وخيارات الوظائف العامة. |
| McpResourceLinkContentInit |
المهيئ ل |
| McpResourceTriggerOptions |
خيارات التكوين لمشغل مورد MCP. تحدد هذه الخيارات السلوك والبيانات الوصفية للمشغل. |
| McpToolFunctionOptions |
خيارات التكوين لوظيفة أداة MCP. يشمل ذلك خيارات خاصة بالمشغلات وخيارات الوظائف العامة. |
| McpToolProperty | |
| McpToolResponseInit |
المهيئ ل |
| McpToolTriggerOptions |
خيارات التكوين لمشغل أداة MCP. تحدد هذه الخيارات السلوك والبيانات الوصفية للمشغل. |
| McpToolTriggerOptionsToRpc |
خيارات التكوين لمشغل أداة MCP. تحدد هذه الخيارات السلوك والبيانات الوصفية للمشغل. |
| MySqlChange | |
| MySqlFunctionOptions | |
| MySqlInputOptions | |
| MySqlOutputOptions | |
| MySqlTriggerOptions | |
| PostInvocationContextInit |
تم تمرير الكائن إلى منشئي PostInvocationContext. لأغراض الاختبار فقط |
| PreInvocationContextInit |
تم تمرير الكائن إلى منشئي PreInvocationContext. لأغراض الاختبار فقط |
| RetryContext | |
| ServiceBusQueueFunctionOptions | |
| ServiceBusQueueOutputOptions | |
| ServiceBusQueueTriggerOptions | |
| ServiceBusTopicFunctionOptions | |
| ServiceBusTopicOutputOptions | |
| ServiceBusTopicTriggerOptions | |
| SetupOptions | |
| SqlChange | |
| SqlFunctionOptions | |
| SqlInputOptions | |
| SqlOutputOptions | |
| SqlTriggerOptions | |
| StorageBlobFunctionOptions | |
| StorageBlobOptions | |
| StorageBlobTriggerOptions | |
| StorageQueueFunctionOptions | |
| StorageQueueOptions | |
| TableInputOptions | |
| TableOutputOptions | |
| Timer |
معلومات جدول المؤقت. يتم توفيرها إلى الدالة عند استخدام ربط مؤقت. |
| TimerFunctionOptions | |
| TimerTriggerOptions | |
| TraceContext |
معلومات TraceContext لتمكين سيناريوهات التتبع الموزعة |
| WarmupContext | |
| WarmupFunctionOptions | |
| WarmupTriggerOptions | |
| WebPubSubConnectionInputOptions | |
| WebPubSubContextInputOptions | |
| WebPubSubFunctionOptions | |
| WebPubSubOutputOptions | |
| WebPubSubTriggerOptions | |
النوع أسماء مستعارة
التعدادات
| CosmosDBv4ChangeFeedMode |
غير وضع التغذية لقيود مشغل Cosmos DB. |
| MySqlChangeOperation | |
| SqlChangeOperation | |
الوظائف
| Mcp |
يحدد فئة أو دالة منشئ كنوع نتيجة MCP يجب تسلسله كمحتوى منظم. عندما تعيد دالة نسخة من نوع مزين بهذا العلامة، سيتم تسلسلها كمحتوى نصي (للتوافق مع الإصدارات السابقة) ومحتوى منظم (للعملاء الذين يدعمونه). بدون العلامة، يتم تسلسل الكائن العادي كنص فقط (JSON متسلسل).
استخدم
الاستخدام البرمجي (يعمل بدون
استخدام الديكور (مطلوب
النماذج المدعومة:
راجع McpToolResponseانظر لكتل المحتوى الصريح + المحتوى الهيكلي راجع McpTextContentراجع لإرجاع كتل المحتوى المفردة |
| Mcp |
المتغيرات
| arg | وظيفة المصنع لإنشاء أداة جديدة لبناء خصائص مثال
|
| prompt |
المصنع لإنشاء منشئ وسائط MCP . يتم الاحتفاظ به منفصلا عن مساعد خاصية |
تفاصيل الوظيفة
McpContent<T>(T)
يحدد فئة أو دالة منشئ كنوع نتيجة MCP يجب تسلسله كمحتوى منظم.
عندما تعيد دالة نسخة من نوع مزين بهذا العلامة، سيتم تسلسلها كمحتوى نصي (للتوافق مع الإصدارات السابقة) ومحتوى منظم (للعملاء الذين يدعمونه).
بدون العلامة، يتم تسلسل الكائن العادي كنص فقط (JSON متسلسل).
استخدم McpToolResponse إذا كنت تحتاج إلى تحكم صريح في المحتوى الهيكلي بدون فئة.
الاستخدام البرمجي (يعمل بدون experimentalDecorators):
class ImageMetadata {
constructor(public imageId: string, public format: string) {}
}
McpContent(ImageMetadata); // marks the class
app.mcpTool('GetImage', {
toolName: 'GetImage',
description: 'Returns image info',
handler: async () => new ImageMetadata('logo', 'png')
});
استخدام الديكور (مطلوب experimentalDecorators: true في tsconfig):
@McpContent
class ImageMetadata { ... }
النماذج المدعومة:
@McpContent@McpContent()McpContent(MyClass)
راجع McpToolResponseانظر لكتل المحتوى الصريح + المحتوى الهيكلي راجع McpTextContentراجع لإرجاع كتل المحتوى المفردة
function McpContent<T>(target: T): T
المعلمات
- target
-
T
فئة اختيارية أو دالة منشئ لتحديد المحتوى المنظم.
المرتجعات
T
الفئة/الوظيفة المستهدفة دون تغيير أو مزين الفئة.
McpContent()
function McpContent(): (target: T) => T
المرتجعات
(target: T) => T
تفاصيل المُتغيّر
arg
وظيفة المصنع لإنشاء أداة جديدة لبناء خصائص
مثال
const toolProperties = {
snippetName: arg
.string()
.describe("Some Description"),
optionalField: arg
.number()
.describe("Optional number field")
.optional(),
};
arg: { boolean() => IToolPropertyBuilder, datetime() => IToolPropertyBuilder, double() => IToolPropertyBuilder, integer() => IToolPropertyBuilder, long() => IToolPropertyBuilder, number() => IToolPropertyBuilder, object() => IToolPropertyBuilder, string() => IToolPropertyBuilder }
النوع
{ boolean() => IToolPropertyBuilder, datetime() => IToolPropertyBuilder, double() => IToolPropertyBuilder, integer() => IToolPropertyBuilder, long() => IToolPropertyBuilder, number() => IToolPropertyBuilder, object() => IToolPropertyBuilder, string() => IToolPropertyBuilder }
promptArg
المصنع لإنشاء منشئ وسائط MCP .
يتم الاحتفاظ به منفصلا عن مساعد خاصية arg الأداة لأن وسائط المطالبة غير مكتوبة (فقط name، اختياري description، وعلم required ).
promptArg: { describe(description: string) => McpPromptArgumentBuilder }
النوع
{ describe(description: string) => McpPromptArgumentBuilder }