---
schema_version: "1"
id: c0368c0bb35e0ea092bafca399aba32631025eb1aa42c6871bfe90fa56b87d5e
title: Azure Cosmos DB Connector 1.0 Reference
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/azure-cosmos-db-connector/1.0/azure-cosmos-db-connector-reference.md
canonical_url: https://docs.mulesoft.com/azure-cosmos-db-connector/1.0/azure-cosmos-db-connector-reference
source_site: docs.mulesoft.com
content_type: documentation
content_hash: 391d5dc6041276c6649380cdf99d88910a78a0da308d1125d85e3836f450a0d5
description: MuleSoft Documentation Site
release: "1.0"
latest: false
---
---
product: Azure Cosmos DB Connector
version: 1.0
---

# Azure Cosmos DB Connector 1.0 Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## Configurations

---

### Key Token Config

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Name</p></td><td><p>String</p></td><td><p>Name for this configuration. Connectors reference the configuration with this name.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Connection</p></td><td><div><div><p><a href="#KeyTokenConfig_KeyTokenAuth">Key Token Auth Connection Provider</a></p></div></div></td><td><p>Connection types for this configuration.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td><p>60</p></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td><p>SECONDS</p></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><div><div><p>How the connector streams request content to the remote service:</p></div><div><ul><li><p><code>AUTO</code> (default)</p><div><p>Connector automatically uses the best streaming strategy based on the request content.</p></div></li><li><p><code>ALWAYS</code></p><div><p>Connector always streams the request content.</p></div></li><li><p><code>NEVER</code></p><div><p>Connector does not stream the request content.</p></div></li></ul></div></div></td><td><p>AUTO</p></td><td></td></tr><tr><td><p>Name</p></td><td><div><div><p>String</p></div></div></td><td><p>ID used to reference this configuration.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Expiration Policy</p></td><td><div><div><p><a href="#ExpirationPolicy">Expiration Policy</a></p></div></div></td><td><p>Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.</p></td><td></td><td></td></tr></tbody></table>

#### Connection Types

##### Key Token Auth Connection Provider

###### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Proxy Config</p></td><td><div><div><p><a href="#Proxy">Proxy</a></p></div></div></td><td><p>Configures a proxy for outbound connections.</p></td><td></td><td></td></tr><tr><td><p>Default Headers</p></td><td><div><div><p>Array of <a href="#DefaultHeader">Default Header</a>.</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Query Parameters</p></td><td><div><div><p>Array of <a href="#DefaultQueryParam">Default Query Param</a>.</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Connection Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long the connector waits before timing out when establishing a connection to the remote service.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Connection Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Connection Timeout</strong> field.</p></td><td><p>SECONDS</p></td><td></td></tr><tr><td><p>Use Persistent Connections</p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Indicates whether to use persistent connections:</p></div><div><ul><li><p><code>true</code></p><div><p>Mule uses persistent connections.</p></div></li><li><p><code>false</code></p><div><p>Mule closes the connection after the first request completes.</p></div></li></ul></div></div></td><td><p>true</p></td><td></td></tr><tr><td><p>Max Connections</p></td><td><div><div><p>Number</p></div></div></td><td><p>Maximum number of connections to open to the backend. HTTP requests are sent in parallel over multiple connections. Setting this value too high can impact latency and consume additional resources without increasing throughput.</p></td><td><p>-1</p></td><td></td></tr><tr><td><p>Connection Idle Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>When persistent connections are enabled, how long a connection can remain idle before Mule closes it.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Connection Idle Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Connection Idle Timeout</strong> field.</p></td><td><p>SECONDS</p></td><td></td></tr><tr><td><p>Stream Response</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>If this value is <code>true</code>, Mule streams received responses.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Response Buffer Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Size of the buffer that stores the HTTP response, in bytes.</p></td><td><p>-1</p></td><td></td></tr><tr><td><p>Database account url</p></td><td><div><div><p>String</p></div></div></td><td><p>Database account URL.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Key token</p></td><td><div><div><p>String</p></div></div></td><td><p>All access key token that enables users to have full control of the Cosmos DB resources.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Version</p></td><td><div><div><p>String</p></div></div></td><td><p>Version of the Cosmos DB REST service.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>TLS configuration</p></td><td><div><div><p><a href="#Tls">TLS</a></p></div></div></td><td><p>If HTTPS is configured as a protocol, the user must configure at least the keystore configuration.</p></td><td></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#reconnection">Reconnection</a></p></div></div></td><td><div><div><p>What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy:</p></div><div><ul><li><p><code>true</code></p><div><p>Allow the deployment to fail.</p></div></li><li><p><code>false</code></p><div><p>Ignore the results of the connectivity test.</p></div></li></ul></div></div></td><td></td><td></td></tr></tbody></table>

## Supported Operations

- [Create Document](#CreateDocument)

- [Create Permission](#CreatePermission)

- [Create Stored Procedure](#CreateStoredProcedure)

- [Delete Document](#DeleteDocument)

- [Delete Permission](#DeletePermission)

- [Delete Stored Procedure](#DeleteStoredProcedure)

- [Execute Stored Procedure](#ExecuteStoredProcedure)

- [Get Document](#GetDocument)

- [Get Permission](#GetPermission)

- [List Documents](#ListDocuments)

- [List Permissions](#ListPermissions)

- [List Stored Procedures](#ListStoredProcedures)

- [Query Documents](#QueryDocuments)

- [Replace Document](#ReplaceDocument)

- [Replace Permission](#ReplacePermission)

- [Replace Stored Procedure](#ReplaceStoredProcedure)

---

### Resource Token Config

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Name</p></td><td><p>String</p></td><td><p>Name for this configuration. Connectors reference the configuration with this name.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Connection</p></td><td><div><div><p><a href="#ResourceTokenConfig_ResourceTokenAuth">Resource Token Auth Connection Provider</a></p></div></div></td><td><p>Connection types for this configuration.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td><p>60</p></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td><p>SECONDS</p></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><div><div><p>How the connector streams request content to the remote service:</p></div><div><ul><li><p><code>AUTO</code> (default)</p><div><p>Connector automatically uses the best streaming strategy based on the request content.</p></div></li><li><p><code>ALWAYS</code></p><div><p>Connector always streams the request content.</p></div></li><li><p><code>NEVER</code></p><div><p>Connector does not stream the request content.</p></div></li></ul></div></div></td><td><p>AUTO</p></td><td></td></tr><tr><td><p>Name</p></td><td><div><div><p>String</p></div></div></td><td><p>ID used to reference this configuration.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Expiration Policy</p></td><td><div><div><p><a href="#ExpirationPolicy">Expiration Policy</a></p></div></div></td><td><p>Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.</p></td><td></td><td></td></tr></tbody></table>

#### Connection Types

##### Resource Token Auth Connection Provider

###### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Proxy Config</p></td><td><div><div><p><a href="#Proxy">Proxy</a></p></div></div></td><td><p>Configures a proxy for outbound connections.</p></td><td></td><td></td></tr><tr><td><p>Default Headers</p></td><td><div><div><p>Array of <a href="#DefaultHeader">Default Header</a>.</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Query Parameters</p></td><td><div><div><p>Array of <a href="#DefaultQueryParam">Default Query Param</a>.</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Connection Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long the connector waits before timing out when establishing a connection to the remote service.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Connection Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Connection Timeout</strong> field.</p></td><td><p>SECONDS</p></td><td></td></tr><tr><td><p>Use Persistent Connections</p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Indicates whether to use persistent connections:</p></div><div><ul><li><p><code>true</code></p><div><p>Mule uses persistent connections.</p></div></li><li><p><code>false</code></p><div><p>Mule closes the connection after the first request completes.</p></div></li></ul></div></div></td><td><p>true</p></td><td></td></tr><tr><td><p>Max Connections</p></td><td><div><div><p>Number</p></div></div></td><td><p>Maximum number of connections to open to the backend. HTTP requests are sent in parallel over multiple connections. Setting this value too high can impact latency and consume additional resources without increasing throughput.</p></td><td><p>-1</p></td><td></td></tr><tr><td><p>Connection Idle Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>When persistent connections are enabled, how long a connection can remain idle before Mule closes it.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Connection Idle Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Connection Idle Timeout</strong> field.</p></td><td><p>SECONDS</p></td><td></td></tr><tr><td><p>Stream Response</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>If this value is <code>true</code>, Mule streams received responses.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Response Buffer Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Size of the buffer that stores the HTTP response, in bytes.</p></td><td><p>-1</p></td><td></td></tr><tr><td><p>Database account url</p></td><td><div><div><p>String</p></div></div></td><td><p>Database account URL.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Resource token</p></td><td><div><div><p>String</p></div></div></td><td><p>Resource token.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Version</p></td><td><div><div><p>String</p></div></div></td><td><p>Version of the Cosmos DB REST service.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>TLS configuration</p></td><td><div><div><p><a href="#Tls">TLS</a></p></div></div></td><td><p>If HTTPS is configured as a protocol, the user must configure at least the keystore configuration.</p></td><td></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#reconnection">Reconnection</a></p></div></div></td><td><div><div><p>What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy:</p></div><div><ul><li><p><code>true</code></p><div><p>Allow the deployment to fail.</p></div></li><li><p><code>false</code></p><div><p>Ignore the results of the connectivity test.</p></div></li></ul></div></div></td><td></td><td></td></tr></tbody></table>

## Supported Operations

- [Create Document](#CreateDocument)

- [Create Stored Procedure](#CreateStoredProcedure)

- [Delete Document](#DeleteDocument)

- [Delete Stored Procedure](#DeleteStoredProcedure)

- [Execute Stored Procedure](#ExecuteStoredProcedure)

- [Get Document](#GetDocument)

- [List Documents](#ListDocuments)

- [List Stored Procedures](#ListStoredProcedures)

- [Query Documents](#QueryDocuments)

- [Replace Document](#ReplaceDocument)

- [Replace Stored Procedure](#ReplaceStoredProcedure)

## Operations

## Create Document

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

Creates a new document in a collection. This operation makes an HTTP POST request to the
/dbs/{dbId}/colls/{collId}/docs endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Db Id</p></td><td><div><div><p>String</p></div></div></td><td><p>User-generated name or ID of the database in which the stored procedure is created.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Coll Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the collection in which the stored procedure is created.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>X ms documentdb is upsert</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>If set to <code>true</code>, Cosmos DB does the following:</p><p>* Creates the document with the ID (and partition key value, if applicable), if the document doesn’t exist. * Updates the document, if it exists.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>X ms indexing directive</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>INCLUDE</p></li><li><p>EXCLUDE</p></li></ul></div></div></td><td><p>The default for indexing behavior is determined by the automatic property’s value in the indexing policy for the collection.</p></td><td></td><td></td></tr><tr><td><p>X ms documentdb partitionkey</p></td><td><div><div><p>String</p></div></div></td><td><p>Partition key value for the document to create. Must be specified only if the collection is created with a <strong>partitionKey</strong> definition, for example, ["partitionKey"].</p></td><td></td><td></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><div><div><p>How the connector streams request content to the remote service:</p></div><div><ul><li><p><code>AUTO</code> (default)</p></li></ul></div><div><p>Connector automatically uses the best streaming strategy based on the request content.</p></div><div><ul><li><p><code>ALWAYS</code></p></li></ul></div><div><p>Connector always streams the request content.</p></div><div><ul><li><p><code>NEVER</code></p></li></ul></div><div><p>Connector does not stream the request content.</p></div></div></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Key Token Config](#KeyTokenConfig)

- [Resource Token Config](#ResourceTokenConfig)

### Throws

- 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>`

Creates a new permission in a database. This operation makes an HTTP POST request to the
/dbs/{dbId}/users/{userName}/permissions endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Db Id</p></td><td><div><div><p>String</p></div></div></td><td><p>User-generated name or ID of the database in which the permission is created.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Username</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the user that owns the permission.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>X ms documentdb expiry seconds</p></td><td><div><div><p>Number</p></div></div></td><td><p>Validity period of the resource token returned by the operation.</p></td><td></td><td></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><div><div><p>How the connector streams request content to the remote service:</p></div><div><ul><li><p><code>AUTO</code> (default)</p></li></ul></div><div><p>Connector automatically uses the best streaming strategy based on the request content.</p></div><div><ul><li><p><code>ALWAYS</code></p></li></ul></div><div><p>Connector always streams the request content.</p></div><div><ul><li><p><code>NEVER</code></p></li></ul></div><div><p>Connector does not stream the request content.</p></div></div></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Key Token Config](#KeyTokenConfig)

### Throws

- 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>`

Creates a new stored procedure in a collection. This operation makes an HTTP POST request to the
/dbs/{dbId}/colls/{collId}/sprocs endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Db Id</p></td><td><div><div><p>String</p></div></div></td><td><p>User-generated name or ID of the database in which the stored procedure is created.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Coll Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the collection in which the stored procedure is created.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><div><div><p>How the connector streams request content to the remote service:</p></div><div><ul><li><p><code>AUTO</code> (default)</p></li></ul></div><div><p>Connector automatically uses the best streaming strategy based on the request content.</p></div><div><ul><li><p><code>ALWAYS</code></p></li></ul></div><div><p>Connector always streams the request content.</p></div><div><ul><li><p><code>NEVER</code></p></li></ul></div><div><p>Connector does not stream the request content.</p></div></div></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Key Token Config](#KeyTokenConfig)

- [Resource Token Config](#ResourceTokenConfig)

### Throws

- 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>`

Deletes an existing document from a collection. This operation makes an HTTP DELETE request to the
/dbs/{dbId}/colls/{collId}/docs/{doc-id} endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Db Id</p></td><td><div><div><p>String</p></div></div></td><td><p>User-generated name or ID of the database in which the stored procedure is created.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Coll Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the collection in which the stored procedure is created.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Doc ID</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the document to delete.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>X ms documentdb partitionkey</p></td><td><div><div><p>String</p></div></div></td><td><p>Partition key value for the document to delete. Must be specified only if the collection is created with a <strong>partitionKey</strong> definition, for example, ["partitionKey"].</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><div><div><p>How the connector streams request content to the remote service:</p></div><div><ul><li><p><code>AUTO</code> (default)</p></li></ul></div><div><p>Connector automatically uses the best streaming strategy based on the request content.</p></div><div><ul><li><p><code>ALWAYS</code></p></li></ul></div><div><p>Connector always streams the request content.</p></div><div><ul><li><p><code>NEVER</code></p></li></ul></div><div><p>Connector does not stream the request content.</p></div></div></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Key Token Config](#KeyTokenConfig)

- [Resource Token Config](#ResourceTokenConfig)

### Throws

- 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>`

Deletes a permission from a database. This operation makes an HTTP DELETE request to the
/dbs/{dbId}/users/{userName}/permissions/{permissionId} endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Db Id</p></td><td><div><div><p>String</p></div></div></td><td><p>User-generated name or ID of the database in which the permission is deleted.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Username</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the user that owns the permission.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Permission Id</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the permission to delete.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><div><div><p>How the connector streams request content to the remote service:</p></div><div><ul><li><p><code>AUTO</code> (default)</p></li></ul></div><div><p>Connector automatically uses the best streaming strategy based on the request content.</p></div><div><ul><li><p><code>ALWAYS</code></p></li></ul></div><div><p>Connector always streams the request content.</p></div><div><ul><li><p><code>NEVER</code></p></li></ul></div><div><p>Connector does not stream the request content.</p></div></div></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Key Token Config](#KeyTokenConfig)

### Throws

- 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>`

Deletes an existing stored procedure from a collection. This operation makes an HTTP DELETE request
to the /dbs/{dbId}/colls/{collId}/sprocs/{sprocId} endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Db Id</p></td><td><div><div><p>String</p></div></div></td><td><p>User-generated name or ID of the database in which the stored procedure is created.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Coll Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the collection in which the stored procedure is created.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Sproc Id</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the stored procedure to delete.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><div><div><p>How the connector streams request content to the remote service:</p></div><div><ul><li><p><code>AUTO</code> (default)</p></li></ul></div><div><p>Connector automatically uses the best streaming strategy based on the request content.</p></div><div><ul><li><p><code>ALWAYS</code></p></li></ul></div><div><p>Connector always streams the request content.</p></div><div><ul><li><p><code>NEVER</code></p></li></ul></div><div><p>Connector does not stream the request content.</p></div></div></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Key Token Config](#KeyTokenConfig)

- [Resource Token Config](#ResourceTokenConfig)

### Throws

- 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>`

Executes a stored procedure by performing a POST on a stored procedure resource. This operation
makes an HTTP POST request to the /dbs/{dbId}/colls/{collId}/sprocs/{sprocId} endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Db Id</p></td><td><div><div><p>String</p></div></div></td><td><p>User generated name or ID of the database in which the stored procedure is executed.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Coll Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the collection in which the stored procedure is executed.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Sproc Id</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the stored procedure to execute.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><div><div><p>How the connector streams request content to the remote service:</p></div><div><ul><li><p><code>AUTO</code> (default)</p></li></ul></div><div><p>Connector automatically uses the best streaming strategy based on the request content.</p></div><div><ul><li><p><code>ALWAYS</code></p></li></ul></div><div><p>Connector always streams the request content.</p></div><div><ul><li><p><code>NEVER</code></p></li></ul></div><div><p>Connector does not stream the request content.</p></div></div></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Key Token Config](#KeyTokenConfig)

- [Resource Token Config](#ResourceTokenConfig)

### Throws

- 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>`

Retrieves a document by its partition key and document key. This operation makes an HTTP GET request
to the /dbs/{dbId}/colls/{collId}/docs/{doc-id} endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Db Id</p></td><td><div><div><p>String</p></div></div></td><td><p>User-generated name or ID of the database in which the stored procedure is created.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Coll Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the collection in which the stored procedure is created.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Doc ID</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the document to replace.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>If None Match</p></td><td><div><div><p>String</p></div></div></td><td><p>Indicates whether the operation is conditional, which means if the response includes a body, the value in the database is different from the specified value in the header. The value must be the ETag of the resource.</p></td><td></td><td></td></tr><tr><td><p>X ms documentdb partitionkey</p></td><td><div><div><p>String</p></div></div></td><td><p>Partition key value for the document to read. Must be specified only if the collection is created with a <strong>partitionKey</strong> definition, for example, ["partitionKey"].</p></td><td></td><td></td></tr><tr><td><p>X ms consistency level</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>STRONG</p></li><li><p>BOUNDED</p></li><li><p>SESSION</p></li><li><p>EVENTUAL</p></li></ul></div></div></td><td><p>Consistency level override. The valid values are listed in order of strongest to weakest. The override must be the same or weaker than the account’s configured consistency level.</p></td><td></td><td></td></tr><tr><td><p>X ms session token</p></td><td><div><div><p>String</p></div></div></td><td><p>String token used with session level consistency. Clients must echo the latest read value of this header during read requests for session consistency.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><div><div><p>How the connector streams request content to the remote service:</p></div><div><ul><li><p><code>AUTO</code> (default)</p></li></ul></div><div><p>Connector automatically uses the best streaming strategy based on the request content.</p></div><div><ul><li><p><code>ALWAYS</code></p></li></ul></div><div><p>Connector always streams the request content.</p></div><div><ul><li><p><code>NEVER</code></p></li></ul></div><div><p>Connector does not stream the request content.</p></div></div></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Key Token Config](#KeyTokenConfig)

- [Resource Token Config](#ResourceTokenConfig)

### Throws

- 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>`

Gets a permission from the specified database. This operation makes an HTTP GET request to the
/dbs/{dbId}/users/{userName}/permissions/{permissionId} endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Db Id</p></td><td><div><div><p>String</p></div></div></td><td><p>User-generated name or ID of the database in which the permission is retrieved.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Username</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the user that owns the permission.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Permission Id</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the permission to retrieve.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>X ms documentdb expiry seconds</p></td><td><div><div><p>Number</p></div></div></td><td><p>Validity period of the resource token returned by the operation.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><div><div><p>How the connector streams request content to the remote service:</p></div><div><ul><li><p><code>AUTO</code> (default)</p></li></ul></div><div><p>Connector automatically uses the best streaming strategy based on the request content.</p></div><div><ul><li><p><code>ALWAYS</code></p></li></ul></div><div><p>Connector always streams the request content.</p></div><div><ul><li><p><code>NEVER</code></p></li></ul></div><div><p>Connector does not stream the request content.</p></div></div></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Key Token Config](#KeyTokenConfig)

### Throws

- 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>`

Returns a list of documents under the collection. This operation makes an HTTP GET request to the
/dbs/{dbId}/colls/{collId}/docs endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Db Id</p></td><td><div><div><p>String</p></div></div></td><td><p>User-generated name or ID of the database in which the stored procedure is created.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Coll Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the collection in which the stored procedure is created.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>X ms consistency level</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>STRONG</p></li><li><p>BOUNDED</p></li><li><p>SESSION</p></li><li><p>EVENTUAL</p></li></ul></div></div></td><td><p>Consistency level override. The valid values are listed in order of strongest to weakest. The override must be the same or weaker than the account’s configured consistency level.</p></td><td></td><td></td></tr><tr><td><p>X ms session token</p></td><td><div><div><p>String</p></div></div></td><td><p>String token used with session level consistency. Clients must echo the latest read value of this header during read requests for session consistency.</p></td><td></td><td></td></tr><tr><td><p>A im</p></td><td><div><div><p>String</p></div></div></td><td><p>Must be set to <code>Incremental feed</code>, or omitted otherwise. Available for REST API version 2016-07-11 and later.</p></td><td></td><td></td></tr><tr><td><p>If None Match</p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Available for REST API version 2016-07-11 and later.</p></div><div><ul><li><p>No header</p><div><p>Returns all changes from the beginning (collection creation).</p></div></li><li><p>"*"</p><div><p>Returns all new changes to data within the collection.</p></div></li><li><p>A collection ETag</p><div><p>Returns all changes made since that logical timestamp.</p></div></li></ul></div></div></td><td></td><td></td></tr><tr><td><p>X ms documentdb partitionkeyrangeid</p></td><td><div><div><p>String</p></div></div></td><td><p>Partition key range ID for reading data. Available for REST API version 2016-07-11 and later.</p></td><td></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><div><div><p>How the connector streams request content to the remote service:</p></div><div><ul><li><p><code>AUTO</code> (default)</p></li></ul></div><div><p>Connector automatically uses the best streaming strategy based on the request content.</p></div><div><ul><li><p><code>ALWAYS</code></p></li></ul></div><div><p>Connector always streams the request content.</p></div><div><ul><li><p><code>NEVER</code></p></li></ul></div><div><p>Connector does not stream the request content.</p></div></div></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Key Token Config](#KeyTokenConfig)

- [Resource Token Config](#ResourceTokenConfig)

### Throws

- 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>`

Lists permissions of a user from a database. This operation makes an HTTP GET request to the
/dbs/{dbId}/users/{userName}/permissions endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Db Id</p></td><td><div><div><p>String</p></div></div></td><td><p>User-generated name or ID of the database in which the permission is retrieved.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Username</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the user that owns the permission.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><div><div><p>How the connector streams request content to the remote service:</p></div><div><ul><li><p><code>AUTO</code> (default)</p></li></ul></div><div><p>Connector automatically uses the best streaming strategy based on the request content.</p></div><div><ul><li><p><code>ALWAYS</code></p></li></ul></div><div><p>Connector always streams the request content.</p></div><div><ul><li><p><code>NEVER</code></p></li></ul></div><div><p>Connector does not stream the request content.</p></div></div></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Key Token Config](#KeyTokenConfig)

### Throws

- 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>`

Returns a list of the stored procedures in the collection. This operation makes an HTTP GET request
to the /dbs/{dbId}/colls/{collId}/sprocs endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Db Id</p></td><td><div><div><p>String</p></div></div></td><td><p>User-generated name or ID of the database in which the stored procedure is created.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Coll Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the collection in which the stored procedure is created.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><div><div><p>How the connector streams request content to the remote service:</p></div><div><ul><li><p><code>AUTO</code> (default)</p></li></ul></div><div><p>Connector automatically uses the best streaming strategy based on the request content.</p></div><div><ul><li><p><code>ALWAYS</code></p></li></ul></div><div><p>Connector always streams the request content.</p></div><div><ul><li><p><code>NEVER</code></p></li></ul></div><div><p>Connector does not stream the request content.</p></div></div></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Key Token Config](#KeyTokenConfig)

- [Resource Token Config](#ResourceTokenConfig)

### Throws

- 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>`

Queries documents. This operation makes an HTTP POST request to the /dbs/{dbId}/colls/{collId}/docs
endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Db Id</p></td><td><div><div><p>String</p></div></div></td><td><p>User-generated name or ID of the database in which the stored procedure is created.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Coll Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the collection in which the stored procedure is created.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>X ms documentdb query enablecrosspartition</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>If the collection is partitioned, this parameter must be set to <code>true</code> to enable execution across multiple partitions. Queries that filter against a single partition key, or against single-partitioned collections do not need to set the header.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>X ms consistency level</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>STRONG</p></li><li><p>BOUNDED</p></li><li><p>SESSION</p></li><li><p>EVENTUAL</p></li></ul></div></div></td><td><p>Consistency level override. The valid values are listed in order of strongest to weakest. The override must be the same or weaker than the account’s configured consistency level.</p></td><td></td><td></td></tr><tr><td><p>X ms session token</p></td><td><div><div><p>String</p></div></div></td><td><p>String token used with session level consistency. Clients must echo the latest read value of this header during read requests for session consistency.</p></td><td></td><td></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><div><div><p>How the connector streams request content to the remote service:</p></div><div><ul><li><p><code>AUTO</code> (default)</p></li></ul></div><div><p>Connector automatically uses the best streaming strategy based on the request content.</p></div><div><ul><li><p><code>ALWAYS</code></p></li></ul></div><div><p>Connector always streams the request content.</p></div><div><ul><li><p><code>NEVER</code></p></li></ul></div><div><p>Connector does not stream the request content.</p></div></div></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Key Token Config](#KeyTokenConfig)

- [Resource Token Config](#ResourceTokenConfig)

### Throws

- 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>`

Replaces the entire content of a document. This operation makes an HTTP PUT request to the
/dbs/{dbId}/colls/{collId}/docs/{doc-id} endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Db Id</p></td><td><div><div><p>String</p></div></div></td><td><p>User-generated name or ID of the database in which the stored procedure is created.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Coll Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the collection in which the stored procedure is created.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Doc ID</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the document to replace.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>If Match</p></td><td><div><div><p>String</p></div></div></td><td><p>Indicates whether an operation is conditional for optimistic concurrency, which means the document is updated only if the specified ETag matches the current version in the database. The value must be set to the ETag value of the resource.</p></td><td></td><td></td></tr><tr><td><p>X ms indexing directive</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>INCLUDE</p></li><li><p>EXCLUDE</p></li></ul></div></div></td><td><p>The default for indexing behavior is determined by the automatic property’s value in the indexing policy for the collection.</p></td><td></td><td></td></tr><tr><td><p>X ms documentdb partitionkey</p></td><td><div><div><p>String</p></div></div></td><td><p>Partition key value for the document to replace. Must be specified only if the collection is created with a <strong>partitionKey</strong> definition, for example, ["partitionKey"].</p></td><td></td><td></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><div><div><p>How the connector streams request content to the remote service:</p></div><div><ul><li><p><code>AUTO</code> (default)</p></li></ul></div><div><p>Connector automatically uses the best streaming strategy based on the request content.</p></div><div><ul><li><p><code>ALWAYS</code></p></li></ul></div><div><p>Connector always streams the request content.</p></div><div><ul><li><p><code>NEVER</code></p></li></ul></div><div><p>Connector does not stream the request content.</p></div></div></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Key Token Config](#KeyTokenConfig)

- [Resource Token Config](#ResourceTokenConfig)

### Throws

- 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>`

Replaces a permission from a database. This operation makes an HTTP PUT request to the
/dbs/{dbId}/users/{userName}/permissions/{permissionId} endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Db Id</p></td><td><div><div><p>String</p></div></div></td><td><p>User-generated name or ID of the database in which the permission is replaced.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Username</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the user that owns the permission.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Permission Id</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the permission to replace.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>X ms documentdb expiry seconds</p></td><td><div><div><p>Number</p></div></div></td><td><p>Validity period of the resource token returned by the operation.</p></td><td></td><td></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><div><div><p>How the connector streams request content to the remote service:</p></div><div><ul><li><p><code>AUTO</code> (default)</p></li></ul></div><div><p>Connector automatically uses the best streaming strategy based on the request content.</p></div><div><ul><li><p><code>ALWAYS</code></p></li></ul></div><div><p>Connector always streams the request content.</p></div><div><ul><li><p><code>NEVER</code></p></li></ul></div><div><p>Connector does not stream the request content.</p></div></div></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Key Token Config](#KeyTokenConfig)

### Throws

- 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>`

Replaces the entire stored procedure resource. All user settable properties, including the ID and
the body, must be submitted in the body to perform the replacement. This operation makes an HTTP PUT
request to the /dbs/{dbId}/colls/{collId}/sprocs/{sprocId} endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Db Id</p></td><td><div><div><p>String</p></div></div></td><td><p>User-generated name or ID of the database in which the stored procedure is replaced.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Coll Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the collection in which the stored procedure is replaced.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Sproc Id</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the stored procedure to replace.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Content to use.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long Mule waits for a response to complete before the request times out.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Response Timeout</strong> field.</p></td><td></td><td></td></tr><tr><td><p>Streaming Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>ALWAYS</p></li><li><p>NEVER</p></li></ul></div></div></td><td><div><div><p>How the connector streams request content to the remote service:</p></div><div><ul><li><p><code>AUTO</code> (default)</p></li></ul></div><div><p>Connector automatically uses the best streaming strategy based on the request content.</p></div><div><ul><li><p><code>ALWAYS</code></p></li></ul></div><div><p>Connector always streams the request content.</p></div><div><ul><li><p><code>NEVER</code></p></li></ul></div><div><p>Connector does not stream the request content.</p></div></div></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">HTTP Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Key Token Config](#KeyTokenConfig)

- [Resource Token Config](#ResourceTokenConfig)

### Throws

- 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

## Types

### Proxy

Configures a proxy for outbound connections.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Host</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Hostname or IP address of the proxy server.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Port of the proxy server.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Username</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Username to authenticate against the proxy server.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password to authenticate against the proxy server.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Non Proxy Hosts</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Comma-separated list of hosts that the proxy must not be used against.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Default Header

Headers automatically added to every outbound request.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Key</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Key for this type.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Value for this type.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Default Query Param

Query parameters automatically added to every outbound request.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Key</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Key for this type.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Value for this type.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### TLS

Configures TLS to provide secure communications for the Mule app.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Enabled Protocols</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Comma-separated list of protocols enabled for this context.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Enabled Cipher Suites</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Comma-separated list of cipher suites enabled for this context.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Trust Store</strong></p></td><td><div><div><p><a href="#TrustStore">Truststore</a></p></div></div></td><td><div><div><p>Configures the TLS truststore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Key Store</strong></p></td><td><div><div><p><a href="#KeyStore">Keystore</a></p></div></div></td><td><div><div><p>Configures the TLS keystore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Revocation Check</strong></p></td><td><div><div><ul><li><p><a href="#StandardRevocationCheck">Standard Revocation Check</a></p></li><li><p><a href="#CustomOcspResponder">Custom OCSP Responder</a></p></li><li><p><a href="#CrlFile">CRL File</a></p></li></ul></div></div></td><td><div><div><p>Configures a revocation checking mechanism.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Truststore

Configures the truststore for TLS.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Path to the truststore. Mule resolves the path relative to the current classpath and file system.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password used to protect the truststore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Type of truststore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Encryption algorithm that the truststore uses.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Insecure</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>true</code>, Mule stops performing certificate validations. Setting this to <code>true</code> can make connections vulnerable to attacks.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Keystore

Configures the keystore for the TLS protocol. The keystore you generate contains a private key and a
public certificate.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Path to the keystore. Mule resolves the path relative to the current classpath and file system.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Type of keystore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Alias</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Key Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password used to protect the private key.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password used to protect the keystore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Encryption algorithm that the keystore uses.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Standard Revocation Check

Configures standard revocation checks for TLS certificates.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Only End Entities</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Which elements to verify in the certificate chain:</p></div><div><ul><li><p><code>true</code></p><div><p>Verify only the last element in the certificate chain.</p></div></li><li><p><code>false</code></p><div><p>Verify all elements in the certificate chain.</p></div></li></ul></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Prefer Crls</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>How to check certificate validity:</p></div><div><ul><li><p><code>true</code></p><div><p>Check the Certification Revocation List (CRL) for certificate validity.</p></div></li><li><p><code>false</code></p><div><p>Use the Online Certificate Status Protocol (OCSP) to check certificate validity.</p></div></li></ul></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>No Fallback</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Whether to use the secondary method to check certificate validity:</p></div><div><ul><li><p><code>true</code></p><div><p>Use the method that wasn’t specified in the <strong>Prefer Crls</strong> field (the secondary method) to check certificate validity.</p></div></li><li><p><code>false</code></p><div><p>Do not use the secondary method to check certificate validity.</p></div></li></ul></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Soft Fail</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>What to do if the revocation server can’t be reached or is busy:</p></div><div><ul><li><p><code>true</code></p><div><p>Avoid verification failure.</p></div></li><li><p><code>false</code></p><div><p>Allow the verification to fail.</p></div></li></ul></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Custom OCSP Responder

Configures a custom OCSP responder for certification revocation checks.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>URL of the OCSP responder.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Cert Alias</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Alias of the signing certificate for the OCSP response. If specified, the alias must be in the truststore.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### CRL File

Specifies the location of the certification revocation list (CRL) file.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Path to the CRL file.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnection

Configures a reconnection strategy for an operation.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Fails Deployment</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy:</p></div><div><ul><li><p><code>true</code></p><div><p>Allow the deployment to fail.</p></div></li><li><p><code>false</code></p><div><p>Ignore the results of the connectivity test.</p></div></li></ul></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Reconnection strategy to use.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnect

Configures a standard reconnection strategy, which specifies how often to reconnect and how many
reconnection attempts the connector source or operation can make.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often to attempt to reconnect, in milliseconds.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Blocking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>false</code>, the reconnection strategy runs in a separate, non-blocking thread.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How many reconnection attempts the Mule app can make.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnect Forever

Configures a forever reconnection strategy by which the connector source or operation attempts to
reconnect at a specified frequency for as long as the Mule app runs.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often to attempt to reconnect, in milliseconds.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Blocking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>false</code>, the reconnection strategy runs in a separate, non-blocking thread.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Expiration Policy

Configures an expiration policy strategy.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Max Idle Time</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Max Idle Time</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### HTTP Response Attributes

Configures HTTP response attributes for the configuration.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Status Code</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>HTTP status code of the response.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Headers</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Map of HTTP headers in the message.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Reason Phrase</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>HTTP reason phrase of the response.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Repeatable In Memory Stream

Configures the in-memory streaming strategy by which the request fails if the data exceeds the MAX
buffer size. Always run performance tests to find the optimal buffer size for your specific use
case.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Initial Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Initial amount of memory to allocate to the data stream. If the streamed data exceeds this value, the buffer expands by <strong>Buffer Size Increment</strong>, with an upper limit of <strong>Max In Memory Size value</strong>.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Size Increment</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Amount by which the buffer size expands if it exceeds its initial size. Setting a value of <code>0</code> or lower specifies that the buffer can’t expand.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><div><div><p>Unit for the <strong>Initial Buffer Size</strong>, <strong>Buffer Size Increment</strong>, and <strong>Buffer Unit</strong> fields.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Repeatable File Store Stream

Configures the repeatable file-store streaming strategy by which Mule keeps a portion of the stream
content in memory. If the stream content is larger than the configured buffer size, Mule backs up
the buffer’s content to disk and then clears the memory.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>In Memory Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Maximum amount of memory that the stream can use for data. If the amount of memory exceeds this value, Mule buffers the content to disk. To optimize performance:</p></div><div><ul><li><p>Configure a larger buffer size to avoid the number of times Mule needs to write the buffer on disk. This increases performance, but it also limits the number of concurrent requests your application can process, because it requires additional memory.</p></li><li><p>Configure a smaller buffer size to decrease memory load at the expense of response time.</p></li></ul></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><div><div><p>Unit for the <strong>In Memory Size</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Repeatable In Memory Iterable

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Initial Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The amount of instances that is initially be allowed to be kept in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the <strong>Buffer Size Increment</strong> attribute, with an upper limit of <strong>Max In Memory Size</strong>. The default value is 100 instances.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Size Increment</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. The default value is 100 instances.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Repeatable File Store Iterable

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>In Memory Objects</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><div><div><p>Unit for the <strong>In Memory Size</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Salesforce Help](https://help.salesforce.com)