Azure Cosmos DB

Azure Cosmos DB 是全域分散式多模型資料庫服務，其設計可讓您透過完整的 SLA 在任意數目的地理區域之間彈性且獨立地調整輸送量和儲存體。

此連接器適用於以下產品和區域：

服務	Class	Regions
副駕駛工作室	進階	所有 Power Automate 區域
邏輯應用程式	標準	所有 Logic Apps 區域
Power Apps	-	無法提供
Power Automate（自動化服務）	進階	所有 Power Automate 區域

連接器中繼資料
Publisher	Microsoft

若要使用此整合，您必須在 Azure 入口網站中設定 Cosmos DB SQL API 帳戶。請注意，目前不支援 Mongo DB API 帳戶。

建立 SQL API 帳戶之後，如果建立類型的連線 Access Key ，請在建立與 Azure Cosmos DB 連接器的連線時提供帳戶識別碼（不含 'documents.azure.com'）。支援 Microsoft Entra ID 驗證的較新作業版本也需要此帳戶識別碼。

Microsoft Entra ID 驗證和 Cosmos DB 連接器

若要使用 Microsoft Entra ID 驗證，必須為正在使用的帳戶指派特定的角色指派，如需詳細資訊，請瀏覽使用 Microsoft Entra ID 為您的 Azure Cosmos DB 帳戶設定角色型存取控制。

備註

只有 明確定義為 資料存取的角色，才允許安全性主體存取 Cosmos DB 資料。內建角色，例如 Owner，或 Contributor不會透過 Microsoft Entra ID 提供該帳戶內 Cosmos DB 資料的存取權。 Azure Cosmos DB 會公開 2 個內建角色：

Cosmos DB Built-in Data Reader （角色定義 ID 00000000-0000-0000-0000-000000000001）
Cosmos DB Built-in Data Contributor （角色定義 ID 00000000-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 限制。
連接器不支援選擇寫入區域和多重寫入區域。
「分割區索引鍵值」必須根據其類型提供。例如，字串值應該用引號括起來，數字應該按原樣提供。例如：「 字串值」、 123、 0.5。
在分割集合上執行的具有、 DISTINCT等的ORDER BY查詢需要「分割區索引鍵值」。
查詢文件 V2 [已取代]、查詢文件 V3、取得所有文件 V2 （預覽）動作會使用適用於 SQL API 的 Azure Cosmos DB .NET SDK （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 自訂值。

這很重要

Microsoft Entra ID 整合（Azure 商業） 連線預設會在美國 政府（GCC） 環境中停用。若要啟用這些類型的連線，租用戶管理員必須在 Power Platform 系統管理中心啟用連線 至 Azure 商業設定 。

開啟此設定可連線至 Azure 商業中資源，這些資源會在 Power Platform 美國政府合規性界限之外運作和傳送資料。這專門用於允許從 Power Platform 連接器的 GCC 雲端版本存取商業資源。

Microsoft Entra ID 整合（Azure 商業） 是唯一適用於從美國政府（GCC） 環境到 Azure 商業資源的驗證類型。

預設已停用 Azure 商業驗證：預設為停用

Power Platform 系統管理中心中的 連線至 Azure 商業 設定：系統管理員檢視

正在建立連線

連接器支援下列驗證類型：


存取金鑰	提供帳戶名稱和存取金鑰，以存取您的 Cosmos DB 帳戶。	Azure Government 和美國政府（GCC）和美國政府（GCC-High）中的 Azure Government 和國防部（DoD）以外的所有區域	可共用
存取金鑰（Azure 政府）	提供帳戶名稱和存取金鑰，以存取您的 Cosmos DB 帳戶。	Azure Government 和國防部（DoD）僅限 Azure Government 和 US Government （GCC）和美國政府（GCC-High）	可共用
Logic Apps 受控識別	使用 LogicApps 受控識別建立連線	僅限 LOGICAPPS	可共用
Microsoft Entra ID 整合式	使用 Microsoft Entra ID 來存取您的 Azure Blob 儲存體。	Azure Government 和美國政府（GCC）和美國政府（GCC-High）中的 Azure Government 和國防部（DoD）以外的所有區域	不可共享
Microsoft Entra ID 整合式（Azure 商業版）	使用 Microsoft Entra ID 在 Azure 商業版中存取 Azure Blob 儲存體。	僅限美國政府（GCC）	不可共享
Microsoft Entra ID 整合式（Azure 政府）	使用 Microsoft Entra ID 來存取您的 Azure Blob 儲存體。	Azure Government 和國防部（DoD）僅限 Azure Government 和 US Government （GCC）和美國政府（GCC-High）	不可共享
預設值 [已棄用]	此選項僅適用於沒有明確驗證類型的舊連線，並且僅用於回溯相容性。	所有區域	不可共享

存取鍵

驗證 ID：keyBasedAuth

適用：Azure Government 和美國政府（GCC）和美國政府（GCC-High）中的 Azure Government 和國防部（DoD）以外的所有區域

提供帳戶名稱和存取金鑰，以存取您的 Cosmos DB 帳戶。

這是可共享的連接。如果 Power App 與其他使用者共用，也會共用連線。如需詳細資訊，請參閱畫布應用程式的連接器概觀 - Power Apps |Microsoft 文件

名稱	類型	Description	為必填項目
帳戶識別碼	字串	沒有「documents.azure.com」部分的帳戶名稱	對
Azure Cosmos DB 帳戶的存取金鑰	securestring	主鍵或次要鍵	對

存取金鑰（Azure 政府）

驗證 ID：keyBasedAuth

適用：Azure Government 和 Department of Defense （DoD）僅限 Azure Government 和 US Government （GCC）和 US Government （GCC-High）

提供帳戶名稱和存取金鑰，以存取您的 Cosmos DB 帳戶。

這是可共享的連接。如果 Power App 與其他使用者共用，也會共用連線。如需詳細資訊，請參閱畫布應用程式的連接器概觀 - Power Apps |Microsoft 文件

名稱	類型	Description	為必填項目
帳戶識別碼	字串	沒有「documents.azure.com」部分的帳戶名稱	對
Azure Cosmos DB 帳戶的存取金鑰	securestring	主鍵或次要鍵	對

Logic Apps 受控識別

驗證 ID：managedIdentityAuth

適用：僅限 LOGICAPPS

使用 LogicApps 受控識別建立連線

這是可共享的連接。如果 Power App 與其他使用者共用，也會共用連線。如需詳細資訊，請參閱畫布應用程式的連接器概觀 - Power Apps |Microsoft 文件

名稱	類型	Description	為必填項目
LogicApps 受控識別	managedIdentity	使用 Logic Apps 受控識別登入	對

Microsoft Entra ID 整合

驗證識別碼：tokenBasedAuth

適用：Azure Government 和美國政府（GCC）和美國政府（GCC-High）中的 Azure Government 和國防部（DoD）以外的所有區域

使用 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 政府）

驗證識別碼：tokenBasedAuth

適用：Azure Government 和 Department of Defense （DoD）僅限 Azure Government 和 US Government （GCC）和 US Government （GCC-High）

使用 Microsoft Entra ID 來存取您的 Azure Blob 儲存體。

這不是可共用的連線。如果 Power App 與其他使用者共用，系統會明確提示其他使用者建立新連線。

預設值 [已棄用]

適用：所有地區

此選項僅適用於沒有明確驗證類型的舊連線，並且僅用於回溯相容性。

這不是可共用的連線。如果 Power App 與其他使用者共用，系統會明確提示其他使用者建立新連線。

名稱	類型	Description	為必填項目
帳戶識別碼	字串	沒有「documents.azure.com」部分的帳戶名稱	對
Azure Cosmos DB 帳戶的存取金鑰	securestring	主鍵或次要鍵	對

節流限制

名稱	呼叫	續約期間
每個連線的 API 呼叫	1500	60 秒

動作

刪除文件 [已棄用]	此動作已被取代。請改用刪除文件（V2）。 ~~刪除文件。~~
刪除文件（V2）	刪除文件（V2）。
刪除預存程序 [已淘汰]	此動作已被取代。請改用刪除預存程序（V2）。 ~~刪除預存程序。~~
刪除預存程序（V2）	刪除預存程序（V2）。
取代文件 [已棄用]	此動作已被取代。請改用替換文檔（V2）。 ~~取代文件。~~
取代文件（V2）	取代文件（V2）。
取代預存程序 [已淘汰]	此動作已被取代。請改用 [取代預存程序（V2）]。 ~~取代預存程序。~~
取代預存程序（V2）	取代預存程序（V2）。
取得所有文件 [已淘汰]	此動作已被取代。請改用取得所有文件（V3）。 ~~取得所有文件。~~
取得所有文件 V2 [已淘汰]	此動作已被取代。請改用取得所有文件（V3）。 ~~取得所有文件 V2。~~
取得所有文件（V3）	取得所有文件（V3）。
取得文件 [已淘汰]	此動作已被取代。請改用取得文件（V2）。 ~~取得文件。~~
取得文件（V2）	取得文件（V2）。
取得預存程序 [已淘汰]	此動作已被取代。請改用取得預存程序（V2）。 ~~取得指定集合中的預存程序。~~
取得預存程序（V2）	取得指定集合（V2）中的預存程序。
執行預存程序 [已淘汰]	此動作已被取代。請改用 [執行預存程序（V2）]。 ~~在指定的集合中執行預存程序。~~
執行預存程序（V2）	在指定的集合（V2）中執行預存程序。
建立或更新文件 [已棄用]	此動作已被取代。請改用建立或更新文件（V3）。 ~~建立或更新文件。在 DocumentDB 中建立文件時，本文必須包含 id 屬性。~~
建立或更新文件（V2） [已淘汰]	此動作已被取代。請改用建立或更新文件（V3）。 ~~建立或更新文件。在 DocumentDB 中建立文件時，本文必須包含 id 屬性。~~
建立或更新文件（V3）	建立或更新文件。在 DocumentDB 中建立文件時，本文必須包含 id 屬性。
建立預存程序 [已淘汰]	此動作已被取代。請改用建立預存程序（V2）。 ~~建立預存程序。~~
建立預存程序（V2）	建立預存程序（V2）。
查詢文件 [已淘汰]	此動作已被取代。請改用查詢文件 V5 。 ~~查詢文件。~~
查詢文件 V2 [已淘汰]	此動作已被取代。請改用查詢文件 V5 。 ~~查詢文件 V2。~~
查詢文件 V3 [已淘汰]	此動作已被取代。請改用查詢文件 V5 。 ~~查詢文件 V3。~~
查詢文件 V4 [已淘汰]	此動作已被取代。請改用查詢文件 V5 。 ~~查詢文件 V4。~~
查詢文件 V5	查詢文件（V5）。

刪除文件 [已棄用]

作業識別碼：: DeleteDocument

此動作已被取代。請改用刪除文件（V2）。

~~刪除文件。~~

參數

名稱	機碼	必要	類型	Description
分割區索引鍵值	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	資料庫的名稱。
集合 ID	collectionId	True	string	集合的名稱。
文件 ID	documentId	True	string	文件的識別碼。
API 版本	x-ms-version		string	API 版本。

刪除文件（V2）

作業識別碼：: DeleteDocument_V2

刪除文件（V2）。

參數

名稱	機碼	必要	類型	Description
分割區索引鍵值	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	資料庫的名稱。
集合 ID	collectionId	True	string	集合的名稱。
文件 ID	documentId	True	string	文件的識別碼。
API 版本	x-ms-version		string	API 版本。

刪除預存程序 [已淘汰]

作業識別碼：: DeleteStoredProcedure

此動作已被取代。請改用刪除預存程序（V2）。

~~刪除預存程序。~~

參數

名稱	機碼	必要	類型	Description
資料庫識別碼	databaseId	True	string	資料庫的名稱。
集合 ID	collectionId	True	string	集合的名稱。
程序識別碼	sprocId	True	string	預存程序的名稱。
API 版本	x-ms-version		string	API 版本。

傳回

response: string

刪除預存程序（V2）

作業識別碼：: DeleteStoredProcedure_V2

刪除預存程序（V2）。

參數

名稱	機碼	必要	類型	Description
Azure Cosmos DB 帳戶名稱	cosmosDbAccountName	True	string	Azure Cosmos DB 帳戶名稱（不含 documents.azure.com）。
資料庫識別碼	databaseId	True	string	資料庫的名稱。
集合 ID	collectionId	True	string	集合的名稱。
程序識別碼	sprocId	True	string	預存程序的名稱。
API 版本	x-ms-version		string	API 版本。

傳回

response: string

取代文件 [已棄用]

作業識別碼：: ReplaceDocument

此動作已被取代。請改用替換文檔（V2）。

~~取代文件。~~

參數

名稱	機碼	必要	類型	Description
分割區索引鍵值	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	資料庫的名稱。
集合 ID	collectionId	True	string	集合的名稱。
文件 ID	documentId	True	string	文件的識別碼。
API 版本	x-ms-version		string	API 版本。

傳回

身體: putDocumentResponse

取代文件（V2）

作業識別碼：: ReplaceDocument_V2

取代文件（V2）。

參數

名稱	機碼	必要	類型	Description
分割區索引鍵值	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	資料庫的名稱。
集合 ID	collectionId	True	string	集合的名稱。
文件 ID	documentId	True	string	文件的識別碼。
API 版本	x-ms-version		string	API 版本。

傳回

身體: putDocumentResponse

取代預存程序 [已淘汰]

作業識別碼：: ReplaceStoredProcedure

此動作已被取代。請改用 [取代預存程序（V2）]。

~~取代預存程序。~~

參數

名稱	機碼	必要	類型	Description
資料庫識別碼	databaseId	True	string	資料庫的名稱。
集合 ID	collectionId	True	string	集合的名稱。
程序識別碼	sprocId	True	string	預存程序的名稱。
函式定義	body		string	定義預存程序的函數，例如 'function（params）{ ... }'
識別碼	id		string	現有預存程序的標識碼。
API 版本	x-ms-version		string	API 版本。

傳回

身體: createStoredProcedureResponse

取代預存程序（V2）

作業識別碼：: ReplaceStoredProcedure_V2

取代預存程序（V2）。

參數

名稱	機碼	必要	類型	Description
Azure Cosmos DB 帳戶名稱	cosmosDbAccountName	True	string	Azure Cosmos DB 帳戶名稱（不含 documents.azure.com）。
資料庫識別碼	databaseId	True	string	資料庫的名稱。
集合 ID	collectionId	True	string	集合的名稱。
程序識別碼	sprocId	True	string	預存程序的名稱。
函式定義	body		string	定義預存程序的函數，例如 'function（params）{ ... }'
識別碼	id		string	現有預存程序的標識碼。
API 版本	x-ms-version		string	API 版本。

傳回

身體: createStoredProcedureResponse

取得所有文件 [已淘汰]

作業識別碼：: GetDocuments

此動作已被取代。請改用取得所有文件（V3）。

~~取得所有文件。~~

參數

名稱	機碼	必要	類型	Description
分割區索引鍵值	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	資料庫的名稱。
集合 ID	collectionId	True	string	集合的名稱。
API 版本	x-ms-version		string	API 版本。

傳回

身體: getDocumentsResponse

取得所有文件 V2 [已淘汰]

作業識別碼：: GetDocumentsV2

此動作已被取代。請改用取得所有文件（V3）。

~~取得所有文件 V2。~~

參數

名稱	機碼	必要	類型	Description
資料庫識別碼	databaseId	True	string	資料庫的名稱。
集合 ID	collectionId	True	string	集合的名稱。
分割區索引鍵值	partitionKey		string	如果為空，則所有分割區都將用於搜尋文件。
最大項目計數	maxItemCount		integer	一個整數，表示每頁要傳回的項目數目上限。
延續權杖	continuationToken		string	用於擷取其他結果的權杖。
一致性等級	consistencyLevel		string	摘要（查詢/讀取摘要）作業所需的一致性層級。
工作階段權杖	sessionToken		string	與工作階段一致性搭配使用的工作階段權杖。

傳回

符合所要求查詢和相關中繼資料的文件陣列。

身體: DocumentsCollection

取得所有文件（V3）

作業識別碼：: GetDocuments_V3

取得所有文件（V3）。

參數

名稱	機碼	必要	類型	Description
分割區索引鍵值	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	資料庫的名稱。
集合 ID	collectionId	True	string	集合的名稱。
API 版本	x-ms-version		string	API 版本。

傳回

身體: getDocumentsResponse

取得文件 [已淘汰]

作業識別碼：: GetDocument

此動作已被取代。請改用取得文件（V2）。

~~取得文件。~~

參數

名稱	機碼	必要	類型	Description
分割區索引鍵值	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	資料庫的名稱。
集合 ID	collectionId	True	string	集合的名稱。
文件 ID	documentId	True	string	文件的識別碼。
API 版本	x-ms-version		string	API 版本。

傳回

response: object

取得文件（V2）

作業識別碼：: GetDocument_V2

取得文件（V2）。

參數

名稱	機碼	必要	類型	Description
分割區索引鍵值	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	資料庫的名稱。
集合 ID	collectionId	True	string	集合的名稱。
文件 ID	documentId	True	string	文件的識別碼。
API 版本	x-ms-version		string	API 版本。

傳回

response: object

取得預存程序 [已淘汰]

作業識別碼：: GetStoredProcedures

此動作已被取代。請改用取得預存程序（V2）。

~~取得指定集合中的預存程序。~~

參數

名稱	機碼	必要	類型	Description
資料庫識別碼	databaseId	True	string	資料庫的名稱。
集合 ID	collectionId	True	string	集合的名稱。
API 版本	x-ms-version		string	API 版本。

傳回

身體: getStoredProceduresResponse

取得預存程序（V2）

作業識別碼：: GetStoredProcedures_V2

取得指定集合（V2）中的預存程序。

參數

名稱	機碼	必要	類型	Description
Azure Cosmos DB 帳戶名稱	cosmosDbAccountName	True	string	Azure Cosmos DB 帳戶名稱（不含 documents.azure.com）。
資料庫識別碼	databaseId	True	string	資料庫的名稱。
集合 ID	collectionId	True	string	集合的名稱。
API 版本	x-ms-version		string	API 版本。

傳回

身體: getStoredProceduresResponse

執行預存程序 [已淘汰]

作業識別碼：: ExecuteStoredProcedure

此動作已被取代。請改用 [執行預存程序（V2）]。

~~在指定的集合中執行預存程序。~~

參數

名稱	機碼	必要	類型	Description
資料庫識別碼	databaseId	True	string	資料庫的名稱。
集合 ID	collectionId	True	string	集合的名稱。
分割區索引鍵值	x-ms-documentdb-raw-partitionkey		string	所要求文件或附件作業的分割區索引鍵值。
程序識別碼	sprocId	True	string	預存程序的名稱。
預存程序的參數	parameters		string	為預存程序的參數指定有效的 JSON，例如 [“param1”， “param2”]。
API 版本	x-ms-version		string	API 版本。

傳回

response: ObjectWithoutType

執行預存程序（V2）

作業識別碼：: ExecuteStoredProcedure_V2

在指定的集合（V2）中執行預存程序。

參數

名稱	機碼	必要	類型	Description
Azure Cosmos DB 帳戶名稱	cosmosDbAccountName	True	string	Azure Cosmos DB 帳戶名稱（不含 documents.azure.com）。
資料庫識別碼	databaseId	True	string	資料庫的名稱。
集合 ID	collectionId	True	string	集合的名稱。
分割區索引鍵值	x-ms-documentdb-raw-partitionkey		string	所要求文件或附件作業的分割區索引鍵值。
程序識別碼	sprocId	True	string	預存程序的名稱。
預存程序的參數	parameters		string	為預存程序的參數指定有效的 JSON，例如 [“param1”， “param2”]。
API 版本	x-ms-version		string	API 版本。

傳回

response: ObjectWithoutType

建立或更新文件 [已棄用]

作業識別碼：: CreateDocument

此動作已被取代。請改用建立或更新文件（V3）。

~~建立或更新文件。在 DocumentDB 中建立文件時，本文必須包含 id 屬性。~~

參數

名稱	機碼	必要	類型	Description
分割區索引鍵值	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	資料庫的名稱。
集合 ID	collectionId	True	string	集合的名稱。
API 版本	x-ms-version		string	API 版本。

傳回

身體: postDocumentsResponse

建立或更新文件（V2） [已淘汰]

作業識別碼：: CreateDocumentV2

此動作已被取代。請改用建立或更新文件（V3）。

~~建立或更新文件。在 DocumentDB 中建立文件時，本文必須包含 id 屬性。~~

參數

名稱	機碼	必要	類型	Description
最大項目計數	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	資料庫的名稱。
集合 ID	collectionId	True	string	集合的名稱。
API 版本	x-ms-version		string	API 版本。

傳回

身體: postDocumentsResponse

建立或更新文件（V3）

作業識別碼：: CreateDocument_V3

建立或更新文件。在 DocumentDB 中建立文件時，本文必須包含 id 屬性。

參數

名稱	機碼	必要	類型	Description
最大項目計數	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	資料庫的名稱。
集合 ID	collectionId	True	string	集合的名稱。
API 版本	x-ms-version		string	API 版本。

傳回

身體: postDocumentsResponse

建立預存程序 [已淘汰]

作業識別碼：: CreateStoredProcedure

此動作已被取代。請改用建立預存程序（V2）。

~~建立預存程序。~~

參數

名稱	機碼	必要	類型	Description
資料庫識別碼	databaseId	True	string	資料庫的名稱。
集合 ID	collectionId	True	string	集合的名稱。
函式定義	body		string	定義預存程序的函數，例如 'function（params）{ ... }'
識別碼	id		string	預存程序的新識別碼。
API 版本	x-ms-version		string	API 版本。

傳回

身體: createStoredProcedureResponse

建立預存程序（V2）

作業識別碼：: CreateStoredProcedure_V2

建立預存程序（V2）。

參數

名稱	機碼	必要	類型	Description
Azure Cosmos DB 帳戶名稱	cosmosDbAccountName	True	string	Azure Cosmos DB 帳戶名稱（不含 documents.azure.com）。
資料庫識別碼	databaseId	True	string	資料庫的名稱。
集合 ID	collectionId	True	string	集合的名稱。
函式定義	body		string	定義預存程序的函數，例如 'function（params）{ ... }'
識別碼	id		string	預存程序的新識別碼。
API 版本	x-ms-version		string	API 版本。

傳回

身體: createStoredProcedureResponse

查詢文件 [已淘汰]

作業識別碼：: QueryDocuments

此動作已被取代。請改用查詢文件 V5 。

~~查詢文件。~~

參數

名稱	機碼	必要	類型	Description
分割區索引鍵值	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	資料庫的名稱。
集合 ID	collectionId	True	string	集合的名稱。
查詢	query		string

傳回

身體: queryResponse

查詢文件 V2 [已淘汰]

作業識別碼：: QueryDocumentsV2

此動作已被取代。請改用查詢文件 V5 。

~~查詢文件 V2。~~

參數

名稱	機碼	必要	類型	Description
資料庫識別碼	databaseId	True	string	資料庫的名稱。
集合 ID	collectionId	True	string	集合的名稱。
QueryText	QueryText		string	SQL 語法查詢文件
分割區索引鍵值	partitionKey		string	分割區索引鍵值。
延續權杖	continuationToken		string	從作業擷取其他結果的權杖。

傳回

符合所要求查詢和相關中繼資料的文件陣列。

身體: QueryDocumentsResponse

查詢文件 V3 [已淘汰]

作業識別碼：: QueryDocumentsV3

此動作已被取代。請改用查詢文件 V5 。

~~查詢文件 V3。~~

參數

名稱	機碼	必要	類型	Description
資料庫識別碼	databaseId	True	string	資料庫的名稱。
集合 ID	collectionId	True	string	集合的名稱。
SQL 語法查詢	queryText	True	string	SQL 查詢。
分割區索引鍵值	partitionKey		string	如果為空，則所有分割區都將用於搜尋文件。
最大項目計數	maxItemCount		integer	一個整數，表示每頁要傳回的項目數目上限。
延續權杖	continuationToken		string	用於擷取其他結果的權杖。
啟用跨分割區	enableCrossPartition		boolean	指出使用者是否能夠傳送多個要求來執行查詢。
一致性等級	consistencyLevel		string	摘要（查詢/讀取摘要）作業所需的一致性層級。
工作階段權杖	sessionToken		string	與工作階段一致性搭配使用的工作階段權杖。

傳回

符合所要求查詢和相關中繼資料的文件陣列。

身體: DocumentsCollection

查詢文件 V4 [已淘汰]

作業識別碼：: QueryDocumentsV4

此動作已被取代。請改用查詢文件 V5 。

~~查詢文件 V4。~~

參數

名稱	機碼	必要	類型	Description
資料庫識別碼	databaseId	True	string	資料庫的名稱。
容器識別碼	containerId	True	string	容器的名稱。
SQL 語法查詢	queryText		string	SQL 查詢。如果為空，將傳回所有文件。
分割區索引鍵值	partitionKey		string	如果為空，則所有分割區都將用於搜尋文件。
最大項目計數	maxItemCount		integer	一個整數，表示每頁要傳回的項目數目上限。
延續權杖	continuationToken		string	用於擷取其他結果的權杖。
一致性等級	consistencyLevel		string	摘要（查詢/讀取摘要）作業所需的一致性層級。
工作階段權杖	sessionToken		string	與工作階段一致性搭配使用的工作階段權杖。

傳回

符合所要求查詢和相關中繼資料的文件陣列。

身體: DocumentsCollection

查詢文件 V5

作業識別碼：: QueryDocuments_V5

查詢文件（V5）。

參數

名稱	機碼	必要	類型	Description
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

定義

查詢文件回應

符合所要求查詢和相關中繼資料的文件陣列。

名稱	路徑	類型	Description
Documents	Documents	array of ObjectWithoutType	符合要求的文件陣列。
文件數量	_count	integer	文件數量。
活動識別碼	ActivityId	string	Azure Cosmos DB 服務活動識別碼。

文件集合

符合所要求查詢和相關中繼資料的文件陣列。

名稱	路徑	類型
Documents	value	array of ObjectWithoutType
延續權杖	ContinuationToken	string
文件數量	Count	integer
請求費用	RequestCharge	double
工作階段權杖	SessionToken	string
活動標識符	ActivityId	string

postDocuments回應

名稱	路徑	類型
_rid	_rid	string
_ts	_ts	integer
_自己	_self	string
_etag	_etag	string
_attachments	_attachments	string
識別碼	id	string

putDocument回應

名稱	路徑	類型	Description
_rid	_rid	string
識別碼	id	string

getDocuments回應

名稱	路徑	類型	Description
_rid	_rid	string
Documents	Documents	array of object

查詢回應

名稱	路徑	類型
_rid	_rid	string
_算	_count	number
Documents	Documents	array of

getStoredProcedures回應

名稱	路徑	類型	Description
_算	_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
body	StoredProcedures.body	string	body
識別碼	StoredProcedures.id	string	識別碼

createStoredProcedureResponse

名稱	路徑	類型	Description
_etag	_etag	string	_etag
_rid	_rid	string	_rid
_自己	_self	string	_自己
_ts	_ts	integer	_ts
body	body	string	body
識別碼	id	string	識別碼

物件無類型

字串

這是基本資料類型「string」。

物件

這是類型 'object'。

共用方式為

Azure Cosmos DB

Microsoft Entra ID 驗證和 Cosmos DB 連接器

Microsoft Entra ID 驗證不支援的作業

已知問題和限制

正在建立連線

存取鍵

存取金鑰 （Azure 政府）

Logic Apps 受控識別

Microsoft Entra ID 整合

Microsoft Entra ID 整合式 （Azure 商業版）

Microsoft Entra ID 整合式 （Azure 政府）

預設值 [已棄用]

節流限制

動作

刪除文件 [已棄用]

參數

刪除文件 （V2）

參數

刪除預存程序 [已淘汰]

參數

傳回

刪除預存程序 （V2）

參數

傳回

取代文件 [已棄用]

參數

傳回

取代文件 （V2）

參數

傳回

取代預存程序 [已淘汰]

參數

傳回

取代預存程序 （V2）

參數

傳回

取得所有文件 [已淘汰]

參數

傳回

取得所有文件 V2 [已淘汰]

參數

傳回

取得所有文件 （V3）

參數

傳回

取得文件 [已淘汰]

參數

傳回

取得文件 （V2）

參數

傳回

取得預存程序 [已淘汰]

參數

傳回

取得預存程序 （V2）

參數

傳回

執行預存程序 [已淘汰]

參數

傳回

執行預存程序 （V2）

參數

傳回

建立或更新文件 [已棄用]

參數

傳回

建立或更新文件 （V2） [已淘汰]

參數

傳回

建立或更新文件 （V3）

參數

傳回

建立預存程序 [已淘汰]

參數

傳回

建立預存程序 （V2）

參數

傳回

查詢文件 [已淘汰]

存取金鑰（Azure 政府）

Microsoft Entra ID 整合式（Azure 商業版）

Microsoft Entra ID 整合式（Azure 政府）

刪除文件（V2）

刪除預存程序（V2）

取代文件（V2）

取代預存程序（V2）

取得所有文件（V3）

取得文件（V2）

取得預存程序（V2）

執行預存程序（V2）

建立或更新文件（V2） [已淘汰]

建立或更新文件（V3）

建立預存程序（V2）