Skip to content

Commit d90872f

Browse files
authored
Fix the Connection property descriptions
1 parent bfe7dd4 commit d90872f

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

articles/azure-functions/functions-bindings-event-grid-output.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -533,7 +533,7 @@ The following table explains the parameters for the `EventGridAttribute`.
533533
|---------|---------|----------------------|
534534
|**TopicEndpointUri** | The name of an app setting that contains the URI for the custom topic, such as `MyTopicEndpointUri`. |
535535
|**TopicKeySetting** | The name of an app setting that contains an access key for the custom topic. |
536-
|**Connection**<sup>*</sup> | The name of the app setting that contains the connection string when using an [identity-based connection](#connections) to the topic. |
536+
|**Connection**<sup>*</sup> | The value of the common prefix for the setting that contains the topic endpoint URI. For more information about the naming format of this application setting, see [Identity-based authentication](#identity-based-authentication). |
537537

538538
# [Isolated process](#tab/isolated-process)
539539

@@ -543,7 +543,7 @@ The following table explains the parameters for the `EventGridOutputAttribute`.
543543
|---------|---------|----------------------|
544544
|**TopicEndpointUri** | The name of an app setting that contains the URI for the custom topic, such as `MyTopicEndpointUri`. |
545545
|**TopicKeySetting** | The name of an app setting that contains an access key for the custom topic. |
546-
|**Connection**<sup>*</sup> | The name of the app setting that contains the connection string when using an [identity-based connection](#connections) to the topic. |
546+
|**connection**<sup>*</sup> | The value of the common prefix for the setting that contains the topic endpoint URI. For more information about the naming format of this application setting, see [Identity-based authentication](#identity-based-authentication). |
547547

548548
---
549549

@@ -588,7 +588,7 @@ The following table explains the binding configuration properties that you set i
588588
|**name** | The variable name used in function code that represents the event. |
589589
|**topicEndpointUri** | The name of an app setting that contains the URI for the custom topic, such as `MyTopicEndpointUri`. |
590590
|**topicKeySetting** | The name of an app setting that contains an access key for the custom topic. |
591-
|**connection**<sup>*</sup> | The name of the app setting that contains the connection string when using an [identity-based connection](#connections) to the topic. |
591+
|**connection**<sup>*</sup> | The value of the common prefix for the setting that contains the topic endpoint URI. For more information about the naming format of this application setting, see [Identity-based authentication](#identity-based-authentication). |
592592

593593
---
594594

@@ -605,7 +605,7 @@ The following table explains the binding configuration properties that you set i
605605
|**name** | The variable name used in function code that represents the event. |
606606
|**topicEndpointUri** | The name of an app setting that contains the URI for the custom topic, such as `MyTopicEndpointUri`. |
607607
|**topicKeySetting** | The name of an app setting that contains an access key for the custom topic. |
608-
|**connection**<sup>*</sup> | The name of the app setting that contains the connection string when using an [identity-based connection](#connections) to the topic. |
608+
|**connection**<sup>*</sup> | The value of the common prefix for the setting that contains the topic endpoint URI. For more information about the naming format of this application setting, see [Identity-based authentication](#identity-based-authentication). |
609609

610610
::: zone-end
611611
::: zone pivot="programming-language-csharp,programming-language-javascript,programming-language-powershell,programming-language-python,programming-language-typescript"
@@ -718,9 +718,11 @@ Use the following steps to configure a topic key:
718718

719719
1. In your application settings, create a setting that defines the topic endpoint. Use the name of this setting for the `TopicEndpointUri` property of the binding.
720720

721-
### Identity-based connection
721+
### Identity-based authentication
722722

723-
When using version 3.3.x or higher of the extension, you can connect to an Event Grid topic using [Azure Active Directory identity](../active-directory/fundamentals/active-directory-whatis.md) instead of just a topic key. To do this, create a setting under a common prefix that you set as the `Connection` property in the binding.
723+
When using version 3.3.x or higher of the extension, you can connect to an Event Grid topic using an [Azure Active Directory identity](../active-directory/fundamentals/active-directory-whatis.md) to avoid having to obtain and work with topic keys.
724+
725+
To do this, create an application setting that returns the topic endpoint URI, where the name of the setting combines a unique _common prefix_, such as `myawesometopic`, with the value `__topicEndpointUri`. You then use the common prefix `myawesometopic` when you define the `Connection` property in the binding.
724726

725727
In this mode, the extension requires the following properties:
726728

@@ -731,7 +733,7 @@ In this mode, the extension requires the following properties:
731733
More properties may be set to customize the connection. See [Common properties for identity-based connections](functions-reference.md#common-properties-for-identity-based-connections).
732734

733735
> [!NOTE]
734-
> When using [Azure App Configuration](../azure-app-configuration/quickstart-azure-functions-csharp.md) or [Key Vault](../key-vault/general/overview.md) 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.
736+
> When using [Azure App Configuration](../azure-app-configuration/quickstart-azure-functions-csharp.md) or [Key Vault](../key-vault/general/overview.md) to provide settings for managed identity-based connections, setting names should use a valid key separator such as `:` or `/` in place of the `__` to ensure names are resolved correctly.
735737
>
736738
> For example, `<CONNECTION_NAME_PREFIX>:topicEndpointUri`.
737739

0 commit comments

Comments
 (0)