Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Azure.Identity Revising Troubleshooting.md #26716

Merged
merged 26 commits into from
Mar 2, 2022

Conversation

schaabs
Copy link
Member

@schaabs schaabs commented Jan 31, 2022

All SDK Contribution checklist:

This checklist is used to make sure that common guidelines for a pull request are followed.

  • Please open PR in Draft mode if it is:
    • Work in progress or not intended to be merged.
    • Encountering multiple pipeline failures and working on fixes.
  • If an SDK is being regenerated based on a new swagger spec, a link to the pull request containing these swagger spec changes has been included above.
  • I have read the contribution guidelines.
  • The pull request does not introduce breaking changes.

General Guidelines and Best Practices

  • Title of the pull request is clear and informative.
  • There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

  • Pull request includes test coverage for the included changes.

SDK Generation Guidelines

  • The generate.cmd file for the SDK has been updated with the version of AutoRest, as well as the commitid of your swagger spec or link to the swagger spec, used to generate the code. (Track 2 only)
  • The *.csproj and AssemblyInfo.cs files have been updated with the new version of the SDK. Please double check nuget.org current release version.

Additional management plane SDK specific contribution checklist:

Note: Only applies to Microsoft.Azure.Management.[RP] or Azure.ResourceManager.[RP]

  • Include updated management metadata.
  • Update AzureRP.props to add/remove version info to maintain up to date API versions.

Management plane SDK Troubleshooting

  • If this is very first SDK for a services and you are adding new service folders directly under /SDK, please add new service label and/or contact assigned reviewer.

  • If the check fails at the Verify Code Generation step, please ensure:

    • Do not modify any code in generated folders.
    • Do not selectively include/remove generated files in the PR.
    • Do use generate.ps1/cmd to generate this PR instead of calling autorest directly.
      Please pay attention to the @microsoft.csharp version output after running generate.ps1. If it is lower than current released version (2.3.82), please run it again as it should pull down the latest version.

    Note: We have recently updated the PSH module called by generate.ps1 to emit additional data. This would help reduce/eliminate the Code Verification check error. Please run following command:

      `dotnet msbuild eng/mgmt.proj /t:Util /p:UtilityName=InstallPsModules`
    

Old outstanding PR cleanup

Please note:
If PRs (including draft) has been out for more than 60 days and there are no responses from our query or followups, they will be closed to maintain a concise list for our reviewers.

@schaabs schaabs requested a review from christothes as a code owner January 31, 2022 17:23
@ghost ghost added the Azure.Identity label Jan 31, 2022
@g2vinay
Copy link
Member

g2vinay commented Jan 31, 2022

Update aka.ms links in .NET Identity Exception messages code accordingly.

@KarishmaGhiya
Copy link
Member

@schaabs Should we include links to the error codes for authorization endpoint errors for some credentials as part of troubleshooting guide?
Examples of error codes for ClientClaimCredential could be - https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-protocols-oidc#error-codes-for-authorization-endpoint-errors
or for AuthCodeCredential could be - https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-auth-code-flow#error-codes-for-authorization-endpoint-errors
I have opened an issue in JS to track this - Azure/azure-sdk-for-js#20177

@christothes christothes mentioned this pull request Feb 7, 2022
11 tasks
@scottaddie
Copy link
Member

@schaabs I've created #26947 as a reminder to update this TSG for the BrokeredAuthN package once it ships.

@check-enforcer
Copy link

check-enforcer bot commented Mar 1, 2022

This pull request is protected by Check Enforcer.
For more information about how to run a pipeline against this pull request, see this.

@schaabs
Copy link
Member Author

schaabs commented Mar 2, 2022

/azp run net - identity- ci

@azure-pipelines
Copy link

No pipelines are associated with this pull request.

@schaabs schaabs merged commit 4e3e465 into Azure:main Mar 2, 2022
yanfa317 pushed a commit to yanfa317/azure-sdk-for-net that referenced this pull request Mar 8, 2022
* Identity Updating Troubleshooting guide

* Update sdk/identity/Azure.Identity/TROUBLESHOOTING.md

Co-authored-by: Christopher Scott <[email protected]>

* Update sdk/identity/Azure.Identity/TROUBLESHOOTING.md

Co-authored-by: Christopher Scott <[email protected]>

* Update sdk/identity/Azure.Identity/TROUBLESHOOTING.md

Co-authored-by: Christopher Scott <[email protected]>

* Update sdk/identity/Azure.Identity/TROUBLESHOOTING.md

Co-authored-by: Christopher Scott <[email protected]>

* Update sdk/identity/Azure.Identity/TROUBLESHOOTING.md

Co-authored-by: Christopher Scott <[email protected]>

* Update sdk/identity/Azure.Identity/TROUBLESHOOTING.md

Co-authored-by: Christopher Scott <[email protected]>

* Update sdk/identity/Azure.Identity/TROUBLESHOOTING.md

Co-authored-by: Christopher Scott <[email protected]>

* fb

* fix links

* ungerunding headers

* Update sdk/identity/Azure.Identity/TROUBLESHOOTING.md

Co-authored-by: Christopher Scott <[email protected]>

* Update sdk/identity/Azure.Identity/TROUBLESHOOTING.md

Co-authored-by: Christopher Scott <[email protected]>

* Update sdk/identity/Azure.Identity/TROUBLESHOOTING.md

Co-authored-by: Christopher Scott <[email protected]>

* Update sdk/identity/Azure.Identity/TROUBLESHOOTING.md

Co-authored-by: Christopher Scott <[email protected]>

* more fb

* more fb

* Update sdk/identity/Azure.Identity/TROUBLESHOOTING.md

Co-authored-by: Christopher Scott <[email protected]>

* add additional help section

* fb

* add permission issues section

* fb

* make image link absolute

Co-authored-by: Christopher Scott <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants