@azure/functions package
Classi
| AppStartContext |
Contesto su un'app di funzione durante l'avvio dell'app. |
| AppTerminateContext |
Contesto su un'app funzione durante la terminazione dell'app. |
| Disposable |
Rappresenta un tipo che può rilasciare risorse, come l'ascolto degli eventi o un timer. |
| HookContext |
Classe base per tutti gli oggetti di contesto hook |
| HttpRequest |
Oggetto richiesta HTTP. Fornito alla funzione quando si usano associazioni HTTP. |
| HttpResponse |
Classe di risposta HTTP |
| InvocationContext |
Contiene metadati e metodi helper specifici di questa chiamata |
| InvocationHookContext |
Classe base per tutti gli oggetti contestuali hook di invocazione |
| LogHookContext |
Contesto su un log |
| McpAudioContent |
Un blocco di contenuto audio nella risposta di uno strumento MCP. |
| McpContentBlock |
Classe base astratta per i blocchi di contenuto di risposta agli strumenti MCP. La libreria Funzioni di Azure discrimina i blocchi di contenuto dai valori utente semplici usando I letterali di oggetti semplici come Estensione con tipi di blocco di contenuto personalizzatiSe la specifica MCP aggiunge un nuovo tipo di blocco — o il tuo scenario ne ha bisogno di uno personalizzato — puoi distribuire la tua sottoclasse senza alcun cambiamento di libreria. Il convertitore controlla Esempio: aggiungere un ipotetico
|
| McpImageContent |
Un blocco di contenuto immagine nella risposta di uno strumento MCP. |
| McpPromptArgumentBuilder |
Fluent Builder per dichiarare gli argomenti di prompt MCP in una mappa a forma Per impostazione predefinita, gli argomenti sono opzionali; chiama Esempio
|
| McpResourceContent |
Un blocco di contenuto con risorse incorporate nella risposta di uno strumento MCP. |
| McpResourceLinkContent |
Un blocco di contenuto a link di risorsa in una risposta a uno strumento MCP. |
| McpTextContent |
Un blocco di contenuto testuale nella risposta di uno strumento MCP. |
| McpToolResponse |
Risposta completa allo strumento MCP con blocchi di contenuto espliciti e contenuti strutturati opzionali.
Restituisci un'istanza di questa classe da un gestore di strumenti quando hai bisogno di controllo completo sia sull'array di contenuto che
|
| PostInvocationContext |
Contesto su una funzione dopo l'esecuzione. |
| PreInvocationContext |
Contesto su una funzione prima che venga eseguita. |
| PromptInvocationContext |
Oggetto di contesto strutturato passato ai gestori di prompt MCP. Fornisce accesso digitato al nome del prompt invocato, agli argomenti (tutti i valori sono stringhe), all'ID sessione opzionale e ai metadati di trasporto opzionali. Esempio
|
Interfacce
| AppStartContextInit |
Oggetto passato ai costruttori AppStartContext. Solo a scopo di test |
| AppTerminateContextInit |
Oggetto passato ai costruttori AppTerminateContext. Solo a scopo di test |
| ConnectorTriggerFunctionOptions | |
| ConnectorTriggerOptions | |
| Cookie |
Oggetto cookie di risposta HTTP a "Set-Cookie" |
| CosmosDBv3FunctionOptions | |
| CosmosDBv3InputOptions | |
| CosmosDBv3OutputOptions | |
| CosmosDBv3TriggerOptions | |
| CosmosDBv4AllVersionsAndDeletesFunctionOptions | |
| CosmosDBv4ChangeFeedItem |
Payload dell'elemento di cambio di feed a piena fedeltà emesso quando |
| CosmosDBv4ChangeFeedMetadata |
Metadati inclusi con ogni elemento di cambiamento del feed quando si utilizza |
| CosmosDBv4InputOptions | |
| CosmosDBv4LatestVersionFunctionOptions | |
| CosmosDBv4OutputOptions | |
| CosmosDBv4TriggerOptions | |
| Duration | |
| EffectiveFunctionOptions |
Le opzioni usate durante la registrazione della funzione, come passato a una chiamata specifica NOTA: questo valore può differire leggermente dall'originale perché è stato convalidato e le impostazioni predefinite potrebbero essere state aggiunte in modo esplicito |
| EventGridEvent | |
| EventGridFunctionOptions |
A questo punto nel tempo non sono disponibili opzioni specifiche del trigger di Griglia di eventi |
| EventGridOutputConnectionOptions | |
| EventGridOutputKeyOptions | |
| EventGridPartialEvent |
Link alla documentazione ed esempi Questa interfaccia "parziale" è pensata per essere utilizzata quando si crea un evento da solo e consente di lasciare fuori alcune proprietà |
| EventGridTriggerOptions |
A questo punto nel tempo non sono disponibili opzioni specifiche del trigger di Griglia di eventi |
| EventHubFunctionOptions | |
| EventHubOutputOptions | |
| EventHubTriggerOptions | |
| Exception | |
| ExponentialBackoffRetryOptions | |
| FixedDelayRetryOptions | |
| FunctionInput |
Configurazione completa per l'input secondario in una funzione ("trigger" è l'input primario) NOTA: non tutti i trigger possono essere usati come input secondari |
| FunctionOptions |
Configura gli input, gli output e il gestore per una funzione di Azure |
| FunctionOutput |
Configurazione completa per l'output in una funzione |
| FunctionTrigger |
Configurazione completa per l'input primario in una funzione |
| GenericFunctionOptions |
Configura gli input, gli output e il gestore per una funzione di Azure |
| GenericInputOptions | |
| GenericOutputOptions | |
| GenericTriggerOptions | |
| HookContextInit |
Interfaccia base per oggetti passati ai costruttori HookContext. Solo a scopo di test. |
| HttpFunctionOptions | |
| HttpOutputOptions |
A questo punto nel tempo non sono disponibili opzioni specifiche per l'output HTTP |
| HttpRequestBodyInit |
Solo a scopo di test. Questa operazione verrà sempre costruita quando viene eseguita nel contesto del runtime di Funzioni di Azure |
| HttpRequestInit |
Solo a scopo di test. Questa operazione verrà sempre costruita quando viene eseguita nel contesto del runtime di Funzioni di Azure |
| HttpRequestUser |
Oggetto che rappresenta l'utente connesso, tramite l'autenticazione di AppService/Functions o l'autenticazione SWA |
| HttpResponseInit | |
| HttpTrigger |
Configurazione completa per l'input primario in una funzione |
| HttpTriggerOptions | |
| IToolPropertyBuilder |
Interfaccia per il builder API fluente per creare le proprietà dello strumento MCP Questo funge da ponte tra l'implementazione e le dichiarazioni di tipo |
| InvocationContextExtraInputs |
Oggetto utilizzato per ottenere input secondari |
| InvocationContextExtraOutputs |
Oggetto utilizzato per impostare output secondari |
| InvocationContextInit |
Solo a scopo di test. Questa operazione verrà sempre costruita quando viene eseguita nel contesto del runtime di Funzioni di Azure |
| InvocationHookContextInit |
Oggetto passato ai costruttori InvocationHookContext. Solo a scopo di test |
| LogHookContextInit |
Oggetto passato ai costruttori LogHookContext. Solo a scopo di test |
| McpAudioContentInit |
Inizializzatore per |
| McpImageContentInit |
Inizializzatore per |
| McpPromptArgument |
Descrive un singolo argomento accettato da un prompt MCP. |
| McpPromptFunctionOptions |
Opzioni di configurazione per una funzione di prompt MCP. Questo include opzioni specifiche per trigger e opzioni di funzione generale. |
| McpPromptTriggerOptions |
Opzioni di configurazione per un trigger di prompt MCP. Queste opzioni definiscono il comportamento e i metadati del trigger. |
| McpPromptTriggerOptionsToRpc |
Le opzioni di formato wire-format inviate all'host delle funzioni per un trigger MCP Prompt.
|
| McpResourceContentInit |
Inizializzatore per |
| McpResourceFunctionOptions |
Opzioni di configurazione per una funzione di risorsa MCP. Questo include opzioni specifiche per trigger e opzioni di funzione generale. |
| McpResourceLinkContentInit |
Inizializzatore per |
| McpResourceTriggerOptions |
Opzioni di configurazione per un trigger di una risorsa MCP. Queste opzioni definiscono il comportamento e i metadati del trigger. |
| McpToolFunctionOptions |
Opzioni di configurazione per una funzione MCP Tool. Questo include opzioni specifiche per trigger e opzioni di funzione generale. |
| McpToolProperty | |
| McpToolResponseInit |
Inizializzatore per |
| McpToolTriggerOptions |
Opzioni di configurazione per un trigger dello strumento MCP. Queste opzioni definiscono il comportamento e i metadati del trigger. |
| McpToolTriggerOptionsToRpc |
Opzioni di configurazione per un trigger dello strumento MCP. Queste opzioni definiscono il comportamento e i metadati del trigger. |
| MySqlChange | |
| MySqlFunctionOptions | |
| MySqlInputOptions | |
| MySqlOutputOptions | |
| MySqlTriggerOptions | |
| PostInvocationContextInit |
Oggetto passato ai costruttori PostInvocationContext. Solo a scopo di test |
| PreInvocationContextInit |
Oggetto passato ai costruttori PreInvocationContext. Solo a scopo di test |
| RetryContext | |
| ServiceBusQueueFunctionOptions | |
| ServiceBusQueueOutputOptions | |
| ServiceBusQueueTriggerOptions | |
| ServiceBusTopicFunctionOptions | |
| ServiceBusTopicOutputOptions | |
| ServiceBusTopicTriggerOptions | |
| SetupOptions | |
| SqlChange | |
| SqlFunctionOptions | |
| SqlInputOptions | |
| SqlOutputOptions | |
| SqlTriggerOptions | |
| StorageBlobFunctionOptions | |
| StorageBlobOptions | |
| StorageBlobTriggerOptions | |
| StorageQueueFunctionOptions | |
| StorageQueueOptions | |
| TableInputOptions | |
| TableOutputOptions | |
| Timer |
Informazioni sulla pianificazione timer. Fornito alla funzione quando si usa un'associazione timer. |
| TimerFunctionOptions | |
| TimerTriggerOptions | |
| TraceContext |
Informazioni traceContext per abilitare gli scenari di traccia distribuita |
| WarmupContext | |
| WarmupFunctionOptions | |
| WarmupTriggerOptions | |
| WebPubSubConnectionInputOptions | |
| WebPubSubContextInputOptions | |
| WebPubSubFunctionOptions | |
| WebPubSubOutputOptions | |
| WebPubSubTriggerOptions | |
Alias tipo
| AppStartHandler |
Gestore per gli hook di avvio dell'app |
| AppTerminateHandler |
Handler per gli hook di terminazione dell'app |
| Arg |
Rappresenta una definizione di proprietà dello strumento (uguale a McpToolProperty ma senza propertyName) |
| Args |
Formato delle proprietà dello strumento - un oggetto che mappa i nomi delle proprietà alle loro definizioni |
| ConnectorTrigger | |
| ConnectorTriggerHandler | |
| CosmosDBChangeFeedItem | |
| CosmosDBChangeFeedMetadata | |
| CosmosDBFunctionOptions | |
| CosmosDBHandler | |
| CosmosDBInput | |
| CosmosDBInputOptions | |
| CosmosDBOutput | |
| CosmosDBOutputOptions | |
| CosmosDBTrigger | |
| CosmosDBTriggerOptions | |
| CosmosDBv3Handler | |
| CosmosDBv3Input | |
| CosmosDBv3Output | |
| CosmosDBv3Trigger | |
| CosmosDBv4FullFidelityFunctionOptions | |
| CosmosDBv4FunctionOptions | |
| CosmosDBv4Handler | |
| CosmosDBv4Input | |
| CosmosDBv4Output | |
| CosmosDBv4Trigger | |
| EventGridHandler | |
| EventGridOutput | |
| EventGridOutputOptions | |
| EventGridTrigger | |
| EventHubHandler | |
| EventHubOutput | |
| EventHubTrigger | |
| FunctionHandler | |
| FunctionResult |
Void se non viene registrato alcun output |
| HttpHandler | |
| HttpHeadersInit |
Rappresenta i tipi di header che possono essere utilizzati per inizializzare le header HTTP. Questa è una definizione locale per evitare la dipendenza da lib.dom. Compatibile con Node.js tipi nativi di header API Fetch. |
| HttpMethod |
Valori possibili per un metodo di richiesta HTTP. |
| HttpMethodFunctionOptions | |
| HttpOutput | |
| HttpRequestParams |
Indirizzare chiavi e valori dei parametri. |
| HttpRequestUserType |
Valori possibili per un tipo di utente di richiesta HTTP |
| HttpResponseBodyInit |
Rappresenta i tipi di corpo che possono essere utilizzati in una risposta HTTP. Questa è una definizione locale per evitare la dipendenza da lib.dom. Compatibile con Node.js tipi di corpo nativi dell'API Fetch. Include Node.js flussi leggibili e AsyncIterable per scenari di streaming HTTP. |
| LogCategory | |
| LogHandler | |
| LogHookHandler |
Maneggiatore per ganci di tronco. |
| LogLevel | |
| McpPromptArguments |
Forme accettate per dichiarare argomentazioni pronte.
|
| McpPromptTrigger |
Rappresenta un trigger MCP Prompt, combinando opzioni di trigger della funzione base con opzioni trigger specifiche per Prompt MCP. |
| McpPromptTriggerHandler |
Una funzione di gestore per i trigger di prompt MCP. |
| McpResourceTrigger |
Rappresenta un trigger di una risorsa MCP, combinando le opzioni di trigger della funzione base con le opzioni di trigger specifiche per la risorsa MCP. |
| McpResourceTriggerHandler |
Una funzione di gestione per i trigger di risorse MCP. |
| McpToolTrigger |
Rappresenta un trigger dello strumento MCP, combinando opzioni di trigger della funzione base con opzioni di trigger specifiche per lo strumento MCP. |
| McpToolTriggerHandler |
Una funzione di gestione per i trigger dello strumento MCP. |
| MySqlHandler | |
| MySqlInput | |
| MySqlOutput | |
| MySqlTrigger | |
| PostInvocationHandler |
Gestore per hook post-invocazione |
| PreInvocationHandler |
Handler per gli hook pre-invocazione. |
| RetryOptions | |
| ServiceBusQueueHandler | |
| ServiceBusQueueOutput | |
| ServiceBusQueueTrigger | |
| ServiceBusTopicHandler | |
| ServiceBusTopicOutput | |
| ServiceBusTopicTrigger | |
| SqlHandler | |
| SqlInput | |
| SqlOutput | |
| SqlTrigger | |
| StorageBlobHandler | |
| StorageBlobInput | |
| StorageBlobInputOptions | |
| StorageBlobOutput | |
| StorageBlobOutputOptions | |
| StorageBlobTrigger | |
| StorageQueueHandler | |
| StorageQueueOutput | |
| StorageQueueOutputOptions | |
| StorageQueueTrigger | |
| StorageQueueTriggerOptions | |
| TableInput | |
| TableOutput | |
| TimerHandler | |
| TimerTrigger | |
| TriggerMetadata |
Metadati correlati all'input che ha attivato la funzione |
| WarmupHandler | |
| WarmupTrigger | |
| WebPubSubConnectionInput | |
| WebPubSubContextInput | |
| WebPubSubHandler | |
| WebPubSubOutput | |
| WebPubSubTrigger | |
Enumerazioni
| CosmosDBv4ChangeFeedMode |
Modifica la modalità di alimentazione per i binding di trigger di Cosmos DB. |
| MySqlChangeOperation | |
| SqlChangeOperation | |
Funzioni
| Mcp |
Contrassegna una classe o una funzione costruttrice come tipo di risultato MCP che dovrebbe essere serializzato come contenuto strutturato. Quando una funzione restituisce un'istanza di un tipo decorato con questo marcatore, il risultato verrà serializzato sia come contenuto testuale (per compatibilità retroattiva) sia come contenuto strutturato (per i client che lo supportano). Senza il marcatore, un oggetto semplice viene serializzato come solo testo (JSON stringificato).
Usa
Uso programmatico (funziona senza):
Uso del decoratore (richiesto
Moduli supportati:
Vedi McpToolResponseVedi Per blocchi di contenuto espliciti + Contenuti strutturati Vedi McpTextContentSee Per restituire singoli blocchi di contenuto |
| Mcp |
Variabili
| arg | Funzione di fabbrica per creare un nuovo builder di proprietà dello strumento Esempio
|
| prompt |
Fabbrica per creare generatori di prompt MCP. Mantenuto separato dall'aiutante delle proprietà |
Dettagli funzione
McpContent<T>(T)
Contrassegna una classe o una funzione costruttrice come tipo di risultato MCP che dovrebbe essere serializzato come contenuto strutturato.
Quando una funzione restituisce un'istanza di un tipo decorato con questo marcatore, il risultato verrà serializzato sia come contenuto testuale (per compatibilità retroattiva) sia come contenuto strutturato (per i client che lo supportano).
Senza il marcatore, un oggetto semplice viene serializzato come solo testo (JSON stringificato).
Usa McpToolResponse se hai bisogno di un controllo esplicito su StructuredContent senza una classe.
Uso programmatico (funziona senza):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')
});
Uso del decoratore (richiesto experimentalDecorators: true in tsconfig):
@McpContent
class ImageMetadata { ... }
Moduli supportati:
@McpContent@McpContent()McpContent(MyClass)
Vedi McpToolResponseVedi Per blocchi di contenuto espliciti + Contenuti strutturati Vedi McpTextContentSee Per restituire singoli blocchi di contenuto
function McpContent<T>(target: T): T
Parametri
- target
-
T
Classe o funzione costruttrice opzionale da contrassegnare per contenuti strutturati.
Valori restituiti
T
La classe/funzione target invariata o un decoratore di classe.
McpContent()
function McpContent(): (target: T) => T
Valori restituiti
(target: T) => T
Dettagli delle variabili
arg
Funzione di fabbrica per creare un nuovo builder di proprietà dello strumento
Esempio
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 }
Tipo
{ boolean() => IToolPropertyBuilder, datetime() => IToolPropertyBuilder, double() => IToolPropertyBuilder, integer() => IToolPropertyBuilder, long() => IToolPropertyBuilder, number() => IToolPropertyBuilder, object() => IToolPropertyBuilder, string() => IToolPropertyBuilder }
promptArg
Fabbrica per creare generatori di prompt MCP.
Mantenuto separato dall'aiutante delle proprietà arg dello strumento perché gli argomenti del prompt non sono digitati (solo name, opzionale description, e un required flag).
promptArg: { describe(description: string) => McpPromptArgumentBuilder }
Tipo
{ describe(description: string) => McpPromptArgumentBuilder }