DatasetVersion

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/azure-ai-foundry/json-schema/azure-ai-foundry-dataset-version-schema.json",
  "title": "DatasetVersion",
  "description": "DatasetVersion Definition",
  "x-generated": "2026-11-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_superseded/azure-ai-foundry-datasets-api-openapi.yml#/components/schemas/DatasetVersion",
  "type": "object",
  "properties": {
    "dataUri": {
      "type": "string",
      "description": "URI of the data ([example](https://go.microsoft.com/fwlink/?linkid=2202330))",
      "minLength": 1,
      "pattern": "[a-zA-Z0-9_]",
      "x-ms-mutability": [
        "read",
        "create"
      ]
    },
    "type": {
      "$ref": "#/$defs/DatasetType",
      "description": "Dataset type"
    },
    "isReference": {
      "type": "boolean",
      "description": "Indicates if the dataset holds a reference to the storage, or the dataset manages storage itself. If true, the underlying data will not be deleted when the dataset version is deleted",
      "readOnly": true
    },
    "connectionName": {
      "type": "string",
      "description": "The Azure Storage Account connection name. Required if startPendingUploadVersion was not called before creating the Dataset",
      "x-ms-mutability": [
        "read",
        "create"
      ]
    },
    "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": [
    "dataUri",
    "type",
    "name",
    "version"
  ],
  "$defs": {
    "DatasetType": {
      "type": "string",
      "description": "Enum to determine the type of data.",
      "enum": [
        "uri_file",
        "uri_folder"
      ],
      "x-ms-enum": {
        "name": "DatasetType",
        "modelAsString": true,
        "values": [
          {
            "name": "uri_file",
            "value": "uri_file",
            "description": "URI file."
          },
          {
            "name": "uri_folder",
            "value": "uri_folder",
            "description": "URI folder."
          }
        ]
      }
    }
  }
}