Referência de linha de comando e PowerShell para emulador do Windows (local)

APLICA-SE A: NoSQL MongoDB Cassandra Gremlin Tabela

O emulador do Azure Cosmos DB fornece um ambiente local que emula o serviço Azure Cosmos DB para fins de desenvolvimento local. Depois de instalar o emulador, você pode controlar o emulador com comandos de linha de comando e PowerShell. Este artigo descreve como usar a linha de comando e os comandos do PowerShell para iniciar e parar o emulador, configurar opções e executar outras operações. Você tem que executar os comandos a partir do local de instalação.

Gerenciar o emulador com sintaxe de linha de comando

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

Para exibir a lista de parâmetros, digite Microsoft.Azure.Cosmos.Emulator.exe /? no prompt de comando.

Gerenciar o emulador com cmdlets do PowerShell

O emulador vem com um módulo do PowerShell para iniciar, parar, desinstalar e recuperar o status do serviço. Execute o seguinte cmdlet para usar o módulo PowerShell:

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

Ou coloque o PSModules diretório no seu PSModulePath e importe-o como mostrado no seguinte comando:

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

Aqui está um resumo dos comandos para controlar o emulador do PowerShell:

Get-CosmosDbEmulatorStatus

Obtém o status do emulador. Devolve um destes ServiceControllerStatus valores:

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

Se for encontrado um erro, nenhum valor será retornado.

Sintaxe

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

Parâmetros

Exemplos

• Obtenha o status de um emulador instalado na D:\SomeFolder\AzureCosmosDBEmulator pasta.

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

Start-CosmosDbEmulator

Inicia o emulador no computador local. Por predefinição, o comando aguarda até que o emulador esteja pronto para aceitar pedidos. Use a -NoWait opção, se desejar que o cmdlet retorne assim que iniciar o emulador. Use os parâmetros de para especificar opções, como a porta NoSQL, a porta direta e os números de porta MongoDB Start-CosmosDbEmulator .

Sintaxe

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

Parâmetros

Exemplos

• Inicie o emulador e aguarde até que ele esteja pronto para aceitar solicitações.

  Start-CosmosDbEmulator
  

• Inicie o emulador com 5 partições reservadas para cada coleção particionada. O número total de partições é definido como padrão: 25. Assim, o número total de coleções particionadas que podem ser criadas é 5 = 25 partitions / 5 partitions/collection. Cada coleção particionada é limitada a 50 GB = 5 partitions * 10 GB / partiton.

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

• Inicia o emulador com números de porta alternativos.

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

Stop-CosmosDbEmulator

Para o emulador. Por predefinição, este comando aguarda até que o emulador seja totalmente encerrado. Utilize a opção -NoWait, se quiser que o cmdlet seja devolvido assim que o emulador começar a encerrar.

Sintaxe

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

Parâmetros

Exemplos

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

Uninstall-CosmosDbEmulator

Desinstala o emulador e, opcionalmente, remove todo o conteúdo do $env:LOCALAPPDATA\CosmosDbEmulator. O cmdlet assegura que o emulador está parado antes de desinstalá-lo.

Sintaxe

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

Parâmetros

Exemplos

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

Alterar o número de contêineres padrão

Por padrão, você pode criar até 25 contêineres de tamanho fixo (com suporte apenas usando SDKs (kits de desenvolvimento de software) do Azure Cosmos DB) ou 5 contêineres ilimitados usando o emulador. Ao modificar o valor PartitionCount, você pode criar até 250 contêineres de tamanho fixo ou 50 contêineres ilimitados, ou qualquer combinação dos dois que não exceda 250 contêineres de tamanho fixo (onde um contêiner ilimitado = 5 contêineres de tamanho fixo). No entanto, não recomendamos que você configure o emulador para ser executado com mais de 200 contêineres de tamanho fixo. Devido à sobrecarga que ele adiciona às operações de E/S do disco, que resultam em tempos limite imprevisíveis ao usar as APIs de ponto de extremidade.

Se você tentar criar um contêiner depois que a contagem de partições atual for excedida, o emulador lançará uma exceção ServiceUnavailable, com a seguinte mensagem.

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

Para alterar o número de contêineres disponíveis no emulador, execute as seguintes etapas:

1. Exclua todos os dados do emulador local clicando com o botão direito do mouse no ícone do emulador na bandeja do sistema e clicando em Redefinir dados....

2. Exclua todos os dados do emulador nesta pasta %LOCALAPPDATA%\CosmosDBEmulator.

3. Saia de todas as instâncias abertas clicando com o botão direito do mouse no ícone do emulador na bandeja do sistema e clicando em Sair. Pode levar um minuto para que todas as instâncias saiam.

4. Instale a versão mais recente do emulador.

5. Inicie o emulador com o sinalizador PartitionCount definindo um valor <= 250. Por exemplo: C:\Program Files\emulator> Microsoft.Azure.Cosmos.Emulator.exe /PartitionCount=100.

Próximos passos

• Saiba mais sobre o emulador do Azure Cosmos DB
• Analise as notas de versão do emulador