Update docs metadata
This commit is contained in:
azure-sdk
Родитель
b3513d02bc
Коммит
655a031500
|
|
@ -3,12 +3,12 @@ title: Azure Identity client library for Java
|
|||
keywords: Azure, java, SDK, API, azure-identity, identity
|
||||
author: g2vinay
|
||||
ms.author: vigera
|
||||
ms.date: 08/10/2023
|
||||
ms.date: 09/11/2023
|
||||
ms.topic: reference
|
||||
ms.devlang: java
|
||||
ms.service: identity
|
||||
---
|
||||
# Azure Identity client library for Java - version 1.10.0
|
||||
# Azure Identity client library for Java - version 1.10.1
|
||||
|
||||
|
||||
The Azure Identity library provides [Azure Active Directory (Azure AD)](https://learn.microsoft.com/azure/active-directory/fundamentals/active-directory-whatis) token authentication support across the Azure SDK. It provides a set of [TokenCredential](https://learn.microsoft.com/java/api/com.azure.core.credential.tokencredential?view=azure-java-stable) implementations that can be used to construct Azure SDK clients that support Azure AD token authentication.
|
||||
|
|
@ -21,7 +21,7 @@ The Azure Identity library provides [Azure Active Directory (Azure AD)](https://
|
|||
|
||||
#### Include the BOM file
|
||||
|
||||
Include the `azure-sdk-bom` in your project to take a dependency on the stable version of the library. In the following snippet, replace the `{bom_version_to_target}` placeholder with the version number. To learn more about the BOM, see the [Azure SDK BOM README](https://github.com/Azure/azure-sdk-for-java/blob/azure-identity_1.10.0/sdk/boms/azure-sdk-bom/README.md).
|
||||
Include the `azure-sdk-bom` in your project to take a dependency on the stable version of the library. In the following snippet, replace the `{bom_version_to_target}` placeholder with the version number. To learn more about the BOM, see the [Azure SDK BOM README](https://github.com/Azure/azure-sdk-for-java/blob/azure-identity_1.10.1/sdk/boms/azure-sdk-bom/README.md).
|
||||
|
||||
```xml
|
||||
<dependencyManagement>
|
||||
|
|
@ -107,6 +107,12 @@ The `DefaultAzureCredential` will attempt to authenticate via the following mech
|
|||
6. **Azure CLI** - If the developer has authenticated an account via the Azure CLI `az login` command, the `DefaultAzureCredential` will authenticate with that account.
|
||||
7. **Azure PowerShell** - If the developer has authenticated an account via the Azure PowerShell `Connect-AzAccount` command, the `DefaultAzureCredential` will authenticate with that account.
|
||||
|
||||
#### Continuation policy
|
||||
|
||||
As of v1.10.0, `DefaultAzureCredential` will attempt to authenticate with all developer credentials until one succeeds, regardless of any errors previous developer credentials experienced. For example, a developer credential may attempt to get a token and fail, so `DefaultAzureCredential` will continue to the next credential in the flow. Deployed service credentials will stop the flow with a thrown exception if they're able to attempt token retrieval, but don't receive one.
|
||||
|
||||
This allows for trying all of the developer credentials on your machine while having predictable deployed behavior.
|
||||
|
||||
#### Note about `VisualStudioCodeCredential`
|
||||
|
||||
Due to a [known issue](https://github.com/Azure/azure-sdk-for-java/issues/27364), `VisualStudioCodeCredential` has been removed from the `DefaultAzureCredential` token chain. When the issue is resolved in a future release, this change will be reverted.
|
||||
|
|
@ -202,7 +208,7 @@ The [Managed identity authentication](https://learn.microsoft.com/azure/active-d
|
|||
- [Azure Virtual Machines](https://learn.microsoft.com/azure/active-directory/managed-identities-azure-resources/how-to-use-vm-token)
|
||||
- [Azure Virtual Machines Scale Sets](https://learn.microsoft.com/azure/active-directory/managed-identities-azure-resources/qs-configure-powershell-windows-vmss)
|
||||
|
||||
**Note:** Use `azure-identity` version `1.7.0` or later to utilize [token caching](https://github.com/Azure/azure-sdk-for-java/blob/azure-identity_1.10.0/sdk/identity/azure-identity/TOKEN_CACHING.md) support for managed identity authentication.
|
||||
**Note:** Use `azure-identity` version `1.7.0` or later to utilize [token caching](https://github.com/Azure/azure-sdk-for-java/blob/azure-identity_1.10.1/sdk/identity/azure-identity/TOKEN_CACHING.md) support for managed identity authentication.
|
||||
|
||||
### Examples
|
||||
|
||||
|
|
@ -543,13 +549,17 @@ Credentials can be chained together to be tried in turn until one succeeds using
|
|||
|
||||
Configuration is attempted in the above order. For example, if values for a client secret and certificate are both present, the client secret will be used.
|
||||
|
||||
## Continuous Access Evaluation
|
||||
|
||||
As of v1.10.0, accessing resources protected by [Continuous Access Evaluation](https://learn.microsoft.com/azure/active-directory/conditional-access/concept-continuous-access-evaluation) (CAE) is possible on a per-request basis. This can be enabled using the [`TokenRequestContext.setCaeEnabled(boolean)` API](https://learn.microsoft.com/java/api/com.azure.core.credential.tokenrequestcontext?view=azure-java-stable#com-azure-core-credential-tokenrequestcontext-setcaeenabled(boolean)). CAE isn't supported for developer credentials.
|
||||
|
||||
## Token caching
|
||||
Token caching is a feature provided by the Azure Identity library that allows apps to:
|
||||
- Cache tokens in memory (default) or on disk (opt-in).
|
||||
- Improve resilience and performance.
|
||||
- Reduce the number of requests made to Azure AD to obtain access tokens.
|
||||
|
||||
The Azure Identity library offers both in-memory and persistent disk caching. For more details, see the [token caching documentation](https://github.com/Azure/azure-sdk-for-java/blob/azure-identity_1.10.0/sdk/identity/azure-identity/TOKEN_CACHING.md).
|
||||
The Azure Identity library offers both in-memory and persistent disk caching. For more details, see the [token caching documentation](https://github.com/Azure/azure-sdk-for-java/blob/azure-identity_1.10.1/sdk/identity/azure-identity/TOKEN_CACHING.md).
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
|
|
@ -557,7 +567,7 @@ Credentials raise exceptions when they fail to authenticate or can't execute aut
|
|||
|
||||
When credentials can't execute authentication due to one of the underlying resources required by the credential being unavailable on the machine, the`CredentialUnavailableException` is raised. The exception has a `message` attribute that describes why the credential is unavailable for authentication execution. When this exception is raised by `ChainedTokenCredential`, the message collects error messages from each credential in the chain.
|
||||
|
||||
See the [troubleshooting guide](https://github.com/Azure/azure-sdk-for-java/blob/azure-identity_1.10.0/sdk/identity/azure-identity/TROUBLESHOOTING.md) for details on how to diagnose various failure scenarios.
|
||||
See the [troubleshooting guide](https://github.com/Azure/azure-sdk-for-java/blob/azure-identity_1.10.1/sdk/identity/azure-identity/TROUBLESHOOTING.md) for details on how to diagnose various failure scenarios.
|
||||
|
||||
## Next steps
|
||||
|
||||
|
|
@ -574,15 +584,15 @@ When you submit a pull request, a CLA-bot will automatically determine whether y
|
|||
This project has adopted the [Microsoft Open Source Code of Conduct][code_of_conduct]. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
|
||||
|
||||
<!-- LINKS -->
|
||||
[azure_core_library]: https://github.com/Azure/azure-sdk-for-java/tree/azure-identity_1.10.0/sdk/core
|
||||
[azure_core_library]: https://github.com/Azure/azure-sdk-for-java/tree/azure-identity_1.10.1/sdk/core
|
||||
[azure_sub]: https://azure.microsoft.com/free/
|
||||
[azuread_doc]: https://learn.microsoft.com/azure/active-directory/
|
||||
[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/
|
||||
[javadoc]: https://learn.microsoft.com/java/api/com.azure.identity?view=azure-java-stable
|
||||
[jdk_link]: https://learn.microsoft.com/java/azure/jdk/?view=azure-java-stable
|
||||
[logging]: https://github.com/Azure/azure-sdk-for-java/wiki/Logging-with-Azure-SDK
|
||||
[secrets_client_library]: https://github.com/Azure/azure-sdk-for-java/tree/azure-identity_1.10.0/sdk/keyvault/azure-security-keyvault-secrets
|
||||
[source]: https://github.com/Azure/azure-sdk-for-java/tree/azure-identity_1.10.0/sdk/identity/azure-identity
|
||||
[secrets_client_library]: https://github.com/Azure/azure-sdk-for-java/tree/azure-identity_1.10.1/sdk/keyvault/azure-security-keyvault-secrets
|
||||
[source]: https://github.com/Azure/azure-sdk-for-java/tree/azure-identity_1.10.1/sdk/identity/azure-identity
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"Name": "azure-identity",
|
||||
"Version": "1.10.0",
|
||||
"Version": "1.10.1",
|
||||
"DevVersion": null,
|
||||
"DirectoryPath": "sdk/identity/azure-identity",
|
||||
"ServiceDirectory": "identity",
|
||||
|
|
@ -10,5 +10,5 @@
|
|||
"SdkType": "client",
|
||||
"IsNewSdk": true,
|
||||
"ArtifactName": "azure-identity",
|
||||
"ReleaseStatus": "2023-08-09"
|
||||
"ReleaseStatus": "2023-09-10"
|
||||
}
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче