Skip to content

Commit

Permalink
Ensure azure-identity readme has exactly one H1 (Azure#14480)
Browse files Browse the repository at this point in the history
The docs publishing system disallows multiple H1 headings in a document.
  • Loading branch information
chlowell authored Oct 14, 2020
1 parent 91ca08f commit d2cfea4
Showing 1 changed file with 12 additions and 13 deletions.
25 changes: 12 additions & 13 deletions sdk/identity/azure-identity/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,17 @@ Azure SDK clients which support Azure Active Directory (AAD) token authenticatio
| [API reference documentation][ref_docs]
| [Azure Active Directory documentation](https://docs.microsoft.com/azure/active-directory/)

# Getting started
## Getting started

## Install the package
### Install the package

Install Azure Identity with pip:

```sh
pip install azure-identity
```

## Prerequisites
### Prerequisites

- an [Azure subscription](https://azure.microsoft.com/free/)
- Python 2.7 or 3.5.3+
Expand Down Expand Up @@ -89,15 +89,15 @@ the following mechanisms in this order, stopping when one succeeds:
- Interactive - If enabled, `DefaultAzureCredential` will interactively
authenticate a user via the current system's default browser.

# Examples
## Examples

The following examples are provided below:

- [Authenticating with DefaultAzureCredential](#authenticating-with-defaultazurecredential "Authenticating with DefaultAzureCredential")
- [Defining a custom authentication flow with ChainedTokenCredential](#defining-a-custom-authentication-flow-with-chainedtokencredential "Defining a custom authentication flow with ChainedTokenCredential")
- [Async credentials](#async-credentials "Async credentials")

## Authenticating with `DefaultAzureCredential`
### Authenticating with `DefaultAzureCredential`

This example demonstrates authenticating the `BlobServiceClient` from the
[azure-storage-blob][azure_storage_blob] library using
Expand Down Expand Up @@ -125,7 +125,7 @@ When enabled, `DefaultAzureCredential` falls back to interactively
authenticating via the system's default web browser when no other credential is
available.

## Defining a custom authentication flow with `ChainedTokenCredential`
### Defining a custom authentication flow with `ChainedTokenCredential`

`DefaultAzureCredential` is generally the quickest way to get started developing
applications for Azure. For more advanced scenarios,
Expand All @@ -150,7 +150,7 @@ credential_chain = ChainedTokenCredential(managed_identity, azure_cli)
client = EventHubProducerClient(namespace, eventhub_name, credential_chain)
```

## Async credentials
### Async credentials

This library includes an async API supported on Python 3.5+. To use the async
credentials in [azure.identity.aio][ref_docs_aio], you must first install an
Expand Down Expand Up @@ -222,7 +222,7 @@ client = SecretClient("https://my-vault.vault.azure.net", default_credential)

## Environment Variables

[DefaultAzureCredential][default_cred_ref] and
[DefaultAzureCredential][default_cred_ref] and
[EnvironmentCredential][environment_cred_ref] can be configured with
environment variables. Each type of authentication requires values for specific
variables:
Expand Down Expand Up @@ -285,9 +285,9 @@ credential = DefaultAzureCredential(logging_enable=True)
> CAUTION: DEBUG level logs from credentials contain sensitive information.
> These logs must be protected to avoid compromising account security.
# Next steps
## Next steps

## Client library support
### Client library support

This is an incomplete list of client libraries accepting Azure Identity
credentials. You can learn more about these libraries, and find additional
Expand All @@ -301,12 +301,12 @@ documentation of them, at the links below.
- [azure-storage-blob][azure_storage_blob]
- [azure-storage-queue][azure_storage_queue]

## Provide Feedback
### Provide Feedback

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

# Contributing
## Contributing

This project welcomes contributions and suggestions. Most contributions require
you to agree to a Contributor License Agreement (CLA) declaring that you have
Expand Down Expand Up @@ -338,7 +338,6 @@ additional questions or comments.
[chain_cred_ref]: https://aka.ms/azsdk/python/identity/docs#azure.identity.ChainedTokenCredential
[cli_cred_ref]: https://aka.ms/azsdk/python/identity/docs#azure.identity.AzureCliCredential
[client_secret_cred_ref]: https://aka.ms/azsdk/python/identity/docs#azure.identity.ClientSecretCredential
[client_secret_cred_aio_ref]: https://aka.ms/azsdk/python/identity/aio/docs#azure.identity.aio.ClientSecretCredential
[default_cred_ref]: https://aka.ms/azsdk/python/identity/docs#azure.identity.DefaultAzureCredential
[device_code_cred_ref]: https://aka.ms/azsdk/python/identity/docs#azure.identity.DeviceCodeCredential
[environment_cred_ref]: https://aka.ms/azsdk/python/identity/docs#azure.identity.EnvironmentCredential
Expand Down

0 comments on commit d2cfea4

Please sign in to comment.