[Identity] Modified Troubleshooting guide for CSS #20223
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
KarishmaGhiya
requested review from
sadasant,
schaabs and
witemple-msft
as code owners
ghost
added
the
1 task
sadasant
reviewed
Feb 4, 2022
sadasant
reviewed
Feb 4, 2022
| ### Credential unavailable error | ||
|
|
||
| #### Environment variables not configured | ||
| > CAUTION: Requests and responses in the Azure Identity library contain sensitive information. Precaution must be taken to protect logs when customizing the output to avoid compromising account security. |
sadasant
reviewed
Feb 4, 2022
sadasant
reviewed
Feb 5, 2022
sadasant
reviewed
Feb 5, 2022
sadasant
reviewed
Feb 5, 2022
sadasant
reviewed
Feb 5, 2022
sadasant
reviewed
Feb 5, 2022
| ##### ClientCertificate credential | ||
| | Error |Description| Mitigation | | ||
| |---|---|---| | ||
| |`CredentialUnavailableError` thrown with message. "DefaultAzureCredential failed to retrieve a token from the included credentials."|All credentials in the `DefaultAzureCredential` chain failed to retrieve a token, each throwing a `CredentialUnavailableError` themselves|<ul><li>[Enable logging](#enabling-and-configuring-logging) to verify the credentials being tried, and get further diagnostic information.</li><li>Consult the troubleshooting guide for underlying credential types for more information.</li><ul><li>[EnvironmentCredential](#troubleshoot-environment-credential-authentication-issues)</li><li>[ManagedIdentityCredential](#troubleshoot-managed-identity-authentication-issues)</li><li>[VisualStudioCodeCredential](#troubleshoot-visual-studio-code-authentication-issues)</li><li>[VisualStudioCredential](#troubleshoot-visualstudio-credential-authentication-issues)</li><li>[AzureCLICredential](#troubleshoot-azure-cli-authentication-issues)</li><li>[AzurePowershellCredential](#troubleshoot-azure-powershell-authentication-issues)</li></ul>| |
There was a problem hiding this comment.
Here it says thrown with message. “Defau[…] That dot before the quote is weird. Also, can we use the code quote where the message is? So that the message can look as if it was copied as is into the document?
CredentialUnavailableErrorthrown with message:DefaultAzureCredential failed to retrieve a token from the included credentials.
What do you think?
sadasant
reviewed
Feb 5, 2022
sadasant
reviewed
Feb 5, 2022
sadasant
reviewed
Feb 5, 2022
sadasant
reviewed
Feb 5, 2022
Co-authored-by: Daniel Rodríguez <[email protected]>
KarishmaGhiya
commented
Feb 5, 2022
KarishmaGhiya
commented
Feb 5, 2022
Co-authored-by: Scott Addie <[email protected]>
Co-authored-by: Scott Addie <[email protected]>
sadasant
reviewed
Feb 23, 2022
sadasant
reviewed
Feb 23, 2022
sadasant
reviewed
Feb 23, 2022
sadasant
reviewed
Feb 23, 2022
sadasant
reviewed
Feb 23, 2022
Comment on lines
314
to
316
| |Az.Account module >= 2.2.0 isn’t installed.|The `Az.Account` module needed for authentication in Azure PowerShell isn't installed.|Install the latest `Az.Account` module. Installation instructions can be found [here](https://docs.microsoft.com/powershell/azure/install-az-ps). To use the Azure PowerShell credential, install the Azure Az PowerShell module:```powershell | ||
| Install-Module -Name Az -Scope CurrentUser -Repository PSGallery -Force | ||
| ``` | ||
| ```| |
There was a problem hiding this comment.
This
```powershell
Install-Module -Name Az -Scope CurrentUser -Repository PSGallery -Force
```
Is broken. I think the fix is to just inline it, like Install-Module -Name Az -Scope CurrentUser -Repository PSGallery -Force
Co-authored-by: Daniel Rodríguez <[email protected]>
Co-authored-by: Daniel Rodríguez <[email protected]>
Co-authored-by: Daniel Rodríguez <[email protected]>
scottaddie
reviewed
Feb 24, 2022
Co-authored-by: Scott Addie <[email protected]>
Co-authored-by: Scott Addie <[email protected]>
Co-authored-by: Scott Addie <[email protected]>
Co-authored-by: Scott Addie <[email protected]>
Co-authored-by: Scott Addie <[email protected]>
Co-authored-by: Scott Addie <[email protected]>
Co-authored-by: Scott Addie <[email protected]>
Co-authored-by: Scott Addie <[email protected]>
Co-authored-by: Scott Addie <[email protected]>
Co-authored-by: Scott Addie <[email protected]>
Co-authored-by: Scott Addie <[email protected]>
Co-authored-by: Scott Addie <[email protected]>
scottaddie
approved these changes
Mar 1, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Packages impacted by this PR
@azure/identity
Issues associated with this PR
#20068
Describe the problem that is addressed by this PR
Developer Customer Support needs an Azure Identity Trouble Shooting Guide (TSG) for JS which includes the error codes and mitigation explained clearly. .NET has a PR open to address this Azure/azure-sdk-for-net#26716
This PR for JS is based off of .NET's PR and customized for JS Identity SDK