Merge pull request #111260 from mcollier/mcollier-update-event-hub-host-json

ShannonLeavitt · web-flow · commit 9c7796e0497a · 2020-04-21T10:22:22.000-06:00
Move Event Hub related host.json settings to a single location.
diff --git a/articles/app-service/webjobs-sdk-how-to.md b/articles/app-service/webjobs-sdk-how-to.md
@@ -122,7 +122,7 @@ In version 3.*x*, the connection limit defaults to infinite connections. If for
 
 In version 2.*x*, you control the number of concurrent connections to a host by using the [ServicePointManager.DefaultConnectionLimit](/dotnet/api/system.net.servicepointmanager.defaultconnectionlimit#System_Net_ServicePointManager_DefaultConnectionLimit) API. In 2.*x*, you should increase this value from the default of 2 before starting your WebJobs host.
 
-All outgoing HTTP requests that you make from a function by using `HttpClient` flow through `ServicePointManager`. After you reach the value set in `DefaultConnectionLimit`, `ServicePointManager` starts queueing requests before sending them. Suppose your `DefaultConnectionLimit` is set to 2 and your code makes 1,000 HTTP requests. Initially, only two requests are allowed through to the OS. The other 998 are queued until there’s room for them. That means your `HttpClient` might time out because it appears to have made the request, but the request was never sent by the OS to the destination server. So you might see behavior that doesn't seem to make sense: your local `HttpClient` is taking 10 seconds to complete a request, but your service is returning every request in 200 ms. 
+All outgoing HTTP requests that you make from a function by using `HttpClient` flow through `ServicePointManager`. After you reach the value set in `DefaultConnectionLimit`, `ServicePointManager` starts queueing requests before sending them. Suppose your `DefaultConnectionLimit` is set to 2 and your code makes 1,000 HTTP requests. Initially, only two requests are allowed through to the OS. The other 998 are queued until there's room for them. That means your `HttpClient` might time out because it appears to have made the request, but the request was never sent by the OS to the destination server. So you might see behavior that doesn't seem to make sense: your local `HttpClient` is taking 10 seconds to complete a request, but your service is returning every request in 200 ms. 
 
 The default value for ASP.NET applications is `Int32.MaxValue`, and that's likely to work well for WebJobs running in a Basic or higher App Service Plan. WebJobs typically need the Always On setting, and that's supported only by Basic and higher App Service Plans.
 
@@ -420,7 +420,7 @@ static async Task Main()
 }
 ```
 
-For more details, see the [Event Hubs binding](../azure-functions/functions-bindings-event-hubs-output.md#hostjson-settings) article.
+For more details, see the [Event Hubs binding](../azure-functions/functions-bindings-event-hubs-trigger.md#host-json) article.
 
 ### Queue storage trigger configuration
 
diff --git a/articles/azure-functions/functions-host-json-v1.md b/articles/azure-functions/functions-host-json-v1.md
@@ -143,9 +143,7 @@ Configuration settings for the [Azure Cosmos DB trigger and bindings](functions-
 
 ## eventHub
 
-Configuration settings for [Event Hub triggers and bindings](functions-bindings-event-hubs.md).
-
-[!INCLUDE [functions-host-json-event-hubs](../../includes/functions-host-json-event-hubs.md)]
+Configuration settings for [Event Hub triggers and bindings](functions-bindings-event-hubs-trigger.md#functions-1x).
 
 ## functions
 
diff --git a/articles/azure-functions/functions-host-json.md b/articles/azure-functions/functions-host-json.md
@@ -211,7 +211,7 @@ Configuration setting can be found in [bindings for Durable Functions](durable/d
 
 ## eventHub
 
-Configuration settings can be found in [Event Hub triggers and bindings](functions-bindings-event-hubs-output.md#host-json). 
+Configuration settings can be found in [Event Hub triggers and bindings](functions-bindings-event-hubs-trigger.md#host-json). 
 
 ## extensions
 
diff --git a/includes/functions-bindings-event-hubs-output.md b/includes/functions-bindings-event-hubs-output.md
@@ -288,33 +288,3 @@ There are two options for outputting an Event Hub message from a function by usi
 | Binding | Reference |
 |---|---|
 | Event Hub | [Operations Guide](https://docs.microsoft.com/rest/api/eventhub/publisher-policy-operations) |
-
-<a name="host-json"></a>  
-
-## host.json settings
-
-This section describes the global configuration settings available for this binding in versions 2.x and higher. The example host.json file below contains only the version 2.x+ settings for this binding. For more information about global configuration settings in versions 2.x and beyond, see [host.json reference for Azure Functions](../articles/azure-functions/functions-host-json.md).
-
-> [!NOTE]
-> For a reference of host.json in Functions 1.x, see [host.json reference for Azure Functions 1.x](../articles/azure-functions/functions-host-json-v1.md).
-
-```json
-{
-    "version": "2.0",
-    "extensions": {
-        "eventHubs": {
-            "batchCheckpointFrequency": 5,
-            "eventProcessorOptions": {
-                "maxBatchSize": 256,
-                "prefetchCount": 512
-            }
-        }
-    }
-}  
-```
-
-|Property  |Default | Description |
-|---------|---------|---------|
-|`maxBatchSize`|10|The maximum event count received per receive loop.|
-|`prefetchCount`|300|The default pre-fetch count used by the underlying `EventProcessorHost`.|
-|`batchCheckpointFrequency`|1|The number of event batches to process before creating an EventHub cursor checkpoint.|
diff --git a/includes/functions-bindings-event-hubs-trigger.md b/includes/functions-bindings-event-hubs-trigger.md
@@ -350,7 +350,7 @@ The following table explains the binding configuration properties that you set i
 |**path** |**EventHubName** | Functions 1.x only. The name of the event hub. When the event hub name is also present in the connection string, that value overrides this property at runtime. |
 |**eventHubName** |**EventHubName** | Functions 2.x and higher. The name of the event hub. When the event hub name is also present in the connection string, that value overrides this property at runtime. Can be referenced via app settings %eventHubName% |
 |**consumerGroup** |**ConsumerGroup** | An optional property that sets the [consumer group](../articles/event-hubs/event-hubs-features.md#event-consumers) used to subscribe to events in the hub. If omitted, the `$Default` consumer group is used. |
-|**cardinality** | n/a | For Javascript. Set to `many` in order to enable batching.  If omitted or set to `one`, a single message is passed to the function. |
+|**cardinality** | n/a | For JavaScript. Set to `many` in order to enable batching.  If omitted or set to `one`, a single message is passed to the function. |
 |**connection** |**Connection** | The name of an app setting that contains the connection string to the event hub's namespace. Copy this connection string by clicking the **Connection Information** button for the [namespace](../articles/event-hubs/event-hubs-create.md#create-an-event-hubs-namespace), not the event hub itself. This connection string must have at least read permissions to activate the trigger.|
 
 [!INCLUDE [app settings to local.settings.json](../articles/azure-functions/../../includes/functions-app-settings-local.md)]
@@ -372,7 +372,8 @@ The Event Hubs trigger provides several [metadata properties](../articles/azure-
 See [code examples](#example) that use these properties earlier in this article.
 
 ## host.json properties
+<a name="host-json"></a>
 
-The [host.json](../articles/azure-functions/functions-host-json.md#eventhub) file contains settings that control Event Hubs trigger behavior.
+The [host.json](../articles/azure-functions/functions-host-json.md#eventhub) file contains settings that control Event Hubs trigger behavior. The configuration is different depending on the Azure Functions version.
 
 [!INCLUDE [functions-host-json-event-hubs](../articles/azure-functions/../../includes/functions-host-json-event-hubs.md)]
diff --git a/includes/functions-host-json-event-hubs.md b/includes/functions-host-json-event-hubs.md
@@ -5,6 +5,35 @@ ms.topic: include
 ms.date: 09/04/2018
 ms.author: glenga
 ---
+
+### Functions 2.x and higher
+
+```json
+{
+    "version": "2.0",
+    "extensions": {
+        "eventHubs": {
+            "batchCheckpointFrequency": 5,
+            "eventProcessorOptions": {
+                "maxBatchSize": 256,
+                "prefetchCount": 512
+            }
+        }
+    }
+}  
+```
+
+|Property  |Default | Description |
+|---------|---------|---------|
+|maxBatchSize|10|The maximum event count received per receive loop.|
+|prefetchCount|300|The default pre-fetch count used by the underlying `EventProcessorHost`.|
+|batchCheckpointFrequency|1|The number of event batches to process before creating an EventHub cursor checkpoint.|
+
+> [!NOTE]
+> For a reference of host.json in Azure Functions 2.x and beyond, see [host.json reference for Azure Functions](../articles/azure-functions/functions-host-json.md).
+
+### Functions 1.x
+
 ```json
 {
     "eventHub": {
@@ -18,5 +47,9 @@ ms.author: glenga
 |Property  |Default | Description |
 |---------|---------|---------| 
 |maxBatchSize|64|The maximum event count received per receive loop.|
-|prefetchCount|n/a|The default PrefetchCount that will be used by the underlying EventProcessorHost.| 
+|prefetchCount|n/a|The default pre-fetch that will be used by the underlying `EventProcessorHost`.| 
 |batchCheckpointFrequency|1|The number of event batches to process before creating an EventHub cursor checkpoint.| 
+
+> [!NOTE]
+> For a reference of host.json in Azure Functions 1.x, see [host.json reference for Azure Functions 1.x](../articles/azure-functions/functions-host-json-v1.md).
+
