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
+24-21Lines changed: 24 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,14 +29,14 @@ pip install azure-identity
29
29
- Python 2.7 or a recent version of Python 3 (this library doesn't support
30
30
end-of-life versions)
31
31
32
-
### Authenticating during local development
32
+
### Authenticate during local development
33
33
34
34
When debugging and executing code locally it is typical for developers to use
35
35
their own accounts for authenticating calls to Azure services. The Azure
36
36
Identity library supports authenticating through developer tools to simplify
37
37
local development.
38
38
39
-
#### Authenticating via Visual Studio Code
39
+
#### Authenticate via Visual Studio Code
40
40
41
41
`DefaultAzureCredential` and `VisualStudioCodeCredential` can authenticate as
42
42
the user signed in to Visual Studio Code's
@@ -45,7 +45,7 @@ After installing the extension, sign in to Azure in Visual Studio Code by
45
45
pressing `F1` to open the command palette and running the `Azure: Sign In`
46
46
command.
47
47
48
-
#### Authenticating via the Azure CLI
48
+
#### Authenticate via the Azure CLI
49
49
50
50
`DefaultAzureCredential` and `AzureCliCredential` can authenticate as the user
51
51
signed in to the [Azure CLI][azure_cli]. To sign in to the Azure CLI, run
@@ -66,7 +66,8 @@ to authenticate requests.
66
66
67
67
The Azure Identity library focuses on OAuth authentication with Azure Active
68
68
Directory (AAD). It offers a variety of credential classes capable of acquiring
69
-
an AAD access token. See [Credential Classes](#credential-classes"Credential Classes") below for a list of this library's credential classes.
69
+
an AAD access token. See the [Credential classes](#credential-classes"Credential classes") section below for a list of
70
+
this library's credential classes.
70
71
71
72
### DefaultAzureCredential
72
73
@@ -111,11 +112,11 @@ in any hosting environment which supports managed identities, such as (this list
111
112
112
113
The following examples are provided below:
113
114
114
-
-[Authenticating with DefaultAzureCredential](#authenticating-with-defaultazurecredential"Authenticating with DefaultAzureCredential")
115
-
-[Defining a custom authentication flow with ChainedTokenCredential](#defining-a-custom-authentication-flow-with-chainedtokencredential"Defining a custom authentication flow with ChainedTokenCredential")
115
+
-[Authenticate with DefaultAzureCredential](#authenticate-with-defaultazurecredential"Authenticate with DefaultAzureCredential")
116
+
-[Define a custom authentication flow with ChainedTokenCredential](#define-a-custom-authentication-flow-with-chainedtokencredential"Define a custom authentication flow with ChainedTokenCredential")
Credentials default to authenticating to the Azure Active Directory endpoint for
226
227
Azure Public Cloud. To access resources in other clouds, such as Azure Government
227
228
or a private cloud, configure credentials with the `authority` argument.
@@ -237,9 +238,9 @@ through a development tool, such as `AzureCliCredential`, use that tool's
237
238
configuration. Similarly, `VisualStudioCodeCredential` accepts an `authority`
238
239
argument but defaults to the authority matching VS Code's "Azure: Cloud" setting.
239
240
240
-
## Credential Classes
241
+
## Credential classes
241
242
242
-
### Authenticating Azure Hosted Applications
243
+
### Authenticate Azure hosted applications
243
244
244
245
|credential|usage
245
246
|-|-
@@ -248,29 +249,29 @@ argument but defaults to the authority matching VS Code's "Azure: Cloud" setting
248
249
|[EnvironmentCredential][environment_cred_ref]|authenticate a service principal or user configured by environment variables
249
250
|[ManagedIdentityCredential][managed_id_cred_ref]|authenticate the managed identity of an Azure resource
250
251
251
-
### Authenticating Service Principals
252
+
### Authenticate service principals
252
253
253
254
|credential|usage
254
255
|-|-
255
256
|[ClientSecretCredential][client_secret_cred_ref]| authenticate a service principal using a secret
256
257
|[CertificateCredential][cert_cred_ref]| authenticate a service principal using a certificate
257
258
258
-
### Authenticating Users
259
+
### Authenticate users
259
260
260
261
|credential|usage
261
262
|-|-
262
263
|[InteractiveBrowserCredential][interactive_cred_ref]|interactively authenticate a user with the default web browser
263
264
|[DeviceCodeCredential][device_code_cred_ref]| interactively authenticate a user on a device with limited UI
264
265
|[UsernamePasswordCredential][userpass_cred_ref]| authenticate a user with a username and password (does not support multi-factor authentication)
265
266
266
-
### Authenticating via Development Tools
267
+
### Authenticate via development tools
267
268
268
269
|credential|usage
269
270
|-|-
270
271
|[AzureCliCredential][cli_cred_ref]|authenticate as the user signed in to the Azure CLI
271
272
|[VisualStudioCodeCredential][vscode_cred_ref]|authenticate as the user signed in to the Visual Studio Code Azure Account extension
272
273
273
-
## Environment Variables
274
+
## Environment variables
274
275
275
276
[DefaultAzureCredential][default_cred_ref] and
276
277
[EnvironmentCredential][environment_cred_ref] can be configured with
@@ -305,7 +306,7 @@ client secret and certificate are both present, the client secret will be used.
305
306
306
307
See the [troubleshooting guide][troubleshooting_guide] for details on how to diagnose various failure scenarios.
307
308
308
-
### Error Handling
309
+
### Error handling
309
310
310
311
Credentials raise `CredentialUnavailableError` when they're unable to attempt
311
312
authentication because they lack required data or state. For example,
@@ -346,11 +347,13 @@ Client and management libraries listed on the
346
347
which support Azure AD authentication accept credentials from this library. You can learn more
347
348
about using these libraries in their documentation, which is linked from the release page.
348
349
349
-
### B2C Support
350
+
### Known issues
350
351
351
-
This library does not support [Azure Active Directory B2C][b2c].
352
+
This library doesn't support [Azure AD B2C][b2c].
352
353
353
-
### Provide Feedback
354
+
For other open issues, refer to the library's [GitHub repository](https://github.com/Azure/azure-sdk-for-python/issues?q=is%3Aopen+is%3Aissue+label%3AAzure.Identity).
355
+
356
+
### Provide feedback
354
357
355
358
If you encounter bugs or have suggestions, please
356
359
[open an issue](https://github.com/Azure/azure-sdk-for-python/issues).
0 commit comments