host.json-Referenz für Azure Functions 2.x oder höher

Die Metadatendatei „host.json“ enthält Konfigurationsoptionen, die sich auf alle Funktionen einer Funktions-App-Instanz auswirken. In diesem Artikel werden die Einstellungen aufgelistet, die ab Version 2.x der Azure Functions-Laufzeit verfügbar sind.

Andere Konfigurationsoptionen für Funktions-Apps werden abhängig davon verwaltet, wo die Funktions-App ausgeführt wird:

• In Azure bereitgestellt: in den Anwendungseinstellungen
• Auf Ihrem lokalen Computer: in der Datei local.settings.json.

Konfigurationen in „host.json“, die mit Bindungen im Zusammenhang stehen, werden gleichmäßig auf alle Funktionen in der Funktions-App angewendet.

Mithilfe der Anwendungseinstellungen können Sie auch Einstellungen pro Umgebung außer Kraft setzen oder anwenden.

host.json-Beispieldatei

In der folgenden Beispieldatei host.json für Version 2.x und höher sind alle möglichen Optionen angegeben (mit Ausnahme der Optionen, die nur für die interne Verwendung vorgesehen sind).

{
    "version": "2.0",
    "aggregator": {
        "batchSize": 1000,
        "flushTimeout": "00:00:30"
    },
    "concurrency": { 
            "dynamicConcurrencyEnabled": true, 
            "snapshotPersistenceEnabled": true 
        },
    "extensions": {
        "blobs": {},
        "cosmosDb": {},
        "durableTask": {},
        "eventHubs": {},
        "http": {},
        "queues": {},
        "sendGrid": {},
        "serviceBus": {}
    },
    "extensionBundle": {
        "id": "Microsoft.Azure.Functions.ExtensionBundle",
        "version": "[4.0.0, 5.0.0)"
    },
    "functions": [ "QueueProcessor", "GitHubWebHook" ],
    "functionTimeout": "00:05:00",
    "healthMonitor": {
        "enabled": true,
        "healthCheckInterval": "00:00:10",
        "healthCheckWindow": "00:02:00",
        "healthCheckThreshold": 6,
        "counterThreshold": 0.80
    },
    "logging": {
        "fileLoggingMode": "debugOnly",
        "logLevel": {
          "Function.MyFunction": "Information",
          "default": "None"
        },
        "applicationInsights": {
            "samplingSettings": {
              "isEnabled": true,
              "maxTelemetryItemsPerSecond" : 20,
              "evaluationInterval": "01:00:00",
              "initialSamplingPercentage": 100.0, 
              "samplingPercentageIncreaseTimeout" : "00:00:01",
              "samplingPercentageDecreaseTimeout" : "00:00:01",
              "minSamplingPercentage": 0.1,
              "maxSamplingPercentage": 100.0,
              "movingAverageRatio": 1.0,
              "excludedTypes" : "Dependency;Event",
              "includedTypes" : "PageView;Trace"
            },
            "dependencyTrackingOptions": {
                "enableSqlCommandTextInstrumentation": true
            },
            "enableLiveMetrics": true,
            "enableDependencyTracking": true,
            "enablePerformanceCountersCollection": true,            
            "httpAutoCollectionOptions": {
                "enableHttpTriggerExtendedInfoCollection": true,
                "enableW3CDistributedTracing": true,
                "enableResponseHeaderInjection": true
            },
            "snapshotConfiguration": {
                "agentEndpoint": null,
                "captureSnapshotMemoryWeight": 0.5,
                "failedRequestLimit": 3,
                "handleUntrackedExceptions": true,
                "isEnabled": true,
                "isEnabledInDeveloperMode": false,
                "isEnabledWhenProfiling": true,
                "isExceptionSnappointsEnabled": false,
                "isLowPrioritySnapshotUploader": true,
                "maximumCollectionPlanSize": 50,
                "maximumSnapshotsRequired": 3,
                "problemCounterResetInterval": "24:00:00",
                "provideAnonymousTelemetry": true,
                "reconnectInterval": "00:15:00",
                "shadowCopyFolder": null,
                "shareUploaderProcess": true,
                "snapshotInLowPriorityThread": true,
                "snapshotsPerDayLimit": 30,
                "snapshotsPerTenMinutesLimit": 1,
                "tempFolder": null,
                "thresholdForSnapshotting": 1,
                "uploaderProxy": null
            }
        }
    },
    "managedDependency": {
        "enabled": true
    },
    "singleton": {
      "lockPeriod": "00:00:15",
      "listenerLockPeriod": "00:01:00",
      "listenerLockRecoveryPollingInterval": "00:01:00",
      "lockAcquisitionTimeout": "00:01:00",
      "lockAcquisitionPollingInterval": "00:00:03"
    },
    "telemetryMode": "OpenTelemetry",
    "watchDirectories": [ "Shared", "Test" ],
    "watchFiles": [ "myFile.txt" ]
}

In den folgenden Abschnitten dieses Artikels werden die einzelnen allgemeinen Eigenschaften erläutert. Alle Eigenschaften sind optional, sofern nicht anders angegeben.

aggregator

Gibt an, wie viele Funktionsaufrufe aggregiert werden, wenn Metriken für Application Insights berechnet werden.

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

Funktionsaufrufe werden aggregiert, wenn der erste der beiden Grenzwerte erreicht wird.

applicationInsights

Diese Einstellung ist ein untergeordnetes Element von logging.

Sie steuert Optionen für Application Insights, einschließlich Stichprobenoptionen.

Die vollständige JSON-Struktur finden Sie in der obigen Beispieldatei „host.json“.

applicationInsights.samplingSettings

Weitere Informationen zu diesen Einstellungen finden Sie unter Erstellen von Stichproben in Application Insights.

applicationInsights.httpAutoCollectionOptions

applicationInsights.dependencyTrackingOptions

applicationInsights.snapshotConfiguration

Weitere Informationen zu Momentaufnahmen finden Sie unter Debugmomentaufnahmen von Ausnahmen in .NET-Apps und Behandeln von Problemen beim Aktivieren des Application Insights-Momentaufnahmedebuggers oder Anzeigen von Momentaufnahmen.

Blobs

Die Konfigurationseinstellungen finden Sie in Storage-Blobtrigger und Bindungen.

console

Diese Einstellung ist ein untergeordnetes Element von logging. Sie steuert die Konsolenprotokollierung, wenn nicht im Debugmodus.

{
    "logging": {
    ...
        "console": {
          "isEnabled": false,
          "DisableColors": true
        },
    ...
    }
}

Azure Cosmos DB

Konfigurationseinstellungen finden Sie unter Azure Cosmos DB-Trigger und -Bindungen.

customHandler

Konfigurationseinstellungen für einen benutzerdefinierten Handler. Weitere Informationen finden Sie unter Benutzerdefinierte Azure Functions-Handler.

"customHandler": {
  "description": {
    "defaultExecutablePath": "server",
    "workingDirectory": "handler",
    "arguments": [ "--port", "%FUNCTIONS_CUSTOMHANDLER_PORT%" ]
  },
  "enableForwardingHttpRequest": false
}

durableTask

Die Konfigurationseinstellung finden Sie in Bindungen für Durable Functions.

concurrency

Aktiviert dynamische Parallelität für bestimmte Bindungen in Ihrer Funktions-App. Weitere Informationen finden Sie unter Dynamische Parallelität.

    { 
        "concurrency": { 
            "dynamicConcurrencyEnabled": true, 
            "snapshotPersistenceEnabled": true 
        } 
    } 

eventHub

Die Konfigurationseinstellung finden Sie in Event Hub-Trigger und -Bindungen.

Erweiterungen

Eigenschaft, die ein Objekt zurückgibt, das alle die bindungsspezifischen-Einstellungen enthält, z.B. http und eventhub.

extensionBundle

Mit Erweiterungsbündeln können Sie kompatible Bindungserweiterungen von Azure Functions zu Ihrer Funktions-App hinzufügen. Weitere Informationen finden Sie unter Erweiterungsbündel für die lokale Entwicklung.

{
    "version": "2.0",
    "extensionBundle": {
        "id": "Microsoft.Azure.Functions.ExtensionBundle",
        "version": "[4.0.0, 5.0.0)"
    }
}

In extensionBundle sind die folgenden Eigenschaften verfügbar:

functions

Eine Liste der Funktionen, die vom Auftragshost ausgeführt werden. Ein leeres Array bedeutet, dass alle Funktionen ausgeführt werden. Nur bei lokaler Ausführung für die Verwendung vorgesehen. In Funktions-Apps in Azure sollten Sie anstelle dieser Einstellung die in How to disable functions in Azure Functions (Deaktivieren von Funktionen in Azure Functions) aufgeführten Schritte ausführen, um bestimmte Funktionen zu deaktivieren.

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

functionTimeout

Gibt die Timeoutdauer für alle Funktionsausführungen an. Die Angabe erfolgt im TimeSpan-Zeichenfolgenformat.

¹ Die Premium-Planausführung wird nur für 60 Minuten garantiert, ist aber eigentlich unbegrenzt.
² Der Wert -1 gibt eine unbegrenzte Ausführung an, es wird jedoch empfohlen, eine feste Obergrenze zu verwenden.

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

healthMonitor

Konfigurationseinstellungen für Host Health Monitor (Überwachung der Hostintegrität).

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

http

Die Konfigurationseinstellung finden Sie in HTTP-Trigger und -Bindungen.

logging

Steuert das Protokollierungsverhalten der Funktions-App, einschließlich Application Insights.

"logging": {
    "fileLoggingMode": "debugOnly",
    "logLevel": {
      "Function.MyFunction": "Information",
      "default": "None"
    },
    "console": {
        ...
    },
    "applicationInsights": {
        ...
    }
}

managedDependency

Verwaltete Abhängigkeit ist ein Vorschaufeature, das derzeit nur mit PowerShell-basierten Funktionen unterstützt wird. Sie ermöglicht, dass Abhängigkeiten automatisch vom Dienst verwaltet werden können. Wenn die enabled-Eigenschaft auf true festgelegt ist, wird die Datei requirements.psd1 verarbeitet. Abhängigkeiten werden aktualisiert, wenn Nebenversionen veröffentlicht werden. Weitere Informationen finden Sie unter Verwaltete Abhängigkeit im PowerShell-Artikel.

{
    "managedDependency": {
        "enabled": true
    }
}

queues

Die Konfigurationseinstellungen finden Sie in Trigger und Bindungen der Speicherwarteschlange.

sendGrid

Die Konfigurationseinstellung finden Sie in SendGrid-Trigger und -Bindungen.

serviceBus

Die Konfigurationseinstellung finden Sie in Service Bus-Trigger und -Bindungen.

singleton

Konfigurationseinstellungen für das Singleton-Sperrverhalten. Weitere Informationen finden Sie unter GitHub-Problem zur Singleton-Unterstützung.

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

telemetryMode

Dieses Feature befindet sich derzeit in der Vorschau.

Wird verwendet, um die Ausgabe von Protokollen und Ablaufverfolgungen in einem OpenTelemetry-Ausgabeformat auf einen oder mehrere Endpunkte zu aktivieren, die OpenTelemetry unterstützen. Wenn diese Einstellung auf " OpenTelemetryOpenTelemetry" festgelegt ist, wird die OpenTelemetry-Ausgabe verwendet. Standardmäßig ohne diese Einstellung werden alle Protokolle, Ablaufverfolgungen und Ereignisse mithilfe der Standardausgabe an Application Insights gesendet. Weitere Informationen finden Sie unter Verwenden von OpenTelemetry mit Azure-Funktionen.

version

Dieser Wert gibt die Schemaversion von „host.json“ an. Die Versionszeichenfolge "version": "2.0" ist erforderlich für Funktions-Apps mit v2 oder höher der Runtime als Ziel. Zwischen v2 und v3 wurden am Schema von „host.json“ keine Änderungen vorgenommen.

watchDirectories

Eine Reihe von Verzeichnissen mit freigegebenem Code, die auf Änderungen überwacht werden sollte. Dadurch wird sichergestellt, dass Änderungen am Code in diesen Verzeichnissen von Ihren Funktionen übernommen werden.

{
    "watchDirectories": [ "Shared" ]
}

watchFiles

Ein Array mit einem oder mehreren Namen von Dateien, die auf Änderungen überwacht werden, für die die App neu gestartet werden muss. Dadurch wird sichergestellt, dass Änderungen am Code in diesen Dateien von Ihren Funktionen übernommen werden.

{
    "watchFiles": [ "myFile.txt" ]
}

Außerkraftsetzung der Werte in der Datei „host.json“

Es kann Fälle geben, in denen Sie spezifische Einstellungen in einer Datei vom Typ „host.json“ für eine bestimmte Datei konfigurieren oder ändern möchten, ohne die Datei „host.json“ selbst zu ändern. Sie können bestimmte Werte in der Datei „host.json“ außer Kraft setzen, indem Sie einen entsprechenden Wert als Anwendungseinstellung erstellen. Wenn von der Runtime eine Anwendungseinstellung im Format AzureFunctionsJobHost__path__to__setting ermittelt wird, wird die entsprechende Einstellung in der JSON-Datei „host.json“ unter path.to.setting außer Kraft gesetzt. Bei der Angabe als Anwendungseinstellung wird der Punkt (.), mit dem die JSON-Hierarchie angegeben wird, durch einen doppelten Unterstrich (__) ersetzt.

Angenommen, Sie möchten die Application Insight-Stichprobenentnahme bei der lokalen Ausführung deaktivieren. Wenn Sie die lokale Datei „host.json“ geändert haben, um Application Insights zu deaktivieren, wird diese Änderung unter Umständen während der Bereitstellung an Ihre Produktions-App gepusht. Es ist sicherer, stattdessen die Anwendungseinstellung "AzureFunctionsJobHost__logging__applicationInsights__samplingSettings__isEnabled":"false" in der Datei local.settings.json zu erstellen. Dies wird in der folgenden Datei vom Typ local.settings.json gezeigt, die nicht veröffentlicht wird:

{
    "IsEncrypted": false,
    "Values": {
        "AzureWebJobsStorage": "{storage-account-connection-string}",
        "FUNCTIONS_WORKER_RUNTIME": "{language-runtime}",
        "AzureFunctionsJobHost__logging__applicationInsights__samplingSettings__isEnabled":"false"
    }
}

Das Überschreiben von Einstellungen der Datei „host.json“ mithilfe von Umgebungsvariablen folgt den ASP.NET Core-Benennungskonventionen. Wenn die Elementstruktur ein Array enthält, sollte der Index des numerischen Arrays als zusätzlicher Elementname in diesem Pfad behandelt werden. Weitere Informationen finden Sie unter Benennung von Umgebungsvariablen.

Nächste Schritte