schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
host.json | logging | Configuration settings for logging. | {"type": "object", "properties": {"logLevel": {"type": "object", "properties": {"default": {"enum": ["Critical", "Debug", "Error", "Information", "None", "Trace", "Warning"], "default": "Information"}}, "additionalProperties": {"enum": ["Critical", "Debug", "Error", "Information", "None", "Trace", "Warning"]}}, "applicationInsights": {"type": "object", "properties": {"samplingSettings": {"type": "object", "properties": {"isEnabled": {"type": "boolean", "default": true}, "maxTelemetryItemsPerSecond": {"type": "integer", "default": 20}, "evaluationInterval": {"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$", "default": "01:00:00"}, "initialSamplingPercentage": {"type": "number", "default": 100}, "samplingPercentageIncreaseTimeout": {"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$", "default": "00:00:01"}, "samplingPercentageDecreaseTimeout": {"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$", "default": "00:00:01"}, "minSamplingPercentage": {"type": "number", "default": 0.1}, "maxSamplingPercentage": {"type": "number", "default": 100}, "movingAverageRatio": {"type": "number", "default": 1}, "excludedTypes": {"type": "string", "default": "Request"}, "includedTypes": {"type": "string", "default": "Request"}}}, "enableLiveMetrics": {"type": "boolean", "default": true}, "enableLiveMetricsFilters": {"type": "boolean", "default": true}, "enableDependencyTracking": {"type": "boolean", "default": true}, "enablePerformanceCountersCollection": {"type": "boolean", "default": true}, "httpAutoCollectionOptions": {"type": "object", "properties": {"enableHttpTriggerExtendedInfoCollection": {"type": "boolean", "default": true}, "enableW3CDistributedTracing": {"type": "boolean", "default": true}, "enableResponseHeaderInjection": {"type": "boolean", "default": true}}, "additionalProperties": false}, "snapshotConfiguration": {"type": "object", "properties": {"agentEndpoint": {"oneOf": [{"type": "string"}, {"enum": [null]}], "default": null}, "captureSnapshotMemoryWeight": {"type": "number", "default": 0.5}, "failedRequestLimit": {"type": "integer", "default": 3}, "handleUntrackedExceptions": {"type": "boolean", "default": true}, "isEnabled": {"type": "boolean", "default": true}, "isEnabledInDeveloperMode": {"type": "boolean", "default": false}, "isEnabledWhenProfiling": {"type": "boolean", "default": true}, "isExceptionSnappointsEnabled": {"type": "boolean", "default": false}, "isLowPrioritySnapshotUploader": {"type": "boolean", "default": true}, "maximumCollectionPlanSize": {"type": "integer", "default": 50, "minimum": 1, "maximum": 9999}, "maximumSnapshotsRequired": {"type": "integer", "default": 3, "minimum": 1, "maximum": 999}, "problemCounterResetInterval": {"type": "string", "pattern": "^(?:[01]\\d|2[0-4]):[0-5]\\d:[0-5]\\d$", "default": "24:00:00"}, "provideAnonymousTelemetry": {"type": "boolean", "default": true}, "reconnectInterval": {"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$", "default": "00:15:00"}, "shadowCopyFolder": {"oneOf": [{"type": "string"}, {"enum": [null]}], "default": null}, "shareUploaderProcess": {"type": "boolean", "default": true}, "snapshotInLowPriorityThread": {"type": "boolean", "default": true}, "snapshotsPerDayLimit": {"type": "integer", "default": 30}, "snapshotsPerTenMinutesLimit": {"type": "integer", "default": 1}, "tempFolder": {"oneOf": [{"type": "string"}, {"enum": [null]}], "default": null}, "thresholdForSnapshotting": {"type": "integer", "default": 1}, "uploaderProxy": {"oneOf": [{"type": "string"}, {"enum": [null]}], "default": null}}, "additionalProperties": false}}, "examples": [{"samplingSettings": {"isEnabled": true, "excludedTypes": "Request"}}], "additionalProperties": false}, "fileLoggingMode": {"enum": ["never", "always", "debugOnly"], "default": "debugOnly"}}} |
host.json | logLevel | Log levels for specific categories. | {"type": "object", "properties": {"default": {"enum": ["Critical", "Debug", "Error", "Information", "None", "Trace", "Warning"], "default": "Information"}}, "additionalProperties": {"enum": ["Critical", "Debug", "Error", "Information", "None", "Trace", "Warning"]}} |
host.json | default | The default level for logging. If a category level is not specified, this value is used. | {"enum": ["Critical", "Debug", "Error", "Information", "None", "Trace", "Warning"], "default": "Information"} |
host.json | applicationInsights | Configuration settings for Application Insights logging. | {"type": "object", "properties": {"samplingSettings": {"type": "object", "properties": {"isEnabled": {"type": "boolean", "default": true}, "maxTelemetryItemsPerSecond": {"type": "integer", "default": 20}, "evaluationInterval": {"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$", "default": "01:00:00"}, "initialSamplingPercentage": {"type": "number", "default": 100}, "samplingPercentageIncreaseTimeout": {"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$", "default": "00:00:01"}, "samplingPercentageDecreaseTimeout": {"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$", "default": "00:00:01"}, "minSamplingPercentage": {"type": "number", "default": 0.1}, "maxSamplingPercentage": {"type": "number", "default": 100}, "movingAverageRatio": {"type": "number", "default": 1}, "excludedTypes": {"type": "string", "default": "Request"}, "includedTypes": {"type": "string", "default": "Request"}}}, "enableLiveMetrics": {"type": "boolean", "default": true}, "enableLiveMetricsFilters": {"type": "boolean", "default": true}, "enableDependencyTracking": {"type": "boolean", "default": true}, "enablePerformanceCountersCollection": {"type": "boolean", "default": true}, "httpAutoCollectionOptions": {"type": "object", "properties": {"enableHttpTriggerExtendedInfoCollection": {"type": "boolean", "default": true}, "enableW3CDistributedTracing": {"type": "boolean", "default": true}, "enableResponseHeaderInjection": {"type": "boolean", "default": true}}, "additionalProperties": false}, "snapshotConfiguration": {"type": "object", "properties": {"agentEndpoint": {"oneOf": [{"type": "string"}, {"enum": [null]}], "default": null}, "captureSnapshotMemoryWeight": {"type": "number", "default": 0.5}, "failedRequestLimit": {"type": "integer", "default": 3}, "handleUntrackedExceptions": {"type": "boolean", "default": true}, "isEnabled": {"type": "boolean", "default": true}, "isEnabledInDeveloperMode": {"type": "boolean", "default": false}, "isEnabledWhenProfiling": {"type": "boolean", "default": true}, "isExceptionSnappointsEnabled": {"type": "boolean", "default": false}, "isLowPrioritySnapshotUploader": {"type": "boolean", "default": true}, "maximumCollectionPlanSize": {"type": "integer", "default": 50, "minimum": 1, "maximum": 9999}, "maximumSnapshotsRequired": {"type": "integer", "default": 3, "minimum": 1, "maximum": 999}, "problemCounterResetInterval": {"type": "string", "pattern": "^(?:[01]\\d|2[0-4]):[0-5]\\d:[0-5]\\d$", "default": "24:00:00"}, "provideAnonymousTelemetry": {"type": "boolean", "default": true}, "reconnectInterval": {"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$", "default": "00:15:00"}, "shadowCopyFolder": {"oneOf": [{"type": "string"}, {"enum": [null]}], "default": null}, "shareUploaderProcess": {"type": "boolean", "default": true}, "snapshotInLowPriorityThread": {"type": "boolean", "default": true}, "snapshotsPerDayLimit": {"type": "integer", "default": 30}, "snapshotsPerTenMinutesLimit": {"type": "integer", "default": 1}, "tempFolder": {"oneOf": [{"type": "string"}, {"enum": [null]}], "default": null}, "thresholdForSnapshotting": {"type": "integer", "default": 1}, "uploaderProxy": {"oneOf": [{"type": "string"}, {"enum": [null]}], "default": null}}, "additionalProperties": false}}, "examples": [{"samplingSettings": {"isEnabled": true, "excludedTypes": "Request"}}], "additionalProperties": false} |
host.json | samplingSettings | Configuration settings for Application Insights client-side adaptive sampling. | {"type": "object", "properties": {"isEnabled": {"type": "boolean", "default": true}, "maxTelemetryItemsPerSecond": {"type": "integer", "default": 20}, "evaluationInterval": {"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$", "default": "01:00:00"}, "initialSamplingPercentage": {"type": "number", "default": 100}, "samplingPercentageIncreaseTimeout": {"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$", "default": "00:00:01"}, "samplingPercentageDecreaseTimeout": {"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$", "default": "00:00:01"}, "minSamplingPercentage": {"type": "number", "default": 0.1}, "maxSamplingPercentage": {"type": "number", "default": 100}, "movingAverageRatio": {"type": "number", "default": 1}, "excludedTypes": {"type": "string", "default": "Request"}, "includedTypes": {"type": "string", "default": "Request"}}} |
host.json | isEnabled | If true, client-side adaptive sampling is enabled. | {"type": "boolean", "default": true} |
host.json | maxTelemetryItemsPerSecond | The target rate that the adaptive algorithm aims for on each instance | {"type": "integer", "default": 20} |
host.json | evaluationInterval | The interval at which the current rate of telemetry is reevaluated. | {"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$", "default": "01:00:00"} |
host.json | initialSamplingPercentage | The initial sampling percentage applied at the start of the sampling process to dynamically vary the percentage. | {"type": "number", "default": 100} |
host.json | samplingPercentageIncreaseTimeout | When the sampling percentage value changes, this property determines how soon afterwards Application Insights is allowed to raise sampling percentage again to capture more data. | {"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$", "default": "00:00:01"} |
host.json | samplingPercentageDecreaseTimeout | When the sampling percentage value changes, this property determines how soon afterwards Application Insights is allowed to lower sampling percentage again to capture less data. | {"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$", "default": "00:00:01"} |
host.json | minSamplingPercentage | As sampling percentage varies, this property determines the minimum allowed sampling percentage. | {"type": "number", "default": 0.1} |
host.json | maxSamplingPercentage | As sampling percentage varies, this property determines the maximum allowed sampling percentage. | {"type": "number", "default": 100} |
host.json | movingAverageRatio | In the calculation of the moving average, the weight assigned to the most recent value. Use a value equal to or less than 1. Smaller values make the algorithm less reactive to sudden changes. | {"type": "number", "default": 1} |
host.json | excludedTypes | A semi-colon delimited list of types excluded from sampling. Recognized: Dependency, Event, Exception, PageView, Request, Trace. | {"type": "string", "default": "Request"} |
host.json | includedTypes | A semi-colon delimited list of types that you want to be sampled. Recognized: Dependency, Event, Exception, PageView, Request, and Trace. | {"type": "string", "default": "Request"} |
host.json | enableLiveMetrics | Enables live metrics collection. | {"type": "boolean", "default": true} |
host.json | enableLiveMetricsFilters | Enables live metrics filters. | {"type": "boolean", "default": true} |
host.json | enableDependencyTracking | Enables dependency tracking | {"type": "boolean", "default": true} |
host.json | enablePerformanceCountersCollection | Enables Kudu performance counters collection. | {"type": "boolean", "default": true} |
host.json | enableHttpTriggerExtendedInfoCollection | Enables or disables extended HTTP request information for HTTP triggers. | {"type": "boolean", "default": true} |
host.json | enableW3CDistributedTracing | Enables or disables support of W3C distributed tracing protocol (and turns on legacy correlation schema). Enabled by default if enableHttpTriggerExtendedInfoCollection is true. If enableHttpTriggerExtendedInfoCollection is false, this flag applies to outgoing requests only, not incoming requests | {"type": "boolean", "default": true} |
host.json | enableResponseHeaderInjection | Enables or disables injection of multi-component correlation headers into responses. Enabling injection allows Application Insights to construct an Application Map to when several instrumentation keys are used. | {"type": "boolean", "default": true} |
host.json | agentEndpoint | The endpoint used to connect to the Application Insights Snapshot Debugger service. | {"oneOf": [{"type": "string"}, {"enum": [null]}], "default": null} |
host.json | captureSnapshotMemoryWeight | The weight given to the current process memory size when checking if there's enough memory to take a snapshot. | {"type": "number", "default": 0.5} |
host.json | failedRequestLimit | The limit on the number of failed requests to request snapshots before the telemetry processor is disabled. | {"type": "integer", "default": 3} |
host.json | handleUntrackedExceptions | Enables or disables tracking of exceptions that aren't tracked by Application Insights telemetry. | {"type": "boolean", "default": true} |
host.json | isEnabled | Enables or disables snapshot collection. | {"type": "boolean", "default": true} |
host.json | isEnabledInDeveloperMode | Enables or disables snapshot collection is enabled in developer mode. | {"type": "boolean", "default": false} |
host.json | isEnabledWhenProfiling | Enables or disables snapshot creation even if the Application Insights Profiler is collecting a detailed profiling session. | {"type": "boolean", "default": true} |
host.json | isExceptionSnappointsEnabled | Enables or disables filtering of exceptions. | {"type": "boolean", "default": false} |
host.json | isLowPrioritySnapshotUploader | Determines whether to run the SnapshotUploader process at below normal priority. | {"type": "boolean", "default": true} |
host.json | maximumCollectionPlanSize | The maximum number of problems that we can track at any time. | {"type": "integer", "default": 50, "minimum": 1, "maximum": 9999} |
host.json | maximumSnapshotsRequired | The maximum number of snapshots collected for a single problem. | {"type": "integer", "default": 3, "minimum": 1, "maximum": 999} |
host.json | problemCounterResetInterval | How often to reset the problem counters in a range from one minute to seven days. | {"type": "string", "pattern": "^(?:[01]\\d|2[0-4]):[0-5]\\d:[0-5]\\d$", "default": "24:00:00"} |
host.json | provideAnonymousTelemetry | Determines whether to send anonymous usage and error telemetry to Microsoft. This telemetry may be used if you contact Microsoft to help troubleshoot problems with the Snapshot Debugger | {"type": "boolean", "default": true} |
host.json | reconnectInterval | How often we reconnect to the Snapshot Debugger endpoint. Allowable range is one minute to one day. | {"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$", "default": "00:15:00"} |
host.json | shadowCopyFolder | Specifies the folder to use for shadow copying binaries. If not set, the folders specified by the following environment variables are tried in order: Fabric_Folder_App_Temp, LOCALAPPDATA, APPDATA, TEMP. | {"oneOf": [{"type": "string"}, {"enum": [null]}], "default": null} |
host.json | shareUploaderProcess | If true, only one instance of SnapshotUploader will collect and upload snapshots for multiple apps that share the InstrumentationKey. If set to false, the SnapshotUploader will be unique for each (ProcessName, InstrumentationKey) tuple. | {"type": "boolean", "default": true} |
host.json | snapshotInLowPriorityThread | Determines whether or not to process snapshots in a low IO priority thread. | {"type": "boolean", "default": true} |
host.json | snapshotsPerDayLimit | The maximum number of snapshots allowed in one day (24 hours). This limit is also enforced on the Application Insights service side. | {"type": "integer", "default": 30} |
host.json | snapshotsPerTenMinutesLimit | The maximum number of snapshots allowed in 10 minutes. Although there is no upper bound on this value, exercise caution increasing it on production workloads because it could impact the performance of your application. | {"type": "integer", "default": 1} |
host.json | tempFolder | Specifies the folder to write minidumps and uploader log files. If not set, then %TEMP%\Dumps is used. | {"oneOf": [{"type": "string"}, {"enum": [null]}], "default": null} |
host.json | thresholdForSnapshotting | How many times Application Insights needs to see an exception before it asks for snapshots. | {"type": "integer", "default": 1} |
host.json | uploaderProxy | Overrides the proxy server used in the Snapshot Uploader process. You may need to use this setting if your application connects to the internet via a proxy server. The Snapshot Collector runs within your application's process and will use the same proxy settings. | {"oneOf": [{"type": "string"}, {"enum": [null]}], "default": null} |
host.json | fileLoggingMode | Value determining what level of file logging is enabled. | {"enum": ["never", "always", "debugOnly"], "default": "debugOnly"} |
host.json | managedDependency | Managed dependency is a feature that is currently only supported with PowerShell based functions. It enables dependencies to be automatically managed by the service. | {"type": "object", "properties": {"enabled": {"type": "boolean", "default": true}}, "additionalProperties": false} |
host.json | enabled | If true, the requirements.psd1 file is processed | {"type": "boolean", "default": true} |
host.json | retry | Retry policy of function execution failures at the app level. Retry policy applies to all the functions in the function app. | {"type": "object", "properties": {"strategy": {"enum": ["exponentialBackoff", "fixedDelay"], "default": "exponentialBackoff"}, "maxRetryCount": {"type": "integer"}, "delayInterval": {"oneOf": [{"type": "string", "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$"}, {"enum": [null]}]}, "minimumInterval": {"oneOf": [{"type": "string", "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$"}, {"enum": [null]}]}, "maximumInterval": {"oneOf": [{"type": "string", "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$"}, {"enum": [null]}]}}} |
host.json | strategy | Retry strategy to use for retrying function executions | {"enum": ["exponentialBackoff", "fixedDelay"], "default": "exponentialBackoff"} |
host.json | maxRetryCount | The maximum number of retries allowed per function execution. -1 means to retry indefinitely. | {"type": "integer"} |
host.json | delayInterval | Value indicating the delayInterval for function execution retries when using FixedDelay strategy. | {"oneOf": [{"type": "string", "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$"}, {"enum": [null]}]} |
host.json | minimumInterval | Value indicating the minimumInterval for function execution retries when using ExponentialBackoff strategy. | {"oneOf": [{"type": "string", "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$"}, {"enum": [null]}]} |
host.json | maximumInterval | Value indicating the maximumInterval for function execution retries when using ExponentialBackoff strategy. | {"oneOf": [{"type": "string", "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$"}, {"enum": [null]}]} |
host.json | customHandler | Configuration settings for Custom Handler. | {"type": "object", "properties": {"enableForwardingHttpRequest": {"type": "boolean", "default": false}}, "additionalProperties": false} |
host.json | description | Configuration settings for Custom Handler process | {"type": "object", "properties": {"defaultExecutablePath": {"type": "string"}, "workingDirectory": {"type": "string"}, "arguments": {"type": "array", "items": {"type": "string"}}}} |
host.json | defaultExecutablePath | Name or path to the Custom Handler process | {"type": "string"} |
host.json | workingDirectory | WorkingDirectory to be used by the Custom Handler process. If not set, defaults to function app root folder. | {"type": "string"} |
host.json | arguments | Arguments to be passed to the Custom Handler process. Can use environment variables following pattern %envVarName% | {"type": "array", "items": {"type": "string"}} |
host.json | enableForwardingHttpRequest | Forward HttpTrigger request to the custom handler | {"type": "boolean", "default": false} |
host.json | watchFiles | An array of one or more names of files that are monitored for changes that require your app to restart. This guarantees that when code in these files are changed, the updates are picked up by your functions | {"type": "array", "uniqueItems": true, "items": {"type": "string", "minLength": 1}, "additionalProperties": false} |
host.json | version | The version of the Azure Functions host.json schema. This is NOT the version of the Azure Functions host. | {"enum": ["2.0"]} |
host.json | from | The sender's email address across all functions. | {"type": "string"} |
host.json | serviceBus | Configuration settings for 'serviceBus' triggers. | {"type": "object", "properties": {"prefetchCount": {"type": "integer"}, "messageHandlerOptions": {"type": "object", "properties": {"maxConcurrentCalls": {"type": "integer", "default": 32}, "maxAutoRenewDuration": {"type": "string", "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$", "default": "00:05:00"}, "autoComplete": {"type": "boolean", "default": true}}, "additionalProperties": false}, "sessionHandlerOptions": {"type": "object", "properties": {"maxAutoRenewDuration": {"type": "string", "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$", "default": "00:55:00"}, "autoComplete": {"type": "boolean", "default": false}, "maxConcurrentSessions": {"type": "integer", "default": 16}, "messageWaitTimeout": {"type": "string", "default": "00:00:30"}}, "additionalProperties": false}, "batchOptions": {"type": "object", "properties": {"maxMessageCount": {"type": "integer", "default": 1000}, "operationTimeout": {"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$", "default": "00:01:00"}, "autoComplete": {"type": "boolean", "default": true}}, "additionalProperties": false}}, "additionalProperties": false} |
host.json | prefetchCount | The default PrefetchCount that will be used by the underlying MessageReceiver. | {"type": "integer"} |
host.json | messageHandlerOptions | The options that will be used for the message handler registered with the MessageReceiver. | {"type": "object", "properties": {"maxConcurrentCalls": {"type": "integer", "default": 32}, "maxAutoRenewDuration": {"type": "string", "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$", "default": "00:05:00"}, "autoComplete": {"type": "boolean", "default": true}}, "additionalProperties": false} |
host.json | maxConcurrentCalls | The maximum number of concurrent calls to the callback the message pump should initiate. | {"type": "integer", "default": 32} |
host.json | maxAutoRenewDuration | The maximum duration within which the Service Bus message lock will be renewed automatically. | {"type": "string", "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$", "default": "00:05:00"} |
host.json | autoComplete | Value determining whether messages will be completed automatically, or whether the function will take responsibility message completion. | {"type": "boolean", "default": true} |
host.json | maxAutoRenewDuration | The maximum duration within which the Service Bus message lock will be renewed automatically. | {"type": "string", "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$", "default": "00:55:00"} |
host.json | autoComplete | Value determining whether messages will be completed automatically, or whether the function will take responsibility message completion. | {"type": "boolean", "default": false} |
host.json | maxConcurrentSessions | The maximum number of sessions that can be handled concurrently per scaled instance. | {"type": "integer", "default": 16} |
host.json | maxMessageCount | The maximum number of messages sent to the function when triggered. | {"type": "integer", "default": 1000} |
host.json | operationTimeout | A time span value expressed in hh:mm:ss. | {"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$", "default": "00:01:00"} |
host.json | autoComplete | Whether the trigger should automatically call complete after processing, or if the function code will manually call complete. | {"type": "boolean", "default": true} |
host.json | eventHubs | Configuration settings for 'eventHub' triggers. | {"oneOf": [{"type": "object", "properties": {"targetUnprocessedEventThreshold": {"type": "integer", "minimum": 1}, "maxEventBatchSize": {"type": "integer", "default": 10, "minimum": 1}, "batchCheckpointFrequency": {"type": "integer", "default": 1}, "prefetchCount": {"type": "integer", "default": 300}, "transportType": {"type": "string", "enum": ["amqpTcp", "amqpWebSockets"], "default": "amqpTcp"}, "webProxy": {"type": "string"}, "customEndpointAddress": {"type": "string"}, "initialOffsetOptions": {"type": "object", "properties": {"type": {"type": "string", "enum": ["fromStart", "fromEnd", "fromEnqueuedTime"], "default": "fromStart"}, "enqueuedTimeUtc": {"type": "string"}}, "additionalProperties": false}, "clientRetryOptions": {"type": "object", "properties": {"mode": {"type": "string", "enum": ["exponential", "fixed"], "default": "exponential"}, "tryTimeout": {"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$", "type": "string", "default": "00:01:00"}, "delay": {"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d\\.\\d\\d$", "type": "string", "default": "00:00:00.80"}, "maxDelay": {"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$", "type": "string", "default": "00:00:01"}, "maxRetries": {"type": "integer", "default": 3}}, "additionalProperties": false}}, "additionalProperties": false}, {"type": "object", "properties": {"batchCheckpointFrequency": {"type": "integer", "default": 1}, "eventProcessorOptions": {"type": "object", "properties": {"maxBatchSize": {"type": "integer"}, "prefetchCount": {"type": "integer"}}, "additionalProperties": false}, "initialOffsetOptions": {"type": "object", "properties": {"type": {"type": "string", "enum": ["fromStart", "fromEnd", "fromEnqueuedTime"], "default": "fromStart"}}, "additionalProperties": false}}, "additionalProperties": false}, {"type": "object", "properties": {"maxBatchSize": {"type": "integer", "default": 64}, "prefetchCount": {"type": "integer", "default": 255}, "batchCheckpointFrequency": {"type": "integer", "default": 1}}, "additionalProperties": false}]} |
host.json | targetUnprocessedEventThreshold | The target number of unprocessed events per worker for Event Hub-triggered functions. This is used in target-based scaling to override the default scaling threshold inferred from maxEventBatchSize. | {"type": "integer", "minimum": 1} |
host.json | maxEventBatchSize | The maximum number of events that will be included in a batch for a single invocation. | {"type": "integer", "default": 10, "minimum": 1} |
host.json | batchCheckpointFrequency | The number of batches to process before creating a checkpoint for the Event Hub. | {"type": "integer", "default": 1} |
host.json | prefetchCount | The number of events that will be eagerly requested from Event Hubs and held in a local cache to allow reads to avoid waiting on a network operation. | {"type": "integer", "default": 300} |
host.json | transportType | The protocol and transport that is used for communicating with Event Hubs. | {"type": "string", "enum": ["amqpTcp", "amqpWebSockets"], "default": "amqpTcp"} |
host.json | webProxy | The proxy to use for communicating with Event Hubs over web sockets. A proxy cannot be used with the amqpTcp transport. | {"type": "string"} |
host.json | customEndpointAddress | The address to use when establishing a connection to Event Hubs, allowing network requests to be routed through an application gateway or other path needed for the host environment. | {"type": "string"} |
host.json | type | The location in the event stream to start processing when a checkpoint does not exist in storage. Applies to all partitions. | {"type": "string", "enum": ["fromStart", "fromEnd", "fromEnqueuedTime"], "default": "fromStart"} |
host.json | enqueuedTimeUtc | Specifies the enqueued time of the event in the stream from which to start processing. When initialOffsetOptions/type is configured as fromEnqueuedTime, this setting is mandatory. Supports time in any format supported by DateTime.Parse(), such as 2020-10-26T20:31Z. | {"type": "string"} |
host.json | mode | The approach to use for calculating retry delays. Exponential mode will retry attempts with a delay based on a back-off strategy where each attempt will increase the duration that it waits before retrying. | {"type": "string", "enum": ["exponential", "fixed"], "default": "exponential"} |
host.json | tryTimeout | The maximum duration to wait for an Event Hubs operation to complete, per attempt. | {"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$", "type": "string", "default": "00:01:00"} |
host.json | delay | The maximum duration to wait for an Event Hubs operation to complete, per attempt. | {"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d\\.\\d\\d$", "type": "string", "default": "00:00:00.80"} |
host.json | maxDelay | The maximum delay to allow between retry attempts. | {"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$", "type": "string", "default": "00:00:01"} |
host.json | maxRetries | The maximum number of retry attempts before considering the associated operation to have failed. | {"type": "integer", "default": 3} |
host.json | batchCheckpointFrequency | The number of batches to process before creating an EventHub cursor checkpoint. | {"type": "integer", "default": 1} |
host.json | eventProcessorOptions | Configuration on processing event hub events. | {"type": "object", "properties": {"maxBatchSize": {"type": "integer"}, "prefetchCount": {"type": "integer"}}, "additionalProperties": false} |
host.json | maxBatchSize | The maximum event count received per receive loop. | {"type": "integer"} |
host.json | prefetchCount | The default PrefetchCount that will be used by the underlying EventProcessorHost. | {"type": "integer"} |
host.json | type | The location in the event stream from which to start processing when a checkpoint doesn't exist in storage. | {"type": "string", "enum": ["fromStart", "fromEnd", "fromEnqueuedTime"], "default": "fromStart"} |
host.json | maxBatchSize | The maximum event count received per receive loop. | {"type": "integer", "default": 64} |
host.json | prefetchCount | The default prefetch that will be used by the underlying EventProcessorHost. | {"type": "integer", "default": 255} |
host.json | batchCheckpointFrequency | The number of event batches to process before creating an EventHub cursor checkpoint. | {"type": "integer", "default": 1} |
host.json | maxDegreeOfParallelism | The number of concurrent invocations allowed for each blob-triggered function. | {"type": "integer", "minimum": 1} |
host.json | maxDequeueCount | The number of times to try processing a message before moving it to the poison queue. | {"type": "integer", "minimum": 1, "default": 5} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.