-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Rename enableAzureTokenProxy -> enableAzureProxy #47747
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Rename enableAzureTokenProxy -> enableAzureProxy #47747
Conversation
API Change CheckAPIView identified API level changes in this PR and created the following API reviews |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR renames the enableAzureTokenProxy() method to enableAzureProxy() in the WorkloadIdentityCredentialBuilder class to align with naming conventions used across other Azure SDK languages. This is a breaking change that only affects code written against beta version 1.19.0-beta.1.
Changes:
- Renamed the
enableAzureTokenProxy()method toenableAzureProxy()in the builder class - Updated the internal field from
enableTokenProxytoenableAzureProxy - Updated all test references to use the new method name
- Documented the breaking change in CHANGELOG.md
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
sdk/identity/azure-identity/src/main/java/com/azure/identity/WorkloadIdentityCredentialBuilder.java |
Renamed method from enableAzureTokenProxy() to enableAzureProxy() and updated internal field name and JavaDoc |
sdk/identity/azure-identity/src/test/java/com/azure/identity/WorkloadIdentityCredentialTest.java |
Updated 11 test method calls to use the new enableAzureProxy() method |
sdk/identity/azure-identity/src/test/java/com/azure/identity/WorkloadIdentityCredentialIdentityBindingTest.java |
Updated 13 test method calls to use the new enableAzureProxy() method |
sdk/identity/azure-identity/CHANGELOG.md |
Added breaking change entry documenting the method rename for version 1.19.0-beta.2 |
|
@chlowell Is there anything related to identity bindings that's worth adding to the TSG section at https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/identity/azure-identity/TROUBLESHOOTING.md#troubleshoot-workloadidentitycredential-authentication-issues? |
|
Great question! We should document the errors devs can see when they try to use identity bindings without enabling the proxy mode: Azure/azure-sdk-for-go#25908 |
Description
The
WorkloadIdentityCredentialoption for enabling the Azure Kubernetes proxy feature has inconsistent naming across Azure SDK languages. This PR aligns the Java SDK with other languages by renaming the option from enableAzureTokenProxy to enableAzureProxy.