DataFlowDebugCommandRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-azure-data-factory/json-schema/microsoft-azure-data-factory-data-flow-debug-command-request-schema.json",
  "title": "DataFlowDebugCommandRequest",
  "description": "Request body structure for data flow debug command.",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/microsoft-azure-data-factory-dataflowdebugsession-api-openapi.yml#/components/schemas/DataFlowDebugCommandRequest",
  "type": "object",
  "properties": {
    "sessionId": {
      "type": "string",
      "description": "The ID of data flow debug session."
    },
    "command": {
      "$ref": "#/$defs/DataFlowDebugCommandType",
      "description": "The command type."
    },
    "commandPayload": {
      "$ref": "#/$defs/DataFlowDebugCommandPayload",
      "description": "The command payload object."
    }
  },
  "$defs": {
    "DataFlowDebugCommandPayload": {
      "type": "object",
      "description": "Structure of command payload.",
      "properties": {
        "streamName": {
          "type": "string",
          "description": "The stream name which is used for preview."
        },
        "rowLimits": {
          "type": "integer",
          "format": "int32",
          "description": "Row limits for preview response."
        },
        "columns": {
          "type": "array",
          "description": "Array of column names.",
          "items": {
            "type": "string"
          }
        },
        "expression": {
          "type": "string",
          "description": "The expression which is used for preview."
        }
      },
      "required": [
        "streamName"
      ]
    },
    "DataFlowDebugCommandType": {
      "type": "string",
      "description": "The command type.",
      "enum": [
        "executePreviewQuery",
        "executeStatisticsQuery",
        "executeExpressionQuery"
      ],
      "x-ms-enum": {
        "name": "DataFlowDebugCommandType",
        "modelAsString": true,
        "values": [
          {
            "name": "executePreviewQuery",
            "value": "executePreviewQuery",
            "description": "executePreviewQuery"
          },
          {
            "name": "executeStatisticsQuery",
            "value": "executeStatisticsQuery",
            "description": "executeStatisticsQuery"
          },
          {
            "name": "executeExpressionQuery",
            "value": "executeExpressionQuery",
            "description": "executeExpressionQuery"
          }
        ]
      }
    }
  }
}