Skip to content

Azure Cosmos Db

Node: azureCosmosDb · Full type: n8n-nodes-base.azureCosmosDb · Version: 1

Credentials

microsoftAzureCosmosDbSharedKeyApi (alias: @microsoft)

CREDENTIAL @microsoft = microsoftAzureCosmosDbSharedKeyApi "My Azure Cosmos Db"

Operations

Resource: container

create

Parameter Type Default Details
containerCreate string "" required
partitionKey json "{
"paths": [
"/id"
],
"kind": "H..." required
additionalFields collection {} keys: indexingPolicy, maxThroughput, offerThroughput

delete

Parameter Type Default Details
container resourceLocator {...} required; modes: list, id

get

Parameter Type Default Details
container resourceLocator {...} required; modes: list, id
simple boolean true

getAll

Parameter Type Default Details
returnAll boolean false
limit number 50
simple boolean true

Resource: item

create

Parameter Type Default Details
container resourceLocator {...} required; modes: list, id
customProperties json "{
"id": "replace_with_new_document_i..." required

delete

Parameter Type Default Details
container resourceLocator {...} required; modes: list, id
item resourceLocator {...} required; modes: list, id
additionalFields collection {} keys: partitionKey

get

Parameter Type Default Details
container resourceLocator {...} required; modes: list, id
item resourceLocator {...} required; modes: list, id
simple boolean true
additionalFields collection {} keys: partitionKey

getAll

Parameter Type Default Details
container resourceLocator {...} required; modes: list, id
returnAll boolean false
limit number 50
simple boolean true

query

Parameter Type Default Details
container resourceLocator {...} required; modes: list, id
query string "" required
simple boolean true
options fixedCollection {} groups: queryOptions

update

Parameter Type Default Details
container resourceLocator {...} required; modes: list, id
item resourceLocator {...} required; modes: list, id
customProperties json "{}" required
additionalFields collection {} keys: partitionKey

Common Parameters

Parameter Type Default Details
requestOptions collection {} keys: batching, allowUnauthorizedCerts, proxy, timeout

Parameter Details

additionalFields children:

Parameter Type Default Details
indexingPolicy json "{
"indexingMode": "consistent",
"au..."
maxThroughput number 1000
offerThroughput number 400

options children:

queryOptions group:

Parameter Type Default Details
queryParameters string ""

requestOptions children:

Parameter Type Default Details
batching fixedCollection {...} groups: batch
allowUnauthorizedCerts boolean false
proxy string ""
timeout number 10000

Example

NODE "azureCosmosDb" @microsoft AS "Azure Cosmos Db" {
  resource: "container",
  operation: "get",
  containerCreate: {{ $json.containerCreate }},
  partitionKey: "{
    "paths": [
        "/id"
    ],
    "kind": "Hash",
    "version": 2
}",
  customProperties: "{
    "id": "replace_with_new_document_id"
}"
}