Skip to content

Commit 1a5e075

Browse files
authored
[Identity] Add known issues section to readme (Azure#21222)
1 parent 9b54ea4 commit 1a5e075

File tree

1 file changed

+24
-21
lines changed

1 file changed

+24
-21
lines changed

sdk/identity/azure-identity/README.md

Lines changed: 24 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,14 @@ pip install azure-identity
2929
- Python 2.7 or a recent version of Python 3 (this library doesn't support
3030
end-of-life versions)
3131

32-
### Authenticating during local development
32+
### Authenticate during local development
3333

3434
When debugging and executing code locally it is typical for developers to use
3535
their own accounts for authenticating calls to Azure services. The Azure
3636
Identity library supports authenticating through developer tools to simplify
3737
local development.
3838

39-
#### Authenticating via Visual Studio Code
39+
#### Authenticate via Visual Studio Code
4040

4141
`DefaultAzureCredential` and `VisualStudioCodeCredential` can authenticate as
4242
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
4545
pressing `F1` to open the command palette and running the `Azure: Sign In`
4646
command.
4747

48-
#### Authenticating via the Azure CLI
48+
#### Authenticate via the Azure CLI
4949

5050
`DefaultAzureCredential` and `AzureCliCredential` can authenticate as the user
5151
signed in to the [Azure CLI][azure_cli]. To sign in to the Azure CLI, run
@@ -66,7 +66,8 @@ to authenticate requests.
6666

6767
The Azure Identity library focuses on OAuth authentication with Azure Active
6868
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.
7071

7172
### DefaultAzureCredential
7273

@@ -111,11 +112,11 @@ in any hosting environment which supports managed identities, such as (this list
111112

112113
The following examples are provided below:
113114

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")
116117
- [Async credentials](#async-credentials "Async credentials")
117118

118-
### Authenticating with `DefaultAzureCredential`
119+
### Authenticate with `DefaultAzureCredential`
119120

120121
More details on configuring your environment to use the `DefaultAzureCredential`
121122
can be found in the class's [reference documentation][default_cred_ref].
@@ -133,7 +134,7 @@ default_credential = DefaultAzureCredential()
133134
client = BlobServiceClient(account_url, credential=default_credential)
134135
```
135136

136-
#### Enabling interactive authentication with `DefaultAzureCredential`
137+
#### Enable interactive authentication with `DefaultAzureCredential`
137138

138139
Interactive authentication is disabled in the `DefaultAzureCredential` by
139140
default and can be enabled with a keyword argument:
@@ -146,7 +147,7 @@ When enabled, `DefaultAzureCredential` falls back to interactively
146147
authenticating via the system's default web browser when no other credential is
147148
available.
148149

149-
#### Specifying a user assigned managed identity for `DefaultAzureCredential`
150+
#### Specify a user assigned managed identity for `DefaultAzureCredential`
150151

151152
Many Azure hosts allow the assignment of a user assigned managed identity. To
152153
configure `DefaultAzureCredential` to authenticate a user assigned identity,
@@ -159,7 +160,7 @@ DefaultAzureCredential(managed_identity_client_id=client_id)
159160
Alternatively, set the environment variable `AZURE_CLIENT_ID` to the identity's
160161
client ID.
161162

162-
### Defining a custom authentication flow with `ChainedTokenCredential`
163+
### Define a custom authentication flow with `ChainedTokenCredential`
163164

164165
`DefaultAzureCredential` is generally the quickest way to get started developing
165166
applications for Azure. For more advanced scenarios,
@@ -221,7 +222,7 @@ default_credential = DefaultAzureCredential()
221222
client = SecretClient("https://my-vault.vault.azure.net", default_credential)
222223
```
223224

224-
## Cloud Configuration
225+
## Cloud configuration
225226
Credentials default to authenticating to the Azure Active Directory endpoint for
226227
Azure Public Cloud. To access resources in other clouds, such as Azure Government
227228
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
237238
configuration. Similarly, `VisualStudioCodeCredential` accepts an `authority`
238239
argument but defaults to the authority matching VS Code's "Azure: Cloud" setting.
239240

240-
## Credential Classes
241+
## Credential classes
241242

242-
### Authenticating Azure Hosted Applications
243+
### Authenticate Azure hosted applications
243244

244245
|credential|usage
245246
|-|-
@@ -248,29 +249,29 @@ argument but defaults to the authority matching VS Code's "Azure: Cloud" setting
248249
|[EnvironmentCredential][environment_cred_ref]|authenticate a service principal or user configured by environment variables
249250
|[ManagedIdentityCredential][managed_id_cred_ref]|authenticate the managed identity of an Azure resource
250251

251-
### Authenticating Service Principals
252+
### Authenticate service principals
252253

253254
|credential|usage
254255
|-|-
255256
|[ClientSecretCredential][client_secret_cred_ref]| authenticate a service principal using a secret
256257
|[CertificateCredential][cert_cred_ref]| authenticate a service principal using a certificate
257258

258-
### Authenticating Users
259+
### Authenticate users
259260

260261
|credential|usage
261262
|-|-
262263
|[InteractiveBrowserCredential][interactive_cred_ref]|interactively authenticate a user with the default web browser
263264
|[DeviceCodeCredential][device_code_cred_ref]| interactively authenticate a user on a device with limited UI
264265
|[UsernamePasswordCredential][userpass_cred_ref]| authenticate a user with a username and password (does not support multi-factor authentication)
265266

266-
### Authenticating via Development Tools
267+
### Authenticate via development tools
267268

268269
|credential|usage
269270
|-|-
270271
|[AzureCliCredential][cli_cred_ref]|authenticate as the user signed in to the Azure CLI
271272
|[VisualStudioCodeCredential][vscode_cred_ref]|authenticate as the user signed in to the Visual Studio Code Azure Account extension
272273

273-
## Environment Variables
274+
## Environment variables
274275

275276
[DefaultAzureCredential][default_cred_ref] and
276277
[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.
305306

306307
See the [troubleshooting guide][troubleshooting_guide] for details on how to diagnose various failure scenarios.
307308

308-
### Error Handling
309+
### Error handling
309310

310311
Credentials raise `CredentialUnavailableError` when they're unable to attempt
311312
authentication because they lack required data or state. For example,
@@ -346,11 +347,13 @@ Client and management libraries listed on the
346347
which support Azure AD authentication accept credentials from this library. You can learn more
347348
about using these libraries in their documentation, which is linked from the release page.
348349

349-
### B2C Support
350+
### Known issues
350351

351-
This library does not support [Azure Active Directory B2C][b2c].
352+
This library doesn't support [Azure AD B2C][b2c].
352353

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
354357

355358
If you encounter bugs or have suggestions, please
356359
[open an issue](https://github.com/Azure/azure-sdk-for-python/issues).

0 commit comments

Comments
 (0)