You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: sdk/identity/azure_identity/README.md
+14-4Lines changed: 14 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,9 +33,9 @@ When no default browser is available, `az login` uses the device code authentica
33
33
34
34
### Credentials
35
35
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.
37
37
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.
39
39
40
40
### DefaultAzureCredential
41
41
@@ -55,7 +55,7 @@ The following examples are provided:
55
55
56
56
### Authenticate with `DefaultAzureCredential`
57
57
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].
59
59
60
60
This example demonstrates authenticating the `SecretClient` from the [azure_security_keyvault_secrets] crate using `DefaultAzureCredential`.
|[`ManagedIdentityCredential`][managed_id_cred_ref]| Authenticates the managed identity of an Azure resource.
137
138
|[`WorkloadIdentityCredential`][workload_id_cred_ref]| Supports [Microsoft Entra Workload ID](https://learn.microsoft.com/azure/aks/workload-identity-overview) on Kubernetes.
138
139
139
140
### Authenticate service principals
140
141
141
142
|Credential|Usage|Reference
142
143
|-|-|-
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)
143
146
|[`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)
144
148
145
149
### Authenticate via development tools
146
150
147
151
|Credential|Usage|Reference
148
152
|-|-|-
149
153
|[`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)
150
155
151
156
## Next steps
152
157
@@ -167,15 +172,20 @@ When you submit a pull request, a CLA-bot will automatically determine whether y
167
172
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.
0 commit comments