Skip to content

Commit 3c019d1

Browse files
g2vinayg2vinay
authored
Update Identity Javadocs. (#35117)
1 parent 431e667 commit 3c019d1

File tree

9 files changed

+77
-75
lines changed

9 files changed

+77
-75
lines changed

‎sdk/identity/azure-identity/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -305,7 +305,7 @@ Not all credentials require this configuration. Credentials that authenticate th
305305
<tr>
306306
<td><code><a href="https://learn.microsoft.com/java/api/com.azure.identity.workloadidentitycredential?view=azure-java-stable">WorkloadIdentityCredential</a></code></td>
307307
<td>supports <a href="https://learn.microsoft.com/azure/aks/workload-identity-overview">Azure AD workload identity</a> on Kubernetes</td>
308-
<td></td>
308+
<td><a href="https://learn.microsoft.com/java/api/com.azure.identity.workloadidentitycredential?view=azure-java-stable">example</a></td>
309309
</tr>
310310
</tbody>
311311
</table>

‎sdk/identity/azure-identity/images/mermaidjs/DefaultAzureCredentialAuthFlow.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
%% 1. Install mermaid CLI (see https://github.com/mermaid-js/mermaid-cli/blob/master/README.md)
55
%% v10.0.2 is known good for our process. npm install -g @mermaid-js/[email protected]
66
%% 2. Run command: mmdc -i DefaultAzureCredentialAuthFlow.md -o DefaultAzureCredentialAuthFlow.svg
7+
%% 3. Generate in .png, run command: mmdc -i DefaultAzureCredentialAuthFlow.md -o DefaultAzureCredentialAuthFlow.png
8+
%% 4. Copy the generated .png file to azure-identity/src/main/java/com/azure/identity/doc-files directory
9+
710
811
flowchart LR;
912
A(Environment):::deployed --> B(Workload Identity):::deployed --> C(Managed Identity):::deployed --> D(Azure Developer CLI):::developer --> E(IntelliJ):::developer --> F(Azure CLI):::developer --> G(Azure PowerShell):::developer;

‎sdk/identity/azure-identity/src/main/java/com/azure/identity/DefaultAzureCredential.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
* with credentials that are used to authenticate in a development environment. The DefaultAzureCredential will
1515
* attempt to authenticate via the following mechanisms in order.</p>
1616
*
17-
* <img src="doc-files/DefaultAzureCredentialAuthFlow.svg" alt="">
17+
* <img src="doc-files/DefaultAzureCredentialAuthFlow.png" alt="">
1818
*
1919
* <ol>
2020
* <li>{@link EnvironmentCredential} - The DefaultAzureCredential will read account information specified via

‎sdk/identity/azure-identity/src/main/java/com/azure/identity/WorkloadIdentityCredential.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
*
4242
* <!-- src_embed com.azure.identity.credential.workloadidentitycredential.construct -->
4343
* <pre>
44-
* TokenCredential onBehalfOfCredential = new WorkloadIdentityCredentialBuilder&#40;&#41;
44+
* TokenCredential workloadIdentityCredential = new WorkloadIdentityCredentialBuilder&#40;&#41;
4545
* .clientId&#40;&quot;&lt;clientID&gt;&quot;&#41;
4646
* .tenantId&#40;&quot;&lt;tenantID&gt;&quot;&#41;
4747
* .tokenFilePath&#40;&quot;&lt;token-file-path&gt;&quot;&#41;

‎sdk/identity/azure-identity/src/main/java/com/azure/identity/WorkloadIdentityCredentialBuilder.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
*
3232
* <!-- src_embed com.azure.identity.credential.workloadidentitycredential.construct -->
3333
* <pre>
34-
* TokenCredential onBehalfOfCredential = new WorkloadIdentityCredentialBuilder&#40;&#41;
34+
* TokenCredential workloadIdentityCredential = new WorkloadIdentityCredentialBuilder&#40;&#41;
3535
* .clientId&#40;&quot;&lt;clientID&gt;&quot;&#41;
3636
* .tenantId&#40;&quot;&lt;tenantID&gt;&quot;&#41;
3737
* .tokenFilePath&#40;&quot;&lt;token-file-path&gt;&quot;&#41;

‎sdk/identity/azure-identity/src/main/java/com/azure/identity/doc-files/DefaultAzureCredentialAuthFlow.png‎

35.6 KB
Loading

‎sdk/identity/azure-identity/src/main/java/com/azure/identity/doc-files/DefaultAzureCredentialAuthFlow.svg‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)