Compartilhar via

az cosmosdb service

Note

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.

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

Crie um recurso de serviço cosmosdb.

 Extension Preview
az cosmosdb service delete

Exclua o recurso de serviço do cosmosdb fornecido.

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

Exclua o recurso de serviço do cosmosdb fornecido.

 Extension Preview
az cosmosdb service list

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

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

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

 Extension Preview
az cosmosdb service show

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

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

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

 Extension Preview
az cosmosdb service update

Atualize um recurso de serviço do cosmosdb.

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

Atualize um recurso de serviço do cosmosdb.

 Extension Preview

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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--count -c

Contagem de instâncias.

Propriedade Valor
Valor padrão: 1
--gateway-type

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

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

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

Propriedade Valor
Valor padrão: False
--size

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

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

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--count -c

Contagem de instâncias.

Propriedade Valor
Valor padrão: 1
--gateway-type

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

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

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

Propriedade Valor
Valor padrão: False
--size

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

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

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--no-wait

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

Propriedade Valor
Valor padrão: False
--yes -y

Não solicite confirmação.

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

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--no-wait

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

Propriedade Valor
Valor padrão: False
--yes -y

Não solicite confirmação.

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

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

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 a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

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 a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

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 a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

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 a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--no-wait

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

Propriedade Valor
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 a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--no-wait

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

Propriedade Valor
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 a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False