Skip to content

Commit 97cd5bc

Browse files
authored
Deprecate config methods for removed cache configuration. (#42437)
* Deprecate config methods for removed cache cnofiguration. In Identity 1.14 we removed support for very old versions of the Azure Toolkit for IntelliJ. These two methods configured the behavior of the old versions, and no longer do anything. * Update changelog to include PR link Fix readme to not point to deprecated method. * update changelog
1 parent 5e1a8d7 commit 97cd5bc

File tree

4 files changed

+8
-3
lines changed

4 files changed

+8
-3
lines changed

sdk/identity/azure-identity/CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
### Bugs Fixed
1010

1111
### Other Changes
12+
- `@Deprecated` methods `DefaultAzureCredential.setIntelliJKeePassDatabasePath` and `IntelliJCredentialBuilder.keePassDatabasePath`. [#42437](https://github.com/Azure/azure-sdk-for-java/pull/42437)
1213

1314
## 1.14.0 (2024-10-03)
1415

sdk/identity/azure-identity/README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -154,12 +154,10 @@ See more about how to configure your IntelliJ IDEA in [Sign in Azure Toolkit for
154154

155155
```java
156156
/**
157-
* DefaultAzureCredential uses the KeePass database path to find the user account in IntelliJ on Windows.
157+
* DefaultAzureCredential uses the signed-in user from Azure Toolkit for Java.
158158
*/
159159
public void createDefaultAzureCredentialForIntelliJ() {
160160
DefaultAzureCredential defaultCredential = new DefaultAzureCredentialBuilder()
161-
// KeePass configuration required only for Windows. No configuration needed for Linux / Mac
162-
.intelliJKeePassDatabasePath("C:\\Users\\user\\AppData\\Roaming\\JetBrains\\IdeaIC2020.1\\c.kdbx")
163161
.build();
164162

165163
// Azure SDK client builders accept the credential as a parameter

sdk/identity/azure-identity/src/main/java/com/azure/identity/DefaultAzureCredentialBuilder.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,10 @@ public DefaultAzureCredentialBuilder authorityHost(String authorityHost) {
108108
* @param databasePath the path to the KeePass database.
109109
* @throws IllegalArgumentException if {@code databasePath} is either not specified or is empty.
110110
* @return An updated instance of this builder with the KeePass database path set as specified.
111+
* @deprecated Support for older Azure Toolkit for IntelliJ versions was
112+
* <a href="https://aka.ms/azsdk/java/identity/intellij-credential-update">removed in 1.14.0.</a>
111113
*/
114+
@Deprecated
112115
public DefaultAzureCredentialBuilder intelliJKeePassDatabasePath(String databasePath) {
113116
if (CoreUtils.isNullOrEmpty(databasePath)) {
114117
throw LOGGER.logExceptionAsError(

sdk/identity/azure-identity/src/main/java/com/azure/identity/IntelliJCredentialBuilder.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,10 @@ public IntelliJCredentialBuilder tenantId(String tenantId) {
7676
* @param databasePath the path to the KeePass database.
7777
* @throws IllegalArgumentException if {@code databasePath} is either not specified or is empty.
7878
* @return An updated instance of this builder with the KeePass database path set as specified.
79+
* @deprecated Support for older Azure Toolkit for IntelliJ versions was
80+
* <a href="https://aka.ms/azsdk/java/identity/intellij-credential-update">removed in 1.14.0.</a>
7981
*/
82+
@Deprecated
8083
public IntelliJCredentialBuilder keePassDatabasePath(String databasePath) {
8184
if (CoreUtils.isNullOrEmpty(databasePath)) {
8285
throw LOGGER.logExceptionAsError(

0 commit comments

Comments
 (0)