Skip to content

Commit f863d37

Browse files
authored
[Messaging Function Extension] README Updates (Azure#20924)
The focus of these changes is to correct an error in the configuration examples for Event Hubs and to include additional information about the permission grants needed when using managed identity.
1 parent 031bc7c commit f863d37

File tree

1 file changed

+6
-5
lines changed
  • sdk/eventhub/Microsoft.Azure.WebJobs.Extensions.EventHubs

1 file changed

+6
-5
lines changed

sdk/eventhub/Microsoft.Azure.WebJobs.Extensions.EventHubs/README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ For the local development use the `local.settings.json` file to store the connec
3636
{
3737
"Values": {
3838
"AzureWebJobsStorage": "UseDevelopmentStorage=true",
39-
"<connection_name>": "Endpoint=sb://<event_hub_name>.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=Jya7Eh76HU92ibsxuk1ITN8CM8Bt76YLKf5ISjU3jZ8="
39+
"<connection_name>": "Endpoint=sb://<event_hubs_namespace>.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=Jya7Eh76HU92ibsxuk1ITN8CM8Bt76YLKf5ISjU3jZ8="
4040
}
4141
}
4242
```
@@ -45,22 +45,23 @@ When deployed use the [application settings](https://docs.microsoft.com/azure/az
4545

4646
#### Managed identity authentication
4747

48-
If your environment has [managed identity](https://docs.microsoft.com/azure/app-service/overview-managed-identity?tabs=dotnet) enabled you can use it to authenticate the Event Hubs extension.
49-
To use managed identity provide the `<connection_name>__fullyQualifiedNamespace` configuration setting.
48+
If your environment has [managed identity](https://docs.microsoft.com/azure/app-service/overview-managed-identity?tabs=dotnet) enabled you can use it to authenticate the Event Hubs extension. Before doing so, you will need to ensure that permissions have been configured as described in the [Azure Functions developer guide]( https://docs.microsoft.com/azure/azure-functions/functions-reference#grant-permission-to-the-identity).
49+
50+
To use managed identity provide the `<connection_name>__fullyQualifiedNamespace` configuration setting.
5051

5152
```json
5253
{
5354
"Values": {
5455
"AzureWebJobsStorage": "UseDevelopmentStorage=true",
55-
"<connection_name>__fullyQualifiedNamespace": "<event_hub_name>.servicebus.windows.net"
56+
"<connection_name>__fullyQualifiedNamespace": "{event_hubs_namespace}.servicebus.windows.net"
5657
}
5758
}
5859
```
5960

6061
Or in the case of deployed app set the same setting in [application settings](https://docs.microsoft.com/azure/azure-functions/functions-how-to-use-azure-function-app-settings):
6162

6263
```
63-
<connection_name>__fullyQualifiedNamespace=<event_hub_name>.servicebus.windows.net
64+
<connection_name>__fullyQualifiedNamespace={event_hubs_namespace}.servicebus.windows.net
6465
```
6566

6667
## Key concepts

0 commit comments

Comments
 (0)