Skip to content

Commit f08221f

Browse files
snakex2000billwert
authored andcommitted
Update TROUBLESHOOTING.md (#42953)
Fixed a typo, added hyphen for a few phrases that needed it. Removed ',' in several places per Copilot CSS KM review feedback.
1 parent 6fc9690 commit f08221f

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

sdk/identity/azure-identity/TROUBLESHOOTING.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ The underlying MSAL library, MSAL4J, also has detailed logging. It is highly ver
9292

9393
| Error Message | Description | Mitigation |
9494
|------------------------------------------------|----------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
95-
| Environment variables aren't fully configured. | A valid combination of environment variables wasn't set. | Ensure the appropriate environment variables are set **prior to application startup** for the intended authentication method.</p><ul><li>To authenticate a service principal using a client secret, ensure the variables `AZURE_CLIENT_ID`, `AZURE_TENANT_ID` and `AZURE_CLIENT_SECRET` are properly set.</li><li>To authenticate a service principal using a certificate, ensure the variables `AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_CERTIFICATE_PATH` and optionally `AZURE_CLIENT_CERTIFICATE_PASSWORD` are properly set. `AZURE_CLIENT_SEND_CERTIFICATE_CHAIN` may optionally be set to send certificate chain in x5c header to support subject name / issuer based authentication.</li><li>To authenticate a user using a password, ensure the variables `AZURE_USERNAME` and `AZURE_PASSWORD` are properly set.</li></ul> |
95+
| Environment variables aren't fully configured. | A valid combination of environment variables wasn't set. | Ensure the appropriate environment variables are set **prior to application startup** for the intended authentication method.</p><ul><li>To authenticate a service principal using a client secret, ensure the variables `AZURE_CLIENT_ID`, `AZURE_TENANT_ID` and `AZURE_CLIENT_SECRET` are properly set.</li><li>To authenticate a service principal using a certificate, ensure the variables `AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_CERTIFICATE_PATH` and optionally `AZURE_CLIENT_CERTIFICATE_PASSWORD` are properly set. `AZURE_CLIENT_SEND_CERTIFICATE_CHAIN` may optionally be set to send certificate chain in x5c header to support subject name / issuer-based authentication.</li><li>To authenticate a user using a password, ensure the variables `AZURE_USERNAME` and `AZURE_PASSWORD` are properly set.</li></ul> |
9696

9797
## Troubleshoot `ClientSecretCredential` authentication issues
9898
`ClientAuthenticationException`
@@ -130,7 +130,7 @@ The underlying MSAL library, MSAL4J, also has detailed logging. It is highly ver
130130

131131
## Troubleshoot `ManagedIdentityCredential` authentication issues
132132

133-
The `ManagedIdentityCredential` is designed to work on a variety of Azure hosts that provide managed identity. Configuring the managed identity and troubleshooting failures varies from hosts. The below table lists the Azure hosts that can be assigned a managed identity, and are supported by the `ManagedIdentityCredential`.
133+
The `ManagedIdentityCredential` is designed to work on a variety of Azure hosts that provide managed identity. Configuring the managed identity and troubleshooting failures varies from hosts. The table below lists the Azure hosts that can be assigned a managed identity and are supported by the `ManagedIdentityCredential`.
134134

135135
|Host Environment| | |
136136
|---|---|---|
@@ -153,12 +153,12 @@ The `ManagedIdentityCredential` is designed to work on a variety of Azure hosts
153153

154154
#### Verify IMDS is available on the VM
155155

156-
If you have access to the VM, you can verify the manged identity endpoint is available via the command line using curl.
156+
If you have access to the VM, you can verify the managed identity endpoint is available via the command line using curl.
157157

158158
```bash
159159
curl 'http://169.254.169.254/metadata/identity/oauth2/token?resource=https://management.core.windows.net&api-version=2018-02-01' -H "Metadata: true"
160160
```
161-
> Note that output of this command will contain a valid access token, and SHOULD NOT BE SHARED to avoid compromising account security.
161+
> Note that output of this command will contain a valid access token and SHOULD NOT BE SHARED to avoid compromising account security.
162162
### Azure App Service and Azure Functions Managed Identity
163163
`CredentialUnavailableException`
164164

@@ -172,7 +172,7 @@ If you have access to SSH into the App Service, you can verify managed identity
172172
```bash
173173
curl 'http://169.254.169.254/metadata/identity/oauth2/token?resource=https://management.core.windows.net&api-version=2018-02-01' -H "Metadata: true"
174174
```
175-
> Note that the output of this command will contain a valid access token, and SHOULD NOT BE SHARED to avoid compromising account security.
175+
> Note that the output of this command will contain a valid access token and SHOULD NOT BE SHARED to avoid compromising account security.
176176
177177
### Azure Kubernetes Service Managed Identity
178178
#### Pod Identity for Kubernetes
@@ -230,18 +230,18 @@ az account get-access-token --output json --resource https://management.core.win
230230

231231
#### Verify the Azure Developer CLI can obtain tokens
232232

233-
You can manually verify that the Azure Developer CLI is properly authenticated, and can obtain tokens. First use the `config` command to verify the account which is currently logged in to the Azure Developer CLI.
233+
You can manually verify that the Azure Developer CLI is properly authenticated and can obtain tokens. First use the `config` command to verify the account which is currently logged in to the Azure Developer CLI.
234234

235235
```bash
236236
azd config list
237237
```
238238

239-
Once you've verified the Azure Developer CLI is using correct account, you can validate that it's able to obtain tokens for this account.
239+
Once you've verified the Azure Developer CLI is using the correct account, you can validate that it's able to obtain tokens for this account.
240240

241241
```bash
242242
azd auth token --output json --scope https://management.core.windows.net/.default
243243
```
244-
>Note that output of this command will contain a valid access token, and SHOULD NOT BE SHARED to avoid compromising account security.
244+
>Note that output of this command will contain a valid access token and SHOULD NOT BE SHARED to avoid compromising account security.
245245
246246
## Troubleshoot `AzurePowerShellCredential` authentication issues
247247

@@ -255,7 +255,7 @@ azd auth token --output json --scope https://management.core.windows.net/.defaul
255255

256256
#### Verify Azure PowerShell can obtain tokens
257257

258-
You can manually verify that Azure PowerShell is properly authenticated, and can obtain tokens. First use the `Get-AzContext` command to verify the account which is currently logged in to the Azure CLI.
258+
You can manually verify that Azure PowerShell is properly authenticated and can obtain tokens. First use the `Get-AzContext` command to verify the account which is currently logged in to the Azure CLI.
259259

260260
```
261261
PS C:\> Get-AzContext
@@ -265,12 +265,12 @@ Name Account SubscriptionName
265265
Subscription1 (xxxxxxxx-xxxx-xxxx-xxx... [email protected] Subscription1 AzureCloud xxxxxxxx-x...
266266
```
267267

268-
Once you've verified Azure PowerShell is using correct account, you can validate that it's able to obtain tokens for this account.
268+
Once you've verified Azure PowerShell is using the correct account, you can validate that it's able to obtain tokens for this account.
269269

270270
```bash
271271
Get-AzAccessToken -ResourceUrl "https://management.core.windows.net"
272272
```
273-
>Note that output of this command will contain a valid access token, and SHOULD NOT BE SHARED to avoid compromising account security.
273+
>Note that output of this command will contain a valid access token and SHOULD NOT BE SHARED to avoid compromising account security.
274274
275275

276276
## Troubleshoot `WorkloadIdentityCredential` authentication issues
@@ -304,7 +304,7 @@ Get-AzAccessToken -ResourceUrl "https://management.core.windows.net"
304304

305305
| Error Message |Description| Mitigation |
306306
|---|---|---|
307-
|The current credential is not configured to acquire tokens for tenant <tenant ID>|The application must configure the credential to allow acquiring tokens from the requested tenant.|Add the requested tenant ID it to the `additionallyAllowedTenants` on the credential builder, or add \"*\" to `additionallyAllowedTenants` to allow acquiring tokens for any tenant.</p>This exception was added as part of a breaking change to multi tenant authentication in version `1.6.0`. Users experiencing this error after upgrading can find details on the change and migration in [BREAKING_CHANGES.md](https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/identity/azure-identity/BREAKING_CHANGES.md) |
307+
|The current credential is not configured to acquire tokens for tenant <tenant ID>|The application must configure the credential to allow acquiring tokens from the requested tenant.|Add the requested tenant ID it to the `additionallyAllowedTenants` on the credential builder, or add \"*\" to `additionallyAllowedTenants` to allow acquiring tokens for any tenant.</p>This exception was added as part of a breaking change to multi-tenant authentication in version `1.6.0`. Users experiencing this error after upgrading can find details on the change and migration in [BREAKING_CHANGES.md](https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/identity/azure-identity/BREAKING_CHANGES.md) |
308308

309309
## Troubleshoot authentication timeout issues
310310

0 commit comments

Comments
 (0)