Azure Cosmos DB
Azure Cosmos DB 是一项全球分布式多模型数据库服务，旨在让你使用全面的 SLA 跨任意数量的地理区域弹性独立缩放吞吐量和存储。
此连接器在以下产品和区域中可用：
| 服务 | Class | 区域 |
|---|---|---|
| Copilot Studio | 高级 | 所有 Power Automate 区域 |
| 逻辑应用程序 | 标准 | 所有 逻辑应用区域 |
| Power Apps | - | 不可用 |
| Power Automate | 高级 | 所有 Power Automate 区域 |
| 连接器元数据 | |
|---|---|
| 发布者 | Microsoft |
若要使用此集成，需要在 Azure 门户中配置 Cosmos DB SQL API 帐户。 请注意，目前不支持 Mongo DB API 帐户。
创建 SQL API 帐户后，创建与 Azure Cosmos DB 连接器建立连接（如果创建类型连接），请提供帐户 ID（不含“documents.azure.com”。Access Key 对于支持Microsoft Entra ID 身份验证的较新版本，还需要此帐户 ID。
Microsoft Entra ID 身份验证和 Cosmos DB 连接器
若要使用 Microsoft Entra ID 身份验证，需要使用的帐户分配特定的角色分配，有关详细信息，请访问 使用 Azure Cosmos DB 帐户的 Microsoft Entra ID 配置基于角色的访问控制。
注释
只有为数据访问 显式 定义的角色才允许安全主体访问 Cosmos DB 数据。 内置角色（例如Owner，或通过 Contributor Microsoft Entra ID 提供对该帐户中的 Cosmos DB 数据的访问权限）。
Azure Cosmos DB 公开了 2 个内置角色：
-
Cosmos DB Built-in Data Reader（角色定义 ID00000000-0000-0000-0000-000000000001） -
Cosmos DB Built-in Data Contributor（角色定义 ID00000000-0000-0000-0000-000000000002）
可以通过多种方式分配角色，并且可以创建自定义角色，以便进行更精细的访问。
下面是有关如何通过 PowerShell 分配 Cosmos DB Built-in Data Reader 的示例（有关此命令 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 ID 身份验证（ 此处所述）进行任何类型的管理作。 以下作仅适用于Access Key连接：
- 创建存储过程（V1 和 V2 版本）
- 删除存储过程（V1 和 V2 版本）
- 更新存储过程（V1 和 V2 版本）
Microsoft Entra ID 身份验证不支持的作
使用 Microsoft Entra ID 身份验证 时，仅支持将 Cosmos DB 帐户名称用作参数的作。 弃用的作将继续使用 Access Key 身份验证，但如果 与 Microsoft Entra ID 连接一起使用，将失败。
已知问题和限制
DocumentDB （Azure Cosmos DB） 连接器支持的文档的最大大小为 2 MB。
此处介绍了 Azure Cosmos DB 限制。
连接器不支持选择写入区域和多写入区域。
必须根据其类型提供“分区键值”。 例如，字符串值应括在引号中，应按原样提供数字。 例如：“string value”，123,0.5。
对于在
ORDER BYDISTINCT分区集合上运行的查询，需要使用“分区键值”等。查询文档 V2 [已弃用]， 查询文档 V3， 获取所有文档 V2 （预览版） 作使用 Azure Cosmos DB .NET SDK for SQL API （版本 2.13.1）。
查询文档 V4（预览版） 作使用适用于 SQL API 的 Azure Cosmos DB .NET SDK（版本 3.15.0）。
查询文档（V5）（预览版） 作使用适用于 SQL API 的 Azure Cosmos DB .NET SDK（版本 3.20.0）。
“最大项计数”参数值可以是从 1 到 1000 的任何数字。 此范围之外的任何数字都将隐式转换为“-1”，这告知 Cosmos DB 服务确定最佳项计数。
如果留空，则以下作仅适用于 没有 分区键值的文档。 具有分区键值的项 将从此作中排除 。
由于 Azure Cosmos DB 不支持使用 Microsoft Entra ID 身份验证的任何类型的管理作（此处所述），因此执行存储过程 （V2） （预览版）仅在使用
Access Key基于的连接时显示可用的存储过程（对于SprocId参数）。Token基于身份验证（Microsoft Entra ID 身份验证）将显示空列表，应sprocId以自定义值手动输入。
重要
默认情况下，美国政府（GCC）环境中禁用Microsoft Entra ID 集成（Azure 商业）连接。 若要启用这些类型的连接，租户管理员必须在 Power Platform 管理中心中启用 “连接到 Azure 商业 ”设置。
启用此设置可以连接到 Azure 商业版中的资源，这些资源在 Power Platform US Government 符合性边界之外运行和发送数据。 这专门用于允许从 Power Platform Connector 的 GCC 云版本访问商业资源。
Microsoft Entra ID 集成（Azure 商业版）是唯一一种从美国政府（GCC）环境到 Azure 商业资源的身份验证类型。
默认禁用的 Azure 商业身份验证： 
Power Platform 管理中心中的 “连接到 Azure 商业 ”设置： 
正在创建连接
连接器支持以下身份验证类型：
| 访问密钥 | 提供帐户名称和访问密钥以访问 Cosmos DB 帐户。 | 除 Azure 政府和国防部（DoD）以外的所有区域（Azure 政府和美国政府（GCC）和美国政府（GCC-High） | 可共享 |
| 访问密钥 （Azure 政府版） | 提供帐户名称和访问密钥以访问 Cosmos DB 帐户。 | Azure 政府和国防部（DoD）仅在 Azure 政府和美国政府（GCC）和美国政府（GCC-High） | 可共享 |
| 逻辑应用托管标识 | 使用 LogicApps 托管标识创建连接 | 仅限 LOGICAPPS | 可共享 |
| Microsoft Entra ID 集成 | 使用 Microsoft Entra ID 访问 Azure Blob 存储。 | 除 Azure 政府和国防部（DoD）以外的所有区域（Azure 政府和美国政府（GCC）和美国政府（GCC-High） | 不可共享 |
| Microsoft Entra ID 集成（Azure 商业版） | 使用 Microsoft Entra ID 访问 Azure 商业版中的 Azure Blob 存储。 | 仅限美国政府（GCC） | 不可共享 |
| Microsoft Entra ID 集成（Azure 政府版） | 使用 Microsoft Entra ID 访问 Azure Blob 存储。 | Azure 政府和国防部（DoD）仅在 Azure 政府和美国政府（GCC）和美国政府（GCC-High） | 不可共享 |
| 默认值 [已弃用] | 此选项仅适用于没有显式身份验证类型的较旧连接，并且仅用于向后兼容性。 | 所有区域 | 不可共享 |
访问密钥
身份验证 ID：keyBasedAuth
适用：除 Azure 政府和国防部（DoD）以外的所有区域（Azure 政府和美国政府（GCC）和美国政府（GCC-High）
提供帐户名称和访问密钥以访问 Cosmos DB 帐户。
这是可共享的连接。 如果 Power App 与其他用户共享，则连接也会共享。 有关详细信息，请参阅 画布应用的连接器概述 - Power Apps |Microsoft Docs
| Name | 类型 | Description | 必选 |
|---|---|---|---|
| 帐户 ID | 字符串 | 没有“documents.azure.com”部分的帐户的名称 | True |
| 访问 Azure Cosmos DB 帐户的密钥 | securestring | 主密钥或辅助密钥 | True |
访问密钥 （Azure 政府版）
身份验证 ID：keyBasedAuth
适用：Azure 政府和国防部（DoD）仅在 Azure 政府和美国政府（GCC）和美国政府（GCC-High）
提供帐户名称和访问密钥以访问 Cosmos DB 帐户。
这是可共享的连接。 如果 Power App 与其他用户共享，则连接也会共享。 有关详细信息，请参阅 画布应用的连接器概述 - Power Apps |Microsoft Docs
| Name | 类型 | Description | 必选 |
|---|---|---|---|
| 帐户 ID | 字符串 | 没有“documents.azure.com”部分的帐户的名称 | True |
| 访问 Azure Cosmos DB 帐户的密钥 | securestring | 主密钥或辅助密钥 | True |
逻辑应用托管标识
身份验证 ID：managedIdentityAuth
适用：仅限 LOGICAPPS
使用 LogicApps 托管标识创建连接
这是可共享的连接。 如果 Power App 与其他用户共享，则连接也会共享。 有关详细信息，请参阅 画布应用的连接器概述 - Power Apps |Microsoft Docs
| Name | 类型 | Description | 必选 |
|---|---|---|---|
| LogicApps 托管标识 | managedIdentity | 使用逻辑应用托管标识登录 | True |
已集成 Microsoft Entra ID
身份验证 ID：tokenBasedAuth
适用：除 Azure 政府和国防部（DoD）以外的所有区域（Azure 政府和美国政府（GCC）和美国政府（GCC-High）
使用 Microsoft Entra ID 访问 Azure Blob 存储。
这是不可共享的连接。 如果 Power App 与另一个用户共享，系统会提示其他用户显式创建新连接。
Microsoft Entra ID 集成（Azure 商业版）
身份验证 ID：oauthCom
适用：仅限美国政府（GCC）
使用 Microsoft Entra ID 访问 Azure 商业版中的 Azure Blob 存储。
这是不可共享的连接。 如果 Power App 与另一个用户共享，系统会提示其他用户显式创建新连接。
Microsoft Entra ID 集成（Azure 政府版）
身份验证 ID：tokenBasedAuth
适用：Azure 政府和国防部（DoD）仅在 Azure 政府和美国政府（GCC）和美国政府（GCC-High）
使用 Microsoft Entra ID 访问 Azure Blob 存储。
这是不可共享的连接。 如果 Power App 与另一个用户共享，系统会提示其他用户显式创建新连接。
默认值 [已弃用]
适用：所有区域
此选项仅适用于没有显式身份验证类型的较旧连接，并且仅用于向后兼容性。
这是不可共享的连接。 如果 Power App 与另一个用户共享，系统会提示其他用户显式创建新连接。
| Name | 类型 | Description | 必选 |
|---|---|---|---|
| 帐户 ID | 字符串 | 没有“documents.azure.com”部分的帐户的名称 | True |
| 访问 Azure Cosmos DB 帐户的密钥 | securestring | 主密钥或辅助密钥 | True |
限制
| 名称 | 调用 | 续订期 |
|---|---|---|
| 每个连接的 API 调用数 | 1500 | 60 秒 |
操作
| 创建存储过程 [已弃用] |
此作已弃用。 请改用“创建存储过程”（V2）。
|
| 创建存储过程 （V2） |
创建存储过程（V2）。 |
| 创建或更新文档 [已弃用] |
此作已弃用。 请改用“创建”或“更新文档”（V3）。
|
| 创建或更新文档 （V2） [已弃用] |
此作已弃用。 请改用“创建”或“更新文档”（V3）。
|
| 创建或更新文档 （V3） |
创建或更新文档。 在 DocumentDB 中创建文档时，正文必须包含 ID 属性。 |
| 删除存储过程 [已弃用] |
此作已弃用。 请改用 Delete 存储过程（V2）。
|
| 删除存储过程 （V2） |
删除存储过程（V2）。 |
| 删除文档 [已弃用] |
此作已弃用。 请改用“删除文档”（V2）。
|
| 删除文档 （V2） |
删除文档（V2）。 |
| 执行存储过程 [已弃用] |
此作已弃用。 请改用执行存储过程（V2）。
|
| 执行存储过程 （V2） |
在指定的集合中执行存储过程（V2）。 |
| 替换存储过程 [已弃用] |
此作已弃用。 请改用替换存储过程 （V2）。
|
| 替换存储过程 （V2） |
替换存储过程 （V2）。 |
| 替换文档 [已弃用] |
此作已弃用。 请改用替换文档（V2）。
|
| 替换文档（V2） |
替换文档（V2）。 |
| 查询文档 [已弃用] |
此作已弃用。 请改用 查询文档 V5 。
|
| 查询文档 V2 [已弃用] |
此作已弃用。 请改用 查询文档 V5 。
|
| 查询文档 V3 [已弃用] |
此作已弃用。 请改用 查询文档 V5 。
|
| 查询文档 V4 [已弃用] |
此作已弃用。 请改用 查询文档 V5 。
|
| 查询文档 V5 |
查询文档 （V5）。 |
| 获取存储过程 [已弃用] |
此作已弃用。 请改用 Get 存储过程 （V2）。
|
| 获取存储过程 （V2） |
获取指定集合中的存储过程（V2）。 |
| 获取所有文档 [已弃用] |
此作已弃用。 请改用“获取所有文档”（V3）。
|
| 获取所有文档 V2 [已弃用] |
此作已弃用。 请改用“获取所有文档”（V3）。
|
| 获取所有文档（V3） |
获取所有文档（V3）。 |
| 获取文档 [已弃用] |
此作已弃用。 请改用“获取文档”（V2）。
|
| 获取文档 （V2） |
获取文档（V2）。 |
创建存储过程 [已弃用]
此作已弃用。 请改用“创建存储过程”（V2）。
创建存储过程。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
数据库 ID
|
databaseId | True | string |
数据库的名称。 |
|
集合 ID
|
collectionId | True | string |
集合的名称。 |
|
函数定义
|
body | string |
定义存储过程的函数，例如“function（params）{ ... }” |
|
|
id
|
id | string |
存储过程的新 ID。 |
|
|
API 版本
|
x-ms-version | string |
API 版本。 |
返回
创建存储过程 （V2）
创建存储过程（V2）。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Azure Cosmos DB 帐户名称
|
cosmosDbAccountName | True | string |
Azure Cosmos DB 帐户名称（无 documents.azure.com）。 |
|
数据库 ID
|
databaseId | True | string |
数据库的名称。 |
|
集合 ID
|
collectionId | True | string |
集合的名称。 |
|
函数定义
|
body | string |
定义存储过程的函数，例如“function（params）{ ... }” |
|
|
id
|
id | string |
存储过程的新 ID。 |
|
|
API 版本
|
x-ms-version | string |
API 版本。 |
返回
创建或更新文档 [已弃用]
此作已弃用。 请改用“创建”或“更新文档”（V3）。
创建或更新文档。 在 DocumentDB 中创建文档时，正文必须包含 ID 属性。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
分区键值
|
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 |
用于会话级别一致性的字符串令牌。 |
|
|
活动 ID
|
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 |
执行文档作后要运行的触发器名称的逗号分隔列表。 |
|
|
数据库 ID
|
databaseId | True | string |
数据库的名称。 |
|
集合 ID
|
collectionId | True | string |
集合的名称。 |
|
API 版本
|
x-ms-version | string |
API 版本。 |
返回
创建或更新文档 （V2） [已弃用]
此作已弃用。 请改用“创建”或“更新文档”（V3）。
创建或更新文档。 在 DocumentDB 中创建文档时，正文必须包含 ID 属性。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
最大项计数
|
x-ms-max-item-count | number |
一个整数，指示每页要返回的最大项数。 |
|
|
继续标记
|
x-ms-continuation | string |
如果要读取更多结果，则为查询和读取源作返回的字符串令牌。 |
|
|
一致性级别
|
x-ms-consistency-level | string |
这是一致性级别替代。 有效值为：Strong、Bounded、Session 或 Eventual（以最强到最弱的顺序）。 |
|
|
会话令牌
|
x-ms-session-token | string |
用于会话级别一致性的字符串令牌。 |
|
|
活动 ID
|
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 |
执行文档作后要运行的触发器名称的逗号分隔列表。 |
|
|
数据库 ID
|
databaseId | True | string |
数据库的名称。 |
|
集合 ID
|
collectionId | True | string |
集合的名称。 |
|
API 版本
|
x-ms-version | string |
API 版本。 |
返回
创建或更新文档 （V3）
创建或更新文档。 在 DocumentDB 中创建文档时，正文必须包含 ID 属性。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
最大项计数
|
x-ms-max-item-count | number |
一个整数，指示每页要返回的最大项数。 |
|
|
继续标记
|
x-ms-continuation | string |
如果要读取更多结果，则为查询和读取源作返回的字符串令牌。 |
|
|
一致性级别
|
x-ms-consistency-level | string |
这是一致性级别替代。 有效值为：Strong、Bounded、Session 或 Eventual（以最强到最弱的顺序）。 |
|
|
会话令牌
|
x-ms-session-token | string |
用于会话级别一致性的字符串令牌。 |
|
|
活动 ID
|
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）。 |
|
数据库 ID
|
databaseId | True | string |
数据库的名称。 |
|
集合 ID
|
collectionId | True | string |
集合的名称。 |
|
API 版本
|
x-ms-version | string |
API 版本。 |
返回
删除存储过程 [已弃用]
此作已弃用。 请改用 Delete 存储过程（V2）。
删除存储过程。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
数据库 ID
|
databaseId | True | string |
数据库的名称。 |
|
集合 ID
|
collectionId | True | string |
集合的名称。 |
|
Sproc ID
|
sprocId | True | string |
存储过程的名称。 |
|
API 版本
|
x-ms-version | string |
API 版本。 |
返回
- response
- string
删除存储过程 （V2）
删除存储过程（V2）。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Azure Cosmos DB 帐户名称
|
cosmosDbAccountName | True | string |
Azure Cosmos DB 帐户名称（无 documents.azure.com）。 |
|
数据库 ID
|
databaseId | True | string |
数据库的名称。 |
|
集合 ID
|
collectionId | True | string |
集合的名称。 |
|
Sproc ID
|
sprocId | True | string |
存储过程的名称。 |
|
API 版本
|
x-ms-version | string |
API 版本。 |
返回
- response
- string
删除文档 [已弃用]
此作已弃用。 请改用“删除文档”（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 |
用于会话级别一致性的字符串令牌。 |
|
|
活动 ID
|
x-ms-activity-id | string |
客户端为作提供标识符，该标识符将在服务器响应中回显。 |
|
|
前触发器
|
x-ms-documentdb-pre-trigger-include | string |
在执行文档作之前要运行的触发器名称的逗号分隔列表。 |
|
|
触发器后
|
x-ms-documentdb-post-trigger-include | string |
执行文档作后要运行的触发器名称的逗号分隔列表。 |
|
|
数据库 ID
|
databaseId | True | string |
数据库的名称。 |
|
集合 ID
|
collectionId | True | string |
集合的名称。 |
|
文档 ID
|
documentId | True | string |
文档的标识符。 |
|
API 版本
|
x-ms-version | string |
API 版本。 |
删除文档 （V2）
删除文档（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 |
用于会话级别一致性的字符串令牌。 |
|
|
活动 ID
|
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）。 |
|
数据库 ID
|
databaseId | True | string |
数据库的名称。 |
|
集合 ID
|
collectionId | True | string |
集合的名称。 |
|
文档 ID
|
documentId | True | string |
文档的标识符。 |
|
API 版本
|
x-ms-version | string |
API 版本。 |
执行存储过程 [已弃用]
此作已弃用。 请改用执行存储过程（V2）。
在指定的集合中执行存储过程。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
数据库 ID
|
databaseId | True | string |
数据库的名称。 |
|
集合 ID
|
collectionId | True | string |
集合的名称。 |
|
分区键值
|
x-ms-documentdb-raw-partitionkey | string |
所请求的文档或附件作的分区键值。 |
|
|
Sproc ID
|
sprocId | True | string |
存储过程的名称。 |
|
存储过程的参数
|
parameters | string |
为存储过程的参数指定有效的 JSON，例如 [“param1”、“param2”。 |
|
|
API 版本
|
x-ms-version | string |
API 版本。 |
返回
- response
- ObjectWithoutType
执行存储过程 （V2）
在指定的集合中执行存储过程（V2）。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Azure Cosmos DB 帐户名称
|
cosmosDbAccountName | True | string |
Azure Cosmos DB 帐户名称（无 documents.azure.com）。 |
|
数据库 ID
|
databaseId | True | string |
数据库的名称。 |
|
集合 ID
|
collectionId | True | string |
集合的名称。 |
|
分区键值
|
x-ms-documentdb-raw-partitionkey | string |
所请求的文档或附件作的分区键值。 |
|
|
Sproc ID
|
sprocId | True | string |
存储过程的名称。 |
|
存储过程的参数
|
parameters | string |
为存储过程的参数指定有效的 JSON，例如 [“param1”、“param2”。 |
|
|
API 版本
|
x-ms-version | string |
API 版本。 |
返回
- response
- ObjectWithoutType
替换存储过程 [已弃用]
此作已弃用。 请改用替换存储过程 （V2）。
替换存储过程。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
数据库 ID
|
databaseId | True | string |
数据库的名称。 |
|
集合 ID
|
collectionId | True | string |
集合的名称。 |
|
Sproc ID
|
sprocId | True | string |
存储过程的名称。 |
|
函数定义
|
body | string |
定义存储过程的函数，例如“function（params）{ ... }” |
|
|
id
|
id | string |
现有存储过程的 ID。 |
|
|
API 版本
|
x-ms-version | string |
API 版本。 |
返回
替换存储过程 （V2）
替换存储过程 （V2）。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Azure Cosmos DB 帐户名称
|
cosmosDbAccountName | True | string |
Azure Cosmos DB 帐户名称（无 documents.azure.com）。 |
|
数据库 ID
|
databaseId | True | string |
数据库的名称。 |
|
集合 ID
|
collectionId | True | string |
集合的名称。 |
|
Sproc ID
|
sprocId | True | string |
存储过程的名称。 |
|
函数定义
|
body | string |
定义存储过程的函数，例如“function（params）{ ... }” |
|
|
id
|
id | string |
现有存储过程的 ID。 |
|
|
API 版本
|
x-ms-version | string |
API 版本。 |
返回
替换文档 [已弃用]
此作已弃用。 请改用替换文档（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 |
用于会话级别一致性的字符串令牌。 |
|
|
活动 ID
|
x-ms-activity-id | string |
客户端为作提供标识符，该标识符将在服务器响应中回显。 |
|
|
前触发器
|
x-ms-documentdb-pre-trigger-include | string |
在执行文档作之前要运行的触发器名称的逗号分隔列表。 |
|
|
触发器后
|
x-ms-documentdb-post-trigger-include | string |
执行文档作后要运行的触发器名称的逗号分隔列表。 |
|
|
数据库 ID
|
databaseId | True | string |
数据库的名称。 |
|
集合 ID
|
collectionId | True | string |
集合的名称。 |
|
文档 ID
|
documentId | True | string |
文档的标识符。 |
|
API 版本
|
x-ms-version | string |
API 版本。 |
返回
- Body
- putDocumentResponse
替换文档（V2）
替换文档（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 |
用于会话级别一致性的字符串令牌。 |
|
|
活动 ID
|
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）。 |
|
数据库 ID
|
databaseId | True | string |
数据库的名称。 |
|
集合 ID
|
collectionId | True | string |
集合的名称。 |
|
文档 ID
|
documentId | True | string |
文档的标识符。 |
|
API 版本
|
x-ms-version | string |
API 版本。 |
返回
- Body
- putDocumentResponse
查询文档 [已弃用]
此作已弃用。 请改用 查询文档 V5 。
查询文档。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
分区键值
|
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 |
用于会话级别一致性的字符串令牌。 |
|
|
活动 ID
|
x-ms-activity-id | string |
客户端为作提供标识符，该标识符将在服务器响应中回显。 |
|
|
数据库 ID
|
databaseId | True | string |
数据库的名称。 |
|
集合 ID
|
collectionId | True | string |
集合的名称。 |
|
查询
|
query | string |
返回
- Body
- queryResponse
查询文档 V2 [已弃用]
此作已弃用。 请改用 查询文档 V5 。
查询文档 V2。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
数据库 ID
|
databaseId | True | string |
数据库的名称。 |
|
集合 ID
|
collectionId | True | string |
集合的名称。 |
|
查询文本 (QueryText)
|
QueryText | string |
针对文档的 SQL 语法查询 |
|
|
分区键值
|
partitionKey | string |
分区键值。 |
|
|
继续标记
|
continuationToken | string |
用于从作中提取其他结果的令牌。 |
返回
与请求的查询和相关元数据匹配的文档数组。
查询文档 V3 [已弃用]
此作已弃用。 请改用 查询文档 V5 。
查询文档 V3。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
数据库 ID
|
databaseId | True | string |
数据库的名称。 |
|
集合 ID
|
collectionId | True | string |
集合的名称。 |
|
SQL 语法查询
|
queryText | True | string |
SQL 查询。 |
|
分区键值
|
partitionKey | string |
如果为空，则所有分区将用于搜索文档。 |
|
|
最大项计数
|
maxItemCount | integer |
一个整数，指示每页要返回的最大项数。 |
|
|
继续标记
|
continuationToken | string |
用于获取其他结果的令牌。 |
|
|
启用跨分区
|
enableCrossPartition | boolean |
指示是否允许用户发送多个请求来执行查询。 |
|
|
一致性级别
|
consistencyLevel | string |
源（查询/读取源）作所需的一致性级别。 |
|
|
会话令牌
|
sessionToken | string |
用于会话一致性的会话令牌。 |
返回
与请求的查询和相关元数据匹配的文档数组。
- Body
- DocumentsCollection
查询文档 V4 [已弃用]
此作已弃用。 请改用 查询文档 V5 。
查询文档 V4。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
数据库 ID
|
databaseId | True | string |
数据库的名称。 |
|
容器 ID
|
containerId | True | string |
容器的名称。 |
|
SQL 语法查询
|
queryText | string |
SQL 查询。 如果为空，则返回所有文档。 |
|
|
分区键值
|
partitionKey | string |
如果为空，则所有分区将用于搜索文档。 |
|
|
最大项计数
|
maxItemCount | integer |
一个整数，指示每页要返回的最大项数。 |
|
|
继续标记
|
continuationToken | string |
用于获取其他结果的令牌。 |
|
|
一致性级别
|
consistencyLevel | string |
源（查询/读取源）作所需的一致性级别。 |
|
|
会话令牌
|
sessionToken | string |
用于会话一致性的会话令牌。 |
返回
与请求的查询和相关元数据匹配的文档数组。
- Body
- DocumentsCollection
查询文档 V5
查询文档 （V5）。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Azure Cosmos DB 帐户名称
|
cosmosDbAccountName | True | string |
Azure Cosmos DB 帐户名称（无 documents.azure.com）。 |
|
数据库 ID
|
databaseId | True | string |
数据库的名称。 |
|
容器 ID
|
containerId | True | string |
容器的名称。 |
|
SQL 语法查询
|
queryText | string |
SQL 查询。 如果为空，则返回所有文档。 |
|
|
分区键值
|
partitionKey | string |
必须根据其类型（“string”， 42， 0.5） 提供值。 如果为空，则所有分区将用于搜索文档。 |
|
|
最大项计数
|
maxItemCount | integer |
一个整数，指示每页要返回的最大项数。 |
|
|
继续标记
|
continuationToken | string |
用于获取其他结果的令牌。 |
|
|
一致性级别
|
consistencyLevel | string |
源（查询/读取源）作所需的一致性级别。 |
|
|
会话令牌
|
sessionToken | string |
用于会话一致性的会话令牌。 |
返回
与请求的查询和相关元数据匹配的文档数组。
- Body
- DocumentsCollection
获取存储过程 [已弃用]
此作已弃用。 请改用 Get 存储过程 （V2）。
获取指定集合中的存储过程。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
数据库 ID
|
databaseId | True | string |
数据库的名称。 |
|
集合 ID
|
collectionId | True | string |
集合的名称。 |
|
API 版本
|
x-ms-version | string |
API 版本。 |
返回
获取存储过程 （V2）
获取指定集合中的存储过程（V2）。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Azure Cosmos DB 帐户名称
|
cosmosDbAccountName | True | string |
Azure Cosmos DB 帐户名称（无 documents.azure.com）。 |
|
数据库 ID
|
databaseId | True | string |
数据库的名称。 |
|
集合 ID
|
collectionId | True | string |
集合的名称。 |
|
API 版本
|
x-ms-version | string |
API 版本。 |
返回
获取所有文档 [已弃用]
此作已弃用。 请改用“获取所有文档”（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 |
用于会话级别一致性的字符串令牌。 |
|
|
活动 ID
|
x-ms-activity-id | string |
客户端为作提供标识符，该标识符将在服务器响应中回显。 |
|
|
数据库 ID
|
databaseId | True | string |
数据库的名称。 |
|
集合 ID
|
collectionId | True | string |
集合的名称。 |
|
API 版本
|
x-ms-version | string |
API 版本。 |
返回
- Body
- getDocumentsResponse
获取所有文档 V2 [已弃用]
此作已弃用。 请改用“获取所有文档”（V3）。
获取所有文档 V2。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
数据库 ID
|
databaseId | True | string |
数据库的名称。 |
|
集合 ID
|
collectionId | True | string |
集合的名称。 |
|
分区键值
|
partitionKey | string |
如果为空，则所有分区将用于搜索文档。 |
|
|
最大项计数
|
maxItemCount | integer |
一个整数，指示每页要返回的最大项数。 |
|
|
继续标记
|
continuationToken | string |
用于获取其他结果的令牌。 |
|
|
一致性级别
|
consistencyLevel | string |
源（查询/读取源）作所需的一致性级别。 |
|
|
会话令牌
|
sessionToken | string |
用于会话一致性的会话令牌。 |
返回
与请求的查询和相关元数据匹配的文档数组。
- Body
- DocumentsCollection
获取所有文档（V3）
获取所有文档（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 |
用于会话级别一致性的字符串令牌。 |
|
|
活动 ID
|
x-ms-activity-id | string |
客户端为作提供标识符，该标识符将在服务器响应中回显。 |
|
|
Azure Cosmos DB 帐户名称
|
cosmosDbAccountName | True | string |
Azure Cosmos DB 帐户名称（无 documents.azure.com）。 |
|
数据库 ID
|
databaseId | True | string |
数据库的名称。 |
|
集合 ID
|
collectionId | True | string |
集合的名称。 |
|
API 版本
|
x-ms-version | string |
API 版本。 |
返回
- Body
- getDocumentsResponse
获取文档 [已弃用]
此作已弃用。 请改用“获取文档”（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 |
用于会话级别一致性的字符串令牌。 |
|
|
活动 ID
|
x-ms-activity-id | string |
客户端为作提供标识符，该标识符将在服务器响应中回显。 |
|
|
数据库 ID
|
databaseId | True | string |
数据库的名称。 |
|
集合 ID
|
collectionId | True | string |
集合的名称。 |
|
文档 ID
|
documentId | True | string |
文档的标识符。 |
|
API 版本
|
x-ms-version | string |
API 版本。 |
返回
- response
- object
获取文档 （V2）
获取文档（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 |
用于会话级别一致性的字符串令牌。 |
|
|
活动 ID
|
x-ms-activity-id | string |
客户端为作提供标识符，该标识符将在服务器响应中回显。 |
|
|
Azure Cosmos DB 帐户名称
|
cosmosDbAccountName | True | string |
Azure Cosmos DB 帐户名称（无 documents.azure.com）。 |
|
数据库 ID
|
databaseId | True | string |
数据库的名称。 |
|
集合 ID
|
collectionId | True | string |
集合的名称。 |
|
文档 ID
|
documentId | True | string |
文档的标识符。 |
|
API 版本
|
x-ms-version | string |
API 版本。 |
返回
- response
- object
定义
QueryDocumentsResponse
与请求的查询和相关元数据匹配的文档数组。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
文档
|
Documents | array of ObjectWithoutType |
与请求匹配的文档数组。 |
|
文档数
|
_count | integer |
文档数。 |
|
活动编号
|
ActivityId | string |
Azure Cosmos DB 服务活动 ID。 |
DocumentsCollection
与请求的查询和相关元数据匹配的文档数组。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
文档
|
value | array of ObjectWithoutType | |
|
继续标记
|
ContinuationToken | string | |
|
文档数
|
Count | integer | |
|
请求费用
|
RequestCharge | double | |
|
会话令牌
|
SessionToken | string | |
|
活动 ID
|
ActivityId | string |
postDocumentsResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
_rid
|
_rid | string | |
|
_ts
|
_ts | integer | |
|
_自我
|
_self | string | |
|
_etag
|
_etag | string | |
|
_附件
|
_attachments | string | |
|
id
|
id | string |
putDocumentResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
_rid
|
_rid | string | |
|
id
|
id | string |
getDocumentsResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
_rid
|
_rid | string | |
|
文档
|
Documents | array of object |
queryResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
_rid
|
_rid | string | |
|
_计数
|
_count | number | |
|
文档
|
Documents | array of |
getStoredProceduresResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
_计数
|
_count | integer |
_计数 |
|
_rid
|
_rid | string |
_rid |
|
Stored程序
|
StoredProcedures | array of object |
Stored程序 |
|
_etag
|
StoredProcedures._etag | string |
_etag |
|
_rid
|
StoredProcedures._rid | string |
_rid |
|
_自我
|
StoredProcedures._self | string |
_自我 |
|
_ts
|
StoredProcedures._ts | integer |
_ts |
|
身体
|
StoredProcedures.body | string |
身体 |
|
id
|
StoredProcedures.id | string |
id |
createStoredProcedureResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
_etag
|
_etag | string |
_etag |
|
_rid
|
_rid | string |
_rid |
|
_自我
|
_self | string |
_自我 |
|
_ts
|
_ts | integer |
_ts |
|
身体
|
body | string |
身体 |
|
id
|
id | string |
id |
ObjectWithoutType
字符串
这是基本数据类型“string”。
对象
这是类型“object”。