You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The `connection` property is a reference to environment configuration that contains name of an application setting containing a connection string. You can get this connection string by selecting the **Connection Information** button for the [namespace](../event-hubs/event-hubs-create.md#create-an-event-hubs-namespace). The connection string must be for an Event Hubs namespace, not the event hub itself.
23
+
The `connection` property references environment configuration that contains the name of an application setting with a connection string. You get this connection string by selecting the **Connection Information** button for the [namespace](../event-hubs/event-hubs-create.md#create-an-event-hubs-namespace). The connection string must be for an Event Hubs namespace, not the event hub itself.
24
24
25
-
The connection string must have at least "read" permissions to activate the function.
25
+
The connection string must have at least **read** permissions to activate the function.
26
26
27
-
This connection string should be stored in an application setting with a name matching the value specified by the `connection` property of the binding configuration.
27
+
Store this connection string in an application setting with a name that matches the value you specify in the `connection` property of the binding configuration.
28
28
29
29
> [!NOTE]
30
-
> Identity-based connections aren't supported by the IoT Hub trigger. If you need to use managed identities end-to-end, you can instead use IoT Hub Routing to send data to an event hub you control. In that way, outbound routing can be authenticated with managed identity the event can be read [from that event hub using managed identity](functions-bindings-event-hubs-trigger.md?tabs=identity-based#connections).
30
+
> The IoT Hub trigger doesn't support identity-based connections. If you need to use managed identities end-to-end, you can instead use IoT Hub Routing to send data to an event hub you control. In that way, outbound routing can be authenticated by using managed identity and the event is read [from that event hub using managed identity](functions-bindings-event-hubs-trigger.md?tabs=identity-based#connections).
31
31
32
32
## host.json properties
33
33
34
-
The [host.json](functions-host-json.md#eventhub) file contains settings that control Event Hub trigger behavior. See the [host.json settings](functions-bindings-event-iot.md#hostjson-settings) section for details regarding available settings.
34
+
The [host.json](functions-host-json.md#eventhub) file contains settings that control Event Hubs trigger behavior. See the [host.json settings](functions-bindings-event-iot.md#hostjson-settings) section for details regarding available settings.
Copy file name to clipboardExpand all lines: includes/functions-service-bus-connections.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,19 +8,19 @@ ms.author: glenga
8
8
9
9
## Connections
10
10
11
-
The `connection` property is a reference to environment configuration which specifies how the app should connect to Service Bus. It may specify:
11
+
The `connection` property references environment configuration that specifies how the app connects to Service Bus. It can specify:
12
12
13
13
- The name of an application setting containing a connection string.
14
-
- The name of a shared prefix for multiple application settings, together defining a managed identity connection.
14
+
- The name of a shared prefix for multiple application settings that together define a managed identity connection.
15
15
16
16
If the configured value is both an exact match for a single setting and a prefix match for other settings, the exact match is used.
17
17
18
18
> [!TIP]
19
-
> Managed identity connections are recommended over connection strings for improved security. Connection strings include credentials that could be exposed, while managed identities eliminate the need to manage secrets.
19
+
> Use managed identity connections instead of connection strings for better security. Connection strings include credentials that could be exposed, while managed identities eliminate the need to manage secrets.
20
20
21
21
### [Managed identity](#tab/identity-based)
22
22
23
-
If you are using [version 5.x or higher of the extension](../articles/azure-functions/functions-bindings-service-bus.md?extensionv5), instead of using a connection string with a secret, you can have the app use a [Microsoft Entra identity](../articles/active-directory/fundamentals/active-directory-whatis.md). To do this, you would define settings under a common prefix which maps to the `connection` property in the trigger and binding configuration.
23
+
If you're using [version 5.x or higher of the extension](../articles/azure-functions/functions-bindings-service-bus.md?extensionv5), instead of using a connection string with a secret, you can have the app use a [Microsoft Entra identity](../articles/active-directory/fundamentals/active-directory-whatis.md). To use managed identities, define settings under a common prefix that maps to the `connection` property in the trigger and binding configuration.
24
24
25
25
In this mode, the extension requires the following application settings:
26
26
@@ -32,7 +32,7 @@ In this mode, the extension requires the following application settings:
32
32
33
33
The value that you replace `<CONNECTION_NAME_PREFIX>` with is treated by the binding extension as the name of the connection setting.
34
34
35
-
For example, if your binding configuration specifies `connection = "ServiceBusConnection"` with a user-assigned managed identity, you would configure the following application settings:
35
+
For example, if your binding configuration specifies `connection = "ServiceBusConnection"` with a user-assigned managed identity, you configure the following application settings:
36
36
37
37
```json
38
38
{
@@ -45,7 +45,7 @@ For example, if your binding configuration specifies `connection = "ServiceBusCo
45
45
> [!TIP]
46
46
> Use user-assigned managed identities for production scenarios where you need fine-grained control over identity permissions across multiple resources.
47
47
48
-
You can use additional settings in the template to further customize the connection. See [Common properties for identity-based connections](../articles/azure-functions/functions-reference.md#common-properties-for-identity-based-connections).
48
+
You can use other settings in the template to further customize the connection. See [Common properties for identity-based connections](../articles/azure-functions/functions-reference.md#common-properties-for-identity-based-connections).
49
49
50
50
> [!NOTE]
51
51
> When using [Azure App Configuration](../articles/azure-app-configuration/quickstart-azure-functions-csharp.md) or [Key Vault](/azure/key-vault/general/overview) to provide settings for Managed Identity connections, setting names should use a valid key separator such as `:` or `/` in place of the `__` to ensure names are resolved correctly.
@@ -58,10 +58,10 @@ You can use additional settings in the template to further customize the connect
58
58
59
59
### [Connection string](#tab/connection-string)
60
60
61
-
Obtain this connection string by following the steps shown at [Get the management credentials](../articles/service-bus-messaging/service-bus-dotnet-get-started-with-queues.md#get-the-connection-string). The connection string must be for a Service Bus namespace, not limited to a specific queue or topic.
61
+
Get this connection string by following the steps in [Get the management credentials](../articles/service-bus-messaging/service-bus-dotnet-get-started-with-queues.md#get-the-connection-string). You need a connection string for a Service Bus namespace, not one that's limited to a specific queue or topic.
62
62
63
-
This connection string should be stored in an application setting with a name matching the value specified by the `connection` property of the binding configuration.
63
+
Store this connection string in an app setting with a name that matches the value you specify in the `connection` property of the binding configuration.
64
64
65
-
If the app setting name begins with "AzureWebJobs", you can specify only the remainder of the name. For example, if you set `connection` to "MyServiceBus", the Functions runtime looks for an app setting that is named "AzureWebJobsMyServiceBus." If you leave `connection` empty, the Functions runtime uses the default Service Bus connection string in the app setting that is named "AzureWebJobsServiceBus".
65
+
If the app setting name starts with `AzureWebJobs`, you only need to specify the rest of the name. For example, if you set `connection` to `MyServiceBus`, the Functions runtime looks for an app setting named `AzureWebJobsMyServiceBus`. If you leave `connection` empty, the Functions runtime uses the default Service Bus connection string in the app setting named `AzureWebJobsServiceBus`.
0 commit comments