Compartir a través de

az cosmosdb mongodb collection

Note

Este grupo de comandos tiene comandos definidos en la CLI de Azure y al menos una extensión. Instale cada extensión para beneficiarse de sus funcionalidades extendidas. Learn more about extensions.

Administración de colecciones de MongoDB de Azure Cosmos DB.

Comandos

Nombre Description Tipo Estado
az cosmosdb mongodb collection create

Cree una colección de MongoDB en una base de datos de MongoDB de Azure Cosmos DB.

 Core GA
az cosmosdb mongodb collection delete

Elimine la colección de MongoDB en una base de datos de MongoDB de Azure Cosmos DB.

 Core GA
az cosmosdb mongodb collection exists

Comprueba si existe una colección mongoDB de Azure Cosmos DB.

 Core GA
az cosmosdb mongodb collection list

Enumere las colecciones de MongoDB en una base de datos de MongoDB de Azure Cosmos DB.

 Core GA
az cosmosdb mongodb collection merge

Combina las particiones de una colección mongodb.

 Extension Preview
az cosmosdb mongodb collection redistribute-partition-throughput

Redistribuye el rendimiento de la partición de una colección mongodb.

 Extension Preview
az cosmosdb mongodb collection restore

Restaure una colección mongodb eliminada dentro de la misma cuenta.

 Core GA
az cosmosdb mongodb collection restore (cosmosdb-preview extensión)

Restaure una colección mongodb eliminada dentro de la misma cuenta.

 Extension Preview
az cosmosdb mongodb collection retrieve-partition-throughput

Recupere el rendimiento de la partición de una colección mongodb.

 Extension Preview
az cosmosdb mongodb collection show

Mostrar los detalles de una colección de MongoDB en una base de datos de MongoDB de Azure Cosmos DB.

 Core GA
az cosmosdb mongodb collection throughput

Administre el rendimiento de la colección de MongoDB en una cuenta de Azure Cosmos DB.

 Core GA
az cosmosdb mongodb collection throughput migrate

Migre el rendimiento de la colección de MongoDB entre el escalado automático y el aprovisionado manualmente.

 Core GA
az cosmosdb mongodb collection throughput show

Obtenga el rendimiento de la colección de MongoDB en una base de datos de MongoDB de Azure Cosmos DB.

 Core GA
az cosmosdb mongodb collection throughput update

Actualice el rendimiento de la colección de MongoDB en una base de datos de MongoDB de Azure Cosmos DB.

 Core GA
az cosmosdb mongodb collection update

Actualice una colección de MongoDB en una base de datos de MongoDB de Azure Cosmos DB.

 Core GA

az cosmosdb mongodb collection create

Editar

Cree una colección de MongoDB en una base de datos de MongoDB de Azure Cosmos DB.

az cosmosdb mongodb collection create --account-name
                                      --database-name
                                      --name
                                      --resource-group
                                      [--analytical-storage-ttl]
                                      [--idx]
                                      [--max-throughput]
                                      [--shard]
                                      [--throughput]

Ejemplos

Cree una colección de MongoDB de Azure Cosmos DB.

az cosmosdb mongodb collection create -g MyResourceGroup -a MyAccount -d MyDatabase -n MyCollection --shard "ShardingKey" --idx @indexes-file.json --throughput "500"

Parámetros requeridos

--account-name -a

Nombre de la cuenta de Cosmosdb.

--database-name -d

Database name.

--name -n

Collection name.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros opcionales

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--analytical-storage-ttl

TTL analítico, cuando se habilita el almacenamiento analítico.

--idx

Índices, puede escribirlo como una cadena o como un archivo, Por ejemplo, --idx @indexes-file.json o --idx "[{"key": {"keys": ["_ts"]},"options": {"expireAfterSeconds": 1000}}, {"key": {"keys": ["user_id", "user_address"]}, "options": {"unique": "true"}}]".

--max-throughput

El recurso de rendimiento máximo puede escalar a (RU/s). Se proporciona cuando el recurso está habilitado para el escalado automático. El valor mínimo puede ser 4000 (RU/s).

--shard

Ruta de acceso de clave de particionamiento.

--throughput

Rendimiento de la colección de MongoDB (RU/s). El valor predeterminado es 400. Omita este parámetro si la base de datos tiene un rendimiento compartido a menos que la colección tenga un rendimiento dedicado.

Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Output format.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az cosmosdb mongodb collection delete

Editar

Elimine la colección de MongoDB en una base de datos de MongoDB de Azure Cosmos DB.

az cosmosdb mongodb collection delete --account-name
                                      --database-name
                                      --name
                                      --resource-group
                                      [--yes]

Parámetros requeridos

--account-name -a

Nombre de la cuenta de Cosmosdb.

--database-name -d

Database name.

--name -n

Collection name.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros opcionales

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--yes -y

No solicita confirmación.

Propiedad Valor
Valor predeterminado: False
Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Output format.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az cosmosdb mongodb collection exists

Editar

Comprueba si existe una colección mongoDB de Azure Cosmos DB.

az cosmosdb mongodb collection exists --account-name
                                      --database-name
                                      --name
                                      --resource-group

Parámetros requeridos

--account-name -a

Nombre de la cuenta de Cosmosdb.

--database-name -d

Database name.

--name -n

Collection name.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Output format.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az cosmosdb mongodb collection list

Editar

Enumere las colecciones de MongoDB en una base de datos de MongoDB de Azure Cosmos DB.

az cosmosdb mongodb collection list --account-name
                                    --database-name
                                    --resource-group

Parámetros requeridos

--account-name -a

Nombre de la cuenta de Cosmosdb.

--database-name -d

Database name.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Output format.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az cosmosdb mongodb collection merge

Vista previa

Este comando está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Combina las particiones de una colección mongodb.

az cosmosdb mongodb collection merge --account-name
                                     --database-name
                                     --name
                                     --resource-group

Ejemplos

combinar particiones de la colección my-mongodb-collection

az cosmosdb mongodb collection merge -g my-resource-group -a my-account -d my-db --name my-mongodb-collection

Parámetros requeridos

--account-name -a

Nombre de la cuenta de base de datos de CosmosDB.

--database-name -d

Nombre de la base de datos mongoDB.

--name -n

Nombre de la colección mongoDB.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Output format.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az cosmosdb mongodb collection redistribute-partition-throughput

Vista previa

Este comando está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Redistribuye el rendimiento de la partición de una colección mongodb.

az cosmosdb mongodb collection redistribute-partition-throughput --account-name
                                                                 --database-name
                                                                 --name
                                                                 --resource-group
                                                                 [--evenly-distribute {false, true}]
                                                                 [--source-partition-info]
                                                                 [--target-partition-info]

Ejemplos

Distribuye uniformemente el rendimiento de la partición para una colección mongodb entre todas las particiones físicas.

az cosmosdb mongodb collection redistribute-partition-throughput --account-name account_name --database-name db_name --name container_name  --resource-group rg_name --evenly-distribute

Redistribuye el rendimiento de la partición de una colección mongodb de particiones de origen a particiones de destino.

az cosmosdb mongodb collection redistribute-partition-throughput --account-name account_name --database-name db_name --name container_name  --resource-group rg_name --target-partition-info 8=1200 6=1200' --source-partition-info 9'

Parámetros requeridos

--account-name -a

Nombre de la cuenta de base de datos de CosmosDB.

--database-name -d

Nombre de la base de datos de CosmosDB.

--name -n

Nombre de la colección de CosmosDB.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros opcionales

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--evenly-distribute

Cambie para distribuir el rendimiento de forma equitativa entre todas las particiones físicas.

Propiedad Valor
Valor predeterminado: False
Valores aceptados: false, true
--source-partition-info

Identificadores de partición física de origen separados por espacios, por ejemplo: 1 2.

Propiedad Valor
Valor predeterminado: []
--target-partition-info

Información sobre el rendimiento de partición física de destino deseado, por ejemplo: '0=1200 1=1200'.

Propiedad Valor
Valor predeterminado: []
Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Output format.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az cosmosdb mongodb collection restore

Editar

Restaure una colección mongodb eliminada dentro de la misma cuenta.

az cosmosdb mongodb collection restore --account-name
                                       --database-name
                                       --name
                                       --resource-group
                                       [--disable-ttl]
                                       [--restore-timestamp]

Ejemplos

Restaure una colección mongodb eliminada dentro de la misma cuenta.

az cosmosdb mongodb collection restore --resource-group resource_group --account-name database_account_name --database-name parent_database_name --name name_of_collection_needs_to_be_restored --restore-timestamp 2020-07-13T16:03:41+0000

Parámetros requeridos

--account-name -a

Nombre de la cuenta de Cosmosdb.

--database-name -d

Database name.

--name -n

Collection name.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros opcionales

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--disable-ttl

Marca para restaurar con TTL deshabilitado.

Uso: --disable-ttl True Default: false.

--restore-timestamp -t

Marca de tiempo a la que se debe restaurar la colección.

Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Output format.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az cosmosdb mongodb collection restore (cosmosdb-preview extensión)

Vista previa

Este comando está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Restaure una colección mongodb eliminada dentro de la misma cuenta.

az cosmosdb mongodb collection restore --account-name
                                       --database-name
                                       --name
                                       --resource-group
                                       [--disable-ttl {false, true}]
                                       [--restore-timestamp]

Ejemplos

Restaure una colección mongodb eliminada dentro de la misma cuenta.

az cosmosdb mongodb collection restore --resource-group resource_group --account-name database_account_name --database-name parent_database_name --name name_of_collection_needs_to_be_restored --restore-timestamp 2020-07-13T16:03:41+0000

Parámetros requeridos

--account-name -a

Nombre de la cuenta de Cosmosdb.

--database-name -d

Database name.

--name -n

Collection name.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros opcionales

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--disable-ttl
Vista previa

Habilite o deshabilite la restauración con ttl deshabilitado.

Propiedad Valor
Valores aceptados: false, true
--restore-timestamp -t

Marca de tiempo a la que se debe restaurar la colección.

Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Output format.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az cosmosdb mongodb collection retrieve-partition-throughput

Vista previa

Este comando está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Recupere el rendimiento de la partición de una colección mongodb.

az cosmosdb mongodb collection retrieve-partition-throughput --account-name
                                                             --database-name
                                                             --name
                                                             --resource-group
                                                             [--all-partitions {false, true}]
                                                             [--physical-partition-ids]

Ejemplos

Recuperación del rendimiento del contenedor container_name para particiones físicas específicas

az cosmosdb mongodb collection retrieve-partition-throughput --account-name account_name --database-name db_name --name container_name  --resource-group rg_name --physical-partition-ids 8 9

Recuperación del rendimiento del contenedor container_name para todas las particiones físicas

az cosmosdb mongodb collection retrieve-partition-throughput --account-name account_name --database-name db_name --name container_name  --resource-group rg_name --all-partitions

Parámetros requeridos

--account-name -a

Nombre de la cuenta de base de datos de CosmosDB.

--database-name -d

Nombre de la base de datos de CosmosDB.

--name -n

Nombre del contenedor de CosmosDB.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros opcionales

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--all-partitions

Cambie para recuperar el rendimiento de todas las particiones físicas.

Propiedad Valor
Valor predeterminado: False
Valores aceptados: false, true
--physical-partition-ids -p

Lista separada por espacios de identificadores de partición física.

Propiedad Valor
Valor predeterminado: []
Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Output format.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az cosmosdb mongodb collection show

Editar

Mostrar los detalles de una colección de MongoDB en una base de datos de MongoDB de Azure Cosmos DB.

az cosmosdb mongodb collection show --account-name
                                    --database-name
                                    --name
                                    --resource-group

Parámetros requeridos

--account-name -a

Nombre de la cuenta de Cosmosdb.

--database-name -d

Database name.

--name -n

Collection name.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Output format.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az cosmosdb mongodb collection update

Editar

Actualice una colección de MongoDB en una base de datos de MongoDB de Azure Cosmos DB.

az cosmosdb mongodb collection update --account-name
                                      --database-name
                                      --name
                                      --resource-group
                                      [--analytical-storage-ttl]
                                      [--idx]

Parámetros requeridos

--account-name -a

Nombre de la cuenta de Cosmosdb.

--database-name -d

Database name.

--name -n

Collection name.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros opcionales

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--analytical-storage-ttl

TTL analítico, cuando se habilita el almacenamiento analítico.

--idx

Índices, puede escribirlo como una cadena o como un archivo, Por ejemplo, --idx @indexes-file.json o --idx "[{"key": {"keys": ["_ts"]},"options": {"expireAfterSeconds": 1000}}, {"key": {"keys": ["user_id", "user_address"]}, "options": {"unique": "true"}}]".

Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Output format.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False