From 402547155c02e0c7b78901b0f8f95b991f6840ce Mon Sep 17 00:00:00 2001 From: Joe Schmitt Date: Mon, 30 Sep 2024 15:35:54 -0700 Subject: [PATCH 1/7] Add tenant id docs --- documentation/compatibility/9.0/README.md | 15 +++++++++++++++ documentation/compatibility/README.md | 1 + .../azure-ad-authentication-configuration.md | 13 +++++++++++-- 3 files changed, 27 insertions(+), 2 deletions(-) create mode 100644 documentation/compatibility/9.0/README.md diff --git a/documentation/compatibility/9.0/README.md b/documentation/compatibility/9.0/README.md new file mode 100644 index 00000000000..204680e25ff --- /dev/null +++ b/documentation/compatibility/9.0/README.md @@ -0,0 +1,15 @@ +# Breaking Changes in 9.0 + +If you are migrating your usage to `dotnet monitor` 9.0, the following changes might affect you. Changes are grouped together by areas within the tool. + +## Changes + +| Area | Title | Introduced | +|--|--|--| +| Configuration | [`TenantId` is now required when configuring Azure Active Directory authentication](#configuration-azure-active-directory-authentication) | RC 2 | + +## Details + +### Configuration: Azure Active Directory Authentication + +When using Azure Active Directory (Entra Id) for authentication, setting the `TenantId` is now **required**. diff --git a/documentation/compatibility/README.md b/documentation/compatibility/README.md index 390dc4e2138..7f3ecfecb3e 100644 --- a/documentation/compatibility/README.md +++ b/documentation/compatibility/README.md @@ -2,3 +2,4 @@ - [Breaking Changes in 7.0](./7.0/README.md) - [Breaking Changes in 8.0](./8.0/README.md) +- [Breaking Changes in 9.0](./9.0/README.md) diff --git a/documentation/configuration/azure-ad-authentication-configuration.md b/documentation/configuration/azure-ad-authentication-configuration.md index 604b6e30917..876eafcc2ef 100644 --- a/documentation/configuration/azure-ad-authentication-configuration.md +++ b/documentation/configuration/azure-ad-authentication-configuration.md @@ -6,15 +6,20 @@ Azure Active Directory authentication must be configured before `dotnet monitor` ## Configuration Options +> [!NOTE] +> Starting in 9.0 RC 2, The `TenantId` option is now **required**. + + | Name | Type | Required | Description | |---|---|---|---| | ClientId | string | true | The unique application (client) id assigned to the app registration in Azure Active Directory. | | RequiredRole | string | true | The role required to be able to authenticate. | | AppIdUri | uri | false | The App ID URI of the app registration. Defaults to `api://{ClientId}` if not specified. | | Instance | uri | false | Specifies the Azure cloud instance users are signing in from. Can be either the Azure public cloud or one of the national clouds. Defaults to the Azure public cloud (`https://login.microsoftonline.com`). | -| TenantId | string | false | The tenant id of the Azure Active Directory tenant, or its tenant domain. Defaults to `organizations`. | +| TenantId | string | false | The tenant id of the Azure Active Directory tenant. Defaults to `organizations`. | +| TenantId (9.0 RC 2+) | string | true | The tenant id of the Azure Active Directory tenant. | -A minimal configuration requires setting just the `ClientId` and `RequiredRole`. +A minimal configuration requires setting just the `TenantId`, `ClientId`, and `RequiredRole`. ### Example Configuration @@ -25,6 +30,7 @@ A minimal configuration requires setting just the `ClientId` and `RequiredRole`. { "Authentication": { "AzureAd": { + "TenantId": "6f565143-0d4c-4e44-a35b-974e4b2f78a0", "ClientId": "5eaf6ccc-e8c1-47c6-a68c-a6453172c655", "RequiredRole": "Application.Access" } @@ -37,6 +43,7 @@ A minimal configuration requires setting just the `ClientId` and `RequiredRole`. Kubernetes ConfigMap ```yaml + Authentication__AzureAd__TenantId: "6f565143-0d4c-4e44-a35b-974e4b2f78a0" Authentication__AzureAd__ClientId: "5eaf6ccc-e8c1-47c6-a68c-a6453172c655" Authentication__AzureAd__RequiredRole: "Application.Access" ``` @@ -46,6 +53,8 @@ A minimal configuration requires setting just the `ClientId` and `RequiredRole`. Kubernetes Environment Variables ```yaml + - name: DotnetMonitor_Authentication__AzureAd__TenantId + value: "6f565143-0d4c-4e44-a35b-974e4b2f78a0" - name: DotnetMonitor_Authentication__AzureAd__ClientId value: "5eaf6ccc-e8c1-47c6-a68c-a6453172c655" - name: DotnetMonitor_Authentication__AzureAd__RequiredRole From 31c90917ba2b4f01fe8608274c8dace1178becde Mon Sep 17 00:00:00 2001 From: Joe Schmitt Date: Mon, 30 Sep 2024 15:36:46 -0700 Subject: [PATCH 2/7] Lint --- .../configuration/azure-ad-authentication-configuration.md | 1 - 1 file changed, 1 deletion(-) diff --git a/documentation/configuration/azure-ad-authentication-configuration.md b/documentation/configuration/azure-ad-authentication-configuration.md index 876eafcc2ef..186ce00c088 100644 --- a/documentation/configuration/azure-ad-authentication-configuration.md +++ b/documentation/configuration/azure-ad-authentication-configuration.md @@ -9,7 +9,6 @@ Azure Active Directory authentication must be configured before `dotnet monitor` > [!NOTE] > Starting in 9.0 RC 2, The `TenantId` option is now **required**. - | Name | Type | Required | Description | |---|---|---|---| | ClientId | string | true | The unique application (client) id assigned to the app registration in Azure Active Directory. | From b6edaaad7f1d0813be73e52894510a5eb1ef91f7 Mon Sep 17 00:00:00 2001 From: Joe Schmitt Date: Mon, 30 Sep 2024 15:37:53 -0700 Subject: [PATCH 3/7] fix entra id --- documentation/compatibility/9.0/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/compatibility/9.0/README.md b/documentation/compatibility/9.0/README.md index 204680e25ff..f415c5c0d7d 100644 --- a/documentation/compatibility/9.0/README.md +++ b/documentation/compatibility/9.0/README.md @@ -12,4 +12,4 @@ If you are migrating your usage to `dotnet monitor` 9.0, the following changes m ### Configuration: Azure Active Directory Authentication -When using Azure Active Directory (Entra Id) for authentication, setting the `TenantId` is now **required**. +When using Azure Active Directory (Entra ID) for authentication, setting the `TenantId` is now **required**. From 1eb52f5f333afda8ff7c7f6e7ab28dd6e0dc2c11 Mon Sep 17 00:00:00 2001 From: Joe Schmitt Date: Mon, 30 Sep 2024 15:38:44 -0700 Subject: [PATCH 4/7] Update docs --- .../configuration/azure-ad-authentication-configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/configuration/azure-ad-authentication-configuration.md b/documentation/configuration/azure-ad-authentication-configuration.md index 186ce00c088..b8fb714bcea 100644 --- a/documentation/configuration/azure-ad-authentication-configuration.md +++ b/documentation/configuration/azure-ad-authentication-configuration.md @@ -15,8 +15,8 @@ Azure Active Directory authentication must be configured before `dotnet monitor` | RequiredRole | string | true | The role required to be able to authenticate. | | AppIdUri | uri | false | The App ID URI of the app registration. Defaults to `api://{ClientId}` if not specified. | | Instance | uri | false | Specifies the Azure cloud instance users are signing in from. Can be either the Azure public cloud or one of the national clouds. Defaults to the Azure public cloud (`https://login.microsoftonline.com`). | -| TenantId | string | false | The tenant id of the Azure Active Directory tenant. Defaults to `organizations`. | | TenantId (9.0 RC 2+) | string | true | The tenant id of the Azure Active Directory tenant. | +| TenantId | string | false | The tenant id of the Azure Active Directory tenant. Defaults to `organizations`. | A minimal configuration requires setting just the `TenantId`, `ClientId`, and `RequiredRole`. From 1638fac1cd51ef607c367dc9416a34b407f9a6d3 Mon Sep 17 00:00:00 2001 From: Joe Schmitt Date: Mon, 30 Sep 2024 15:40:17 -0700 Subject: [PATCH 5/7] Add links --- documentation/compatibility/9.0/README.md | 2 +- .../configuration/azure-ad-authentication-configuration.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/compatibility/9.0/README.md b/documentation/compatibility/9.0/README.md index f415c5c0d7d..ac6c5d4925a 100644 --- a/documentation/compatibility/9.0/README.md +++ b/documentation/compatibility/9.0/README.md @@ -12,4 +12,4 @@ If you are migrating your usage to `dotnet monitor` 9.0, the following changes m ### Configuration: Azure Active Directory Authentication -When using Azure Active Directory (Entra ID) for authentication, setting the `TenantId` is now **required**. +When using Azure Active Directory (Entra ID) for authentication, setting the `TenantId` option is now **required**. See [azure-ad-authentication-configuration.md](../../configuration/azure-ad-authentication-configuration.md#configuration-options) for more details. diff --git a/documentation/configuration/azure-ad-authentication-configuration.md b/documentation/configuration/azure-ad-authentication-configuration.md index b8fb714bcea..f4680adc5b8 100644 --- a/documentation/configuration/azure-ad-authentication-configuration.md +++ b/documentation/configuration/azure-ad-authentication-configuration.md @@ -7,7 +7,7 @@ Azure Active Directory authentication must be configured before `dotnet monitor` ## Configuration Options > [!NOTE] -> Starting in 9.0 RC 2, The `TenantId` option is now **required**. +> Starting in 9.0 RC 2, the `TenantId` option is now **required**. | Name | Type | Required | Description | |---|---|---|---| From 789ded194e80b26a9113d10c90f116b93ae94be3 Mon Sep 17 00:00:00 2001 From: Joe Schmitt Date: Mon, 30 Sep 2024 15:41:13 -0700 Subject: [PATCH 6/7] Update hyperlink --- documentation/compatibility/9.0/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/compatibility/9.0/README.md b/documentation/compatibility/9.0/README.md index ac6c5d4925a..6af76be3460 100644 --- a/documentation/compatibility/9.0/README.md +++ b/documentation/compatibility/9.0/README.md @@ -12,4 +12,4 @@ If you are migrating your usage to `dotnet monitor` 9.0, the following changes m ### Configuration: Azure Active Directory Authentication -When using Azure Active Directory (Entra ID) for authentication, setting the `TenantId` option is now **required**. See [azure-ad-authentication-configuration.md](../../configuration/azure-ad-authentication-configuration.md#configuration-options) for more details. +When using Azure Active Directory (Entra ID) for authentication, setting the `TenantId` option is now **required**. See [Azure Active Directory Authentication Configuration](../../configuration/azure-ad-authentication-configuration.md#configuration-options) for more details. From 07a9cb1ed0d0504c83b4d37c7a8252d607e28c15 Mon Sep 17 00:00:00 2001 From: Joe Schmitt Date: Mon, 30 Sep 2024 15:42:27 -0700 Subject: [PATCH 7/7] Update cspell --- cspell.json | 1 + 1 file changed, 1 insertion(+) diff --git a/cspell.json b/cspell.json index ebb62e70107..178b0f9483d 100644 --- a/cspell.json +++ b/cspell.json @@ -40,6 +40,7 @@ "distroless", "dockerfiles", "dylib", + "entra", "ESRP", "evented", "exfiltrate",