Skip to content

[Identity] Documentation improvements #31798

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.

Sign up for GitHub

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

Merged
billwert merged 1 commit into from
Oct 28, 2022
Merged

[Identity] Documentation improvements #31798

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions sdk/identity/azure-identity/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,7 @@ While the `DefaultAzureCredential` is generally the quickest way to get started

ManagedIdentityCredential managedIdentityCredential = new ManagedIdentityCredentialBuilder().build();
AzureCliCredential cliCredential = new AzureCliCredentialBuilder().build();

ChainedTokenCredential credential = new ChainedTokenCredentialBuilder().addLast(managedIdentityCredential).addLast(cliCredential).build();

// Azure SDK client builders accept the credential as a parameter
Expand Down Expand Up @@ -476,7 +476,7 @@ Credentials can be chained together to be tried in turn until one succeeds using
</tr>
<tr>
<td><code>AZURE_CLIENT_CERTIFICATE_PATH</code></td>
<td>path to a PEM-encoded certificate file including private key</td>
<td>path to a PFX or PEM-encoded certificate file including private key</td>
</tr>
<tr>
<td><code>AZURE_CLIENT_CERTIFICATE_PASSWORD</code></td>
Expand All @@ -500,6 +500,10 @@ Credentials can be chained together to be tried in turn until one succeeds using
<td><code>AZURE_CLIENT_ID</code></td>
<td>ID of an Azure AD application</td>
</tr>
<tr>
<td><code>AZURE_TENANT_ID</code></td>
<td>(optional) ID of the application's Azure AD tenant</td>
</tr>
<tr>
<td><code>AZURE_USERNAME</code></td>
<td>a username (usually an email address)</td>
Expand Down
1 change: 1 addition & 0 deletions sdk/identity/azure-identity/src/main/java/com/azure/identity/EnvironmentCredential.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
* <li>{@link Configuration#PROPERTY_AZURE_CLIENT_ID AZURE_CLIENT_ID}</li>
* <li>{@link Configuration#PROPERTY_AZURE_USERNAME AZURE_USERNAME}</li>
* <li>{@link Configuration#PROPERTY_AZURE_PASSWORD AZURE_PASSWORD}</li>
* <li>{@link Configuration#PROPERTY_AZURE_TENANT_ID AZURE_TENANT_ID}</li>
* </ul>
*/
@Immutable
Expand Down
8 changes: 7 additions & 1 deletion sdk/identity/azure-identity/src/main/java/com/azure/identity/VisualStudioCodeCredential.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,13 @@
import java.util.concurrent.atomic.AtomicReference;

/**
* Enables authentication to Azure Active Directory using data from Visual Studio Code
* Enables authentication to Azure Active Directory as the user signed in to Visual Studio Code via
* the 'Azure Account' extension.
*
* <p>It's a <a href="https://github.com/Azure/azure-sdk-for-java/issues/27364">known issue</a> that this credential doesn't
* work with <a href="https://marketplace.visualstudio.com/items?itemName=ms-vscode.azure-account">Azure Account extension</a>
* versions newer than <strong>0.9.11</strong>. A long-term fix to this problem is in progress. In the meantime, consider
* authenticating with {@link AzureCliCredential}.</p>
*/
public class VisualStudioCodeCredential implements TokenCredential {
private final IdentityClient identityClient;
Expand Down