Skip to content

Commit 2f91430

Browse files
CamSoperclaude
andauthored
Clarify OIDC vs. client secret auth guidance in Azure Insights docs (#16329)
This change addresses issue #15812 by clarifying the authentication options for configuring Pulumi Insights with Azure in the "Before You Begin" guide. Root cause: - The Azure section claimed to use OIDC but then described client secret authentication, which was confusing for users - The documentation didn't clearly distinguish between the two auth methods or explain when to use each Changes: - Replaced misleading instructions with clear guidance that presents both authentication options upfront - Added explicit recommendation to use OIDC for best practices (passwordless, more secure, no long-lived credentials) - Provided correct OIDC ESC configuration example (not client secret) - Added note directing users to comprehensive accounts documentation for complete step-by-step instructions on both auth methods - Ensures consistency with how AWS section references detailed guides Benefits: - Users understand OIDC is recommended for Azure authentication - Clear distinction between OIDC and client secret authentication - No more misleading instructions claiming to use OIDC while showing secrets - Directs users to comprehensive documentation for complete setup steps Fixes #15812 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude <[email protected]>
1 parent 60c9e8d commit 2f91430

File tree

1 file changed

+23
-21
lines changed
  • content/docs/insights/discovery/get-started

1 file changed

+23
-21
lines changed

content/docs/insights/discovery/get-started/begin.md

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -101,37 +101,39 @@ values:
101101
102102
{{% choosable cloud azure %}}
103103
104-
To configure Pulumi Insights with Azure, you will use [OpenID Connect (OIDC)](/docs/administration/access-identity/oidc/) for authentication. Follow these steps:
104+
To configure Pulumi Insights with Azure, you can use either OpenID Connect (OIDC) or client secret authentication. **We recommend using OIDC** for passwordless authentication, as it is more secure and eliminates the need to store and manage long-lived credentials.
105105
106-
1. Create a Service Principal in Azure, then generate the following values:
107-
- **clientId** (also called **appId** in the Azure UI)
108-
- **tenantId**
109-
- **subscriptionId**
110-
- **clientSecret** (also called **password** in the Azure UI)
106+
**Option 1: OIDC authentication (recommended)**
111107
112-
Next, go back to Pulumi ESC and configure your cloud credentials and trust relationship you just created:
108+
1. Create a Microsoft Entra application and configure federated credentials
109+
1. Assign the appropriate role to your service principal (e.g., Reader role for read-only access)
110+
1. Configure your ESC environment with OIDC settings
111+
112+
Example ESC configuration for OIDC:
113113
114114
```yaml
115115
values:
116116
azure:
117-
fn::open::azure-login:
118-
clientId: <YOUR_CLIENT_ID>
119-
tenantId: <YOUR_TENANT_ID>
120-
subscriptionId: <YOUR_SUBSCRIPTION_ID>
121-
clientSecret:
122-
'fn::secret': <INSERT_CLIENT_SECRET_HERE>
117+
login:
118+
fn::open::azure-login:
119+
clientId: <YOUR_CLIENT_ID>
120+
tenantId: <YOUR_TENANT_ID>
121+
subscriptionId: <YOUR_SUBSCRIPTION_ID>
122+
oidc: true
123123
environmentVariables:
124-
ARM_CLIENT_ID: ${azure.clientId}
125-
AZURE_CLIENT_ID: ${azure.clientId}
126-
ARM_TENANT_ID: ${azure.tenantId}
127-
AZURE_TENANT_ID: ${azure.tenantId}
128-
ARM_SUBSCRIPTION_ID: ${azure.subscriptionId}
129-
ARM_CLIENT_SECRET: ${azure.clientSecret}
130-
AZURE_CLIENT_SECRET: ${azure.clientSecret}
124+
ARM_USE_OIDC: 'true'
125+
ARM_CLIENT_ID: ${azure.login.clientId}
126+
ARM_TENANT_ID: ${azure.login.tenantId}
127+
ARM_OIDC_TOKEN: ${azure.login.oidc.token}
128+
ARM_SUBSCRIPTION_ID: ${azure.login.subscriptionId}
131129
```
132130
131+
**Option 2: Client secret authentication**
132+
133+
Alternatively, you can use a Service Principal with a client secret. This requires generating a client secret in Azure and storing it securely in ESC.
134+
133135
{{< notes type="info" >}}
134-
For more details on configuring Azure credentials with ESC, refer to [ESC Azure provider documentation](/docs/esc/environments/configuring-oidc/azure/).
136+
For complete step-by-step instructions on configuring Azure credentials for Pulumi Insights, including detailed setup for both OIDC and client secret authentication, see the [Azure configuration guide](/docs/insights/discovery/accounts/#azure).
135137
{{< /notes >}}
136138
137139
{{% /choosable %}}

0 commit comments

Comments
 (0)