mirror of
https://github.com/microsoft/fabric-rest-api-specs.git
synced 2026-11-04 12:04:23 +00:00
862 lines
31 KiB
JSON
862 lines
31 KiB
JSON
{
|
|
"swagger": "2.0",
|
|
"info": {
|
|
"title": "Dataflow data types",
|
|
"version": "v1"
|
|
},
|
|
"paths": {},
|
|
"definitions": {
|
|
"Dataflow": {
|
|
"description": "A Dataflow object.",
|
|
"type": "object",
|
|
"required": [ "type" ],
|
|
"allOf": [
|
|
{
|
|
"$ref": "../common/definitions.json#/definitions/Item"
|
|
}
|
|
]
|
|
},
|
|
"Dataflows": {
|
|
"description": "A list of Dataflows.",
|
|
"required": [ "value" ],
|
|
"type": "object",
|
|
"properties": {
|
|
"value": {
|
|
"description": "A list of Dataflows.",
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/Dataflow"
|
|
}
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
|
|
}
|
|
]
|
|
},
|
|
"CreateDataflowRequest": {
|
|
"description": "Create Dataflow request payload.",
|
|
"required": [ "displayName" ],
|
|
"properties": {
|
|
"displayName": {
|
|
"description": "The Dataflow display name. The display name must follow naming rules according to item type.",
|
|
"type": "string",
|
|
"readOnly": false
|
|
},
|
|
"description": {
|
|
"description": "The Dataflow description. Maximum length is 256 characters.",
|
|
"type": "string",
|
|
"readOnly": false
|
|
},
|
|
"folderId": {
|
|
"description": "The folder ID. If not specified or null, the Dataflow is created with the workspace as its folder.",
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"readOnly": false
|
|
},
|
|
"definition": {
|
|
"description": "The Dataflow public definition.",
|
|
"$ref": "#/definitions/DataflowDefinition",
|
|
"readOnly": false
|
|
},
|
|
"sensitivityLabelSettings": {
|
|
"description": "The sensitivity label settings for the Dataflow.",
|
|
"$ref": "../common/definitions.json#/definitions/SensitivityLabelSettings",
|
|
"readOnly": false
|
|
}
|
|
}
|
|
},
|
|
"UpdateDataflowDefinitionRequest": {
|
|
"description": "Update Dataflow public definition request payload.",
|
|
"required": [ "definition" ],
|
|
"properties": {
|
|
"definition": {
|
|
"$ref": "#/definitions/DataflowDefinition"
|
|
}
|
|
}
|
|
},
|
|
"DataflowDefinitionResponse": {
|
|
"description": "Dataflow public definition response.",
|
|
"required": [ "definition" ],
|
|
"properties": {
|
|
"definition": {
|
|
"$ref": "#/definitions/DataflowDefinition",
|
|
"readOnly": true
|
|
}
|
|
}
|
|
},
|
|
"DataflowDefinition": {
|
|
"description": "Dataflow public definition object. Refer to this [article](/rest/api/fabric/articles/item-management/definitions/dataflow-definition) for more details on the structure of the Dataflow definition.",
|
|
"type": "object",
|
|
"required": [ "parts" ],
|
|
"properties": {
|
|
"format": {
|
|
"description": "The format of the data flow definition.",
|
|
"type": "string",
|
|
"readOnly": false
|
|
},
|
|
"parts": {
|
|
"description": "A list of definition parts.",
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/DataflowDefinitionPart"
|
|
},
|
|
"readOnly": false
|
|
}
|
|
}
|
|
},
|
|
"DataflowDefinitionPart": {
|
|
"description": "Dataflow definition part object.",
|
|
"type": "object",
|
|
"properties": {
|
|
"path": {
|
|
"description": "The Dataflow public definition part path.",
|
|
"type": "string",
|
|
"readOnly": false
|
|
},
|
|
"payload": {
|
|
"description": "The Dataflow public definition part payload.",
|
|
"type": "string",
|
|
"readOnly": false
|
|
},
|
|
"payloadType": {
|
|
"description": "The payload type.",
|
|
"$ref": "../common/definitions.json#/definitions/PayloadType",
|
|
"readOnly": false
|
|
}
|
|
}
|
|
},
|
|
"UpdateDataflowRequest": {
|
|
"description": "Update Dataflow request.",
|
|
"properties": {
|
|
"displayName": {
|
|
"description": "The Dataflow display name. The display name must follow naming rules according to item type.",
|
|
"type": "string",
|
|
"readOnly": false
|
|
},
|
|
"description": {
|
|
"description": "The Dataflow description. Maximum length is 256 characters.",
|
|
"type": "string",
|
|
"readOnly": false
|
|
}
|
|
}
|
|
},
|
|
"DataflowSchedule": {
|
|
"description": "Dataflow schedule.",
|
|
"type": "object",
|
|
"required": [ "id", "enabled" ],
|
|
"allOf": [
|
|
{
|
|
"$ref": "../platform/definitions/platform.json#/definitions/ItemSchedule"
|
|
}
|
|
]
|
|
},
|
|
"CreateDataflowExecuteScheduleRequest": {
|
|
"description": "Create dataflow execute schedule plan request payload.",
|
|
"type": "object",
|
|
"allOf": [
|
|
{
|
|
"$ref": "../platform/definitions/platform.json#/definitions/CreateScheduleRequest"
|
|
}
|
|
]
|
|
},
|
|
"CreateDataflowApplyChangesScheduleRequest": {
|
|
"description": "Create dataflow apply changes schedule plan request payload.",
|
|
"type": "object",
|
|
"allOf": [
|
|
{
|
|
"$ref": "../platform/definitions/platform.json#/definitions/CreateScheduleRequest"
|
|
}
|
|
]
|
|
},
|
|
"RunOnDemandDataflowExecuteJobRequest": {
|
|
"description": "Run on demand execute dataflow job instance payload",
|
|
"type": "object",
|
|
"properties": {
|
|
"executionData": {
|
|
"description": "Payload for run on-demand execute job request. Needed only if the dataflow has parameterization enabled.",
|
|
"$ref": "#/definitions/DataflowExecutionPayload"
|
|
}
|
|
}
|
|
},
|
|
"DataflowExecutionPayload": {
|
|
"description": "The execution data payload for Dataflow",
|
|
"type": "object",
|
|
"properties": {
|
|
"executeOption": {
|
|
"description": "Options to run the execute operation. Additional executeOptions may be added over time.",
|
|
"type": "string",
|
|
"enum": [ "SkipApplyChanges", "ApplyChangesIfNeeded" ],
|
|
"x-ms-enum": {
|
|
"name": "ExecuteOption",
|
|
"modelAsString": true,
|
|
"values": [
|
|
{
|
|
"value": "SkipApplyChanges",
|
|
"description": "Default Value. Apply Changes operation is skipped."
|
|
},
|
|
{
|
|
"value": "ApplyChangesIfNeeded",
|
|
"description": "Appply Changes operation is done if needed. Can be used when the latest changes are required for Execute."
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"parameters": {
|
|
"description": "A list of parameters to override during execution.",
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/ItemJobParameter"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"ItemJobParameter": {
|
|
"description": "Parameter details.",
|
|
"type": "object",
|
|
"required": [
|
|
"parameterName",
|
|
"type",
|
|
"value"
|
|
],
|
|
"properties": {
|
|
"parameterName": {
|
|
"description": "Name of the parameter.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "The parameter type. Additional parameter types may be added over time.",
|
|
"type": "string",
|
|
"enum": [ "Automatic" ],
|
|
"x-ms-enum": {
|
|
"name": "Type",
|
|
"modelAsString": true,
|
|
"values": [
|
|
{
|
|
"value": "Automatic",
|
|
"description": "Value must be Automatic"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"value": {
|
|
"description": "The value of the parameter to override during execution.",
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"ExecuteQueryRequest": {
|
|
"description": "Request payload for executing a query against a dataflow.",
|
|
"type": "object",
|
|
"required": [ "queryName" ],
|
|
"properties": {
|
|
"queryName": {
|
|
"description": "The name of the query to execute from the dataflow (or from the custom mashup document if provided).",
|
|
"type": "string",
|
|
"example": "MyTable"
|
|
},
|
|
"customMashupDocument": {
|
|
"description": "Optional custom mashup document to override the dataflow's default mashup.",
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"DataflowParameters": {
|
|
"description": "A list of Dataflow parameters.",
|
|
"type": "object",
|
|
"required": [ "value" ],
|
|
"properties": {
|
|
"value": {
|
|
"description": "A list of parameters defined in the Dataflow.",
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/DataflowParameter"
|
|
}
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
|
|
}
|
|
]
|
|
},
|
|
"DataflowParameter": {
|
|
"description": "Base type for a Dataflow parameter that contains the corresponding properties for all parameters.",
|
|
"type": "object",
|
|
"discriminator": "type",
|
|
"required": [ "name", "type", "isRequired", "description" ],
|
|
"properties": {
|
|
"name": {
|
|
"description": "The name of the parameter.",
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"description": "A description of the parameter.",
|
|
"type": "string"
|
|
},
|
|
"isRequired": {
|
|
"description": "Indicates whether the parameter is required.",
|
|
"type": "boolean"
|
|
},
|
|
"type": {
|
|
"description": "The type of the parameter. Additional type types may be added over time.",
|
|
"type": "string",
|
|
"enum": [ "String", "Boolean", "Integer", "Number", "DateTime", "DateTimeZone", "Date", "Time", "Duration" ],
|
|
"x-ms-enum": {
|
|
"name": "ParameterType",
|
|
"modelAsString": true,
|
|
"values": [
|
|
{
|
|
"value": "String",
|
|
"description": "The parameter value is of type string."
|
|
},
|
|
{
|
|
"value": "Boolean",
|
|
"description": "The parameter value is of type boolean."
|
|
},
|
|
{
|
|
"value": "Integer",
|
|
"description": "The parameter value is of type long."
|
|
},
|
|
{
|
|
"value": "Number",
|
|
"description": "The parameter value is of type double."
|
|
},
|
|
{
|
|
"value": "DateTime",
|
|
"description": "The parameter value is of type DateTime. The time is in UTC, using the YYYY-MM-DDTHH:mm:ssZ format."
|
|
},
|
|
{
|
|
"value": "DateTimeZone",
|
|
"description": "The parameter value is of type DateTimeZone. String in the format `yyyy-MM-ddTHH:mm:sszzz`."
|
|
},
|
|
{
|
|
"value": "Date",
|
|
"description": "The parameter value is of type Date. String in the format `yyyy-MM-dd`."
|
|
},
|
|
{
|
|
"value": "Time",
|
|
"description": "The parameter value is of type Time. String in the format `HH:mm:ss`."
|
|
},
|
|
{
|
|
"value": "Duration",
|
|
"description": "The parameter value is of type Duration. String in the format `\\Pd\\DTH\\Hm\\Ms\\S`."
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"DataflowStringParameter": {
|
|
"type": "object",
|
|
"description": "A Dataflow parameter of type String.",
|
|
"required": [ "defaultValue" ],
|
|
"properties": {
|
|
"defaultValue": {
|
|
"description": "The value with which the parameter will be refreshed if none is provided when executing the dataflow .",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/DataflowParameter"
|
|
}
|
|
],
|
|
"x-ms-discriminator-value": "String"
|
|
},
|
|
"DataflowBooleanParameter": {
|
|
"type": "object",
|
|
"description": "A Dataflow parameter of type Boolean.",
|
|
"required": [ "defaultValue" ],
|
|
"properties": {
|
|
"defaultValue": {
|
|
"description": "The value with which the parameter will be refreshed if none is provided when executing the dataflow.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/DataflowParameter"
|
|
}
|
|
],
|
|
"x-ms-discriminator-value": "Boolean"
|
|
},
|
|
"DataflowIntegerParameter": {
|
|
"type": "object",
|
|
"description": "A Dataflow parameter of type Long.",
|
|
"required": [ "defaultValue" ],
|
|
"properties": {
|
|
"defaultValue": {
|
|
"description": "The value with which the parameter will be refreshed if none is provided when executing the dataflow.",
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/DataflowParameter"
|
|
}
|
|
],
|
|
"x-ms-discriminator-value": "Integer"
|
|
},
|
|
"DataflowNumberParameter": {
|
|
"type": "object",
|
|
"description": "A Dataflow parameter of type double.",
|
|
"required": [ "defaultValue" ],
|
|
"properties": {
|
|
"defaultValue": {
|
|
"description": "The value with which the parameter will be refreshed if none is provided when executing the dataflow.",
|
|
"type": "number",
|
|
"format": "double"
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/DataflowParameter"
|
|
}
|
|
],
|
|
"x-ms-discriminator-value": "Number"
|
|
},
|
|
"DataflowDateTimeParameter": {
|
|
"type": "object",
|
|
"description": "A Dataflow parameter of type DateTime. String in the format `yyyy-MM-ddTHH:mm:ss.xxxZ` (Example: `2025-09-15T21:45:00.000Z`).",
|
|
"required": [ "defaultValue" ],
|
|
"properties": {
|
|
"defaultValue": {
|
|
"description": "The value with which the parameter will be refreshed if none is provided when executing the dataflow.",
|
|
"type": "string",
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/DataflowParameter"
|
|
}
|
|
],
|
|
"x-ms-discriminator-value": "DateTime"
|
|
},
|
|
"DataflowDateTimeZoneParameter": {
|
|
"type": "object",
|
|
"description": "A Dataflow parameter of type DateTimeZone. String in the format `yyyy-MM-ddTHH:mm:sszzz` (Example: `2025-09-15T21:45:00+02:00`). Use \"Automatic\" type to override this type of parameter when executing the dataflow.",
|
|
"required": [ "defaultValue" ],
|
|
"properties": {
|
|
"defaultValue": {
|
|
"description": "The value with which the parameter will be refreshed if none is provided when executing the dataflow.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/DataflowParameter"
|
|
}
|
|
],
|
|
"x-ms-discriminator-value": "DateTimeZone"
|
|
},
|
|
"DataflowDateParameter": {
|
|
"type": "object",
|
|
"description": "A Dataflow parameter of type Date. String in the format `yyyy-MM-dd` (Example: `2025-09-15` for the date Sep 15, 2025). Use \"Automatic\" type to override this type of parameter when executing the dataflow.",
|
|
"required": [ "defaultValue" ],
|
|
"properties": {
|
|
"defaultValue": {
|
|
"description": "The value with which the parameter will be refreshed if none is provided when executing the dataflow.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/DataflowParameter"
|
|
}
|
|
],
|
|
"x-ms-discriminator-value": "Date"
|
|
},
|
|
"DataflowTimeParameter": {
|
|
"type": "object",
|
|
"description": "A Dataflow parameter of type Time. String in the format `HH:mm:ss` (Example: `21:45:00` for 9:45 PM). Use \"Automatic\" type to override this type of parameter when executing the dataflow.",
|
|
"required": [ "defaultValue" ],
|
|
"properties": {
|
|
"defaultValue": {
|
|
"description": "The value with which the parameter will be refreshed if none is provided when executing the dataflow.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/DataflowParameter"
|
|
}
|
|
],
|
|
"x-ms-discriminator-value": "Time"
|
|
},
|
|
"DataflowDurationParameter": {
|
|
"type": "object",
|
|
"description": "A Dataflow parameter of type Duration. String in the format `\\Pd\\DTH\\Hm\\Ms\\S` (Example: `P5DT14H35M30S` for 5 days, 14 hours, 35 minutes and 30 seconds). Use \"Automatic\" type to override this type of parameter when executing the dataflow.",
|
|
"required": [ "defaultValue" ],
|
|
"properties": {
|
|
"defaultValue": {
|
|
"description": "The value with which the parameter will be refreshed if none is provided when executing the dataflow.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/DataflowParameter"
|
|
|
|
}
|
|
],
|
|
"x-ms-discriminator-value": "Duration"
|
|
},
|
|
"DataflowUpgradeReadinessList": {
|
|
"description": "A paginated list of Gen1 dataflow upgrade readiness results.",
|
|
"type": "object",
|
|
"required": [ "value" ],
|
|
"properties": {
|
|
"value": {
|
|
"description": "The Gen1 dataflow upgrade readiness results.",
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/DataflowUpgradeReadiness"
|
|
},
|
|
"readOnly": true
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
|
|
}
|
|
]
|
|
},
|
|
"DataflowUpgradeReadiness": {
|
|
"description": "The upgrade readiness assessment for a Gen1 dataflow.",
|
|
"type": "object",
|
|
"required": [ "id", "displayName", "status" ],
|
|
"properties": {
|
|
"id": {
|
|
"description": "The identifier of the assessed Gen1 dataflow.",
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"readOnly": true
|
|
},
|
|
"displayName": {
|
|
"description": "The display name of the Gen1 dataflow.",
|
|
"type": "string",
|
|
"readOnly": true
|
|
},
|
|
"status": {
|
|
"description": "The overall readiness verdict for the dataflow. The value is the highest severity among the reasons in this order: `UpgradeUnavailable`, `NeedsAttention`, and `ReadyToMigrate`. `Unknown` is not an aggregation outcome and means the readiness assessment could not be completed.",
|
|
"$ref": "#/definitions/DataflowUpgradeReadinessStatus",
|
|
"readOnly": true
|
|
},
|
|
"reasons": {
|
|
"description": "The reasons behind the readiness verdict. This property is omitted when the status is `ReadyToMigrate` and is always present when the status is `Unknown`.",
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/DataflowUpgradeReadinessReason"
|
|
},
|
|
"readOnly": true
|
|
}
|
|
}
|
|
},
|
|
"DataflowUpgradeReadinessReason": {
|
|
"description": "A reason contributing to a Gen1 dataflow upgrade readiness verdict.",
|
|
"type": "object",
|
|
"required": [ "status", "code", "message" ],
|
|
"properties": {
|
|
"status": {
|
|
"description": "The readiness severity contributed by this reason.",
|
|
"$ref": "#/definitions/DataflowUpgradeReadinessStatus",
|
|
"readOnly": true
|
|
},
|
|
"code": {
|
|
"description": "The stable code identifying the readiness reason.",
|
|
"$ref": "#/definitions/DataflowUpgradeReasonCode",
|
|
"readOnly": true
|
|
},
|
|
"message": {
|
|
"description": "The human-readable message accompanying the reason code.",
|
|
"type": "string",
|
|
"readOnly": true
|
|
}
|
|
}
|
|
},
|
|
"DataflowUpgradeReadinessStatus": {
|
|
"description": "The Gen1 dataflow upgrade readiness status. Additional DataflowUpgradeReadinessStatus types may be added over time.",
|
|
"type": "string",
|
|
"enum": [ "Unknown", "ReadyToMigrate", "NeedsAttention", "UpgradeUnavailable" ],
|
|
"x-ms-enum": {
|
|
"name": "DataflowUpgradeReadinessStatus",
|
|
"modelAsString": true,
|
|
"values": [
|
|
{
|
|
"value": "Unknown",
|
|
"description": "The readiness assessment could not be completed and should be reported for investigation."
|
|
},
|
|
{
|
|
"value": "ReadyToMigrate",
|
|
"description": "The upgrade is expected to succeed without changes before or after the upgrade."
|
|
},
|
|
{
|
|
"value": "NeedsAttention",
|
|
"description": "The upgrade is expected to succeed, but follow-up changes may be needed or the upgrade may adjust the dataflow automatically."
|
|
},
|
|
{
|
|
"value": "UpgradeUnavailable",
|
|
"description": "The upgrade is expected to fail until the reported reasons are resolved."
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"DataflowUpgradeReasonCode": {
|
|
"description": "The reason for a Gen1 dataflow upgrade readiness result. Additional DataflowUpgradeReasonCode types may be added over time.",
|
|
"type": "string",
|
|
"enum": [ "MightBeAccessedByDirectQuery", "HasByolAsStorage", "HasIncrementalRefresh", "HasLinkedEntities", "IsReferencedByLinkedEntities", "ServiceThrottled", "HasUnsupportedNameCharacters", "DisplayNameAlreadyInUse", "ExceedsGen2QueryLimit", "HasUnresolvedConnections", "AssessmentUnavailable" ],
|
|
"x-ms-enum": {
|
|
"name": "DataflowUpgradeReasonCode",
|
|
"modelAsString": true,
|
|
"values": [
|
|
{
|
|
"value": "MightBeAccessedByDirectQuery",
|
|
"description": "The dataflow might be accessed through DirectQuery."
|
|
},
|
|
{
|
|
"value": "HasByolAsStorage",
|
|
"description": "The dataflow uses bring-your-own-lake storage."
|
|
},
|
|
{
|
|
"value": "HasIncrementalRefresh",
|
|
"description": "The dataflow uses incremental refresh."
|
|
},
|
|
{
|
|
"value": "HasLinkedEntities",
|
|
"description": "The dataflow has linked entities."
|
|
},
|
|
{
|
|
"value": "IsReferencedByLinkedEntities",
|
|
"description": "The dataflow is referenced by linked entities in other dataflows."
|
|
},
|
|
{
|
|
"value": "ServiceThrottled",
|
|
"description": "The readiness assessment was throttled and may succeed when retried later."
|
|
},
|
|
{
|
|
"value": "HasUnsupportedNameCharacters",
|
|
"description": "The display name contains characters that are unsupported by Dataflow Gen2 and are sanitized during the upgrade."
|
|
},
|
|
{
|
|
"value": "DisplayNameAlreadyInUse",
|
|
"description": "The sanitized display name is already in use and is prefixed during the upgrade."
|
|
},
|
|
{
|
|
"value": "ExceedsGen2QueryLimit",
|
|
"description": "The dataflow has more load-enabled queries than Dataflow Gen2 supports."
|
|
},
|
|
{
|
|
"value": "HasUnresolvedConnections",
|
|
"description": "One or more data source connections could not be resolved and must be recreated or rebound before the upgrade."
|
|
},
|
|
{
|
|
"value": "AssessmentUnavailable",
|
|
"description": "The readiness assessment could not run and should be reported for investigation."
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"UpgradeGen1DataflowsRequest": {
|
|
"description": "The request payload for upgrading Gen1 dataflows.",
|
|
"type": "object",
|
|
"required": [ "dataflows" ],
|
|
"properties": {
|
|
"dataflows": {
|
|
"description": "The Gen1 dataflows to upgrade in the specified workspace.",
|
|
"type": "array",
|
|
"minItems": 1,
|
|
"maxItems": 50,
|
|
"items": {
|
|
"$ref": "#/definitions/Gen1DataflowUpgradeTarget"
|
|
},
|
|
"readOnly": false
|
|
}
|
|
}
|
|
},
|
|
"Gen1DataflowUpgradeTarget": {
|
|
"description": "A Gen1 dataflow targeted for an in-place upgrade.",
|
|
"type": "object",
|
|
"required": [ "id" ],
|
|
"properties": {
|
|
"id": {
|
|
"description": "The identifier of the Gen1 dataflow to upgrade. The dataflow must belong to the specified workspace.",
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"readOnly": false
|
|
}
|
|
}
|
|
},
|
|
"DataflowUpgradeResult": {
|
|
"description": "The result of a Gen1 dataflow upgrade batch.",
|
|
"type": "object",
|
|
"required": [ "summary", "migrations" ],
|
|
"properties": {
|
|
"summary": {
|
|
"description": "The roll-up counts for the upgrade batch.",
|
|
"$ref": "#/definitions/DataflowUpgradeSummary",
|
|
"readOnly": true
|
|
},
|
|
"migrations": {
|
|
"description": "The migration result for each requested dataflow.",
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/DataflowMigration"
|
|
},
|
|
"readOnly": true
|
|
}
|
|
}
|
|
},
|
|
"DataflowUpgradeSummary": {
|
|
"description": "The roll-up counts for a Gen1 dataflow upgrade batch.",
|
|
"type": "object",
|
|
"required": [ "totalCount", "succeededCount", "failedCount" ],
|
|
"properties": {
|
|
"totalCount": {
|
|
"description": "The total number of dataflows in the request.",
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"readOnly": true
|
|
},
|
|
"succeededCount": {
|
|
"description": "The number of dataflows that were upgraded successfully.",
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"readOnly": true
|
|
},
|
|
"failedCount": {
|
|
"description": "The number of dataflows that failed to upgrade.",
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"readOnly": true
|
|
}
|
|
}
|
|
},
|
|
"DataflowMigration": {
|
|
"description": "The migration result for a Gen1 dataflow.",
|
|
"type": "object",
|
|
"required": [ "dataflowId", "dataflowName", "targetDataflowName", "workspaceId", "workspaceName", "assessmentStatus", "migrationStatus" ],
|
|
"properties": {
|
|
"dataflowId": {
|
|
"description": "The identifier of the dataflow, which is preserved by a successful in-place upgrade.",
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"readOnly": true
|
|
},
|
|
"dataflowName": {
|
|
"description": "The source Gen1 dataflow display name.",
|
|
"type": "string",
|
|
"readOnly": true
|
|
},
|
|
"targetDataflowName": {
|
|
"description": "The resulting Dataflow Gen2 display name, which may differ from the source display name.",
|
|
"type": "string",
|
|
"readOnly": true
|
|
},
|
|
"workspaceId": {
|
|
"description": "The identifier of the workspace containing the dataflow.",
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"readOnly": true
|
|
},
|
|
"workspaceName": {
|
|
"description": "The display name of the workspace containing the dataflow.",
|
|
"type": "string",
|
|
"readOnly": true
|
|
},
|
|
"assessmentStatus": {
|
|
"description": "The readiness verdict evaluated for the dataflow during the upgrade. This property does not report `UpgradeUnavailable`; a readiness result that predicts failure is reported as `NeedsAttention` because the migration status and migration error describe the actual outcome.",
|
|
"$ref": "#/definitions/DataflowUpgradeReadinessStatus",
|
|
"readOnly": true
|
|
},
|
|
"requiredActions": {
|
|
"description": "The changes required before the dataflow can be upgraded. This property is omitted when no changes are required.",
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/DataflowUpgradeRequiredAction"
|
|
},
|
|
"readOnly": true
|
|
},
|
|
"migrationStatus": {
|
|
"description": "The migration outcome for the dataflow.",
|
|
"$ref": "#/definitions/DataflowMigrationStatus",
|
|
"readOnly": true
|
|
},
|
|
"migrationEndDateTime": {
|
|
"description": "The time when the dataflow migration reached a terminal state. This property is omitted when the time is not available. When present, the value is in UTC, using the YYYY-MM-DDTHH:mm:ssZ format.",
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"readOnly": true
|
|
},
|
|
"migrationError": {
|
|
"description": "The failure detail for the dataflow migration. This property is present only when the migration status is `Failed`, and `isRetriable` is always included. The `requestId` contains the upgrade operation ID. The error code is one of `InsufficientPrivileges`, `DataflowNotFound`, `DataflowBusy`, `DataflowRequiresChanges`, `CapacityOrLicenseNotSupported`, or `UpgradeFailed`.",
|
|
"allOf": [
|
|
{
|
|
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
|
},
|
|
{
|
|
"type": "object",
|
|
"required": [ "isRetriable" ],
|
|
"properties": {
|
|
"isRetriable": {
|
|
"description": "Indicates whether the dataflow migration can be retried.",
|
|
"type": "boolean",
|
|
"readOnly": true
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"readOnly": true
|
|
}
|
|
}
|
|
},
|
|
"DataflowUpgradeRequiredAction": {
|
|
"description": "A change required before a Gen1 dataflow can be upgraded.",
|
|
"type": "object",
|
|
"required": [ "status", "code", "message" ],
|
|
"properties": {
|
|
"status": {
|
|
"description": "The readiness severity contributed by this required action.",
|
|
"$ref": "#/definitions/DataflowUpgradeReadinessStatus",
|
|
"readOnly": true
|
|
},
|
|
"code": {
|
|
"description": "The stable reason code identifying the required change.",
|
|
"$ref": "#/definitions/DataflowUpgradeReasonCode",
|
|
"readOnly": true
|
|
},
|
|
"message": {
|
|
"description": "The human-readable description of the required change.",
|
|
"type": "string",
|
|
"readOnly": true
|
|
}
|
|
}
|
|
},
|
|
"DataflowMigrationStatus": {
|
|
"description": "The outcome of a Gen1 dataflow migration. Additional DataflowMigrationStatus types may be added over time.",
|
|
"type": "string",
|
|
"enum": [ "Unknown", "Succeeded", "Failed" ],
|
|
"x-ms-enum": {
|
|
"name": "DataflowMigrationStatus",
|
|
"modelAsString": true,
|
|
"values": [
|
|
{
|
|
"value": "Unknown",
|
|
"description": "The migration outcome was not populated and indicates a service defect if returned."
|
|
},
|
|
{
|
|
"value": "Succeeded",
|
|
"description": "The dataflow was upgraded successfully."
|
|
},
|
|
{
|
|
"value": "Failed",
|
|
"description": "The dataflow failed to upgrade."
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
} |