Azure Functions 2.x 以降の host.json のリファレンス

host.json メタデータ ファイルには、関数アプリ インスタンス内のすべての関数に影響する構成オプションが含まれています。 この記事では、Azure Functions ランタイムのバージョン 2.x 移行で使用できる設定を一覧表示しています。

その他の関数アプリの構成オプションは、関数アプリが実行される場所に応じて管理されます。

• Azure にデプロイ済み: アプリケーション設定内
• ローカル コンピューター上: local.settings.json ファイル内

バインドに関連する host.json 内の構成は、関数アプリの各関数に均等に適用されます。

また、アプリケーション設定を使用して、環境ごとに設定をオーバーライドまたは適用することもできます。

サンプル host.json ファイル

バージョン 2.x 以降用の次のサンプルの host.json ファイルには、使用可能なすべてのオプションが指定されています (内部でのみ使用するオプションは除く)。

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

この記事の次のセクションでは、最上位レベルの各プロパティについて説明します。 特記がない場合は、いずれも省略可能です。

aggregator

Application Insights のメトリックを計算するときに集計される関数呼び出しの数を指定します。

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

2 つの制限のいずれかに最初に達した場合、関数呼び出しが集計されます。

applicationInsights

この設定は logging の子です。

サンプリング オプションなど、Application Insights のオプションを制御します。

完全な JSON 構造については、前の サンプル host.json ファイル を参照してください。

applicationInsights.samplingSettings

これらの設定の詳細については、「Application Insights におけるサンプリング」を参照してください。

applicationInsights.httpAutoCollectionOptions

applicationInsights.dependencyTrackingOptions

applicationInsights.snapshotConfiguration

スナップショットの詳細については、「.NET アプリでの例外でのデバッグ スナップショット」および「Application Insights Snapshot Debugger の有効化やスナップショットの表示に関する問題のトラブルシューティング」を参照してください。

BLOB

構成設定は、Storage BLOB のトリガーとバインディングに関する記事に記載されています。

console

この設定は logging の子です。 デバッグ モードでないときのコンソール ログ記録を制御します。

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

Azure Cosmos DB

構成設定は、Azure Cosmos DB のトリガーとバインディング に関する記事に記載されています。

customHandler

カスタム ハンドラーの構成設定。 詳細については、「Azure Functions のカスタム ハンドラー」を参照してください。

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

durableTask

構成設定は、Durable Functions のバインディングに関する記事に記載されています。

concurrency

関数アプリ内の特定のバインディングに対して動的な同時実行制御を有効にします。 詳細については、「動的な同時実行制御」を参照してください。

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

eventHub

構成設定は、Event Hub のトリガーとバインディングに関する記事に記載されています。

拡張機能

バインド固有の設定 (http や eventHub など) をすべて含むオブジェクトを返すプロパティ。

extensionBundle

拡張機能バンドルを使用すると、互換性のある一連の関数バインド拡張機能を関数アプリに追加できます。 詳細については、「ローカル開発用の拡張機能バンドル」を参照してください。

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

extensionBundle では次のプロパティを使用できます。

functions

ジョブのホストが実行される関数の一覧。 空の配列は、すべての関数を実行することを示します。 ローカルで実行する場合にのみ使用します。 Azure の関数アプリでは、この設定を使用する代わりに、「Azure Functions で関数を無効にする方法」の手順に従って、特定の関数を無効にする必要があります。

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

functionTimeout

すべての関数実行のタイムアウト期間を示します。 これは、期間文字列形式に従います。

¹ Premium プランの実行が保証されるのは 60 分間のみですが、技術的には無制限です。
²-1 の値は無制限の実行を示しますが、固定の上限を維持することをお勧めします。

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

healthMonitor

ホストの正常性監視を行うための構成設定です。

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

http

構成設定は、HTTP トリガーとバインディングに関する記事に記載されています。

logging

Application Insights など、関数アプリのログの動作を制御します。

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

managedDependency

マネージド依存関係は、現在 PowerShell ベースの関数でのみサポートされている機能です。 この機能を使用すると、サービスによって依存関係を自動的に管理できます。 enabled プロパティが true に設定されている場合は、requirements.psd1 ファイルが処理されます。 いずれかのマイナー バージョンがリリースされると、依存関係が更新されます。 詳細については、PowerShell の記事のマネージド依存関係に関する記事をご覧ください。

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

queues

構成設定は、Storage キュー トリガーとバインディングに関する記事に記載されています。

sendGrid

構成設定は、SendGrid のトリガーとバインディングに関する記事に記載されています。

serviceBus

構成設定は、Service Bus のトリガーとバインディングに関する記事に記載されています。

singleton

シングルトン ロック動作の構成設定。 詳細については、「GitHub issue about singleton support」(シングルトンのサポートに関する GitHub の問題) を参照してください。

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

telemetryMode

この機能は現在プレビュー段階です。

OpenTelemetry をサポートする 1 つ以上のエンドポイントへの OpenTelemetry 出力形式のログとトレースの出力を有効にするために使用されます。 この設定を OpenTelemetry に設定すると、OpenTelemetry 出力が使用されます。 既定では、この設定を行わないと、すべてのログ、トレース、およびイベントが標準出力を使用して Application Insights に送信されます。 詳細については、「 Azure Functions での OpenTelemetry の使用」を参照してください。

version

この値は、host. json のスキーマ バージョンを示します。 v2 ランタイム、またはそれ以降のバージョンを対象とする関数アプリでは、バージョン文字列 "version": "2.0" が必要です。 v2 と v3 間での host.json スキーマの変更はありません。

watchDirectories

変更を監視する共有コード ディレクトリのセット。 これらのディレクトリ内のコードを変更した場合に、関数によって変更を選択するようにします。

{
    "watchDirectories": [ "Shared" ]
}

watchFiles

アプリを再起動する必要がある変更について監視されているファイルの 1 つ以上の名前の配列。 これにより、これらのファイル内のコードが変更されたときに、その更新が関数によって取得されることが保証されます。

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

host.json 値をオーバーライドする

host.json ファイル自体を変更せずに、特定の環境用に host.json ファイル内の特定の設定を構成または変更することが必要な場合があります。 特定の host.json 値をオーバーライドするには、等価の値をアプリケーション設定として作成します。 ランタイムは、AzureFunctionsJobHost__path__to__setting 形式のアプリケーション設定を検出すると、JSON の path.to.setting にある等価の host.json 設定をオーバーライドします。 アプリケーション設定として表現した場合、JSON 階層を示すために使用されるドット (.) は 2 つのアンダースコア (__) に置き換えられます。

たとえば、ローカルで実行しているときに Application Insight のサンプリングを無効にするとします。 ローカルの host.json ファイルを変更して Application Insights を無効にした場合、この変更がデプロイ中に運用アプリにプッシュされる可能性があります。 これをより安全に行うには、代わりに local.settings.json ファイル内にアプリケーション設定を "AzureFunctionsJobHost__logging__applicationInsights__samplingSettings__isEnabled":"false" として作成します。 これは、次の local.settings.json ファイルで確認できます。このファイルは発行されません。

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

環境変数を使用した host.json 設定のオーバーライドは、ASP.NET Core の名前付け規則に従います。 要素構造に配列が含まれている場合は、数値配列のインデックスをこのパスの追加の要素名として扱う必要があります。 詳細については、「環境変数の名前付け」を参照してください。

次のステップ