Skip to content

Commit 0476970

Browse files
Document breaking Entra ID configuration change (#7379)
1 parent e64c03c commit 0476970

File tree

4 files changed

+27
-2
lines changed

4 files changed

+27
-2
lines changed

Diff for: cspell.json

+1
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@
4040
"distroless",
4141
"dockerfiles",
4242
"dylib",
43+
"entra",
4344
"ESRP",
4445
"evented",
4546
"exfiltrate",

Diff for: documentation/compatibility/9.0/README.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Breaking Changes in 9.0
2+
3+
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.
4+
5+
## Changes
6+
7+
| Area | Title | Introduced |
8+
|--|--|--|
9+
| Configuration | [`TenantId` is now required when configuring Azure Active Directory authentication](#configuration-azure-active-directory-authentication) | RC 2 |
10+
11+
## Details
12+
13+
### Configuration: Azure Active Directory Authentication
14+
15+
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.

Diff for: documentation/compatibility/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,4 @@
22

33
- [Breaking Changes in 7.0](./7.0/README.md)
44
- [Breaking Changes in 8.0](./8.0/README.md)
5+
- [Breaking Changes in 9.0](./9.0/README.md)

Diff for: documentation/configuration/azure-ad-authentication-configuration.md

+10-2
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,19 @@ Azure Active Directory authentication must be configured before `dotnet monitor`
66

77
## Configuration Options
88

9+
> [!NOTE]
10+
> Starting in 9.0 RC 2, the `TenantId` option is now **required**.
11+
912
| Name | Type | Required | Description |
1013
|---|---|---|---|
1114
| ClientId | string | true | The unique application (client) id assigned to the app registration in Azure Active Directory. |
1215
| RequiredRole | string | true | The role required to be able to authenticate. |
1316
| AppIdUri | uri | false | The App ID URI of the app registration. Defaults to `api://{ClientId}` if not specified. |
1417
| 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`). |
15-
| TenantId | string | false | The tenant id of the Azure Active Directory tenant, or its tenant domain. Defaults to `organizations`. |
18+
| TenantId (9.0 RC 2+) | string | true | The tenant id of the Azure Active Directory tenant. |
19+
| TenantId | string | false | The tenant id of the Azure Active Directory tenant. Defaults to `organizations`. |
1620

17-
A minimal configuration requires setting just the `ClientId` and `RequiredRole`.
21+
A minimal configuration requires setting just the `TenantId`, `ClientId`, and `RequiredRole`.
1822

1923
### Example Configuration
2024

@@ -25,6 +29,7 @@ A minimal configuration requires setting just the `ClientId` and `RequiredRole`.
2529
{
2630
"Authentication": {
2731
"AzureAd": {
32+
"TenantId": "6f565143-0d4c-4e44-a35b-974e4b2f78a0",
2833
"ClientId": "5eaf6ccc-e8c1-47c6-a68c-a6453172c655",
2934
"RequiredRole": "Application.Access"
3035
}
@@ -37,6 +42,7 @@ A minimal configuration requires setting just the `ClientId` and `RequiredRole`.
3742
<summary>Kubernetes ConfigMap</summary>
3843

3944
```yaml
45+
Authentication__AzureAd__TenantId: "6f565143-0d4c-4e44-a35b-974e4b2f78a0"
4046
Authentication__AzureAd__ClientId: "5eaf6ccc-e8c1-47c6-a68c-a6453172c655"
4147
Authentication__AzureAd__RequiredRole: "Application.Access"
4248
```
@@ -46,6 +52,8 @@ A minimal configuration requires setting just the `ClientId` and `RequiredRole`.
4652
<summary>Kubernetes Environment Variables</summary>
4753
4854
```yaml
55+
- name: DotnetMonitor_Authentication__AzureAd__TenantId
56+
value: "6f565143-0d4c-4e44-a35b-974e4b2f78a0"
4957
- name: DotnetMonitor_Authentication__AzureAd__ClientId
5058
value: "5eaf6ccc-e8c1-47c6-a68c-a6453172c655"
5159
- name: DotnetMonitor_Authentication__AzureAd__RequiredRole

0 commit comments

Comments
 (0)