Skip to content

Commit

Permalink
Merge pull request #20 from MicrosoftLearning/Dev-branch
Browse files Browse the repository at this point in the history
Replaced v-Core-based for vCore-based in the instructions
  • Loading branch information
MScalopez authored Apr 1, 2024
2 parents c6e5282 + 386ef31 commit b31bc98
Show file tree
Hide file tree
Showing 7 changed files with 85 additions and 85 deletions.
2 changes: 1 addition & 1 deletion Instructions/00-powershell-script.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ When a parameter is added to the script execution, the parameter performs severa
1. **Read and Parse the .env File**: If using an **.env** file, reads it and parses its content. By default, the script uses the **.env** file for configuration values, but this setting can be overridden by setting the *-useEnvFile* parameter to *False*.
1. **Conditional Resource Creation and Configuration**: Conditionally creates Azure resources and configures network rules.
1. **Resource Group Creation**: Creates a new resource group. By default, a Resource Group is created, but this setting can be skipped by setting the *-skipCreatingResourceGroup* parameter to *True*.
1. **Deployment and Configuration of Azure Cosmos DB resources**: Deploys v-Core-based Azure Cosmos DB for MongoDB resources. By default, a Cosmos DB cluster is created, but this setting can be skipped by setting the *-skipCreatingCosmosDBCluster* parameter to *True*.
1. **Deployment and Configuration of Azure Cosmos DB resources**: Deploys vCore-based Azure Cosmos DB for MongoDB resources. By default, a Cosmos DB cluster is created, but this setting can be skipped by setting the *-skipCreatingCosmosDBCluster* parameter to *True*.
1. **Deployment and Configuration of Azure OpenAI Resources**: Deploys Azure OpenAI models and setups. By default, an Azure OpenAI account, deployment, and completion deployment are created, but these settings can be skipped by setting the respective parameters to *True*.
1. **Update the .env File**: Updates the **.env** file with the latest configurations. Updating the **.env** file is done by default unless the parameter *-updateEnvFile* is set to *False*.
1. **Output Resource Information**: Outputs detailed information about the created or configured resources.
Expand Down
44 changes: 22 additions & 22 deletions Instructions/01-create-account.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
---
lab:
title: 'Create a v-Core-based Azure Cosmos DB for MongoDB account using the Azure portal'
module: 'Module 1 - Get Started with v-Core-based Azure Cosmos DB for MongoDB'
title: 'Create a vCore-based Azure Cosmos DB for MongoDB account using the Azure portal'
module: 'Module 1 - Get Started with vCore-based Azure Cosmos DB for MongoDB'
---

In this lab, we guide you through the process of creating a v-Core-based Azure Cosmos DB for MongoDB account using the Azure portal. We walk you through the steps of setting up the Cosmos DB account, configuring the necessary settings, and preparing it for use. The focus is on understanding the different configuration options and how they affect the behavior and performance of the Cosmos DB. By the end of this lab, you have a fully configured Cosmos DB for MongoDB ready for data storage and retrieval.
In this lab, we guide you through the process of creating a vCore-based Azure Cosmos DB for MongoDB account using the Azure portal. We walk you through the steps of setting up the Cosmos DB account, configuring the necessary settings, and preparing it for use. The focus is on understanding the different configuration options and how they affect the behavior and performance of the Cosmos DB. By the end of this lab, you have a fully configured Cosmos DB for MongoDB ready for data storage and retrieval.

### Objectives

- Understand the process of creating a new resource in Azure portal.
- Learn how to set up a v-Core-based Azure Cosmos DB for MongoDB account.
- Learn how to set up a vCore-based Azure Cosmos DB for MongoDB account.
- Familiarize with the different configuration options available during the setup.
- Understand the process of reviewing and finalizing the setup of the Cosmos DB account.
- Learn how to connect to the newly created Cosmos DB account using the Azure portal's Mongo Shell.

## Create your v-Core-based Azure Cosmos DB for MongoDB account
## Create your vCore-based Azure Cosmos DB for MongoDB account

Let's go ahead and learn how easy is to create your v-Core-based Azure Cosmos DB for MongoDB account using the Azure portal. To create this account, follow these steps:
Let's go ahead and learn how easy is to create your vCore-based Azure Cosmos DB for MongoDB account using the Azure portal. To create this account, follow these steps:

1. Sign in to the [Azure portal](https://portal.azure.com/).

Expand Down Expand Up @@ -64,47 +64,47 @@ Let's go ahead and learn how easy is to create your v-Core-based Azure Cosmos DB
| Firewall rules | Manually add all the IP ranges that you would like to grant access to your Cosmos DB account by selecting a *Rule Name*, a *Start IP address* and an *End IP address.* |

> [!NOTE]
> On a production environment, you would likely select **Private Access** for your *conectivity method* and use a *virtual network* and a *subnet* provided by your Azure network administrator. You will also most likely set private endpoints for access to the v-Core-based Azure Cosmos DB for MongoDB account.
> On a production environment, you would likely select **Private Access** for your *conectivity method* and use a *virtual network* and a *subnet* provided by your Azure network administrator. You will also most likely set private endpoints for access to the vCore-based Azure Cosmos DB for MongoDB account.
>
> Under the **Firewall rules** section is where you can add specific IP addresses that are allowed to access the Cosmos DB account. This is useful for restricting access to only specific IP addresses, such as your organization's IP addresses. You will notice there are two options: **+ Add current client IP address (your current public IP address)** and **+ Add 0.0.0.0 - 255.255.255.255**. The first option will add your current IP address to the list of allowed IP addresses, which could be benign if your public IP from your client never changes. The second option will allow you to add the range of ***ALL*** IP addresses in the internet. Be very careful of ever selecting that second option, since it opens your cluster to the whole internet.
1. Select on the **Review + create** button at the bottom.

1. In the **Review + create** tab, review your account settings, and then select the **Create** button.

It takes 5+ minutes for the v-Core-based Azure Cosmos DB for MongoDB account to be created. Once the account is created, you can use the Azure portal to access your account.
It takes 5+ minutes for the vCore-based Azure Cosmos DB for MongoDB account to be created. Once the account is created, you can use the Azure portal to access your account.

## Connect to your v-Core-based Azure Cosmos DB for MongoDB account using the Azure portal
## Connect to your vCore-based Azure Cosmos DB for MongoDB account using the Azure portal

Time to connect to your v-Core-based Azure Cosmos DB for MongoDB account using the Azure portal. To do connect to the account, follow these steps:
Time to connect to your vCore-based Azure Cosmos DB for MongoDB account using the Azure portal. To do connect to the account, follow these steps:

1. If you aren't signed in, sign in to the [Azure portal](https://portal.azure.com).

1. In the search bar at the top of the portal, type **Azure Cosmos DB** and select it from the search results.

1. In the **Azure Cosmos DB** window, select your newly created v-Core-based Azure Cosmos DB for MongoDB account.
1. In the **Azure Cosmos DB** window, select your newly created vCore-based Azure Cosmos DB for MongoDB account.

Let's get familiar with a couple of options available to you in the *Azure Cosmos DB for MongoDB (vCore)* window. You notice that there are several options available to you in the menu, including **Overview**, **Quit start**, **Networking**, **Connection string**, among others. For this lab, you focus on those four options you listed.

1. **Overview**: the Overview option provides you with a quick overview of your v-Core-based Azure Cosmos DB for MongoDB account. The overview includes the account's name, status, subscription, resource group, and location. This overview also includes the MongoDB version, admin username, cluster tier, shard count, disk size, connectivity method, and high availability. One interesting option available is to **Reset password**.
1. **Overview**: the Overview option provides you with a quick overview of your vCore-based Azure Cosmos DB for MongoDB account. The overview includes the account's name, status, subscription, resource group, and location. This overview also includes the MongoDB version, admin username, cluster tier, shard count, disk size, connectivity method, and high availability. One interesting option available is to **Reset password**.

1. **Reset password**: On the top of the overview page, select **Reset password**. You're prompted to enter a new password and to confirm it. This option is useful if you ever need to change the password for the admin user.

1. Unless you want to change the password, just select **X discard**. If you do change the password, make sure to update your records with the new password.

1. **Quick start**: You'll skip this one for now and revisit it in the next section of the lab.

1. **Networking**: This tab provides you with the options to configure the network settings for your v-Core-based Azure Cosmos DB for MongoDB account. This option includes the ability to add IP addresses to the firewall rules, private endpoint connections and allow public access from Azure services and resources within Azure to this cluster.
1. **Networking**: This tab provides you with the options to configure the network settings for your vCore-based Azure Cosmos DB for MongoDB account. This option includes the ability to add IP addresses to the firewall rules, private endpoint connections and allow public access from Azure services and resources within Azure to this cluster.

1. **Connection string**: This option should list the connection string your application needs to connect to this cluster. Remember that just knowing the connection string isn't enough to connect to the cluster. Remember that you also need to ensure that the IP address from where you're connecting is allowed in the firewall rules.

1. **Connection String**: Select on the **Copy** button to copy the connection string to your clipboard. You use this connection string to connect to your v-Core-based Azure Cosmos DB for MongoDB account.
1. **Connection String**: Select on the **Copy** button to copy the connection string to your clipboard. You use this connection string to connect to your vCore-based Azure Cosmos DB for MongoDB account.

1. Copy the connection string to your application's configuration file or to a secure location for later use in your application.

### Connect to your v-Core-based Azure Cosmos DB for MongoDB account using the Azure portal's Mongo Shell
### Connect to your vCore-based Azure Cosmos DB for MongoDB account using the Azure portal's Mongo Shell

Now that you have your v-Core-based Azure Cosmos DB for MongoDB account created, let's connect to it using the Azure portal's Mongo Shell. To connect, follow these steps:
Now that you have your vCore-based Azure Cosmos DB for MongoDB account created, let's connect to it using the Azure portal's Mongo Shell. To connect, follow these steps:

1. In the **Azure Cosmos DB for MongoDB (vCore)** window, select **Quick start**.

Expand All @@ -113,7 +113,7 @@ Now that you have your v-Core-based Azure Cosmos DB for MongoDB account created,
1. In the **Quick start** window, select **Launch quick start**. This option creates a sample database for you to test on. In a production environment, you would most likely not use the **Launch quick start** option, since you would be creating your own databases and collections.

1. Enter the password for the admin user you created when you created the v-Core-based Azure Cosmos DB for MongoDB account in the Mongo Shell window. Select **Next**.
1. Enter the password for the admin user you created when you created the vCore-based Azure Cosmos DB for MongoDB account in the Mongo Shell window. Select **Next**.

1. Select the **Create new database and collection** button. On the Mongo Shell screen, you notice that the MongoDB commands to create the new database and collection were run. Select **Next**.

Expand All @@ -125,7 +125,7 @@ Now that you have your v-Core-based Azure Cosmos DB for MongoDB account created,

1. In the **Quick start** window, select **Mongo Shell**.

1. Enter the password for the admin user you created when you created the v-Core-based Azure Cosmos DB for MongoDB account in the Mongo Shell window.
1. Enter the password for the admin user you created when you created the vCore-based Azure Cosmos DB for MongoDB account in the Mongo Shell window.

1. To test the connection, let's run some MongoDB commands. Run the following commands:

Expand Down Expand Up @@ -154,7 +154,7 @@ Now that you have your v-Core-based Azure Cosmos DB for MongoDB account created,
exit
```

You now have a fully configured v-Core-based Azure Cosmos DB for MongoDB account and you connected to it using the Azure portal's Mongo Shell. You're ready to start using it to store and retrieve data.
You now have a fully configured vCore-based Azure Cosmos DB for MongoDB account and you connected to it using the Azure portal's Mongo Shell. You're ready to start using it to store and retrieve data.

## Clean Up

Expand All @@ -164,14 +164,14 @@ After completing the lab exercises, it's important to clean up any resources you

1. **Delete Resource Group**: If you created a new resource group for this lab, navigate to *Resource groups*, find your group, and delete it. This action removes all the resources contained within it, including your Azure Cosmos DB instance.

1. **Manually Delete Individual Resources**: If you added resources to an existing resource group, you need to delete each resource individually. Navigate to the v-Core-based Azure Cosmos DB for MongoDB account and delete it.
1. **Manually Delete Individual Resources**: If you added resources to an existing resource group, you need to delete each resource individually. Navigate to the vCore-based Azure Cosmos DB for MongoDB account and delete it.

1. **Verify Deletion**: Confirm that the v-Core-based Azure Cosmos DB for MongoDB account resource you no longer need was successfully removed and is no longer listed in your Azure portal.
1. **Verify Deletion**: Confirm that the vCore-based Azure Cosmos DB for MongoDB account resource you no longer need was successfully removed and is no longer listed in your Azure portal.

1. **Review Billing**: Check your Azure billing section to ensure no unexpected charges are incurred, verifying that all unwanted resources were successfully deleted.

This cleanup process helps maintain your Azure account organized and free from unnecessary charges, ensuring you only pay for resources you actively use.

## Conclusion

This lab guided you through how to set up a v-Core-based Azure Cosmos DB for MongoDB account using the Azure portal. The lab showed you how to connect to the newly created v-Core-based Azure Cosmos DB for MongoDB account using the Azure portal's Mongo Shell. You learned how to configure the network settings for your v-Core-based Azure Cosmos DB for MongoDB account and how to retrieve the connection string for your application. You also learned how to reset the password for the admin user. You should now have a good understanding of the different configuration options available when setting up a v-Core-based Azure Cosmos DB for MongoDB account and how to connect to it using the Azure portal's Mongo Shell. In the next module, you'll learn how to migrate existing MongoDB databases to your v-Core-based Azure Cosmos DB for MongoDB account.
This lab guided you through how to set up a vCore-based Azure Cosmos DB for MongoDB account using the Azure portal. The lab showed you how to connect to the newly created vCore-based Azure Cosmos DB for MongoDB account using the Azure portal's Mongo Shell. You learned how to configure the network settings for your vCore-based Azure Cosmos DB for MongoDB account and how to retrieve the connection string for your application. You also learned how to reset the password for the admin user. You should now have a good understanding of the different configuration options available when setting up a vCore-based Azure Cosmos DB for MongoDB account and how to connect to it using the Azure portal's Mongo Shell. In the next module, you'll learn how to migrate existing MongoDB databases to your vCore-based Azure Cosmos DB for MongoDB account.
Loading

0 comments on commit b31bc98

Please sign in to comment.