Contact Us 1-800-596-4880
  1. Homepage
  2. Azure Cosmos DB Connector (1.0)

  3. Azure Cosmos DB Connector Reference

All Connectors

Azure Cosmos DB Connector 1.0 Reference

Configurations

Key Token Config

Parameters

Name Type Description Default Value Required

Name

String

Name for this configuration. Connectors reference the configuration with this name.

x

Connection

Key Token Auth Connection Provider

Connection types for this configuration.

x

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

60

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

SECONDS

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

AUTO

Name

String

ID used to reference this configuration.

x

Expiration Policy

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Connection Types

Key Token Auth Connection Provider
Parameters
Name Type Description Default Value Required

Proxy Config

Proxy

Configures a proxy for outbound connections.

Default Headers

Array of Default Header.

Query Parameters

Array of Default Query Param.

Connection Timeout

Number

How long the connector waits before timing out when establishing a connection to the remote service.

30

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

SECONDS

Use Persistent Connections

Boolean

Indicates whether to use persistent connections:

  • true

    Mule uses persistent connections.

  • false

    Mule closes the connection after the first request completes.

true

Max Connections

Number

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.

-1

Connection Idle Timeout

Number

When persistent connections are enabled, how long a connection can remain idle before Mule closes it.

30

Connection Idle Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Idle Timeout field.

SECONDS

Stream Response

Boolean

If this value is true, Mule streams received responses.

false

Response Buffer Size

Number

Size of the buffer that stores the HTTP response, in bytes.

-1

Database account url

String

Database account URL.

x

Key token

String

All access key token that enables users to have full control of the Cosmos DB resources.

x

Version

String

Version of the Cosmos DB REST service.

x

TLS configuration

TLS

If HTTPS is configured as a protocol, the user must configure at least the keystore configuration.

Reconnection

Reconnection

What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy:

  • true

    Allow the deployment to fail.

  • false

    Ignore the results of the connectivity test.

Supported Operations

Resource Token Config

Parameters

Name Type Description Default Value Required

Name

String

Name for this configuration. Connectors reference the configuration with this name.

x

Connection

Resource Token Auth Connection Provider

Connection types for this configuration.

x

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

60

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

SECONDS

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

AUTO

Name

String

ID used to reference this configuration.

x

Expiration Policy

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Connection Types

Resource Token Auth Connection Provider
Parameters
Name Type Description Default Value Required

Proxy Config

Proxy

Configures a proxy for outbound connections.

Default Headers

Array of Default Header.

Query Parameters

Array of Default Query Param.

Connection Timeout

Number

How long the connector waits before timing out when establishing a connection to the remote service.

30

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

SECONDS

Use Persistent Connections

Boolean

Indicates whether to use persistent connections:

  • true

    Mule uses persistent connections.

  • false

    Mule closes the connection after the first request completes.

true

Max Connections

Number

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.

-1

Connection Idle Timeout

Number

When persistent connections are enabled, how long a connection can remain idle before Mule closes it.

30

Connection Idle Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Idle Timeout field.

SECONDS

Stream Response

Boolean

If this value is true, Mule streams received responses.

false

Response Buffer Size

Number

Size of the buffer that stores the HTTP response, in bytes.

-1

Database account url

String

Database account URL.

x

Resource token

String

Resource token.

x

Version

String

Version of the Cosmos DB REST service.

x

TLS configuration

TLS

If HTTPS is configured as a protocol, the user must configure at least the keystore configuration.

Reconnection

Reconnection

What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy:

  • true

    Allow the deployment to fail.

  • false

    Ignore the results of the connectivity test.

Supported Operations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Db Id

String

User-generated name or ID of the database in which the stored procedure is created.

x

Coll Id

String

Name of the collection in which the stored procedure is created.

x

X ms documentdb is upsert

Boolean

If set to true, Cosmos DB does the following:

* Creates the document with the ID (and partition key value, if applicable), if the document doesn’t exist. * Updates the document, if it exists.

false

X ms indexing directive

Enumeration, one of:

  • INCLUDE

  • EXCLUDE

The default for indexing behavior is determined by the automatic property’s value in the indexing policy for the collection.

X ms documentdb partitionkey

String

Partition key value for the document to create. Must be specified only if the collection is created with a partitionKey definition, for example, ["partitionKey"].

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

Connector always streams the request content.

  • NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Db Id

String

User-generated name or ID of the database in which the permission is created.

x

Username

String

Name of the user that owns the permission.

x

X ms documentdb expiry seconds

Number

Validity period of the resource token returned by the operation.

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

Connector always streams the request content.

  • NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Db Id

String

User-generated name or ID of the database in which the stored procedure is created.

x

Coll Id

String

Name of the collection in which the stored procedure is created.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

Connector always streams the request content.

  • NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Db Id

String

User-generated name or ID of the database in which the stored procedure is created.

x

Coll Id

String

Name of the collection in which the stored procedure is created.

x

Doc ID

String

ID of the document to delete.

x

X ms documentdb partitionkey

String

Partition key value for the document to delete. Must be specified only if the collection is created with a partitionKey definition, for example, ["partitionKey"].

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Custom Query Parameters

Object

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.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

Connector always streams the request content.

  • NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Db Id

String

User-generated name or ID of the database in which the permission is deleted.

x

Username

String

Name of the user that owns the permission.

x

Permission Id

String

ID of the permission to delete.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Custom Query Parameters

Object

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.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

Connector always streams the request content.

  • NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Db Id

String

User-generated name or ID of the database in which the stored procedure is created.

x

Coll Id

String

Name of the collection in which the stored procedure is created.

x

Sproc Id

String

ID of the stored procedure to delete.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Custom Query Parameters

Object

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.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

Connector always streams the request content.

  • NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

HTTP Response Attributes

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Db Id

String

User generated name or ID of the database in which the stored procedure is executed.

x

Coll Id

String

Name of the collection in which the stored procedure is executed.

x

Sproc Id

String

ID of the stored procedure to execute.

x

Body

Array of String

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

Connector always streams the request content.

  • NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Db Id

String

User-generated name or ID of the database in which the stored procedure is created.

x

Coll Id

String

Name of the collection in which the stored procedure is created.

x

Doc ID

String

Name of the document to replace.

x

If None Match

String

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.

X ms documentdb partitionkey

String

Partition key value for the document to read. Must be specified only if the collection is created with a partitionKey definition, for example, ["partitionKey"].

X ms consistency level

Enumeration, one of:

  • STRONG

  • BOUNDED

  • SESSION

  • EVENTUAL

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.

X ms session token

String

String token used with session level consistency. Clients must echo the latest read value of this header during read requests for session consistency.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

Connector always streams the request content.

  • NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Db Id

String

User-generated name or ID of the database in which the permission is retrieved.

x

Username

String

Name of the user that owns the permission.

x

Permission Id

String

ID of the permission to retrieve.

x

X ms documentdb expiry seconds

Number

Validity period of the resource token returned by the operation.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

Connector always streams the request content.

  • NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Db Id

String

User-generated name or ID of the database in which the stored procedure is created.

x

Coll Id

String

Name of the collection in which the stored procedure is created.

x

X ms consistency level

Enumeration, one of:

  • STRONG

  • BOUNDED

  • SESSION

  • EVENTUAL

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.

X ms session token

String

String token used with session level consistency. Clients must echo the latest read value of this header during read requests for session consistency.

A im

String

Must be set to Incremental feed, or omitted otherwise. Available for REST API version 2016-07-11 and later.

If None Match

String

Available for REST API version 2016-07-11 and later.

  • No header

    Returns all changes from the beginning (collection creation).

  • "*"

    Returns all new changes to data within the collection.

  • A collection ETag

    Returns all changes made since that logical timestamp.

X ms documentdb partitionkeyrangeid

String

Partition key range ID for reading data. Available for REST API version 2016-07-11 and later.

Output Mime Type

String

MIME type of the payload that this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

Connector always streams the request content.

  • NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Array of Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Db Id

String

User-generated name or ID of the database in which the permission is retrieved.

x

Username

String

Name of the user that owns the permission.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

Connector always streams the request content.

  • NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Db Id

String

User-generated name or ID of the database in which the stored procedure is created.

x

Coll Id

String

Name of the collection in which the stored procedure is created.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

Connector always streams the request content.

  • NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Db Id

String

User-generated name or ID of the database in which the stored procedure is created.

x

Coll Id

String

Name of the collection in which the stored procedure is created.

x

X ms documentdb query enablecrosspartition

Boolean

If the collection is partitioned, this parameter must be set to true 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.

false

X ms consistency level

Enumeration, one of:

  • STRONG

  • BOUNDED

  • SESSION

  • EVENTUAL

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.

X ms session token

String

String token used with session level consistency. Clients must echo the latest read value of this header during read requests for session consistency.

Body

Any

Content to use.

#[payload]

Output Mime Type

String

MIME type of the payload that this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

Connector always streams the request content.

  • NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Array of Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Db Id

String

User-generated name or ID of the database in which the stored procedure is created.

x

Coll Id

String

Name of the collection in which the stored procedure is created.

x

Doc ID

String

Name of the document to replace.

x

If Match

String

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.

X ms indexing directive

Enumeration, one of:

  • INCLUDE

  • EXCLUDE

The default for indexing behavior is determined by the automatic property’s value in the indexing policy for the collection.

X ms documentdb partitionkey

String

Partition key value for the document to replace. Must be specified only if the collection is created with a partitionKey definition, for example, ["partitionKey"].

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

Connector always streams the request content.

  • NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Db Id

String

User-generated name or ID of the database in which the permission is replaced.

x

Username

String

Name of the user that owns the permission.

x

Permission Id

String

ID of the permission to replace.

x

X ms documentdb expiry seconds

Number

Validity period of the resource token returned by the operation.

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

Connector always streams the request content.

  • NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Db Id

String

User-generated name or ID of the database in which the stored procedure is replaced.

x

Coll Id

String

Name of the collection in which the stored procedure is replaced.

x

Sproc Id

String

ID of the stored procedure to replace.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

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.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

  • AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

Connector always streams the request content.

  • NEVER

Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

HTTP Response Attributes

For Configurations

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.

Field Type Description Default Value Required

Host

String

Hostname or IP address of the proxy server.

x

Port

Number

Port of the proxy server.

x

Username

String

Username to authenticate against the proxy server.

Password

String

Password to authenticate against the proxy server.

Non Proxy Hosts

String

Comma-separated list of hosts that the proxy must not be used against.

Default Header

Headers automatically added to every outbound request.

Field Type Description Default Value Required

Key

String

Key for this type.

x

Value

String

Value for this type.

x

Default Query Param

Query parameters automatically added to every outbound request.

Field Type Description Default Value Required

Key

String

Key for this type.

x

Value

String

Value for this type.

x

TLS

Configures TLS to provide secure communications for the Mule app.

Field Type Description Default Value Required

Enabled Protocols

String

Comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

Comma-separated list of cipher suites enabled for this context.

Trust Store

Truststore

Configures the TLS truststore.

Key Store

Keystore

Configures the TLS keystore.

Revocation Check

Configures a revocation checking mechanism.

Truststore

Configures the truststore for TLS.

Field Type Description Default Value Required

Path

String

Path to the truststore. Mule resolves the path relative to the current classpath and file system.

Password

String

Password used to protect the truststore.

Type

String

Type of truststore.

Algorithm

String

Encryption algorithm that the truststore uses.

Insecure

Boolean

If true, Mule stops performing certificate validations. Setting this to true can make connections vulnerable to attacks.

Keystore

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

Field Type Description Default Value Required

Path

String

Path to the keystore. Mule resolves the path relative to the current classpath and file system.

Type

String

Type of keystore.

Alias

String

Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file.

Key Password

String

Password used to protect the private key.

Password

String

Password used to protect the keystore.

Algorithm

String

Encryption algorithm that the keystore uses.

Standard Revocation Check

Configures standard revocation checks for TLS certificates.

Field Type Description Default Value Required

Only End Entities

Boolean

Which elements to verify in the certificate chain:

  • true

    Verify only the last element in the certificate chain.

  • false

    Verify all elements in the certificate chain.

Prefer Crls

Boolean

How to check certificate validity:

  • true

    Check the Certification Revocation List (CRL) for certificate validity.

  • false

    Use the Online Certificate Status Protocol (OCSP) to check certificate validity.

No Fallback

Boolean

Whether to use the secondary method to check certificate validity:

  • true

    Use the method that wasn’t specified in the Prefer Crls field (the secondary method) to check certificate validity.

  • false

    Do not use the secondary method to check certificate validity.

Soft Fail

Boolean

What to do if the revocation server can’t be reached or is busy:

  • true

    Avoid verification failure.

  • false

    Allow the verification to fail.

Custom OCSP Responder

Configures a custom OCSP responder for certification revocation checks.

Field Type Description Default Value Required

Url

String

URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response. If specified, the alias must be in the truststore.

CRL File

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

Field Type Description Default Value Required

Path

String

Path to the CRL file.

Reconnection

Configures a reconnection strategy for an operation.

Field Type Description Default Value Required

Fails Deployment

Boolean

What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy:

  • true

    Allow the deployment to fail.

  • false

    Ignore the results of the connectivity test.

Reconnection Strategy

Reconnection strategy to use.

Reconnect

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

Field Type Description Default Value Required

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

Count

Number

How many reconnection attempts the Mule app can make.

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.

Field Type Description Default Value Required

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

Expiration Policy

Configures an expiration policy strategy.

Field Type Description Default Value Required

Max Idle Time

Number

Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Max Idle Time field.

HTTP Response Attributes

Configures HTTP response attributes for the configuration.

Field Type Description Default Value Required

Status Code

Number

HTTP status code of the response.

x

Headers

Object

Map of HTTP headers in the message.

x

Reason Phrase

String

HTTP reason phrase of the response.

x

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.

Field Type Description Default Value Required

Initial Buffer Size

Number

Initial amount of memory to allocate to the data stream. If the streamed data exceeds this value, the buffer expands by Buffer Size Increment, with an upper limit of Max In Memory Size value.

Buffer Size Increment

Number

Amount by which the buffer size expands if it exceeds its initial size. Setting a value of 0 or lower specifies that the buffer can’t expand.

Max Buffer Size

Number

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.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the Initial Buffer Size, Buffer Size Increment, and Buffer Unit fields.

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.

Field Type Description Default Value Required

In Memory Size

Number

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:

  • 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.

  • Configure a smaller buffer size to decrease memory load at the expense of response time.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the In Memory Size field.

Repeatable In Memory Iterable

Field Type Description Default Value Required

Initial Buffer Size

Number

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 Buffer Size Increment attribute, with an upper limit of Max In Memory Size. The default value is 100 instances.

Buffer Size Increment

Number

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.

Max Buffer Size

Number

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.

Repeatable File Store Iterable

Field Type Description Default Value Required

In Memory Objects

Number

The maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the In Memory Size field.

See Also

Back to top
View on GitHub