Azure Cosmos DB (облачная база данных)
Azure Cosmos DB — это глобально распределенная служба базы данных с несколькими моделями, предназначенная для обеспечения эластичного и независимого масштабирования пропускной способности и хранилища в любом количестве географических регионов с комплексным соглашением об уровне обслуживания.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | Class | Регионы |
|---|---|---|
| Copilot Studio | Премия | Все Power Automate регионы |
| Логические приложения | Стандарт | Все регионы Logic Apps |
| Power Apps | - | Недоступно |
| Power Automate | Премия | Все Power Automate регионы |
| Метаданные соединителя | |
|---|---|
| Publisher | Microsoft |
Чтобы использовать эту интеграцию, вам потребуется учетная запись API SQL Cosmos DB, настроенная на портале Azure. Обратите внимание, что учетные записи API Mongo DB в настоящее время не поддерживаются.
После создания учетной записи API SQL укажите идентификатор учетной записи (без documents.azure.com) при создании подключения к соединителю Azure Cosmos DB при создании подключения типа Access Key . Этот идентификатор учетной записи также необходим для новых версий операций, поддерживающих проверку подлинности идентификатора Microsoft Entra.
Проверка подлинности идентификатора Microsoft Entra и соединитель Cosmos DB
Чтобы использовать проверку подлинности идентификатора Microsoft Entra, учетная запись, используемая должна быть назначена определенному назначению ролей, дополнительные сведения см. в статье "Настройка управления доступом на основе ролей с помощью идентификатора Microsoft Entra для учетной записи Azure Cosmos DB".
Замечание
Только роли , явно определенные для доступа к данным, позволяют субъекту безопасности получать доступ к данным Cosmos DB. Встроенные роли, например Owner, или Contributorне предоставляют доступ к данным Cosmos DB в этой учетной записи с помощью идентификатора Microsoft Entra. Существуют 2 встроенные роли, предоставляемые Azure Cosmos DB:
-
Cosmos DB Built-in Data Reader(идентификатор00000000-0000-0000-0000-000000000001определения роли) -
Cosmos DB Built-in Data Contributor(идентификатор00000000-0000-0000-0000-000000000002определения роли)
Роли можно назначать множество способов и создавать пользовательские роли для более детального доступа.
Ниже приведен пример назначения Cosmos DB Built-in Data Reader с помощью PowerShell (дополнительные сведения об этой команде New-AzCosmosDBSqlRoleAssignment):
$resourceGroupName = "<myResourceGroup>"
$accountName = "<myCosmosAccount>"
$principalId = "<myPrincipalId>"
$roleDefinitionId = "/subscriptions/<<mySubscription>>/resourceGroups/<<myResourceGroup>>/providers/Microsoft.DocumentDB/databaseAccounts/<<myCosmosAccount>>/sqlRoleDefinitions/00000000-0000-0000-0000-000000000001"
New-AzCosmosDBSqlRoleAssignment -AccountName $accountName `
-ResourceGroupName $resourceGroupName `
-RoleDefinitionId $roleDefinitionId `
-PrincipalId $principalId `
-AssignableScope "/"
Сбой добавления этих назначений ролей в конечном итоге приведет к несанкционированным запросам, таким как это: Request is blocked because principal [<<principal-id>>] does not have the required RBAC permissions to perform action <unauthorized actions>.
Замечание
Azure Cosmos DB не поддерживает какие-либо операции управления с проверкой подлинности идентификатора Microsoft Entra (описано здесь). Следующие операции будут работать только с подключениями Access Key :
- Создание хранимой процедуры (версии 1 и версии 2)
- Удаление хранимой процедуры (версии 1 и версии 2)
- Обновление хранимой процедуры (версии 1 и версии 2)
Операции, не поддерживаемые проверкой подлинности идентификатора Microsoft Entra
При использовании проверки подлинности Идентификатора Microsoft Entra поддерживаются только действия с именем учетной записи Cosmos DB в качестве параметра. Устаревшие действия будут продолжать работать с Access Key проверкой подлинности, но при использовании с подключением идентификатора Microsoft Entra ID завершится ошибкой.
Известные проблемы и ограничения
Максимальный размер документа, поддерживаемого соединителем DocumentDB (Azure Cosmos DB), составляет 2 МБ.
Ограничения Azure Cosmos DB описаны здесь.
Выбор региона записи и нескольких регионов записи не поддерживается соединителем.
Значение ключа секции должно быть предоставлено в соответствии с его типом. Например, строковое значение должно быть заключено в кавычки, число должно быть указано как есть. Например: "строковое значение", 123, 0.5.
Значение ключа секции требуется для запросов с
ORDER BYDISTINCTи т. д., которые выполняются в секционированных коллекциях.Запрос документов версии 2 [DEPRECATED], запрос документов версии 3, получение всех документов версии 2 (предварительная версия) использует пакет SDK для .NET Azure Cosmos DB для API SQL (версия 2.13.1).
Действие запроса документов версии 4 (предварительная версия) использует пакет SDK для .NET Azure Cosmos DB для API SQL (версия 3.15.0).
Действие запроса документов (V5) (предварительная версия) использует пакет SDK для .NET Azure Cosmos DB для API SQL (версия 3.20.0).
Значение параметра Max Item Count может быть любым числом от 1 до 1000. Любое число за пределами этого диапазона будет неявно преобразовано в "-1", которое сообщает службе Cosmos DB определить оптимальное количество элементов.
Если осталось пустым, следующие операции будут работать только с документами, не имеющими значения ключа секции. Элементы со значением ключа секции будут исключены из этих действий.
Из-за того, что Azure Cosmos DB не поддерживает какие-либо операции управления с проверкой подлинности идентификатора Microsoft Entra (описано здесь), операция Execute stored procedure (V2) (предварительная версия) будет отображать только доступные хранимые процедуры (для
SprocIdпараметра) при использованииAccess Keyподключения на основе.TokenНа основе проверки подлинности (проверки подлинности идентификатора Microsoft Entra) отображается пустой список, иsprocIdего следует вводить вручную в качестве настраиваемого значения.
Это важно
Встроенные подключения Microsoft Entra ID (Azure Commercial) отключены в средах GCC для государственных организаций США по умолчанию. Чтобы включить эти типы подключений, параметр Подключения к коммерческой службе Azure должен быть включен в Центре администрирования Power Platform администратором клиента.
Включение этого параметра позволяет подключаться к ресурсам в коммерческой службе Azure, которые работают и отправляют данные за пределы соответствия требованиям Power Platform ДЛЯ государственных организаций США. Это специально используется для предоставления доступа к коммерческим ресурсам из облачных версий GCC соединителей Power Platform.
Microsoft Entra ID Integrated (Azure Commercial) — это единственный тип проверки подлинности, который работает из сред US Для государственных организаций (GCC) в коммерческие ресурсы Azure.
Коммерческая проверка подлинности Azure отключена по 
Параметр "Подключение к коммерческой сети Azure" в Центре 
Power Platform: представление администратора
Создание подключения
Соединитель поддерживает следующие типы проверки подлинности:
| ключа доступа | Укажите имя учетной записи и ключ доступа для доступа к учетной записи Cosmos DB. | Все регионы, кроме Azure для государственных организаций и министерства обороны (DoD) в Azure для государственных организаций и государственных организаций США (GCC) и государственных организаций США (GCC-High) | Доступный для общего пользования |
| Ключ доступа (Azure для государственных организаций) | Укажите имя учетной записи и ключ доступа для доступа к учетной записи Cosmos DB. | Azure для государственных организаций и министерства обороны (DoD) в Azure для государственных организаций и государственных организаций США (GCC) и правительства США (GCC-High) только | Доступный для общего пользования |
| Управляемое удостоверение Logic Apps | Создание подключения с помощью управляемого удостоверения LogicApps | Только LOGICAPPS | Доступный для общего пользования |
| Интегрированный идентификатор Microsoft Entra | Используйте идентификатор Microsoft Entra для доступа к хранилищу BLOB-объектов Azure. | Все регионы, кроме Azure для государственных организаций и министерства обороны (DoD) в Azure для государственных организаций и государственных организаций США (GCC) и государственных организаций США (GCC-High) | Недоступен для совместного использования |
| Интегрированная идентификатора Microsoft Entra (коммерческая служба Azure) | Используйте идентификатор Microsoft Entra для доступа к хранилищу BLOB-объектов Azure в коммерческой службе Azure. | Только правительство США (GCC) | Недоступен для совместного использования |
| Интегрированная идентификатора Microsoft Entra (Azure для государственных организаций) | Используйте идентификатор Microsoft Entra для доступа к хранилищу BLOB-объектов Azure. | Azure для государственных организаций и министерства обороны (DoD) в Azure для государственных организаций и государственных организаций США (GCC) и правительства США (GCC-High) только | Недоступен для совместного использования |
| По умолчанию [не рекомендуется] | Этот параметр предназначен только для старых подключений без явного типа проверки подлинности и предоставляется только для обратной совместимости. | Все регионы | Недоступен для совместного использования |
Ключ доступа
Идентификатор проверки подлинности: keyBasedAuth
Применимо: все регионы, кроме Azure для государственных организаций и министерства обороны (DoD) в Azure для государственных организаций и государственных организаций США (GCC) и сша (GCC-High)
Укажите имя учетной записи и ключ доступа для доступа к учетной записи Cosmos DB.
Это совместное подключение. Если приложение power app предоставлено другому пользователю, подключение также предоставляется совместно. Дополнительные сведения см. в обзоре соединителей для приложений на основе холста — Power Apps | Документация Майкрософт
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| ID счета | струна | Имя учетной записи без части "documents.azure.com" | True |
| Ключ доступа к учетной записи Azure Cosmos DB | securestring | Первичный или вторичный ключ | True |
Ключ доступа (Azure для государственных организаций)
Идентификатор проверки подлинности: keyBasedAuth
Применимо: Azure для государственных организаций и министерства обороны (DoD) в Azure для государственных организаций и государственных организаций США (GCC) и правительства США (GCC-High) только
Укажите имя учетной записи и ключ доступа для доступа к учетной записи Cosmos DB.
Это совместное подключение. Если приложение power app предоставлено другому пользователю, подключение также предоставляется совместно. Дополнительные сведения см. в обзоре соединителей для приложений на основе холста — Power Apps | Документация Майкрософт
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| ID счета | струна | Имя учетной записи без части "documents.azure.com" | True |
| Ключ доступа к учетной записи Azure Cosmos DB | securestring | Первичный или вторичный ключ | True |
Управляемое удостоверение Logic Apps
Идентификатор проверки подлинности: managedIdentityAuth
Применимо: только LOGICAPPS
Создание подключения с помощью управляемого удостоверения LogicApps
Это совместное подключение. Если приложение power app предоставлено другому пользователю, подключение также предоставляется совместно. Дополнительные сведения см. в обзоре соединителей для приложений на основе холста — Power Apps | Документация Майкрософт
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| Управляемое удостоверение LogicApps | управляемая идентичность | Вход с помощью управляемого удостоверения Logic Apps | True |
Microsoft Entra id Integrated
Идентификатор проверки подлинности: tokenBasedAuth
Применимо: все регионы, кроме Azure для государственных организаций и министерства обороны (DoD) в Azure для государственных организаций и государственных организаций США (GCC) и сша (GCC-High)
Используйте идентификатор Microsoft Entra для доступа к хранилищу BLOB-объектов Azure.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
Интегрированная идентификатора Microsoft Entra (коммерческая служба Azure)
Идентификатор проверки подлинности: oauthCom
Применимо: только правительство США (GCC)
Используйте идентификатор Microsoft Entra для доступа к хранилищу BLOB-объектов Azure в коммерческой службе Azure.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
Интегрированная идентификатора Microsoft Entra (Azure для государственных организаций)
Идентификатор проверки подлинности: tokenBasedAuth
Применимо: Azure для государственных организаций и министерства обороны (DoD) в Azure для государственных организаций и государственных организаций США (GCC) и правительства США (GCC-High) только
Используйте идентификатор Microsoft Entra для доступа к хранилищу BLOB-объектов Azure.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
По умолчанию [не рекомендуется]
Применимо: все регионы
Этот параметр предназначен только для старых подключений без явного типа проверки подлинности и предоставляется только для обратной совместимости.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| ID счета | струна | Имя учетной записи без части "documents.azure.com" | True |
| Ключ доступа к учетной записи Azure Cosmos DB | securestring | Первичный или вторичный ключ | True |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 1500 | 60 секунд |
Действия
| Выполнение хранимой процедуры (версия 2) |
Выполните хранимую процедуру в указанной коллекции (V2). |
| Выполнение хранимой процедуры [DEPRECATED] |
Это действие устарело. Вместо этого используйте хранимую процедуру execute (V2).
|
| Замена документа (версия 2) |
Замените документ (версия 2). |
| Замена документа [не рекомендуется] |
Это действие устарело. Вместо этого используйте документ замены (V2 ).
|
| Замена хранимой процедуры (версия 2) |
Замените хранимую процедуру (версия 2). |
| Замена хранимой процедуры [DEPRECATED] |
Это действие устарело. Вместо этого используйте хранимую процедуру замены (V2 ).
|
| Запрос документов [DEPRECATED] |
Это действие устарело. Вместо этого используйте документы запроса версии 5 .
|
| Запрос документов V5 |
Запрос документов (V5). |
| Запрос документов версии 2 [НЕ РЕКОМЕНДУЕТСЯ] |
Это действие устарело. Вместо этого используйте документы запроса версии 5 .
|
| Запрос документов версии 3 [НЕ РЕКОМЕНДУЕТСЯ] |
Это действие устарело. Вместо этого используйте документы запроса версии 5 .
|
| Запрос документов версии 4 [НЕ РЕКОМЕНДУЕТСЯ] |
Это действие устарело. Вместо этого используйте документы запроса версии 5 .
|
| Получение всех документов (версия 3) |
Получение всех документов (V3). |
| Получение всех документов [DEPRECATED] |
Это действие устарело. Вместо этого используйте команду Get all documents (V3).
|
| Получение всех документов версии 2 [НЕ РЕКОМЕНДУЕТСЯ] |
Это действие устарело. Вместо этого используйте команду Get all documents (V3).
|
| Получение документа (версия 2) |
Получение документа (версия 2). |
| Получение документа [DEPRECATED] |
Это действие устарело. Вместо этого используйте документ (V2).
|
| Получение хранимых процедур (версия 2) |
Получение хранимых процедур в указанной коллекции (версия 2). |
| Получение хранимых процедур [DEPRECATED] |
Это действие устарело. Вместо этого используйте хранимые процедуры (V2).
|
| Создание или обновление документа (V3) |
Создание или обновление документа. При создании документа в DocumentDB текст должен содержать свойство идентификатора. |
| Создание или обновление документа (версия 2) [DEPRECATED] |
Это действие устарело. Вместо этого используйте документ create or update (V3).
|
| Создание или обновление документа [DEPRECATED] |
Это действие устарело. Вместо этого используйте документ create or update (V3).
|
| Создание хранимой процедуры (версия 2) |
Создайте хранимую процедуру (версия 2). |
| Создание хранимой процедуры [DEPRECATED] |
Это действие устарело. Вместо этого используйте хранимую процедуру (V2).
|
| Удаление документа (версия 2) |
Удаление документа (версия 2). |
| Удаление документа [DEPRECATED] |
Это действие устарело. Вместо этого используйте документ delete (V2).
|
| Удаление хранимой процедуры (версия 2) |
Удаление хранимой процедуры (версия 2). |
| Удаление хранимой процедуры [DEPRECATED] |
Это действие устарело. Вместо этого используйте хранимую процедуру удаления (V2 ).
|
Выполнение хранимой процедуры (версия 2)
Выполните хранимую процедуру в указанной коллекции (V2).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя учетной записи Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Имя учетной записи Azure Cosmos DB (без documents.azure.com). |
|
Идентификатор базы данных
|
databaseId | True | string |
Имя базы данных. |
|
Идентификатор коллекции
|
collectionId | True | string |
Имя коллекции. |
|
Значение ключа секции
|
x-ms-documentdb-raw-partitionkey | string |
Значение ключа секции для запрошенной операции документа или вложения. |
|
|
Идентификатор Sproc
|
sprocId | True | string |
Имя хранимой процедуры. |
|
Параметры хранимой процедуры
|
parameters | string |
Укажите допустимый JSON для параметров хранимой процедуры, например ["param1", "param2"]. |
|
|
Версия API
|
x-ms-version | string |
Версия API. |
Возвращаемое значение
- response
- ObjectWithoutType
Выполнение хранимой процедуры [DEPRECATED]
Это действие устарело. Вместо этого используйте хранимую процедуру execute (V2).
Выполните хранимую процедуру в указанной коллекции.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор базы данных
|
databaseId | True | string |
Имя базы данных. |
|
Идентификатор коллекции
|
collectionId | True | string |
Имя коллекции. |
|
Значение ключа секции
|
x-ms-documentdb-raw-partitionkey | string |
Значение ключа секции для запрошенной операции документа или вложения. |
|
|
Идентификатор Sproc
|
sprocId | True | string |
Имя хранимой процедуры. |
|
Параметры хранимой процедуры
|
parameters | string |
Укажите допустимый JSON для параметров хранимой процедуры, например ["param1", "param2"]. |
|
|
Версия API
|
x-ms-version | string |
Версия API. |
Возвращаемое значение
- response
- ObjectWithoutType
Замена документа (версия 2)
Замените документ (версия 2).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Значение ключа секции
|
x-ms-documentdb-raw-partitionkey | string |
Значение ключа секции для запрошенной операции документа или вложения. |
|
|
Максимальное число элементов
|
x-ms-max-item-count | number |
Целое число, указывающее максимальное количество возвращаемых элементов на страницу. |
|
|
Токен продолжения
|
x-ms-continuation | string |
Строковый маркер, возвращаемый для запросов и операций веб-канала чтения, если требуется прочитать больше результатов. |
|
|
Уровень согласованности
|
x-ms-consistency-level | string |
Это переопределение уровня согласованности. Допустимые значения: Strong, Bounded, Session или Eventual (в порядке наиболее сильных и слабых). |
|
|
Токен сеанса
|
x-ms-session-token | string |
Строковый маркер, используемый с согласованность уровня сеанса. |
|
|
Идентификатор действия
|
x-ms-activity-id | string |
Предоставленный клиентом идентификатор операции, который будет отклочен в ответе сервера. |
|
|
Предварительный триггер
|
x-ms-documentdb-pre-trigger-include | string |
Разделенный запятыми список имен триггеров, выполняемых перед выполнением операции документа. |
|
|
После триггера
|
x-ms-documentdb-post-trigger-include | string |
Разделенный запятыми список имен триггеров, выполняемых после выполнения операции документа. |
|
|
Имя учетной записи Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Имя учетной записи Azure Cosmos DB (без documents.azure.com). |
|
Идентификатор базы данных
|
databaseId | True | string |
Имя базы данных. |
|
Идентификатор коллекции
|
collectionId | True | string |
Имя коллекции. |
|
Идентификатор документа
|
documentId | True | string |
Идентификатор документа. |
|
Версия API
|
x-ms-version | string |
Версия API. |
Возвращаемое значение
- Тело
- putDocumentResponse
Замена документа [не рекомендуется]
Это действие устарело. Вместо этого используйте документ замены (V2 ).
Замените документ.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Значение ключа секции
|
x-ms-documentdb-raw-partitionkey | string |
Значение ключа секции для запрошенной операции документа или вложения. |
|
|
Максимальное число элементов
|
x-ms-max-item-count | number |
Целое число, указывающее максимальное количество возвращаемых элементов на страницу. |
|
|
Токен продолжения
|
x-ms-continuation | string |
Строковый маркер, возвращаемый для запросов и операций веб-канала чтения, если требуется прочитать больше результатов. |
|
|
Уровень согласованности
|
x-ms-consistency-level | string |
Это переопределение уровня согласованности. Допустимые значения: Strong, Bounded, Session или Eventual (в порядке наиболее сильных и слабых). |
|
|
Токен сеанса
|
x-ms-session-token | string |
Строковый маркер, используемый с согласованность уровня сеанса. |
|
|
Идентификатор действия
|
x-ms-activity-id | string |
Предоставленный клиентом идентификатор операции, который будет отклочен в ответе сервера. |
|
|
Предварительный триггер
|
x-ms-documentdb-pre-trigger-include | string |
Разделенный запятыми список имен триггеров, выполняемых перед выполнением операции документа. |
|
|
После триггера
|
x-ms-documentdb-post-trigger-include | string |
Разделенный запятыми список имен триггеров, выполняемых после выполнения операции документа. |
|
|
Идентификатор базы данных
|
databaseId | True | string |
Имя базы данных. |
|
Идентификатор коллекции
|
collectionId | True | string |
Имя коллекции. |
|
Идентификатор документа
|
documentId | True | string |
Идентификатор документа. |
|
Версия API
|
x-ms-version | string |
Версия API. |
Возвращаемое значение
- Тело
- putDocumentResponse
Замена хранимой процедуры (версия 2)
Замените хранимую процедуру (версия 2).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя учетной записи Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Имя учетной записи Azure Cosmos DB (без documents.azure.com). |
|
Идентификатор базы данных
|
databaseId | True | string |
Имя базы данных. |
|
Идентификатор коллекции
|
collectionId | True | string |
Имя коллекции. |
|
Идентификатор Sproc
|
sprocId | True | string |
Имя хранимой процедуры. |
|
Определение функции
|
body | string |
Функция, определяющая хранимую процедуру, например function(params){ ... }' |
|
|
id
|
id | string |
Идентификатор существующей хранимой процедуры. |
|
|
Версия API
|
x-ms-version | string |
Версия API. |
Возвращаемое значение
Замена хранимой процедуры [DEPRECATED]
Это действие устарело. Вместо этого используйте хранимую процедуру замены (V2 ).
Замените хранимую процедуру.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор базы данных
|
databaseId | True | string |
Имя базы данных. |
|
Идентификатор коллекции
|
collectionId | True | string |
Имя коллекции. |
|
Идентификатор Sproc
|
sprocId | True | string |
Имя хранимой процедуры. |
|
Определение функции
|
body | string |
Функция, определяющая хранимую процедуру, например function(params){ ... }' |
|
|
id
|
id | string |
Идентификатор существующей хранимой процедуры. |
|
|
Версия API
|
x-ms-version | string |
Версия API. |
Возвращаемое значение
Запрос документов [DEPRECATED]
Это действие устарело. Вместо этого используйте документы запроса версии 5 .
Запрос документов.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Значение ключа секции
|
x-ms-documentdb-raw-partitionkey | string |
Значение ключа секции для запрошенной операции документа или вложения. |
|
|
Максимальное число элементов
|
x-ms-max-item-count | number |
Целое число, указывающее максимальное количество возвращаемых элементов на страницу. |
|
|
Токен продолжения
|
x-ms-continuation | string |
Строковый маркер, возвращаемый для запросов и операций веб-канала чтения, если требуется прочитать больше результатов. |
|
|
Включение перекрестной секции
|
x-ms-documentdb-query-enablecrosspartition | boolean |
Если коллекция секционирована, необходимо задать значение True, чтобы разрешить выполнение между несколькими секциями. |
|
|
Уровень согласованности
|
x-ms-consistency-level | string |
Это переопределение уровня согласованности. Допустимые значения: Strong, Bounded, Session или Eventual (в порядке наиболее сильных и слабых). |
|
|
Токен сеанса
|
x-ms-session-token | string |
Строковый маркер, используемый с согласованность уровня сеанса. |
|
|
Идентификатор действия
|
x-ms-activity-id | string |
Предоставленный клиентом идентификатор операции, который будет отклочен в ответе сервера. |
|
|
Идентификатор базы данных
|
databaseId | True | string |
Имя базы данных. |
|
Идентификатор коллекции
|
collectionId | True | string |
Имя коллекции. |
|
query
|
query | string |
Возвращаемое значение
- Тело
- queryResponse
Запрос документов V5
Запрос документов (V5).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя учетной записи Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Имя учетной записи Azure Cosmos DB (без documents.azure.com). |
|
Идентификатор базы данных
|
databaseId | True | string |
Имя базы данных. |
|
Идентификатор контейнера
|
containerId | True | string |
Имя контейнера. |
|
Запрос синтаксиса SQL
|
queryText | string |
SQL-запрос. Если пусто, возвращает все документы. |
|
|
Значение ключа секции
|
partitionKey | string |
Значение должно быть предоставлено в соответствии с типом ("string", 42, 0.5). Если это пусто, все секции будут использоваться для поиска документов. |
|
|
Максимальное число элементов
|
maxItemCount | integer |
Целое число, указывающее максимальное количество возвращаемых элементов на страницу. |
|
|
Токен продолжения
|
continuationToken | string |
Маркер для получения дополнительных результатов. |
|
|
Уровень согласованности
|
consistencyLevel | string |
Уровень согласованности, необходимый для операции веб-канала (запрос/чтение веб-канала). |
|
|
Токен сеанса
|
sessionToken | string |
Маркер сеанса для использования с согласованность сеансов. |
Возвращаемое значение
Массив документов, соответствующих запрошенным запросам и соответствующим метаданным.
- Тело
- DocumentsCollection
Запрос документов версии 2 [НЕ РЕКОМЕНДУЕТСЯ]
Это действие устарело. Вместо этого используйте документы запроса версии 5 .
Запрос документов версии 2.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор базы данных
|
databaseId | True | string |
Имя базы данных. |
|
Идентификатор коллекции
|
collectionId | True | string |
Имя коллекции. |
|
ТекстЗапроса
|
QueryText | string |
Запрос синтаксиса SQL по документам |
|
|
Значение ключа секции
|
partitionKey | string |
Значение ключа секции. |
|
|
Токен продолжения
|
continuationToken | string |
Маркер для получения дополнительных результатов из операции. |
Возвращаемое значение
Массив документов, соответствующих запрошенным запросам и соответствующим метаданным.
Запрос документов версии 3 [НЕ РЕКОМЕНДУЕТСЯ]
Это действие устарело. Вместо этого используйте документы запроса версии 5 .
Запрос документов версии 3.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор базы данных
|
databaseId | True | string |
Имя базы данных. |
|
Идентификатор коллекции
|
collectionId | True | string |
Имя коллекции. |
|
Запрос синтаксиса SQL
|
queryText | True | string |
SQL-запрос. |
|
Значение ключа секции
|
partitionKey | string |
Если это пусто, все секции будут использоваться для поиска документов. |
|
|
Максимальное число элементов
|
maxItemCount | integer |
Целое число, указывающее максимальное количество возвращаемых элементов на страницу. |
|
|
Токен продолжения
|
continuationToken | string |
Маркер для получения дополнительных результатов. |
|
|
Включение перекрестной секции
|
enableCrossPartition | boolean |
Указывает, разрешено ли пользователю отправлять несколько запросов для выполнения запроса. |
|
|
Уровень согласованности
|
consistencyLevel | string |
Уровень согласованности, необходимый для операции веб-канала (запрос/чтение веб-канала). |
|
|
Токен сеанса
|
sessionToken | string |
Маркер сеанса для использования с согласованность сеансов. |
Возвращаемое значение
Массив документов, соответствующих запрошенным запросам и соответствующим метаданным.
- Тело
- DocumentsCollection
Запрос документов версии 4 [НЕ РЕКОМЕНДУЕТСЯ]
Это действие устарело. Вместо этого используйте документы запроса версии 5 .
Запрос документов версии 4.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор базы данных
|
databaseId | True | string |
Имя базы данных. |
|
Идентификатор контейнера
|
containerId | True | string |
Имя контейнера. |
|
Запрос синтаксиса SQL
|
queryText | string |
SQL-запрос. Если пусто, возвращает все документы. |
|
|
Значение ключа секции
|
partitionKey | string |
Если это пусто, все секции будут использоваться для поиска документов. |
|
|
Максимальное число элементов
|
maxItemCount | integer |
Целое число, указывающее максимальное количество возвращаемых элементов на страницу. |
|
|
Токен продолжения
|
continuationToken | string |
Маркер для получения дополнительных результатов. |
|
|
Уровень согласованности
|
consistencyLevel | string |
Уровень согласованности, необходимый для операции веб-канала (запрос/чтение веб-канала). |
|
|
Токен сеанса
|
sessionToken | string |
Маркер сеанса для использования с согласованность сеансов. |
Возвращаемое значение
Массив документов, соответствующих запрошенным запросам и соответствующим метаданным.
- Тело
- DocumentsCollection
Получение всех документов (версия 3)
Получение всех документов (V3).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Значение ключа секции
|
x-ms-documentdb-raw-partitionkey | string |
Значение ключа секции для запрошенной операции документа или вложения. |
|
|
Максимальное число элементов
|
x-ms-max-item-count | number |
Целое число, указывающее максимальное количество возвращаемых элементов на страницу. |
|
|
Токен продолжения
|
x-ms-continuation | string |
Строковый маркер, возвращаемый для запросов и операций веб-канала чтения, если требуется прочитать больше результатов. |
|
|
Уровень согласованности
|
x-ms-consistency-level | string |
Это переопределение уровня согласованности. Допустимые значения: Strong, Bounded, Session или Eventual (в порядке наиболее сильных и слабых). |
|
|
Токен сеанса
|
x-ms-session-token | string |
Строковый маркер, используемый с согласованность уровня сеанса. |
|
|
Идентификатор действия
|
x-ms-activity-id | string |
Предоставленный клиентом идентификатор операции, который будет отклочен в ответе сервера. |
|
|
Имя учетной записи Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Имя учетной записи Azure Cosmos DB (без documents.azure.com). |
|
Идентификатор базы данных
|
databaseId | True | string |
Имя базы данных. |
|
Идентификатор коллекции
|
collectionId | True | string |
Имя коллекции. |
|
Версия API
|
x-ms-version | string |
Версия API. |
Возвращаемое значение
- Тело
- getDocumentsResponse
Получение всех документов [DEPRECATED]
Это действие устарело. Вместо этого используйте команду Get all documents (V3).
Получение всех документов.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Значение ключа секции
|
x-ms-documentdb-raw-partitionkey | string |
Значение ключа секции для запрошенной операции документа или вложения. |
|
|
Максимальное число элементов
|
x-ms-max-item-count | number |
Целое число, указывающее максимальное количество возвращаемых элементов на страницу. |
|
|
Токен продолжения
|
x-ms-continuation | string |
Строковый маркер, возвращаемый для запросов и операций веб-канала чтения, если требуется прочитать больше результатов. |
|
|
Уровень согласованности
|
x-ms-consistency-level | string |
Это переопределение уровня согласованности. Допустимые значения: Strong, Bounded, Session или Eventual (в порядке наиболее сильных и слабых). |
|
|
Токен сеанса
|
x-ms-session-token | string |
Строковый маркер, используемый с согласованность уровня сеанса. |
|
|
Идентификатор действия
|
x-ms-activity-id | string |
Предоставленный клиентом идентификатор операции, который будет отклочен в ответе сервера. |
|
|
Идентификатор базы данных
|
databaseId | True | string |
Имя базы данных. |
|
Идентификатор коллекции
|
collectionId | True | string |
Имя коллекции. |
|
Версия API
|
x-ms-version | string |
Версия API. |
Возвращаемое значение
- Тело
- getDocumentsResponse
Получение всех документов версии 2 [НЕ РЕКОМЕНДУЕТСЯ]
Это действие устарело. Вместо этого используйте команду Get all documents (V3).
Получение всех документов версии 2.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор базы данных
|
databaseId | True | string |
Имя базы данных. |
|
Идентификатор коллекции
|
collectionId | True | string |
Имя коллекции. |
|
Значение ключа секции
|
partitionKey | string |
Если это пусто, все секции будут использоваться для поиска документов. |
|
|
Максимальное число элементов
|
maxItemCount | integer |
Целое число, указывающее максимальное количество возвращаемых элементов на страницу. |
|
|
Токен продолжения
|
continuationToken | string |
Маркер для получения дополнительных результатов. |
|
|
Уровень согласованности
|
consistencyLevel | string |
Уровень согласованности, необходимый для операции веб-канала (запрос/чтение веб-канала). |
|
|
Токен сеанса
|
sessionToken | string |
Маркер сеанса для использования с согласованность сеансов. |
Возвращаемое значение
Массив документов, соответствующих запрошенным запросам и соответствующим метаданным.
- Тело
- DocumentsCollection
Получение документа (версия 2)
Получение документа (версия 2).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Значение ключа секции
|
x-ms-documentdb-raw-partitionkey | string |
Значение ключа секции для запрошенной операции документа или вложения. |
|
|
Максимальное число элементов
|
x-ms-max-item-count | number |
Целое число, указывающее максимальное количество возвращаемых элементов на страницу. |
|
|
Токен продолжения
|
x-ms-continuation | string |
Строковый маркер, возвращаемый для запросов и операций веб-канала чтения, если требуется прочитать больше результатов. |
|
|
Уровень согласованности
|
x-ms-consistency-level | string |
Это переопределение уровня согласованности. Допустимые значения: Strong, Bounded, Session или Eventual (в порядке наиболее сильных и слабых). |
|
|
Токен сеанса
|
x-ms-session-token | string |
Строковый маркер, используемый с согласованность уровня сеанса. |
|
|
Идентификатор действия
|
x-ms-activity-id | string |
Предоставленный клиентом идентификатор операции, который будет отклочен в ответе сервера. |
|
|
Имя учетной записи Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Имя учетной записи Azure Cosmos DB (без documents.azure.com). |
|
Идентификатор базы данных
|
databaseId | True | string |
Имя базы данных. |
|
Идентификатор коллекции
|
collectionId | True | string |
Имя коллекции. |
|
Идентификатор документа
|
documentId | True | string |
Идентификатор документа. |
|
Версия API
|
x-ms-version | string |
Версия API. |
Возвращаемое значение
- response
- object
Получение документа [DEPRECATED]
Это действие устарело. Вместо этого используйте документ (V2).
Получение документа.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Значение ключа секции
|
x-ms-documentdb-raw-partitionkey | string |
Значение ключа секции для запрошенной операции документа или вложения. |
|
|
Максимальное число элементов
|
x-ms-max-item-count | number |
Целое число, указывающее максимальное количество возвращаемых элементов на страницу. |
|
|
Токен продолжения
|
x-ms-continuation | string |
Строковый маркер, возвращаемый для запросов и операций веб-канала чтения, если требуется прочитать больше результатов. |
|
|
Уровень согласованности
|
x-ms-consistency-level | string |
Это переопределение уровня согласованности. Допустимые значения: Strong, Bounded, Session или Eventual (в порядке наиболее сильных и слабых). |
|
|
Токен сеанса
|
x-ms-session-token | string |
Строковый маркер, используемый с согласованность уровня сеанса. |
|
|
Идентификатор действия
|
x-ms-activity-id | string |
Предоставленный клиентом идентификатор операции, который будет отклочен в ответе сервера. |
|
|
Идентификатор базы данных
|
databaseId | True | string |
Имя базы данных. |
|
Идентификатор коллекции
|
collectionId | True | string |
Имя коллекции. |
|
Идентификатор документа
|
documentId | True | string |
Идентификатор документа. |
|
Версия API
|
x-ms-version | string |
Версия API. |
Возвращаемое значение
- response
- object
Получение хранимых процедур (версия 2)
Получение хранимых процедур в указанной коллекции (версия 2).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя учетной записи Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Имя учетной записи Azure Cosmos DB (без documents.azure.com). |
|
Идентификатор базы данных
|
databaseId | True | string |
Имя базы данных. |
|
Идентификатор коллекции
|
collectionId | True | string |
Имя коллекции. |
|
Версия API
|
x-ms-version | string |
Версия API. |
Возвращаемое значение
Получение хранимых процедур [DEPRECATED]
Это действие устарело. Вместо этого используйте хранимые процедуры (V2).
Получение хранимых процедур в указанной коллекции.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор базы данных
|
databaseId | True | string |
Имя базы данных. |
|
Идентификатор коллекции
|
collectionId | True | string |
Имя коллекции. |
|
Версия API
|
x-ms-version | string |
Версия API. |
Возвращаемое значение
Создание или обновление документа (V3)
Создание или обновление документа. При создании документа в DocumentDB текст должен содержать свойство идентификатора.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Максимальное число элементов
|
x-ms-max-item-count | number |
Целое число, указывающее максимальное количество возвращаемых элементов на страницу. |
|
|
Токен продолжения
|
x-ms-continuation | string |
Строковый маркер, возвращаемый для запросов и операций веб-канала чтения, если требуется прочитать больше результатов. |
|
|
Уровень согласованности
|
x-ms-consistency-level | string |
Это переопределение уровня согласованности. Допустимые значения: Strong, Bounded, Session или Eventual (в порядке наиболее сильных и слабых). |
|
|
Токен сеанса
|
x-ms-session-token | string |
Строковый маркер, используемый с согласованность уровня сеанса. |
|
|
Идентификатор действия
|
x-ms-activity-id | string |
Предоставленный клиентом идентификатор операции, который будет отклочен в ответе сервера. |
|
|
IsUpsert
|
x-ms-documentdb-is-upsert | boolean |
Если задано значение true, документ будет заменен, если он существует еще. |
|
|
Предварительный триггер
|
x-ms-documentdb-pre-trigger-include | string |
Разделенный запятыми список имен триггеров, выполняемых перед выполнением операции документа. |
|
|
После триггера
|
x-ms-documentdb-post-trigger-include | string |
Разделенный запятыми список имен триггеров, выполняемых после выполнения операции документа. |
|
|
Имя учетной записи Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Имя учетной записи Azure Cosmos DB (без documents.azure.com). |
|
Идентификатор базы данных
|
databaseId | True | string |
Имя базы данных. |
|
Идентификатор коллекции
|
collectionId | True | string |
Имя коллекции. |
|
Версия API
|
x-ms-version | string |
Версия API. |
Возвращаемое значение
Создание или обновление документа (версия 2) [DEPRECATED]
Это действие устарело. Вместо этого используйте документ create or update (V3).
Создание или обновление документа. При создании документа в DocumentDB текст должен содержать свойство идентификатора.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Максимальное число элементов
|
x-ms-max-item-count | number |
Целое число, указывающее максимальное количество возвращаемых элементов на страницу. |
|
|
Токен продолжения
|
x-ms-continuation | string |
Строковый маркер, возвращаемый для запросов и операций веб-канала чтения, если требуется прочитать больше результатов. |
|
|
Уровень согласованности
|
x-ms-consistency-level | string |
Это переопределение уровня согласованности. Допустимые значения: Strong, Bounded, Session или Eventual (в порядке наиболее сильных и слабых). |
|
|
Токен сеанса
|
x-ms-session-token | string |
Строковый маркер, используемый с согласованность уровня сеанса. |
|
|
Идентификатор действия
|
x-ms-activity-id | string |
Предоставленный клиентом идентификатор операции, который будет отклочен в ответе сервера. |
|
|
IsUpsert
|
x-ms-documentdb-is-upsert | boolean |
Если задано значение true, документ будет заменен, если он существует еще. |
|
|
Предварительный триггер
|
x-ms-documentdb-pre-trigger-include | string |
Разделенный запятыми список имен триггеров, выполняемых перед выполнением операции документа. |
|
|
После триггера
|
x-ms-documentdb-post-trigger-include | string |
Разделенный запятыми список имен триггеров, выполняемых после выполнения операции документа. |
|
|
Идентификатор базы данных
|
databaseId | True | string |
Имя базы данных. |
|
Идентификатор коллекции
|
collectionId | True | string |
Имя коллекции. |
|
Версия API
|
x-ms-version | string |
Версия API. |
Возвращаемое значение
Создание или обновление документа [DEPRECATED]
Это действие устарело. Вместо этого используйте документ create or update (V3).
Создание или обновление документа. При создании документа в DocumentDB текст должен содержать свойство идентификатора.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Значение ключа секции
|
x-ms-documentdb-raw-partitionkey | string |
Значение ключа секции для запрошенной операции документа или вложения. |
|
|
Максимальное число элементов
|
x-ms-max-item-count | number |
Целое число, указывающее максимальное количество возвращаемых элементов на страницу. |
|
|
Токен продолжения
|
x-ms-continuation | string |
Строковый маркер, возвращаемый для запросов и операций веб-канала чтения, если требуется прочитать больше результатов. |
|
|
Уровень согласованности
|
x-ms-consistency-level | string |
Это переопределение уровня согласованности. Допустимые значения: Strong, Bounded, Session или Eventual (в порядке наиболее сильных и слабых). |
|
|
Токен сеанса
|
x-ms-session-token | string |
Строковый маркер, используемый с согласованность уровня сеанса. |
|
|
Идентификатор действия
|
x-ms-activity-id | string |
Предоставленный клиентом идентификатор операции, который будет отклочен в ответе сервера. |
|
|
IsUpsert
|
x-ms-documentdb-is-upsert | boolean |
Если задано значение true, документ будет заменен, если он существует еще. |
|
|
Предварительный триггер
|
x-ms-documentdb-pre-trigger-include | string |
Разделенный запятыми список имен триггеров, выполняемых перед выполнением операции документа. |
|
|
После триггера
|
x-ms-documentdb-post-trigger-include | string |
Разделенный запятыми список имен триггеров, выполняемых после выполнения операции документа. |
|
|
Идентификатор базы данных
|
databaseId | True | string |
Имя базы данных. |
|
Идентификатор коллекции
|
collectionId | True | string |
Имя коллекции. |
|
Версия API
|
x-ms-version | string |
Версия API. |
Возвращаемое значение
Создание хранимой процедуры (версия 2)
Создайте хранимую процедуру (версия 2).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя учетной записи Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Имя учетной записи Azure Cosmos DB (без documents.azure.com). |
|
Идентификатор базы данных
|
databaseId | True | string |
Имя базы данных. |
|
Идентификатор коллекции
|
collectionId | True | string |
Имя коллекции. |
|
Определение функции
|
body | string |
Функция, определяющая хранимую процедуру, например function(params){ ... }' |
|
|
id
|
id | string |
Новый идентификатор хранимой процедуры. |
|
|
Версия API
|
x-ms-version | string |
Версия API. |
Возвращаемое значение
Создание хранимой процедуры [DEPRECATED]
Это действие устарело. Вместо этого используйте хранимую процедуру (V2).
Создайте хранимую процедуру.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор базы данных
|
databaseId | True | string |
Имя базы данных. |
|
Идентификатор коллекции
|
collectionId | True | string |
Имя коллекции. |
|
Определение функции
|
body | string |
Функция, определяющая хранимую процедуру, например function(params){ ... }' |
|
|
id
|
id | string |
Новый идентификатор хранимой процедуры. |
|
|
Версия API
|
x-ms-version | string |
Версия API. |
Возвращаемое значение
Удаление документа (версия 2)
Удаление документа (версия 2).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Значение ключа секции
|
x-ms-documentdb-raw-partitionkey | string |
Значение ключа секции для запрошенной операции документа или вложения. |
|
|
Максимальное число элементов
|
x-ms-max-item-count | number |
Целое число, указывающее максимальное количество возвращаемых элементов на страницу. |
|
|
Токен продолжения
|
x-ms-continuation | string |
Строковый маркер, возвращаемый для запросов и операций веб-канала чтения, если требуется прочитать больше результатов. |
|
|
Уровень согласованности
|
x-ms-consistency-level | string |
Это переопределение уровня согласованности. Допустимые значения: Strong, Bounded, Session или Eventual (в порядке наиболее сильных и слабых). |
|
|
Токен сеанса
|
x-ms-session-token | string |
Строковый маркер, используемый с согласованность уровня сеанса. |
|
|
Идентификатор действия
|
x-ms-activity-id | string |
Предоставленный клиентом идентификатор операции, который будет отклочен в ответе сервера. |
|
|
Предварительный триггер
|
x-ms-documentdb-pre-trigger-include | string |
Разделенный запятыми список имен триггеров, выполняемых перед выполнением операции документа. |
|
|
После триггера
|
x-ms-documentdb-post-trigger-include | string |
Разделенный запятыми список имен триггеров, выполняемых после выполнения операции документа. |
|
|
Имя учетной записи Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Имя учетной записи Azure Cosmos DB (без documents.azure.com). |
|
Идентификатор базы данных
|
databaseId | True | string |
Имя базы данных. |
|
Идентификатор коллекции
|
collectionId | True | string |
Имя коллекции. |
|
Идентификатор документа
|
documentId | True | string |
Идентификатор документа. |
|
Версия API
|
x-ms-version | string |
Версия API. |
Удаление документа [DEPRECATED]
Это действие устарело. Вместо этого используйте документ delete (V2).
Удаление документа.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Значение ключа секции
|
x-ms-documentdb-raw-partitionkey | string |
Значение ключа секции для запрошенной операции документа или вложения. |
|
|
Максимальное число элементов
|
x-ms-max-item-count | number |
Целое число, указывающее максимальное количество возвращаемых элементов на страницу. |
|
|
Токен продолжения
|
x-ms-continuation | string |
Строковый маркер, возвращаемый для запросов и операций веб-канала чтения, если требуется прочитать больше результатов. |
|
|
Уровень согласованности
|
x-ms-consistency-level | string |
Это переопределение уровня согласованности. Допустимые значения: Strong, Bounded, Session или Eventual (в порядке наиболее сильных и слабых). |
|
|
Токен сеанса
|
x-ms-session-token | string |
Строковый маркер, используемый с согласованность уровня сеанса. |
|
|
Идентификатор действия
|
x-ms-activity-id | string |
Предоставленный клиентом идентификатор операции, который будет отклочен в ответе сервера. |
|
|
Предварительный триггер
|
x-ms-documentdb-pre-trigger-include | string |
Разделенный запятыми список имен триггеров, выполняемых перед выполнением операции документа. |
|
|
После триггера
|
x-ms-documentdb-post-trigger-include | string |
Разделенный запятыми список имен триггеров, выполняемых после выполнения операции документа. |
|
|
Идентификатор базы данных
|
databaseId | True | string |
Имя базы данных. |
|
Идентификатор коллекции
|
collectionId | True | string |
Имя коллекции. |
|
Идентификатор документа
|
documentId | True | string |
Идентификатор документа. |
|
Версия API
|
x-ms-version | string |
Версия API. |
Удаление хранимой процедуры (версия 2)
Удаление хранимой процедуры (версия 2).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя учетной записи Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Имя учетной записи Azure Cosmos DB (без documents.azure.com). |
|
Идентификатор базы данных
|
databaseId | True | string |
Имя базы данных. |
|
Идентификатор коллекции
|
collectionId | True | string |
Имя коллекции. |
|
Идентификатор Sproc
|
sprocId | True | string |
Имя хранимой процедуры. |
|
Версия API
|
x-ms-version | string |
Версия API. |
Возвращаемое значение
- response
- string
Удаление хранимой процедуры [DEPRECATED]
Это действие устарело. Вместо этого используйте хранимую процедуру удаления (V2 ).
Удаление хранимой процедуры.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор базы данных
|
databaseId | True | string |
Имя базы данных. |
|
Идентификатор коллекции
|
collectionId | True | string |
Имя коллекции. |
|
Идентификатор Sproc
|
sprocId | True | string |
Имя хранимой процедуры. |
|
Версия API
|
x-ms-version | string |
Версия API. |
Возвращаемое значение
- response
- string
Определения
QueryDocumentsResponse
Массив документов, соответствующих запрошенным запросам и соответствующим метаданным.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Documents
|
Documents | array of ObjectWithoutType |
Массив документов, соответствующих запросу. |
|
Количество документов
|
_count | integer |
Количество документов. |
|
Идентификатор активности
|
ActivityId | string |
Идентификатор действия службы Azure Cosmos DB. |
DocumentsCollection
Массив документов, соответствующих запрошенным запросам и соответствующим метаданным.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Documents
|
value | array of ObjectWithoutType | |
|
Токен продолжения
|
ContinuationToken | string | |
|
Количество документов
|
Count | integer | |
|
Плата за запрос
|
RequestCharge | double | |
|
Токен сеанса
|
SessionToken | string | |
|
Идентификатор действия
|
ActivityId | string |
postDocumentsResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
_удалить
|
_rid | string | |
|
_ts
|
_ts | integer | |
|
_сам
|
_self | string | |
|
_etag
|
_etag | string | |
|
_Вложения
|
_attachments | string | |
|
id
|
id | string |
putDocumentResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
_удалить
|
_rid | string | |
|
id
|
id | string |
getDocumentsResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
_удалить
|
_rid | string | |
|
Documents
|
Documents | array of object |
queryResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
_удалить
|
_rid | string | |
|
_считать
|
_count | number | |
|
Documents
|
Documents | array of |
getStoredProceduresResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
_считать
|
_count | integer |
_считать |
|
_удалить
|
_rid | string |
_удалить |
|
Хранимые процедуры
|
StoredProcedures | array of object |
Хранимые процедуры |
|
_etag
|
StoredProcedures._etag | string |
_etag |
|
_удалить
|
StoredProcedures._rid | string |
_удалить |
|
_сам
|
StoredProcedures._self | string |
_сам |
|
_ts
|
StoredProcedures._ts | integer |
_ts |
|
body
|
StoredProcedures.body | string |
body |
|
id
|
StoredProcedures.id | string |
id |
createStoredProcedureResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
_etag
|
_etag | string |
_etag |
|
_удалить
|
_rid | string |
_удалить |
|
_сам
|
_self | string |
_сам |
|
_ts
|
_ts | integer |
_ts |
|
body
|
body | string |
body |
|
id
|
id | string |
id |
ObjectWithoutType
струна
Это базовый тип данных string.
объект
Это тип object.