From 1df4523417eca6f3acf574175fda97ad51cae1cc Mon Sep 17 00:00:00 2001 From: azure-sdk Date: Mon, 12 Feb 2024 18:51:52 +0000 Subject: [PATCH] Update docs metadata --- docs-ref-services/preview/identity-readme.md | 28 ++++++++++++-------- metadata/preview/azure-identity.json | 4 +-- 2 files changed, 19 insertions(+), 13 deletions(-) diff --git a/docs-ref-services/preview/identity-readme.md b/docs-ref-services/preview/identity-readme.md index 9431da9a2645..706f394b954b 100644 --- a/docs-ref-services/preview/identity-readme.md +++ b/docs-ref-services/preview/identity-readme.md @@ -1,12 +1,12 @@ --- title: Azure Identity client library for Java keywords: Azure, java, SDK, API, azure-identity, identity -ms.date: 10/27/2023 +ms.date: 02/12/2024 ms.topic: reference ms.devlang: java ms.service: identity --- -# Azure Identity client library for Java - version 1.11.0-beta.2 +# Azure Identity client library for Java - version 1.12.0-beta.1 The Azure Identity library provides [Microsoft Entra ID](https://learn.microsoft.com/azure/active-directory/fundamentals/active-directory-whatis) ([formerly Azure Active Directory](https://learn.microsoft.com/azure/active-directory/fundamentals/new-name)) 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 Microsoft Entra token authentication. @@ -19,7 +19,7 @@ The Azure Identity library provides [Microsoft Entra ID](https://learn.microsoft #### 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.11.0-beta.2/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.12.0-beta.1/sdk/boms/azure-sdk-bom/README.md). ```xml @@ -55,7 +55,7 @@ To take dependency on a particular version of the library that isn't present in com.azure azure-identity - 1.10.4 + 1.11.2 ``` [//]: # ({x-version-update-end}) @@ -206,7 +206,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.11.0-beta.2/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.12.0-beta.1/sdk/identity/azure-identity/TOKEN_CACHING.md) support for managed identity authentication. ### Examples @@ -557,7 +557,11 @@ Token caching is a feature provided by the Azure Identity library that allows ap - Improve resilience and performance. - Reduce the number of requests made to Microsoft Entra ID 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.11.0-beta.2/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.12.0-beta.1/sdk/identity/azure-identity/TOKEN_CACHING.md). + +## Brokered authentication + +An authentication broker is an application that runs on a user’s machine and manages the authentication handshakes and token maintenance for connected accounts. Currently, only the Windows Web Account Manager (WAM) is supported. To enable support, use the [`azure-identity-broker`][azure_identity_broker] package. For details on authenticating using WAM, see the [broker plugin documentation][azure_identity_broker_readme]. ## Troubleshooting @@ -565,7 +569,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.11.0-beta.2/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.12.0-beta.1/sdk/identity/azure-identity/TROUBLESHOOTING.md) for details on how to diagnose various failure scenarios. ## Next steps @@ -582,15 +586,17 @@ 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. -[azure_core_library]: https://github.com/Azure/azure-sdk-for-java/tree/azure-identity_1.11.0-beta.2/sdk/core +[azure_core_library]: https://github.com/Azure/azure-sdk-for-java/tree/azure-identity_1.12.0-beta.1/sdk/core +[azure_identity_broker]: https://central.sonatype.com/artifact/com.azure/azure-identity-broker +[azure_identity_broker_readme]: https://github.com/Azure/azure-sdk-for-java/blob/azure-identity_1.12.0-beta.1/sdk/identity/azure-identity-broker/README.md [azure_sub]: https://azure.microsoft.com/free/ [code_of_conduct]: https://opensource.microsoft.com/codeofconduct/ -[entraid_doc]: https://learn.microsoft.com/azure/active-directory/ +[entraid_doc]: https://learn.microsoft.com/entra/identity/ [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.11.0-beta.2/sdk/keyvault/azure-security-keyvault-secrets -[source]: https://github.com/Azure/azure-sdk-for-java/tree/azure-identity_1.11.0-beta.2/sdk/identity/azure-identity +[secrets_client_library]: https://github.com/Azure/azure-sdk-for-java/tree/azure-identity_1.12.0-beta.1/sdk/keyvault/azure-security-keyvault-secrets +[source]: https://github.com/Azure/azure-sdk-for-java/tree/azure-identity_1.12.0-beta.1/sdk/identity/azure-identity ![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-java%2Fsdk%2Fidentity%2Fazure-identity%2FREADME.png) diff --git a/metadata/preview/azure-identity.json b/metadata/preview/azure-identity.json index 2369f4aa4973..488abf06be29 100644 --- a/metadata/preview/azure-identity.json +++ b/metadata/preview/azure-identity.json @@ -1,6 +1,6 @@ { "Name": "azure-identity", - "Version": "1.11.0-beta.2", + "Version": "1.12.0-beta.1", "DevVersion": null, "DirectoryPath": "sdk/identity/azure-identity", "ServiceDirectory": "identity", @@ -10,5 +10,5 @@ "SdkType": "client", "IsNewSdk": true, "ArtifactName": "azure-identity", - "ReleaseStatus": "2023-10-27" + "ReleaseStatus": "2024-02-12" }