référence host.json pour Azure Functions 1.x

Le fichier de métadonnées host.json contient des options de configuration qui affectent l’ensemble des fonctions d’une instance d’application de fonction. Cet article répertorie les paramètres disponibles pour le runtime version 1.x. Le schéma JSON est sur http://json.schemastore.org/host.

Les autres options de configuration d’application de fonction sont managées dans vos paramètres d’application.

Certains paramètres host.json sont uniquement utilisés lors de l’exécution locale dans le fichier local.settings.json.

Exemple de fichier host.json

L’exemple de fichier host.json suivant contient toutes les options possibles spécifiées.

{
    "aggregator": {
        "batchSize": 1000,
        "flushTimeout": "00:00:30"
    },
    "applicationInsights": {
        "sampling": {
          "isEnabled": true,
          "maxTelemetryItemsPerSecond" : 5
        }
    },
    "documentDB": {
        "connectionMode": "Gateway",
        "protocol": "Https",
        "leaseOptions": {
            "leasePrefix": "prefix"
        }
    },
    "eventHub": {
      "maxBatchSize": 64,
      "prefetchCount": 256,
      "batchCheckpointFrequency": 1
    },
    "functions": [ "QueueProcessor", "GitHubWebHook" ],
    "functionTimeout": "00:05:00",
    "healthMonitor": {
        "enabled": true,
        "healthCheckInterval": "00:00:10",
        "healthCheckWindow": "00:02:00",
        "healthCheckThreshold": 6,
        "counterThreshold": 0.80
    },
    "http": {
        "routePrefix": "api",
        "maxOutstandingRequests": 20,
        "maxConcurrentRequests": 10,
        "dynamicThrottlesEnabled": false
    },
    "id": "9f4ea53c5136457d883d685e57164f08",
    "logger": {
        "categoryFilter": {
            "defaultLevel": "Information",
            "categoryLevels": {
                "Host": "Error",
                "Function": "Error",
                "Host.Aggregator": "Information"
            }
        }
    },
    "queues": {
      "maxPollingInterval": 2000,
      "visibilityTimeout" : "00:00:30",
      "batchSize": 16,
      "maxDequeueCount": 5,
      "newBatchThreshold": 8
    },
    "sendGrid": {
        "from": "Contoso Group <admin@contoso.com>"
    },
    "serviceBus": {
      "maxConcurrentCalls": 16,
      "prefetchCount": 100,
      "autoRenewTimeout": "00:05:00",
      "autoComplete": true
    },
    "singleton": {
      "lockPeriod": "00:00:15",
      "listenerLockPeriod": "00:01:00",
      "listenerLockRecoveryPollingInterval": "00:01:00",
      "lockAcquisitionTimeout": "00:01:00",
      "lockAcquisitionPollingInterval": "00:00:03"
    },
    "tracing": {
      "consoleLevel": "verbose",
      "fileLoggingMode": "debugOnly"
    },
    "watchDirectories": [ "Shared" ],
}

Les sections suivantes de cet article expliquent chaque propriété de niveau supérieur. Tous sont facultatifs sauf indication contraire.

agrégateur

Spécifie le nombre d’appels de fonction agrégés lorsque vous calculez des métriques pour Application Insights.

{
    "aggregator": {
        "batchSize": 1000,
        "flushTimeout": "00:00:30"
    }
}

Les invocations de fonctions sont agrégées lorsque la première des deux limites est atteinte.

AnalysesDesApplications

Contrôle la fonctionnalité d’échantillonnage dans Application Insights.

{
        "applicationInsights": {
                "sampling": {
                    "isEnabled": true,
                    "maxTelemetryItemsPerSecond" : 5
                }
        }
}

Base de données de documents

Paramètres de configuration du déclencheur et des liaisons Azure Cosmos DB.

{
    "documentDB": {
        "connectionMode": "Gateway",
        "protocol": "Https",
        "leaseOptions": {
            "leasePrefix": "prefix1"
        }
    }
}

durableTask

Paramètres de configuration pour Durable Functions.

Dans Azure Functions runtime 1.x, la durableTask section se trouve à la racine du fichierhost.json. Les paramètres disponibles dépendent de la version de l’extension Durable Functions. Pour la référence de configuration actuelle, voir Durable Functions host.json paramètres.

eventHub

Paramètres de configuration pour les déclencheurs et liaisons Event Hub.

fonctions

Liste des fonctions que l’hôte de travail exécute. Un tableau vide désigne l’exécution de toutes les fonctions. Utilisée uniquement pour une exécution locale. Dans les applications fonctionnelles Azure, vous devez suivre les étapes du guide How to disable functions in Azure Functions pour désactiver des fonctions spécifiques plutôt que d’utiliser ce paramètre.

{
    "functions": [ "QueueProcessor", "GitHubWebHook" ]
}

functionTimeout

Indique la durée du délai d’expiration de toutes les fonctions. Dans les plans de consommation serverless, la plage valide est comprise entre 1 seconde et 10 minutes, et la valeur par défaut est de 5 minutes. Dans un plan App Service, il n’existe aucune limite globale et la valeur par défaut est null, ce qui indique qu’il n’y a pas de délai d’expiration.

{
    "functionTimeout": "00:05:00"
}

healthMonitor

Paramètres de configuration pour Host health monitor.

{
    "healthMonitor": {
        "enabled": true,
        "healthCheckInterval": "00:00:10",
        "healthCheckWindow": "00:02:00",
        "healthCheckThreshold": 6,
        "counterThreshold": 0.80
    }
}

http

Paramètres de configuration pour les déclencheurs HTTP et les liaisons.

{
    "http": {
        "routePrefix": "api",
        "maxOutstandingRequests": 200,
        "maxConcurrentRequests": 100,
        "dynamicThrottlesEnabled": true
    }
}

id

ID unique d’un hôte de travail. Il peut s’agir d’un GUID en minuscules dont les tirets ont été supprimés. Requis lors d’une exécution locale. Lors de l’exécution dans Azure, nous vous recommandons de ne pas définir de valeur d’ID. Un ID est généré automatiquement dans Azure lorsque id est omis.

Si vous partagez un compte de stockage entre plusieurs applications fonctionnelles, assurez-vous que chaque application fonctionnelle a une id différente. Vous pouvez omettre la propriété id ou définir manuellement chaque id de l’application de fonction sur une autre valeur. Le déclencheur du minuteur utilise un verrou de stockage pour garantir qu’il n’y aura qu’une seule instance du minuteur quand une application de fonction fera l’objet d’un scale-out vers plusieurs instances. Si deux applications de fonction partagent le même id et que chacune utilise un déclencheur de minuteur, un seul minuteur s’exécute.

{
    "id": "9f4ea53c5136457d883d685e57164f08"
}

logger

Contrôle le filtrage des journaux d’activité écrits par un objet ILogger ou par context.log.

{
    "logger": {
        "categoryFilter": {
            "defaultLevel": "Information",
            "categoryLevels": {
                "Host": "Error",
                "Function": "Error",
                "Host.Aggregator": "Information"
            }
        }
    }
}

queues

Paramètre de configuration des déclencheurs et liaisons de file d’attente de stockage.

{
    "queues": {
      "maxPollingInterval": 2000,
      "visibilityTimeout" : "00:00:30",
      "batchSize": 16,
      "maxDequeueCount": 5,
      "newBatchThreshold": 8
    }
}

SendGrid

Paramètres de configuration pour la liaison de sortie SendGrid.

{
    "sendGrid": {
        "from": "Contoso Group <admin@contoso.com>"
    }
}    

serviceBus

Paramètre de configuration pour déclencheurs et liaisons de Service Bus.

{ 
    "serviceBus": {
      "maxConcurrentCalls": 16,
      "prefetchCount": 100,
      "autoRenewTimeout": "00:05:00",
      "autoComplete": true
    }
}

singleton

Paramètres de configuration du comportement de verrouillage Singleton. Pour plus d’informations, consultez l’article sur le problème de GitHub relatif à la prise en charge de singleton.

{
    "singleton": {
      "lockPeriod": "00:00:15",
      "listenerLockPeriod": "00:01:00",
      "listenerLockRecoveryPollingInterval": "00:01:00",
      "lockAcquisitionTimeout": "00:01:00",
      "lockAcquisitionPollingInterval": "00:00:03"
    }
}

tracing

Version 1.x

Paramètres de configuration des journaux que vous créez en utilisant un objet TraceWriter. Pour en savoir plus, consultez [Journalisation en C#].

{
    "tracing": {
      "consoleLevel": "verbose",
      "fileLoggingMode": "debugOnly"
    }
}

watchDirectories

Ensemble de répertoires de code partagé dont les modifications doivent être surveillées. Garantit que lorsque le code contenu dans ces répertoires est modifié, les modifications sont prises en compte par vos fonctions.

{
    "watchDirectories": [ "Shared" ]
}

Étapes suivantes