Index

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/azure-ai-foundry/json-schema/azure-ai-foundry-index-schema.json",
  "title": "Index",
  "description": "Index resource Definition",
  "x-generated": "2026-11-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_superseded/azure-ai-foundry-indexes-api-openapi.yml#/components/schemas/Index",
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/$defs/IndexType",
      "description": "Type of index"
    },
    "id": {
      "type": "string",
      "description": "Asset ID, a unique identifier for the asset",
      "readOnly": true
    },
    "name": {
      "type": "string",
      "description": "The name of the resource",
      "readOnly": true
    },
    "version": {
      "type": "string",
      "description": "The version of the resource",
      "readOnly": true
    },
    "description": {
      "type": "string",
      "description": "The asset description text.",
      "x-ms-mutability": [
        "update",
        "create"
      ]
    },
    "tags": {
      "type": "object",
      "description": "Tag dictionary. Tags can be added, removed, and updated.",
      "additionalProperties": {
        "type": "string"
      },
      "x-ms-mutability": [
        "update",
        "create"
      ]
    }
  },
  "required": [
    "type",
    "name",
    "version"
  ],
  "$defs": {
    "IndexType": {
      "type": "string",
      "enum": [
        "AzureSearch",
        "CosmosDBNoSqlVectorStore",
        "ManagedAzureSearch"
      ],
      "x-ms-enum": {
        "name": "IndexType",
        "modelAsString": true,
        "values": [
          {
            "name": "azureSearch",
            "value": "AzureSearch",
            "description": "Azure search"
          },
          {
            "name": "cosmosDB",
            "value": "CosmosDBNoSqlVectorStore",
            "description": "CosmosDB"
          },
          {
            "name": "managedAzureSearch",
            "value": "ManagedAzureSearch",
            "description": "Managed Azure Search"
          }
        ]
      }
    }
  }
}