Identity azure pipelines service connection #40246

billwert · 2024-05-18T00:19:25Z

Description

Please add an informative description that covers that changes made by the pull request and link all relevant issues.

If an SDK is being regenerated based on a new swagger spec, a link to the pull request containing these swagger spec changes has been included above.

All SDK Contribution checklist:

The pull request does not introduce [breaking changes]
CHANGELOG is updated for new features, bug fixes or other significant changes.
I have read the contribution guidelines.

General Guidelines and Best Practices

Title of the pull request is clear and informative.
There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

Pull request includes test coverage for the included changes.

azure-sdk · 2024-05-18T00:27:31Z

API change check

APIView has identified API level changes in this PR and created following API reviews.

com.azure:azure-identity

billwert · 2024-05-18T01:15:03Z

/azp run java - identity - tests

azure-pipelines · 2024-05-18T01:15:09Z

No pipelines are associated with this pull request.

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

...dentity/azure-identity/src/main/java/com/azure/identity/AzurePipelinesCredentialBuilder.java

billwert · 2024-05-21T20:44:35Z

/azp run java - identity

azure-pipelines · 2024-05-21T20:45:57Z

Azure Pipelines successfully started running 1 pipeline(s).

billwert · 2024-05-21T23:40:10Z

/azp run java - identity

azure-pipelines · 2024-05-21T23:40:36Z

Azure Pipelines successfully started running 1 pipeline(s).

g2vinay · 2024-05-22T23:41:30Z

sdk/identity/azure-identity/TROUBLESHOOTING.md

@@ -283,6 +284,8 @@ Get-AzAccessToken -ResourceUrl "https://management.core.windows.net"
 |---|---|---|
 |`CredentialUnavailableException` raised with message. "IntelliJ Authentication not available. Please log in with Azure Tools for IntelliJ plugin in the IDE."| The Credential was not able to locate the cached token to use for authentication. | Ensure that you login on the Azure Tools for IntelliJ plugin, that will populate the cache for the credential to pick up.

+## Troubleshoot `AzurePipelinesCredential` authentication issues
+


is this meant to be empty ?

Yes, waiting on copy from @KarishmaGhiya.

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

...dentity/azure-identity/src/main/java/com/azure/identity/AzurePipelinesCredentialBuilder.java

billwert · 2024-05-22T23:59:28Z

sdk/identity/azure-identity/src/test/java/com/azure/identity/recorded/IdentityTestBase.java

@@ -62,7 +62,7 @@ HttpPipeline getHttpPipeline(HttpClient httpClient) {
 if (interceptorManager.isPlaybackMode()) {
 List<TestProxyRequestMatcher> customMatchers = new ArrayList<>();
 customMatchers.add(new BodilessMatcher());
- customMatchers.add(new CustomMatcher().setExcludedHeaders(Collections.singletonList("X-MRC-CV")));
+ customMatchers.add(new CustomMatcher().setExcludedHeaders(Arrays.asList("X-MRC-CV", "x-client-CPU")));


This actually snuck in from another PR; will remove it.

g2vinay · 2024-05-23T15:55:40Z

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

+ if (client == null) {
+ HttpClient.createDefault();
+ }
+ HttpPipeline pipeline = IdentityClientBase.setupPipeline(client, identityClientOptions);


We should refactor this to utilize/reuse a single instance of Pipeline from IdentityClientBase.
This is not consistent with the pattern of single pipeline instance per client with other SDKs.
One way, is to make this a Function<HttpPipeline, Supplier<String>>, apply the function in IdentityClient when assertion is needed to be passed to msal.

Will look at this in a refactor before GA.

g2vinay · 2024-05-23T18:30:06Z

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

+ }
+ HttpPipeline pipeline = IdentityClientBase.setupPipeline(client, identityClientOptions);
+ try {
+ URL url = new URL(requestUrl);


This is all impl logic, it can be moved to IdentityClientBase and accessed directly there with the pipeline instance in the client.

g2vinay · 2024-05-23T21:19:57Z

sdk/identity/azure-identity/CHANGELOG.md

@@ -3,6 +3,7 @@
 ## 1.13.0-beta.1 (Unreleased)

 ### Features Added
+- Added `AzurePipelinesCredential`


We can elaborate on what use case this credential solves as a one liner here.

billwert · 2024-05-23T21:23:35Z

/azp run java - identity

azure-pipelines · 2024-05-23T21:24:52Z

Azure Pipelines successfully started running 1 pipeline(s).

sdk/identity/azure-identity/CHANGELOG.md

scottaddie · 2024-05-23T21:45:04Z

@billwert Please also add a row for the new credential type to the top of this table: https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/identity/azure-identity/README.md#authenticate-service-principals

billwert · 2024-05-23T22:05:35Z

@billwert Please also add a row for the new credential type to the top of this table: https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/identity/azure-identity/README.md#authenticate-service-principals

done.

scottaddie · 2024-05-23T22:31:58Z

sdk/identity/azure-identity/CHANGELOG.md

@@ -3,6 +3,7 @@
 ## 1.13.0-beta.1 (Unreleased)

 ### Features Added
+- Added `AzurePipelinesCredential` to support [Microsoft Entra Workload ID](https://learn.microsoft.com/azure/devops/pipelines/library/service-endpoints?view=azure-devops&tabs=yaml).


You'll want to add something like "in Azure Pipelines service connections" at the end of this sentence.

sdk/identity/azure-identity/README.md

...dentity/azure-identity/src/main/java/com/azure/identity/AzurePipelinesCredentialBuilder.java

…zurePipelinesCredentialBuilder.java Co-authored-by: Scott Addie <[email protected]>

…/github.com/billwert/azure-sdk-for-java into identity-azure-pipelines-service-connection

billwert requested review from g2vinay, joshfree and a team as code owners May 18, 2024 00:19

billwert requested review from maorleger, pvaneck, KarishmaGhiya, scottaddie and xiangyan99 May 18, 2024 00:19

github-actions bot added the Azure.Identity label May 18, 2024

scottaddie reviewed May 20, 2024

View reviewed changes

g2vinay reviewed May 22, 2024

View reviewed changes

sdk/identity/azure-identity/src/main/java/com/azure/identity/AzurePipelinesCredential.java Show resolved Hide resolved

g2vinay reviewed May 22, 2024

View reviewed changes

...dentity/azure-identity/src/main/java/com/azure/identity/AzurePipelinesCredentialBuilder.java Show resolved Hide resolved

billwert commented May 22, 2024

View reviewed changes

g2vinay reviewed May 23, 2024

View reviewed changes

g2vinay approved these changes May 23, 2024

View reviewed changes

scottaddie reviewed May 23, 2024

View reviewed changes

sdk/identity/azure-identity/CHANGELOG.md Outdated Show resolved Hide resolved

billwert added 16 commits May 23, 2024 15:11

set a NONE context

9840a06

log an error

ee920c4

parse the response properly.

6b2c66e

fix test package version

3d5dbbd

update changelog

4d4ae59

Add error handling, samples, etc.

da79fc2

Checkstyle fixes

461c212

Remove extra code from another PR

120021e

Fix test to read SYSTEM_ACCESSTOKEN from the environment

4fa0ba9

Add @immutable

c6f666e

Add missing doc

5700e36

fix linter error

e3520a3

fix test

bdbe708

one more test fix

78581db

pr feedback

531c761

fixup version in pom

50c6f45

billwert force-pushed the identity-azure-pipelines-service-connection branch from d6bb253 to 50c6f45 Compare May 23, 2024 22:17

remove link to pass linkcheck, will add back for GA.

482381b

scottaddie reviewed May 23, 2024

View reviewed changes

sdk/identity/azure-identity/README.md Outdated Show resolved Hide resolved

scottaddie reviewed May 23, 2024

View reviewed changes

billwert and others added 6 commits May 23, 2024 15:35

fix link

4020feb

Update sdk/identity/azure-identity/src/main/java/com/azure/identity/A…

1bbf5a1

…zurePipelinesCredentialBuilder.java Co-authored-by: Scott Addie <[email protected]>

Update sdk/identity/azure-identity/src/main/java/com/azure/identity/A…

a1d6c00

…zurePipelinesCredentialBuilder.java Co-authored-by: Scott Addie <[email protected]>

Update sdk/identity/azure-identity/src/main/java/com/azure/identity/A…

fd7e9a2

…zurePipelinesCredentialBuilder.java Co-authored-by: Scott Addie <[email protected]>

fix readme

6453f78

Merge branch 'identity-azure-pipelines-service-connection' of https:/…

2fc0d7b

…/github.com/billwert/azure-sdk-for-java into identity-azure-pipelines-service-connection

billwert enabled auto-merge (squash) May 23, 2024 22:46

billwert merged commit ead0569 into Azure:main May 23, 2024
19 checks passed

billwert deleted the identity-azure-pipelines-service-connection branch May 24, 2024 00:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Identity azure pipelines service connection #40246

Identity azure pipelines service connection #40246

billwert commented May 18, 2024 •

edited by scottaddie

azure-sdk commented May 18, 2024

billwert commented May 18, 2024

azure-pipelines bot commented May 18, 2024

billwert commented May 21, 2024

azure-pipelines bot commented May 21, 2024

billwert commented May 21, 2024

azure-pipelines bot commented May 21, 2024

g2vinay May 22, 2024

billwert May 22, 2024

billwert May 22, 2024

g2vinay May 23, 2024 •

edited

billwert May 23, 2024

g2vinay May 23, 2024 •

edited

g2vinay May 23, 2024

billwert commented May 23, 2024

azure-pipelines bot commented May 23, 2024

scottaddie commented May 23, 2024

billwert commented May 23, 2024

scottaddie May 23, 2024

Identity azure pipelines service connection #40246

Identity azure pipelines service connection #40246

Conversation

billwert commented May 18, 2024 • edited by scottaddie

Description

All SDK Contribution checklist:

azure-sdk commented May 18, 2024

billwert commented May 18, 2024

azure-pipelines bot commented May 18, 2024

billwert commented May 21, 2024

azure-pipelines bot commented May 21, 2024

billwert commented May 21, 2024

azure-pipelines bot commented May 21, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

g2vinay May 23, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

g2vinay May 23, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

billwert commented May 23, 2024

azure-pipelines bot commented May 23, 2024

scottaddie commented May 23, 2024

billwert commented May 23, 2024

Choose a reason for hiding this comment

billwert commented May 18, 2024 •

edited by scottaddie

g2vinay May 23, 2024 •

edited

g2vinay May 23, 2024 •

edited