Azure Functions 1.x 的 host.json 參考文件

host.json 中繼資料檔案所包括的設定選項，會影響函數應用程式執行個體的所有函式。 本文列出版本 1.x 執行階段可用的設定。 JSON 結構描述位於 http://json.schemastore.org/host。

其他函數應用程式設定選項的管理是在應用程式設定中進行。

有些 host.json 設定只有在本機執行時，才會在 local.settings.json 檔案中使用。

範例 host.json 檔案

下列範例 host.json 檔案已指定所有可能的選項。

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

本文的下列各節說明每個最上層屬性。 除非另有說明，否則全部都是選擇項目。

彙總工具

指定計算 Application Insights 的計量時彙總多少函式引動過程。

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

當達到兩個限制中的第一個時，功能呼叫會被彙總。

applicationInsights

控制 Application Insights 中的取樣功能。

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

DocumentDB

Azure Cosmos DB 觸發器及綁定 的設定。

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

durableTask

Durable Functions 的設定設定。

在執行Azure Functions 1.x 版本中，該durableTask區段位於 host.json 檔案的根節點。 可用的設定依據 Durable Functions 擴充功能的版本而定。 關於目前的設定參考，請參見Durable Functions host.json設定。

eventHub

事件中樞觸發程序和繫結 (部分內容可能是機器或 AI 翻譯) 的組態設定。

函式

工作主機所執行的函式清單。 空陣列表示已執行所有函式。 預定只能在本機執行時使用。 在 Azure 的功能應用程式中，你應該按照如何在 Azure Functions步驟來關閉特定功能，而不是用這個設定。

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

functionTimeout

指出所有函式的逾時持續期間。 在無伺服器的使用情況方案中，有效範圍是從 1 秒到 10 分鐘，而預設值是 5 分鐘。 在 App Service 方案中沒有整體限制，而且預設值為 Null，這表示沒有逾時。

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

健康監視器

Host 健康監控器 的設定設定。

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

http

HTTP 觸發器與綁定的設定。

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

id

作業主機的唯一識別碼。 可以是已移除虛線的小寫 GUID。 在本機執行時為必要項目。 在 Azure 執行時，我們建議不要設定 ID 值。 當省略 id 時，Azure 會自動產生一個 ID。

如果您在多個函數應用程式中共用儲存體帳戶，請確定每個函數應用程式具有不同的 id。 您可以省略 id 屬性或將每個函數應用程式的 id 手動設定為不同的值。 計時器觸發程序會使用儲存體鎖定，以確保當函數應用程式相應放大至多個執行個體時，只會有一個計時器執行個體。 如果兩個函數應用程式共用相同的 id，且每個應用程式都使用計時器觸發器，則只有一個計時器會執行。

{
    "id": "9f4ea53c5136457d883d685e57164f08"
}

記錄器

控制篩選由 ILogger 物件或 context.log 所寫入的記錄。

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

queues

儲存體佇列觸發程序和繫結的組態設定。

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

SendGrid

SendGrid 輸出綁定的設定設定。

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

serviceBus

服務匯流排觸發程序和繫結的組態設定。

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

singleton

Singleton 鎖定行為的組態設定。 欲了解更多資訊，請參閱 GitHub 關於單例支援的議題。

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

追蹤

1.x 版

使用 TraceWriter 物件所建立記錄的組態設定。 若要深入了解，請參閱 [C# 日誌]。

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

watchDirectories

應該監視其變更的一組共用程式碼目錄 (部分內容可能是機器或 AI 翻譯)。 請確定，這些目錄中的程式碼變更時，函式會反映變更。

{
    "watchDirectories": [ "Shared" ]
}

下一步