Skip to content

Commit 4ac07c6

Browse files
Merge pull request #278777 from seesharprun/cosmos-emulator-windows-certificate-install
Cosmos DB | Resolve multiple issues with emulator instructions
2 parents b5bb5f3 + 34473f7 commit 4ac07c6

File tree

4 files changed

+165
-53
lines changed

4 files changed

+165
-53
lines changed

articles/cosmos-db/emulator-release-notes.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ titleSuffix: Azure Cosmos DB
44
description: View the release notes for the latest version and previous versions of the Azure Cosmos DB Windows (local) emulator.
55
author: sajeetharan
66
ms.author: sasinnat
7-
ms.reviewer: sidandrews
7+
ms.reviewer: mjbrown
88
ms.service: cosmos-db
99
ms.topic: release-notes
10-
ms.date: 09/11/2023
10+
ms.date: 06/20/2024
1111
---
1212

1313
# Release notes for the Azure Cosmos DB Windows (local) emulator
@@ -38,11 +38,11 @@ Only the most recent version of the Azure Cosmos DB emulator is actively support
3838

3939
### ``2.14.16`` (January 24, 2024)
4040

41-
- This release fixes an issue which was causing emulator to bind with `loopback` instead of `public interface` even after passing /AllowNetworkAccess command line option.
41+
- This release fixes an issue, which was causing emulator to bind with `loopback` instead of `public interface` even after passing /AllowNetworkAccess command line option.
4242

4343
### ``2.14.12`` (March 20, 2023)
4444

45-
- This release fixes an issue impacting Gremlin and Table endpoint API types. Prior to this fix a client application fails with a 500 status code when trying to connect to the public emulator's endpoint.
45+
- This release fixes an issue impacting Gremlin and Table endpoint API types. Before this fix, client applications failed with a 500 status code when trying to connect to the public emulator's endpoint.
4646

4747
### ``2.14.11`` (January 27, 2023)
4848

@@ -60,13 +60,13 @@ Only the most recent version of the Azure Cosmos DB emulator is actively support
6060

6161
- This release updates the Azure Cosmos DB Emulator background services to match the latest online functionality of the Azure Cosmos DB. In addition to this update, there are a couple of issues addressed in this release:
6262
- Update Data Explorer to the latest content and fix a broken link for the quick start sample documentation.
63-
- Add option to enable the API for MongoDB and configure version for the Linux Azure Cosmos DB emulator by setting the environment variable: `AZURE_COSMOS_EMULATOR_ENABLE_MONGODB_ENDPOINT` in the Docker container. Valid settings are: ``3.2``, ``3.6``, ``4.0`` and ``4.2``
63+
- Add option to enable the API for MongoDB and configure version for the Linux Azure Cosmos DB emulator by setting the environment variable: `AZURE_COSMOS_EMULATOR_ENABLE_MONGODB_ENDPOINT` in the Docker container. Valid settings are: ``3.2``, ``3.6``, ``4.0``, and ``4.2``
6464

6565
### ``2.14.6`` (March 7, 2022)
6666

6767
- This release updates the Azure Cosmos DB Emulator background services to match the latest online functionality of the Azure Cosmos DB. In addition to this update, there are a couple of issues addressed in this release:
6868
- Fix for an issue related to high CPU usage when the emulator is running.
69-
- Add PowerShell option to set the API for MongoDB and version: `-MongoApiVersion`. Valid settings are: ``3.2``, ``3.6`` and ``4.0``
69+
- Add PowerShell option to set the API for MongoDB and version: `-MongoApiVersion`. Valid settings are: ``3.2``, ``3.6``, and ``4.0``
7070

7171
### ``2.14.5`` (January 18, 2022)
7272

@@ -78,7 +78,7 @@ Only the most recent version of the Azure Cosmos DB emulator is actively support
7878

7979
### ``2.14.3`` (September 8, 2021)
8080

81-
- This release updates the Azure Cosmos DB Emulator background services to match the latest online functionality of the Azure Cosmos DB. It also addresses issues with performance data that's collected and resets the base image for the Linux Azure Cosmos DB emulator Docker image.
81+
- This release updates the Azure Cosmos DB Emulator background services to match the latest online functionality of the Azure Cosmos DB. It also addresses issues with performance data and resets the base image for the Linux Azure Cosmos DB emulator Docker image.
8282

8383
### ``2.14.2`` (August 12, 2021)
8484

@@ -145,7 +145,7 @@ Only the most recent version of the Azure Cosmos DB emulator is actively support
145145

146146
### ``2.9.1``
147147

148-
- This release fixes couple issues in the query API support and restores compatibility with older OSs such as Windows Server 2012.
148+
- This release fixes couple issues in the query API support and restores compatibility with older operating systems such as Windows Server 2012.
149149

150150
### ``2.9.0``
151151

@@ -176,4 +176,4 @@ Only the most recent version of the Azure Cosmos DB emulator is actively support
176176
## Next steps
177177

178178
- [Learn more about the Azure Cosmos DB emulator](emulator.md)
179-
- [Get started using the Azure Comsos DB emulator for development](how-to-develop-emulator.md)
179+
- [Get started using the Azure Cosmos DB emulator for development](how-to-develop-emulator.md)

articles/cosmos-db/emulator-windows-arguments.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ titleSuffix: Azure Cosmos DB
44
description: Manage the Azure Cosmos DB emulator with the command line or PowerShell and change the configuration of the emulator.
55
author: sajeetharan
66
ms.author: sasinnat
7-
ms.reviewer: sidandrews
7+
ms.reviewer: mjbrown
88
ms.service: cosmos-db
99
ms.topic: reference
10-
ms.date: 09/11/2023
10+
ms.date: 06/20/2024
1111
---
1212

1313
# Command-line and PowerShell reference for Windows (local) emulator
@@ -58,7 +58,7 @@ To view the list of parameters, type `Microsoft.Azure.Cosmos.Emulator.exe /?` at
5858
| `StartWprTraces` | Start collecting debug trace logs using **Windows Performance Recording** tool. | `Microsoft.Azure.Cosmos.Emulator.exe /StartWprTraces` |
5959
| `StopWprTraces` | Stop collecting debug trace logs using **Windows Performance Recording** tool. | `Microsoft.Azure.Cosmos.Emulator.exe /StopWprTraces` |
6060
| `FailOnSslCertificateNameMismatch` | By default the emulator regenerates its self-signed TLS/SSL certificate, if the certificate's SAN doesn't include the emulator host's domain name, local IP address ([v4](https://wikipedia.org/wiki/Internet_Protocol_version_4)), `localhost`, and `127.0.0.1`. With this option, the emulator instead fails at startup. You should then use the `/GenCert` option to create and install a new self-signed TLS/SSL certificate. | `Microsoft.Azure.Cosmos.Emulator.exe /FailOnSslCertificateNameMismatch` |
61-
| `GenCert` | Generate and install a new self-signed TLS/SSL certificate. optionally including a comma-separated list of extra DNS names for accessing the emulator over the network. | `Microsoft.Azure.Cosmos.Emulator.exe /GenCert` |
61+
| `GenCert` | Generate and install a new self-signed TLS/SSL certificate. optionally including a comma-separated list of extra Domain Name System (DNS) names for accessing the emulator over the network. | `Microsoft.Azure.Cosmos.Emulator.exe /GenCert` |
6262
| `DirectPorts` | Specifies the ports to use for direct connectivity. Defaults are `10251`, `10252`, `10253`, and `10254`. | `Microsoft.Azure.Cosmos.Emulator.exe /DirectPorts:65600,65700` |
6363
| `Key` | Authorization key for the emulator. Key must be the base-64 encoding of a 64-byte vector. | `Microsoft.Azure.Cosmos.Emulator.exe /Key:D67PoU0bcK/kgPKFHu4W+3SUY9LNcwcFLIUHnwrkA==` |
6464
| `EnableRateLimiting` | Specifies that request rate limiting behavior is enabled. | `Microsoft.Azure.Cosmos.Emulator.exe /EnableRateLimiting` |
@@ -81,7 +81,7 @@ The emulator comes with a PowerShell module to start, stop, uninstall, and retri
8181
Import-Module "$env:ProgramFiles\Azure Cosmos DB Emulator\PSModules\Microsoft.Azure.CosmosDB.Emulator"
8282
```
8383

84-
or place the `PSModules` directory on your `PSModulePath` and import it as shown in the following command:
84+
Or place the `PSModules` directory on your `PSModulePath` and import it as shown in the following command:
8585

8686
```powershell
8787
$env:PSModulePath += ";$env:ProgramFiles\Azure Cosmos DB Emulator\PSModules"
@@ -185,7 +185,7 @@ Start-CosmosDbEmulator [-AllowNetworkAccess]
185185

186186
#### Examples
187187

188-
- Start the emulator and wait until it's fully started and ready to accept requests.
188+
- Start the emulator and wait until it's ready to accept requests.
189189

190190
```powershell
191191
Start-CosmosDbEmulator
@@ -271,9 +271,9 @@ Uninstall-CosmosDbEmulator @parameters
271271

272272
## Change the number of default containers
273273

274-
By default, you can create up to 25 fixed size containers (only supported using Azure Cosmos DB SDKs), or 5 unlimited containers using the emulator. By modifying the **PartitionCount** value, you can create up to 250 fixed size containers or 50 unlimited containers, or any combination of the two that doesn't exceed 250 fixed size containers (where one unlimited container = 5 fixed size containers). However it's not recommended to set up the emulator to run with more than 200 fixed size containers. Because of the overhead that it adds to the disk IO operations, which result in unpredictable timeouts when using the endpoint APIs.
274+
By default, you can create up to 25 fixed size containers (only supported using Azure Cosmos DB software development kits (SDKs)), or 5 unlimited containers using the emulator. By modifying the **PartitionCount** value, you can create up to 250 fixed size containers or 50 unlimited containers, or any combination of the two that doesn't exceed 250 fixed size containers (where one unlimited container = 5 fixed size containers). However we don't recommend that you set up the emulator to run with more than 200 fixed size containers. Because of the overhead that it adds to the disk IO operations, which result in unpredictable timeouts when using the endpoint APIs.
275275

276-
If you attempt to create a container after the current partition count has been exceeded, the emulator throws a ServiceUnavailable exception, with the following message.
276+
If you attempt to create a container after the current partition count is exceeded, the emulator throws a ServiceUnavailable exception, with the following message.
277277

278278
```output
279279
Sorry, we are currently experiencing high demand in this region, and cannot fulfill your request at this time. We work continuously to bring more and more capacity online, and encourage you to try again.
@@ -286,7 +286,7 @@ To change the number of containers available in the emulator, run the following
286286

287287
1. Delete all emulator data in this folder `%LOCALAPPDATA%\CosmosDBEmulator`.
288288

289-
1. Exit all open instances by right-clicking the **emulator** icon on the system tray, and then clicking **Exit**. It may take a minute for all instances to exit.
289+
1. Exit all open instances by right-clicking the **emulator** icon on the system tray, and then clicking **Exit**. It might take a minute for all instances to exit.
290290

291291
1. Install the latest version of the [emulator](https://cosmosdbportalstorage.azureedge.net/emulator/2023_01_30_2.14.11-dfad83c1/azure-cosmosdb-emulator-2.14.11-dfad83c1.msi).
292292

articles/cosmos-db/emulator.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ titleSuffix: Azure Cosmos DB
44
description: Use the Azure Cosmos DB local or docker-based emulator to test your applications against multiple API endpoints.
55
author: sajeetharan
66
ms.author: sasinnat
7-
ms.reviewer: sidandrews
7+
ms.reviewer: mjbrown
88
ms.service: cosmos-db
9-
ms.topic: conceptual
10-
ms.date: 09/11/2023
9+
ms.topic: concept-article
10+
ms.date: 06/20/2024
1111
# CustomerIntent: As a developer, I want to use the Azure Cosmos DB emulator so that I can develop my application against a database during development.
1212
---
1313

@@ -29,7 +29,7 @@ The emulator provides an environment on your developer workspace that isn't capa
2929
- The emulator only supports **provisioned throughput**. The emulator doesn't support **serverless** throughput.
3030
- The emulator uses a well-known key when it starts. You can't regenerate the key for the running emulator. To use a different key, you must [start the emulator with the custom key specified](#authentication).
3131
- The emulator can't be replicated across geographical regions or multiple instances. Only a single running instance of the emulator is supported. The emulator can't be scaled out.
32-
- The emulator only supports up to 10 fixed-size containers at 400 RU/s or 5 unlimited-size containers.
32+
- The emulator ideally supports up to 10 fixed-size containers at 400 RU/s or 5 unlimited-size containers. Theoretically, you can create more containers, but you could experience performance degradation with the emulator.
3333
- The emulator only supports the [Session](consistency-levels.md#session-consistency) and [Strong](consistency-levels.md#strong-consistency) consistency levels. The emulator isn't a scalable service and doesn't actually implement the consistency levels. The emulator only flags the configured consistency level for testing purposes.
3434
- The emulator constraints the unique identifier of items to a size of **254** characters.
3535
- The emulator supports a maximum of five `JOIN` statements per query.

0 commit comments

Comments
 (0)