Merge pull request #225358 from TheovanKraay/cosmos-java-passwordless

American-Dipper · web-flow · commit 3f73a3cd2626 · 2023-02-02T15:42:05.000-08:00
passwordless cosmos java changes
diff --git a/articles/cosmos-db/nosql/quickstart-java.md b/articles/cosmos-db/nosql/quickstart-java.md
@@ -55,7 +55,7 @@ As items are inserted into an Azure Cosmos DB container, the database grows hori
 
 ## Create a database account
 
-Before you can create a document database, you need to create a API for NoSQL account with Azure Cosmos DB.
+Before you can create a document database, you need to create an API for NoSQL account with Azure Cosmos DB.
 
 [!INCLUDE [cosmos-db-create-dbaccount](../includes/cosmos-db-create-dbaccount.md)]
 
@@ -74,7 +74,7 @@ Before you can create a document database, you need to create a API for NoSQL ac
 
 ## Clone the sample application
 
-Now let's switch to working with code. Let's clone a API for NoSQL app from GitHub, set the connection string, and run it. You'll see how easy it is to work with data programmatically. 
+Now let's switch to working with code. Let's clone an API for NoSQL app from GitHub, set the connection string, and run it. You'll see how easy it is to work with data programmatically. 
 
 Run the following command to clone the sample repository. This command creates a copy of the sample app on your computer.
 
@@ -116,6 +116,36 @@ This step is optional. If you're interested in learning how the database resourc
 
     [!code-java[](~/azure-cosmosdb-java-v4-getting-started/src/main/java/com/azure/cosmos/sample/sync/SyncMain.java?name=QueryItems)]
 
+## Run the app
+
+Now go back to the Azure portal to get your connection string information and launch the app with your endpoint information. This enables your app to communicate with your hosted database.
+
+1. In the git terminal window, `cd` to the sample code folder.
+
+    ```bash
+    cd azure-cosmos-java-getting-started
+    ```
+
+2. In the git terminal window, use the following command to install the required Java packages.
+
+    ```bash
+    mvn package
+    ```
+
+3. In the git terminal window, use the following command to start the Java application (replace SYNCASYNCMODE with `sync` or `async` depending on which sample code you would like to run, replace YOUR_COSMOS_DB_HOSTNAME with the quoted URI value from the portal, and replace YOUR_COSMOS_DB_MASTER_KEY with the quoted primary key from portal)
+
+    ```bash
+    mvn exec:java@SYNCASYNCMODE -DACCOUNT_HOST=YOUR_COSMOS_DB_HOSTNAME -DACCOUNT_KEY=YOUR_COSMOS_DB_MASTER_KEY
+    ```
+
+    The terminal window displays a notification that the FamilyDB database was created. 
+    
+4. The app creates database with name `AzureSampleFamilyDB`
+5. The app creates container with name `FamilyContainer`
+6. The app will perform point reads using object IDs and partition key value (which is lastName in our sample). 
+7. The app will query items to retrieve all families with last name in ('Andersen', 'Wakefield', 'Johnson')
+8. The app doesn't delete the created resources. Return to the Azure portal to [clean up the resources](#clean-up-resources) from your account so you don't incur charges.
+
 # [Async API](#tab/async)
 
 ### Managing database resources using the asynchronous (async) API
@@ -146,8 +176,6 @@ This step is optional. If you're interested in learning how the database resourc
 
     [!code-java[](~/azure-cosmosdb-java-v4-getting-started/src/main/java/com/azure/cosmos/sample/async/AsyncMain.java?name=QueryItems)]
 
----
-
 ## Run the app
 
 Now go back to the Azure portal to get your connection string information and launch the app with your endpoint information. This enables your app to communicate with your hosted database.
@@ -178,8 +206,177 @@ Now go back to the Azure portal to get your connection string information and la
 6. The app will perform point reads using object IDs and partition key value (which is lastName in our sample). 
 7. The app will query items to retrieve all families with last name in ('Andersen', 'Wakefield', 'Johnson')
 
+8. The app doesn't delete the created resources. Return to the Azure portal to [clean up the resources](#clean-up-resources) from your account so you don't incur charges.
+
+[!INCLUDE [passwordless-overview](../../../includes/passwordless/passwordless-overview.md)]
+
+## [Passwordless Sync API](#tab/passwordlesssync)
+
+[!INCLUDE [java-default-azure-credential-overview](../../../includes/passwordless/java-default-azure-credential-overview.md)]
+
+[!INCLUDE [cosmos-nosql-create-assign-roles](../../../includes/passwordless/cosmos-nosql/cosmos-nosql-create-assign-roles.md)]
+
+## Authenticate using DefaultAzureCredential
+
+[!INCLUDE [default-azure-credential-sign-in](../../../includes/passwordless/default-azure-credential-sign-in.md)]
+
+You can authenticate to Cosmos DB for NoSQL using `DefaultAzureCredential` by adding the `azure-identity` [dependency](https://mvnrepository.com/artifact/com.azure/azure-identity) to your application. `DefaultAzureCredential` will automatically discover and use the account you signed-in with in the previous step.
+
+### Managing database resources using the synchronous (sync) API
+
+* `CosmosClient` initialization. The `CosmosClient` provides client-side logical representation for the Azure Cosmos DB database service. This client is used to configure and execute requests against the service.
+    
+    [!code-java[](~/azure-cosmosdb-java-v4-getting-started/src/main/java/com/azure/cosmos/sample/sync/SyncPasswordlessMain.java?name=CreatePasswordlessSyncClient)]
+
+* Use the [`az cosmosdb sql database create`](/cli/azure/cosmosdb/sql/database#az-cosmosdb-sql-database-create) and [`az cosmosdb sql container create`](/cli/azure/cosmosdb/sql/container#az-cosmosdb-sql-container-create) commands to create a Cosmos DB NoSQL database and container.
+
+    ```azurecli-interactive
+    # Create a SQL API database
+    az cosmosdb sql database create \
+        --account-name msdocs-cosmos-nosql \
+        --resource-group msdocs \
+        --name AzureSampleFamilyDB
+    ```
+    
+    ```azurecli-interactive
+    # Create a SQL API container
+    az cosmosdb sql container create \
+        --account-name msdocs-cosmos-nosql \
+        --resource-group msdocs \
+        --database-name AzureSampleFamilyDB \
+        --name FamilyContainer \
+        --partition-key-path '/lastName'
+    ```
+
+* Item creation by using the `createItem` method.
+
+    [!code-java[](~/azure-cosmosdb-java-v4-getting-started/src/main/java/com/azure/cosmos/sample/sync/SyncPasswordlessMain.java?name=CreateItem)]
+   
+* Point reads are performed using `readItem` method.
+
+    [!code-java[](~/azure-cosmosdb-java-v4-getting-started/src/main/java/com/azure/cosmos/sample/sync/SyncPasswordlessMain.java?name=ReadItem)]
+
+* SQL queries over JSON are performed using the `queryItems` method.
+
+    [!code-java[](~/azure-cosmosdb-java-v4-getting-started/src/main/java/com/azure/cosmos/sample/sync/SyncPasswordlessMain.java?name=QueryItems)]
+
+## Run the app
+
+Now go back to the Azure portal to get your connection string information and launch the app with your endpoint information. This enables your app to communicate with your hosted database.
+
+1. In the git terminal window, `cd` to the sample code folder.
+
+    ```bash
+    cd azure-cosmos-java-getting-started
+    ```
+
+2. In the git terminal window, use the following command to install the required Java packages.
+
+    ```bash
+    mvn package
+    ```
+
+3. In the git terminal window, use the following command to start the Java application. Replace `SYNCASYNCMODE` with `sync-passwordless` or `async-passwordless`, depending upon which sample code you'd like to run. Replace `YOUR_COSMOS_DB_HOSTNAME` with the quoted URI value from the portal, and replace `YOUR_COSMOS_DB_MASTER_KEY` with the quoted primary key from portal.
+
+    ```bash
+    mvn exec:java@SYNCASYNCMODE -DACCOUNT_HOST=YOUR_COSMOS_DB_HOSTNAME -DACCOUNT_KEY=YOUR_COSMOS_DB_MASTER_KEY
+    ```
+
+    The terminal window displays a notification that the FamilyDB database was created. 
+
+4. The app will reference the database and container you created via Azure CLI earlier. 
+    
+5. The app will perform point reads using object IDs and partition key value (which is lastName in our sample). 
+6. The app will query items to retrieve all families with last name in ('Andersen', 'Wakefield', 'Johnson')
+
 7. The app doesn't delete the created resources. Switch back to the portal to [clean up the resources](#clean-up-resources).  from your account so that you don't incur charges.
 
+## [Passwordless Aync API](#tab/passwordlessasync)
+
+[!INCLUDE [java-default-azure-credential-overview](../../../includes/passwordless/java-default-azure-credential-overview.md)]
+
+[!INCLUDE [cosmos-nosql-create-assign-roles](../../../includes/passwordless/cosmos-nosql/cosmos-nosql-create-assign-roles.md)]
+
+## Authenticate using DefaultAzureCredential
+
+[!INCLUDE [default-azure-credential-sign-in](../../../includes/passwordless/default-azure-credential-sign-in.md)]
+
+You can authenticate to Cosmos DB for NoSQL using `DefaultAzureCredential` by adding the `azure-identity` [dependency](https://mvnrepository.com/artifact/com.azure/azure-identity) to your application. `DefaultAzureCredential` will automatically discover and use the account you signed-in with in the previous step.
+
+### Managing database resources using the asynchronous (async) API
+
+* Async API calls return immediately, without waiting for a response from the server. In light of this, the following code snippets show proper design patterns for accomplishing all of the preceding management tasks using async API.
+
+* `CosmosAsyncClient` initialization. The `CosmosAsyncClient` provides client-side logical representation for the Azure Cosmos DB database service. This client is used to configure and execute asynchronous requests against the service.
+    
+    [!code-java[](~/azure-cosmosdb-java-v4-getting-started/src/main/java/com/azure/cosmos/sample/async/AsyncPasswordlessMain.java?name=CreatePasswordlessAsyncClient)]
+
+* Use the [`az cosmosdb sql database create`](/cli/azure/cosmosdb/sql/database#az-cosmosdb-sql-database-create) and [`az cosmosdb sql container create`](/cli/azure/cosmosdb/sql/container#az-cosmosdb-sql-container-create) commands to create a Cosmos DB NoSQL database and container.
+
+    ```azurecli-interactive
+    # Create a SQL API database
+    az cosmosdb sql database create \
+        --account-name msdocs-cosmos-nosql \
+        --resource-group msdocs \
+        --name AzureSampleFamilyDB
+    ```
+    
+    ```azurecli-interactive
+    # Create a SQL API container
+    az cosmosdb sql container create \
+        --account-name msdocs-cosmos-nosql \
+        --resource-group msdocs \
+        --database-name AzureSampleFamilyDB \
+        --name FamilyContainer \
+        --partition-key-path '/lastName'
+    ```
+
+* As with the sync API, item creation is accomplished using the `createItem` method. This example shows how to efficiently issue numerous async `createItem` requests by subscribing to a Reactive Stream which issues the requests and prints notifications. Since this simple example runs to completion and terminates, `CountDownLatch` instances are used to ensure the program does not terminate during item creation. **The proper asynchronous programming practice is not to block on async calls - in realistic use-cases requests are generated from a main() loop that executes indefinitely, eliminating the need to latch on async calls.**
+
+    [!code-java[](~/azure-cosmosdb-java-v4-getting-started/src/main/java/com/azure/cosmos/sample/async/AsyncPasswordlessMain.java?name=CreateItem)]
+   
+* As with the sync API, point reads are performed using `readItem` method.
+
+    [!code-java[](~/azure-cosmosdb-java-v4-getting-started/src/main/java/com/azure/cosmos/sample/async/AsyncPasswordlessMain.java?name=ReadItem)]
+
+* As with the sync API, SQL queries over JSON are performed using the `queryItems` method.
+
+    [!code-java[](~/azure-cosmosdb-java-v4-getting-started/src/main/java/com/azure/cosmos/sample/async/AsyncPasswordlessMain.java?name=QueryItems)]
+
+## Run the app
+
+Now go back to the Azure portal to get your connection string information and launch the app with your endpoint information. This enables your app to communicate with your hosted database.
+
+1. In the git terminal window, `cd` to the sample code folder.
+
+    ```bash
+    cd azure-cosmos-java-getting-started
+    ```
+
+2. In the git terminal window, use the following command to install the required Java packages.
+
+    ```bash
+    mvn package
+    ```
+
+3. In the git terminal window, use the following command to start the Java application (replace SYNCASYNCMODE with `sync-passwordless` or `async-passwordless` depending on which sample code you would like to run, replace YOUR_COSMOS_DB_HOSTNAME with the quoted URI value from the portal, and replace YOUR_COSMOS_DB_MASTER_KEY with the quoted primary key from portal)
+
+    ```bash
+    mvn exec:java@SYNCASYNCMODE -DACCOUNT_HOST=YOUR_COSMOS_DB_HOSTNAME -DACCOUNT_KEY=YOUR_COSMOS_DB_MASTER_KEY
+    ```
+
+    The terminal window displays a notification that the `AzureSampleFamilyDB` database was created. 
+
+4. The app will reference the database and container you created via Azure CLI earlier. 
+    
+5. The app will perform point reads using object IDs and partition key value (which is lastName in our sample). 
+6. The app will query items to retrieve all families with last name in ('Andersen', 'Wakefield', 'Johnson')
+
+7. The app doesn't delete the created resources. Switch back to the portal to [clean up the resources](#clean-up-resources).  from your account so that you don't incur charges.
+
+---
+
+
 ## Review SLAs in the Azure portal
 
 [!INCLUDE [cosmosdb-tutorial-review-slas](../includes/cosmos-db-tutorial-review-slas.md)]
diff --git a/includes/passwordless/java-default-azure-credential-overview.md b/includes/passwordless/java-default-azure-credential-overview.md
@@ -0,0 +1,15 @@
+---
+title: "include file"
+description: "include file"
+services: storage
+author: TheovanKraay
+ms.service: storage
+ms.topic: include
+ms.date: 01/27/2023
+ms.author: thvankra
+ms.custom: include file
+---
+
+`DefaultAzureCredential` is a class provided by the Azure Identity library for Java. To learn more about `DefaultAzureCredential`, see the [Azure authentication with Java and Azure Identity](/azure/developer/java/sdk/identity). `DefaultAzureCredential` supports multiple authentication methods and determines which method should be used at runtime. This approach enables your app to use different authentication methods in different environments (local vs. production) without implementing environment-specific code.
+
+For example, your app can authenticate using your Visual Studio sign-in credentials when developing locally, and then use a [managed identity](../../articles/active-directory/managed-identities-azure-resources/overview.md) once it has been deployed to Azure. No code changes are required for this transition.
