Microsoft Azure · Schema

IndexingPolicy

The indexing policy for a container.

API ManagementCloudCloud ComputingEnterpriseInfrastructure as a ServicePlatform as a ServiceT1

Properties

Name Type Description
automatic boolean Whether indexing is automatic.
indexingMode string The indexing mode.
includedPaths array Paths to include in indexing.
excludedPaths array Paths to exclude from indexing.
compositeIndexes array Composite indexes for the container.
spatialIndexes array Spatial indexes for the container.
View JSON Schema on GitHub

JSON Schema

azure-cosmos-db-indexing-policy-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "IndexingPolicy",
  "type": "object",
  "description": "The indexing policy for a container.",
  "properties": {
    "automatic": {
      "type": "boolean",
      "description": "Whether indexing is automatic."
    },
    "indexingMode": {
      "type": "string",
      "description": "The indexing mode."
    },
    "includedPaths": {
      "type": "array",
      "description": "Paths to include in indexing."
    },
    "excludedPaths": {
      "type": "array",
      "description": "Paths to exclude from indexing."
    },
    "compositeIndexes": {
      "type": "array",
      "description": "Composite indexes for the container."
    },
    "spatialIndexes": {
      "type": "array",
      "description": "Spatial indexes for the container."
    }
  }
}