Add passwordless to Use Java and JDBC with Azure SQL Database #8829

bbenz · 2023-04-08T03:41:48Z

No description provided.

prmerger-automator · 2023-04-08T03:41:54Z

@bbenz : Thanks for your contribution! The author(s) have been notified to review your proposed change.

learn-build-service-prod · 2023-04-08T03:53:38Z

Learn Build status updates of commit 9f01a70:

✅ Validation status: passed

File	Status	Preview URL	Details
azure-sql/database/connect-query-java.md	✅Succeeded

For more details, please refer to the build report.

For any questions, please:

Try searching the learn.microsoft.com contributor guides
Post your question in the Learn support channel

scottaddie

Please also add passwordless-java to ms.custom. This metadata will help us take inventory of passwordless content for Java.

scottaddie · 2023-04-08T14:57:25Z

azure-sql/database/connect-query-java.md

+Create a *src/main/resources/application.properties* file, and add:
+
+```properties
+String url = "jdbc:sqlserver://$AZ_DATABASE_SERVER_NAME.database.windows.net:1433;databaseName=$AZ_DATABASE_NAME;authentication=ActiveDirectoryMSI;"   


Instead of ActiveDirectoryMSI, let's use the DefaultAzureCredential support that was added in this PR: microsoft/mssql-jdbc#1936. It should just involve replacing authentication=ActiveDirectoryMSI; with authentication=DefaultAzureCredential;. This will be important because managed identity isn't a thing in the local dev scenario. DefaultAzureCredential takes care of that local dev experience, while offering managed identity support when deployed to Azure.

@David-Engel Is the JDBC driver's DefaultAzureCredential support documented anywhere on learn.microsoft.com?

Thanks, I based my approach on this doc, which will likely have to be updated as well: https://learn.microsoft.com/en-us/azure/developer/java/spring-framework/migrate-sql-database-to-passwordless-connection?tabs=java%2Capp-service%2Cassign-role-service-connector

Instead of ActiveDirectoryMSI, let's use the DefaultAzureCredential support that was added in this PR: microsoft/mssql-jdbc#1936. It should just involve replacing authentication=ActiveDirectoryMSI; with authentication=DefaultAzureCredential;. This will be important because managed identity isn't a thing in the local dev scenario. DefaultAzureCredential takes care of that local dev experience, while offering managed identity support when deployed to Azure.

@David-Engel David Engel (Simba Technologies Inc) Vendor Is the JDBC driver's DefaultAzureCredential support documented anywhere on learn.microsoft.com?

@scottaddie Yes. The option is authentication=ActiveDirectoryDefault. The value was changed from DefaultAzureCredential before GA to be consistent with other drivers: microsoft/mssql-jdbc#2055

Public docs:
https://learn.microsoft.com/en-us/sql/connect/jdbc/connecting-using-azure-active-directory-authentication?view=sql-server-ver16#connect-using-activedirectorydefault-authentication-mode

Hi folks, this is going to take more time than I have to invest this week while on vacation, I'll have to pick it up when I'm back from vacation next week.
@David-Engel, I have created a POC repo with the code at https://github.com/bbenz/azure-sql-passwordless-poc. If you or anyone on your team could work with that code to figure out what the complete solution should be in this exact situation (dependencies to include and the correct connection string), it would be greatly appreciated, and your expertise with the latest options will likely result in many fewer iterations to get to the finish line. All that is needed is to add the correct connection string in the resources/application.properties file and work out what dependencies to include in the pom.xml, the rest of the code is assembled and verified to be able to build successfully. Once that's done I can update the docs with the final (likely small) changes, or feel free to submit an additional pr.

Ping @David-Engel. Can you please take a look at this for Brian?

scottaddie · 2023-04-08T15:02:54Z

azure-sql/database/connect-query-java.md

        </dependency>
+       <dependency>
+            <groupId>com.azure</groupId>
+            <artifactId>azure-identity</artifactId>


I don't think you'll need a dependency on azure-identity. The JDBC driver should give you what you need. See my other comment about using the DefaultAzureCredential support.

The JDBC driver only has an optional dependency on azure-identity. If an application wants to use JDBC driver features that require it, they do have to add the dependency to their application. There is a long dependency chain we didn't want to bring in to all consumers who aren't using Azure.

learn-build-service-prod · 2023-04-10T04:44:03Z

Learn Build status updates of commit 057a5ef:

✅ Validation status: passed

File	Status	Preview URL	Details
azure-sql/database/connect-query-java.md	✅Succeeded

For more details, please refer to the build report.

For any questions, please:

Try searching the learn.microsoft.com contributor guides
Post your question in the Learn support channel

ShannonLeavitt · 2023-04-10T15:07:58Z

@jdubois

IMPORTANT: When the changes are ready for publication, add a #sign-off comment to signal that the PR is ready for the review team to merge.

#label:"aq-pr-triaged"
@MicrosoftDocs/public-repo-pr-review-team

jdubois · 2023-04-11T06:14:06Z

OK, @scottaddie and @bbenz I see the review is OK but there are still pending comments, please ping me when this is OK on your side and I will sign off

David-Engel

My suggested changes should get your demo app running. With them, I was able to run the mvn command to the point that is was only erroring because I didn't have my DB/environment configured for any of the ActiveDirectoryDefault authentication options. (SQL auth worked fine.)

Not mentioned in this article, but understood by Java/Maven devs:

mvn should be in your PATH
JAVA_HOME should be defined

David-Engel · 2023-04-24T20:55:08Z

azure-sql/database/connect-query-java.md

+Create a *src/main/resources/application.properties* file, and add:
+
+```properties
+String url = "jdbc:sqlserver://$AZ_DATABASE_SERVER_NAME.database.windows.net:1433;databaseName=$AZ_DATABASE_NAME;authentication=ActiveDirectoryMSI;"   


Suggested change

String url = "jdbc:sqlserver://$AZ_DATABASE_SERVER_NAME.database.windows.net:1433;databaseName=$AZ_DATABASE_NAME;authentication=ActiveDirectoryMSI;"

url=jdbc:sqlserver://$AZ_DATABASE_SERVER_NAME.database.windows.net:1433;databaseName=$AZ_DATABASE_NAME;authentication=ActiveDirectoryDefault;

David-Engel · 2023-04-24T20:55:20Z

azure-sql/database/connect-query-java.md

+
+```properties
+String url = "jdbc:sqlserver://$AZ_DATABASE_SERVER_NAME.database.windows.net:1433;databaseName=$AZ_DATABASE_NAME;authentication=ActiveDirectoryMSI;"   
+Connection con = DriverManager.getConnection(url);


Suggested change

Connection con = DriverManager.getConnection(url);

David-Engel · 2023-04-24T20:55:39Z

azure-sql/database/connect-query-java.md

@@ -174,7 +274,7 @@ CREATE TABLE todo (id INT PRIMARY KEY, description VARCHAR(255), details VARCHAR

 Next, add the Java code that will use JDBC to store and retrieve data from your Azure SQL database.

-Create a *src/main/java/DemoApplication.java* file, that contains:
+Create a *src/main/java/com/example/demo/DemoApplication.java* file, that contains:


Suggested change

Create a *src/main/java/com/example/demo/DemoApplication.java* file, that contains:

Create a *src/main/com/example/demo/DemoApplication.java* file, that contains:

David-Engel · 2023-04-26T17:28:50Z

A more general comment: This PR should be against the main branch of the private docs repo. If you don't have access, you can join here.

bbenz · 2023-05-02T16:55:56Z

Closing this PR and resubmitting via sql-docs-pr to comply with the publishing process.

scottaddie · 2023-05-02T23:28:20Z

@bbenz Please link the new PR to this one after you open it. That way, we have a nice audit trail of feedback.

bbenz added 2 commits April 7, 2023 20:33

Passwordless update - JDBC with Azure SQL Database

7307765

fix typos

9f01a70

prmerger-automator bot added the do-not-merge label Apr 8, 2023

prmerger-automator bot requested a review from jdubois April 8, 2023 03:41

prmerger-automator bot assigned jdubois Apr 8, 2023

prmerger-automator bot added Change sent to author sql-database/svc development/subsvc labels Apr 8, 2023

scottaddie reviewed Apr 8, 2023

View reviewed changes

Additional small changes

057a5ef

prmerger-automator bot added the aq-pr-triaged tracking label for the PR review team label Apr 10, 2023

David-Engel reviewed Apr 24, 2023

View reviewed changes

bbenz closed this May 2, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add passwordless to Use Java and JDBC with Azure SQL Database #8829

Add passwordless to Use Java and JDBC with Azure SQL Database #8829

bbenz commented Apr 8, 2023

prmerger-automator bot commented Apr 8, 2023

learn-build-service-prod bot commented Apr 8, 2023

scottaddie left a comment

scottaddie Apr 8, 2023

bbenz Apr 9, 2023

David-Engel Apr 11, 2023

bbenz Apr 12, 2023

scottaddie Apr 21, 2023

scottaddie Apr 8, 2023

David-Engel Apr 11, 2023

learn-build-service-prod bot commented Apr 10, 2023

ShannonLeavitt commented Apr 10, 2023

jdubois commented Apr 11, 2023

David-Engel left a comment •

edited

Loading

David-Engel Apr 24, 2023

David-Engel Apr 24, 2023

David-Engel Apr 24, 2023

David-Engel commented Apr 26, 2023 •

edited

Loading

bbenz commented May 2, 2023

scottaddie commented May 2, 2023

	String url = "jdbc:sqlserver://$AZ_DATABASE_SERVER_NAME.database.windows.net:1433;databaseName=$AZ_DATABASE_NAME;authentication=ActiveDirectoryMSI;"
	url=jdbc:sqlserver://$AZ_DATABASE_SERVER_NAME.database.windows.net:1433;databaseName=$AZ_DATABASE_NAME;authentication=ActiveDirectoryDefault;

	Create a src/main/java/com/example/demo/DemoApplication.java file, that contains:
	Create a src/main/com/example/demo/DemoApplication.java file, that contains:

Add passwordless to Use Java and JDBC with Azure SQL Database #8829

Add passwordless to Use Java and JDBC with Azure SQL Database #8829

Conversation

bbenz commented Apr 8, 2023

prmerger-automator bot commented Apr 8, 2023

learn-build-service-prod bot commented Apr 8, 2023

✅ Validation status: passed

scottaddie left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

learn-build-service-prod bot commented Apr 10, 2023

✅ Validation status: passed

ShannonLeavitt commented Apr 10, 2023

jdubois commented Apr 11, 2023

David-Engel left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

David-Engel commented Apr 26, 2023 • edited Loading

bbenz commented May 2, 2023

scottaddie commented May 2, 2023

David-Engel left a comment •

edited

Loading

David-Engel commented Apr 26, 2023 •

edited

Loading