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 documentation feedback #8498

Closed
tjprescott opened this issue Nov 7, 2019 · 2 comments · Fixed by #18205
Closed

Azure.Identity documentation feedback #8498

tjprescott opened this issue Nov 7, 2019 · 2 comments · Fixed by #18205
Assignees
Milestone

Comments

@tjprescott
Copy link
Member

tjprescott commented Nov 7, 2019

Feedback on: https://azuresdkdocs.blob.core.windows.net/$web/python/azure-identity/1.0.0/index.html

  • DefaultAzureCredential - Clicking "DefaultAzureCredential" in the table does not go to that class. It is the only like that isn't an aka.ms link so that may have something to do with it.
    - CertificateCredential - cert_path says that the certificate must not be password protected. According to @johanste, this flow should work with a password-protected private key in the cert. Already tracked by Support client certificate passwords #5764.
  • Certificate Credential - No information or links to how to actually associate the certificate with a service principal. I found this flow to be particularly confusing and there is precedent since Managed Identity and Device Code have links to external docs.
  • DeviceCodeCredential - while it did link to documentation, that documentation was in-depth info on how the REST calls work. The would point of the SDK is that the user doesn't need to worry about that. What the documentation was lacking is all the work that needs to be done in the portal to correctly set this up to work. I ended up Googling and finding this, which was helpful: https://github.com/AzureAD/microsoft-authentication-library-for-dotnet/wiki/Device-Code-Flow
  • ManagedIdentityCredential - Here again, the linked documentation was dense and not helpful in me actually setting up the end-to-end configuration. I ended up consulting many docs and finally using the following Azure Friday video to figure out how to set up and test this: https://binged.it/2PUj704

cc/ @mayurid

@tjprescott tjprescott changed the title AzureIdentity documentation feedback Azure.Identity documentation feedback Nov 7, 2019
@johanste
Copy link
Member

johanste commented Nov 7, 2019

According to @johanste, this flow should work with a password-protected private key in the cert.

Not high priority, but is there a reason to not support password protected private keys?

@mayurid mayurid added this to the [2019] December milestone Nov 7, 2019
@chlowell
Copy link
Member

chlowell commented Nov 8, 2019

Not high priority, but is there a reason to not support password protected private keys?

No. Supporting them is tracked by #5764.

@chlowell chlowell removed this from the [2020] January milestone Mar 31, 2020
@chlowell chlowell added this to the Backlog milestone Apr 28, 2020
@github-actions github-actions bot locked and limited conversation to collaborators Apr 12, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants