Container

A Cosmos DB container (collection) resource.

API ManagementCloudCloud ComputingEnterpriseInfrastructure as a ServicePlatform as a ServiceT1

Properties

Name	Type	Description
id	string	The unique name that identifies the container.
indexingPolicy	object
partitionKey	object
uniqueKeyPolicy	object
conflictResolutionPolicy	object
defaultTtl	integer	Default time-to-live in seconds. -1 means items never expire.
_rid	string	System-generated resource ID.
_ts	integer	System-generated timestamp.
_self	string	System-generated URI for the resource.
_etag	string	System-generated resource etag.
_docs	string	Addressable path for the documents resource.
_sprocs	string	Addressable path for the stored procedures resource.
_triggers	string	Addressable path for the triggers resource.
_udfs	string	Addressable path for the user-defined functions resource.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Container",
  "title": "Container",
  "type": "object",
  "description": "A Cosmos DB container (collection) resource.",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique name that identifies the container.",
      "example": "abc123"
    },
    "indexingPolicy": {
      "$ref": "#/components/schemas/IndexingPolicy"
    },
    "partitionKey": {
      "$ref": "#/components/schemas/PartitionKeyDefinition"
    },
    "uniqueKeyPolicy": {
      "$ref": "#/components/schemas/UniqueKeyPolicy"
    },
    "conflictResolutionPolicy": {
      "$ref": "#/components/schemas/ConflictResolutionPolicy"
    },
    "defaultTtl": {
      "type": "integer",
      "description": "Default time-to-live in seconds. -1 means items never expire.",
      "example": 10
    },
    "_rid": {
      "type": "string",
      "readOnly": true,
      "description": "System-generated resource ID.",
      "example": "500123"
    },
    "_ts": {
      "type": "integer",
      "readOnly": true,
      "description": "System-generated timestamp.",
      "example": 10
    },
    "_self": {
      "type": "string",
      "readOnly": true,
      "description": "System-generated URI for the resource.",
      "example": "example_value"
    },
    "_etag": {
      "type": "string",
      "readOnly": true,
      "description": "System-generated resource etag.",
      "example": "example_value"
    },
    "_docs": {
      "type": "string",
      "readOnly": true,
      "description": "Addressable path for the documents resource.",
      "example": "example_value"
    },
    "_sprocs": {
      "type": "string",
      "readOnly": true,
      "description": "Addressable path for the stored procedures resource.",
      "example": "example_value"
    },
    "_triggers": {
      "type": "string",
      "readOnly": true,
      "description": "Addressable path for the triggers resource.",
      "example": "example_value"
    },
    "_udfs": {
      "type": "string",
      "readOnly": true,
      "description": "Addressable path for the user-defined functions resource.",
      "example": "example_value"
    }
  },
  "required": [
    "id",
    "partitionKey"
  ]
}