az cosmosdb service

Note

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

Команды для выполнения операций со службой.

Команды

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

Создайте ресурс службы Cosmosdb.

 Core GA
az cosmosdb service create (cosmosdb-preview Расширение)

Создайте ресурс службы Cosmosdb.

 Extension Preview
az cosmosdb service delete

Удалите указанный ресурс службы Cosmosdb.

 Core GA
az cosmosdb service delete (cosmosdb-preview Расширение)

Удалите указанный ресурс службы Cosmosdb.

 Extension Preview
az cosmosdb service list

Перечислите весь ресурс службы Cosmosdb в учетной записи.

 Core GA
az cosmosdb service list (cosmosdb-preview Расширение)

Перечислите весь ресурс службы Cosmosdb в учетной записи.

 Extension Preview
az cosmosdb service show

Получите ресурс службы Cosmosdb в учетной записи.

 Core GA
az cosmosdb service show (cosmosdb-preview Расширение)

Получите ресурс службы Cosmosdb в учетной записи.

 Extension Preview
az cosmosdb service update

Обновите ресурс службы Cosmosdb.

 Core GA
az cosmosdb service update (cosmosdb-preview Расширение)

Обновите ресурс службы Cosmosdb.

 Extension Preview

az cosmosdb service create

Изменить

Создайте ресурс службы Cosmosdb.

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

Примеры

Создайте ресурс службы Cosmosdb.

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

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

--account-name -a

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

--name -n

Имя службы.

--resource-group-name -g

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

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

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Политика Azure для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--count -c

Число экземпляров.

Свойство Значение
Default value: 1
--gateway-type

Тип выделенного шлюза. Допустимо только для типа службы SqlDedicatedGateway.

Свойство Значение
Default value: IntegratedCache
Допустимые значения: DistributedQuery, IntegratedCache
--no-wait

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

Свойство Значение
Default value: False
--size

Размер экземпляра. Возможные значения: Cosmos.D4s, Cosmos.D8s, Cosmos.D16s и т. д.

Свойство Значение
Default value: Cosmos.D4s
Глобальные параметры
--debug

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

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

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

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Свойство Значение
Default value: False

az cosmosdb service create (cosmosdb-preview Расширение)

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

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

Создайте ресурс службы Cosmosdb.

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

Примеры

Создайте ресурс службы Cosmosdb.

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

Создайте ресурс службы построителя материализованных представлений cosmosdb.

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

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

--account-name -a

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

--kind -k

Тип службы.

--name -n

Имя службы.

--resource-group-name -g

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

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

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Политика Azure для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--count -c

Число экземпляров.

Свойство Значение
Default value: 1
--gateway-type

Тип выделенного шлюза. Допустимо только для типа службы SqlDedicatedGateway.

Свойство Значение
Default value: IntegratedCache
Допустимые значения: DistributedQuery, IntegratedCache
--no-wait

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

Свойство Значение
Default value: False
--size

Размер экземпляра. Возможные значения: Cosmos.D4s, Cosmos.D8s, Cosmos.D16s и т. д.

Свойство Значение
Default value: Cosmos.D4s
Глобальные параметры
--debug

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

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

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

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Свойство Значение
Default value: False

az cosmosdb service delete

Изменить

Удалите указанный ресурс службы Cosmosdb.

az cosmosdb service delete --account-name
                           --name
                           --resource-group-name
                           [--acquire-policy-token]
                           [--change-reference]
                           [--no-wait]
                           [--yes]

Примеры

Удалите указанный ресурс службы Cosmosdb.

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

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

--account-name -a

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

--name -n

Имя службы.

--resource-group-name -g

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

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

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Политика Azure для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--no-wait

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

Свойство Значение
Default value: False
--yes -y

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

Свойство Значение
Default value: False
Глобальные параметры
--debug

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

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

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

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Свойство Значение
Default value: False

az cosmosdb service delete (cosmosdb-preview Расширение)

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

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

Удалите указанный ресурс службы Cosmosdb.

az cosmosdb service delete --account-name
                           --name
                           --resource-group-name
                           [--acquire-policy-token]
                           [--change-reference]
                           [--no-wait]
                           [--yes]

Примеры

Удалите указанный ресурс службы Cosmosdb.

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

Удалите ресурс службы построителя материализованных представлений cosmosdb.

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

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

--account-name -a

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

--name -n

Имя службы.

--resource-group-name -g

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

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

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Политика Azure для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--no-wait

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

Свойство Значение
Default value: False
--yes -y

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

Свойство Значение
Default value: False
Глобальные параметры
--debug

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

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

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

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Свойство Значение
Default value: False

az cosmosdb service list

Изменить

Перечислите весь ресурс службы Cosmosdb в учетной записи.

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

Примеры

Перечислите весь ресурс службы Cosmosdb в учетной записи.

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

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

--account-name -a

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

--resource-group-name -g

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

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

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

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

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

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Свойство Значение
Default value: False

az cosmosdb service list (cosmosdb-preview Расширение)

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

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

Перечислите весь ресурс службы Cosmosdb в учетной записи.

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

Примеры

Перечислите весь ресурс службы Cosmosdb в учетной записи.

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

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

--account-name -a

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

--resource-group-name -g

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

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

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

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

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

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Свойство Значение
Default value: False

az cosmosdb service show

Изменить

Получите ресурс службы Cosmosdb в учетной записи.

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

Примеры

Получите ресурс службы Cosmosdb в учетной записи.

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

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

--account-name -a

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

--name -n

Имя службы.

--resource-group-name -g

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

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

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

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

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

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Свойство Значение
Default value: False

az cosmosdb service show (cosmosdb-preview Расширение)

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

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

Получите ресурс службы Cosmosdb в учетной записи.

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

Примеры

Получите ресурс службы Cosmosdb в учетной записи.

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

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

--account-name -a

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

--name -n

Имя службы.

--resource-group-name -g

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

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

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

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

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

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Свойство Значение
Default value: False

az cosmosdb service update

Изменить

Обновите ресурс службы Cosmosdb.

az cosmosdb service update --account-name
                           --count
                           --name
                           --resource-group-name
                           [--acquire-policy-token]
                           [--change-reference]
                           [--no-wait]
                           [--size]

Примеры

Обновите ресурс службы Cosmosdb.

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

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

--account-name -a

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

--count -c

Число экземпляров.

--name -n

Имя службы.

--resource-group-name -g

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

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

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Политика Azure для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--no-wait

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

Свойство Значение
Default value: False
--size

Размер экземпляра. Возможные значения: Cosmos.D4s, Cosmos.D8s, Cosmos.D16s и т. д.

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

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

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

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

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Свойство Значение
Default value: False

az cosmosdb service update (cosmosdb-preview Расширение)

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

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

Обновите ресурс службы Cosmosdb.

az cosmosdb service update --account-name
                           --count
                           --kind
                           --name
                           --resource-group-name
                           [--acquire-policy-token]
                           [--change-reference]
                           [--no-wait]
                           [--size]

Примеры

Обновите ресурс службы Cosmosdb.

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

Обновите ресурс службы построителя материализованных представлений cosmosdb.

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

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

--account-name -a

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

--count -c

Число экземпляров.

--kind -k

Тип службы.

--name -n

Имя службы.

--resource-group-name -g

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

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

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Политика Azure для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--no-wait

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

Свойство Значение
Default value: False
--size

Размер экземпляра. Возможные значения: Cosmos.D4s, Cosmos.D8s, Cosmos.D16s и т. д.

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

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

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

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

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Свойство Значение
Default value: False