Skip to content

Commit 97bddf8

Browse files
authored
DAC auth flow updates (Azure#30363)
* DAC auth flow updates * Use aka.ms links
1 parent 34b77b3 commit 97bddf8

File tree

3 files changed

+16
-17
lines changed

3 files changed

+16
-17
lines changed

sdk/identity/azure-identity/README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -226,7 +226,7 @@ Not all credentials require this configuration. Credentials that authenticate th
226226
|[`ChainedTokenCredential`][chain_cred_ref]| Allows users to define custom authentication flows composing multiple credentials.
227227
|[`EnvironmentCredential`][environment_cred_ref]| Authenticates a service principal or user via credential information specified in environment variables.
228228
|[`ManagedIdentityCredential`][managed_id_cred_ref]| Authenticates the managed identity of an Azure resource.
229-
|`WorkloadIdentityCredential`| Supports [Azure AD workload identity](https://learn.microsoft.com/azure/aks/workload-identity-overview) on Kubernetes.
229+
|[`WorkloadIdentityCredential`][workload_id_cred_ref]| Supports [Azure AD workload identity](https://learn.microsoft.com/azure/aks/workload-identity-overview) on Kubernetes.
230230

231231
### Authenticate service principals
232232

@@ -251,8 +251,8 @@ Not all credentials require this configuration. Credentials that authenticate th
251251
|Credential|Usage|Reference
252252
|-|-|-
253253
|[`AzureCliCredential`][cli_cred_ref]| Authenticates in a development environment with the Azure CLI. | [Azure CLI authentication](https://learn.microsoft.com/cli/azure/authenticate-azure-cli)
254-
|`AzureDeveloperCliCredential`| Authenticates in a development environment with the Azure Developer CLI. | [Azure Developer CLI Reference](https://learn.microsoft.com/azure/developer/azure-developer-cli/reference)
255-
|[`PowerShellCredential`][powershell_cred_ref]| Authenticates in a development environment with the Azure PowerShell. | [Azure PowerShell authentication](https://learn.microsoft.com/powershell/azure/authenticate-azureps)
254+
|[`AzureDeveloperCliCredential`][azd_cli_cred_ref]| Authenticates in a development environment with the Azure Developer CLI. | [Azure Developer CLI Reference](https://learn.microsoft.com/azure/developer/azure-developer-cli/reference)
255+
|[`AzurePowerShellCredential`][powershell_cred_ref]| Authenticates in a development environment with the Azure PowerShell. | [Azure PowerShell authentication](https://learn.microsoft.com/powershell/azure/authenticate-azureps)
256256
|[`VisualStudioCodeCredential`][vscode_cred_ref]| Authenticates as the user signed in to the Visual Studio Code Azure Account extension. | [VS Code Azure Account extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.azure-account)
257257

258258
## Environment variables
@@ -296,7 +296,6 @@ Token caching is a feature provided by the Azure Identity library that allows ap
296296

297297
The Azure Identity library offers both in-memory and persistent disk caching. For more details, see the [token caching documentation](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/identity/azure-identity/TOKEN_CACHING.md).
298298

299-
300299
## Troubleshooting
301300

302301
See the [troubleshooting guide][troubleshooting_guide] for details on how to diagnose various failure scenarios.
@@ -348,6 +347,7 @@ When you submit a pull request, a CLA-bot will automatically determine whether y
348347
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information, see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
349348

350349
[auth_code_cred_ref]: https://aka.ms/azsdk/python/identity/authorizationcodecredential
350+
[azd_cli_cred_ref]: https://aka.ms/azsdk/python/identity/azuredeveloperclicredential
351351
[azure_cli]: https://learn.microsoft.com/cli/azure
352352
[azure_developer_cli]:https://aka.ms/azure-dev
353353
[azure_core_transport_doc]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#transport
@@ -372,5 +372,6 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope
372372
[troubleshooting_guide]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/identity/azure-identity/TROUBLESHOOTING.md
373373
[userpass_cred_ref]: https://aka.ms/azsdk/python/identity/usernamepasswordcredential
374374
[vscode_cred_ref]: https://aka.ms/azsdk/python/identity/vscodecredential
375+
[workload_id_cred_ref]: https://aka.ms/azsdk/python/identity/workloadidentitycredential
375376

376377
![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-python%2Fsdk%2Fidentity%2Fazure-identity%2FREADME.png)

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

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,15 @@
22
%% STEPS TO GENERATE IMAGE
33
%% =======================
44
%% 1. Install mermaid CLI (see https://github.com/mermaid-js/mermaid-cli/blob/master/README.md)
5-
%% v8.14.0 is known good for our process. npm install -g @mermaid-js/mermaid-cli@8.14.0
5+
%% v10.1.0 is known good for our process. npm install -g @mermaid-js/mermaid-cli@10.1.0
66
%% 2. Run command: mmdc -i DefaultAzureCredentialAuthFlow.md -o DefaultAzureCredentialAuthFlow.svg
77
88
flowchart LR;
9-
A(Environment):::deployed ==> B(Workload Identity):::deployed ==> C(Managed Identity):::deployed ==> D(Azure CLI):::developer ==> E(Azure PowerShell):::developer ==> F(Azure Developer CLI):::developer ==> G(Interactive browser):::interactive;
9+
A(Environment):::deployed --> B(Workload Identity):::deployed --> C(Managed Identity):::deployed --> D(Azure CLI):::developer --> E(Azure PowerShell):::developer --> F(Azure Developer CLI):::developer --> G(Interactive browser):::interactive;
1010
1111
subgraph CREDENTIAL TYPES;
1212
direction LR;
13-
Deployed(Deployed service):::deployed ==> Developer(Developer):::developer ==> Interactive(Interactive developer):::interactive;
14-
15-
%% Hide links between boxes in the legend by setting width to 0. The integers after "linkStyle" represent link indices.
16-
linkStyle 6 stroke-width:0px;
17-
linkStyle 7 stroke-width:0px;
13+
Deployed(Deployed service):::deployed ~~~ Developer(Developer):::developer ~~~ Interactive(Interactive developer):::interactive;
1814
end;
1915
2016
%% Define styles for credential type boxes
@@ -23,9 +19,11 @@ flowchart LR;
2319
classDef interactive fill:#A5A5A5, stroke:#828282;
2420
2521
%% Add API ref links to credential type boxes
26-
click A "https://learn.microsoft.com/python/api/azure-identity/azure.identity.environmentcredential?view=azure-python" _blank;
27-
click C "https://learn.microsoft.com/python/api/azure-identity/azure.identity.managedidentitycredential?view=azure-python" _blank;
28-
click D "https://learn.microsoft.com/python/api/azure-identity/azure.identity.azureclicredential?view=azure-python" _blank;
29-
click E "https://learn.microsoft.com/python/api/azure-identity/azure.identity.azurepowershellcredential?view=azure-python" _blank;
30-
click G "https://learn.microsoft.com/python/api/azure-identity/azure.identity.interactivebrowsercredential?view=azure-python" _blank;
22+
click A "https://aka.ms/azsdk/python/identity/environmentcredential" _blank;
23+
click B "https://aka.ms/azsdk/python/identity/workloadidentitycredential" _blank;
24+
click C "https://aka.ms/azsdk/python/identity/managedidentitycredential" _blank;
25+
click D "https://aka.ms/azsdk/python/identity/azclicredential" _blank;
26+
click E "https://aka.ms/azsdk/python/identity/powershellcredential" _blank;
27+
click F "https://aka.ms/azsdk/python/identity/azuredeveloperclicredential" _blank;
28+
click G "https://aka.ms/azsdk/python/identity/interactivebrowsercredential" _blank;
3129
```

0 commit comments

Comments
 (0)