Remarque
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de vous connecter ou de modifier des répertoires.
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de modifier des répertoires.
Azure Functions fournit des extensions de déclenchement et de liaison qui s’intègrent à divers services, principalement les services Azure. L’extension Connector étend ces intégrations à une gamme beaucoup plus large de services, incluant des systèmes métier et des plateformes de données.
Par exemple, utilisez le déclencheur du connecteur pour exécuter une fonction lorsqu’un nouvel e-mail arrive en Office 365 Outlook, qu’un fichier est créé en SharePoint, ou qu’un enregistrement change dans Salesforce. Le déclencheur reçoit des événements d’un connecteur géré dans l’espace de noms Azure Connector. Pour explorer les connecteurs gérés disponibles, voir la référence des connecteurs.
Pour plus d’informations sur les connecteurs gérés, le moment de leur utilisation et la disponibilité des fonctionnalités, voir Utiliser les connecteurs gérés dans Azure Functions.
Note
Le déclencheur de connecteur n’est actuellement pas pris en charge pour ce langage.
Modes de livraison
Les connecteurs gérés supportent deux modes de livraison :
-
Évaluation : L’hôte Fonctions se connecte sortant à l’espace de noms du connecteur pour recevoir des événements. Définissez
deliveryMode: 'Poll', et fournissezconnectionettriggerConfigNamedans les options d’enregistrement. -
Webhook : L’espace de noms Connector envoie des événements au point de terminaison de rappel de l’extension. Webhook est la norme par défaut lorsque vous omettez
deliveryMode.
Les deux modes supportent des assistants nommés tels que connectors.office365.onNewEmail l’assistant générique connectorTrigger . Pour obtenir de l’aide dans le choix d’un mode, voir Choisir un mode de livraison.
Get started
Suivez le chemin de configuration de votre mode de livraison :
- Installez les paquets Node.js et configurez le bundle d’extensions.
- Créez ou réutilisez un espace de noms et une connexion, puis créez une configuration de déclencheur de sonde.
- Obtenez le point de déroulement du sondage.
- Configurez les identifiants de l’appelant, l’accès à la connexion et les paramètres locaux ou déployés.
- Utilisez un exemple de sondage ci-dessous, en faisant correspondre ses
connectionvaleurstriggerConfigNameà vos paramètres.
Le sondage ne nécessite pas de terminaison de rappel public ni de clé système. Pour la livraison webhook, la fonction de destination et le point de terminaison de rappel doivent être prêts avant de créer la configuration du déclencheur.
Modes de livraison
Les connecteurs gérés supportent deux modes de livraison :
-
Évaluation : L’hôte Fonctions se connecte sortant à l’espace de noms du connecteur pour recevoir des événements. Réglez
delivery_mode=func.DeliveryMode.POLL, et approvisionneconnectionettrigger_config_namesur@app.connector_trigger. -
Webhook : L’espace de noms Connector envoie des événements au point de terminaison de rappel de l’extension. Webhook est la norme par défaut lorsque vous omettez
delivery_mode.@app.connector_trigger
Pour obtenir de l’aide dans le choix d’un mode, voir Choisir un mode de livraison.
Get started
Suivez le chemin de configuration de votre mode de livraison :
- Installez les paquets Python et configurez le bundle d’extensions.
- Créez ou réutilisez un espace de noms et une connexion, puis créez une configuration de déclencheur de sonde.
- Obtenez le point de déroulement du sondage.
- Configurez les identifiants de l’appelant, l’accès à la connexion et les paramètres locaux ou déployés.
- Utilisez un exemple de sondage ci-dessous, en faisant correspondre ses
connectionvaleurstrigger_config_nameà vos paramètres.
Le sondage ne nécessite pas de terminaison de rappel public ni de clé système. Pour la livraison webhook, la fonction de destination et le point de terminaison de rappel doivent être prêts avant de créer la configuration du déclencheur.
Modes de livraison
Les connecteurs gérés supportent deux modes de livraison :
-
Évaluation : L’hôte Fonctions se connecte sortant à l’espace de noms du connecteur pour recevoir des événements. Définissez
DeliveryMode = ConnectorTriggerDeliveryMode.Poll, puis ajoutez les paramètres de connexion et déclenchez la configuration sur[ConnectorTrigger]. -
Webhook : L’espace de noms Connector envoie des événements au point de terminaison de rappel de l’extension. Webhook est la valeur par défaut lorsque vous omettez
DeliveryModel’attribut[ConnectorTrigger].
Pour obtenir de l’aide dans le choix d’un mode, voir Choisir un mode de livraison.
Get started
Suivez le chemin de configuration de votre mode de livraison :
- Installez l’extension.
- Créez ou réutilisez un espace de noms et une connexion, puis créez une configuration de déclencheur de sonde.
- Obtenez le point de déroulement du sondage.
- Configurez les identifiants de l’appelant, l’accès à la connexion et les paramètres locaux ou déployés.
- Utilisez un exemple ci-dessous, en associant ses
ConnectionvaleursTriggerConfigNameet à vos paramètres.
Le sondage ne nécessite pas de terminaison de rappel public ni de clé système. Pour la livraison webhook, la fonction de destination et le point de terminaison de rappel doivent être prêts avant de créer la configuration du déclencheur.
Examples
Les exemples Office 365 Outlook et SharePoint Online utilisent des charges utiles fortement typées issues du SDK Azure Connectors. Pour les opérations de connecteur qui n’ont pas encore de charges utiles fortement typées, liez pour string recevoir la charge utile JSON brute. Ces exemples enregistrent intentionnellement uniquement les informations de base de la charge utile afin de rester concentrés sur la manière de définir les fonctions déclenchées par le connecteur. Remplacez la journalisation par la logique de traitement de votre application.
Pour savoir quelles opérations de connecteur prennent en charge les payloads fortement typés pour .NET, voir Operations to Azure Functions signature mapping.
Le mode de livraison de sondage prend également en charge les propriétés optionnelles de l’attribut [ConnectorTrigger] . Pour les descriptions, les valeurs prises en charge et les valeurs par défaut, voir Propriétés d’attribut de sondage.
Office 365 Outlook
L’exemple suivant s’exécute lorsqu’un nouvel e-mail arrive dans la boîte aux lettres Office 365 Outlook configurée :
Cet exemple reçoit des lots pouvant compter jusqu’à quatre événements de connecteur, chacun contenant un e-mail, et l’utilise ConnectorEvent<T> pour accéder à la charge utile de chaque événement et MessageId.
using Microsoft.Azure.Functions.Worker;
using Microsoft.Azure.Functions.Worker.Extensions.Connector;
using Microsoft.Extensions.Logging;
using Azure.Connectors.Sdk.Office365.Models;
namespace Office365App;
public sealed class O365Functions(ILogger<O365Functions> logger)
{
[Function("OnNewEmail")]
public void OnNewEmail(
[ConnectorTrigger(
DeliveryMode = ConnectorTriggerDeliveryMode.Poll,
Connection = "ConnectorNamespace",
TriggerConfigName = "%OnNewEmailTriggerConfigName%",
IsBatched = true,
MaxBatchSize = 4,
TargetPendingEventThreshold = 16)]
ConnectorEvent<Office365OnNewEmailTriggerPayload>[] emails)
{
foreach (var email in emails)
{
var messageCount = email.Data.Body?.Value?.Count ?? 0;
logger.LogInformation(
"Poll event {MessageId}: received {MessageCount} new email message(s).",
email.MessageId,
messageCount);
}
}
}
Pour le développement local, incluez les paramètres de connexion et le nom de configuration du déclencheur dans la Values section local.settings.json:
{
"ConnectorNamespace__pollingEndpoint": "https://<connector-namespace-host>",
"OnNewEmailTriggerConfigName": "<polling-trigger-config-name>"
}
Les propriétés d’attribut font référence aux paramètres suivants :
-
Connection = "ConnectorNamespace"identifie le préfixe des paramètres. L’extension lit le point de terminaison de sondage à partir deConnectorNamespace__pollingEndpoint. Pour obtenir le point de terminaison et les informations sur les identifiants et les politiques d’accès requises, voir Accès au point de départ. -
TriggerConfigName = "%OnNewEmailTriggerConfigName%"Résout la valeur duOnNewEmailTriggerConfigNameparamètre. Définissez sa valeur sur le nom de la configuration du déclencheur de sondage dans votre espace de noms de connecteur.
Les noms du préfixe et des paramètres sont illustratifs ; si vous les modifiez, mettez à jour à la fois les propriétés de l’attribut et les paramètres pour qu’ils correspondent. Pour une application de fonction déployée, ajoutez les mêmes paramètres aux paramètres de l’application de fonction au lieu delocal.settings.json.
Le Office365OnNewEmailTriggerPayload type est défini dans l’espace Azure.Connectors.Sdk.Office365.Models de noms.
Pour l’exemple complet de code, y compris l’infrastructure et l’enregistrement des déclencheurs, voir Office 365 Outlook déclencheurs pour .NET.
SharePoint en ligne
L’exemple suivant s’exécute lorsqu’un fichier est créé dans la bibliothèque de documents SharePoint Online configurée :
Cet exemple reçoit un événement de connecteur contenant un fichier par invocation (par défaut) et l’utilise ConnectorEvent<T> pour accéder à sa charge utile et MessageId.
using Microsoft.Azure.Functions.Worker;
using Microsoft.Azure.Functions.Worker.Extensions.Connector;
using Microsoft.Extensions.Logging;
using Azure.Connectors.Sdk.SharePointOnline.Models;
namespace SharePointApp;
public sealed class SharePointFunctions(ILogger<SharePointFunctions> logger)
{
[Function("OnNewFile")]
public void OnNewFile(
[ConnectorTrigger(
DeliveryMode = ConnectorTriggerDeliveryMode.Poll,
Connection = "ConnectorNamespace",
TriggerConfigName = "%OnNewFileTriggerConfigName%")]
ConnectorEvent<SharePointOnlineOnNewFileItemsTriggerPayload> file)
{
var fileCount = file.Data.Body?.Value?.Count ?? 0;
logger.LogInformation(
"Poll event {MessageId}: received {FileCount} new SharePoint file(s).",
file.MessageId,
fileCount);
}
}
Pour le développement local, incluez ces valeurs dans l’objet Values dans local.settings.json:
{
"ConnectorNamespace__pollingEndpoint": "https://<connector-namespace-host>",
"OnNewFileTriggerConfigName": "<polling-trigger-config-name>"
}
Les propriétés d’attribut font référence aux paramètres suivants :
-
Connection = "ConnectorNamespace"identifie le préfixe des paramètres. L’extension lit le point de terminaison de sondage à partir deConnectorNamespace__pollingEndpoint. Pour obtenir le point de terminaison et les informations sur les identifiants et les politiques d’accès requises, voir Accès au point de départ. -
TriggerConfigName = "%OnNewFileTriggerConfigName%"Résout la valeur duOnNewFileTriggerConfigNameparamètre. Définissez sa valeur au nom de la configuration du déclencheur de sondage SharePoint dans votre espace de noms Connector.
Les noms du préfixe et des paramètres sont illustratifs ; si vous les modifiez, mettez à jour à la fois les propriétés de l’attribut et les paramètres pour qu’ils correspondent. Pour une application de fonction déployée, ajoutez les mêmes paramètres aux paramètres de l’application de fonction au lieu delocal.settings.json.
Le SharePointOnlineOnNewFileItemsTriggerPayload type est défini dans l’espace Azure.Connectors.Sdk.SharePointOnline.Models de noms.
Pour l’exemple complet de code, y compris l’infrastructure et l’enregistrement des déclencheurs, voir SharePoint Online déclencheurs pour .NET.
Connecteur sans charge utile fortement typée
Certains événements de connecteur n'ont pas encore de charge utile .NET fortement typée. L’exemple suivant s’exécute lorsqu’un nouveau message est ajouté à un chat ou à un canal Microsoft Teams. Le polling permet ConnectorEvent<string> de recevoir la charge utile JSON brute avec les métadonnées de livraison ; la livraison webhook se lie directement à string:
Cet exemple reçoit un événement de connecteur par invocation (par défaut) et l’utilise ConnectorEvent<string> pour accéder à sa charge utile JSON et MessageId.
using Microsoft.Azure.Functions.Worker;
using Microsoft.Azure.Functions.Worker.Extensions.Connector;
using Microsoft.Extensions.Logging;
namespace TeamsApp;
public sealed class TeamsFunctions(ILogger<TeamsFunctions> logger)
{
[Function("OnNewTeamsMessage")]
public void OnNewTeamsMessage(
[ConnectorTrigger(
DeliveryMode = ConnectorTriggerDeliveryMode.Poll,
Connection = "ConnectorNamespace",
TriggerConfigName = "%OnNewTeamsMessageTriggerConfigName%")]
ConnectorEvent<string> message)
{
logger.LogInformation(
"Poll event {MessageId}: received a Teams payload of {PayloadLength} characters.",
message.MessageId,
message.Data.Length);
}
}
Pour le développement local, incluez ces valeurs dans l’objet Values dans local.settings.json:
{
"ConnectorNamespace__pollingEndpoint": "https://<connector-namespace-host>",
"OnNewTeamsMessageTriggerConfigName": "<polling-trigger-config-name>"
}
Les propriétés d’attribut font référence aux paramètres suivants :
-
Connection = "ConnectorNamespace"identifie le préfixe des paramètres. L’extension lit le point de terminaison de sondage à partir deConnectorNamespace__pollingEndpoint. Pour obtenir le point de terminaison et les informations sur les identifiants et les politiques d’accès requises, voir Accès au point de départ. -
TriggerConfigName = "%OnNewTeamsMessageTriggerConfigName%"Résout la valeur duOnNewTeamsMessageTriggerConfigNameparamètre. Définissez sa valeur au nom de la configuration du déclencheur de sondage Teams dans votre espace de noms Connector.
Les noms du préfixe et des paramètres sont illustratifs ; si vous les modifiez, mettez à jour à la fois les propriétés de l’attribut et les paramètres pour qu’ils correspondent. Pour une application de fonction déployée, ajoutez les mêmes paramètres aux paramètres de l’application de fonction au lieu delocal.settings.json.
Pour l’exemple de code complet, incluant l’infrastructure et l’enregistrement des déclencheurs, voir Déclencheurs génériques de connecteurs pour .NET.
Mappages d’événements de connecteur
Le nom de l’opération est défini par le connecteur géré. Vous choisissez le nom de la fonction dans votre code. Les exemples de polling et de webhook utilisent les mêmes noms d’événements, d’opérations et de fonctions :
| Événement de connecteur | Nom de l’opération | Nom de la fonction |
|---|---|---|
| Nouvel e-mail Office 365 Outlook | OnNewEmailV3 |
OnNewEmail |
| Nouveau fichier SharePoint Online | GetOnNewFileItems |
OnNewFile |
| Nouveau message de chat ou de canal Microsoft Teams | WebhookNewMessageTrigger |
OnNewTeamsMessage |
Les charges utiles Webhook peuvent contenir plusieurs éléments, selon la configuration du déclencheur.
La livraison par sondage active splitOntoujours , de sorte que chaque événement en file d’attente contient un élément divisé. Cependant, le mode de sondage peut regrouper les événements en une seule invocation de fonction en définissant IsBatched = true. Pour la configuration du lot, voir Attributs.
Types de liaisons
Pour les fonctions de travail isolées .NET, les deux modes de livraison supportent ces types de paramètres :
| Type | Description |
|---|---|
string |
Reçoit le corps de l’événement en tant que JSON brut. Utilisez ce type lorsqu’un modèle SDK fortement typé n’est pas disponible ou lorsque vous souhaitez désérialiser vous-même la charge utile. |
| Modèle SDK de connecteur | Désérialise le corps d’événement JSON en un modèle spécifique à une opération à partir de Azure.Connectors.Sdk, tel que Office365OnNewEmailTriggerPayload ou SharePointOnlineOnNewFileItemsTriggerPayload. |
| POCO JSON-désérialisable | Désérialise le corps de l’événement JSON en un type .NET dont la forme correspond à la charge utile du connecteur en utilisant le sérialiseur de travail configuré. |
ConnectorEvent<T> |
Encapsule un type de charge utile supporté dans Data.
MessageId contient l’identifiant de livraison pour le sondage et est null pour la livraison webhook. |
Paramètres de matrice
Les paramètres du tableau ont des significations différentes selon chaque mode de diffusion.
Pour le sondage, IsBatched détermine la forme du paramètre de la fonction, où T est un type de charge utile d’événement pris en charge :
IsBatched |
Type de paramètre de fonction |
|---|---|
false (valeur par défaut) |
T ou ConnectorEvent<T> |
true |
T[] ou ConnectorEvent<T>[], même lorsque MaxBatchSize = 1 |
Réglé MaxBatchSize à une valeur de 1 à 32 ; sans lotage, la taille effective du lot doit être 1. La taille du lot compte les événements du connecteur, pas les éléments au sein de la charge utile d’un événement. Le batching ne change pas le type de charge utile à l’intérieur de chaque événement. La collection d’une Body.Value charge utile SDK est distincte de la matrice externe d’événements fournie à une invocation groupée.
Pour le webhook, utilisez T[] la désérialiation du corps de la matrice JSON d’un seul callback en un tableau d’éléments de payload. Ce n’est pas un lot d’événements livrés séparément. La livraison Webhook traite un rappel par invocation ; IsBatched s’applique uniquement aux sondages.
Examples
L’extension du connecteur Node.js fournit des contextes typés pour les opérations Office 365 Outlook, SharePoint Online et Microsoft Teams présentées dans cette section. Ces exemples enregistrent intentionnellement uniquement les informations de base sur la charge utile afin de rester concentrés sur la définition des fonctions déclenchées par le Connecteur. Remplacez la journalisation par la logique de traitement de votre application.
Pour trouver quelles opérations de connecteur supportent les charges utiles fortement typées pour JavaScript et TypeScript, consultez la référence de l’extensionNode.js connecteur.
Office 365 Outlook
L’exemple suivant s’exécute lorsqu’un nouvel e-mail arrive dans la boîte aux lettres Office 365 Outlook configurée :
Cet exemple reçoit jusqu’à quatre événements de connecteur par invocation. L’assistant fournit les e-mails de ces événements sous forme de liste unique.
import { InvocationContext } from '@azure/functions';
import {
connectors,
EmailTriggerContext,
} from '@azure/functions-extensions-connectors';
connectors.office365.onNewEmail('OnNewEmail', {
deliveryMode: 'Poll',
connection: 'ConnectorNamespace',
triggerConfigName: '%OnNewEmailTriggerConfigName%',
cardinality: 'many',
maxBatchSize: 4,
targetPendingEventThreshold: 16,
handler: async (
context: EmailTriggerContext,
invocationContext: InvocationContext,
) => {
invocationContext.log(
`Received ${context.emails.length} new email message(s).`,
);
},
});
Le EmailTriggerContext type expose les messages sous forme d’un tableau typé emails .
Pour des exemples supplémentaires, voir Office 365 Outlook déclencheurs pour TypeScript.
SharePoint en ligne
L’exemple suivant s’exécute lorsqu’un fichier est créé dans la bibliothèque de documents SharePoint Online configurée :
Cet exemple reçoit un événement de connecteur par invocation, la valeur par défaut. L’assistant fournit ses enregistrements de propriétés de fichier sous forme de liste.
import { InvocationContext } from '@azure/functions';
import {
connectors,
SharepointItemTriggerContext,
} from '@azure/functions-extensions-connectors';
connectors.sharepoint.onNewFileItems('OnSharepointNewFile', {
deliveryMode: 'Poll',
connection: 'ConnectorNamespace',
triggerConfigName: '%OnSharepointNewFileTriggerConfigName%',
handler: async (
context: SharepointItemTriggerContext,
invocationContext: InvocationContext,
) => {
invocationContext.log(
`Received ${context.records.length} new SharePoint file(s).`,
);
},
});
Le SharepointItemTriggerContext type expose les enregistrements de propriétés de fichier pour records l’opération GetOnNewFileItems . L’assistant conserve les champs fournis par le connecteur sans les convertir en un schéma de fichier fixe. Pour d’autres exemples, voir les déclencheurs SharePoint Online pour TypeScript.
Microsoft Teams
L’exemple suivant s’exécute lorsqu’un nouveau message est ajouté à un canal Microsoft Teams :
Cet exemple reçoit un événement de connecteur par invocation, la valeur par défaut. L’assistant fournit sa charge utile de messages sous forme de liste.
import { InvocationContext } from '@azure/functions';
import {
ChannelMessageTriggerContext,
connectors,
} from '@azure/functions-extensions-connectors';
connectors.teams.onNewChannelMessage('OnNewChannelMessage', {
deliveryMode: 'Poll',
connection: 'ConnectorNamespace',
triggerConfigName: '%OnNewTeamsMessageTriggerConfigName%',
handler: async (
context: ChannelMessageTriggerContext,
invocationContext: InvocationContext,
) => {
invocationContext.log(
`Received ${context.messages.length} new Teams message(s).`,
);
},
});
Le ChannelMessageTriggerContext type expose les messages sous forme d’un tableau typé messages .
Pour d’autres exemples, voir les déclencheurs Microsoft Teams pour TypeScript.
Charge utile de connecteur générique
Utilisez l’assistant générique lorsqu’une opération n’a pas d’enregistrement nommé. Accédez context.rawPayload lorsque votre code doit traiter la charge utile originale elle-même.
Cet exemple reçoit un événement de connecteur par invocation, la valeur par défaut. L’assistant fournit ses objets de charge sous forme de liste.
import { InvocationContext } from '@azure/functions';
import {
connectorTrigger,
ConnectorTriggerContext,
} from '@azure/functions-extensions-connectors';
connectorTrigger('OnConnectorEvent', {
deliveryMode: 'Poll',
connection: 'ConnectorNamespace',
triggerConfigName: '%GenericTriggerConfigName%',
handler: async (
context: ConnectorTriggerContext,
invocationContext: InvocationContext,
) => {
invocationContext.log(`Received ${context.items.length} payload item(s).`);
},
});
Le contexte générique attribue par défaut son type d’élément à unknown. Validez les éléments avant d’accéder aux propriétés spécifiques à l’opération.
context.rawPayload conserve l’entrée analysée avant la normalisation, y compris le tableau d’événements externe pour le polling par lots.
Examples
L’extension du connecteur Node.js fournit des contextes spécifiques au connecteur pour les opérations Office 365 Outlook, SharePoint Online et Microsoft Teams présentées dans cette section. Ces exemples enregistrent intentionnellement uniquement les informations de base sur la charge utile afin de rester concentrés sur la définition des fonctions déclenchées par le Connecteur. Remplacez la journalisation par la logique de traitement de votre application.
Pour trouver quelles opérations de connecteur supportent les charges utiles fortement typées pour JavaScript et TypeScript, consultez la référence de l’extensionNode.js connecteur.
Office 365 Outlook
L’exemple suivant s’exécute lorsqu’un nouvel e-mail arrive dans la boîte aux lettres Office 365 Outlook configurée :
Cet exemple reçoit jusqu’à quatre événements de connecteur par invocation. L’assistant fournit les e-mails de ces événements sous forme de liste unique.
const {
connectors,
} = require('@azure/functions-extensions-connectors');
connectors.office365.onNewEmail('OnNewEmail', {
deliveryMode: 'Poll',
connection: 'ConnectorNamespace',
triggerConfigName: '%OnNewEmailTriggerConfigName%',
cardinality: 'many',
maxBatchSize: 4,
targetPendingEventThreshold: 16,
handler: async (context, invocationContext) => {
invocationContext.log(
`Received ${context.emails.length} new email message(s).`,
);
},
});
Le contexte du gestionnaire expose les messages via le emails tableau.
SharePoint en ligne
L’exemple suivant s’exécute lorsqu’un fichier est créé dans la bibliothèque de documents SharePoint Online configurée :
Cet exemple reçoit un événement de connecteur par invocation, la valeur par défaut. L’assistant fournit ses enregistrements de propriétés de fichier sous forme de liste.
const {
connectors,
} = require('@azure/functions-extensions-connectors');
connectors.sharepoint.onNewFileItems('OnSharepointNewFile', {
deliveryMode: 'Poll',
connection: 'ConnectorNamespace',
triggerConfigName: '%OnSharepointNewFileTriggerConfigName%',
handler: async (context, invocationContext) => {
invocationContext.log(
`Received ${context.records.length} new SharePoint file(s).`,
);
},
});
Le contexte du gestionnaire expose les enregistrements de propriétés de fichier pour records l’opération GetOnNewFileItems . L’assistant conserve les champs fournis par le connecteur sans les convertir en un schéma de fichier fixe.
Microsoft Teams
L’exemple suivant s’exécute lorsqu’un nouveau message est ajouté à un canal Microsoft Teams :
Cet exemple reçoit un événement de connecteur par invocation, la valeur par défaut. L’assistant fournit sa charge utile de messages sous forme de liste.
const {
connectors,
} = require('@azure/functions-extensions-connectors');
connectors.teams.onNewChannelMessage('OnNewChannelMessage', {
deliveryMode: 'Poll',
connection: 'ConnectorNamespace',
triggerConfigName: '%OnNewTeamsMessageTriggerConfigName%',
handler: async (context, invocationContext) => {
invocationContext.log(
`Received ${context.messages.length} new Teams message(s).`,
);
},
});
Le contexte du gestionnaire expose les messages via le messages tableau.
Charge utile de connecteur générique
Utilisez l’assistant générique lorsqu’une opération n’a pas d’enregistrement nommé. Accédez context.rawPayload lorsque votre code doit traiter la charge utile originale elle-même.
Cet exemple reçoit un événement de connecteur par invocation, la valeur par défaut. L’assistant fournit ses objets de charge sous forme de liste.
const {
connectorTrigger,
} = require('@azure/functions-extensions-connectors');
connectorTrigger('OnConnectorEvent', {
deliveryMode: 'Poll',
connection: 'ConnectorNamespace',
triggerConfigName: '%GenericTriggerConfigName%',
handler: async (context, invocationContext) => {
invocationContext.log(`Received ${context.items.length} payload item(s).`);
},
});
Validez les éléments avant d’accéder aux propriétés spécifiques à l’opération.
context.rawPayload conserve l’entrée analysée avant la normalisation, y compris le tableau d’événements externe pour le polling par lots.
Paramètres de sondage locaux
Ajoutez les noms de configuration du point de terminaison de sondage et de déclencheur à local.settings.json:
{
"IsEncrypted": false,
"Values": {
"ConnectorNamespace__pollingEndpoint": "https://<connector-namespace-host>",
"OnNewEmailTriggerConfigName": "<outlook-polling-trigger-config-name>",
"OnSharepointNewFileTriggerConfigName": "<sharepoint-polling-trigger-config-name>",
"OnNewTeamsMessageTriggerConfigName": "<teams-polling-trigger-config-name>",
"GenericTriggerConfigName": "<generic-polling-trigger-config-name>"
}
}
La valeur des connection: 'ConnectorNamespace' exemples identifie le préfixe des paramètres. Chaque triggerConfigName expression se résout selon son paramètre correspondant dans l’application. Pour les paramètres déployés et les permissions de connexion, voir Interrogation de l’authentification.
Pour un autre exemple d’enregistrement au scrutin, voir l’échantillonNode.js sondage.
Examples
Les exemples Office 365 Outlook et SharePoint Online utilisent des convertisseurs fournis par azurefunctions-extensions-connectors. L’exemple générique reçoit le JSON brut sans annotation SDK. Ces exemples enregistrent uniquement les informations de base sur la charge utile ; remplacez la journalisation par la logique de traitement de votre application.
Pour trouver quelles opérations de connecteur supportent les payloads fortement typés pour Python, voir Concepts clés dans l’extension du connecteur Python.
Office 365 Outlook
L’exemple suivant s’exécute lorsqu’un nouvel e-mail arrive dans la boîte aux lettres Office 365 Outlook configurée :
Cet exemple reçoit jusqu’à quatre événements de connecteur par invocation. Le convertisseur fournit les e-mails de ces événements en une seule liste.
import logging
import azure.functions as func
import azurefunctions.extensions.connectors.office365 as office365
app = func.FunctionApp()
@app.function_name(name="OnNewEmail")
@app.connector_trigger(
arg_name="emails",
delivery_mode=func.DeliveryMode.POLL,
connection="ConnectorNamespace",
trigger_config_name="%OnNewEmailTriggerConfigName%",
cardinality=func.Cardinality.MANY,
max_batch_size=4,
target_pending_event_threshold=16,
)
def on_new_email(
emails: list[office365.GraphClientReceiveMessage],
) -> None:
logging.info(
"Received %s new email message(s).",
len(emails),
)
La GraphClientReceiveMessage liaison supporte l’opération OnNewEmailV3 . Pour l’enregistrement complet du code, de l’infrastructure et des déclencheurs pour les deux modes, voir Office 365 Outlook déclencheurs pour Python.
SharePoint en ligne
L’exemple suivant s’exécute lorsqu’un fichier est créé dans la bibliothèque de documents SharePoint Online configurée :
Cet exemple reçoit un événement de connecteur par invocation, la valeur par défaut. Le convertisseur fournit ses enregistrements de propriétés de fichier sous forme de liste.
import logging
import azure.functions as func
import azurefunctions.extensions.connectors.sharepointonline as sharepoint
app = func.FunctionApp()
@app.function_name(name="OnSharepointNewFile")
@app.connector_trigger(
arg_name="files",
delivery_mode=func.DeliveryMode.POLL,
connection="ConnectorNamespace",
trigger_config_name="%OnSharepointNewFileTriggerConfigName%",
)
def on_sharepoint_new_file(files: list[sharepoint.Item]) -> None:
logging.info(
"Received %s new SharePoint file(s).",
len(files),
)
La Item liaison supporte l’opération GetOnNewFileItems et préserve les propriétés du fichier dans dynamic_properties. Pour le code complet, l’infrastructure et l’enregistrement des déclencheurs pour les deux modes, voir SharePoint Online déclencheurs pour Python.
Charge utile de connecteur générique
Utilisez la azure-functions bibliothèque pour recevoir des événements sous forme de chaînes JSON brutes lorsqu’une opération ne dispose pas d’un convertisseur typé pris en charge, ou lorsque vous souhaitez analyser le JSON vous-même.
Cet exemple reçoit un événement de connecteur par invocation, la norme par défaut, sous forme de chaîne JSON brute.
import logging
import azure.functions as func
app = func.FunctionApp()
@app.function_name(name="OnConnectorEvent")
@app.connector_trigger(
arg_name="payload",
delivery_mode=func.DeliveryMode.POLL,
connection="ConnectorNamespace",
trigger_config_name="%GenericTriggerConfigName%",
)
def on_connector_event(payload: str) -> None:
logging.info("Received a connector event.")
Pour des exemples complets, voir Déclencheurs génériques de connecteurs pour Python.
Pour le sondage local, définissez les noms des points de terminaison et des déclencheurs de configuration sous Valueslocal.settings.json:
{
"IsEncrypted": false,
"Values": {
"ConnectorNamespace__pollingEndpoint": "https://<connector-namespace-host>",
"OnNewEmailTriggerConfigName": "<outlook-polling-trigger-config-name>",
"OnSharepointNewFileTriggerConfigName": "<sharepoint-polling-trigger-config-name>",
"GenericTriggerConfigName": "<generic-polling-trigger-config-name>"
}
}
La valeur des connection="ConnectorNamespace" exemples identifie le préfixe des paramètres. Chaque trigger_config_name expression se résout selon son paramètre correspondant dans l’application. Pour les paramètres déployés et les permissions de connexion, voir Interrogation de l’authentification.
Types de liaisons
Les deux modes de livraison supportent les formes d’enregistrement et de charge utile suivantes :
| Enregistrement | Entrée du gestionnaire |
|---|---|
app.connectorTrigger à partir de @azure/functions |
Reçoit l’entrée de déclenchement originale sans normalisation de l’aide. Le type d’entrée TypeScript est unknownpar défaut ; pour le polling groupé, utilisez un type tableau tel que unknown[]. |
connectorTrigger à partir de @azure/functions-extensions-connectors |
Reçoit un ConnectorTriggerContext<T> avec normalisation payload et items, analysé rawPayload, et toJSON() sérialisation. Le type d’élément TypeScript est par défaut .unknown |
Des assistants nommés tels que connectors.office365.onNewEmail |
Recevoir le contexte normalisé avec un tableau nommé, tel que emails, , ou messages, qui aliase itemsrecords. TypeScript déduit le type d’élément SDK pris en charge. |
Les assistants acceptent les entrées d’objets ou les chaînes JSON. Ils se normalisent { body: item } et { body: { value: [...] } } enveloppent. Pour le sondage en groupes, ils aplatissent la matrice extérieure des enveloppes et leurs éléments de charge utile en un seul items tableau, préservant l’ordre.
rawPayload conserve l’entrée analysée avant la normalisation, y compris le tableau d’événements externe.
Configurez cardinality: 'many' pour activer le lotage d’invocations. Un tableau dans le contexte ou un type de tableau TypeScript seul n’active pas le batching.
maxBatchSize Compte les événements du connecteur, pas les éléments dans la baie normalisée. Chaque invocation de webhook gère un callback, qui peut contenir plusieurs éléments de payload.
Les types TypeScript décrivent la charge utile attendue mais ne valident ni ne transforment les champs spécifiques à l’opération à l’exécution. Validez la charge utile avant d’accéder aux propriétés lorsque sa forme n’est pas connue. Pour les enregistrements typés pris en charge et les types de charges utiles SDK, consultez la référence de l’extension du connecteurNode.js.
Types de liaisons
Le déclencheur Connector prend en charge ces types de paramètres Python :
| Type | Description |
|---|---|
str |
Reçoit le corps de l’événement sous forme de chaîne JSON. |
dict |
Accepté comme annotation, mais le convertisseur brut ne résume pas les chaînes JSON en dictionnaires. Pour analyser le JSON brut, liez et str utilisez json.loads. |
bytes |
Reçoit le corps de l’événement sous forme d’octets bruts. |
typing.List[str] ou typing.List[bytes] |
Reçoit des événements de connecteur livrés séparément sous forme de liste lors de l’interrogation .cardinality=func.Cardinality.MANY Importez List depuis typing pour ces annotations. |
| Annotation SDK du connecteur prise en charge | Utilise un convertisseur enregistré par azurefunctions-extensions-connectors pour désérialiser la charge utile en une liste de modèles SDK spécifiques à l’opération. |
Pour les liaisons SDK, annotez le paramètre avec le type de liaison pris en charge ou une liste de ce type, telle que list[office365.GraphClientReceiveMessage]. Les liaisons SDK prises en charge retournent des listes pour les invocations à événement unique et groupées. Pour le sondage groupé, le convertisseur aplatit les événements de transport et leurs éléments de charge utile en une seule liste.
Activez cardinality=func.Cardinality.MANY le décorateur pour activer le lotage d’invocations. Une annotation de liste seule ne permet pas de faire du batching. Le paramètre de taille du lot compte les événements du connecteur, et non les éléments de la charge utile d’un événement ni le nombre de modèles dans la liste retournée.
L’accès à la connexion et l’autorisation de rappel sont séparés. L’espace de noms du connecteur gère automatiquement son propre accès à la connexion du connecteur géré. Configurez l’accès de l’application de fonction selon son mode de livraison.
Attributes
L’attribut ConnectorTrigger prend en charge les propriétés suivantes lorsqu’il DeliveryMode est défini à ConnectorTriggerDeliveryMode.Poll:
| Propriété | Required | Default | Description |
|---|---|---|---|
DeliveryMode |
Oui, pour le sondage | ConnectorTriggerDeliveryMode.Webhook |
Réglez pour ConnectorTriggerDeliveryMode.Poll utiliser le sondage. |
Connection |
Oui | null |
Identifie le préfixe de configuration pour le point de terminaison de sondage de l’espace de noms du connecteur et les paramètres d’identité. Par exemple, "ConnectorNamespace" sélectionne ConnectorNamespace__pollingEndpoint. |
TriggerConfigName |
Oui | null |
Le nom de la configuration du déclencheur de sondage dans l’espace de noms du connecteur. Fournissez le nom directement ou utilisez une expression de paramètre d’application telle que "%OnNewEmailTriggerConfigName%". |
IsBatched |
No | false |
Si chaque invocation reçoit un lot d’événements connecteurs. Quand false, chaque invocation reçoit un événement. Définir et true utiliser un paramètre de tableau pour recevoir les lots. Les lots sont traités un par un par auditeur. |
MaxBatchSize |
No | 1 |
Nombre maximal d’événements de connecteur par invocation, de 1 à 32. Lorsqu’elle est omise ou réglée à 0, utilise le réglage de defaultMaxBatchSize l’hôte, qui est par défaut à 1 moins que cela ne soit configuré autrement dans host.json. La taille effective du lot doit être 1 lorsque IsBatched est false. |
MaxConcurrentCalls |
No | 16 |
Tâches maximales de traitement simultanées à événement unique par auditeur sur une instance, y compris préparation, invocation et accusé de réception. La valeur doit être non négative. Lorsqu’elle est omise ou réglée à 0, utilise le réglage de defaultMaxConcurrentCalls l’hôte, qui est par défaut à 16 moins que cela ne soit configuré autrement dans host.json. S’applique uniquement quand IsBatched est false. Les invocations groupées traitent un lot à la fois par auditeur. |
TargetPendingEventThreshold |
No | 16 |
Nombre souhaité d’événements de connecteurs en attente par instance pour une mise à l’échelle basée sur la cible. La valeur doit être non négative. Lorsqu’elle est omise ou réglée à 0, utilise le réglage de defaultTargetPendingEventThreshold l’hôte, qui est par défaut à 16 moins que cela ne soit configuré autrement dans host.json. Le temps d’exécution peut passer outre cette cible de mise à l’échelle. Cette propriété ne change pas la taille du lot ni la concurrence d’invocation. |
Pour les paramètres par défaut à l’échelle de l’application, voir Paramètres de sondage host.json. La taille du lot compte les événements du connecteur, pas les éléments au sein de la charge utile d’un événement.
Décorateurs de scrutin
Activez delivery_mode=func.DeliveryMode.POLL@app.connector_trigger et configurez la connexion de sondage et la configuration du déclencheur :
| Parameter | Required | Default | Description |
|---|---|---|---|
arg_name |
Oui | None | Identifie le paramètre de fonction qui reçoit la charge utile. |
delivery_mode |
Oui, pour le sondage | func.DeliveryMode.WEBHOOK |
Réglez pour func.DeliveryMode.POLL utiliser le sondage. Les cordes "Poll" et "Webhook" sont également supportés. |
connection |
Oui | None | Identifie le préfixe des paramètres pour le point de terminaison de sondage et les paramètres d’identité. Par exemple, "ConnectorNamespace" sélectionne ConnectorNamespace__pollingEndpoint. |
trigger_config_name |
Oui | None | Identifie la configuration du déclencheur de sonde. Fournissez le nom directement ou utilisez une expression de paramètre d’application telle que "%OnNewEmailTriggerConfigName%". |
cardinality |
No | func.Cardinality.ONE |
Réglez sur func.Cardinality.MANY ou "many" pour activer le batching d’invocation. Les invocations groupées sont traitées une par une par auditeur. |
max_batch_size |
No | Par défaut de l’hôte : 1 |
Nombre maximal d’événements de connecteur par invocation, de 1 à 32. Lorsqu’elle est omise ou définie sur 0, utilise defaultMaxBatchSize de host.json. Sans traitement par lots, la taille effective du lot doit être 1. |
max_concurrent_calls |
No | Par défaut de l’hôte : 16 |
Tâches de traitement simultanées à événement unique par auditeur sur une seule instance. Lorsqu’elle est omise ou définie sur 0, utilise defaultMaxConcurrentCalls de host.json. La valeur doit être non négative. Cela ne s’applique pas aux invocations groupées. |
target_pending_event_threshold |
No | Par défaut de l’hôte : 16 |
Ciblez les événements en attente par instance pour une mise à l’échelle basée sur la cible. Lorsqu’elle est omise ou définie sur 0, utilise defaultTargetPendingEventThreshold de host.json. La valeur doit être non négative. Ne change pas la taille du lot ni la concurrence d’invocation ; l’exécution peut remplacer la cible de mise à l’échelle. |
Pour les paramètres par défaut à l’échelle de l’application, voir Paramètres de sondage host.json. Pour les formes de paramètres et les annotations SDK, voir Types de liaison.
Options d’enregistrement au scrutin
Définissez deliveryMode: 'Poll' sur un assistant nommé, l’assistant générique connectorTrigger , ou app.connectorTrigger, et configurez la configuration de la connexion de sondage et du déclencheur :
| Option | Required | Default | Description |
|---|---|---|---|
deliveryMode |
Oui, pour le sondage | 'Webhook' |
Réglez pour 'Poll' utiliser le sondage. |
connection |
Oui | None | Identifie le préfixe des paramètres pour le point de terminaison de sondage et les paramètres d’identité. Par exemple, 'ConnectorNamespace' sélectionne ConnectorNamespace__pollingEndpoint. |
triggerConfigName |
Oui | None | Identifie la configuration du déclencheur de sonde. Fournissez le nom directement ou utilisez une expression de paramètre d’application telle que '%OnNewEmailTriggerConfigName%'. |
cardinality |
No | 'one' |
Réglez sur 'many' pour activer le batching d’invocation. Les invocations groupées sont traitées une par une par auditeur. |
maxBatchSize |
No | Par défaut de l’hôte : 1 |
Nombre maximal d’événements de connecteur par invocation, de 1 à 32. Lorsqu’elle est omise ou définie sur 0, utilise defaultMaxBatchSize de host.json. Sans traitement par lots, la taille effective du lot doit être 1. |
maxConcurrentCalls |
No | Par défaut de l’hôte : 16 |
Tâches de traitement simultanées à événement unique par auditeur sur une seule instance. Lorsqu’elle est omise ou définie sur 0, utilise defaultMaxConcurrentCalls de host.json. La valeur doit être non négative. Cela ne s’applique pas aux invocations groupées. |
targetPendingEventThreshold |
No | Par défaut de l’hôte : 16 |
Ciblez les événements en attente par instance pour une mise à l’échelle basée sur la cible. Lorsqu’elle est omise ou définie sur 0, utilise defaultTargetPendingEventThreshold de host.json. La valeur doit être non négative. Ne change pas la taille du lot ni la concurrence d’invocation ; l’exécution peut remplacer la cible de mise à l’échelle. |
Pour les paramètres par défaut à l’échelle de l’application, voir Paramètres de sondage host.json. Pour les formes d’entrée du gestionnaire, voir Types de liaison.
Point de terminaison de sondage
Le paramètre de connexion de la fonction sélectionne le préfixe du point de terminaison de sonde. Par exemple, le préfixe "ConnectorNamespace" utilise ConnectorNamespace__pollingEndpoint. Définissez ce paramètre sous Valueslocal.settings.json pour le développement local ou dans les paramètres d’application pour une application fonctionnelle déployée, comme montré dans les exemples de sondage.
Récupérez le point de terminaison de sondage depuis le portail Connector Namespace, ou dérivez-le du service généré pollingEndpoints.receiveUri par la configuration du déclencheur comme suit. Remplacez les espaces réservés par vos valeurs de ressources.
Nécessite Azure CLI, jq, et sed.
triggerConfigId="/subscriptions/<subscription-id>/resourceGroups/<resource-group>/providers/Microsoft.Web/connectorGateways/<namespace-name>/triggerConfigs/<trigger-config-name>"
triggerConfig=$(az rest --method get \
--url "${triggerConfigId}?api-version=2026-05-01-preview" \
--query '{receiveUri:properties.pollingEndpoints.receiveUri,name:name}' \
--output json)
receiveUri=$(printf '%s' "$triggerConfig" | jq -r '.receiveUri')
pollingEndpoint=$(printf '%s' "$receiveUri" |
sed -E 's#/(api/)?trigger[Cc]onfigs/[^/]+/receive$##')
triggerConfigName=$(printf '%s' "$triggerConfig" | jq -r '.name')
printf '%s\n' "ConnectorNamespace__pollingEndpoint=$pollingEndpoint" \
"OnNewEmailTriggerConfigName=$triggerConfigName"
Dérivez le paramètre à partir de l’URI de réception générée par le service comme suit :
Service pollingEndpoints.receiveUri |
<Connection>__pollingEndpoint |
|---|---|
https://<connector-namespace-host>/api/triggerconfigs/<name>/receive |
https://<connector-namespace-host> |
https://<host>/api/connectorGateways/<id>/triggerconfigs/<name>/receive |
https://<host>/api/connectorGateways/<id> |
Conservez l’identifiant hôte et passerelle fourni par le service ; ne devinez pas un nom d’hôte ni ne configurez l’URL de réception complète, un chemin d’opération, une base autonome /api ou une chaîne de requête.
L’extension utilise ce point de terminaison avec le nom de configuration du déclencheur pour construire les URL des opérations de sondage. Pour les identifiants et les politiques d’accès nécessaires pour appeler ces URL, voir Interrogation de l’authentification.
Configuration du déclencheur de sondage
Le nom de configuration déclencheur de la fonction identifie la configuration à partir de laquelle recevoir les événements.
Interrogation des valeurs de configuration des déclencheurs
| Valeur de configuration | Description |
|---|---|
| Connexion | La connexion de connecteur gérée autorisée, telle que Office 365 Outlook ou SharePoint Online. Cela est distinct du réglage de connexion de la fonction, qui identifie un préfixe de paramètres d’application. |
| Nom de l’opération | Le déclencheur du connecteur, tel que OnNewEmailV3 ou GetOnNewFileItems. |
| Parameters | Valeurs requises par l’opération, telles qu’un dossier Outlook ou un site SharePoint et une bibliothèque de documents. |
| Nom de configuration du déclencheur | Le nom de cette configuration de déclencheur de sonde, référencé directement par la fonction ou via un paramètre d’application. |
| Mode de distribution | Comment les événements sont organisés depuis les services, via un sondage ou un mode webhook. |
Créer une configuration de déclencheur de sondage
Si vous n’avez pas déjà d’espace de noms de connecteur, créez un espace de noms de connecteur.
Allez sur le portail Espace de noms du Connecteur, puis sélectionnez votre espace de noms.
Dans le menu de l’espace de noms, sélectionnez Déclencheurs, puis sélectionnez Créer.
Trouvez le connecteur géré que vous souhaitez utiliser, puis sélectionnez l’événement qui devrait déclencher la fonction.
Sur la page de configuration du déclencheur, créez une connexion ou sélectionnez une connexion existante. La création d’une connexion nécessite une authentification unique avec le service externe.
Fournir les informations requises pour l’événement. Par exemple, l’événement Office 365 Outlook nouvel e-mail nécessite que le dossier surveille les nouveaux messages.
Pour le type de destination, choisissez Azure Functions.
Pour le mode de livraison, choisissez Sondage.
Passez en revue la configuration, puis sélectionnez Créer.
Authentification par sondage
Pour les interrogations, accordez une politique d’accès au niveau de connexion à l’identité gérée de l’application de fonction (déployée) ou à votre identité de développeur (locale). L'hôte Fonctions utilise les identifiants Microsoft Entra de cette identité pour recevoir et accuser réception des événements via le point de terminaison de sondage. L’accès à la connexion propre au Connector Namespace est géré automatiquement.
La politique de l’appelant accorde l’accès à la connexion du connecteur géré, et non à l’espace de noms lui-même. Se connecter ou activer une identité gérée n’accorde pas automatiquement cet accès à l’appelant.
Contrairement à la livraison par webhook, le sondage ne nécessite pas d’URL de rappel public ni de clé système d’application de fonction car l’application de fonction récupère les événements de l’espace de noms plutôt que de recevoir des rappels.
Les paramètres d’authentification dans les sous-sections suivantes utilisent le préfixe ConnectorNamespace, correspondant aux exemples de déclencheurs. Si votre fonction utilise un préfixe de configuration de connexion différent, utilisez ce préfixe à la place.
Accorder des politiques d’accès
Utilisez l’une ou l’autre méthode pour accorder à l’appelant de sondage l’accès à la connexion. Vous avez besoin d’une autorisation pour gérer les politiques d’accès sur la connexion. Utilisez l’ID principal (objet) de l’appelant, et non son ID d’application (client).
- Allez sur le portail Espace de noms du Connecteur, puis sélectionnez votre espace de noms.
- Ouvrez Connexions et sélectionnez la connexion du connecteur géré utilisée par votre configuration de déclencheur de sonde.
- Ouvrez l’onglet Politiques d’accès de la connexion.
- Ajoutez une politique d’accès pour l’identité de l’appelant. Pour le développement local, utilisez l’ID d’objet de votre compte développeur. Pour une application de fonction déployée, utilisez l’ID principal (objet) de l’identité gérée que votre application utilise.
- Vérifiez que l’appelant dispose d’une politique d’accès sur la connexion.
Développement local
- Connectez-vous avec votre identité de développeur, par exemple en exécutant
az login. Il s’agit du compte Microsoft Entra que l’extension utilise pour authentifier les requêtes de sondage localement. - Accorder une politique d’accès à la connexion du connecteur géré pour cette identité. Se connecter seul ne donne pas accès à la connexion.
- Définissez les paramètres de connexion sous
Valueslocal.settings.json. OmettezConnectorNamespace__credentiald’utiliser les identifiants de développeur.
Application de fonction déployée
- Activez une identité gérée attribuée par le système dans l’application de fonction, ou attribuez-lui une identité gérée attribuée par l’utilisateur.
- Accorder une politique d’accès à la connexion du connecteur géré pour cette identité.
- Configurez les paramètres d’authentification suivants dans les paramètres de l’application de fonction :
| Paramètre d’application | Valeur |
|---|---|
ConnectorNamespace__credential |
managedidentity |
ConnectorNamespace__clientId |
L’ID client de l’identité gérée attribuée par l’utilisateur à utiliser pour les interrogations. Défini uniquement lors de l’utilisation d’une identité attribuée par l’utilisateur. |
Sinon, réglez ConnectorNamespace__managedIdentityResourceId sur l’ID de ressource de l’identité attribuée par l’utilisateur au lieu de définir ConnectorNamespace__clientId. Pour une identité assignée par le système, omettez les deux sélecteurs.
Utilisation des sondages
L’hôte Fonctions se connecte sortant à l’espace de noms du connecteur pour interroger les événements et confirmer les invocations réussies. L’extension transmet les événements à votre fonction ; vous n’écrivez pas de boucle de sondage.
La livraison est au moins une fois. Les invocations échouées ne sont pas reconnues, et les événements peuvent être relivrés après l’expiration du verrouillage géré par le service. Rendre le traitement idempotent.
Si vous utilisez ConnectorEvent<T>.MessageId pour la déduplication, définissez la portée à la configuration de l’espace de noms et du déclencheur ; ne supposez pas que les identifiants de message sont uniques entre les déclencheurs.
Réglez DeliveryMode = ConnectorTriggerDeliveryMode.Poll sur [ConnectorTrigger], et fournissez les Connection propriétés et TriggerConfigName . Voir les exemples de sondages.
Pour les propriétés d’attribut, les valeurs prises en charge et les valeurs par défaut, voir Polling des propriétés d’attribut.
Réglez delivery_mode=func.DeliveryMode.POLL sur @app.connector_trigger, et fournissez connection et trigger_config_name. Voir les exemples de sondages.
L’hôte reçoit un événement par invocation sauf si cardinality=func.Cardinality.MANY l’activation par lots est disponible. Pour les lots bruts, utilisez typing.List[str] ou typing.List[bytes]; les annotations SDK prises en charge fournissent une liste de modèles. Pour les options, les valeurs prises en charge et les valeurs par défaut, voir Décorateurs de sondage.
Définissez deliveryMode: 'Poll', et fournissez connection et triggerConfigName dans les options d’enregistrement. Voir les exemples de sondages.
L’hôte reçoit un événement par invocation sauf si cardinality: 'many' l’activation par lots est disponible. Les assistants nommés et génériques combinent les éléments de payload de tous les événements en un seul contexte. Les gestionnaires directs app.connectorTrigger reçoivent plutôt le tableau d’événements externe. Pour les options, les valeurs prises en charge et les valeurs par défaut, voir Options d’enregistrement des sondages.
Mise à l’échelle et accès concurrentiel
Livraison Webhook
En mode webhook, l’espace de noms Connector envoie des requêtes HTTP au point de terminaison de rappel de l’extension. Les déclencheurs de connecteurs évoluent comme les déclencheurs HTTP, selon le comportement d’échelle HTTP du plan d’hébergement et ses limites. Pour plus de détails, voir Échelon piloté par les événements dans Azure Functions.
Livraison des sondages
En mode polling, le déclencheur du connecteur utilise une mise à l’échelle basée sur la cible basée sur le retard estimé des événements pour la configuration du déclencheur dans l’espace de noms du connecteur. La cible d’échelon est indépendante de la concurrence de traitement par instance et de la taille du lot. Pour l’équation de mise à l’échelle, les paramètres de configuration et les directives de réglage, voir Mise à l’échelle basée sur la cible des connecteurs gérés.
Enregistrement
Utilisez la fonction générique connectorTrigger pour une opération qui n’a pas d’enregistrement spécifique au connecteur :
import { InvocationContext } from '@azure/functions';
import {
connectorTrigger,
ConnectorTriggerContext,
} from '@azure/functions-extensions-connectors';
connectorTrigger('OnConnectorEvent', {
handler: async (
context: ConnectorTriggerContext,
invocationContext: InvocationContext,
) => {
invocationContext.log(JSON.stringify(context.rawPayload));
},
});
L’enregistrement générique met par défaut le type d’objet à unknown. Validez la charge utile avant d’accéder aux propriétés spécifiques à l’opération. Configurez le connecteur, le fonctionnement, les paramètres de fonctionnement, la fonction de destination et l’authentification de rappel dans la configuration du déclencheur dans l’espace de noms Azure Connector.
Enregistrement
Utilisez la fonction générique connectorTrigger pour une opération qui n’a pas d’enregistrement spécifique au connecteur :
const {
connectorTrigger,
} = require('@azure/functions-extensions-connectors');
connectorTrigger('OnConnectorEvent', {
handler: async (context, invocationContext) => {
invocationContext.log(JSON.stringify(context.rawPayload));
},
});
L’enregistrement générique normalise l’enveloppe de rappel mais ne valide pas la forme spécifique de la charge utile à l’opération. Validez la charge utile avant d’accéder aux propriétés spécifiques à l’opération. Configurez le connecteur, le fonctionnement, les paramètres de fonctionnement, la fonction de destination et l’authentification de rappel dans la configuration du déclencheur dans l’espace de noms Azure Connector.
Décorateurs
Appliquer connector_trigger à la fonction qui reçoit la charge utile de l’événement :
import azure.functions as func
app = func.FunctionApp()
@app.function_name(name="OnConnectorEvent")
@app.connector_trigger(arg_name="payload")
def on_connector_event(payload: str) -> None:
# Process the raw JSON payload.
pass
La arg_name valeur identifie le paramètre de fonction qui reçoit la charge utile. Configurez le connecteur, le fonctionnement, les paramètres de fonctionnement, la fonction de destination et l’authentification de rappel dans la configuration du déclencheur dans l’espace de noms Azure Connector.
Attributes
Contrairement au sondage, la livraison par webhook ne nécessite pas de propriétés supplémentaires sur l’attribut [ConnectorTrigger] car le webhook est le mode de livraison par défaut. Vous pouvez aussi définir DeliveryMode = ConnectorTriggerDeliveryMode.Webhook explicitement. Les propriétés spécifiques au sondage ne s’appliquent pas à la livraison par webhook.
Configuration du déclencheur webhook
L’URL de rappel de la configuration du déclencheur identifie la fonction de destination.
Valeurs de configuration des déclencheurs Webhook
| Valeur de configuration | Description |
|---|---|
| Connexion | La connexion de connecteur gérée autorisée, telle que Office 365 Outlook ou SharePoint Online. |
| Nom de l’opération | Le déclencheur du connecteur, tel que OnNewEmailV3 ou GetOnNewFileItems. |
| Parameters | Valeurs requises par l’opération, telles qu’un dossier Outlook ou un site SharePoint et une bibliothèque de documents. |
| Callback URL (URL de rappel) | L’extension Connector webhook endpoint pour la fonction de destination. Voir authentification Webhook. |
| Nom de la fonction | Le nom de la fonction enregistrée dans votre code d’application. |
| Authentication | La configuration d’authentification utilisée pour appeler l’application de fonction. |
La functionName valeur de la chaîne de requête dans l’URL de rappel doit correspondre au nom de la fonction enregistrée. Les noms valides de fonctions webhook contiennent de 1 à 128 lettres, chiffres, soulignements ou traits d’union.
Créer une configuration de déclencheur webhook
Créez une configuration de déclencheur en utilisant Azure CLI ou le portail Connector Namespace.
Configurer le déclencheur
Une configuration de déclenchement dans Azure Connector Namespace associe un événement de service externe au rappel de la fonction de destination.
Valeurs de configuration des déclencheurs
| Valeur de configuration | Description |
|---|---|
| Connexion | La connexion de connecteur gérée autorisée, telle que Office 365 Outlook ou SharePoint Online. |
| Nom de l’opération | Le déclencheur du connecteur, tel que OnNewEmailV3 ou GetOnNewFileItems. |
| Parameters | Valeurs requises par l’opération, telles qu’un dossier Outlook ou un site SharePoint et une bibliothèque de documents. |
| Callback URL (URL de rappel) | L’extension Connector webhook endpoint pour la fonction de destination. Voir authentification Webhook. |
| Nom de la fonction | Le nom de la fonction enregistrée dans votre code d’application. |
| Authentication | La configuration d’authentification utilisée pour appeler l’application de fonction. |
La functionName valeur de la chaîne de requête dans l’URL de rappel de la configuration du déclencheur doit correspondre au nom de la fonction enregistrée. Les noms de fonctions valides contiennent de 1 à 128 lettres, chiffres, sous-traits ou traits d’union.
Le nom de l’opération est défini par le connecteur géré. Vous choisissez le nom de la fonction dans votre code, et la configuration du déclencheur associe l’opération à cette fonction. Les exemples de cet article utilisent ces mappages :
| Événement de connecteur | Nom de l’opération | Nom de la fonction |
|---|---|---|
| Nouvel e-mail Office 365 Outlook | OnNewEmailV3 |
OnNewEmail |
| Nouveau fichier SharePoint Online | GetOnNewFileItems |
OnSharepointNewFile |
| Nouveau message du canal Microsoft Teams | OnNewChannelMessage |
OnNewChannelMessage |
| Événement de connecteur sélectionné | L’opération sélectionnée dans la configuration du déclencheur | OnConnectorEvent |
| Événement de connecteur | Nom de l’opération | Nom de la fonction |
|---|---|---|
| Nouvel e-mail Office 365 Outlook | OnNewEmailV3 |
OnNewEmail |
| Nouveau fichier SharePoint Online | GetOnNewFileItems |
OnSharepointNewFile |
| Événement de connecteur sélectionné | L’opération sélectionnée dans la configuration du déclencheur | OnConnectorEvent |
Créer une configuration de déclencheur
Créez une configuration de déclencheur en utilisant Azure CLI ou le portail Connector Namespace.
Avant que l’extension ne puisse recevoir un événement, créez ces ressources et configurations :
- Un espace de noms de connecteurs.
- Une connexion de connecteur gérée autorisée à accéder au service externe.
- Une configuration de déclencheur qui sélectionne l’événement du connecteur, les paramètres de fonctionnement et le mode de livraison.
Pour la livraison webhook, la configuration du déclencheur inclut également l’URL de rappel et l’authentification de rappel.
Les configurations de déclencheurs sont des ressources d’espace de noms de connecteurs que vous pouvez également déployer via ARM ou Bicep.
Les exemples Azure CLI ci-dessous utilisent une application de fonction déployée. Déployez l’application avec l’extension et la fonction destination avant de les exécuter.
L’exemple Bash suivant utilise Azure CLI et jq pour créer un déclencheur Office 365 Outlook de nouveau message. Remplacez les valeurs provisoires pour vos ressources et vos liens :
resourceGroup="<RESOURCE_GROUP>"
namespaceName="<CONNECTOR_NAMESPACE>"
functionAppName="<FUNCTION_APP>"
functionName="OnNewEmail"
triggerName="<TRIGGER_NAME>"
connectionName="<CONNECTION_NAME>"
connectorName="office365"
operationName="OnNewEmailV3"
subscriptionId=$(az account show --query id --output tsv)
connectorKey=$(az functionapp keys list \
--resource-group "$resourceGroup" \
--name "$functionAppName" \
--query "systemKeys.connector_extension" \
--output tsv)
callbackUrl="https://${functionAppName}.azurewebsites.net/runtime/webhooks/connector?functionName=${functionName}"
notificationFile=$(mktemp)
trap 'rm -f "$notificationFile"' EXIT
jq -n \
--arg callbackUrl "$callbackUrl" \
--arg connectorKey "$connectorKey" \
'{
callbackUrl: $callbackUrl,
authentication: {
type: "QueryString",
name: "code",
value: $connectorKey
}
}' > "$notificationFile"
az connector-namespace trigger create \
--resource-group "$resourceGroup" \
--namespace "$namespaceName" \
--name "$triggerName" \
--connection-details "{connectionName:${connectionName},connectorName:${connectorName}}" \
--operation-name "$operationName" \
--parameters "[{name:folderPath,value:'Inbox'}]" \
--notification-details "@$notificationFile" \
--description "${connectorName} ${operationName} -> ${functionName}" \
--metadata "{destinationType:functionApp,functionAppName:${functionAppName},functionAppResourceGroup:${resourceGroup},functionAppSubscriptionId:${subscriptionId},functionName:${functionName},recurrenceFrequency:Minute,recurrenceInterval:'5'}"
rm -f "$notificationFile"
trap - EXIT
La --parameters valeur est spécifique à l’opération du connecteur. Dans cet exemple, folderPath sélectionne le dossier Outlook à suivre. L’URL de rappel ne contient pas la clé système. L’objet notificationDetails.authentication ajoute la clé comme un secret de requête lors de l’invoque de l’espace de noms Connector la fonction.
Authentification Webhook
L’espace de noms de connecteur envoie des événements à l’application de fonction, plutôt que l’application de fonction interroge l’espace de noms. Par défaut, l’hôte Fonctions authentifie ces rappels en validant la clé système de l’extension Connector, nommée connector_extension.
L’espace de noms du connecteur gère automatiquement l’accès à sa connexion de connecteur gérée. Contrairement au sondage, l’identité de l’application de fonction n’a pas besoin d’une politique d’accès à la connexion uniquement pour recevoir les rappels webhook ; la clé système autorise ces requêtes à l’application de fonction.
URL de rappel Webhook
Application déployée
Utilisez le point de terminaison de rappel de l’extension, sans clé dans l’URL :
https://<FUNCTION_APP_HOSTNAME>/runtime/webhooks/connector?functionName=<FUNCTION_NAME>
La functionName valeur doit correspondre au nom de la fonction enregistrée : l’attribut [Function] en C#, le @app.function_name décorateur dans Python, ou l’enregistrement du déclencheur dans Node.js.
Pour une application déployée utilisant l’authentification par défaut, utilisez la clé système de connector_extension l’extension Connector, et non une clé de fonction individuelle. Après avoir déployé l’application de fonction avec l’extension, récupérez la clé système :
az functionapp keys list \
--resource-group <RESOURCE_GROUP> \
--name <FUNCTION_APP_NAME> \
--query "systemKeys.connector_extension" \
--output tsv
Dans la configuration du déclencheur, stockez la clé dans notificationDetails.authentication, séparément de l’URL de rappel :
{
"notificationDetails": {
"callbackUrl": "https://<FUNCTION_APP_HOSTNAME>/runtime/webhooks/connector?functionName=<FUNCTION_NAME>",
"authentication": {
"type": "QueryString",
"name": "code",
"value": "<CONNECTOR_EXTENSION_KEY>"
}
}
}
Lors de la livraison d’un événement, l’espace de noms Connector ajoute la clé comme code paramètre query-string. Garder la clé séparée de l’URL de rappel enregistrée permet au portail de la masquer comme un secret. N’incluez pas la clé dans l’URL de rappel enregistrée ni ne la validez sous contrôle de versions.
Les configurations de déclencheurs existantes qui incluent la clé dans l’URL de rappel continuent de fonctionner. Lorsque vous modifiez et enregistrez une configuration de déclencheur existante, la clé se déplace vers notificationDetails.authentication.
Les clés système ne peuvent pas être définies par déclencheur et nécessitent une rotation coordonnée entre l’application de fonction et l’espace de noms du connecteur. Pour les rappels basés sur l’identité sans clé partagée, voir Authentification intégrée.
Développement local de webhooks
Les rappels Webhook doivent atteindre votre hôte Fonctions en cours d’exécution depuis l’espace de noms Connector. Lorsque vous jouez localement :
Démarrez l’application de fonctions avec Azure Functions Core Tools, permettant l’autorisation :
func start --enableAuthImportant
Utilisez-le
--enableAuthtoujours lorsque vous exposez votre application via un dev tunnel. Sans cela, votre endpoint de fonction n’est absolument pas authentifié sur l’internet public.Utilisez un tunnel de développement Microsoft pour transférer un point de terminaison HTTPS public vers le port hôte local des fonctions. Réglez la visibilité du port tunnel sur Publique afin que l’espace de noms du connecteur puisse y accéder.
Construisez l’URL de rappel avec le nom d’hôte du tunnel et le nom de la fonction enregistrée, et utilisez-la dans la configuration du déclencheur webhook. Par exemple, un port de redirection tunnel 7071 vers la
OnNewFilefonction utilise une URL telle que :https://<tunnel-id>-7071.usw2.devtunnels.ms/runtime/webhooks/connector?functionName=OnNewFilePour un hôte local qui stocke des secrets dans Azurite, récupérez sa
connector_extensionclé système à l’aide de ces commandes PowerShell. Réglé$connStrsur la célèbre chaîne de connexion Azurite :$connStr = "<azurite-connection-string>" # Find the most recent host.json blob $blobs = az storage blob list --container-name azure-webjobs-secrets --connection-string $connStr -o json | ConvertFrom-Json $blobName = ($blobs | Where-Object { $_.name -match '(^|/)host\.json$' } | Sort-Object { $_.properties.lastModified } | Select-Object -Last 1).name # Download and parse az storage blob download --container-name azure-webjobs-secrets --name $blobName --connection-string $connStr --file host-keys.json --no-progress $keys = Get-Content host-keys.json | ConvertFrom-Json $connectorKey = ($keys.systemKeys | Where-Object { $_.name -eq "connector_extension" }).value Remove-Item -LiteralPath host-keys.jsonStockez séparément la clé système de
connector_extensionl’hôte local dansnotificationDetails.authentication, en utilisant le format d’authentificationQueryStringprésenté ci-dessus.Maintenez l’hôte et le tunnel en fonctionnement pendant les tests. Mettez à jour la configuration du déclencheur si le nom d’hôte du tunnel change.
Authentification intégrée
Pour les rappels webhook sans clés partagées, utilisez l’authentification intégrée du service d’application (également appelée Easy Auth) avec une identité gérée. Cette configuration est indépendante du langage de programmation de la fonction.
L’espace de noms de connecteur utilise son identité gérée assignée par le système ou l’utilisateur pour demander un jeton Microsoft Entra ID pour chaque rappel. L’authentification intégrée valide le jeton et l’identité de l’appelant avant que la requête n’atteigne l’hôte Functions. Pour une implémentation de bout en bout sans secrets client, consultez l’exemple d’authentification intégré.
Cette section couvre l’authentification de l’espace de noms vers l’application de fonction. L’espace de noms du connecteur gère automatiquement l’accès à sa connexion de connecteur gérée. Pour l’authentification des services en amont, voir aperçu des connecteurs Azure.
Configuration de l’application de fonction
Important
Cette configuration nécessite une authentification sur l’ensemble de l’application de fonction, pas seulement /runtime/webhooks/connector, et restreint l’accès à l’identité de rappel de l’espace de noms. Les fonctions HTTP existantes qui nécessitent des clés de fonction continuent de nécessiter ces clés en plus de l’authentification au niveau de l’application. Avant d’appliquer cette configuration à une application existante, assurez-vous que les clients API et les sondes d’intégrité peuvent satisfaire à la politique d’authentification et d’autorisation au niveau de l’application ainsi que à toute exigence de clé au niveau de la fonction. Sinon, les requêtes peuvent échouer avec HTTP 401 ou 403. Si l’application doit accepter d’autres appelants, adaptez la politique d’autorisation au lieu de copier cette liste d’autorisations sans modification. Pour les options de politique, voir Configurer l’autorisation Microsoft Entra.
Configurez l'authentification intégrée via la ressource ARM deauthsettingsV2 l'application de fonction ou son équivalent dans Bicep. L’exemple utilise les paramètres clés suivants :
| Setting | Purpose |
|---|---|
platform.enabled: true |
Active l’authentification intégrée. |
globalValidation.requireAuthentication: true |
Nécessite une authentification avant que les requêtes n’atteignent l’hôte des fonctions. |
globalValidation.unauthenticatedClientAction: Return401 |
Renvoie HTTP 401 pour les rappels non authentifiés au lieu de rediriger vers une page de connexion. |
identityProviders.azureActiveDirectory.enabled: true |
Active la validation du token Microsoft Entra. |
registration.clientId |
L’ID de l’application (client) de l’enregistrement de l’application Microsoft Entra qui représente l’application de fonction. |
registration.openIdIssuer |
URL de l’émetteur pour votre locataire : https://login.microsoftonline.com/{tenantId}/v2.0. |
validation.allowedAudiences |
ID client et URI d’identificateur de l’application Entra. Les jetons doivent porter un public autorisé dans la aud revendication. |
validation.defaultAuthorizationPolicy.allowedPrincipals.identities |
Les identifiants d’objet (principal) autorisaient à appeler l’application de fonction. L’exemple permet uniquement l’identité gérée du callback de l’espace de noms. Adaptez cette politique si votre application a d’autres appelants. Un jeton valide avec une oid revendication non inscrite dans la liste des autorisations est refusé avec HTTP 403. |
Les registration paramètres et validation dans ce tableau se trouvent sous identityProviders.azureActiveDirectory.
L’exemple attribue également une identité gérée attribuée par l’utilisateur à l’application de fonction et la fédére à l’enregistrement de l’application Entra. L’authentification intégrée utilise cette identification fédérée pour obtenir des assertions client sans stocker de secret client. L’exemple définit le paramètre OVERRIDE_USE_MI_FIC_ASSERTION_CLIENTID de l’application sur l’ID client de l’identité de l’application de la fonction et sur registration.clientSecretSettingName le nom de ce paramètre.
L’identité de l’application de fonction utilisée pour la fédération est distincte de l’identité de rappel de l’espace de noms. L’identité de l’espace de noms est l’appelant autorisé par allowedPrincipals.identities.
Une fois l’authentification intégrée configurée pour valider les rappels, désactivez la vérification redondante de la clé systèmehost.json:
{
"version": "2.0",
"extensions": {
"connector": {
"system": {
"webhookAuthorizationLevel": "Anonymous"
}
}
}
}
À utiliser Anonymous uniquement lorsqu’une autre couche d’authentification valide les requêtes avant qu’elles n’atteignent l’hôte des fonctions. Ce paramètre n’active pas la validation du token en soi.
Configuration de l’espace de noms du connecteur
Activez une identité gérée attribuée par le système dans l’espace de noms du connecteur, ou associez-y une identité attribuée par l’utilisateur. Dans la configuration notificationDetails.authenticationdu déclencheur , définissez :
| Propriété | Valeur |
|---|---|
type |
ManagedServiceIdentity |
audience |
L’ID client de l’enregistrement de l’application Entra, correspondant à un public accepté par l’application de fonction. |
identity |
L’ID de ressource de l’identité gérée attribuée par l’utilisateur attaché. Omettez cette propriété pour une identité assignée par le système. |
L’espace de noms utilise cet identité pour obtenir un jeton et l’envoie dans l’en-tête du Authorization: Bearer <token> rappel. Le jeton iss identifie le locataire, aud identifie l’application cible et oid identifie l’identité gérée de l’espace de noms.
L’espace de noms gère automatiquement son propre accès à la connexion du connecteur géré. Cet accès est distinct de l’autorisation de rappel, que vous configurez via l’authentification intégrée de l’application de fonction.
Flux d’authentification et validation
- L’espace de noms du connecteur obtient un jeton pour l’audience configurée en utilisant son identité gérée par rappel.
- L’espace de noms envoie le jeton avec l’événement au point de terminaison webhook de l’extension.
- L’authentification intégrée valide la signature, l’expiration, l’émetteur et l’audience du jeton, et vérifie qu’il
oidcorrespond à une identité autorisée. Les jetons manquants ou invalides reçoivent HTTP 401 ; les jetons valides provenant d’une identité non inscrite dans la liste des permissions reçoivent HTTP 403. - Seules les demandes autorisées atteignent l’hôte des fonctions. Avec la vérification de clé système redondante désactivée, l’extension invoque la fonction de destination et lie le corps de l’événement à son paramètre.
Votre fonction n’a pas besoin de code d’application pour effectuer ces vérifications d’accès.
Documentation d’authentification associée
- Authentification et autorisation dans Azure App Service et Azure Functions
- Configurer votre application App Service ou Azure Functions pour utiliser la connexion à Microsoft Entra
- Configuration basée sur des fichiers dans l’authentification des services d’application
- Fédération des identités de charge de travail dans Microsoft Entra ID
- Identités managées pour les ressources Azure
Utilisation du Webhook
L’espace de noms du connecteur envoie des événements au point de terminaison webhook de l’extension, où la functionName valeur de la chaîne de requête sélectionne la fonction. L’extension lie le corps de l’événement à votre paramètre de fonction ; vous n’implémentez pas de gestionnaire HTTP.
Le nom de la fonction doit correspondre au nom de votre [Function] attribut. Les rappels peuvent inclure x-ms-* des en-têtes identifiant la configuration du déclencheur, la connexion, le type d’événement et l’ID de corrélation, mais ces en-têtes ne sont pas disponibles pour votre fonction via le déclencheur du connecteur.
Utilisez [ConnectorTrigger] sans propriétés de sondage. Webhook est la norme par défaut lorsque vous omettez DeliveryMode. Voir les exemples de webhooks.
Votre fonction peut recevoir la charge utile d’événement en utilisant n’importe lequel des types de liaison .NET pris en charge.
L’extension accepte HTTP POST et PUT les requêtes avec le application/json type de contenu. Un corps de requête non vide doit contenir un JSON valide. Les requêtes sont soumises à la limite de corps de requête hôte Fonctions et aux limites de service en amont ; l’extension n’impose pas de plafond distinct de taille de charge utile.
Pour configurer la limite de corps de requête hôte, réglez le paramètre de l’application à l’échelle FUNCTIONS_REQUEST_BODY_SIZE_LIMIT de l’application en octets et redémarrez l’hôte. Ce n’est pas un host.json réglage et ne modifie pas les téléchargements à sortie liée Poll, qui utilisent extensions.connector.maxLinkedOutputSizeInBytes. Des limites plus élevées ne garantissent pas les tailles de charge utile prises en charge ; tiennent compte du buffering, de la mémoire de travail et des limites en amont.
Utilisation du Webhook
L’assistant générique reçoit un ConnectorTriggerContext<T>. Sa payload propriété contient l’enveloppe de rappel normalisée, items contient les éléments d’événement, et rawPayload conserve l’entrée analysée avant la normalisation. Les enregistrements spécifiques au connecteur fournissent des tableaux nommés, tels que emails, records, ou messages.
Chaque invocation gère un rappel, qui peut contenir plusieurs éléments de payload. Pour une opération sans enregistrement spécifique au connecteur, le type d’élément TypeScript est par défaut .unknown Validez la charge utile avant d’accéder aux propriétés spécifiques à l’opération. Pour les enregistrements typés pris en charge, consultez la référence de l’extension du connecteurNode.js.
Utilisation du Webhook
Le déclencheur peut lier le corps de la requête à str, dict, ou bytes. Lorsqu’il azurefunctions-extensions-connectors enregistre un convertisseur pour l’annotation SDK de la fonction, le travailleur désérialise le corps de la requête dans le type spécifique à l’opération supporté.
Chaque invocation gère un rappel. Les liaisons SDK prises en charge fournissent ses éléments de payload sous forme de liste ; utilisez une annotation telle que list[office365.GraphClientReceiveMessage]. Pour les annotations spécifiques à l’opération prises en charge, consultez le mappage de signature d’opération.
L’extension accepte HTTP POST et PUT les requêtes avec le application/json type de contenu. Un corps de requête non vide doit contenir un JSON valide. Les requêtes sont soumises à la limite de corps de requête hôte des Fonctions et aux limites de service en amont.
Metadata
Le déclencheur Connector n’expose actuellement pas les en-têtes de rappel ni d’autres métadonnées de requête comme données de liaison. L’extension définit un contrat de liaison vide, de sorte que la fonction ne reçoit que le corps de la requête JSON dans un type de liaison supporté par le langage sélectionné.