Compartilhar via

az cosmosdb service

  • Referência

Observação

Esse grupo de comandos tem comandos definidos na CLI do Azure e em pelo menos uma extensão. Instale cada extensão para se beneficiar de seus recursos estendidos. Saiba mais sobre extensões.

Comandos para executar operações no Serviço.

Comandos

Nome Description Tipo Status
az cosmosdb service create

Crie um recurso de serviço cosmosdb.

 Núcleo GA
az cosmosdb service create (cosmosdb-preview extensão)

Crie um recurso de serviço cosmosdb.

 Extensão Visualizar
az cosmosdb service delete

Exclua o recurso de serviço do cosmosdb fornecido.

 Núcleo GA
az cosmosdb service delete (cosmosdb-preview extensão)

Exclua o recurso de serviço do cosmosdb fornecido.

 Extensão Visualizar
az cosmosdb service list

Liste todos os recursos de serviço do cosmosdb em uma conta.

 Núcleo GA
az cosmosdb service list (cosmosdb-preview extensão)

Liste todos os recursos de serviço do cosmosdb em uma conta.

 Extensão Visualizar
az cosmosdb service show

Obtenha o recurso de serviço cosmosdb em uma conta.

 Núcleo GA
az cosmosdb service show (cosmosdb-preview extensão)

Obtenha o recurso de serviço cosmosdb em uma conta.

 Extensão Visualizar
az cosmosdb service update

Atualize um recurso de serviço do cosmosdb.

 Núcleo GA
az cosmosdb service update (cosmosdb-preview extensão)

Atualize um recurso de serviço do cosmosdb.

 Extensão Visualizar

az cosmosdb service create

Editar

Crie um recurso de serviço cosmosdb.

az cosmosdb service create --account-name
                           --name
                           --resource-group-name
                           [--count]
                           [--gateway-type {DistributedQuery, IntegratedCache}]
                           [--no-wait]
                           [--size]

Exemplos

Crie um recurso de serviço cosmosdb.

az cosmosdb service create --resource-group MyResourceGroup --account-name MyAccount --name "sqlDedicatedGateway" --count 3 --size "Cosmos.D4s"

Parâmetros Exigidos

--account-name -a

Nome da conta de banco de dados do Cosmos DB.

--name -n

Nome do serviço.

--resource-group-name -g

Nome do grupo de recursos da conta de banco de dados.

Parâmetros Opcionais

--count -c

Contagem de instâncias.

Valor padrão: 1
--gateway-type

Tipo de gateway dedicado. Válido apenas para o tipo de serviço SqlDedicatedGateway.

Valores aceitos: DistributedQuery, IntegratedCache
Valor padrão: IntegratedCache
--no-wait

Não aguarde a conclusão da operação de execução longa.

Valor padrão: False
--size

Tamanho da instância. Os valores possíveis são: Cosmos.D4s, Cosmos.D8s, Cosmos.D16s etc.

Valor padrão: Cosmos.D4s
Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az cosmosdb service create (cosmosdb-preview extensão)

Versão Prévia

O grupo de comandos 'cosmosdb service' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Crie um recurso de serviço cosmosdb.

az cosmosdb service create --account-name
                           --kind
                           --name
                           --resource-group-name
                           [--count]
                           [--gateway-type {DistributedQuery, IntegratedCache}]
                           [--no-wait]
                           [--size]

Exemplos

Crie um recurso de serviço cosmosdb.

az cosmosdb service create --resource-group MyResourceGroup --account-name MyAccount --name "sqlDedicatedGateway" --kind "SqlDedicatedGateway" --count 3 --size "Cosmos.D4s"

Crie um recurso de serviço do construtor de exibições materializadas do cosmosdb.

az cosmosdb service create --resource-group MyResourceGroup --account-name MyAccount --name "MaterializedViewsBuilder" --kind "MaterializedViewsBuilder" --count 3 --size "Cosmos.D4s"

Parâmetros Exigidos

--account-name -a

Nome da conta de banco de dados do Cosmos DB.

--kind -k

Tipo de serviço.

--name -n

Nome do serviço.

--resource-group-name -g

Nome do grupo de recursos da conta de banco de dados.

Parâmetros Opcionais

--count -c

Contagem de instâncias.

Valor padrão: 1
--gateway-type

Tipo de gateway dedicado. Válido apenas para o tipo de serviço SqlDedicatedGateway.

Valores aceitos: DistributedQuery, IntegratedCache
Valor padrão: IntegratedCache
--no-wait

Não aguarde a conclusão da operação de execução longa.

Valor padrão: False
--size

Tamanho da instância. Os valores possíveis são: Cosmos.D4s, Cosmos.D8s, Cosmos.D16s etc.

Valor padrão: Cosmos.D4s
Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az cosmosdb service delete

Editar

Exclua o recurso de serviço do cosmosdb fornecido.

az cosmosdb service delete --account-name
                           --name
                           --resource-group-name
                           [--no-wait]
                           [--yes]

Exemplos

Exclua o recurso de serviço do cosmosdb fornecido.

az cosmosdb service delete --resource-group MyResourceGroup --account-name MyAccount --name "sqlDedicatedGateway"

Parâmetros Exigidos

--account-name -a

Nome da conta de banco de dados do Cosmos DB.

--name -n

Nome do serviço.

--resource-group-name -g

Nome do grupo de recursos da conta de banco de dados.

Parâmetros Opcionais

--no-wait

Não aguarde a conclusão da operação de execução longa.

Valor padrão: False
--yes -y

Não solicite confirmação.

Valor padrão: False
Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az cosmosdb service delete (cosmosdb-preview extensão)

Versão Prévia

O grupo de comandos 'cosmosdb service' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Exclua o recurso de serviço do cosmosdb fornecido.

az cosmosdb service delete --account-name
                           --name
                           --resource-group-name
                           [--no-wait]
                           [--yes]

Exemplos

Exclua o recurso de serviço do cosmosdb fornecido.

az cosmosdb service delete --resource-group MyResourceGroup --account-name MyAccount --name "sqlDedicatedGateway"

Exclua o recurso de serviço do construtor de exibições materializadas do cosmosdb.

az cosmosdb service delete --resource-group MyResourceGroup --account-name MyAccount --name "MaterializedViewsBuilder"

Parâmetros Exigidos

--account-name -a

Nome da conta de banco de dados do Cosmos DB.

--name -n

Nome do serviço.

--resource-group-name -g

Nome do grupo de recursos da conta de banco de dados.

Parâmetros Opcionais

--no-wait

Não aguarde a conclusão da operação de execução longa.

Valor padrão: False
--yes -y

Não solicite confirmação.

Valor padrão: False
Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az cosmosdb service list

Editar

Liste todos os recursos de serviço do cosmosdb em uma conta.

az cosmosdb service list --account-name
                         --resource-group-name

Exemplos

Liste todos os recursos de serviço do cosmosdb em uma conta.

az cosmosdb service list --resource-group MyResourceGroup --account-name MyAccount

Parâmetros Exigidos

--account-name -a

Nome da conta de banco de dados do Cosmos DB.

--resource-group-name -g

Nome do grupo de recursos da conta de banco de dados.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az cosmosdb service list (cosmosdb-preview extensão)

Versão Prévia

O grupo de comandos 'cosmosdb service' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Liste todos os recursos de serviço do cosmosdb em uma conta.

az cosmosdb service list --account-name
                         --resource-group-name

Exemplos

Liste todos os recursos de serviço do cosmosdb em uma conta.

az cosmosdb service list --resource-group MyResourceGroup --account-name MyAccount

Parâmetros Exigidos

--account-name -a

Nome da conta de banco de dados do Cosmos DB.

--resource-group-name -g

Nome do grupo de recursos da conta de banco de dados.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az cosmosdb service show

Editar

Obtenha o recurso de serviço cosmosdb em uma conta.

az cosmosdb service show --account-name
                         --name
                         --resource-group-name

Exemplos

Obtenha o recurso de serviço cosmosdb em uma conta.

az cosmosdb service show --resource-group MyResourceGroup --account-name MyAccount --name "sqlDedicatedGateway"

Parâmetros Exigidos

--account-name -a

Nome da conta de banco de dados do Cosmos DB.

--name -n

Nome do serviço.

--resource-group-name -g

Nome do grupo de recursos da conta de banco de dados.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az cosmosdb service show (cosmosdb-preview extensão)

Versão Prévia

O grupo de comandos 'cosmosdb service' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Obtenha o recurso de serviço cosmosdb em uma conta.

az cosmosdb service show --account-name
                         --name
                         --resource-group-name

Exemplos

Obtenha o recurso de serviço cosmosdb em uma conta.

az cosmosdb service show --resource-group MyResourceGroup --account-name MyAccount --name "sqlDedicatedGateway"

Parâmetros Exigidos

--account-name -a

Nome da conta de banco de dados do Cosmos DB.

--name -n

Nome do serviço.

--resource-group-name -g

Nome do grupo de recursos da conta de banco de dados.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az cosmosdb service update

Editar

Atualize um recurso de serviço do cosmosdb.

az cosmosdb service update --account-name
                           --count
                           --name
                           --resource-group-name
                           [--no-wait]
                           [--size]

Exemplos

Atualize um recurso de serviço do cosmosdb.

az cosmosdb service update --resource-group MyResourceGroup --account-name MyAccount --name "sqlDedicatedGateway" --count 3

Parâmetros Exigidos

--account-name -a

Nome da conta de banco de dados do Cosmos DB.

--count -c

Contagem de instâncias.

--name -n

Nome do serviço.

--resource-group-name -g

Nome do grupo de recursos da conta de banco de dados.

Parâmetros Opcionais

--no-wait

Não aguarde a conclusão da operação de execução longa.

Valor padrão: False
--size

Tamanho da instância. Os valores possíveis são: Cosmos.D4s, Cosmos.D8s, Cosmos.D16s etc.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az cosmosdb service update (cosmosdb-preview extensão)

Versão Prévia

O grupo de comandos 'cosmosdb service' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Atualize um recurso de serviço do cosmosdb.

az cosmosdb service update --account-name
                           --count
                           --kind
                           --name
                           --resource-group-name
                           [--no-wait]
                           [--size]

Exemplos

Atualize um recurso de serviço do cosmosdb.

az cosmosdb service update --resource-group MyResourceGroup --account-name MyAccount --name "sqlDedicatedGateway" --kind "SqlDedicatedGateway" --count 3

Atualize um recurso de serviço do construtor de exibições materializadas do cosmosdb.

az cosmosdb service update --resource-group MyResourceGroup --account-name MyAccount --name "MaterializedViewsBuilder" --kind "MaterializedViewsBuilder" --count 3

Parâmetros Exigidos

--account-name -a

Nome da conta de banco de dados do Cosmos DB.

--count -c

Contagem de instâncias.

--kind -k

Tipo de serviço.

--name -n

Nome do serviço.

--resource-group-name -g

Nome do grupo de recursos da conta de banco de dados.

Parâmetros Opcionais

--no-wait

Não aguarde a conclusão da operação de execução longa.

Valor padrão: False
--size

Tamanho da instância. Os valores possíveis são: Cosmos.D4s, Cosmos.D8s, Cosmos.D16s etc.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.