mirror of
https://github.com/microsoft/fabric-rest-api-specs.git
synced 2026-11-04 12:04:23 +00:00
998 lines
41 KiB
JSON
998 lines
41 KiB
JSON
{
|
|
"swagger": "2.0",
|
|
"info": {
|
|
"title": "Environment data types",
|
|
"version": "v1"
|
|
},
|
|
"paths": {},
|
|
"definitions": {
|
|
"EnvironmentSparkComputePreview": {
|
|
"type": "object",
|
|
"properties": {
|
|
"instancePool": {
|
|
"description": "Environment pool has to be a valid custom pool. \"Starter Pool\" means use starter pool.",
|
|
"$ref": "../common/spark_definitions.json#/definitions/InstancePool"
|
|
},
|
|
"driverCores": {
|
|
"description": "Spark driver core. Must be one of the following values: 4, 8, 16, 32, 64.",
|
|
"format": "int32",
|
|
"type": "integer"
|
|
},
|
|
"driverMemory": {
|
|
"description": "Spark driver memory.",
|
|
"type": "string"
|
|
},
|
|
"executorCores": {
|
|
"description": "Spark executor core. Must be one of the following values: 4, 8, 16, 32, 64.",
|
|
"format": "int32",
|
|
"type": "integer"
|
|
},
|
|
"executorMemory": {
|
|
"description": "Spark executor memory.",
|
|
"type": "string"
|
|
},
|
|
"dynamicExecutorAllocation": {
|
|
"description": "Dynamic executor allocation.",
|
|
"$ref": "#/definitions/DynamicExecutorAllocationProperties"
|
|
},
|
|
"sparkProperties": {
|
|
"type": "object",
|
|
"description": "Spark properties. The dictionary-based contract for defining Spark properties will be deprecated on January 31, 2026. Please migrate to using a list of key-value pairs instead."
|
|
},
|
|
"runtimeVersion": {
|
|
"description": "Runtime version, find the supported [fabric runtimes](/fabric/data-engineering/runtime).",
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"UpdateEnvironmentSparkComputeRequestPreview": {
|
|
"type": "object",
|
|
"properties": {
|
|
"instancePool": {
|
|
"description": "Environment pool has to be a valid custom pool. The name for a default workspace pool is *Starter Pool*.",
|
|
"$ref": "../common/spark_definitions.json#/definitions/InstancePool",
|
|
"type": "object"
|
|
},
|
|
"driverCores": {
|
|
"description": "Spark driver core.",
|
|
"format": "int32",
|
|
"type": "integer"
|
|
},
|
|
"driverMemory": {
|
|
"description": "Spark driver memory.",
|
|
"type": "string"
|
|
},
|
|
"executorCores": {
|
|
"description": "Spark executor core.",
|
|
"format": "int32",
|
|
"type": "integer"
|
|
},
|
|
"executorMemory": {
|
|
"description": "Spark executor memory.",
|
|
"type": "string"
|
|
},
|
|
"dynamicExecutorAllocation": {
|
|
"description": "Dynamic executor allocation.",
|
|
"$ref": "#/definitions/DynamicExecutorAllocationProperties"
|
|
},
|
|
"sparkProperties": {
|
|
"type": "object",
|
|
"description": "Spark properties. The dictionary-based contract for defining Spark properties will be deprecated on January 31, 2026. Please migrate to using a list of key-value pairs instead."
|
|
},
|
|
"runtimeVersion": {
|
|
"description": "Runtime version, find the supported [fabric runtimes](/fabric/data-engineering/runtime).",
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"EnvironmentSparkCompute": {
|
|
"type": "object",
|
|
"properties": {
|
|
"instancePool": {
|
|
"description": "Environment pool has to be a valid custom pool. \"Starter Pool\" means use starter pool.",
|
|
"$ref": "../common/spark_definitions.json#/definitions/InstancePool"
|
|
},
|
|
"driverCores": {
|
|
"description": "Spark driver core. Must be one of the following values: 4, 8, 16, 32, 64.",
|
|
"format": "int32",
|
|
"type": "integer"
|
|
},
|
|
"driverMemory": {
|
|
"description": "Spark driver memory.",
|
|
"type": "string",
|
|
"$ref": "#/definitions/CustomPoolMemory"
|
|
},
|
|
"executorCores": {
|
|
"description": "Spark executor core. Must be one of the following values: 4, 8, 16, 32, 64.",
|
|
"format": "int32",
|
|
"type": "integer"
|
|
},
|
|
"executorMemory": {
|
|
"description": "Spark executor memory.",
|
|
"type": "string",
|
|
"$ref": "#/definitions/CustomPoolMemory"
|
|
},
|
|
"dynamicExecutorAllocation": {
|
|
"description": "Dynamic executor allocation.",
|
|
"$ref": "#/definitions/DynamicExecutorAllocationProperties"
|
|
},
|
|
"sparkProperties": {
|
|
"type": "array",
|
|
"description": "Spark properties.",
|
|
"items": {
|
|
"$ref": "#/definitions/SparkProperty"
|
|
}
|
|
},
|
|
"runtimeVersion": {
|
|
"description": "Runtime version, find the supported [fabric runtimes](/fabric/data-engineering/runtime). For example: 1.3",
|
|
"type": "string"
|
|
},
|
|
"customLivePoolSupport": {
|
|
"description": "Controls whether the live pool is enabled. When `Enabled`, clusters are pre-hydrated according to the hydration settings so that workloads start without cold-start latency.",
|
|
"$ref": "#/definitions/CustomLivePoolSupport"
|
|
},
|
|
"customLivePoolSettings": {
|
|
"description": "Live pool hydration settings. Controls how clusters are pre-hydrated when live pool support is enabled.",
|
|
"$ref": "#/definitions/CustomLivePoolSettings"
|
|
}
|
|
}
|
|
},
|
|
"UpdateEnvironmentSparkComputeRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"instancePool": {
|
|
"description": "Environment pool has to be a valid custom pool. The name for a default workspace pool is *Starter Pool*.",
|
|
"$ref": "../common/spark_definitions.json#/definitions/InstancePool",
|
|
"type": "object"
|
|
},
|
|
"driverCores": {
|
|
"description": "Spark driver core. Must be one of the following values: 4, 8, 16, 32, 64.",
|
|
"format": "int32",
|
|
"type": "integer"
|
|
},
|
|
"driverMemory": {
|
|
"description": "Spark driver memory.",
|
|
"type": "string",
|
|
"$ref": "#/definitions/CustomPoolMemory"
|
|
},
|
|
"executorCores": {
|
|
"description": "Spark executor core. Must be one of the following values: 4, 8, 16, 32, 64.",
|
|
"format": "int32",
|
|
"type": "integer"
|
|
},
|
|
"executorMemory": {
|
|
"description": "Spark executor memory.",
|
|
"type": "string",
|
|
"$ref": "#/definitions/CustomPoolMemory"
|
|
},
|
|
"dynamicExecutorAllocation": {
|
|
"description": "Dynamic executor allocation.",
|
|
"$ref": "#/definitions/DynamicExecutorAllocationProperties"
|
|
},
|
|
"sparkProperties": {
|
|
"type": "array",
|
|
"description": "Spark properties.",
|
|
"items": {
|
|
"$ref": "#/definitions/SparkProperty"
|
|
}
|
|
},
|
|
"runtimeVersion": {
|
|
"description": "Runtime version, find the supported [fabric runtimes](/fabric/data-engineering/runtime). For example: 1.3",
|
|
"type": "string"
|
|
},
|
|
"customLivePoolSupport": {
|
|
"description": "Controls whether the live pool is active. Setting `Disabled` turns it off but retains the hydration settings. Omit to leave the existing value unchanged.",
|
|
"$ref": "#/definitions/CustomLivePoolSupport"
|
|
},
|
|
"customLivePoolSettings": {
|
|
"description": "Live pool hydration settings. Pass `null` to remove the hydration settings entirely. Omit to leave the existing value unchanged.",
|
|
"$ref": "#/definitions/CustomLivePoolSettings"
|
|
}
|
|
}
|
|
},
|
|
"CustomPoolMemory": {
|
|
"type": "string",
|
|
"description": "Custom pool memory for Spark driver or Spark executor. Additional `CustomPoolMemory` types may be added over time.",
|
|
"enum": ["28g", "56g", "112g", "224g", "400g"],
|
|
"x-ms-enum": {
|
|
"name": "CustomPoolMemory",
|
|
"modelAsString": true,
|
|
"values": [
|
|
{
|
|
"value": "28g",
|
|
"description": "28GB memory."
|
|
},
|
|
{
|
|
"value": "56g",
|
|
"description": "56G memory."
|
|
},
|
|
{
|
|
"value": "112g",
|
|
"description": "112G memory."
|
|
},
|
|
{
|
|
"value": "224g",
|
|
"description": "224G memory."
|
|
},
|
|
{
|
|
"value": "400g",
|
|
"description": "400G memory."
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"SparkProperty": {
|
|
"type": "object",
|
|
"description": "A Spark property key and its value.",
|
|
"properties": {
|
|
"key": {
|
|
"description": "The Spark property key.",
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"description": "The Spark property value.",
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"DynamicExecutorAllocationProperties": {
|
|
"description": "Dynamic executor allocation proerties.",
|
|
"required": [
|
|
"enabled",
|
|
"minExecutors",
|
|
"maxExecutors"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"enabled": {
|
|
"description": "The status of the dynamic executor allocation. False - Disabled, true - Enabled.",
|
|
"type": "boolean"
|
|
},
|
|
"minExecutors": {
|
|
"description": "The minimum executor number for dynamic allocation and the minimum for this property is 1. The maximum value has to be lower than `maxExecutors`.",
|
|
"format": "int32",
|
|
"type": "integer",
|
|
"minimum": 1
|
|
},
|
|
"maxExecutors": {
|
|
"description": "The maximum executor number for dynamic allocation and the minimum for this property is 1. The maximum value has to be lower than the instance pool `maxNodeCount`.",
|
|
"format": "int32",
|
|
"type": "integer",
|
|
"minimum": 1
|
|
}
|
|
}
|
|
},
|
|
"Environments": {
|
|
"description": "A list of environments.",
|
|
"required": ["value"],
|
|
"type": "object",
|
|
"properties": {
|
|
"value": {
|
|
"description": "A list of environments.",
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/Environment"
|
|
}
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
|
|
}
|
|
]
|
|
},
|
|
"Environment": {
|
|
"description": "An Environment item.",
|
|
"type": "object",
|
|
"required": ["type"],
|
|
"allOf": [
|
|
{
|
|
"$ref": "../common/definitions.json#/definitions/Item"
|
|
}
|
|
],
|
|
"properties": {
|
|
"properties": {
|
|
"description": "The environment properties.",
|
|
"$ref": "#/definitions/EnvironmentProperties"
|
|
}
|
|
}
|
|
},
|
|
"CreateEnvironmentRequest": {
|
|
"description": "Create environment request payload.",
|
|
"required": ["displayName"],
|
|
"properties": {
|
|
"displayName": {
|
|
"description": "The environment display name.",
|
|
"type": "string",
|
|
"readOnly": false
|
|
},
|
|
"description": {
|
|
"description": "The environment description. Maximum length is 256 characters.",
|
|
"type": "string",
|
|
"readOnly": false
|
|
},
|
|
"folderId": {
|
|
"description": "The folder ID. If not specified or null, the environment is created with the workspace as its folder.",
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"readOnly": false
|
|
},
|
|
"definition": {
|
|
"description": "The environment public definition.",
|
|
"$ref": "#/definitions/EnvironmentDefinition",
|
|
"readOnly": false
|
|
},
|
|
"sensitivityLabelSettings": {
|
|
"description": "The sensitivity label settings for the environment.",
|
|
"$ref": "../common/definitions.json#/definitions/SensitivityLabelSettings",
|
|
"readOnly": false
|
|
}
|
|
}
|
|
},
|
|
"UpdateEnvironmentDefinitionRequest": {
|
|
"description": "Update environment public definition request payload.",
|
|
"required": ["definition"],
|
|
"properties": {
|
|
"definition": {
|
|
"$ref": "#/definitions/EnvironmentDefinition"
|
|
}
|
|
}
|
|
},
|
|
"EnvironmentDefinitionResponse": {
|
|
"description": "Environment public definition response.",
|
|
"required": ["definition"],
|
|
"properties": {
|
|
"definition": {
|
|
"$ref": "#/definitions/EnvironmentDefinition",
|
|
"readOnly": true
|
|
}
|
|
}
|
|
},
|
|
"EnvironmentDefinition" : {
|
|
"description": "Environment public definition object. Refer to this [article](/rest/api/fabric/articles/item-management/definitions/environment-definition) for more details on the structure of the Environment definition.",
|
|
"type": "object",
|
|
"required": ["parts"],
|
|
"properties": {
|
|
"format": {
|
|
"description": "The format of the Environment definition.",
|
|
"type": "string",
|
|
"readOnly": false
|
|
},
|
|
"parts": {
|
|
"description": "A list of definition parts.",
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/EnvironmentDefinitionPart"
|
|
},
|
|
"readOnly": false
|
|
}
|
|
}
|
|
},
|
|
"EnvironmentDefinitionPart": {
|
|
"description": "Environment definition part object.",
|
|
"type": "object",
|
|
"properties": {
|
|
"path": {
|
|
"description": "The environment part path.",
|
|
"type": "string",
|
|
"readOnly": false
|
|
},
|
|
"payload": {
|
|
"description": "The environment part payload.",
|
|
"type": "string",
|
|
"readOnly": false
|
|
},
|
|
"payloadType":{
|
|
"description": "The payload type.",
|
|
"$ref": "../common/definitions.json#/definitions/PayloadType",
|
|
"readOnly": false
|
|
}
|
|
}
|
|
},
|
|
"UpdateEnvironmentRequest": {
|
|
"description": "Update environment request.",
|
|
"properties": {
|
|
"displayName": {
|
|
"description": "The environment display name.",
|
|
"type": "string",
|
|
"readOnly": false
|
|
},
|
|
"description": {
|
|
"description": "The environment description. Maximum length is 256 characters.",
|
|
"type": "string",
|
|
"readOnly": false
|
|
}
|
|
}
|
|
},
|
|
"EnvironmentProperties": {
|
|
"description": "Environment properties.",
|
|
"type": "object",
|
|
"required": ["publishDetails"],
|
|
"properties": {
|
|
"publishDetails": {
|
|
"description": "Environment publish operation details.",
|
|
"$ref": "#/definitions/PublishDetails"
|
|
}
|
|
}
|
|
},
|
|
"PublishDetails": {
|
|
"description": "Details of publish operation.",
|
|
"type": "object",
|
|
"properties": {
|
|
"state": {
|
|
"description": "Publish state. Additional state types may be added over time.",
|
|
"type": "string",
|
|
"enum": ["Success", "Cancelled", "Failed", "Cancelling", "Running", "Waiting"],
|
|
"x-ms-enum": {
|
|
"name": "EnvironmentPublishState",
|
|
"modelAsString": true,
|
|
"values": [
|
|
{
|
|
"value": "Waiting",
|
|
"description": "Environment publish is in waiting state."
|
|
},
|
|
{
|
|
"value": "Running",
|
|
"description": "Environment publish is in running state."
|
|
},
|
|
{
|
|
"value": "Cancelling",
|
|
"description": "Environment publish is in cancelling state."
|
|
},
|
|
{
|
|
"value": "Cancelled",
|
|
"description": "Environment publish is in cancelled state."
|
|
},
|
|
{
|
|
"value": "Failed",
|
|
"description": "Environment publish is in failed state."
|
|
},
|
|
{
|
|
"value": "Success",
|
|
"description": "Environment publish is in success state."
|
|
}
|
|
]
|
|
}
|
|
|
|
},
|
|
"targetVersion": {
|
|
"description": "Target verion to be published.",
|
|
"format": "uuid",
|
|
"type": "string"
|
|
},
|
|
"startTime": {
|
|
"description": "Start time of publish operation in UTC, using the YYYY-MM-DDTHH:mm:ss.sssssssZ format.",
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"endTime": {
|
|
"description": "End time of publish operation in UTC, using the YYYY-MM-DDTHH:mm:ss.sssssssZ format.",
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"componentPublishInfo": {
|
|
"description": "Environment component publish information.",
|
|
"$ref": "#/definitions/ComponentPublishInfo"
|
|
}
|
|
}
|
|
},
|
|
"ComponentPublishInfo": {
|
|
"description": "Publish info for each components in environment.",
|
|
"type": "object",
|
|
"properties": {
|
|
"sparkLibraries": {
|
|
"description": "Spark libraries publish information.",
|
|
"$ref": "#/definitions/SparkLibraries"
|
|
},
|
|
"sparkSettings": {
|
|
"description": "Spark settings publish information.",
|
|
"$ref": "#/definitions/SparkSettings"
|
|
}
|
|
}
|
|
},
|
|
"SparkLibraries": {
|
|
"description": "Spark libraries.",
|
|
"type": "object",
|
|
"properties": {
|
|
"state": {
|
|
"description": "Publish state. Additional state types may be added over time.",
|
|
"type": "string",
|
|
"enum": ["Success", "Cancelled", "Failed", "Cancelling", "Running", "Waiting"],
|
|
"x-ms-enum": {
|
|
"name": "EnvironmentPublishState",
|
|
"modelAsString": true,
|
|
"values": [
|
|
{
|
|
"value": "Waiting",
|
|
"description": "Environment publish is in waiting state."
|
|
},
|
|
{
|
|
"value": "Running",
|
|
"description": "Environment publish is in running state."
|
|
},
|
|
{
|
|
"value": "Cancelling",
|
|
"description": "Environment publish is in cancelling state."
|
|
},
|
|
{
|
|
"value": "Cancelled",
|
|
"description": "Environment publish is in cancelled state."
|
|
},
|
|
{
|
|
"value": "Failed",
|
|
"description": "Environment publish is in failed state."
|
|
},
|
|
{
|
|
"value": "Success",
|
|
"description": "Environment publish is in success state."
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"SparkSettings": {
|
|
"description": "Spark settings.",
|
|
"type": "object",
|
|
"properties": {
|
|
"state": {
|
|
"description": "Publish state. Additional state types may be added over time.",
|
|
"type": "string",
|
|
"enum": ["Success", "Cancelled", "Failed", "Cancelling", "Running", "Waiting"],
|
|
"x-ms-enum": {
|
|
"name": "EnvironmentPublishState",
|
|
"modelAsString": true,
|
|
"values": [
|
|
{
|
|
"value": "Waiting",
|
|
"description": "Environment publish is in waiting state."
|
|
},
|
|
{
|
|
"value": "Running",
|
|
"description": "Environment publish is in running state."
|
|
},
|
|
{
|
|
"value": "Cancelling",
|
|
"description": "Environment publish is in cancelling state."
|
|
},
|
|
{
|
|
"value": "Cancelled",
|
|
"description": "Environment publish is in cancelled state."
|
|
},
|
|
{
|
|
"value": "Failed",
|
|
"description": "Environment publish is in failed state."
|
|
},
|
|
{
|
|
"value": "Success",
|
|
"description": "Environment publish is in success state."
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"LibraryType": {
|
|
"type": "string",
|
|
"description": "A library type. Additional types may be added over time.",
|
|
"enum": ["Custom", "External"],
|
|
"x-ms-enum": {
|
|
"name": "LibraryType",
|
|
"modelAsString": true,
|
|
"values": [
|
|
{
|
|
"value": "Custom",
|
|
"description": "Custom libraries"
|
|
},
|
|
{
|
|
"value": "External",
|
|
"description": "External libraries"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"Libraries": {
|
|
"description": "Environment libraries.",
|
|
"type": "object",
|
|
"properties": {
|
|
"libraries": {
|
|
"type": "array",
|
|
"description": "All custom and external libraries (.py, .whl, .jar, .tar.gz and external).",
|
|
"items": {
|
|
"$ref": "#/definitions/Library"
|
|
}
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
|
|
}
|
|
]
|
|
},
|
|
"Library": {
|
|
"description": "Custom or external library.",
|
|
"type": "object",
|
|
"discriminator": "libraryType",
|
|
"required": ["libraryType", "name"],
|
|
"properties": {
|
|
"libraryType": {
|
|
"$ref": "#/definitions/LibraryType"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"description": "The name of library."
|
|
}
|
|
}
|
|
},
|
|
"CustomLibrary": {
|
|
"type": "object",
|
|
"description": "Custom library.",
|
|
"x-ms-discriminator-value": "Custom",
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/Library"
|
|
}
|
|
]
|
|
},
|
|
"ExternalLibrary": {
|
|
"type": "object",
|
|
"description": "External library.",
|
|
"required": ["version"],
|
|
"x-ms-discriminator-value": "External",
|
|
"properties": {
|
|
"version": {
|
|
"type": "string",
|
|
"description": "The version of external library."
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/Library"
|
|
}
|
|
]
|
|
},
|
|
"RemoveExternalLibrariesRequest": {
|
|
"type": "object",
|
|
"description": "Request to delete an external library.",
|
|
"required": ["name", "version"],
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"description": "The name of library."
|
|
},
|
|
"version": {
|
|
"type": "string",
|
|
"description": "The version of external library."
|
|
}
|
|
}
|
|
},
|
|
"CustomLivePoolSettings": {
|
|
"description": "Live pool hydration settings on the environment's spark compute.",
|
|
"type": "object",
|
|
"properties": {
|
|
"maxClustersToHydrate": {
|
|
"description": "Maximum number of clusters to pre-hydrate during each activation cycle. Minimum: 1. The maximum allowed value is determined by the capacity size and is exposed on the instance pool settings as `InstancePool.maxClustersToHydrateLimit`.",
|
|
"format": "int32",
|
|
"type": "integer",
|
|
"minimum": 1
|
|
},
|
|
"clusterIdleTimeout": {
|
|
"description": "Idle-time threshold after which a hydrated cluster is released, using the ISO 8601 duration format. Minimum: PT20M. Maximum: PT24H.",
|
|
"format": "duration",
|
|
"type": "string"
|
|
},
|
|
"customLivePoolLifespan": {
|
|
"description": "Maximum lifetime of a live pool activation, using the ISO 8601 duration format. The live pool job runs for this duration and then terminates. Minimum: PT30M. Maximum: PT24H.",
|
|
"format": "duration",
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"CustomLivePoolSupport": {
|
|
"type": "string",
|
|
"description": "Flag controlling whether live pool support is active. Additional `CustomLivePoolSupport` values may be added over time.",
|
|
"enum": ["Enabled", "Disabled"],
|
|
"x-ms-enum": {
|
|
"name": "CustomLivePoolSupport",
|
|
"modelAsString": true,
|
|
"values": [
|
|
{
|
|
"value": "Enabled",
|
|
"description": "Live pool support is active."
|
|
},
|
|
{
|
|
"value": "Disabled",
|
|
"description": "Live pool support is inactive. Configuration is retained."
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"LibrariesPreview": {
|
|
"description": "Environment libraries.",
|
|
"type": "object",
|
|
"properties": {
|
|
"customLibraries": {
|
|
"description": "Custom libraries (.py, .whl, .jar, .tar.gz).",
|
|
"$ref": "#/definitions/CustomLibraries"
|
|
},
|
|
"environmentYml": {
|
|
"description": "Feed libraries.",
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"CustomLibraries": {
|
|
"description": "Custom libraries.",
|
|
"type": "object",
|
|
"properties": {
|
|
"wheelFiles": {
|
|
"type": "array",
|
|
"description": "A list of Wheel files.",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"pyFiles": {
|
|
"type": "array",
|
|
"description": "A list of Python files.",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"jarFiles": {
|
|
"type": "array",
|
|
"description": "A list of Jar files.",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"rTarFiles": {
|
|
"type": "array",
|
|
"description": "A list of R files.",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"PoolActivations": {
|
|
"description": "A paginated list of pool activations.",
|
|
"type": "object",
|
|
"required": ["value"],
|
|
"allOf": [
|
|
{
|
|
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
|
|
}
|
|
],
|
|
"properties": {
|
|
"value": {
|
|
"description": "A list of pool activations.",
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/PoolActivation"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"PoolActivation": {
|
|
"description": "A pool activation object.",
|
|
"type": "object",
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/CustomLivePoolSettings"
|
|
}
|
|
],
|
|
"properties": {
|
|
"jobInstanceId": {
|
|
"description": "The pool activation job instance identifier.",
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"name": {
|
|
"description": "The pool activation name.",
|
|
"type": "string"
|
|
},
|
|
"capacityId": {
|
|
"description": "The capacity identifier.",
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"state": {
|
|
"description": "The current lifecycle state of the activation.",
|
|
"$ref": "#/definitions/JobHistoryStatus"
|
|
},
|
|
"scheduledStartDateTime": {
|
|
"description": "The scheduled start time in UTC, using the YYYY-MM-DDTHH:mm:ssZ format.",
|
|
"type": "string"
|
|
},
|
|
"startDateTime": {
|
|
"description": "The actual start time in UTC, using the YYYY-MM-DDTHH:mm:ssZ format.",
|
|
"type": "string"
|
|
},
|
|
"scheduledEndDateTime": {
|
|
"description": "The scheduled end time in UTC, using the YYYY-MM-DDTHH:mm:ssZ format.",
|
|
"type": "string"
|
|
},
|
|
"endDateTime": {
|
|
"description": "The actual end time in UTC, using the YYYY-MM-DDTHH:mm:ssZ format. Omitted if the activation is ongoing.",
|
|
"type": "string"
|
|
},
|
|
"isRecurring": {
|
|
"description": "Whether the activation recurs on a schedule.",
|
|
"type": "boolean"
|
|
},
|
|
"cancellationReason": {
|
|
"description": "The reason for cancellation, if applicable.",
|
|
"type": "string"
|
|
},
|
|
"jobType": {
|
|
"description": "The monitoring job type classification.",
|
|
"type": "string"
|
|
},
|
|
"runtimeVersion": {
|
|
"description": "The Fabric runtime version used for the activation.",
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"PoolActivationDetails": {
|
|
"description": "A pool activation details object with extended diagnostic properties.",
|
|
"type": "object",
|
|
"required": [
|
|
"sparkConfiguration"
|
|
],
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/PoolActivation"
|
|
}
|
|
],
|
|
"properties": {
|
|
"poolName": {
|
|
"description": "The pool display name.",
|
|
"type": "string"
|
|
},
|
|
"sparkConfiguration": {
|
|
"description": "The Spark configuration for the activation. Always present in the Get pool activation detail response.",
|
|
"$ref": "#/definitions/SparkConfiguration"
|
|
},
|
|
"resourceStatusSummary": {
|
|
"description": "The summary of activation resources grouped by lifecycle status.",
|
|
"$ref": "#/definitions/ResourceStatusSummary"
|
|
}
|
|
}
|
|
},
|
|
"SparkComputeConfiguration": {
|
|
"description": "Common Spark compute configuration properties.",
|
|
"type": "object",
|
|
"properties": {
|
|
"driverMemory": {
|
|
"description": "The driver memory allocation including the unit suffix, for example `7g` or `28g`.",
|
|
"type": "string"
|
|
},
|
|
"driverCores": {
|
|
"description": "The number of CPU cores allocated to the driver.",
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"executorMemory": {
|
|
"description": "The executor memory allocation including the unit suffix, for example `7g` or `28g`.",
|
|
"type": "string"
|
|
},
|
|
"executorCores": {
|
|
"description": "The number of CPU cores allocated to each executor.",
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
}
|
|
},
|
|
"SparkConfiguration": {
|
|
"description": "The Spark configuration for a pool activation.",
|
|
"type": "object",
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/SparkComputeConfiguration"
|
|
}
|
|
],
|
|
"properties": {
|
|
"numExecutors": {
|
|
"description": "The number of executors.",
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"isDynamicAllocationEnabled": {
|
|
"description": "Whether dynamic allocation was enabled for the activation. When `false`, the activation used a fixed executor count from `numExecutors` and no dynamic scaling was applied.",
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"ResourceStatusSummary": {
|
|
"description": "The summary of custom live pool activation resources grouped by user-facing lifecycle status.",
|
|
"type": "object",
|
|
"properties": {
|
|
"starting": {
|
|
"description": "The number of resources currently provisioning.",
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"ready": {
|
|
"description": "The number of resources warmed up and available.",
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"acquired": {
|
|
"description": "The number of resources acquired by (actively assigned to) a session.",
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"stopping": {
|
|
"description": "The number of resources being decommissioned.",
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"deactivated": {
|
|
"description": "The number of resources intentionally deactivated by policy.",
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"expired": {
|
|
"description": "The number of resources that exceeded their lifetime.",
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"cancelled": {
|
|
"description": "The number of resources cancelled before completion.",
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"failed": {
|
|
"description": "The number of resources that failed to provision.",
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
}
|
|
},
|
|
"JobHistoryStatus": {
|
|
"description": "The lifecycle state of a pool activation. Additional JobHistoryStatus types may be added over time.",
|
|
"type": "string",
|
|
"enum": [
|
|
"NotStarted",
|
|
"InProgress",
|
|
"Succeeded",
|
|
"Failed",
|
|
"Cancelled",
|
|
"Unknown"
|
|
],
|
|
"x-ms-enum": {
|
|
"name": "State",
|
|
"modelAsString": true,
|
|
"values": [
|
|
{
|
|
"value": "NotStarted",
|
|
"description": "The activation has not yet started."
|
|
},
|
|
{
|
|
"value": "InProgress",
|
|
"description": "The activation is currently in progress."
|
|
},
|
|
{
|
|
"value": "Succeeded",
|
|
"description": "The activation completed successfully."
|
|
},
|
|
{
|
|
"value": "Failed",
|
|
"description": "The activation failed."
|
|
},
|
|
{
|
|
"value": "Cancelled",
|
|
"description": "The activation was cancelled."
|
|
},
|
|
{
|
|
"value": "Unknown",
|
|
"description": "The activation state is unknown."
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|