Skip to content

Commit 03c48c2

Browse files
scottaddieCopilot
andauthored
Add missing credentials to Identity README (Azure#2701)
* Add missing credentials to Identity README * Update heading * More edits * Update sdk/identity/azure_identity/README.md Co-authored-by: Copilot <[email protected]> * Replace class with struct * Add structs to dictionary * React to feedback * Update dictionary --------- Co-authored-by: Copilot <[email protected]>
1 parent e77379f commit 03c48c2

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

sdk/identity/azure_identity/README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,9 @@ When no default browser is available, `az login` uses the device code authentica
3333

3434
### Credentials
3535

36-
A credential is a class that contains or can obtain the data needed for a service client to authenticate requests. Service clients across the Azure SDK accept a credential instance when they're constructed, and use that credential to authenticate requests.
36+
A credential is a struct that contains or can obtain the data needed for a service client to authenticate requests. Service clients across the Azure SDK accept a credential instance when they're constructed, and use that credential to authenticate requests.
3737

38-
The Azure Identity library focuses on OAuth authentication with Microsoft Entra ID. It offers various credential classes capable of acquiring a Microsoft Entra access token. See the [Credential classes](#credential-classes "Credential classes") section for a list of this library's credential classes.
38+
The Azure Identity library focuses on OAuth authentication with Microsoft Entra ID. It offers various credentials capable of acquiring a Microsoft Entra access token. See the [Credential structures](#credential-structures "Credential structures") section for a list of this library's credentials.
3939

4040
### DefaultAzureCredential
4141

@@ -55,7 +55,7 @@ The following examples are provided:
5555

5656
### Authenticate with `DefaultAzureCredential`
5757

58-
More details on configuring your environment to use `DefaultAzureCredential` can be found in the class's [reference documentation][default_cred_ref].
58+
More details on configuring your environment to use `DefaultAzureCredential` can be found in the struct's [reference documentation][default_cred_ref].
5959

6060
This example demonstrates authenticating the `SecretClient` from the [azure_security_keyvault_secrets] crate using `DefaultAzureCredential`.
6161

@@ -122,7 +122,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
122122

123123
```
124124

125-
## Credential classes
125+
## Credential structures
126126

127127
### Credential chains
128128

@@ -134,19 +134,24 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
134134

135135
|Credential|Usage
136136
|-|-
137+
|[`ManagedIdentityCredential`][managed_id_cred_ref]| Authenticates the managed identity of an Azure resource.
137138
|[`WorkloadIdentityCredential`][workload_id_cred_ref]| Supports [Microsoft Entra Workload ID](https://learn.microsoft.com/azure/aks/workload-identity-overview) on Kubernetes.
138139

139140
### Authenticate service principals
140141

141142
|Credential|Usage|Reference
142143
|-|-|-
144+
|[`AzurePipelinesCredential`][az_pipelines_cred_ref]| Supports [Microsoft Entra Workload ID](https://learn.microsoft.com/azure/devops/pipelines/release/configure-workload-identity?view=azure-devops) on Azure Pipelines. |
145+
|[`ClientAssertionCredential`][assert_cred_ref]| Authenticates a service principal using a signed client assertion. | [Service principal authentication](https://learn.microsoft.com/entra/identity-platform/app-objects-and-service-principals)
143146
|[`ClientCertificateCredential`][cert_cred_ref]| Authenticates a service principal using a certificate. | [Service principal authentication](https://learn.microsoft.com/entra/identity-platform/app-objects-and-service-principals)
147+
|[`ClientSecretCredential`][secret_cred_ref]| Authenticates a service principal using a secret. | [Service principal authentication](https://learn.microsoft.com/entra/identity-platform/app-objects-and-service-principals)
144148

145149
### Authenticate via development tools
146150

147151
|Credential|Usage|Reference
148152
|-|-|-
149153
|[`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)
154+
|[`AzureDeveloperCliCredential`][azd_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)
150155

151156
## Next steps
152157

@@ -167,15 +172,20 @@ When you submit a pull request, a CLA-bot will automatically determine whether y
167172
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.
168173

169174
<!-- LINKS -->
175+
[assert_cred_ref]: https://docs.rs/azure_identity/latest/azure_identity/struct.ClientAssertionCredential.html
176+
[az_pipelines_cred_ref]: https://docs.rs/azure_identity/latest/azure_identity/struct.AzurePipelinesCredential.html
177+
[azd_cred_ref]: https://docs.rs/azure_identity/latest/azure_identity/struct.AzureDeveloperCliCredential.html
170178
[Azure CLI]: https://learn.microsoft.com/cli/azure
171179
[azure_security_keyvault_secrets]: https://github.com/Azure/azure-sdk-for-rust/tree/main/sdk/keyvault/azure_security_keyvault_secrets
172180
[Azure subscription]: https://azure.microsoft.com/free/
173181
[cert_cred_ref]: https://docs.rs/azure_identity/latest/azure_identity/struct.ClientCertificateCredential.html
174182
[cli_cred_ref]: https://docs.rs/azure_identity/latest/azure_identity/struct.AzureCliCredential.html
175183
[default_cred_ref]: https://docs.rs/azure_identity/latest/azure_identity/struct.DefaultAzureCredential.html
184+
[managed_id_cred_ref]: https://docs.rs/azure_identity/latest/azure_identity/struct.ManagedIdentityCredential.html
176185
[Microsoft Entra ID documentation]: https://learn.microsoft.com/entra/identity/
177186
[API reference documentation]: https://docs.rs/azure_identity/latest/azure_identity/
178187
[Package (crates.io)]: https://crates.io/crates/azure_identity
188+
[secret_cred_ref]: https://docs.rs/azure_identity/latest/azure_identity/struct.ClientSecretCredential.html
179189
[Source code]: https://github.com/Azure/azure-sdk-for-rust/tree/main/sdk/identity/azure_identity
180190
[token_cred_ref]: https://docs.rs/azure_core/latest/azure_core/credentials/trait.TokenCredential.html
181191
[workload_id_cred_ref]: https://docs.rs/azure_identity/latest/azure_identity/struct.WorkloadIdentityCredential.html

0 commit comments

Comments
 (0)