Windows (ローカル) エミュレーターのコマンドラインと PowerShell リファレンス

適用対象: NoSQL MongoDB Cassandra Gremlin Table

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 コマンドレットでエミュレーターを管理する

エミュレーターには、サービスの開始、停止、アンインストール、状態の取得のための PowerShell モジュールが付属しています。 この PowerShell モジュールを使用するには、次のコマンドレットを実行します。

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

または、PSModulePathに PSModules ディレクトリを配置し、次のコマンドに示すようにインポートします。

$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>]

Parameters

例

• D:\SomeFolder\AzureCosmosDBEmulator フォルダーにインストールされているエミュレーターの状態を取得します。

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

Start-CosmosDbEmulator

ローカル コンピューターでエミュレーターを起動します。 既定では、このコマンドは、エミュレーターで要求を受け付ける準備ができるまで待ちます。 エミュレーターを起動したらすぐにコマンドレットから戻るようにする場合は、-NoWait オプションを使用します。 NoSQL ポート、ダイレクト ポート、MongoDB ポート番号などのオプションを指定するには、Start-CosmosDbEmulator のパラメーターを使用します。

構文

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>]

Parameters

例

• エミュレーターを起動し、要求を受け入れる準備ができるまで待ちます。

  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

エミュレーターを停止します。 既定では、このコマンドは、エミュレーターが完全に停止するまで待ちます。 エミュレーターが停止し始めたらすぐにコマンドレットから戻るようにする場合は、-NoWait オプションを使用します。

構文

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

Parameters

例

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

Uninstall-CosmosDbEmulator

エミュレーターをアンインストールし、オプションで $env:LOCALAPPDATA\CosmosDbEmulator のすべての内容を削除します。 このコマンドレットは、アンインストールする前にエミュレーターが停止されたことを確認します。

構文

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

Parameters

例

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

既定のコンテナー数を変更する

既定では、最大 25 個の固定サイズコンテナー (Azure Cosmos DB ソフトウェア開発キット (SDK) を使用してのみサポート)、またはエミュレーターを使用して 5 つの無制限コンテナーを作成できます。 PartitionCount の値を変更すると、固定サイズのコンテナーであれば 250 個、容量無制限のコンテナーであれば 50 個まで作成できるようになります。この 2 つの組み合わせは、固定サイズのコンテナー 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. システム トレイのエミュレーター アイコンを右クリックし、開いているすべてのインスタンスを終了して、[終了] をクリックします。 すべてのインスタンスが終了するまでに 1 分かかる場合があります。

4. 最新バージョンのエミュレーターをインストールします。

5. PartitionCount フラグの値を 250 以下に設定して、エミュレーターを起動します。 (例: C:\Program Files\emulator> Microsoft.Azure.Cosmos.Emulator.exe /PartitionCount=100)。

次のステップ

• Azure Cosmos DB エミュレーターの詳細を確認する
• エミュレーターのリリース ノートを確認する