host.json Referenz für Azure Functions 1.x

Die Metadatendatei host.json enthält Konfigurationsoptionen, die sich auf alle Funktionen einer Funktions-App-Instanz auswirken. In diesem Artikel werden die verfügbaren Einstellungen für die Version 1.x Runtime aufgelistet. Das JSON-Schema finden Sie unter http://json.schemastore.org/host.

Weitere Konfigurationsoptionen Ihrer Funktions-App werden in den Anwendungseinstellungen verwaltet.

Einige Einstellungen in host.json werden nur bei lokaler Ausführung in der local.settings.json-Datei verwendet.

host.json-Beispieldatei

Für die folgenden host.json-Beispieldateien sind alle möglichen Optionen angegeben.

{
    "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" ],
}

In den folgenden Abschnitten dieses Artikels werden die einzelnen Top-Level-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 Grenzen erreicht ist.

applicationInsights

Steuert das Stichprobenfeature in Application Insights.

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

DocumentDB

Konfigurationseinstellungen für den Azure Cosmos DB Trigger und Bindungen.

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

dauerhafteAufgabe

Konfigurationseinstellungen für Durable Functions.

In Azure Functions Laufzeit 1.x befindet sich der durableTask Abschnitt an der Wurzel der host.json-Datei. Die verfügbaren Einstellungen hängen von der Version der Durable Functions-Erweiterung ab. Für die aktuelle Konfigurationsreferenz siehe Durable Functions host.json Einstellungen.

eventHub

Konfigurationseinstellungen für Event Hub-Trigger und -Bindungen.

Funktionen

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 stattdessen den Schritten in Wie Sie Funktionen in Azure Functions deaktivieren folgen, um bestimmte Funktionen zu deaktivieren, anstatt diese Einstellung zu verwenden.

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

functionTimeout

Gibt die Timeoutdauer für alle Funktionen an. Bei einem serverlosen Verbrauchsplan liegt der gültige Bereich zwischen 1 Sekunde und 10 Minuten, wobei der Standardwert bei 5 Minuten liegt. In einem App Service-Plan besteht keine allgemeine Einschränkung, und der Standardwert ist NULL (also kein Timeout).

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

healthMonitor

Konfigurationseinstellungen für Host-Überwachungsprogramm.

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

http

Konfigurationseinstellungen für HTTP-Trigger und Bindungen.

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

id

Die eindeutige ID für einen Jobhost. Dies kann eine GUID in Kleinbuchstaben mit entfernten Bindestrichen sein. Für die lokale Ausführung erforderlich. Wenn Sie Azure verwenden, empfehlen wir, keinen ID-Wert festzulegen. Eine ID wird automatisch in Azure generiert, wenn id weggelassen wird.

Wenn Sie ein Speicherkonto für mehrere Funktions-Apps verwenden, stellen Sie sicher, dass jede Funktions-App einen anderen Wert für id aufweist. Sie können die id-Eigenschaft auslassen oder id für jede Funktions-App manuell auf einen anderen Wert festlegen. Der Zeitgebertrigger verwendet eine Speichersperre, um sicherzustellen, dass nur eine Zeitgeberinstanz vorhanden ist, wenn eine Funktions-App auf mehrere Instanzen horizontal hochskaliert wird. Wenn zwei Funktions-Apps dasselbe id aufweisen und beide einen Timer-Trigger verwenden, wird nur ein Timer ausgeführt.

{
    "id": "9f4ea53c5136457d883d685e57164f08"
}

Protokollierungstool

Steuerelemente, die nach Protokollen filtern, die von einem ILogger-Objekt oder von context.log geschrieben werden.

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

queues

Konfigurationseinstellungen für Trigger und Bindungen der Speicherwarteschlange.

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

SendGrid

Konfigurationseinstellung für die SendGrid-Ausgangsbindung.

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

serviceBus

Konfigurationseinstellung für Service Bus Trigger und Bindungen.

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

singleton

Konfigurationseinstellungen für das Singleton-Sperrverhalten. Weitere Informationen finden Sie in GitHub Issue über Singleton-Support.

{
    "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

Konfigurationseinstellungen für Protokolle, die Sie mithilfe eines TraceWriter-Objekts erstellen. Weitere Informationen finden Sie unter [C#-Protokollierung].

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

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" ]
}

Nächste Schritte