Partilhar via

az cosmosdb service

Note

Este 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

Name Description Tipo Status
az cosmosdb service create

Crie um recurso de serviço cosmosdb.

 Core disponibilidade geral
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 cosmosdb fornecido.

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

Exclua o recurso de serviço cosmosdb fornecido.

 Extension Preview
az cosmosdb service list

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

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

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

 Extension Preview
az cosmosdb service show

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

 Core disponibilidade geral
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 cosmosdb.

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

Atualize um recurso de serviço 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 Obrigatórios

--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 tornar-se necessários para que o comando seja executado com êxito.

--count -c

Contagem de instâncias.

Propriedade Valor
Default value: 1
--gateway-type

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

Propriedade Valor
Default value: IntegratedCache
Valores aceites: DistributedQuery, IntegratedCache
--no-wait

Não espere que a operação de longa duração termine.

Propriedade Valor
Default value: False
--size

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

Propriedade Valor
Default value: Cosmos.D4s
Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

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

Pré-visualizar

O grupo de comando 'cosmosdb service' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: 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 visualizaçõ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 Obrigatórios

--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 tornar-se necessários para que o comando seja executado com êxito.

--count -c

Contagem de instâncias.

Propriedade Valor
Default value: 1
--gateway-type

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

Propriedade Valor
Default value: IntegratedCache
Valores aceites: DistributedQuery, IntegratedCache
--no-wait

Não espere que a operação de longa duração termine.

Propriedade Valor
Default value: False
--size

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

Propriedade Valor
Default value: Cosmos.D4s
Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az cosmosdb service delete

Editar

Exclua o recurso de serviço cosmosdb fornecido.

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

Exemplos

Exclua o recurso de serviço cosmosdb fornecido.

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

Parâmetros Obrigatórios

--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 tornar-se necessários para que o comando seja executado com êxito.

--no-wait

Não espere que a operação de longa duração termine.

Propriedade Valor
Default value: False
--yes -y

Não solicite confirmação.

Propriedade Valor
Default value: False
Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

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

Pré-visualizar

O grupo de comando 'cosmosdb service' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Exclua o recurso de serviço cosmosdb fornecido.

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

Exemplos

Exclua o recurso de serviço cosmosdb fornecido.

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

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

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

Parâmetros Obrigatórios

--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 tornar-se necessários para que o comando seja executado com êxito.

--no-wait

Não espere que a operação de longa duração termine.

Propriedade Valor
Default value: False
--yes -y

Não solicite confirmação.

Propriedade Valor
Default value: False
Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az cosmosdb service list

Editar

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

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

Exemplos

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

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

Parâmetros Obrigatórios

--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 de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

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

Pré-visualizar

O grupo de comando 'cosmosdb service' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

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

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

Exemplos

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

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

Parâmetros Obrigatórios

--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 de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: 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 Obrigatórios

--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 de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

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

Pré-visualizar

O grupo de comando 'cosmosdb service' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: 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 Obrigatórios

--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 de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az cosmosdb service update

Editar

Atualize um recurso de serviço cosmosdb.

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

Exemplos

Atualize um recurso de serviço cosmosdb.

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

Parâmetros Obrigatórios

--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 tornar-se necessários para que o comando seja executado com êxito.

--no-wait

Não espere que a operação de longa duração termine.

Propriedade Valor
Default value: False
--size

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

Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

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

Pré-visualizar

O grupo de comando 'cosmosdb service' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Atualize um recurso de serviço cosmosdb.

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

Exemplos

Atualize um recurso de serviço 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 visualizações materializado do cosmosdb.

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

Parâmetros Obrigatórios

--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 tornar-se necessários para que o comando seja executado com êxito.

--no-wait

Não espere que a operação de longa duração termine.

Propriedade Valor
Default value: False
--size

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

Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False