Download beer

Shared data: If you have Windows and Mac OS X applications that you must run concurrently (and they must access the same data with both Lion and Windows), an emulator is your only option. No need to reboot: With Boot Camp, you must reboot to run your MacBook under Windows. Software Windows emulators don’t need a reboot. Installation on Mac OS X is easy by using the Homebrew package installer. The WinTin Windows port is available as an installer. To run the client on Android or ChromeOS requires Termux, an Android terminal emulator and Linux environment that will also run on the Chromebook and Kindle Fire tablet. To run the client on the iPhone and iPad. How to Install Mac OS X on PC. If you want to install Mac on PC, you have two basic options how to do it: you can either install the Mac OS X operating system directly on a drive or use a Mac emulator for Windows. The former option gives you the best performance you can get, while the latter option is a lot simpler. Currently the Cosmos emulator can only be run on Windows. Users running Mac or Linux can run the emulator in a Windows virtual machine hosted in a hypervisor such as Parallels or VirtualBox. Below are the steps to enable this. Within the Windows VM run the command below and make note of the IPv4 address.

1. Windows Cmd Emulator Mac Free
2. Mac Os Emulator

The Azure Cosmos Emulator provides a local environment that emulates the Azure Cosmos DB service for development purposes. Using the Azure Cosmos Emulator, you can develop and test your application locally, without creating an Azure subscription or incurring any costs. When you're satisfied with how your application is working in the Azure Cosmos Emulator, you can switch to using an Azure Cosmos account in the cloud.

You can develop using Azure Cosmos Emulator with SQL, Cassandra, MongoDB, Gremlin, and Table API accounts. However at this time the Data Explorer view in the emulator fully supports clients for SQL API only.

How the emulator works

The Azure Cosmos Emulator provides a high-fidelity emulation of the Azure Cosmos DB service. It supports identical functionality as Azure Cosmos DB, including support for creating and querying data, provisioning and scaling containers, and executing stored procedures and triggers. You can develop and test applications using the Azure Cosmos Emulator, and deploy them to Azure at global scale by just making a single configuration change to the connection endpoint for Azure Cosmos DB.

While emulation of the Azure Cosmos DB service is faithful, the emulator's implementation is different than the service. For example, the emulator uses standard OS components such as the local file system for persistence, and the HTTPS protocol stack for connectivity. Functionality that relies on Azure infrastructure like global replication, single-digit millisecond latency for reads/writes, and tunable consistency levels are not applicable.

You can migrate data between the Azure Cosmos Emulator and the Azure Cosmos DB service by using the Azure Cosmos DB Data Migration Tool.

You can run Azure Cosmos Emulator on the Windows Docker container, see the Docker Hub for the docker pull command and GitHub for the Dockerfile and more information.

Differences between the emulator and the service

Because the Azure Cosmos Emulator provides an emulated environment running on the local developer workstation, there are some differences in functionality between the emulator and an Azure Cosmos account in the cloud:

• Currently Data Explorer in the emulator supports clients for SQL API. The Data Explorer view and operations for Azure Cosmos DB APIs such as MongoDB, Table, Graph, and Cassandra APIs are not fully supported.
• The Azure Cosmos Emulator supports only a single fixed account and a well-known master key. Key regeneration is not possible in the Azure Cosmos Emulator, however the default key can be changed using the command-line option.
• The Azure Cosmos Emulator supports an Azure Cosmos account in provisioned throughput mode; it currently doesn't support an Azure Cosmos account in serverless mode.
• The Azure Cosmos Emulator is not a scalable service and will not support a large number of containers.
• The Azure Cosmos Emulator does not offer different Azure Cosmos DB consistency levels.
• The Azure Cosmos Emulator does not offer multi-region replication.
• As your copy of the Azure Cosmos Emulator might not always be up-to-date with the most recent changes in the Azure Cosmos DB service, you should refer to the Azure Cosmos DB capacity planner to accurately estimate the production throughput (RUs) needs of your application.
• When using the Azure Cosmos Emulator, by default, you can create up to 25 fixed size containers (only supported using Azure Cosmos DB SDKs), or 5 unlimited containers using the Azure Cosmos Emulator. For more information about changing this value, see Setting the PartitionCount value.
• Emulator supports max ID property size of 254 characters.

System requirements

The Azure Cosmos Emulator has the following hardware and software requirements:

• Software requirements
  • Windows Server 2012 R2, Windows Server 2016, or Windows 10
  • 64-bit operating system
• Minimum Hardware requirements
  • 2-GB RAM
  • 10-GB available hard disk space

Installation

You can download and install the Azure Cosmos Emulator from the Microsoft Download Center or you can run the emulator on Docker for Windows. For instructions on using the emulator on Docker for Windows, see Running on Docker.

Note

To install, configure, and run the Azure Cosmos Emulator, you must have administrative privileges on the computer. The emulator will create/add a certificate and also set the firewall rules in order to run its services; therefore it's necessary for the emulator to be able to execute such operations.

Running on Windows

To start the Azure Cosmos Emulator, select the Start button or press the Windows key. Begin typing Azure Cosmos Emulator, and select the emulator from the list of applications.

When the emulator is running, you'll see an icon in the Windows taskbar notification area.

The Azure Cosmos Emulator by default runs on the local machine ('localhost') listening on port 8081.

The Azure Cosmos Emulator is installed to C:Program FilesAzure Cosmos DB Emulator by default. You can also start and stop the emulator from the command-line. For more information, see the command-line tool reference.

Start Data Explorer

When the Azure Cosmos Emulator launches, it automatically opens the Azure Cosmos Data Explorer in your browser. The address appears as https://localhost:8081/_explorer/index.html. If you close the explorer and would like to reopen it later, you can either open the URL in your browser or launch it from the Azure Cosmos Emulator in the Windows Tray Icon as shown below.

Checking for updates

Data Explorer indicates if there is a new update available for download.

Note

Data created in one version of the Azure Cosmos Emulator (see %LOCALAPPDATA%CosmosDBEmulator or data path optional settings) is not guaranteed to be accessible when using a different version. If you need to persist your data for the long term, it is recommended that you store that data in an Azure Cosmos account, rather than in the Azure Cosmos Emulator.

Authenticating requests

As with Azure Cosmos DB in the cloud, every request that you make against the Azure Cosmos Emulator must be authenticated. The Azure Cosmos Emulator supports a single fixed account and a well-known authentication key for master key authentication. This account and key are the only credentials permitted for use with the Azure Cosmos Emulator. They are:

Note

The master key supported by the Azure Cosmos Emulator is intended for use only with the emulator. You cannot use your production Azure Cosmos DB account and key with the Azure Cosmos Emulator.

Note

If you have started the emulator with the /Key option, then use the generated key instead of C2y6yDjf5/R+ob0N8A7Cgv30VRDJIWEHLM+4QDU5DE2nQ9nDuVTqobD4b8mGGyPMbIZnqyMsEcaGQy67XIw/Jw. For more information about /Key option, see Command-line tool reference.

As with the Azure Cosmos DB, the Azure Cosmos Emulator supports only secure communication via TLS.

Running on a local network

You can run the emulator on a local network. To enable network access, specify the /AllowNetworkAccess option at the command-line, which also requires that you specify /Key=key_string or /KeyFile=file_name. You can use /GenKeyFile=file_name to generate a file with a random key upfront. Then you can pass that to /KeyFile=file_name or /Key=contents_of_file.

To enable network access for the first time the user should shut down the emulator and delete the emulator's data directory (%LOCALAPPDATA%CosmosDBEmulator).

Developing with the emulator

SQL API

Once you have the Azure Cosmos Emulator running on your desktop, you can use any supported Azure Cosmos DB SDK or the Azure Cosmos DB REST API to interact with the emulator. The Azure Cosmos Emulator also includes a built-in Data Explorer that lets you create containers for SQL API or Cosmos DB for Mongo DB API, and view and edit items without writing any code.

Azure Cosmos DB's API for MongoDB

Once you have the Azure Cosmos Emulator running on your desktop, you can use the Azure Cosmos DB's API for MongoDB to interact with the emulator. Start emulator from command prompt as an administrator with '/EnableMongoDbEndpoint'. Then use the following connection string to connect to the MongoDB API account:

Table API

Once you have the Azure Cosmos Emulator running on your desktop, you can use the Azure Cosmos DB Table API SDK to interact with the emulator. Start emulator from command prompt as an administrator with '/EnableTableEndpoint'. Next run the following code to connect to the table API account:

Cassandra API

Start emulator from an administrator command prompt with '/EnableCassandraEndpoint'. Alternatively you can also set the environment variable AZURE_COSMOS_EMULATOR_CASSANDRA_ENDPOINT=true.

• Run the following commands in a regular command prompt window:

• In the CQLSH shell, run the following commands to connect to the Cassandra endpoint:

Gremlin API

Start emulator from an administrator command prompt with '/EnableGremlinEndpoint'. Alternatively you can also set the environment variable AZURE_COSMOS_EMULATOR_GREMLIN_ENDPOINT=true

• Install apache-tinkerpop-gremlin-console-3.3.4.

• In the emulator's Data Explorer create a database 'db1' and a collection 'coll1'; for the partition key, choose '/name'

• Run the following commands in a regular command prompt window:

• In the Gremlin shell run the following commands to connect to the Gremlin endpoint:

Export the TLS/SSL certificate

.NET languages and runtime use the Windows Certificate Store to securely connect to the Azure Cosmos DB local emulator. Other languages have their own method of managing and using certificates. Java uses its own certificate store whereas Python uses socket wrappers.

In order to obtain a certificate to use with languages and runtimes that do not integrate with the Windows Certificate Store, you will need to export it using the Windows Certificate Manager. You can start it by running certlm.msc or follow the step by step instructions in Export the Azure Cosmos Emulator Certificates. Once the certificate manager is running, open the Personal Certificates as shown below and export the certificate with the friendly name 'DocumentDBEmulatorCertificate' as a BASE-64 encoded X.509 (.cer) file.

The X.509 certificate can be imported into the Java certificate store by following the instructions in Adding a Certificate to the Java CA Certificates Store. Once the certificate is imported into the certificate store, clients for SQL and Azure Cosmos DB's API for MongoDB will be able to connect to the Azure Cosmos Emulator.

When connecting to the emulator from Python and Node.js SDKs, TLS verification is disabled.

Command-line tool reference

From the installation location, you can use the command-line to start and stop the emulator, configure options, and perform other operations.

Command-line syntax

To view the list of options, type Microsoft.Azure.Cosmos.Emulator.exe /? at the command prompt.

Change the number of containers

By default, you can create up to 25 fixed size containers (only supported using Azure Cosmos DB SDKs), or 5 unlimited containers using the Azure Cosmos 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 does not 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.

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.

'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.ActivityId: 12345678-1234-1234-1234-123456789abc'

To change the number of containers available in the Azure Cosmos Emulator, run the following steps:

1. Delete all local Azure Cosmos Emulator data by right-clicking the Azure Cosmos DB Emulator icon on the system tray, and then clicking Reset Data….
2. Delete all emulator data in this folder %LOCALAPPDATA%CosmosDBEmulator.
3. Exit all open instances by right-clicking the Azure Cosmos DB Emulator icon on the system tray, and then clicking Exit. It may take a minute for all instances to exit.
4. Install the latest version of the Azure Cosmos Emulator.
5. Launch the emulator with the PartitionCount flag by setting a value <= 250. For example: C:Program FilesAzure Cosmos DB Emulator> Microsoft.Azure.Cosmos.Emulator.exe /PartitionCount=100.

Controlling the emulator

The emulator comes with a PowerShell module to start, stop, uninstall, and retrieve the status of the service. Run the following cmdlet to use the PowerShell module:

or place the PSModules directory on your PSModulesPath and import it as shown in the following command:

Here is a summary of the commands for controlling the emulator from PowerShell:

Get-CosmosDbEmulatorStatus

Syntax

Get-CosmosDbEmulatorStatus

Remarks

Returns one of these ServiceControllerStatus values: ServiceControllerStatus.StartPending, ServiceControllerStatus.Running, or ServiceControllerStatus.Stopped.

Start-CosmosDbEmulator

Syntax

Start-CosmosDbEmulator [-DataPath <string>] [-DefaultPartitionCount <uint16>] [-DirectPort <uint16[]>] [-MongoPort <uint16>] [-NoUI] [-NoWait] [-PartitionCount <uint16>] [-Port <uint16>] [<CommonParameters>]

Remarks

Starts the emulator. By default, the command waits until the emulator is ready to accept requests. Use the -NoWait option, if you wish the cmdlet to return as soon as it starts the emulator.

Stop-CosmosDbEmulator

Syntax

Stop-CosmosDbEmulator [-NoWait]

Remarks

Stops the emulator. By default, this command waits until the emulator is fully shut down. Use the -NoWait option, if you wish the cmdlet to return as soon as the emulator begins to shut down.

Uninstall-CosmosDbEmulator

Syntax

Uninstall-CosmosDbEmulator [-RemoveData]

Remarks

Uninstalls the emulator and optionally removes the full contents of $env:LOCALAPPDATACosmosDbEmulator.The cmdlet ensures the emulator is stopped before uninstalling it.

Running on Docker

The Azure Cosmos Emulator can be run on Docker for Windows. The emulator does not work on Docker for Oracle Linux.

Once you have Docker for Windows installed, switch to Windows containers by right-clicking the Docker icon on the toolbar and selecting Switch to Windows containers.

Windows Cmd Emulator Mac Free

Next, pull the emulator image from Docker Hub by running the following command from your favorite shell.

To start the image, run the following commands.

From the command-line:

Note

If you see a port conflict error (specified port is already in use) when you run the docker run command, you can pass a custom port by altering the port numbers. For example, you can change the '-p 8081:8081' to '-p 443:8081'

From PowerShell:

The response looks similar to the following:

Now use the endpoint and master key-in from the response in your client and import the TLS/SSL certificate into your host. To import the TLS/SSL certificate, do the following from an admin command prompt:

From the command-line:

From PowerShell:

Closing the interactive shell once the emulator has been started will shut down the emulator's container.

To open the Data Explorer, navigate to the following URL in your browser. The emulator endpoint is provided in the response message shown above.

https://<emulator endpoint provided in response>/_explorer/index.html

If you have a .NET client application running on a Linux docker container and if you are running Azure Cosmos emulator on a host machine, please follow the below section for Linux to import the certificate into the Linux docker container.

Running on Mac or Linux

Currently the Cosmos emulator can only be run on Windows. Users running Mac or Linux can run the emulator in a Windows virtual machine hosted in a hypervisor such as Parallels or VirtualBox. Below are the steps to enable this.

Within the Windows VM run the command below and make note of the IPv4 address.

Within your application you need to change the URI used as Endpoint to use the IPv4 address returned by ipconfig.exe instead of localhost.

The next step, from the within the Windows VM, launch the Cosmos emulator from the command line using the following options.

Finally, we need to resolve the certificate trust process between the application running on the Linux or Mac environment and the Emulator. We have two options:

1. Disable the SSL validation in the application:

For any application running in a framework compatible with .NET Standard 2.1 or later, we can leverage the CosmosClientOptions.HttpClientFactory:

For any application running in a framework compatible with .NET Standard 2.0, we can leverage the CosmosClientOptions.HttpClientFactory:

For Node.js applications, you can modify your package.json file to set the NODE_TLS_REJECT_UNAUTHORIZED while starting the application:

Note

Disabling SSL validation is only recommended for development purposes and should not be done when running in a production environment.

2. Import the Emulator CA certificate into the Linux or Mac environment:

Linux

If you are working on Linux, .NET relays on OpenSSL to do the validation:

1. Export the certificate in PFX format (PFX is available when choosing to export the private key).

2. Copy that PFX file into your Linux environment.

3. Convert the PFX file into a CRT file

4. Copy the CRT file to the folder that contains custom certificates in your Linux distribution. Commonly on Debian distributions, it is located on /usr/local/share/ca-certificates/.

5. Update the CA certificates, which will update the /etc/ssl/certs/ folder.

macOS

Use the following steps if you are working on Mac:

1. Export the certificate in PFX format (PFX is available when choosing to export the private key).

2. Copy that PFX file into your Mac environment.

3. Open the Keychain Access application and import the PFX file.

4. Open the list of Certificates and identify the one with the name localhost.

5. Open the context menu for that particular item, select Get Item and under Trust > When using this certificate option, select Always Trust.

After following these steps, your environment will trust the certificate used by the Emulator when connecting to the IP address exposes by /AllowNetworkAccess.

Troubleshooting

Mac Os Emulator

Use the following tips to help troubleshoot issues you encounter with the Azure Cosmos Emulator:

• If you installed a new version of the emulator and are experiencing errors, ensure you reset your data. You can reset your data by right-clicking the Azure Cosmos Emulator icon on the system tray, and then clicking Reset Data…. If that does not fix the errors, you can uninstall the emulator and any older versions of the emulator if found, remove 'C:Program filesAzure Cosmos DB Emulator' directory and reinstall the emulator. See Uninstall the local emulator for instructions.

• If the Azure Cosmos Emulator crashes, collect dump files from '%LOCALAPPDATA%CrashDumps' folder, compress them, and open a support ticket from the Azure portal.

• If you experience crashes in Microsoft.Azure.Cosmos.ComputeServiceStartupEntryPoint.exe, this might be a symptom where the Performance Counters are in a corrupted state. Usually running the following command from an admin command prompt fixes the issue:

• If you encounter a connectivity issue, collect trace files, compress them, and open a support ticket in the Azure portal.

• If you receive a Service Unavailable message, the emulator might be failing to initialize the network stack. Check to see if you have the Pulse secure client or Juniper networks client installed, as their network filter drivers may cause the problem. Uninstalling third-party network filter drivers typically fixes the issue. Alternatively, start the emulator with /DisableRIO, which will switch the emulator network communication to regular Winsock.

• If you encounter 'Forbidden','message':'Request is being made with a forbidden encryption in transit protocol or cipher. Check account SSL/TLS minimum allowed protocol setting...' connectivity issues, this might be caused by global changes in the OS (for example Insider Preview Build 20170) or the browser settings that enable TLS 1.3 as default. Similar error might occur when using the SDK to execute a request against the Cosmos emulator, such as Microsoft.Azure.Documents.DocumentClientException: Request is being made with a forbidden encryption in transit protocol or cipher. Check account SSL/TLS minimum allowed protocol setting. This is expected at this time since Cosmos emulator only accepts and works with TLS 1.2 protocol. The recommended work around is to change the settings and default to TLS 1.2; for instance in IIS Manager navigate to 'Sites' -> 'Default Web Sites' and locate the 'Site Bindings' for port 8081 and edit them to disable TLS 1.3. Similar operation can be performed for the Web browser via the 'Settings' options.

• While the emulator is running, if your computer goes to sleep mode or runs any OS updates, you might see a Service is currently unavailable message. Reset the emulator's data, by right-clicking on the icon that appears on the windows notification tray and select Reset Data.

Collect trace files

To collect debugging traces, run the following commands from an administrative command prompt:

1. cd /d '%ProgramFiles%Azure Cosmos DB Emulator'
2. Microsoft.Azure.Cosmos.Emulator.exe /shutdown. Watch the system tray to make sure the program has shut down, it may take a minute. You can also just click Exit in the Azure Cosmos Emulator user interface.
3. Microsoft.Azure.Cosmos.Emulator.exe /startwprtraces
4. Microsoft.Azure.Cosmos.Emulator.exe
5. Reproduce the problem. If Data Explorer is not working, you only need to wait for the browser to open for a few seconds to catch the error.
6. Microsoft.Azure.Cosmos.Emulator.exe /stopwprtraces
7. Navigate to %ProgramFiles%Azure Cosmos DB Emulator and find the docdbemulator_000001.etl file.
8. Open a support ticket in the Azure portal and include the .etl file along with repro steps.

Uninstall the local emulator

1. Exit all open instances of the local emulator by right-clicking the Azure Cosmos Emulator icon on the system tray, and then clicking Exit. It may take a minute for all instances to exit.
2. In the Windows search box, type Apps & features and click on the Apps & features (System settings) result.
3. In the list of apps, scroll to Azure Cosmos DB Emulator, select it, click Uninstall, then confirm and click Uninstall again.
4. When the app is uninstalled, navigate to %LOCALAPPDATA%CosmosDBEmulator and delete the folder.

Next steps

In this tutorial, you've learned how to use the local emulator for free local development. You can now proceed to the next tutorial and learn how to export emulator TLS/SSL certificates.