Azure Cosmos DB

Azure Cosmos DB は、包括的な SLA を使用して、任意の数の地域にわたってスループットとストレージを柔軟かつ独立してスケールできるように設計された、グローバル分散マルチモデル データベース サービスです。

このコネクタは、次の製品および地域で利用可能です。

Service クラス 地域
Logic Apps 標準 すべての Logic Apps 地域および統合サービス環境 (ISE)
Power Automate プレミアム すべての Power Automate 地域
Power Apps - 該当なし
コネクタ メタデータ
発行者 マイクロソフト

この統合を使用するには、Azure Portal で構成されている Cosmos DB SQL API アカウントが必要です。 Mongo DB API アカウントは現在サポートされていませんのでご注意ください。

SQL API アカウントが作成されたら、Access Key タイプの接続を作成する場合は、Azure Cosmos DB コネクタを使用して接続を作成するときにアカウント ID ('documents.azure.com' の部分を除く) を指定します。 このアカウント ID は、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 データへのアクセスを提供しません。 2 つの組み込みロールが Azure Cosmos DB により公開されています

  1. Cosmos DB Built-in Data Reader (ロールの定義 ID 00000000-0000-0000-0000-000000000001)
  2. 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 接続でのみ動作します

  1. ストアド プロシージャを作成する (V1 および V2 バージョン)
  2. ストアド プロシージャを削除する (V1 および V2 バージョン)
  3. ストアド プロシージャを更新する (V1 および V2 バージョン)

Microsoft Entra ID 認証でサポートされていない操作

Microsoft Entra ID 認証を使用している場合、パラメーターとして Cosmos DB アカウント名を使用しているアクションのみがサポートされます。 非推奨アクションは引き続き Access Key 認証で機能しますが、Microsoft Entra AAD 接続で使用すると失敗します。

既知の問題と制限事項

接続の作成

コネクタは、次の認証タイプをサポートしています:

アクセス キー Cosmos DB アカウントにアクセスできるアカウント名とアクセス キーを入力してください。 Azure Government、米国政府 (GCC)、米国政府 (GCC-High) における Azure Government と国防総省 (DOD) を除くすべての地域 共有可能
アクセス キー (Azure Government) Cosmos DB アカウントにアクセスできるアカウント名とアクセス キーを入力してください。 Azure Government、Azure Government の国防総省 (DoD)、米国政府 (GCC)、および米国政府 (GCC-High) のみ 共有可能
Azure AD 統合 Azure Active Directory を使用して、Azure Blob Storage にアクセスします。 MOONCAKE のみ 共有不可
Azure AD 統合 (Azure Government) Azure Active Directory を使用して、Azure Blob Storage にアクセスします。 Azure Government、米国政府 (GCC)、米国政府 (GCC-High) における Azure Government と国防総省 (DoD) のみ 共有不可
Logic Apps マネージド ID LogicApps Managed Identity を使用して接続を作成する LOGICAPPS のみ 共有可能
Microsoft Entra ID 統合 Microsoft Entra ID を使用して、Azure Blob Storage にアクセスします。 Azure Government、MOONCAKE、米国政府 (GCC)、米国政府 (GCC-High) における Azure Government と国防総省 (DoD) を除くすべての地域 共有不可
既定 [非推奨] このオプションは、明示的な認証の種類を持たない古い接続専用に対してのみ使用され、下位互換性を保つためにのみ提供されます。 すべての地域 共有不可

アクセス キー

認証 ID: keyBasedAuth

適用可能: Azure Government、米国政府 (GCC)、米国政府 (GCC-High) における Azure Government と国防総省 (DOD) を除くすべての地域

Cosmos DB アカウントにアクセスできるアカウント名とアクセス キーを入力してください。

これは共有可能な接続です。 Power App が他のユーザーと共有されている場合、接続も共有されます。 詳細については、キャンバス アプリのコネクタの概要 - Power Apps | Microsoft Docs を参照してください

件名 タイプ 内容 必要
取引先企業 ID 文字列 「documents.azure.com」の部分がないアカウントの名前
Azure Cosmos DB アカウントのアクセス キー securestring プライマリ キーまたはセカンダリ キー

アクセス キー (Azure Government)

認証 ID: keyBasedAuth

適用: Azure Government、Azure Government の国防総省 (DoD)、米国政府 (GCC)、および米国政府 (GCC-High) のみ

Cosmos DB アカウントにアクセスできるアカウント名とアクセス キーを入力してください。

これは共有可能な接続です。 Power App が他のユーザーと共有されている場合、接続も共有されます。 詳細については、キャンバス アプリのコネクタの概要 - Power Apps | Microsoft Docs を参照してください

件名 タイプ 内容 必要
取引先企業 ID 文字列 「documents.azure.com」の部分がないアカウントの名前
Azure Cosmos DB アカウントのアクセス キー securestring プライマリ キーまたはセカンダリ キー True

Azure AD 統合

Auth ID: tokenBasedAuth

適用: MOONCAKE のみ

Azure Active Directory を使用して、Azure Blob Storage にアクセスします。

これは共有可能な接続ではありません。 パワー アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。

Azure AD 統合 (Azure Government)

認証 ID: tokenBasedAuth

適用: Azure Government、Azure Government の国防総省 (DoD)、米国政府 (GCC)、および米国政府 (GCC-High) のみ

Azure Active Directory を使用して、Azure Blob Storage にアクセスします。

これは共有可能な接続ではありません。 パワー アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。

Logic Apps マネージド ID

認証 ID: managedIdentityAuth

適用対象: LOGICAPPS のみ

LogicApps Managed Identity を使用して接続を作成する

これは共有可能な接続です。 Power App が他のユーザーと共有されている場合、接続も共有されます。 詳細については、キャンバス アプリのコネクタの概要 - Power Apps | Microsoft Docs を参照してください

名前 種類 説明 必須
LogicApps Managed Identity managedIdentity Logic Apps Managed Identity でサインインする True

Microsoft Entra ID 統合

Auth ID: tokenBasedAuth

適用可能: Azure Government、MOONCAKE、米国政府 (GCC)、米国政府 (GCC-High) における Azure Government と国防総省 (DoD) を除くすべての地域

Microsoft Entra ID を使用して、Azure Blob Storage にアクセスします。

これは共有可能な接続ではありません。 パワー アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。

既定 [非推奨]

適用できるもの: すべての領域

このオプションは、明示的な認証の種類を持たない古い接続専用に対してのみ使用され、下位互換性を保つためにのみ提供されます。

これは共有可能な接続ではありません。 パワー アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。

名称 タイプ 内容 必要
アカウント ID 文字列 アカウントの名前 ('documents.azure.com' の部分を除く)
Azure Cosmos DB アカウントのアクセス キー securestring プライマリ キーまたはセカンダリ キー

調整制限

名前 呼び出し 更新期間
接続ごとの API 呼び出し 1500 60 秒

アクション

すべてのドキュメントの取得 [非推奨]

このアクションは非推奨になりました。 代わりに、すべてのドキュメントの取得 (V3) を使用してください。

ドキュメントをすべて取得します。

すべてのドキュメントの取得 V2 [非推奨]

このアクションは非推奨になりました。 代わりに、すべてのドキュメントの取得 (V3) を使用してください。

すべてのドキュメントを取得します V2。

すべてのドキュメントを取得 (V3)

すべてのドキュメントを取得します (V3)。

クエリ ドキュメント [非推奨]

このアクションは非推奨になりました。 代わりにクエリ ドキュメント V5 を使用してください。

クエリ ドキュメントです。

クエリ ドキュメント V2 [非推奨]

このアクションは非推奨になりました。 代わりにクエリ ドキュメント V5 を使用してください。

クエリ ドキュメント V2 です。

クエリ ドキュメント V3 [非推奨]

このアクションは非推奨になりました。 代わりにクエリ ドキュメント V5 を使用してください。

クエリ ドキュメント V3 です。

クエリ ドキュメント V4 [非推奨]

このアクションは非推奨になりました。 代わりにクエリ ドキュメント V5 を使用してください。

クエリ ドキュメント V4 です。

ストアド プロシージャの作成 [非推奨]

このアクションは非推奨になりました。 代わりに、ストアド プロシージャの作成 (V2) を使用してください。

ストアド プロシージャを作成します。

ストアド プロシージャの削除 [非推奨]

このアクションは非推奨になりました。 代わりに、ストアド プロシージャの削除 (V2) を使用してください。

ストアド プロシージャを削除します。

ストアド プロシージャの実行 [非推奨]

このアクションは非推奨になりました。 代わりに、ストアド プロシージャの実行 (V2) を使用してください。

指定されたコレクションでストアド プロシージャを実行します。

ストアド プロシージャの置換 [非推奨]

このアクションは非推奨になりました。 代わりに、ストアド プロシージャの置換 (V2) を使用してください。

ストアド プロシージャを置き換えます。

ストアド プロシージャを作成 (V2)

ストアド プロシージャを作成します (V2)。

ストアド プロシージャを削除 (V2)

ストアド プロシージャを削除します (V2)。

ストアド プロシージャを取得 (V2)

指定されたコレクションからストアド プロシージャを取得します (V2)。

ストアド プロシージャを取得 [非推奨]

このアクションは非推奨になりました。 代わりに、ストアド プロシージャの取得 (V2) を使用してください。

指定されたコレクションでストアド プロシージャを取得します。

ストアド プロシージャを実行 (V2)

指定されたコレクション内のストアド プロシージャを実行します (V2)。

ストアド プロシージャを置換 (V2)

ストアド プロシージャを置換します (V2)。

ドキュメントの作成または更新 (V2) [非推奨]

このアクションは非推奨になりました。 代わりに、ドキュメントの作成または更新 (V3) を使用してください。

ドキュメントを作成または更新します。DocumentDB にドキュメントを作成する場合は、本文に ID プロパティが含まれている必要があります。

ドキュメントの作成または更新 [非推奨]

このアクションは非推奨になりました。 代わりに、ドキュメントの作成または更新 (V3) を使用してください。

ドキュメントを作成または更新します。DocumentDB にドキュメントを作成する場合は、本文に ID プロパティが含まれている必要があります。

ドキュメントの削除 [非推奨]

このアクションは非推奨になりました。 代わりに、ドキュメントの削除 (V2) を使用してください。

1 つのドキュメントを削除します。

ドキュメントの取得 [非推奨]

このアクションは非推奨になりました。 代わりに、ドキュメントの取得 (V2) を使用してください。

ドキュメントを取得します。

ドキュメントの置換 [非推奨]

このアクションは非推奨になりました。 代わりに、ドキュメントの置換 (V2) を使用してください。

ドキュメントを置き換えます。

ドキュメントをクエリする (V5)

ドキュメントをクエリします (V5)。

ドキュメントを作成または更新 (V3)

ドキュメントを作成または更新します。 DocumentDB にドキュメントを作成するときは、本文に ID プロパティが含まれている必要があります。

ドキュメントを削除 (V2)

ドキュメントを削除します (V2)。

ドキュメントを取得 (V2)

ドキュメントを取得します (V2)。

ドキュメントを置換 (V2)

ドキュメントを置換します (V2)。

すべてのドキュメントの取得 [非推奨]

このアクションは非推奨になりました。 代わりに、すべてのドキュメントの取得 (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 のバージョンです。

戻り値

本文​​
getDocumentsResponse

すべてのドキュメントの取得 V2 [非推奨]

このアクションは非推奨になりました。 代わりに、すべてのドキュメントの取得 (V3) を使用してください。

すべてのドキュメントを取得します V2。

パラメーター

名前 キー 必須 説明
データベース ID
databaseId True string

データベースの名前です。

コレクション ID
collectionId True string

コレクションの名前。

パーティション キーの値
partitionKey string

空の場合、すべてのパーティションを使用してドキュメントを検索します。

最大項目数
maxItemCount integer

ページごとに返す項目の最大数を表す整数です。

継続トークン
continuationToken string

追加の結果をフェッチするトークンです。

整合性レベル
consistencyLevel string

フィード (クエリまたは読み取りフィード) 操作に必要な整合性レベルです。

セッション トークン
sessionToken string

セッションの整合性で使用されるセッション トークンです。

戻り値

要求されたクエリと関連するメタデータに一致するドキュメントの配列です。

本文​​
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 のバージョンです。

戻り値

本文​​
getDocumentsResponse

クエリ ドキュメント [非推奨]

このアクションは非推奨になりました。 代わりにクエリ ドキュメント 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

戻り値

本文​​
queryResponse

クエリ ドキュメント V2 [非推奨]

このアクションは非推奨になりました。 代わりにクエリ ドキュメント V5 を使用してください。

クエリ ドキュメント V2 です。

パラメーター

名前 キー 必須 説明
データベース ID
databaseId True string

データベースの名前です。

コレクション ID
collectionId True string

コレクションの名前。

QueryText
QueryText string

ドキュメントに対する SQL 構文クエリ

パーティション キーの値
partitionKey string

パーティション キーの値です。

継続トークン
continuationToken string

操作からの追加の結果をフェッチするトークンです。

戻り値

要求されたクエリと関連するメタデータに一致するドキュメントの配列です。

本文​​
QueryDocumentsResponse

クエリ ドキュメント 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

セッションの整合性で使用されるセッション トークンです。

戻り値

要求されたクエリと関連するメタデータに一致するドキュメントの配列です。

本文​​
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

セッションの整合性で使用されるセッション トークンです。

戻り値

要求されたクエリと関連するメタデータに一致するドキュメントの配列です。

本文​​
DocumentsCollection

ストアド プロシージャの作成 [非推奨]

このアクションは非推奨になりました。 代わりに、ストアド プロシージャの作成 (V2) を使用してください。

ストアド プロシージャを作成します。

パラメーター

名前 キー 必須 説明
データベース ID
databaseId True string

データベースの名前です。

コレクション ID
collectionId True string

コレクションの名前。

関数定義
body string

ストアド プロシージャを定義する関数。例: 'function (params){ ... }'

ID
id string

ストアド プロシージャの新しい ID です。

API のバージョン
x-ms-version string

API のバージョンです。

戻り値

ストアド プロシージャの削除 [非推奨]

このアクションは非推奨になりました。 代わりに、ストアド プロシージャの削除 (V2) を使用してください。

ストアド プロシージャを削除します。

パラメーター

名前 キー 必須 説明
データベース ID
databaseId True string

データベースの名前です。

コレクション ID
collectionId True string

コレクションの名前。

Sproc ID
sprocId True string

ストアド プロシージャの名前です。

API のバージョン
x-ms-version string

API のバージョンです。

戻り値

応答
string

ストアド プロシージャの実行 [非推奨]

このアクションは非推奨になりました。 代わりに、ストアド プロシージャの実行 (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 のバージョンです。

戻り値

ストアド プロシージャの置換 [非推奨]

このアクションは非推奨になりました。 代わりに、ストアド プロシージャの置換 (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

コレクションの名前。

関数定義
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

ストアド プロシージャの名前です。

API のバージョン
x-ms-version string

API のバージョンです。

戻り値

応答
string

ストアド プロシージャを取得 (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 のバージョンです。

戻り値

ストアド プロシージャを取得 [非推奨]

このアクションは非推奨になりました。 代わりに、ストアド プロシージャの取得 (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

コレクションの名前。

パーティション キーの値
x-ms-documentdb-raw-partitionkey string

要求されたドキュメントまたは添付ファイル操作のパーティション キーの値です。

Sproc ID
sprocId True string

ストアド プロシージャの名前です。

ストアド プロシージャのパラメーター
parameters string

ストアド プロシージャのパラメーターに有効な JSON を指定します (例: ["param1", "param2"])。

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) [非推奨]

このアクションは非推奨になりました。 代わりに、ドキュメントの作成または更新 (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 のバージョンです。

戻り値

本文​​
postDocumentsResponse

ドキュメントの作成または更新 [非推奨]

このアクションは非推奨になりました。 代わりに、ドキュメントの作成または更新 (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 のバージョンです。

戻り値

本文​​
postDocumentsResponse

ドキュメントの削除 [非推奨]

このアクションは非推奨になりました。 代わりに、ドキュメントの削除 (V2) を使用してください。

1 つのドキュメントを削除します。

パラメーター

名前 キー 必須 説明
パーティション キーの値
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) を使用してください。

ドキュメントを取得します。

パラメーター

名前 キー 必須 説明
パーティション キーの値
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 のバージョンです。

戻り値

応答
object

ドキュメントの置換 [非推奨]

このアクションは非推奨になりました。 代わりに、ドキュメントの置換 (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 のバージョンです。

戻り値

本文​​
putDocumentResponse

ドキュメントをクエリする (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

セッションの整合性で使用されるセッション トークンです。

戻り値

要求されたクエリと関連するメタデータに一致するドキュメントの配列です。

本文​​
DocumentsCollection

ドキュメントを作成または更新 (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 のバージョンです。

戻り値

本文​​
postDocumentsResponse

ドキュメントを削除 (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)

ドキュメントを取得します (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 のバージョンです。

戻り値

応答
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

この操作のクライアントが指定した識別子。これは、サーバー応答でエコーされます。

事前トリガー
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 のバージョンです。

戻り値

本文​​
putDocumentResponse

定義

QueryDocumentsResponse

要求されたクエリと関連するメタデータに一致するドキュメントの配列です。

名前 パス 説明
ドキュメント​
Documents array of ObjectWithoutType

要求に一致するドキュメントの配列です。

ドキュメントの数
_count integer

ドキュメントの数です。

活動 ID
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
_self string
_etag
_etag string
_attachments
_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
_count number
ドキュメント​
Documents array of

getStoredProceduresResponse

名前 パス 説明
_count
_count integer

_count

_rid
_rid string

_rid

StoredProcedures
StoredProcedures array of object

StoredProcedures

_etag
StoredProcedures._etag string

_etag

_rid
StoredProcedures._rid string

_rid

_self
StoredProcedures._self string

_self

_ts
StoredProcedures._ts integer

_ts

本文
StoredProcedures.body string

本文

ID
StoredProcedures.id string

ID

createStoredProcedureResponse

名前 パス 説明
_etag
_etag string

_etag

_rid
_rid string

_rid

_self
_self string

_self

_ts
_ts integer

_ts

本文
body string

本文

ID
id string

ID

ObjectWithoutType

文字列

これは基本的なデータ型 '文字列' です。

オブジェクト

’オブジェクト’ という種類です。