Skip to content

Commit e037abf

Browse files
Merge pull request #280135 from ggailey777/leonard
[Functions] Add docs for APPLICATIONINSIGHTS_AUTHENTICATION_STRING
2 parents 1392cfa + a5bfe2b commit e037abf

File tree

2 files changed

+19
-8
lines changed

2 files changed

+19
-8
lines changed

articles/azure-functions/configure-monitoring.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Configure monitoring for Azure Functions
33
description: Learn how to connect your function app to Application Insights for monitoring and how to configure data collection.
44
ms.service: azure-functions
55
ms.topic: how-to
6-
ms.date: 06/17/2024
6+
ms.date: 07/05/2024
77
ms.custom: devdivchpfy22
88

99
# Customer intent: As a developer, I want to understand how to configure monitoring for my functions correctly, so I can collect the data that I need.
@@ -287,8 +287,9 @@ For a function app to send data to Application Insights, it needs to connect to
287287

288288
| Setting name | Description |
289289
| ---- | ---- |
290-
| **[APPLICATIONINSIGHTS_CONNECTION_STRING](functions-app-settings.md#applicationinsights_connection_string)** | This setting is recommended and is required when your Application Insights instance runs in a sovereign cloud. The connection string supports other [new capabilities](../azure-monitor/app/migrate-from-instrumentation-keys-to-connection-strings.md#new-capabilities). |
291-
| **[APPINSIGHTS_INSTRUMENTATIONKEY](functions-app-settings.md#appinsights_instrumentationkey)** | Legacy setting, which Application Insights has deprecated in favor of the connection string setting. |
290+
| **[`APPLICATIONINSIGHTS_CONNECTION_STRING`](functions-app-settings.md#applicationinsights_connection_string)** | This setting is recommended and is required when your Application Insights instance runs in a sovereign cloud. The connection string supports other [new capabilities](../azure-monitor/app/migrate-from-instrumentation-keys-to-connection-strings.md#new-capabilities). |
291+
| **[`APPLICATIONINSIGHTS_AUTHENTICATION_STRING`](./functions-app-settings.md#applicationinsights_authentication_string)** | Connects to Application Insights using Microsoft Entra authentication. The value contains the client ID of either a system-assigned or a user-assigned managed identity that is authorized to publish telemetry to your Application Insights workspace. The string has a format of `ClientId=<YOUR_CLIENT_ID>;Authorization=AAD`. For more information, see [Microsoft Entra authentication for Application Insights](../azure-monitor/app/azure-ad-authentication.md).|
292+
| **[`APPINSIGHTS_INSTRUMENTATIONKEY`](functions-app-settings.md#appinsights_instrumentationkey)** | Legacy setting, which Application Insights has deprecated in favor of the connection string setting. |
292293

293294
When you create your function app in the [Azure portal](./functions-get-started.md) from the command line by using [Azure Functions Core Tools](./create-first-function-cli-csharp.md) or [Visual Studio Code](./create-first-function-vs-code-csharp.md), Application Insights integration is enabled by default. The Application Insights resource has the same name as your function app, and is created either in the same region or in the nearest region.
294295

articles/azure-functions/functions-app-settings.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,14 @@ Don't use both `APPINSIGHTS_INSTRUMENTATIONKEY` and `APPLICATIONINSIGHTS_CONNECT
5656

5757
[!INCLUDE [azure-monitor-log-analytics-rebrand](~/reusable-content/ce-skilling/azure/includes/azure-monitor-instrumentation-key-deprecation.md)]
5858

59+
## APPLICATIONINSIGHTS_AUTHENTICATION_STRING
60+
61+
The connection string for Application Insights by using Microsoft Entra authentication. Use this setting when you must connect to your Application Insights workspace by using Microsoft Entra authentication. The string contains the client ID of either a system-assigned or a user-assigned managed identity that is authorized to publish telemetry to your Application Insights workspace. For more information, see [Microsoft Entra authentication for Application Insights](../azure-monitor/app/azure-ad-authentication.md).
62+
63+
|Key|Sample value|
64+
|---|------------|
65+
|APPLICATIONINSIGHTS_AUTHENTICATION_STRING|`ClientId=<YOUR_CLIENT_ID>;Authorization=AAD`|
66+
5967
## APPLICATIONINSIGHTS_CONNECTION_STRING
6068

6169
The connection string for Application Insights. Don't use both `APPINSIGHTS_INSTRUMENTATIONKEY` and `APPLICATIONINSIGHTS_CONNECTION_STRING`. While the use of `APPLICATIONINSIGHTS_CONNECTION_STRING` is recommended in all cases, it's required in the following cases:
@@ -69,6 +77,8 @@ For more information, see [Connection strings](../azure-monitor/app/sdk-connecti
6977
|---|------------|
7078
|APPLICATIONINSIGHTS_CONNECTION_STRING|`InstrumentationKey=...`|
7179

80+
To connect to Application Insights with Microsoft Entra authentication, you should instead use [`APPLICATIONINSIGHTS_AUTHENTICATION_STRING`](#applicationinsights_authentication_string).
81+
7282
## AZURE_FUNCTION_PROXY_DISABLE_LOCAL_CALL
7383

7484
> [!IMPORTANT]
@@ -190,7 +200,7 @@ Add `EnableProxies` to this list to re-enable proxies on version 4.x of the Func
190200

191201
## AzureWebJobsKubernetesSecretName
192202

193-
Indicates the Kubernetes Secrets resource used for storing keys. Supported only when running in Kubernetes. This setting requires you to set `AzureWebJobsSecretStorageType` to `kubernetes`. When `AzureWebJobsKubernetesSecretName` isn't set, the repository is considered read-only. In this case, the values must be generated before deployment. The [Azure Functions Core Tools](functions-run-local.md) generates the values automatically when deploying to Kubernetes.
203+
Indicates the Kubernetes Secrets resource used for storing keys. Supported only when running in Kubernetes. This setting requires you to set `AzureWebJobsSecretStorageType` to `kubernetes`. When `AzureWebJobsKubernetesSecretName` isn't set, the repository is considered read only. In this case, the values must be generated before deployment. The [Azure Functions Core Tools](functions-run-local.md) generates the values automatically when deploying to Kubernetes.
194204

195205
|Key|Sample value|
196206
|---|------------|
@@ -269,7 +279,7 @@ Specifies the repository or provider to use for key storage. Keys are always enc
269279
|AzureWebJobsSecretStorageType|`blob`|Keys are stored in a Blob storage container in the account provided by the `AzureWebJobsStorage` setting. Blob storage is the default behavior when `AzureWebJobsSecretStorageType` isn't set.<br/>To specify a different storage account, use the `AzureWebJobsSecretStorageSas` setting to indicate the SAS URL of a second storage account. |
270280
|AzureWebJobsSecretStorageType | `files` | Keys are persisted on the file system. This is the default behavior for Functions v1.x.|
271281
|AzureWebJobsSecretStorageType |`keyvault` | Keys are stored in a key vault instance set by `AzureWebJobsSecretStorageKeyVaultName`. |
272-
|AzureWebJobsSecretStorageType | `kubernetes` | Supported only when running the Functions runtime in Kubernetes. When `AzureWebJobsKubernetesSecretName` isn't set, the repository is considered read-only. In this case, the values must be generated before deployment. The [Azure Functions Core Tools](functions-run-local.md) generates the values automatically when deploying to Kubernetes.|
282+
|AzureWebJobsSecretStorageType | `kubernetes` | Supported only when running the Functions runtime in Kubernetes. When `AzureWebJobsKubernetesSecretName` isn't set, the repository is considered read only. In this case, the values must be generated before deployment. The [Azure Functions Core Tools](functions-run-local.md) generates the values automatically when deploying to Kubernetes.|
273283

274284
To learn more, see [Secret repositories](security-concepts.md#secret-repositories).
275285

@@ -281,7 +291,7 @@ Specifies the connection string for an Azure Storage account that the Functions
281291
|---|------------|
282292
|AzureWebJobsStorage|`DefaultEndpointsProtocol=https;AccountName=...`|
283293

284-
Instead of a connection string, you can use an identity based connection for this storage account. For more information, see [Connecting to host storage with an identity](functions-reference.md#connecting-to-host-storage-with-an-identity).
294+
Instead of a connection string, you can use an identity-based connection for this storage account. For more information, see [Connecting to host storage with an identity](functions-reference.md#connecting-to-host-storage-with-an-identity).
285295

286296
## AzureWebJobsStorage__accountName
287297

@@ -551,7 +561,7 @@ The configuration is specific to Python function apps. It defines the prioritiza
551561
|PYTHON\_ISOLATE\_WORKER\_DEPENDENCIES|`1`| Prioritize loading the Python libraries from application's package defined in requirements.txt. This prevents your libraries from colliding with internal Python worker's libraries. |
552562

553563
## PYTHON_ENABLE_DEBUG_LOGGING
554-
Enables debug-level logging in a Python function app. A value of `1` enables debug-level logging. Without this setting or with a value of `0`, only information and higher level logs are sent from the Python worker to the Functions host. Use this setting when debugging or tracing your Python function executions.
564+
Enables debug-level logging in a Python function app. A value of `1` enables debug-level logging. Without this setting or with a value of `0`, only information and higher-level logs are sent from the Python worker to the Functions host. Use this setting when debugging or tracing your Python function executions.
555565

556566
When debugging Python functions, make sure to also set a debug or trace [logging level](functions-host-json.md#logging) in the host.json file, as needed. To learn more, see [How to configure monitoring for Azure Functions](configure-monitoring.md).
557567

@@ -886,7 +896,7 @@ In the [Flex Consumption plan](./flex-consumption-plan.md), these site propertie
886896
| `properties.use32BitWorkerProcess` |32-bit not supported |
887897
| `properties.vnetBackupRestoreEnabled` |Not used for networking in Flex Consumption|
888898
| `properties.vnetContentShareEnabled` |Not used for networking in Flex Consumption|
889-
| `properties.vnetImagePullEnabled` |Not used for networking in Flex Consumptionlid|
899+
| `properties.vnetImagePullEnabled` |Not used for networking in Flex Consumption|
890900
| `properties.vnetRouteAllEnabled` |Not used for networking in Flex Consumption|
891901
| `properties.windowsFxVersion` |Not valid|
892902

0 commit comments

Comments
 (0)