1. ホームページ
  2. Azure Cosmos DB Connector

  3. Azure Cosmos DB Connector リファレンス

All Connectors

Azure Cosmos DB Connector 1.0 リファレンス

設定

キートークン設定

パラメーター

名前 型 説明 デフォルト値 必須

Name (名前)

String (文字列)

この設定の名前。コネクタはこの名前の設定を参照します。

x

Connection (接続)

Key Token Auth Connection Provider (キートークン認証接続プロバイダー)

この設定の接続種別。

x

Response Timeout (応答タイムアウト)

Number (数値)

Mule が応答の完了を待機する時間。この時間が経過すると、要求がタイムアウトします。

60

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

[Response Timeout (応答タイムアウト)]​ 項目の時間単位。

SECONDS (秒)

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

コネクタが要求のコンテンツをリモートサービスにストリーミングする方法。

  • AUTO​ (デフォルト)

    コネクタは、要求コンテンツに基づいて自動的に最適なストリーミング戦略を使用します。

  • ALWAYS​

    コネクタは、常に要求コンテンツをストリーミングします。

  • NEVER​

    コネクタは、要求コンテンツをストリーミングしません。

AUTO

Name (名前)

String (文字列)

この設定の参照に使用される ID。

x

Expiration Policy (有効期限ポリシー)

Expiration Policy (有効期限ポリシー)

動的設定インスタンスがアイドル状態を続けられる最小時間を設定します。この時間が経過すると、Mule Runtime で期限切れに相当するとみなされます。

接続種別

キートークン認証接続プロバイダー
パラメーター
名前 型 説明 デフォルト値 必須

Proxy Config (プロキシ設定)

Proxy (プロキシ)

アウトバウンド接続のプロキシを設定します。

Default Headers (デフォルトヘッダー)

Default Header (デフォルトヘッダー)​の配列。

Query Parameters (クエリパラメーター)

Default Query Param (デフォルトクエリパラメーター)​の配列。

Connection Timeout (接続タイムアウト)

Number (数値)

リモートサーバーへの接続を確立するときのコネクタの待機時間。この時間を経過するとタイムアウトします。

30

Connection Timeout Unit (接続タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

[Connection Timeout (接続タイムアウト)]​ 項目の時間単位。

SECONDS (秒)

Use Persistent Connections (永続接続を使用)

Boolean (ブール)

永続接続を使用するかどうかを示します。

  • true​

    Mule は永続接続を使用します。

  • false​

    Mule は最初の要求が完了すると接続を閉じます。

true

Max Connections (最大接続数)

Number (数値)

バックエンドに対して開く接続の最大数。HTTP 要求は、複数の接続を介して並行して送信されます。この値の設定が高すぎると、レイテンシーに影響し、スループットを高めることなく追加リソースがコンシュームされる可能性があります。

-1

Connection Idle Timeout (接続アイドルタイムアウト)

Number (数値)

永続接続が有効になっている場合、接続が Mule によって閉じられるまでアイドル状態を維持できる時間。

30

Connection Idle Timeout Unit (接続アイドルタイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

[Connection Idle Timeout (接続アイドルタイムアウト)]​ 項目の時間単位。

SECONDS (秒)

Stream Response (応答のストリーミング)

Boolean (ブール)

この値が ​true​ の場合、Mule は受信した応答をストリーミングします。

false

Response Buffer Size (応答バッファサイズ)

Number (数値)

HTTP 応答が保存されるバッファのサイズ (バイト)。

-1

Database account url (データベースアカウント URL)

String (文字列)

データベースアカウント URL。

x

Key token (キートークン)

String (文字列)

ユーザーが Cosmos DB リソースを完全にコントロールできるようにするフルアクセスキートークン。

x

Version (バージョン)

String (文字列)

Cosmos DB REST サービスのバージョン。

x

TLS configuration (TLS 設定)

TLS

プロトコルとして HTTPS が設定されている場合、ユーザーは少なくともキーストアを設定する必要があります。

Reconnection (再接続)

[Reconnection]

アプリケーションのデプロイ時に、関連する再接続戦略をすべて実行した後、接続テストに合格しない場合の処理:

  • true​

    デプロイの失敗を許可します。

  • false​

    接続テストの結果を無視します。

サポートされている操作

リソーストークン設定

パラメーター

名前 型 説明 デフォルト値 必須

Name (名前)

String (文字列)

この設定の名前。コネクタはこの名前の設定を参照します。

x

Connection (接続)

Resource Token Auth Connection Provider (リソーストークン認証接続プロバイダー)

この設定の接続種別。

x

Response Timeout (応答タイムアウト)

Number (数値)

Mule が応答の完了を待機する時間。この時間が経過すると、要求がタイムアウトします。

60

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

[Response Timeout (応答タイムアウト)]​ 項目の時間単位。

SECONDS (秒)

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

コネクタが要求のコンテンツをリモートサービスにストリーミングする方法。

  • AUTO​ (デフォルト)

    コネクタは、要求コンテンツに基づいて自動的に最適なストリーミング戦略を使用します。

  • ALWAYS​

    コネクタは、常に要求コンテンツをストリーミングします。

  • NEVER​

    コネクタは、要求コンテンツをストリーミングしません。

AUTO

Name (名前)

String (文字列)

この設定の参照に使用される ID。

x

Expiration Policy (有効期限ポリシー)

Expiration Policy (有効期限ポリシー)

動的設定インスタンスがアイドル状態を続けられる最小時間を設定します。この時間が経過すると、Mule Runtime で期限切れに相当するとみなされます。

接続種別

リソーストークン認証接続プロバイダー
パラメーター
名前 型 説明 デフォルト値 必須

Proxy Config (プロキシ設定)

Proxy (プロキシ)

アウトバウンド接続のプロキシを設定します。

Default Headers (デフォルトヘッダー)

Default Header (デフォルトヘッダー)​の配列。

Query Parameters (クエリパラメーター)

Default Query Param (デフォルトクエリパラメーター)​の配列。

Connection Timeout (接続タイムアウト)

Number (数値)

リモートサーバーへの接続を確立するときのコネクタの待機時間。この時間を経過するとタイムアウトします。

30

Connection Timeout Unit (接続タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

[Connection Timeout (接続タイムアウト)]​ 項目の時間単位。

SECONDS (秒)

Use Persistent Connections (永続接続を使用)

Boolean (ブール)

永続接続を使用するかどうかを示します。

  • true​

    Mule は永続接続を使用します。

  • false​

    Mule は最初の要求が完了すると接続を閉じます。

true

Max Connections (最大接続数)

Number (数値)

バックエンドに対して開く接続の最大数。HTTP 要求は、複数の接続を介して並行して送信されます。この値の設定が高すぎると、レイテンシーに影響し、スループットを高めることなく追加リソースがコンシュームされる可能性があります。

-1

Connection Idle Timeout (接続アイドルタイムアウト)

Number (数値)

永続接続が有効になっている場合、接続が Mule によって閉じられるまでアイドル状態を維持できる時間。

30

Connection Idle Timeout Unit (接続アイドルタイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

[Connection Idle Timeout (接続アイドルタイムアウト)]​ 項目の時間単位。

SECONDS (秒)

Stream Response (応答のストリーミング)

Boolean (ブール)

この値が ​true​ の場合、Mule は受信した応答をストリーミングします。

false

Response Buffer Size (応答バッファサイズ)

Number (数値)

HTTP 応答が保存されるバッファのサイズ (バイト)。

-1

Database account url (データベースアカウント URL)

String (文字列)

データベースアカウント URL。

x

Resource token (リソーストークン)

String (文字列)

リソーストークン。

x

Version (バージョン)

String (文字列)

Cosmos DB REST サービスのバージョン。

x

TLS configuration (TLS 設定)

TLS

プロトコルとして HTTPS が設定されている場合、ユーザーは少なくともキーストアを設定する必要があります。

Reconnection (再接続)

[Reconnection]

アプリケーションのデプロイ時に、関連する再接続戦略をすべて実行した後、接続テストに合格しない場合の処理:

  • true​

    デプロイの失敗を許可します。

  • false​

    接続テストの結果を無視します。

サポートされている操作

操作

Create Document

<azure-cosmos-db-connector-mule-4:create-document>

コレクションに新しいドキュメントを作成します。この操作では、/dbs/{dbId}/colls/{collId}/docs エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Db Id

String (文字列)

ユーザーが生成した、ストアドプロシージャーを作成するデータベースの名前または ID。

x

Coll Id (コレクション ID)

String (文字列)

ストアドプロシージャーを作成するコレクションの名前。

x

X ms documentdb is upsert (X ms documentdb が更新/挿入)

Boolean (ブール)

true​ に設定されている場合、Cosmos DB は以下を行います。

* 指定された ID (該当する場合は、さらにパーティションキー) のドキュメントが存在しない場合は、そのドキュメントを作成します。 * 存在する場合は、既存のドキュメントを更新します。

false

X ms indexing directive (X ms インデックス付けディレクティブ)

Enumeration (列挙)。次のいずれかになります。

  • INCLUDE

  • EXCLUDE

インデックス付け動作のデフォルトは、コレクションのインデックス付けポリシーで指定されている automatic プロパティの値によって決定されます。

X ms documentdb partitionkey (X ms documentdb パーティションキー)

String (文字列)

作成するドキュメントのパーティションキー値。​partitionKey​ 定義 (例: ["partitionKey"]) を使用してコレクションを作成する場合にのみ指定する必要があります。

Body (本文)

Any (任意)

使用するコンテンツ。

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

Response Timeout (応答タイムアウト)

Number (数値)

Mule が応答の完了を待機する時間。この時間が経過すると、要求がタイムアウトします。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

[Response Timeout (応答タイムアウト)]​ 項目の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

コネクタが要求のコンテンツをリモートサービスにストリーミングする方法。

  • AUTO​ (デフォルト)

コネクタは、要求コンテンツに基づいて自動的に最適なストリーミング戦略を使用します。

  • ALWAYS​

コネクタは、常に要求コンテンツをストリーミングします。

  • NEVER​

コネクタは、要求コンテンツをストリーミングしません。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:BAD_REQUEST

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:CLIENT_ERROR

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:CONNECTIVITY

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:NOT_FOUND

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:SERVER_ERROR

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:TIMEOUT

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:TOO_MANY_REQUESTS

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:UNAUTHORIZED

Create Permission

<azure-cosmos-db-connector-mule-4:create-permission>

データベースに新しい権限を作成します。この操作では、/dbs/{dbId}/users/{userName}/permissions エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Db Id

String (文字列)

ユーザーが生成した、権限を作成するデータベースの名前または ID。

x

Username (ユーザー名)

String (文字列)

権限を所有するユーザーの名前。

x

X ms documentdb expiry seconds (X ms documentdb 有効期限秒数)

Number (数値)

操作で返されたリソーストークンの有効期限。

Body (本文)

Any (任意)

使用するコンテンツ。

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

Response Timeout (応答タイムアウト)

Number (数値)

Mule が応答の完了を待機する時間。この時間が経過すると、要求がタイムアウトします。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

[Response Timeout (応答タイムアウト)]​ 項目の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

コネクタが要求のコンテンツをリモートサービスにストリーミングする方法。

  • AUTO​ (デフォルト)

コネクタは、要求コンテンツに基づいて自動的に最適なストリーミング戦略を使用します。

  • ALWAYS​

コネクタは、常に要求コンテンツをストリーミングします。

  • NEVER​

コネクタは、要求コンテンツをストリーミングしません。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:BAD_REQUEST

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:CLIENT_ERROR

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:CONNECTIVITY

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:NOT_FOUND

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:SERVER_ERROR

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:TIMEOUT

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:TOO_MANY_REQUESTS

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:UNAUTHORIZED

Create Stored Procedure

<azure-cosmos-db-connector-mule-4:create-stored-procedure>

コレクションに新しいストアドプロシージャーを作成します。この操作では、/dbs/{dbId}/colls/{collId}/sprocs エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Db Id

String (文字列)

ユーザーが生成した、ストアドプロシージャーを作成するデータベースの名前または ID。

x

Coll Id (コレクション ID)

String (文字列)

ストアドプロシージャーを作成するコレクションの名前。

x

Body (本文)

Any (任意)

使用するコンテンツ。

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

Response Timeout (応答タイムアウト)

Number (数値)

Mule が応答の完了を待機する時間。この時間が経過すると、要求がタイムアウトします。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

[Response Timeout (応答タイムアウト)]​ 項目の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

コネクタが要求のコンテンツをリモートサービスにストリーミングする方法。

  • AUTO​ (デフォルト)

コネクタは、要求コンテンツに基づいて自動的に最適なストリーミング戦略を使用します。

  • ALWAYS​

コネクタは、常に要求コンテンツをストリーミングします。

  • NEVER​

コネクタは、要求コンテンツをストリーミングしません。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:BAD_REQUEST

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:CLIENT_ERROR

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:CONNECTIVITY

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:NOT_FOUND

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:SERVER_ERROR

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:TIMEOUT

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:TOO_MANY_REQUESTS

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:UNAUTHORIZED

Delete Document

<azure-cosmos-db-connector-mule-4:delete-document>

コレクションから既存のドキュメントを削除します。この操作では、/dbs/{dbId}/colls/{collId}/docs/{doc-id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Db Id

String (文字列)

ユーザーが生成した、ストアドプロシージャーを作成するデータベースの名前または ID。

x

Coll Id (コレクション ID)

String (文字列)

ストアドプロシージャーを作成するコレクションの名前。

x

Doc ID (ドキュメント ID)

String (文字列)

削除するドキュメントの ID。

x

X ms documentdb partitionkey (X ms documentdb パーティションキー)

String (文字列)

削除するドキュメントのパーティションキー値。​partitionKey​ 定義 (例: ["partitionKey"]) を使用してコレクションを作成する場合にのみ指定する必要があります。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

Response Timeout (応答タイムアウト)

Number (数値)

Mule が応答の完了を待機する時間。この時間が経過すると、要求がタイムアウトします。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

[Response Timeout (応答タイムアウト)]​ 項目の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

コネクタが要求のコンテンツをリモートサービスにストリーミングする方法。

  • AUTO​ (デフォルト)

コネクタは、要求コンテンツに基づいて自動的に最適なストリーミング戦略を使用します。

  • ALWAYS​

コネクタは、常に要求コンテンツをストリーミングします。

  • NEVER​

コネクタは、要求コンテンツをストリーミングしません。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:BAD_REQUEST

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:CLIENT_ERROR

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:CONNECTIVITY

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:NOT_FOUND

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:SERVER_ERROR

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:TIMEOUT

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:TOO_MANY_REQUESTS

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:UNAUTHORIZED

Delete Permission

<azure-cosmos-db-connector-mule-4:delete-permission>

データベースから権限を削除します。この操作では、/dbs/{dbId}/users/{userName}/permissions/{permissionId} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Db Id

String (文字列)

ユーザーが生成した、権限を削除するデータベースの名前または ID。

x

Username (ユーザー名)

String (文字列)

権限を所有するユーザーの名前。

x

Permission Id (権限 ID)

String (文字列)

削除する権限の ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

Response Timeout (応答タイムアウト)

Number (数値)

Mule が応答の完了を待機する時間。この時間が経過すると、要求がタイムアウトします。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

[Response Timeout (応答タイムアウト)]​ 項目の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

コネクタが要求のコンテンツをリモートサービスにストリーミングする方法。

  • AUTO​ (デフォルト)

コネクタは、要求コンテンツに基づいて自動的に最適なストリーミング戦略を使用します。

  • ALWAYS​

コネクタは、常に要求コンテンツをストリーミングします。

  • NEVER​

コネクタは、要求コンテンツをストリーミングしません。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:BAD_REQUEST

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:CLIENT_ERROR

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:CONNECTIVITY

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:NOT_FOUND

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:SERVER_ERROR

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:TIMEOUT

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:TOO_MANY_REQUESTS

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:UNAUTHORIZED

Delete Stored Procedure

<azure-cosmos-db-connector-mule-4:delete-stored-procedure>

コレクションから既存のストアドプロシージャーを削除します。この操作では、/dbs/{dbId}/colls/{collId}/sprocs/{sprocId} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Db Id

String (文字列)

ユーザーが生成した、ストアドプロシージャーを作成するデータベースの名前または ID。

x

Coll Id (コレクション ID)

String (文字列)

ストアドプロシージャーを作成するコレクションの名前。

x

Sproc Id (ストアドプロシージャー ID)

String (文字列)

削除するストアドプロシージャーの ID。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

Response Timeout (応答タイムアウト)

Number (数値)

Mule が応答の完了を待機する時間。この時間が経過すると、要求がタイムアウトします。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

[Response Timeout (応答タイムアウト)]​ 項目の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

コネクタが要求のコンテンツをリモートサービスにストリーミングする方法。

  • AUTO​ (デフォルト)

コネクタは、要求コンテンツに基づいて自動的に最適なストリーミング戦略を使用します。

  • ALWAYS​

コネクタは、常に要求コンテンツをストリーミングします。

  • NEVER​

コネクタは、要求コンテンツをストリーミングしません。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:BAD_REQUEST

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:CLIENT_ERROR

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:CONNECTIVITY

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:NOT_FOUND

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:SERVER_ERROR

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:TIMEOUT

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:TOO_MANY_REQUESTS

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:UNAUTHORIZED

Execute Stored Procedure

<azure-cosmos-db-connector-mule-4:execute-stored-procedure>

ストアドプロシージャーリソースに対して POST を実行することで、ストアドプロシージャーを実行します。この操作では、/dbs/{dbId}/colls/{collId}/sprocs/{sprocId} エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Db Id

String (文字列)

ユーザーが生成した、ストアドプロシージャーを実行するデータベースの名前または ID。

x

Coll Id (コレクション ID)

String (文字列)

ストアドプロシージャーを実行するコレクションの名前。

x

Sproc Id (ストアドプロシージャー ID)

String (文字列)

実行するストアドプロシージャーの ID。

x

Body (本文)

Array of String (文字列の配列)

使用するコンテンツ。

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

Response Timeout (応答タイムアウト)

Number (数値)

Mule が応答の完了を待機する時間。この時間が経過すると、要求がタイムアウトします。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

[Response Timeout (応答タイムアウト)]​ 項目の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

コネクタが要求のコンテンツをリモートサービスにストリーミングする方法。

  • AUTO​ (デフォルト)

コネクタは、要求コンテンツに基づいて自動的に最適なストリーミング戦略を使用します。

  • ALWAYS​

コネクタは、常に要求コンテンツをストリーミングします。

  • NEVER​

コネクタは、要求コンテンツをストリーミングしません。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:BAD_REQUEST

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:CLIENT_ERROR

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:CONNECTIVITY

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:NOT_FOUND

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:SERVER_ERROR

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:TIMEOUT

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:TOO_MANY_REQUESTS

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:UNAUTHORIZED

Get Document

<azure-cosmos-db-connector-mule-4:get-document>

パーティションキーとドキュメントキーでドキュメントを取得します。この操作では、/dbs/{dbId}/colls/{collId}/docs/{doc-id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Db Id

String (文字列)

ユーザーが生成した、ストアドプロシージャーを作成するデータベースの名前または ID。

x

Coll Id (コレクション ID)

String (文字列)

ストアドプロシージャーを作成するコレクションの名前。

x

Doc ID (ドキュメント ID)

String (文字列)

置換するドキュメントの名前。

x

If None Match (一致しない合)

String (文字列)

操作が条件付きであるかどうかを示します。条件付きとは、応答に本文が含まれる場合には、データベースの値がヘッダーで指定されている値とは異なることを意味します。値は、リソースの Etag である必要があります。

X ms documentdb partitionkey (X ms documentdb パーティションキー)

String (文字列)

読み取るドキュメントのパーティションキー値。​partitionKey​ 定義 (例: ["partitionKey"]) を使用してコレクションを作成する場合にのみ指定する必要があります。

X ms consistency level (X ms 一貫性レベル)

Enumeration (列挙)。次のいずれかになります。

  • STRONG

  • BOUNDED

  • SESSION

  • EVENTUAL

一貫性レベルの上書き。有効な値を強度の高い順にリストします。上書きの値は、アカウントで設定されている一貫性レベル以下である必要があります。

X ms session token (X ms セッショントークン)

String (文字列)

セッションレベル一貫性で使用する文字列トークン。クライアントは、セッション一貫性の読み取りリクエスト中は、このヘッダーの最新の読み取り値をエコー表示する必要があります。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

Response Timeout (応答タイムアウト)

Number (数値)

Mule が応答の完了を待機する時間。この時間が経過すると、要求がタイムアウトします。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

[Response Timeout (応答タイムアウト)]​ 項目の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

コネクタが要求のコンテンツをリモートサービスにストリーミングする方法。

  • AUTO​ (デフォルト)

コネクタは、要求コンテンツに基づいて自動的に最適なストリーミング戦略を使用します。

  • ALWAYS​

コネクタは、常に要求コンテンツをストリーミングします。

  • NEVER​

コネクタは、要求コンテンツをストリーミングしません。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:BAD_REQUEST

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:CLIENT_ERROR

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:CONNECTIVITY

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:NOT_FOUND

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:SERVER_ERROR

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:TIMEOUT

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:TOO_MANY_REQUESTS

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:UNAUTHORIZED

Get Permission

<azure-cosmos-db-connector-mule-4:get-permission>

指定されたデータベースから権限を取得します。この操作では、/dbs/{dbId}/users/{userName}/permissions/{permissionId} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Db Id

String (文字列)

ユーザーが生成した、権限を取得するデータベースの名前または ID。

x

Username (ユーザー名)

String (文字列)

権限を所有するユーザーの名前。

x

Permission Id (権限 ID)

String (文字列)

取得する権限の ID。

x

X ms documentdb expiry seconds (X ms documentdb 有効期限秒数)

Number (数値)

操作で返されたリソーストークンの有効期限。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

Response Timeout (応答タイムアウト)

Number (数値)

Mule が応答の完了を待機する時間。この時間が経過すると、要求がタイムアウトします。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

[Response Timeout (応答タイムアウト)]​ 項目の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

コネクタが要求のコンテンツをリモートサービスにストリーミングする方法。

  • AUTO​ (デフォルト)

コネクタは、要求コンテンツに基づいて自動的に最適なストリーミング戦略を使用します。

  • ALWAYS​

コネクタは、常に要求コンテンツをストリーミングします。

  • NEVER​

コネクタは、要求コンテンツをストリーミングしません。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:BAD_REQUEST

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:CLIENT_ERROR

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:CONNECTIVITY

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:NOT_FOUND

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:SERVER_ERROR

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:TIMEOUT

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:TOO_MANY_REQUESTS

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:UNAUTHORIZED

List Documents

<azure-cosmos-db-connector-mule-4:list-documents>

コレクションのドキュメントのリストを返します。この操作では、/dbs/{dbId}/colls/{collId}/docs エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Db Id

String (文字列)

ユーザーが生成した、ストアドプロシージャーを作成するデータベースの名前または ID。

x

Coll Id (コレクション ID)

String (文字列)

ストアドプロシージャーを作成するコレクションの名前。

x

X ms consistency level (X ms 一貫性レベル)

Enumeration (列挙)。次のいずれかになります。

  • STRONG

  • BOUNDED

  • SESSION

  • EVENTUAL

一貫性レベルの上書き。有効な値を強度の高い順にリストします。上書きの値は、アカウントで設定されている一貫性レベル以下である必要があります。

X ms session token (X ms セッショントークン)

String (文字列)

セッションレベル一貫性で使用する文字列トークン。クライアントは、セッション一貫性の読み取りリクエスト中は、このヘッダーの最新の読み取り値をエコー表示する必要があります。

A im

String (文字列)

Incremental feed​ に設定するか、または省略する必要があります。REST API バージョン 2016-07-11 以降で使用できます。

If None Match (一致しない合)

String (文字列)

REST API バージョン 2016-07-11 以降で使用できます。

  • ヘッダーなし

    最初 (コレクションの作成時) からのすべての変更を返します。

  • "*"

    コレクション内のデータへの新しい変更を返します。

  • コレクション ETag

    論理タイムスタンプ以降のすべての変更を返します。

X ms documentdb partitionkeyrangeid (X ms documentdb パーティションキー範囲 ID)

String (文字列)

データを読み取るためのパーティションキー範囲 ID。REST API バージョン 2016-07-11 以降で使用できます。

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

Response Timeout (応答タイムアウト)

Number (数値)

Mule が応答の完了を待機する時間。この時間が経過すると、要求がタイムアウトします。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

[Response Timeout (応答タイムアウト)]​ 項目の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

コネクタが要求のコンテンツをリモートサービスにストリーミングする方法。

  • AUTO​ (デフォルト)

コネクタは、要求コンテンツに基づいて自動的に最適なストリーミング戦略を使用します。

  • ALWAYS​

コネクタは、常に要求コンテンツをストリーミングします。

  • NEVER​

コネクタは、要求コンテンツをストリーミングしません。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

次の設定の場合

スロー

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:BAD_REQUEST

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:CLIENT_ERROR

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:CONNECTIVITY

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:NOT_FOUND

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:SERVER_ERROR

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:TIMEOUT

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:TOO_MANY_REQUESTS

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:UNAUTHORIZED

List Permissions

<azure-cosmos-db-connector-mule-4:list-permissions>

ユーザーの権限をデータベースから取得してリストとして表示します。この操作では、/dbs/{dbId}/users/{userName}/permissions エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Db Id

String (文字列)

ユーザーが生成した、権限を取得するデータベースの名前または ID。

x

Username (ユーザー名)

String (文字列)

権限を所有するユーザーの名前。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

Response Timeout (応答タイムアウト)

Number (数値)

Mule が応答の完了を待機する時間。この時間が経過すると、要求がタイムアウトします。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

[Response Timeout (応答タイムアウト)]​ 項目の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

コネクタが要求のコンテンツをリモートサービスにストリーミングする方法。

  • AUTO​ (デフォルト)

コネクタは、要求コンテンツに基づいて自動的に最適なストリーミング戦略を使用します。

  • ALWAYS​

コネクタは、常に要求コンテンツをストリーミングします。

  • NEVER​

コネクタは、要求コンテンツをストリーミングしません。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:BAD_REQUEST

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:CLIENT_ERROR

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:CONNECTIVITY

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:NOT_FOUND

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:SERVER_ERROR

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:TIMEOUT

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:TOO_MANY_REQUESTS

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:UNAUTHORIZED

List Stored Procedures

<azure-cosmos-db-connector-mule-4:list-stored-procedures>

コレクション内のストアドプロシージャーのリストを返します。この操作では、/dbs/{dbId}/colls/{collId}/sprocs エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Db Id

String (文字列)

ユーザーが生成した、ストアドプロシージャーを作成するデータベースの名前または ID。

x

Coll Id (コレクション ID)

String (文字列)

ストアドプロシージャーを作成するコレクションの名前。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

Response Timeout (応答タイムアウト)

Number (数値)

Mule が応答の完了を待機する時間。この時間が経過すると、要求がタイムアウトします。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

[Response Timeout (応答タイムアウト)]​ 項目の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

コネクタが要求のコンテンツをリモートサービスにストリーミングする方法。

  • AUTO​ (デフォルト)

コネクタは、要求コンテンツに基づいて自動的に最適なストリーミング戦略を使用します。

  • ALWAYS​

コネクタは、常に要求コンテンツをストリーミングします。

  • NEVER​

コネクタは、要求コンテンツをストリーミングしません。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:BAD_REQUEST

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:CLIENT_ERROR

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:CONNECTIVITY

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:NOT_FOUND

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:SERVER_ERROR

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:TIMEOUT

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:TOO_MANY_REQUESTS

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:UNAUTHORIZED

Query Documents

<azure-cosmos-db-connector-mule-4:query-documents>

ドキュメントを照会します。この操作では、/dbs/{dbId}/colls/{collId}/docs エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Db Id

String (文字列)

ユーザーが生成した、ストアドプロシージャーを作成するデータベースの名前または ID。

x

Coll Id (コレクション ID)

String (文字列)

ストアドプロシージャーを作成するコレクションの名前。

x

X ms documentdb query enablecrosspartition (X ms documentdb クロスパーティションクエリ有効)

Boolean (ブール)

パーティション化されている場合は、このパラメーターを ​true​ に設定して複数のパーティションに渡る実行を有効にする必要があります。単一のパーティションキーまたは単一のパーティション化されたコレクションに絞り込むクエリでは、このヘッダーを設定する必要はありません。

false

X ms consistency level (X ms 一貫性レベル)

Enumeration (列挙)。次のいずれかになります。

  • STRONG

  • BOUNDED

  • SESSION

  • EVENTUAL

一貫性レベルの上書き。有効な値を強度の高い順にリストします。上書きの値は、アカウントで設定されている一貫性レベル以下である必要があります。

X ms session token (X ms セッショントークン)

String (文字列)

セッションレベル一貫性で使用する文字列トークン。クライアントは、セッション一貫性の読み取りリクエスト中は、このヘッダーの最新の読み取り値をエコー表示する必要があります。

Body (本文)

Any (任意)

使用するコンテンツ。

#[payload]

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

Response Timeout (応答タイムアウト)

Number (数値)

Mule が応答の完了を待機する時間。この時間が経過すると、要求がタイムアウトします。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

[Response Timeout (応答タイムアウト)]​ 項目の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

コネクタが要求のコンテンツをリモートサービスにストリーミングする方法。

  • AUTO​ (デフォルト)

コネクタは、要求コンテンツに基づいて自動的に最適なストリーミング戦略を使用します。

  • ALWAYS​

コネクタは、常に要求コンテンツをストリーミングします。

  • NEVER​

コネクタは、要求コンテンツをストリーミングしません。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any の配列

次の設定の場合

スロー

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:BAD_REQUEST

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:CLIENT_ERROR

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:CONNECTIVITY

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:NOT_FOUND

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:SERVER_ERROR

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:TIMEOUT

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:TOO_MANY_REQUESTS

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:UNAUTHORIZED

Replace Document

<azure-cosmos-db-connector-mule-4:replace-document>

ドキュメントのコンテンツ全体を置換します。この操作では、/dbs/{dbId}/colls/{collId}/docs/{doc-id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Db Id

String (文字列)

ユーザーが生成した、ストアドプロシージャーを作成するデータベースの名前または ID。

x

Coll Id (コレクション ID)

String (文字列)

ストアドプロシージャーを作成するコレクションの名前。

x

Doc ID (ドキュメント ID)

String (文字列)

置換するドキュメントの名前。

x

If Match (一致する場合)

String (文字列)

操作が楽観的な同時実行について条件付きであるかどうかを示します。楽観的な同時実行について条件付きであるというのは、指定された Etag がデータベース内の現在のバージョンと一致する場合にのみドキュメントを更新することを意味します。この値は、リソースの Etag 値に設定する必要があります。

X ms indexing directive (X ms インデックス付けディレクティブ)

Enumeration (列挙)。次のいずれかになります。

  • INCLUDE

  • EXCLUDE

インデックス付け動作のデフォルトは、コレクションのインデックス付けポリシーで指定されている automatic プロパティの値によって決定されます。

X ms documentdb partitionkey (X ms documentdb パーティションキー)

String (文字列)

置換するドキュメントのパーティションキー値。​partitionKey​ 定義 (例: ["partitionKey"]) を使用してコレクションを作成する場合にのみ指定する必要があります。

Body (本文)

Any (任意)

使用するコンテンツ。

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

Response Timeout (応答タイムアウト)

Number (数値)

Mule が応答の完了を待機する時間。この時間が経過すると、要求がタイムアウトします。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

[Response Timeout (応答タイムアウト)]​ 項目の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

コネクタが要求のコンテンツをリモートサービスにストリーミングする方法。

  • AUTO​ (デフォルト)

コネクタは、要求コンテンツに基づいて自動的に最適なストリーミング戦略を使用します。

  • ALWAYS​

コネクタは、常に要求コンテンツをストリーミングします。

  • NEVER​

コネクタは、要求コンテンツをストリーミングしません。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:BAD_REQUEST

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:CLIENT_ERROR

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:CONNECTIVITY

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:NOT_FOUND

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:SERVER_ERROR

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:TIMEOUT

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:TOO_MANY_REQUESTS

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:UNAUTHORIZED

Replace Permission

<azure-cosmos-db-connector-mule-4:replace-permission>

データベースの権限を置換します。この操作では、/dbs/{dbId}/users/{userName}/permissions/{permissionId} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Db Id

String (文字列)

ユーザーが生成した、権限を置換するデータベースの名前または ID。

x

Username (ユーザー名)

String (文字列)

権限を所有するユーザーの名前。

x

Permission Id (権限 ID)

String (文字列)

置換する権限の ID。

x

X ms documentdb expiry seconds (X ms documentdb 有効期限秒数)

Number (数値)

操作で返されたリソーストークンの有効期限。

Body (本文)

Any (任意)

使用するコンテンツ。

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

Response Timeout (応答タイムアウト)

Number (数値)

Mule が応答の完了を待機する時間。この時間が経過すると、要求がタイムアウトします。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

[Response Timeout (応答タイムアウト)]​ 項目の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

コネクタが要求のコンテンツをリモートサービスにストリーミングする方法。

  • AUTO​ (デフォルト)

コネクタは、要求コンテンツに基づいて自動的に最適なストリーミング戦略を使用します。

  • ALWAYS​

コネクタは、常に要求コンテンツをストリーミングします。

  • NEVER​

コネクタは、要求コンテンツをストリーミングしません。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:BAD_REQUEST

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:CLIENT_ERROR

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:CONNECTIVITY

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:NOT_FOUND

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:SERVER_ERROR

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:TIMEOUT

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:TOO_MANY_REQUESTS

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:UNAUTHORIZED

Replace Stored Procedure

<azure-cosmos-db-connector-mule-4:replace-stored-procedure>

ストアドプロシージャーリソース全体を置換します。置換を実行するには、ID や body など、ユーザーが設定できるすべてのプロパティをすべて本文で送信する必要があります。この操作では、/dbs/{dbId}/colls/{collId}/sprocs/{sprocId} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Db Id

String (文字列)

ユーザーが生成した、ストアドプロシージャーを置換するデータベースの名前または ID。

x

Coll Id (コレクション ID)

String (文字列)

ストアドプロシージャーを置換するコレクションの名前。

x

Sproc Id (ストアドプロシージャー ID)

String (文字列)

置換するストアドプロシージャーの ID。

x

Body (本文)

Any (任意)

使用するコンテンツ。

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

Response Timeout (応答タイムアウト)

Number (数値)

Mule が応答の完了を待機する時間。この時間が経過すると、要求がタイムアウトします。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

[Response Timeout (応答タイムアウト)]​ 項目の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

コネクタが要求のコンテンツをリモートサービスにストリーミングする方法。

  • AUTO​ (デフォルト)

コネクタは、要求コンテンツに基づいて自動的に最適なストリーミング戦略を使用します。

  • ALWAYS​

コネクタは、常に要求コンテンツをストリーミングします。

  • NEVER​

コネクタは、要求コンテンツをストリーミングしません。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:BAD_REQUEST

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:CLIENT_ERROR

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:CONNECTIVITY

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:NOT_FOUND

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:RETRY_EXHAUSTED

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:SERVER_ERROR

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:TIMEOUT

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:TOO_MANY_REQUESTS

  • AZURE-COSMOS-DB-CONNECTOR-MULE-4:UNAUTHORIZED

型

Proxy (プロキシ)

アウトバウンド接続のプロキシを設定します。

項目 型 説明 デフォルト値 必須

Host (ホスト)

String (文字列)

プロキシサーバーのホスト名または IP アドレス。

x

Port (ポート)

Number (数値)

プロキシサーバーのポート。

x

Username (ユーザー名)

String (文字列)

プロキシサーバーに対して認証するユーザー名。

Password (パスワード)

String (文字列)

プロキシサーバーに対して認証するパスワード。

Non Proxy Hosts (非プロキシホスト)

String (文字列)

プロキシを使用してはならないホストのカンマ区切りリスト。

Default Header (デフォルトヘッダー)

すべてのアウトバウンド要求に自動的に追加されるヘッダー。

項目 型 説明 デフォルト値 必須

Key (キー)

String (文字列)

この型のキー。

x

Value (値)

String (文字列)

この型の値。

x

Default Query Param (デフォルトクエリパラメーター)

すべてのアウトバウンド要求に自動的に追加されるクエリパラメーター。

項目 型 説明 デフォルト値 必須

Key (キー)

String (文字列)

この型のキー。

x

Value (値)

String (文字列)

この型の値。

x

TLS

Mule アプリケーションのセキュアな通信を提供するように TLS を設定します。

項目 型 説明 デフォルト値 必須

Enabled Protocols (有効化されたプロトコル)

String (文字列)

このコンテキストで有効化されたプロトコルのカンマ区切りリスト。

Enabled Cipher Suites (有効化された暗号化スイート)

String (文字列)

このコンテキストで有効化された暗号化スイートのカンマ区切りリスト。

トラストストア

Truststore (トラストストア)

TLS トラストストアを設定します。

Key Store (キーストア)

Keystore (キーストア)

TLS キーストアを設定します。

Revocation Check (取り消し確認)

取り消し確認メカニズムを設定します。

Truststore (トラストストア)

TLS 用のトラストストアを設定します。

項目 型 説明 デフォルト値 必須

Path (パス)

String (文字列)

トラストストアへのパス。Mule では、現在のクラスパスとファイルシステムへの相対的なパスを解決します。

Password (パスワード)

String (文字列)

トラストストアを保護するために使用するパスワード。

Type (型)

String (文字列)

トラストストアの型。

Algorithm (アルゴリズム)

String (文字列)

トラストストアで使用する暗号化アルゴリズム。

Insecure (安全ではない)

Boolean (ブール)

true​ の場合、Mule では証明書の検証の実行を停止します。これを ​true​ に設定すると、接続が攻撃に対して脆弱になる可能性があります。

Keystore (キーストア)

TLS プロトコル用のキーストアを設定します。生成したキーストアには、非公開キーと公開証明書が格納されます。

項目 型 説明 デフォルト値 必須

Path (パス)

String (文字列)

キーストアへのパス。Mule では、現在のクラスパスとファイルシステムへの相対的なパスを解決します。

Type (型)

String (文字列)

キーストアの型。

Alias (別名)

String (文字列)

キーストアに複数の非公開キーが含まれている場合に使用するキーの別名。デフォルトでは、Mule はファイル内の最初のキーを使用します。

Key Password (キーパスワード)

String (文字列)

非公開キーを保護するために使用するパスワード。

Password (パスワード)

String (文字列)

キーストアを保護するために使用するパスワード。

Algorithm (アルゴリズム)

String (文字列)

キーストアで使用する暗号化アルゴリズム。

Standard Revocation Check (標準の取り消し確認)

TLS 証明書の標準取り消し確認を設定します。

項目 型 説明 デフォルト値 必須

Only End Entities (最後のエンティティのみ)

Boolean (ブール)

証明書チェーン内で確認する要素:

  • true​

    証明書チェーンの最後の要素のみを確認します。

  • false​

    証明書チェーンのすべての要素を確認します。

Prefer Crls (CRL を優先)

Boolean (ブール)

証明書の有効性を確認する方法:

  • true​

    証明書失効リスト (CRL) で証明書の有効性を確認します。

  • false​

    オンライン証明書状況プロトコル (OCSP) を使用して証明書の有効性を確認します。

No Fallback (代替なし)

Boolean (ブール)

証明書の有効性を確認するための第 2 の方法を使用するかどうか:

  • true​

    [Prefer Crls (CRL を優先)]​ 項目で指定されていない方法 (第 2 の方法) を使用して証明書の有効性を確認します。

  • false​

    証明書の有効性を確認するための第 2 の方法を使用しません。

Soft Fail (ソフトフェール)

Boolean (ブール)

取り消しサーバーに到達できない場合や取り消しサーバーが混雑している場合の処理:

  • true​

    検証エラーを回避します。

  • false​

    検証の失敗を許可します。

Custom OCSP Responder (カスタム OCSP レスポンダー)

証明書の取り消し確認のカスタム OCSP レスポンダーを設定します。

項目 型 説明 デフォルト値 必須

Url

String (文字列)

OCSP レスポンダーの URL。

Cert Alias (証明書の別名)

String (文字列)

OCSP 応答の署名証明書の別名。指定した場合、別名はトラストストアに存在する必要があります。

CRL File (CRL ファイル)

証明書失効リスト (CRL) ファイルの場所を指定します。

項目 型 説明 デフォルト値 必須

Path (パス)

String (文字列)

CRL ファイルへのパス。

Reconnection (再接続)

操作の再接続戦略を設定します。

項目 型 説明 デフォルト値 必須

Fails Deployment (デプロイに失敗)

Boolean (ブール)

アプリケーションのデプロイ時に、関連する再接続戦略をすべて実行した後、接続テストに合格しない場合の処理:

  • true​

    デプロイの失敗を許可します。

  • false​

    接続テストの結果を無視します。

Reconnection Strategy (再接続戦略)

使用する再接続戦略。

Reconnect (再接続)

標準再接続戦略を設定し、再接続の頻度と、コネクタソースまたは操作で実行できる再接続の試行回数を指定します。

項目 型 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続を試行する頻度 (ミリ秒)。

Blocking

Boolean (ブール)

false​ の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

Count (数)

Number (数値)

Mule アプリケーションで実行できる再接続の試行回数。

Reconnect Forever (繰り返し再接続)

Mule アプリケーションが実行されている間はコネクタソースや操作によって指定された頻度で再接続が試行される Forever 再接続戦略を設定します。

項目 型 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続を試行する頻度 (ミリ秒)。

Blocking

Boolean (ブール)

false​ の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

Expiration Policy (有効期限ポリシー)

有効期限ポリシー戦略を設定します。

項目 型 説明 デフォルト値 必須

Max Idle Time (最大アイドル時間)

Number (数値)

動的設定インスタンスがアイドル状態を続けられる最大時間を設定します。この時間が経過すると、Mule Runtime で期限切れに相当するとみなされます。

Time Unit (時間単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

[Max Idle Time (最大アイドル時間)]​ 項目の時間単位。

HTTP Response Attributes (HTTP 応答属性)

設定の HTTP 応答属性を設定します。

項目 型 説明 デフォルト値 必須

Status Code (状況コード)

Number (数値)

応答の HTTP 状況コード。

x

Headers (ヘッダー)

Object (オブジェクト)

メッセージ内の HTTP ヘッダーのマッピング。

x

Reason Phrase (理由を示す語句)

String (文字列)

応答の HTTP の理由を示す語句。

x

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)

データが最大バッファサイズを超えた場合に要求が失敗するメモリ内ストリーミング戦略を設定します。ユースケースで最適なバッファサイズは、必ずパフォーマンステストを実施して決めてください。

項目 型 説明 デフォルト値 必須

Initial Buffer Size (初期バッファサイズ)

Number (数値)

データストリームに割り当てるメモリの初期容量。ストリーミングされたデータがこの値を超える場合は、​[Buffer Size Increment (バッファサイズ増分)]​ の単位で ​[Max In Memory Size (最大メモリ内サイズ)]​ 値を上限としてバッファが拡張されます。

Buffer Size Increment (バッファサイズ増分)

Number (数値)

バッファサイズが初期サイズを超えた場合に、拡張する量。値を ​0​ またはそれ以下に設定すると、バッファは拡張されません。

Max Buffer Size (最大バッファサイズ)

Number (数値)

使用するメモリの最大量。これを超えると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。0 以下の値は無制限を意味します。

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれかになります。

  • BYTE (バイト)

  • KB

  • MB

  • GB

[Initial Buffer Size (初期バッファサイズ)]​ 項目、​[Buffer Size Increment (バッファサイズ増分)]​ 項目、​[Buffer Unit (バッファ単位)]​ 項目の単位。

Repeatable File Store Stream (反復可能なファイルストアストリーム)

反復可能なファイルストアストリーミング戦略を設定します。この戦略では、ストリームコンテンツの一部がメモリ内に格納されます。ストリームのコンテンツが、設定されたバッファサイズよりも大きい場合、Mule はバッファのコンテンツをディスクにバックアップしてからメモリをクリアします。

項目 型 説明 デフォルト値 必須

In Memory Size (メモリ内サイズ)

Number (数値)

ストリームのデータで使用できるメモリの最大量。メモリ量がこの値を超えると、コンテンツはディスクにバッファされます。パフォーマンスを最適化する方法は、次のとおりです。

  • バッファサイズを大きくすると、Mule がバッファをディスクに書き込む回数を減らせます。これによってパフォーマンスが高まりますが、より多くのメモリが必要になるため、アプリケーションが処理できる同時要求数が制限されます。

  • バッファサイズを小さくすると、メモリの負荷は低減しますが、応答時間が長くなります。

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれかになります。

  • BYTE (バイト)

  • KB

  • MB

  • GB

[In Memory Size (メモリ内サイズ)]​ 項目の単位。

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)

項目 型 説明 デフォルト値 必須

Initial Buffer Size (初期バッファサイズ)

Number (数値)

ストリームを使用し、ランダムアクセスを提供するために初期状態でメモリ内に保持が許容されるインスタンスの量。ストリームのデータ量がこのバッファサイズを超える場合は、​[Buffer Size Increment (バッファサイズ増分)]​ 属性に従って、​[Max In Memory Size (最大メモリ内サイズ)]​ を上限としてバッファが拡張されます。デフォルト値は 100 インスタンスです。

Buffer Size Increment (バッファサイズ増分)

Number (数値)

バッファサイズが初期サイズを超えた場合に、どれだけ拡張するか。値を 0 以下に設定すると、バッファが拡張されません。つまり、バッファがフルになると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。デフォルト値は 100 インスタンスです。

Max Buffer Size (最大バッファサイズ)

Number (数値)

使用するメモリの最大量。これを超えると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。0 以下の値は無制限を意味します。

Repeatable File Store Iterable (反復可能なファイルストアイテラブル)

項目 型 説明 デフォルト値 必須

In Memory Objects (メモリ内オブジェクト)

Number (数値)

メモリ内に保持されるインスタンスの最大数。これ以上の量が必要な場合、ディスク上のコンテンツがバッファされます。

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれかになります。

  • BYTE (バイト)

  • KB

  • MB

  • GB

[In Memory Size (メモリ内サイズ)]​ 項目の単位。

関連情報