fabric-rest-api-specs/warehouse/definitions.json

{
  "swagger": "2.0",
  "info": {
    "version": "v1",
    "title": "Warehouse data types"
  },
  "paths": {},
  "definitions": {
    "Warehouses": {
      "description": "A list of warehouses.",
      "required": ["value"],
      "type": "object",
      "properties": {
        "value": {
          "description": "A list of warehouses.",
          "type": "array",
          "items": {
            "$ref": "#/definitions/Warehouse"
          }
        }
      },
      "allOf": [
        {
          "$ref": "../common/definitions.json#/definitions/PaginatedResponse"
        }
      ]
    },
    "Warehouse": {
      "description": "A warehouse object.",
      "type": "object",
      "required": ["type"],
      "allOf": [
        {
            "$ref": "../common/definitions.json#/definitions/Item"
        }
      ],
      "properties": {
          "properties": {
              "description": "The warehouse properties.",
              "$ref": "#/definitions/WarehouseProperties"
          }
      }
    },
    "WarehouseProperties": {
      "description": "The warehouse item properties.",
      "type": "object",
      "required": ["connectionString", "createdDate", "lastUpdatedTime"],
      "properties": {
        "connectionString": {
          "description": "The SQL connection string connected to the workspace containing this warehouse.",
          "type": "string"
        },
        "createdDate": {
          "description": "The date and time the warehouse was created.",
          "type": "string",
          "format": "date-time"
        },
        "lastUpdatedTime": {
          "description": "The date and time the warehouse was last updated",
          "type": "string",
          "format": "date-time"
        },
        "collationType": {
          "description": "The collation type of the warehouse.",
          "$ref": "#/definitions/CollationType"
        }
      }
    },
    "CollationType": {
      "type": "string",
        "description": "Warehouse collation. Additional `collations` may be added over time.",
        "enum": ["Latin1_General_100_BIN2_UTF8", "Latin1_General_100_CI_AS_KS_WS_SC_UTF8"],
        "x-ms-enum": {
          "name": "CollationType",
          "modelAsString": true,
          "values": [
            {
                "value": "Latin1_General_100_BIN2_UTF8",
                "description": "The default - case-sensitive (CS) collation"
            },
            {
                "value": "Latin1_General_100_CI_AS_KS_WS_SC_UTF8",
                "description": "case-insensitive (CI) collation"
            }
          ]
        }
    },
    "CreateWarehouseRequest": {
      "description": "Create warehouse request payload.",
      "required": ["displayName"],
      "properties": {
        "displayName": {
          "description": "The warehouse display name. The display name must follow naming rules according to item type.",
          "type": "string",
          "readOnly": false
        },
        "description": {
          "description": "The warehouse description. Maximum length is 256 characters.",
          "type": "string",
          "readOnly": false
        },
        "folderId": {
          "description": "The folder ID. If not specified or null, the warehouse is created with the workspace as its folder.",
          "type": "string",
          "format": "uuid",
          "readOnly": false
        },
        "creationPayload": {
            "description": "The warehouse creation payload. You cannot use `definition` and `creationPayload` at the same time.",
            "$ref": "#/definitions/WarehouseCreationPayload",
            "readOnly": false
        },
        "definition": {
            "description": "The warehouse definition. You cannot use `definition` and `creationPayload` at the same time.",
            "$ref": "#/definitions/WarehouseDefinition",
            "readOnly": false
        },
        "sensitivityLabelSettings": {
            "description": "The sensitivity label settings for the warehouse.",
            "$ref": "../common/definitions.json#/definitions/SensitivityLabelSettings",
            "readOnly": false
        }
      }
    },
    "WarehouseCreationPayload": {
      "description": "Warehouse item payload",
      "type": "object",
      "required": [
        "collationType"
      ],
      "properties": {
        "collationType": {
          "description": "The default collation type of the warehouse.",
          "$ref": "#/definitions/CollationType"
        }
      }
    },
    "UpdateWarehouseDefinitionRequest": {
      "description": "Update warehouse public definition request payload.",
      "required": ["definition"],
      "properties": {
        "definition": {
          "$ref": "#/definitions/WarehouseDefinition"
        }
      }
    },
    "WarehouseDefinitionResponse": {
      "description": "The warehouse public definition response.",
      "required": ["definition"],
      "properties": {
        "definition": {
          "$ref": "#/definitions/WarehouseDefinition",
          "readOnly": true
        }
      }
    },
    "WarehouseDefinition": {
      "description": "The warehouse public definition object. Refer to this [article](/rest/api/fabric/articles/item-management/definitions/warehouse-definition) for more details on the structure of the warehouse definition.",
      "type": "object",
      "required": ["parts"],
      "properties": {
        "format": {
          "description": "The format of the warehouse definition. Supported formats: `dacpac` and `sqlproj`. If no format is provided, `sqlproj` is used.",
          "type": "string",
          "readOnly": false
        },
        "parts": {
          "description": "A list of definition parts.",
          "type": "array",
          "items": {
            "$ref": "#/definitions/WarehouseDefinitionPart"
          },
          "readOnly": false
        }
      }
    },
    "WarehouseDefinitionPart": {
      "description": "Warehouse definition part object.",
      "type": "object",
      "required": ["path", "payload", "payloadType"],
      "properties": {
        "path": {
          "description": "The warehouse public definition part path.",
          "type": "string",
          "readOnly": false
        },
        "payload": {
          "description": "The warehouse public definition part payload.",
          "type": "string",
          "readOnly": false
        },
        "payloadType": {
          "description": "The payload type.",
          "$ref": "../common/definitions.json#/definitions/PayloadType",
          "readOnly": false
        }
      }
    },
    "UpdateWarehouseRequest": {
      "description": "Update warehouse request.",
      "properties": {
        "displayName": {
          "description": "The warehouse display name. The display name must follow naming rules according to item type.",
          "type": "string",
          "readOnly": false
        },
        "description": {
          "description": "The warehouse description. Maximum length is 256 characters.",
          "type": "string",
          "readOnly": false
        }
      }
    },
    "UpdateSQLPoolsConfigurationRequest": {
      "type": "object",
      "description": "SQL pools configuration request payload.",
      "properties": {
        "customSQLPoolsEnabled": {
          "description": "Indicates whether the SQL pools configuration is enabled. When set to false, the configuration is disabled but preserved. Re-enabling it restores the previously saved configuration.",
          "type": "boolean"
        },
        "customSQLPools": {
          "description": "A list of SQL pool elements. In update requests, you must explicitly specify the name of the pools to retain. Any SQL pool not included in the update request will be deleted.",
          "type": "array",
          "items": {
            "$ref": "#/definitions/CustomSQLPool"
          }
        }
      }
    },
    "CustomSQLPool": {
      "type": "object",
      "description": "Custom SQL pool element.",
      "properties": {
        "name": {
          "description": "Friendly name for the SQL pool.",
          "type": "string"
        },
        "isDefault": {
          "description": "Indicates that this is a default SQL pool. Only one pool can be marked as default. True - Sql Pool is the default, False - Sql Pool is not the default.",
          "type": "boolean"
        },
        "maxResourcePercentage": {
          "description": "Maximum percentage of workspace resources that this SQL pool is allowed to consume. Value is an integer in the range 1-100. The sum of maxResourcePercentage values across all SQL pools must not exceed 100",
          "format": "int32",
          "type": "integer"
        },
        "optimizeForReads": {
          "description": "Optimizes the SQL pool for read-heavy workloads. True - the SQL pool will leverage enhanced caching to improve read performance. False - the SQL pool will not use enhanced caching. Default is true.",
          "type": "boolean"
        },
        "classifier": {
          "$ref": "#/definitions/CustomSqlPoolClassifier",
          "description": "This is an object that holds the classifier that is applied to the SQL pool."
        }
      }
    },
    "CustomSqlPoolClassifier": {
      "type": "object",
      "description": "A classifier element.",
      "required": [
        "type",
        "value"
      ],
      "properties": {
        "type": {
          "description": "Classifier element type.",
          "$ref": "#/definitions/CustomSqlPoolClassifierType"
        },
        "value": {
          "description": "List of strings.",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "CustomSqlPoolClassifierType": {
      "description": "Classifier element type. Additional classifier element types may be added over time.",
      "type": "string",
      "enum": ["Application Name", "Application Name Regex", "Statement Type"],
      "x-ms-enum": {
        "name": "CustomSqlPoolClassifierType",
        "modelAsString": true,
        "values": [
          {
            "value": "Application Name",
            "description": "Refers to specific application names applied to the SQL pool."
          },
          {
            "value": "Application Name Regex",
            "description": "Refers to a regular expression pattern used to match the application names applied to the SQL pool."
          },
          {
            "value": "Statement Type",
            "description": "Refers to SQL statement types applied to the SQL pool."
          }
        ]
      }
    },
    "SQLPoolsConfigurationResponse": {
      "type": "object",
      "description": "SQL pools configuration response.",
      "properties": {
        "customSQLPoolsEnabled": {
          "description": "Indicates whether the SQL pools configuration is enabled. When set to false, the configuration is disabled but preserved. Re-enabling it restores the previously saved configuration.",
          "type": "boolean"
        },
        "customSQLPools": {
          "description": "A list of SQL pool elements.",
          "type": "array",
          "items": {
            "$ref": "#/definitions/CustomSQLPool"
          }
        }
      }
    },
    "RestorePoint": {
      "type": "object",
      "description": "The properties of a restore point.",
      "required": [ "id", "displayName", "description", "creationMode", "creationDetails" ],
      "properties": {
        "id": {
          "description": "The restore point ID.",
          "type": "string",
          "readOnly": true
        },
        "displayName": {
          "description": "The restore point name.",
          "type": "string",
          "readOnly": false
        },
        "description": {
          "description": "The restore point description.",
          "type": "string",
          "readOnly": false
        },
        "creationMode": {
          "description": "The creation mode of the restore point. Additional creation mode types may be added over time.",
          "type": "string",
          "readOnly": true,
          "enum": [ "UserDefined", "SystemCreated" ],
          "x-ms-enum": {
            "name": "CreationModeType",
            "modelAsString": true,
            "values": [
              {
                "value": "UserDefined",
                "description": "User defined restore point."
              },
              {
                "value": "SystemCreated",
                "description": "System created restore point."
              }
            ]
          }
        },
        "creationDetails": {
          "description": "The creation metadata of the restore point.",
          "$ref": "#/definitions/RestorePointEventDetails"
        }
      }
    },
    "RestorePointEventDetails": {
      "type": "object",
      "description": "The restore point event details.",
      "required": [ "eventDateTime" ],
      "properties": {
        "eventDateTime": {
            "description": "The time of the restore point event in UTC, using the YYYY-MM-DDTHH:mm:ssZ format.",
            "type": "string",
            "format": "date-time",
            "readOnly": true
        },
        "eventInitiator": {
          "description": "The principal that initiated the restore point event.",
          "$ref": "../common/definitions.json#/definitions/Principal"
        }
      }
    },
    "RestorePoints": {
      "description": "A list of restore points.",
      "required": [ "value" ],
      "type": "object",
      "properties": {
        "value": {
          "description": "A list of restore points.",
          "type": "array",
          "readOnly": true,
          "items": {
            "$ref": "#/definitions/RestorePoint"
          }
        }
      },
      "allOf": [
        {
          "$ref": "../common/definitions.json#/definitions/PaginatedResponse"
        }
      ]
    },
    "CreateRestorePointRequest": {
      "description": "Create restore point request payload.",
      "properties": {
        "displayName": {
          "description": "The restore point name. Maximum length is 128 characters.",
          "type": "string",
          "readOnly": false
        },
        "description": {
          "description": "The restore point description. Maximum length is 512 characters.",
          "type": "string",
          "readOnly": false
        }
      }
    },
    "UpdateRestorePointRequest": {
      "description": "Update restore point request payload.",
      "properties": {
        "displayName": {
          "description": "The restore point name. Maximum length is 128 characters.",
          "type": "string",
          "readOnly": false
        },
        "description": {
          "description": "The restore point description. Maximum length is 512 characters.",
          "type": "string",
          "readOnly": false
        }
      }
    },
    "ConnectionStringResponse": {
      "description": "The SQL connection string for the workspace containing this warehouse.",
      "type": "object",
      "properties": {
        "connectionString": {
          "description": "The SQL connection string for the workspace containing this warehouse.",
          "type": "string",
          "readOnly": false
        }
      }
    }
  }
}