az cosmosdb mongodb collection

  • Ссылка

Примечание.

Эта группа команд содержит команды, определенные как в Azure CLI, так и в одном расширении. Установите каждое расширение, чтобы воспользоваться расширенными возможностями. Подробнее о расширениях.

Управление коллекциями MongoDB Azure Cosmos DB.

Команды

Имя Описание Тип Состояние
az cosmosdb mongodb collection create

Создайте коллекцию MongoDB в базе данных MongoDB Azure Cosmos DB.

 Основные сведения Общедоступная версия
az cosmosdb mongodb collection delete

Удалите коллекцию MongoDB в базе данных MongoDB Azure Cosmos DB.

 Основные сведения Общедоступная версия
az cosmosdb mongodb collection exists

Проверяет, существует ли коллекция MongoDB Azure Cosmos DB.

 Основные сведения Общедоступная версия
az cosmosdb mongodb collection list

Перечислите коллекции MongoDB в базе данных MongoDB Azure Cosmos DB.

 Основные сведения Общедоступная версия
az cosmosdb mongodb collection merge

Объединяет секции коллекции mongodb.

 Расширение Предварительный просмотр
az cosmosdb mongodb collection redistribute-partition-throughput

Перераспределяет пропускную способность секции коллекции mongodb.

 Расширение Предварительный просмотр
az cosmosdb mongodb collection restore

Восстановите удаленную коллекцию mongodb в той же учетной записи.

 Основные сведения Общедоступная версия
az cosmosdb mongodb collection restore (cosmosdb-preview Расширение)

Восстановите удаленную коллекцию mongodb в той же учетной записи.

 Расширение Предварительный просмотр
az cosmosdb mongodb collection retrieve-partition-throughput

Получение пропускной способности секции коллекции mongodb.

 Расширение Предварительный просмотр
az cosmosdb mongodb collection show

Отображение сведений о коллекции MongoDB в базе данных MongoDB Azure Cosmos DB.

 Основные сведения Общедоступная версия
az cosmosdb mongodb collection throughput

Управление пропускной способностью коллекции MongoDB в учетной записи Azure Cosmos DB.

 Основные сведения Общедоступная версия
az cosmosdb mongodb collection throughput migrate

Перенос пропускной способности коллекции MongoDB между автомасштабированием и подготовкой вручную.

 Основные сведения Общедоступная версия
az cosmosdb mongodb collection throughput show

Получение пропускной способности коллекции MongoDB в базе данных MongoDB Azure Cosmos DB.

 Основные сведения Общедоступная версия
az cosmosdb mongodb collection throughput update

Обновите пропускную способность коллекции MongoDB в базе данных MongoDB Azure Cosmos DB.

 Основные сведения Общедоступная версия
az cosmosdb mongodb collection update

Обновите коллекцию MongoDB в базе данных MongoDB Azure Cosmos DB.

 Основные сведения Общедоступная версия

az cosmosdb mongodb collection create

Изменить

Создайте коллекцию MongoDB в базе данных MongoDB Azure Cosmos DB.

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

Примеры

Создайте коллекцию MongoDB Для Azure Cosmos DB.

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

Обязательные параметры

--account-name -a

Имя учетной записи Cosmosdb.

--database-name -d

имя базы данных.

--name -n

Имя коллекции.

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

Необязательные параметры

--analytical-storage-ttl

Аналитическое TTL, если включено аналитическое хранилище.

--idx

Индексы можно ввести в виде строки или в виде файла. Например, --idx или --idx @indexes-file.json "[{"key": {"keys": ["_ts"]},"options": {"expireAfterSeconds": 1000}}, {"key": {"keys": ["user_id"", "user_address"]}, "options": {"unique": "true"}}".

--max-throughput

Максимальный ресурс пропускной способности может масштабироваться до (ЕЗ/с). Предоставляется при включении автомасштабирования ресурса. Минимальное значение может быть равно 4000 (ЕЗ/с).

--shard

Путь к ключу сегментирования.

--throughput

Пропускная способность коллекции MongoDB (ЕЗ/с). Значение по умолчанию — 400. Не укажите этот параметр, если база данных имеет общую пропускную способность, если коллекция не должна иметь выделенную пропускную способность.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az cosmosdb mongodb collection delete

Изменить

Удалите коллекцию MongoDB в базе данных MongoDB Azure Cosmos DB.

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

Обязательные параметры

--account-name -a

Имя учетной записи Cosmosdb.

--database-name -d

имя базы данных.

--name -n

Имя коллекции.

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

Необязательные параметры

--yes -y

Не запрашивать подтверждение.

значение по умолчанию: False
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az cosmosdb mongodb collection exists

Изменить

Проверяет, существует ли коллекция MongoDB Azure Cosmos DB.

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

Обязательные параметры

--account-name -a

Имя учетной записи Cosmosdb.

--database-name -d

имя базы данных.

--name -n

Имя коллекции.

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az cosmosdb mongodb collection list

Изменить

Перечислите коллекции MongoDB в базе данных MongoDB Azure Cosmos DB.

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

Обязательные параметры

--account-name -a

Имя учетной записи Cosmosdb.

--database-name -d

имя базы данных.

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az cosmosdb mongodb collection merge

Предварительный просмотр

Эта команда находится в предварительной версии и находится в процессе разработки. Уровни ссылок и поддержки: https://aka.ms/CLI_refstatus

Объединяет секции коллекции mongodb.

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

Примеры

объединение секций коллекции my-mongodb-collection

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

Обязательные параметры

--account-name -a

Имя учетной записи базы данных CosmosDB.

--database-name -d

Имя базы данных MongoDB.

--name -n

Имя коллекции mongoDB.

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az cosmosdb mongodb collection redistribute-partition-throughput

Предварительный просмотр

Эта команда находится в предварительной версии и находится в процессе разработки. Уровни ссылок и поддержки: https://aka.ms/CLI_refstatus

Перераспределяет пропускную способность секции коллекции 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]

Примеры

Равномерно распределяет пропускную способность секции для коллекции mongodb среди всех физических секций.

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

Распространение пропускной способности секции для коллекции mongodb из исходных секций в целевые секции

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'

Обязательные параметры

--account-name -a

Имя учетной записи базы данных CosmosDB.

--database-name -d

Имя имени базы данных CosmosDB.

--name -n

Имя коллекции CosmosDB.

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

Необязательные параметры

--evenly-distribute

Переключитесь на распределение пропускной способности одинаково между всеми физическими секциями.

допустимые значения: false, true
значение по умолчанию: False
--source-partition-info

Идентификаторы физической секции, разделенные пространством, например 1 2.

значение по умолчанию: []
--target-partition-info

Сведения о требуемой пропускной способности физической секции: "0=1200 1=1200".

значение по умолчанию: []
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az cosmosdb mongodb collection restore

Изменить

Восстановите удаленную коллекцию mongodb в той же учетной записи.

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

Примеры

Восстановите удаленную коллекцию mongodb в той же учетной записи.

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

Обязательные параметры

--account-name -a

Имя учетной записи Cosmosdb.

--database-name -d

имя базы данных.

--name -n

Имя коллекции.

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

Необязательные параметры

--restore-timestamp -t

Метка времени, в которую необходимо восстановить коллекцию.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az cosmosdb mongodb collection restore (cosmosdb-preview Расширение)

Предварительный просмотр

Эта команда находится в предварительной версии и находится в процессе разработки. Уровни ссылок и поддержки: https://aka.ms/CLI_refstatus

Восстановите удаленную коллекцию mongodb в той же учетной записи.

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

Примеры

Восстановите удаленную коллекцию mongodb в той же учетной записи.

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

Обязательные параметры

--account-name -a

Имя учетной записи Cosmosdb.

--database-name -d

имя базы данных.

--name -n

Имя коллекции.

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

Необязательные параметры

--disable-ttl
Предварительный просмотр

Включите или отключите восстановление с отключенным ttl.

допустимые значения: false, true
--restore-timestamp -t

Метка времени, в которую необходимо восстановить коллекцию.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az cosmosdb mongodb collection retrieve-partition-throughput

Предварительный просмотр

Эта команда находится в предварительной версии и находится в процессе разработки. Уровни ссылок и поддержки: https://aka.ms/CLI_refstatus

Получение пропускной способности секции коллекции mongodb.

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

Примеры

Получение пропускной способности контейнера container_name для определенных физических секций

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

Получение пропускной способности контейнера container_name для всех физических секций

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

Обязательные параметры

--account-name -a

Имя учетной записи базы данных CosmosDB.

--database-name -d

Имя имени базы данных CosmosDB.

--name -n

Имя контейнера CosmosDB.

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

Необязательные параметры

--all-partitions

Переключитесь, чтобы получить пропускную способность для всех физических секций.

допустимые значения: false, true
значение по умолчанию: False
--physical-partition-ids -p

Разделенный пробелом список идентификаторов физических разделов.

значение по умолчанию: []
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az cosmosdb mongodb collection show

Изменить

Отображение сведений о коллекции MongoDB в базе данных MongoDB Azure Cosmos DB.

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

Обязательные параметры

--account-name -a

Имя учетной записи Cosmosdb.

--database-name -d

имя базы данных.

--name -n

Имя коллекции.

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az cosmosdb mongodb collection update

Изменить

Обновите коллекцию MongoDB в базе данных MongoDB Azure Cosmos DB.

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

Обязательные параметры

--account-name -a

Имя учетной записи Cosmosdb.

--database-name -d

имя базы данных.

--name -n

Имя коллекции.

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

Необязательные параметры

--analytical-storage-ttl

Аналитическое TTL, если включено аналитическое хранилище.

--idx

Индексы можно ввести в виде строки или в виде файла. Например, --idx или --idx @indexes-file.json "[{"key": {"keys": ["_ts"]},"options": {"expireAfterSeconds": 1000}}, {"key": {"keys": ["user_id"", "user_address"]}, "options": {"unique": "true"}}".

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.