Windows（本地）模拟器的命令行和 PowerShell 参考

适用对象： NoSQL MongoDB Cassandra Gremlin 表

为便于本地开发，Azure Cosmos DB 模拟器提供了模拟 Azure Cosmos DB 服务的本地环境。 安装模拟器后，可以通过命令行和 PowerShell 命令控制模拟器。 本文介绍如何使用命令行和 PowerShell 命令启动和停止模拟器、配置选项和执行其他操作。 必须从安装位置运行命令。

用命令行语法管理模拟器

Microsoft.Azure.Cosmos.Emulator.exe 
    [/Shutdown] [/DataPath] [/Port] [/MongoPort] 
    [/DirectPorts] [/Key] [/EnableRateLimiting] 
    [/DisableRateLimiting] [/NoUI] [/NoExplorer] 
    [/EnableMongoDbEndpoint] 
    [/?]

要查看参数列表，请在命令提示符下键入 Microsoft.Azure.Cosmos.Emulator.exe /?。

使用 PowerShell cmdlet 管理模拟器

该模拟器附带一个 PowerShell 模块，它可用于启动、停止、卸载和检索服务的状态。 运行下列 cmdlet 以使用 PowerShell 模块：

Import-Module "$env:ProgramFiles\Azure Cosmos DB Emulator\PSModules\Microsoft.Azure.CosmosDB.Emulator"

或者，将 PSModules 目录放置在 PSModulePath 上，并按如下命令中所示将其导入：

$env:PSModulePath += ";$env:ProgramFiles\Azure Cosmos DB Emulator\PSModules"
Import-Module Microsoft.Azure.CosmosDB.Emulator

下面汇总了用于通过 PowerShell 控制模拟器的命令：

Get-CosmosDbEmulatorStatus

获取模拟器状态。 返回以下 ServiceControllerStatus 值之一：

• ServiceControllerStatus.StartPending
• ServiceControllerStatus.Running
• ServiceControllerStatus.Stopped

如果遇到错误，不返回任何值。

语法

Get-CosmosDbEmulatorStatus 
    [[-AlternativeInstallLocation] <String>] 
    [<CommonParameters>]

参数设置

示例

• 获取 D:\SomeFolder\AzureCosmosDBEmulator 文件夹中安装的模拟器的状态。

  @parameters = {
      AlternativeInstallLocation = "D:\SomeFolder\AzureCosmosDBEmulator"
  }
  Get-CosmosDbEmulatorStatus @parameters
  

Start-CosmosDbEmulator

在本地计算机上启动模拟器。 默认情况下，此命令会一直等待，直至模拟器做好接受请求的准备。 如果希望 cmdlet 在启动模拟器后立即返回，请使用 -NoWait选项。 使用 Start-CosmosDbEmulator 的参数指定 NoSQL 端口、直接端口和 MongoDB 端口号等选项。

语法

Start-CosmosDbEmulator [-AllowNetworkAccess]
    [-AlternativeInstallLocation <String>] [-CassandraPort <UInt16>]
    [-ComputePort <UInt16>] [-Consistency <String>] [-Credential
    <PSCredential>] [-DataPath <String>] [-DefaultPartitionCount
    <UInt16>] [-DirectPort <UInt16[]>] [-EnableMongoDb]
    [-EnableCassandra] [-EnableGremlin] [-EnableTable]
    [-EnableSqlCompute] [-EnablePreview]
    [-FailOnSslCertificateNameMismatch] [-GremlinPort <UInt16>]
    [-TablePort <UInt16>] [-SqlComputePort <UInt16>] [-Key <String>]
    [-MongoPort <UInt16>] [-MongoApiVersion <String>] [-NoFirewall]
    [-NoTelemetry] [-NoUI] [-NoWait] [-PartitionCount <UInt16>] [-Port
    <UInt16>] [-SimulateRateLimiting] [-Timeout <UInt32>] [-Trace]
    [<CommonParameters>]

参数设置

示例

• 启动模拟器并等待，直到它准备好接受请求。

  Start-CosmosDbEmulator
  

• 使用为每个已分区集合保留的 5 个分区启动模拟器。 分区总数设置为默认值：25。 因此，可以创建的分区集合总数为 5 = 25 partitions / 5 partitions/collection。 每个已分区集合的上限为 50 GB = 5 partitions * 10 GB / partiton。

  @parameters = {
      DefaultPartitionCount = 5
  }
  Start-CosmosDbEmulator @parameters
  

• 使用备用端口号启动模拟器。

  @parameters = {
      Port = 443 
      MongoPort = 27017 
      DirectPort = 20001,20002,20003,20004
  }
  Start-CosmosDbEmulator @parameters
  

Stop-CosmosDbEmulator

停止模拟器。 默认情况下，此命令会一直等待，直至模拟器完全关闭。 如果希望 cmdlet 在模拟器开始关闭后立即返回，请使用 -NoWait 选项。

语法

Stop-CosmosDbEmulator 
    [[-AlternativeInstallLocation] <String>]
    [-NoWait] [[-Timeout] <UInt32>] [-Trace] 
    [<CommonParameters>]

参数设置

示例

@parameters = {
    NoWait = $true
}
Stop-CosmosDbEmulator @parameters

Uninstall-CosmosDbEmulator

卸载模拟器，并选择性地删除 $env:LOCALAPPDATA\CosmosDbEmulator 的完整内容。 此 cmdlet 可确保在卸载模拟器之前，模拟器已停止。

语法

Uninstall-CosmosDbEmulator 
    [-RemoveData] 
    [<CommonParameters>]

参数设置

示例

@parameters = {
    RemoveData = $false
}
Uninstall-CosmosDbEmulator @parameters

更改默认容器数量

默认情况下，可最多创建 25 个固定大小的容器（仅支持使用 Azure Cosmos DB 软件开发工具包 (SDK) 进行创建），或使用模拟器创建 5 个不受限容器。 通过修改 PartitionCount 值，可以创建最多 250 个固定大小的容器或 50 个不受限容器，也可以创建两者的任意组合（前提是不超过 250 个固定大小的容器，其中 1 个不受限容器 = 5 个固定大小的容器）。 但是，我们不建议将模拟器设置为使用 200 多个固定大小的容器运行。 因为这会造成磁盘 IO 操作的开销增加，导致在运行终结点 API 时出现不可预测的超时情况。

如果在已超过当前分区计数后尝试创建容器，则模拟器将引发 ServiceUnavailable 异常，并收到以下消息。

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

要更改模拟器中的可用容器数，请执行以下步骤：

1. 在系统托盘上右击“模拟器”图标，然后点击“重置数据...”，从而删除所有本地模拟器数据。

2. 删除文件夹 %LOCALAPPDATA%\CosmosDBEmulator 中的所有模拟器数据。

3. 在系统托盘上右击“模拟器”图标，然后点击“退出”，从而退出所有打开的实例。 退出所有实例可能需要一分钟。

4. 安装最新版本的 模拟器。

5. 通过设置一个 <= 250 的值启动具有 PartitionCount 标志的模拟器。 例如：C:\Program Files\emulator> Microsoft.Azure.Cosmos.Emulator.exe /PartitionCount=100。

后续步骤

• 详细了解 Azure Cosmos DB 模拟器
• 查看模拟器的发行说明