nprasad2077/fabric-rest-api-specs
1
0 Fork 0
mirror of https://github.com/microsoft/fabric-rest-api-specs.git synced 2026-11-04 12:04:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updating swagger files.

Browse Source
This commit is contained in:
Fabric-APIs-Publish-Specification-Pipeline committed 2025-11-18 22:05:27 +00:00
1 parent be580e82e8
commit b6c9556b38
84 files changed
+2117 -746
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

anomalyDetector/definitions.json
+1 -18
View File
@@ -14,24 +14,7 @@
{
"$ref": "../common/definitions.json#/definitions/Item"
}
],
"properties": {
"properties": {
"description": "The AnomalyDetector properties.",
"$ref": "#/definitions/AnomalyDetectorProperties"
}
}
},
"AnomalyDetectorProperties": {
"description": "The AnomalyDetector properties.",
"type": "object",
"required": ["oneLakeRootPath"],
"properties": {
"oneLakeRootPath": {
"description": "OneLake path to the AnomalyDetector root directory.",
"type": "string"
}
}
]
},
"AnomalyDetectors": {
"description": "A list of Collection Names.",
anomalyDetector/examples/GetAnomalyDetector.json
+1 -4
View File
@@ -10,10 +10,7 @@
"displayName": "AnomalyDetector 1",
"description": "A AnomalyDetector description.",
"type": "AnomalyDetector",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"properties": {
"oneLakeRootPath": "https://onelake.dfs.fabric.microsoft.com/f089354e-8366-4e18-aea3-4cb4a3a50b48/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
}
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
}
}
}
anomalyDetector/examples/ListAnomalyDetectorsInWorkspace.json
+2 -8
View File
@@ -11,20 +11,14 @@
"displayName": "AnomalyDetector Name 1",
"description": "A AnomalyDetector description.",
"type": "AnomalyDetector",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"properties": {
"oneLakeRootPath": "https://onelake.dfs.fabric.microsoft.com/f089354e-8366-4e18-aea3-4cb4a3a50b48/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
}
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
},
{
"id": "f697fb63-abd4-4399-9548-be7e3c3c0dac",
"displayName": "AnomalyDetector Name 2",
"description": "A AnomalyDetector description.",
"type": "AnomalyDetector",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"properties": {
"oneLakeRootPath": "https://onelake.dfs.fabric.microsoft.com/f089354e-8366-4e18-aea3-4cb4a3a50b48/d8f6cf16-3aac-4440-9d76-a03d86b7ae3e"
}
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
}
]
}
common/definitions.json
+11 -3
View File
@@ -192,7 +192,7 @@
"ItemType": {
"description": "The type of the item. Additional item types may be added over time.",
"type": "string",
"enum": [ "Dashboard", "Report", "SemanticModel", "PaginatedReport", "Datamart", "Lakehouse", "Eventhouse", "Environment", "KQLDatabase", "KQLQueryset", "KQLDashboard", "DataPipeline", "Notebook", "SparkJobDefinition", "MLExperiment", "MLModel", "Warehouse", "Eventstream", "SQLEndpoint", "MirroredWarehouse", "MirroredDatabase", "Reflex", "GraphQLApi", "MountedDataFactory", "SQLDatabase", "CopyJob", "VariableLibrary", "Dataflow", "ApacheAirflowJob", "WarehouseSnapshot", "DigitalTwinBuilder", "DigitalTwinBuilderFlow", "MirroredAzureDatabricksCatalog", "Map", "AnomalyDetector", "UserDataFunction", "GraphModel", "GraphQuerySet" ],
"enum": [ "Dashboard", "Report", "SemanticModel", "PaginatedReport", "Datamart", "Lakehouse", "Eventhouse", "Environment", "KQLDatabase", "KQLQueryset", "KQLDashboard", "DataPipeline", "Notebook", "SparkJobDefinition", "MLExperiment", "MLModel", "Warehouse", "Eventstream", "SQLEndpoint", "MirroredWarehouse", "MirroredDatabase", "Reflex", "GraphQLApi", "MountedDataFactory", "SQLDatabase", "CopyJob", "VariableLibrary", "Dataflow", "ApacheAirflowJob", "WarehouseSnapshot", "DigitalTwinBuilder", "DigitalTwinBuilderFlow", "MirroredAzureDatabricksCatalog", "Map", "AnomalyDetector", "UserDataFunction", "GraphModel", "GraphQuerySet", "SnowflakeDatabase", "OperationsAgent" ],
"x-ms-enum": {
"name": "ItemType",
"modelAsString": true,
@@ -346,8 +346,16 @@
"description": "A GraphModel."
},
{
"value": "GraphQuerySet",
"description": "A Graph QuerySet."
"value": "GraphQuerySet",
"description": "A Graph QuerySet."
},
{
"value": "SnowflakeDatabase",
"description": "A Snowflake Database to store Iceberg tables created from Snowflake account."
},
{
"value": "OperationsAgent",
"description": "A OperationsAgent."
}
]
},
common/spark_definitions.json
-27
View File
@@ -144,33 +144,6 @@
"livySessionItemResourceUri": {
"type": "string",
"description": "The URI used to retrieve all Livy sessions for a given item."
},
"driverMemory": {
"type": "integer",
"description": "The amount of memory (in GB) assigned to the Spark driver process. Affects the driver's ability to handle job coordination and metadata. "
},
"driverCores": {
"type": "integer",
"description": "The number of CPU cores allocated to the Spark driver. Controls how much parallel processing the driver can handle."
},
"executorMemory": {
"type": "integer",
"description": "The amount of memory (in GB) assigned to each Spark executor process. Impacts how much data can be processed in memory per executor."
},
"executorCores": {
"description": "The number of CPU cores allocated to each Spark executor. Determines how many tasks each executor can run in parallel. "
},
"numExecutors": {
"type": "integer",
"description": "The total number of executors requested for the Spark job. Controls the parallelism and scalability of the job. "
},
"isDynamicAllocationEnabled": {
"type": "boolean",
"description": "Flag indicating whether dynamic allocation is enabled for the Spark job."
},
"dynamicAllocationMaxExecutors": {
"type": "integer",
"description": "Sets the maximum number of executors that Spark's dynamic allocation can scale up to during job execution. "
}
}
},
dataflow/examples/RunOnDemandDataflowApplyChangesJob.json
+1 -2
View File
@@ -1,8 +1,7 @@
{
"parameters": {
"workspaceId": "a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1",
"dataflowId": "dddddddd-9999-0000-1111-eeeeeeeeeeee",
"jobType": "ApplyChanges"
"dataflowId": "dddddddd-9999-0000-1111-eeeeeeeeeeee"
},
"responses": {
"202": {
dataflow/examples/RunOnDemandDataflowExecuteJob.json
+1 -2
View File
@@ -1,8 +1,7 @@
{
"parameters": {
"workspaceId": "a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1",
"dataflowId": "dddddddd-9999-0000-1111-eeeeeeeeeeee",
"jobType": "Execute"
"dataflowId": "dddddddd-9999-0000-1111-eeeeeeeeeeee"
},
"responses": {
"202": {
dataflow/examples/RunOnDemandDataflowExecuteJobWithParameters.json
-1
View File
@@ -2,7 +2,6 @@
"parameters": {
"workspaceId": "a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1",
"dataflowId": "dddddddd-9999-0000-1111-eeeeeeeeeeee",
"jobType": "Execute",
"runOnDemandItemJobRequest": {
"executionData": {
"executeOption": "ApplyChangesIfNeeded",
dataflow/swagger.json
+4 -18
View File
@@ -632,10 +632,10 @@
}
}
},
"/workspaces/{workspaceId}/dataflows/{dataflowId}/jobs/instances?jobType=Execute": {
"/workspaces/{workspaceId}/dataflows/{dataflowId}/jobs/Execute/instances": {
"post": {
"summary": "Run on-demand execute job instance.",
"description": "> [!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\n## Required Delegated Scopes\n\n For dataflows APIs use these scope types: \n- Specific scope: Dataflow.Execute.All \n\n for more information about scopes, see: [scopes article](/rest/api/fabric/articles/scopes).\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
"description": "> [!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n> The URL for this API has been updated to include the job type as part of the path, replacing the previous use of a query parameter. For backward compatibility, invocations using the query parameter are still supported.\n\n## Required Delegated Scopes\n\n For dataflows APIs use these scope types: \n- Specific scope: Dataflow.Execute.All \n\n for more information about scopes, see: [scopes article](/rest/api/fabric/articles/scopes).\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
"tags": [
"BackgroundJobs"
],
@@ -660,13 +660,6 @@
"format": "uuid",
"required": true
},
{
"in": "query",
"name": "jobType",
"description": "*Execute* job type. *Refresh* can also be used as an alias for *Execute*.",
"type": "string",
"required": true
},
{
"in": "body",
"name": "runOnDemandItemJobRequest",
@@ -708,10 +701,10 @@
}
}
},
"/workspaces/{workspaceId}/dataflows/{dataflowId}/jobs/instances?jobType=ApplyChanges": {
"/workspaces/{workspaceId}/dataflows/{dataflowId}/jobs/ApplyChanges/instances": {
"post": {
"summary": "Run on-demand apply changes job instance.",
"description": "> [!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\n## Required Delegated Scopes\n\n For dataflows APIs use these scope types: \n- Specific scope: Dataflow.Execute.All \n\n for more information about scopes, see: [scopes article](/rest/api/fabric/articles/scopes).\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
"description": "> [!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\n> [!NOTE]\n> The URL for this API has been updated to include the job type as part of the path, replacing the previous use of a query parameter. For backward compatibility, invocations using the query parameter are still supported.\n\n## Required Delegated Scopes\n\n For dataflows APIs use these scope types: \n- Specific scope: Dataflow.Execute.All \n\n for more information about scopes, see: [scopes article](/rest/api/fabric/articles/scopes).\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
"tags": [
"BackgroundJobs"
],
@@ -735,13 +728,6 @@
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "query",
"name": "jobType",
"description": "*ApplyChanges* job type.",
"type": "string",
"required": true
}
],
"responses": {
environment/examples/GetEnvironmentPreview.json
+1 -1
View File
@@ -2,7 +2,7 @@
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"environmentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
"preview": true
"beta": true
},
"responses": {
"200": {
environment/examples/GetEnvironmentSparkCompute.json
+1 -1
View File
@@ -2,7 +2,7 @@
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"environmentId": "707cfd07-cbf1-41da-aad7-dd157ddb8c11",
"preview": "false"
"beta": "false"
},
"responses": {
"200": {
environment/examples/GetEnvironmentSparkComputePreview.json
+1 -1
View File
@@ -2,7 +2,7 @@
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"environmentId": "707cfd07-cbf1-41da-aad7-dd157ddb8c11",
"preview": true
"beta": true
},
"responses": {
"200": {
environment/examples/GetPublishedLibraries.json
+1 -1
View File
@@ -2,7 +2,7 @@
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"environmentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
"preview": "false"
"beta": "false"
},
"responses": {
"200": {
environment/examples/GetPublishedLibrariesPreview.json
+1 -1
View File
@@ -2,7 +2,7 @@
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"environmentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
"preview": true
"beta": true
},
"responses": {
"200": {
environment/examples/GetStagingLibraries.json
+1 -1
View File
@@ -2,7 +2,7 @@
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"environmentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
"preview": "false"
"beta": "false"
},
"responses": {
"200": {
environment/examples/GetStagingLibrariesPreview.json
+1 -1
View File
@@ -2,7 +2,7 @@
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"environmentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
"preview": true
"beta": true
},
"responses": {
"200": {
environment/examples/PublishEnvironment.json
+1 -1
View File
@@ -2,7 +2,7 @@
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"environmentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
"preview": "false"
"beta": "false"
},
"responses": {
"200": {
environment/examples/PublishEnvironmentPreview.json
+1 -1
View File
@@ -2,7 +2,7 @@
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"environmentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
"preview": true
"beta": true
},
"responses": {
"200": {
environment/examples/UpdateEnvironmentSparkCompute.json
+1 -1
View File
@@ -2,7 +2,7 @@
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"environmentId": "707cfd07-cbf1-41da-aad7-dd157ddb8c11",
"preview": "false",
"beta": "false",
"updateEnvironmentSparkComputeRequest": {
"instancePool": {
"name": "MyWorkspacePool",
environment/examples/UpdateEnvironmentSparkComputeInstancePoolWithId.json
+1 -1
View File
@@ -2,7 +2,7 @@
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"environmentId": "707cfd07-cbf1-41da-aad7-dd157ddb8c11",
"preview": "false",
"beta": "false",
"updateEnvironmentSparkComputeRequest": {
"instancePool": {
"id": "78942136-106c-4f3e-80fc-7ff4eae11603"
environment/examples/UpdateEnvironmentSparkComputePreview.json
+1 -1
View File
@@ -2,7 +2,7 @@
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"environmentId": "707cfd07-cbf1-41da-aad7-dd157ddb8c11",
"preview": true,
"beta": true,
"updateEnvironmentSparkComputeRequest": {
"instancePool": {
"name": "MyWorkspacePool",
environment/swagger.json
+43 -43
View File
@@ -10,13 +10,13 @@
"host": "api.fabric.microsoft.com",
"basePath": "/v1",
"paths": {
"/workspaces/{workspaceId}/environments/{environmentId}/staging/sparkcompute?preview=true": {
"/workspaces/{workspaceId}/environments/{environmentId}/staging/sparkcompute?beta=true": {
"get": {
"tags": [
"Staging"
],
"summary": "Get environment staging spark compute.",
"description": "> [!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use. This preview API will be deprecated on **March 1, 2026**, and replaced by a stable version, available [here](/rest/api/fabric/environment/staging/get-spark-compute). The new version introduces breaking changes and is not backward compatible.\n**When calling this API, callers must specify `true` as the value for the query parameter `preview`.**\n\n## Deprecation Notice\n\nA new query parameter `preview` has been introduced to facilitate this transition:\n* The `preview` query parameter currently defaults to `true`.\n* Set the value of the `preview` query parameter to `false` to use the stable Release version of this API.\n* Starting March 1, 2026, the default value for `preview` will change to `false`.\n\nTo ensure compatibility, explicitly set the `preview` parameter to your desired value (`true` or `false`).\n\nIt is recommended to migrate your integration to use the Release version as soon as possible by specifying `false` for the `preview` query parameter (**the default value for the `preview` query parameter will be set to `false` on API's deprecation date**).\n\nThe following incompatible changes were introduced in the Release version:\n* Response property `sparkProperties`'s type was changed from `object` to the list of `SparkProperty`.\n\n## Permissions\n\nRead permission for the environment item. \n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All or Environment.Read.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"description": "> [!NOTE]\n> This API is part of a Beta release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use. This beta API will be deprecated on **March 1, 2026**, and replaced by a stable version, available [here](/rest/api/fabric/environment/staging/get-spark-compute). The new version introduces breaking changes and is not backward compatible.\n**When calling this API, callers must specify `true` as the value for the query parameter `beta` (`preview` query parameter has been replaced by `beta`. For backward compatibility, `beta` is still supported and behaves the same as `beta`).**\n\n## Deprecation Notice\n\nA new query parameter `beta` has been introduced to facilitate this transition:\n* The `beta` query parameter currently defaults to `true`.\n* Set the value of the `beta` query parameter to `false` to use the stable Release version of this API.\n* Starting March 1, 2026, the default value for `beta` will change to `false`.\n\nTo ensure compatibility, explicitly set the `beta` parameter to your desired value (`true` or `false`).\n\nIt is recommended to migrate your integration to use the Release version as soon as possible by specifying `false` for the `beta` query parameter (**the default value for the `beta` query parameter will be set to `false` on API's deprecation date**).\n\nThe following incompatible changes were introduced in the Release version:\n* Response property `sparkProperties`'s type was changed from `object` to the list of `SparkProperty`.\n\n## Permissions\n\nRead permission for the environment item. \n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All or Environment.Read.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"operationId": "Staging_Get_Spark_Compute_(preview)",
"produces": [
"application/json"
@@ -39,9 +39,9 @@
"format": "uuid"
},
{
"name": "preview",
"name": "beta",
"in": "query",
"description": "This parameter specifies which version of the API to use. Set to `true` to use the preview version described on this page, or to `false` to use the Release version detailed [here](/rest/api/fabric/environment/staging/get-spark-compute).\nStarting March 1, 2026, the default value for `preview` will change to `false`.",
"description": "This parameter specifies which version of the API to use. Set to `true` to use the beta version described on this page, or to `false` to use the Release version detailed [here](/rest/api/fabric/environment/staging/get-spark-compute).\nStarting March 1, 2026, the default value for `beta` will change to `false`.",
"required": true,
"type": "boolean",
"x-ms-deprecation": {
@@ -77,7 +77,7 @@
"Staging"
],
"summary": "Update environment staging spark compute. If you want to delete a spark property, set its value as null.",
"description": "> [!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use. This preview API will be deprecated on **March 1, 2026**, and replaced by a stable version, available [here](/rest/api/fabric/environment/staging/update-spark-compute). The new version introduces breaking changes and is not backward compatible.\n**When calling this API, callers must specify `true` as the value for the query parameter `preview`.**\n\n## Deprecation Notice\n\nA new query parameter `preview` has been introduced to facilitate this transition:\n* The `preview` query parameter currently defaults to `true`.\n* Set the value of the `preview` query parameter to `false` to use the stable Release version of this API.\n* Starting March 1, 2026, the default value for `preview` will change to `false`.\n\nTo ensure compatibility, explicitly set the `preview` parameter to your desired value (`true` or `false`).\n\nIt is recommended to migrate your integration to use the Release version as soon as possible by specifying `false` for the `preview` query parameter (**the default value for the `preview` query parameter will be set to `false` on API's deprecation date**).\n\nThe following incompatible changes were introduced in the Release version:\n* Request and response property `sparkProperties`'s type was changed from `object` to the list of `SparkProperty`.\n\n## Permissions\n\nWrite permission for the environment item. \n\n## Required Delegated Scopes\n\nItem.ReadWrite.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"description": "> [!NOTE]\n> This API is part of a Beta release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use. This beta API will be deprecated on **March 1, 2026**, and replaced by a stable version, available [here](/rest/api/fabric/environment/staging/update-spark-compute). The new version introduces breaking changes and is not backward compatible.\n**When calling this API, callers must specify `true` as the value for the query parameter `beta` (`preview` query parameter has been replaced by `beta`. For backward compatibility, `preview` is still supported and behaves the same as `beta`).**\n\n## Deprecation Notice\n\nA new query parameter `beta` has been introduced to facilitate this transition:\n* The `beta` query parameter currently defaults to `true`.\n* Set the value of the `beta` query parameter to `false` to use the stable Release version of this API.\n* Starting March 1, 2026, the default value for `beta` will change to `false`.\n\nTo ensure compatibility, explicitly set the `beta` parameter to your desired value (`true` or `false`).\n\nIt is recommended to migrate your integration to use the Release version as soon as possible by specifying `false` for the `beta` query parameter (**the default value for the `beta` query parameter will be set to `false` on API's deprecation date**).\n\nThe following incompatible changes were introduced in the Release version:\n* Request and response property `sparkProperties`'s type was changed from `object` to the list of `SparkProperty`.\n\n## Permissions\n\nWrite permission for the environment item. \n\n## Required Delegated Scopes\n\nItem.ReadWrite.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"operationId": "Staging_Update_Spark_Compute_(preview)",
"consumes": [
"application/json"
@@ -103,9 +103,9 @@
"format": "uuid"
},
{
"name": "preview",
"name": "beta",
"in": "query",
"description": "This parameter specifies which version of the API to use. Set to `true` to use the preview version described on this page, or to `false` to use the Release version detailed [here](/rest/api/fabric/environment/staging/update-spark-compute).\nStarting March 1, 2026, the default value for `preview` will change to `false`.",
"description": "This parameter specifies which version of the API to use. Set to `true` to use the beta version described on this page, or to `false` to use the Release version detailed [here](/rest/api/fabric/environment/staging/update-spark-compute).\nStarting March 1, 2026, the default value for `beta` will change to `false`.",
"required": true,
"type": "boolean",
"x-ms-deprecation": {
@@ -146,13 +146,13 @@
}
}
},
"/workspaces/{workspaceId}/environments/{environmentId}/sparkcompute?preview=true": {
"/workspaces/{workspaceId}/environments/{environmentId}/sparkcompute?beta=true": {
"get": {
"tags": [
"Published"
],
"summary": "Get environment spark compute.",
"description": "> [!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use. This preview API will be deprecated on **March 1, 2026**, and replaced by a stable version, available [here](/rest/api/fabric/environment/published/get-spark-compute). The new version introduces breaking changes and is not backward compatible.\n**When calling this API, callers must specify `true` as the value for the query parameter `preview`.**\n\n## Deprecation Notice\n\nA new query parameter `preview` has been introduced to facilitate this transition:\n* The `preview` query parameter currently defaults to `true`.\n* Set the value of the `preview` query parameter to `false` to use the stable Release version of this API.\n* Starting March 1, 2026, the default value for `preview` will change to `false`.\n\nTo ensure compatibility, explicitly set the `preview` parameter to your desired value (`true` or `false`).\n\nIt is recommended to migrate your integration to use the Release version as soon as possible by specifying `false` for the `preview` query parameter (**the default value for the `preview` query parameter will be set to `false` on API's deprecation date**).\n\nThe following incompatible changes were introduced in the Release version:\n* Response property `sparkProperties`'s type was changed from `object` to the list of `SparkProperty`.\n\n## Permissions\n\nRead permission for the environment item. \n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All or Environment.Read.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"description": "> [!NOTE]\n> This API is part of a Beta release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use. This beta API will be deprecated on **March 1, 2026**, and replaced by a stable version, available [here](/rest/api/fabric/environment/published/get-spark-compute). The new version introduces breaking changes and is not backward compatible.\n**When calling this API, callers must specify `true` as the value for the query parameter `beta` (`preview` query parameter has been replaced by `beta`. For backward compatibility, `preview` is still supported and behaves the same as `beta`).**\n\n## Deprecation Notice\n\nA new query parameter `beta` has been introduced to facilitate this transition:\n* The `beta` query parameter currently defaults to `true`.\n* Set the value of the `beta` query parameter to `false` to use the stable Release version of this API.\n* Starting March 1, 2026, the default value for `beta` will change to `false`.\n\nTo ensure compatibility, explicitly set the `beta` parameter to your desired value (`true` or `false`).\n\nIt is recommended to migrate your integration to use the Release version as soon as possible by specifying `false` for the `beta` query parameter (**the default value for the `beta` query parameter will be set to `false` on API's deprecation date**).\n\nThe following incompatible changes were introduced in the Release version:\n* Response property `sparkProperties`'s type was changed from `object` to the list of `SparkProperty`.\n\n## Permissions\n\nRead permission for the environment item. \n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All or Environment.Read.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"operationId": "Published_Get_Spark_Compute_(preview)",
"produces": [
"application/json"
@@ -175,9 +175,9 @@
"format": "uuid"
},
{
"name": "preview",
"name": "beta",
"in": "query",
"description": "This parameter specifies which version of the API to use. Set to `true` to use the preview version described on this page, or to `false` to use the Release version detailed [here](/rest/api/fabric/environment/published/get-spark-compute).\nStarting March 1, 2026, the default value for `preview` will change to `false`.",
"description": "This parameter specifies which version of the API to use. Set to `true` to use the beta version described on this page, or to `false` to use the Release version detailed [here](/rest/api/fabric/environment/published/get-spark-compute).\nStarting March 1, 2026, the default value for `beta` will change to `false`.",
"required": true,
"type": "boolean",
"x-ms-deprecation": {
@@ -209,13 +209,13 @@
}
}
},
"/workspaces/{workspaceId}/environments/{environmentId}/staging/sparkcompute?preview=false": {
"/workspaces/{workspaceId}/environments/{environmentId}/staging/sparkcompute?beta=false": {
"get": {
"tags": [
"Staging"
],
"summary": "Get environment staging spark compute.",
"description": "> [!NOTE]\n> This API is a release version of a preview version due to be deprecated on March 1, 2026.\n**When calling this API - callers must set the query parameter `preview` to the value `false`**.\n\n## Permissions\n\nRead permission for the environment item. \n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All or Environment.Read.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"description": "> [!NOTE]\n> This API is a release version of a beta version due to be deprecated on March 1, 2026.\n**When calling this API - callers must set the query parameter `beta` to the value `false`**.\n\n## Permissions\n\nRead permission for the environment item. \n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All or Environment.Read.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"operationId": "Staging_GetSparkCompute",
"produces": [
"application/json"
@@ -238,7 +238,7 @@
"format": "uuid"
},
{
"name": "preview",
"name": "beta",
"in": "query",
"description": "This parameter specifies which version of the API to use. Set to `false` to use the release version.",
"required": true,
@@ -276,7 +276,7 @@
"Staging"
],
"summary": "Update environment staging spark compute. If you want to delete a spark property, set its value as null.",
"description": "> [!NOTE]\n> This API is a release version of a preview version due to be deprecated on March 1, 2026.\n**When calling this API - callers must set the query parameter `preview` to the value `false`**\n\n## Permissions\n\nWrite permission for the environment item. \n\n## Required Delegated Scopes\n\nItem.ReadWrite.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"description": "> [!NOTE]\n> This API is a release version of a beta version due to be deprecated on March 1, 2026.\n**When calling this API - callers must set the query parameter `beta` to the value `false`**\n\n## Permissions\n\nWrite permission for the environment item. \n\n## Required Delegated Scopes\n\nItem.ReadWrite.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"operationId": "Staging_UpdateSparkCompute",
"consumes": [
"application/json"
@@ -302,7 +302,7 @@
"format": "uuid"
},
{
"name": "preview",
"name": "beta",
"in": "query",
"description": "This parameter specifies which version of the API to use. Set to `false` to use the release version.",
"required": true,
@@ -348,13 +348,13 @@
}
}
},
"/workspaces/{workspaceId}/environments/{environmentId}/sparkcompute?preview=false": {
"/workspaces/{workspaceId}/environments/{environmentId}/sparkcompute?beta=false": {
"get": {
"tags": [
"Published"
],
"summary": "Get environment spark compute.",
"description": "> [!NOTE]\n> This API is a release version of a preview version due to be deprecated on March 1, 2026.\n**When calling this API - callers must set the query parameter `preview` to the value `false`**\n\n## Permissions\n\nRead permission for the environment item. \n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All or Environment.Read.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"description": "> [!NOTE]\n> This API is a release version of a beta version due to be deprecated on March 1, 2026.\n**When calling this API - callers must set the query parameter `beta` to the value `false`**\n\n## Permissions\n\nRead permission for the environment item. \n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All or Environment.Read.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"operationId": "Published_GetSparkCompute",
"produces": [
"application/json"
@@ -377,7 +377,7 @@
"format": "uuid"
},
{
"name": "preview",
"name": "beta",
"in": "query",
"description": "This parameter specifies which version of the API to use. Set to `false` to use the release version.",
"required": true,
@@ -850,10 +850,10 @@
}
}
},
"/workspaces/{workspaceId}/environments/{environmentId}/staging/libraries?preview=false": {
"/workspaces/{workspaceId}/environments/{environmentId}/staging/libraries?beta=false": {
"get": {
"summary": "Get a list of libraries staged into environment.",
"description": "> [!NOTE]\n> This API is a release version of a preview version due to be deprecated on March 1, 2026.\n**When calling this API - callers must set the query parameter `preview` to the value `false`**\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\nRead permission for the environment item. \n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All or Environment.Read.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"description": "> [!NOTE]\n> This API is a release version of a beta version due to be deprecated on March 1, 2026.\n**When calling this API - callers must set the query parameter `beta` to the value `false`**\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\nRead permission for the environment item. \n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All or Environment.Read.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"tags": [
"Staging"
],
@@ -883,7 +883,7 @@
"format": "uuid"
},
{
"name": "preview",
"name": "beta",
"in": "query",
"description": "This parameter specifies which version of the API to use. Set to `false` to use the release version.",
"required": true,
@@ -927,7 +927,7 @@
"/workspaces/{workspaceId}/environments/{environmentId}/staging/libraries": {
"post": {
"summary": "Upload spark library into environment.",
"description": "> [!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use. This preview API will be deprecated on **March 1, 2026**, and replaced by a stable version, available [here](/rest/api/fabric/environment/staging/upload-custom-library).\nThe new version introduces breaking changes and is not backward compatible.**\n\n## Deprecation Notice\n\nIt is recommended to migrate your integration to use the Release version.\n\nThe following incompatible changes were introduced in the Release version:\n* The request URL structure has changed: the library name to be added is now specified directly in the URL path.\n* The request now supports `application/octet-stream` as `Content-Type` instead of `multipart/form-data`.\n\nThis API allows one file upload at a time. The supported file formats are .jar, .py, .whl, .tar.gz, or environment.yml.\n\n## Limitations\n\nThe maximum request size allowed is 100MB.\n\nNetwork issues may impact the upload size and may result in timeouts.\n\n## Content-Type\n\nThe library file needs to be upload using `Content-Type` as `multipart/form-data`.\n\n## Permissions\n\nWrite permission for the environment item. \n\n## Required Delegated Scopes\n\nEnvironment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"description": "> [!NOTE]\n> This API is part of a Beta release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use. This beta API will be deprecated on **March 1, 2026**, and replaced by a stable version, available [here](/rest/api/fabric/environment/staging/upload-custom-library).\nThe new version introduces breaking changes and is not backward compatible.**\n\n## Deprecation Notice\n\nIt is recommended to migrate your integration to use the Release version.\n\nThe following incompatible changes were introduced in the Release version:\n* The request URL structure has changed: the library name to be added is now specified directly in the URL path.\n* The request now supports `application/octet-stream` as `Content-Type` instead of `multipart/form-data`.\n\nThis API allows one file upload at a time. The supported file formats are .jar, .py, .whl, .tar.gz, or environment.yml.\n\n## Limitations\n\nThe maximum request size allowed is 100MB.\n\nNetwork issues may impact the upload size and may result in timeouts.\n\n## Content-Type\n\nThe library file needs to be upload using `Content-Type` as `multipart/form-data`.\n\n## Permissions\n\nWrite permission for the environment item. \n\n## Required Delegated Scopes\n\nEnvironment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"tags": [
"Staging"
],
@@ -975,7 +975,7 @@
},
"delete": {
"summary": "Deletes a library from environment. It supports deleting one file at a time.",
"description": "> [!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use. This preview API will be deprecated on **March 1, 2026**, and replaced by a stable version, available [here](/rest/api/fabric/environment/staging/delete-custom-library).\nThe new version introduces breaking changes and is not backward compatible.**\n\n## Deprecation Notice\n\nIt is recommended to migrate your integration to use the Release version.\n\nThe following incompatible changes were introduced in the Release version:\n* The request URL structure has changed: the library name to be removed is now specified directly in the URL path, rather than as a query parameter in the libraries collection.\n\n## Permissions\n\nWrite permission for the environment item. \n\n## Required Delegated Scopes\n\nEnvironment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"description": "> [!NOTE]\n> This API is part of a Beta release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use. This beta API will be deprecated on **March 1, 2026**, and replaced by a stable version, available [here](/rest/api/fabric/environment/staging/delete-custom-library).\nThe new version introduces breaking changes and is not backward compatible.**\n\n## Deprecation Notice\n\nIt is recommended to migrate your integration to use the Release version.\n\nThe following incompatible changes were introduced in the Release version:\n* The request URL structure has changed: the library name to be removed is now specified directly in the URL path, rather than as a query parameter in the libraries collection.\n\n## Permissions\n\nWrite permission for the environment item. \n\n## Required Delegated Scopes\n\nEnvironment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"tags": [
"Staging"
],
@@ -1026,10 +1026,10 @@
}
}
},
"/workspaces/{workspaceId}/environments/{environmentId}/staging/libraries?preview=true": {
"/workspaces/{workspaceId}/environments/{environmentId}/staging/libraries?beta=true": {
"get": {
"summary": "Get environment staging libraries.",
"description": "> [!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use. This preview API will be deprecated on **March 1, 2026**, and replaced by a stable version, available [here](/rest/api/fabric/environment/staging/list-libraries). The new version introduces breaking changes and is not backward compatible.\n**When calling this API, callers must specify `true` as the value for the query parameter `preview`.**\n\n## Deprecation Notice\n\nA new query parameter `preview` has been introduced to facilitate this transition:\n* The `preview` query parameter currently defaults to `true`.\n* Set the value of the `preview` query parameter to `false` to use the stable Release version of this API.\n* Starting March 1, 2026, the default value for `preview` will change to `false`.\n\nIt is recommended to migrate your integration to use the Release version as soon as possible by specifying `false` for the `preview` query parameter (**the default value for the `preview` query parameter will be set to `false` on API's deprecation date**).\n\nThe following incompatible changes were introduced in the Release version:\n* Different response format and schema structure\n* Enhanced library properties in the response\n* Updated field names and data types\n* Improved error handling and messages\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\nRead permission for the environment item. \n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All or Environment.Read.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"description": "> [!NOTE]\n> This API is part of a Beta release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use. This beta API will be deprecated on **March 1, 2026**, and replaced by a stable version, available [here](/rest/api/fabric/environment/staging/list-libraries). The new version introduces breaking changes and is not backward compatible.\n**When calling this API, callers must specify `true` as the value for the query parameter `beta` (`preview` query parameter has been replaced by `beta`. For backward compatibility, `preview` is still supported and behaves the same as `beta`).**\n\n## Deprecation Notice\n\nA new query parameter `beta` has been introduced to facilitate this transition:\n* The `beta` query parameter currently defaults to `true`.\n* Set the value of the `beta` query parameter to `false` to use the stable Release version of this API.\n* Starting March 1, 2026, the default value for `beta` will change to `false`.\n\nIt is recommended to migrate your integration to use the Release version as soon as possible by specifying `false` for the `beta` query parameter (**the default value for the `beta` query parameter will be set to `false` on API's deprecation date**).\n\nThe following incompatible changes were introduced in the Release version:\n* Different response format and schema structure\n* Enhanced library properties in the response\n* Updated field names and data types\n* Improved error handling and messages\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\nRead permission for the environment item. \n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All or Environment.Read.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"tags": [
"Staging"
],
@@ -1055,9 +1055,9 @@
"format": "uuid"
},
{
"name": "preview",
"name": "beta",
"in": "query",
"description": "This parameter specifies which version of the API to use. Set to `true` to use the preview version described on this page, or to `false` to use the Release version detailed [here](/rest/api/fabric/environment/staging/list-libraries).\nStarting March 1, 2026, the default value for `preview` will change to `false`.",
"description": "This parameter specifies which version of the API to use. Set to `true` to use the beta version described on this page, or to `false` to use the Release version detailed [here](/rest/api/fabric/environment/staging/list-libraries).\nStarting March 1, 2026, the default value for `beta` will change to `false`.",
"required": true,
"type": "boolean",
"x-ms-deprecation": {
@@ -1354,10 +1354,10 @@
}
}
},
"/workspaces/{workspaceId}/environments/{environmentId}/libraries?preview=false": {
"/workspaces/{workspaceId}/environments/{environmentId}/libraries?beta=false": {
"get": {
"summary": "Get environment published libraries.",
"description": "> [!NOTE]\n> This API is a release version of a preview version due to be deprecated on March 1, 2026.\n**When calling this API - callers must set the query parameter `preview` to the value `false`**\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\nRead permission for the environment item. \n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All or Environment.Read.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"description": "> [!NOTE]\n> This API is a release version of a beta version due to be deprecated on March 1, 2026.\n**When calling this API - callers must set the query parameter `beta` to the value `false` (`preview` query parameter has been replaced by `beta`. For backward compatibility, `preview` is still supported and behaves the same as `beta`)**\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\nRead permission for the environment item. \n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All or Environment.Read.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"tags": [
"Published"
],
@@ -1394,7 +1394,7 @@
"required": false
},
{
"name": "preview",
"name": "beta",
"in": "query",
"description": "This parameter specifies which version of the API to use. Set to `false` to use the release version.",
"required": true,
@@ -1428,10 +1428,10 @@
}
}
},
"/workspaces/{workspaceId}/environments/{environmentId}/libraries?preview=true": {
"/workspaces/{workspaceId}/environments/{environmentId}/libraries?beta=true": {
"get": {
"summary": "Get environment published libraries.",
"description": "> [!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use. This preview API will be deprecated on **March 1, 2026**, and replaced by a stable version, available [here](/rest/api/fabric/environment/published/list-libraries). The new version introduces breaking changes and is not backward compatible.\n**When calling this API, callers must specify `true` as the value for the query parameter `preview`.**\n\n## Deprecation Notice\n\nA new query parameter `preview` has been introduced to facilitate this transition:\n* The `preview` query parameter currently defaults to `true`.\n* Set the value of the `preview` query parameter to `false` to use the stable Release version of this API.\n* Starting March 1, 2026, the default value for `preview` will change to `false`.\n\nIt is recommended to migrate your integration to use the Release version as soon as possible by specifying `false` for the `preview` query parameter (**the default value for the `preview` query parameter will be set to `false` on API's deprecation date**).\n\nThe following incompatible changes were introduced in the Release version:\n* Different response format and schema structure\n* Enhanced library properties in the response\n* Updated field names and data types\n* Improved error handling and messages\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\nRead permission for the environment item. \n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All or Environment.Read.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"description": "> [!NOTE]\n> This API is part of a Beta release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use. This beta API will be deprecated on **March 1, 2026**, and replaced by a stable version, available [here](/rest/api/fabric/environment/published/list-libraries). The new version introduces breaking changes and is not backward compatible.\n**When calling this API, callers must specify `true` as the value for the query parameter `beta` (`preview` query parameter has been replaced by `beta`. For backward compatibility, `preview` is still supported and behaves the same as `beta`).**\n\n## Deprecation Notice\n\nA new query parameter `beta` has been introduced to facilitate this transition:\n* The `beta` query parameter currently defaults to `true`.\n* Set the value of the `beta` query parameter to `false` to use the stable Release version of this API.\n* Starting March 1, 2026, the default value for `beta` will change to `false`.\n\nIt is recommended to migrate your integration to use the Release version as soon as possible by specifying `false` for the `beta` query parameter (**the default value for the `beta` query parameter will be set to `false` on API's deprecation date**).\n\nThe following incompatible changes were introduced in the Release version:\n* Different response format and schema structure\n* Enhanced library properties in the response\n* Updated field names and data types\n* Improved error handling and messages\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\nRead permission for the environment item. \n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All or Environment.Read.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"tags": [
"Published"
],
@@ -1457,9 +1457,9 @@
"format": "uuid"
},
{
"name": "preview",
"name": "beta",
"in": "query",
"description": "This parameter specifies which version of the API to use. Set to `true` to use the preview version described on this page, or to `false` to use the Release version detailed [here](/rest/api/fabric/environment/published/list-libraries).\nStarting March 1, 2026, the default value for `preview` will change to `false`.",
"description": "This parameter specifies which version of the API to use. Set to `true` to use the beta version described on this page, or to `false` to use the Release version detailed [here](/rest/api/fabric/environment/published/list-libraries).\nStarting March 1, 2026, the default value for `beta` will change to `false`.",
"required": true,
"type": "boolean",
"x-ms-deprecation": {
@@ -1538,10 +1538,10 @@
}
}
},
"/workspaces/{workspaceId}/environments/{environmentId}/staging/publish?preview=false": {
"/workspaces/{workspaceId}/environments/{environmentId}/staging/publish?beta=false": {
"post": {
"summary": "Trigger an environment publish operation.",
"description": "> [!NOTE]\n> This API is a release version of a preview version due to be deprecated on March 1, 2026.\n**When calling this API - callers must set the query parameter `preview` to the value `false`**\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\nWrite permission for the environment item. \n\n## Required Delegated Scopes\n\nItem.ReadWrite.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"description": "> [!NOTE]\n> This API is a release version of a beta version due to be deprecated on March 1, 2026.\n**When calling this API - callers must set the query parameter `beta` to the value `false`**\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\nWrite permission for the environment item. \n\n## Required Delegated Scopes\n\nItem.ReadWrite.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"tags": [
"Items"
],
@@ -1568,7 +1568,7 @@
"format": "uuid"
},
{
"name": "preview",
"name": "beta",
"in": "query",
"description": "This parameter specifies which version of the API to use. Set to `false` to use the release version.",
"required": true,
@@ -1583,7 +1583,7 @@
],
"responses": {
"202": {
"description": "Request accepted, publish operation is in progress. Returns the GA contract when `preview=false` (default after March 1, 2026).",
"description": "Request accepted, publish operation is in progress. Returns the GA contract when `beta=false` (default after March 1, 2026).",
"headers": {
"Location": {
"description": "The URL of the operation status, which can be used to track the operation state.",
@@ -1620,10 +1620,10 @@
}
}
},
"/workspaces/{workspaceId}/environments/{environmentId}/staging/publish?preview=true": {
"/workspaces/{workspaceId}/environments/{environmentId}/staging/publish?beta=true": {
"post": {
"summary": "Trigger an environment publish operation.",
"description": "> [!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use. This preview API will be deprecated on **March 1, 2026**, and replaced by a stable version, available [here](/rest/api/fabric/environment/items/publish-environment). The new version introduces breaking changes and is not backward compatible.\n**When calling this API, callers must specify `true` as the value for the query parameter `preview`.**\n\n## Deprecation Notice\n\nA new query parameter `preview` has been introduced to facilitate this transition:\n* The `preview` query parameter currently defaults to `true`.\n* Set the value of the `preview` query parameter to `false` to use the stable Release version of this API.\n* Starting March 1, 2026, the default value for `preview` will change to `false`.\n\nIt is recommended to migrate your integration to use the Release version as soon as possible by specifying `false` for the `preview` query parameter (**the default value for the `preview` query parameter will be set to `false` on API's deprecation date**).\n\nThe following incompatible changes were introduced in the Release version:\n* Response is following [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation) pattern and HTTP response code 202 may be returned.\n\n## Permissions\n\nWrite permission for the environment item. \n\n## Required Delegated Scopes\n\nItem.ReadWrite.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"description": "> [!NOTE]\n> This API is part of a Beta release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use. This beta API will be deprecated on **March 1, 2026**, and replaced by a stable version, available [here](/rest/api/fabric/environment/items/publish-environment). The new version introduces breaking changes and is not backward compatible.\n**When calling this API, callers must specify `true` as the value for the query parameter `beta` (`preview` query parameter has been replaced by `beta`. For backward compatibility, `preview` is still supported and behaves the same as `beta`).**\n\n## Deprecation Notice\n\nA new query parameter `beta` has been introduced to facilitate this transition:\n* The `beta` query parameter currently defaults to `true`.\n* Set the value of the `beta` query parameter to `false` to use the stable Release version of this API.\n* Starting March 1, 2026, the default value for `beta` will change to `false`.\n\nIt is recommended to migrate your integration to use the Release version as soon as possible by specifying `false` for the `beta` query parameter (**the default value for the `beta` query parameter will be set to `false` on API's deprecation date**).\n\nThe following incompatible changes were introduced in the Release version:\n* Response is following [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation) pattern and HTTP response code 202 may be returned.\n\n## Permissions\n\nWrite permission for the environment item. \n\n## Required Delegated Scopes\n\nItem.ReadWrite.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"tags": [
"Items"
],
@@ -1649,9 +1649,9 @@
"format": "uuid"
},
{
"name": "preview",
"name": "beta",
"in": "query",
"description": "This parameter specifies which version of the API to use. Set to `true` to use the preview version described on this page, or to `false` to use the Release version detailed [here](/rest/api/fabric/environment/items/publish-environment).\nStarting March 1, 2026, the default value for `preview` will change to `false`.",
"description": "This parameter specifies which version of the API to use. Set to `true` to use the beta version described on this page, or to `false` to use the Release version detailed [here](/rest/api/fabric/environment/items/publish-environment).\nStarting March 1, 2026, the default value for `beta` will change to `false`.",
"required": true,
"type": "boolean",
"x-ms-deprecation": {
graphModel/definitions.json
+1 -20
View File
@@ -16,26 +16,7 @@
{
"$ref": "../common/definitions.json#/definitions/Item"
}
],
"properties": {
"properties": {
"description": "The GraphModel properties.",
"$ref": "#/definitions/GraphModelProperties"
}
}
},
"GraphModelProperties": {
"description": "The GraphModel properties.",
"type": "object",
"required": [
"oneLakeRootPath"
],
"properties": {
"oneLakeRootPath": {
"description": "OneLake path to the GraphModel root directory.",
"type": "string"
}
}
]
},
"GraphModels": {
"description": "A list of Public Facing Collection Names.",
graphModel/examples/ExecuteQuery.json
+1 -1
View File
@@ -5,7 +5,7 @@
"createQueryResultRequest": {
"query": "MATCH (node_station:`station`) RETURN TO_JSON_STRING(node_station) AS `station` LIMIT 10;"
},
"preview": true
"beta": true
},
"responses": {
"200": {
graphModel/examples/GetGraphModel.json
+1 -4
View File
@@ -10,10 +10,7 @@
"displayName": "GraphModel 1",
"description": "A GraphModel description.",
"type": "GraphModel",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"properties": {
"oneLakeRootPath": "https://onelake.dfs.fabric.microsoft.com/f089354e-8366-4e18-aea3-4cb4a3a50b48/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
}
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
}
}
}
graphModel/examples/GetQueryableGraphType.json
+1 -1
View File
@@ -2,7 +2,7 @@
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"GraphModelId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
"preview": true
"beta": true
},
"responses": {
"200": {
graphModel/examples/ListGraphModelsInWorkspace.json
+2 -8
View File
@@ -11,20 +11,14 @@
"displayName": "GraphModel Name 1",
"description": "A GraphModel description.",
"type": "GraphModel",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"properties": {
"oneLakeRootPath": "https://onelake.dfs.fabric.microsoft.com/f089354e-8366-4e18-aea3-4cb4a3a50b48/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
}
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
},
{
"id": "f697fb63-abd4-4399-9548-be7e3c3c0dac",
"displayName": "GraphModel Name 2",
"description": "A GraphModel description.",
"type": "GraphModel",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"properties": {
"oneLakeRootPath": "https://onelake.dfs.fabric.microsoft.com/f089354e-8366-4e18-aea3-4cb4a3a50b48/d8f6cf16-3aac-4440-9d76-a03d86b7ae3e"
}
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
}
]
}
graphModel/examples/RunOnDemandRefreshGraph.json
+1 -2
View File
@@ -1,8 +1,7 @@
{
"parameters": {
"workspaceId": "4b218778-e7a5-4d73-8187-f10824047715",
"GraphModelId": "431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
"jobType": "RefreshGraph"
"GraphModelId": "431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7"
},
"responses": {
"202": {
graphModel/swagger.json
+6 -6
View File
@@ -512,7 +512,7 @@
"/workspaces/{workspaceId}/GraphModels/{GraphModelId}/executeQuery": {
"post": {
"summary": "Executes a query on the specified graph model.",
"description": "> [!NOTE]\n> GraphModel item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n**When calling this API, callers must specify `true` as the value for the query parameter `preview`.**\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\n The caller must have a *viewer* workspace role. \n\n## Required Delegated Scopes\n\nWorkspace.Read.All or Workspace.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
"description": "> [!NOTE]\n> GraphModel item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n> This API is part of a Beta release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n**When calling this API, callers must specify `true` as the value for the query parameter `beta` (`preview` query parameter has been replaced by `beta`. For backward compatibility, `preview` is still supported and behaves the same as `beta`).**\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\n The caller must have a *viewer* workspace role. \n\n## Required Delegated Scopes\n\nWorkspace.Read.All or Workspace.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
"tags": [
"Items"
],
@@ -550,11 +550,11 @@
"required": true
},
{
"name": "preview",
"name": "beta",
"in": "query",
"required": true,
"type": "boolean",
"description": "This required parameter must be set to `true` to access this API, which is currently in preview."
"description": "This required parameter must be set to `true` to access this API, which is currently in beta."
}
],
"responses": {
@@ -582,7 +582,7 @@
"/workspaces/{workspaceId}/GraphModels/{GraphModelId}/getQueryableGraphType": {
"get": {
"summary": "Get the current queryable graph type.",
"description": "> [!NOTE]\n> GraphModel item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n**When calling this API, callers must specify `true` as the value for the query parameter `preview`.**\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\n The caller must have a *viewer* workspace role. \n The caller must have *read* permissions for the graph model. \n\n## Required Delegated Scopes\n\nWorkspace.Read.All or Workspace.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
"description": "> [!NOTE]\n> GraphModel item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n> This API is part of a Beta release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n**When calling this API, callers must specify `true` as the value for the query parameter `beta` (`preview` query parameter has been replaced by `beta`. For backward compatibility, `preview` is still supported and behaves the same as `beta`).**\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\n The caller must have a *viewer* workspace role. \n The caller must have *read* permissions for the graph model. \n\n## Required Delegated Scopes\n\nWorkspace.Read.All or Workspace.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
"tags": [
"Items"
],
@@ -608,11 +608,11 @@
"required": true
},
{
"name": "preview",
"name": "beta",
"in": "query",
"required": true,
"type": "boolean",
"description": "This required parameter must be set to `true` to access this API, which is currently in preview."
"description": "This required parameter must be set to `true` to access this API, which is currently in beta."
}
],
"responses": {
lakehouse/examples/GetSessionInItemId.json
+1 -8
View File
@@ -51,14 +51,7 @@
"capacityId": "3c0cd366-dc28-4b6d-a525-4d415a8666e7",
"operationName": "Batch Livy Run",
"runtimeVersion": "1.3",
"livySessionItemResourceUri": "",
"driverMemory": 4,
"driverCores": 2,
"executorMemory": 8,
"executorCores": 4,
"numExecutors": 10,
"isDynamicAllocationEnabled": true,
"dynamicAllocationMaxExecutors": 20
"livySessionItemResourceUri": ""
}
}
}
lakehouse/examples/ListSessionsInItemId.json
+1 -8
View File
@@ -54,14 +54,7 @@
"capacityId": "3c0cd366-dc28-4b6d-a525-4d415a8666e7",
"operationName": "Batch Livy Run",
"runtimeVersion": "1.3",
"livySessionItemResourceUri": "",
"driverMemory": 4,
"driverCores": 2,
"executorMemory": 8,
"executorCores": 4,
"numExecutors": 10,
"isDynamicAllocationEnabled": true,
"dynamicAllocationMaxExecutors": 20
"livySessionItemResourceUri": ""
}
]
}
lakehouse/examples/RunOnDemandRefreshMaterializedLakeViewsNoBody.json
+1 -2
View File
@@ -1,8 +1,7 @@
{
"parameters": {
"workspaceId": "4b218778-e7a5-4d73-8187-f10824047715",
"lakehouseId": "431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
"jobType": "RefreshMaterializedLakeViews"
"lakehouseId": "431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7"
},
"responses": {
"202": {
lakehouse/examples/RunOnDemandTableMaintenance1.json
-1
View File
@@ -2,7 +2,6 @@
"parameters": {
"workspaceId": "4b218778-e7a5-4d73-8187-f10824047715",
"lakehouseId": "431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
"jobType": "TableMaintenance",
"runOnDemandTableMaintenanceRequest": {
"executionData": {
"tableName": "table1",
lakehouse/examples/RunOnDemandTableMaintenance2.json
-1
View File
@@ -2,7 +2,6 @@
"parameters": {
"workspaceId": "4b218778-e7a5-4d73-8187-f10824047715",
"lakehouseId": "431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
"jobType": "TableMaintenance",
"runOnDemandTableMaintenanceRequest": {
"executionData": {
"tableName": "table1",
lakehouse/examples/RunOnDemandTableMaintenanceForSchemaEnabledLakehouse.json
-1
View File
@@ -2,7 +2,6 @@
"parameters": {
"workspaceId": "4b218778-e7a5-4d73-8187-f10824047715",
"lakehouseId": "431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
"jobType": "TableMaintenance",
"runOnDemandTableMaintenanceRequest": {
"executionData": {
"tableName": "table1",
lakehouse/swagger.json
+5 -117
View File
@@ -449,10 +449,10 @@
}
}
},
"/workspaces/{workspaceId}/lakehouses/{lakehouseId}/jobs/instances?jobType=TableMaintenance": {
"/workspaces/{workspaceId}/lakehouses/{lakehouseId}/jobs/TableMaintenance/instances": {
"post": {
"summary": "Run on-demand [table maintenance](/fabric/data-engineering/lakehouse-table-maintenance) job instance.",
"description": "> [!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\n## Required Delegated Scopes \n\nLakehouse.Execute.All or Item.Execute.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"description": "> [!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n> The URL for this API has been updated to include the job type as part of the path, replacing the previous use of a query parameter. For backward compatibility, invocations using the query parameter are still supported.\n\n## Required Delegated Scopes \n\nLakehouse.Execute.All or Item.Execute.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"tags": [
"BackgroundJobs"
],
@@ -477,13 +477,6 @@
"format": "uuid",
"required": true
},
{
"in": "query",
"name": "jobType",
"description": "*TableMaintenance* job type.",
"type": "string",
"required": true
},
{
"in": "body",
"name": "runOnDemandTableMaintenanceRequest",
@@ -599,7 +592,7 @@
"LivySessions"
],
"summary": "Returns a list of livy sessions from the specified item identifier.",
"description": "This API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\n The caller must have *read* permissions for the lakehouse. \n\n## Required Delegated Scopes \n\n Lakehouse.Read.All or Lakehouse.ReadWrite.All or Item.Read.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"description": "This API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\n The caller must have *viewer* or higher workspace role. \n\n## Required Delegated Scopes \n\n Lakehouse.Read.All or Lakehouse.ReadWrite.All or Item.Read.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"operationId": "LivySessions_ListLivySessions",
"x-ms-pageable": {
"nextLinkName": "continuationUri"
@@ -652,104 +645,6 @@
}
}
},
"/workspaces/{workspaceId}/lakehouses/{lakehouseId}/livySessions?preview=true": {
"get": {
"tags": [
"LivySessions"
],
"summary": "Returns a list of livy sessions from the specified item identifier (preview).",
"description": "[!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\n**When calling this API, callers must specify `true` as the value for the query parameter `preview`.**\n\n This API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\n The caller must have *read* permissions for the lakehouse. \n\n## Required Delegated Scopes \n\n Lakehouse.Read.All or Lakehouse.ReadWrite.All or Item.Read.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"operationId": "LivySessions_List_Livy_Sessions_(preview)",
"x-ms-pageable": {
"nextLinkName": "continuationUri"
},
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace identifier.",
"format": "uuid",
"type": "string",
"required": true
},
{
"in": "path",
"name": "lakehouseId",
"description": "The lakehouse ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "query",
"name": "preview",
"description": "This required parameter must be set to `true` to access this API, which is currently in preview.",
"type": "boolean",
"required": true
},
{
"in": "query",
"name": "submittedDateTime",
"description": "Submitted date time filter. Filter the sessions based on the submitted date time in UTC, using the YYYY-MM-DDTHH:mm:ssZ format.",
"type": "string",
"format": "date-time",
"required": false
},
{
"in": "query",
"name": "endDateTime",
"description": "Ended date time filter. Filter the sessions based on the ended date time in UTC, using the YYYY-MM-DDTHH:mm:ssZ format.",
"type": "string",
"format": "date-time",
"required": false
},
{
"in": "query",
"name": "submitter.Id",
"description": "The GUID value of the user who submitted the session.",
"type": "string",
"format": "uuid",
"required": false
},
{
"in": "query",
"name": "state",
"description": "The state of the session. Possible values are: `NotStarted`, `InProgress`, `Cancelled`, `Failed`, `Succeeded`, `Unknown`. This value maps to the `state` field in the response.",
"type": "string",
"required": false
},
{
"in": "query",
"name": "continuationToken",
"description": "Token to retrieve the next page of results, if available.",
"type": "string",
"required": false
}
],
"responses": {
"200": {
"description": "OK -- Returns a list of all livy sessions associated to an itemId.",
"schema": {
"$ref": "../common/spark_definitions.json#/definitions/LivySessions"
}
},
"default": {
"description": "Common error codes:\n\n* SparkCoreItemNotFound - Lakehouse identifier does not exist\n\n* SparkCoreUnexpectedException - Unhandled exception ocurred.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List all livy sessions (Preview) example": {
"$ref": "./examples/ListSessionsInItemId_preview.json"
}
}
}
},
"/workspaces/{workspaceId}/lakehouses/{lakehouseId}/livySessions/{livyId}": {
"get": {
"tags": [
@@ -806,10 +701,10 @@
}
}
},
"/workspaces/{workspaceId}/lakehouses/{lakehouseId}/jobs/instances?jobType=RefreshMaterializedLakeViews": {
"/workspaces/{workspaceId}/lakehouses/{lakehouseId}/jobs/RefreshMaterializedLakeViews/instances": {
"post": {
"summary": "Run on-demand [Refresh MaterializedLakeViews](/fabric/data-engineering/materialized-lake-views/refresh-materialized-lake-view) job instance.",
"description": "> [!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\n## Required Delegated Scopes\n\nLakehouse.Execute.All or Item.Execute.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
"description": "> [!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\n> [!NOTE]\n> The URL for this API has been updated to include the job type as part of the path, replacing the previous use of a query parameter. For backward compatibility, invocations using the query parameter are still supported.\n\n## Required Delegated Scopes\n\nLakehouse.Execute.All or Item.Execute.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
"tags": [
"BackgroundJobs"
],
@@ -833,13 +728,6 @@
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "query",
"name": "jobType",
"description": "*RefreshMaterializedLakeViews* job type.",
"type": "string",
"required": true
}
],
"responses": {
notebook/examples/GetSessionInItemId.json
+1 -8
View File
@@ -51,14 +51,7 @@
"capacityId": "3c0cd366-dc28-4b6d-a525-4d415a8666e7",
"operationName": "Batch Livy Run",
"runtimeVersion": "1.3",
"livySessionItemResourceUri": "",
"driverMemory": 4,
"driverCores": 2,
"executorMemory": 8,
"executorCores": 4,
"numExecutors": 10,
"isDynamicAllocationEnabled": true,
"dynamicAllocationMaxExecutors": 20
"livySessionItemResourceUri": ""
}
}
}
notebook/examples/ListSessionsInItemId.json
+1 -8
View File
@@ -54,14 +54,7 @@
"capacityId": "3c0cd366-dc28-4b6d-a525-4d415a8666e7",
"operationName": "Batch Livy Run",
"runtimeVersion": "1.3",
"livySessionItemResourceUri": "",
"driverMemory": 4,
"driverCores": 2,
"executorMemory": 8,
"executorCores": 4,
"numExecutors": 10,
"isDynamicAllocationEnabled": true,
"dynamicAllocationMaxExecutors": 20
"livySessionItemResourceUri": ""
}
]
}
notebook/swagger.json
+3 -101
View File
@@ -464,7 +464,7 @@
"LivySessions"
],
"summary": "Returns a list of livy sessions from the specified item identifier.",
"description": "This API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\n The caller must have *read* permissions for the notebook. \n\n## Required Delegated Scopes \n\n Notebook.Read.All or Notebook.ReadWrite.All or Item.Read.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"description": "This API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\n The caller must have *viewer* or higher workspace role. \n\n## Required Delegated Scopes \n\n Notebook.Read.All or Notebook.ReadWrite.All or Item.Read.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"operationId": "LivySessions_ListLivySessions",
"x-ms-pageable": {
"nextLinkName": "continuationUri"
@@ -494,7 +494,7 @@
"description": "Token to retrieve the next page of results, if available.",
"type": "string",
"required": false
}
}
],
"responses": {
"200": {
@@ -517,104 +517,6 @@
}
}
},
"/workspaces/{workspaceId}/notebooks/{notebookId}/livySessions?preview=true": {
"get": {
"tags": [
"LivySessions"
],
"summary": "Returns a list of livy sessions from the specified item identifier (preview).",
"description": "[!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\n**When calling this API, callers must specify `true` as the value for the query parameter `preview`.**\n\n This API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\n The caller must have *read* permissions for the notebook. \n\n## Required Delegated Scopes \n\n Notebook.Read.All or Notebook.ReadWrite.All or Item.Read.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"operationId": "LivySessions_List_Livy_Sessions_(preview)",
"x-ms-pageable": {
"nextLinkName": "continuationUri"
},
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace identifier.",
"format": "uuid",
"type": "string",
"required": true
},
{
"in": "path",
"name": "notebookId",
"description": "The notebook ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "query",
"name": "preview",
"description": "This required parameter must be set to `true` to access this API, which is currently in preview.",
"type": "boolean",
"required": true
},
{
"in": "query",
"name": "submittedDateTime",
"description": "Submitted date time filter. Filter the sessions based on the submitted date time in UTC, using the YYYY-MM-DDTHH:mm:ssZ format.",
"type": "string",
"format": "date-time",
"required": false
},
{
"in": "query",
"name": "endDateTime",
"description": "Ended date time filter. Filter the sessions based on the ended date time in UTC, using the YYYY-MM-DDTHH:mm:ssZ format.",
"type": "string",
"format": "date-time",
"required": false
},
{
"in": "query",
"name": "submitter.Id",
"description": "The GUID value of the user who submitted the session.",
"type": "string",
"format": "uuid",
"required": false
},
{
"in": "query",
"name": "state",
"description": "The state of the session. Possible values are: `NotStarted`, `InProgress`, `Cancelled`, `Failed`, `Succeeded`, `Unknown`. This value maps to the `state` field in the response.",
"type": "string",
"required": false
},
{
"in": "query",
"name": "continuationToken",
"description": "Token to retrieve the next page of results, if available.",
"type": "string",
"required": false
}
],
"responses": {
"200": {
"description": "OK -- Returns a list of all livy sessions associated to an itemId.",
"schema": {
"$ref": "../common/spark_definitions.json#/definitions/LivySessions"
}
},
"default": {
"description": "Common error codes:\n\n* SparkCoreItemNotFound - Notebook identifier does not exist\n\n* SparkCoreUnexpectedException - Unhandled exception ocurred.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List all livy sessions (Preview) example": {
"$ref": "./examples/ListSessionsInItemId_preview.json"
}
}
}
},
"/workspaces/{workspaceId}/notebooks/{notebookId}/livySessions/{livyId}": {
"get": {
"tags": [
@@ -622,7 +524,7 @@
],
"operationId": "LivySessions_GetLivySession",
"summary": "Returns properties of the specified livy session.",
"description": "## Permissions\n\n The caller must have *read* permissions for the notebook. \n\n## Required Delegated Scopes \n\n Notebook.Read.All or Notebook.ReadWrite.All or Item.Read.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"description": "## Permissions\n\n The caller must have *viewer* or higher workspace role. \n\n## Required Delegated Scopes \n\n Notebook.Read.All or Notebook.ReadWrite.All or Item.Read.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"produces": [
"application/json"
],
operationsAgent/definitions.json
+191
View File
@@ -0,0 +1,191 @@
{
"swagger": "2.0",
"info": {
"title": "OperationsAgent data types",
"version": "v1"
},
"paths": {},
"definitions": {
"OperationsAgent": {
"description": "A OperationsAgent object.",
"type": "object",
"required": ["type"],
"allOf": [
{
"$ref": "../common/definitions.json#/definitions/Item"
}
],
"properties": {
"properties": {
"description": "The OperationsAgent properties.",
"$ref": "#/definitions/OperationsAgentProperties"
}
}
},
"OperationsAgentProperties": {
"description": "The OperationsAgent properties.",
"type": "object",
"required": [
"state"
],
"properties": {
"state": {
"description": "The current state of the OperationsAgent. Additional AgentState values may be added over time.",
"type": "string",
"enum": [
"Active",
"Inactive"
],
"x-ms-enum": {
"name": "AgentState",
"modelAsString": true,
"values": [
{
"value": "Active",
"description": "The OperationsAgent is active and running."
},
{
"value": "Inactive",
"description": "The OperationsAgent is inactive and not running."
}
]
}
}
}
},
"OperationsAgents": {
"description": "A list of Operations Agents.",
"required": ["value"],
"type": "object",
"properties": {
"value": {
"description": "A list of Operations Agents.",
"type": "array",
"items": {
"$ref": "#/definitions/OperationsAgent"
}
}
},
"allOf": [
{
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
}
]
},
"CreateOperationsAgentRequest": {
"description": "Create OperationsAgent request payload.",
"required": ["displayName"],
"properties": {
"displayName": {
"description": "The OperationsAgent display name. The display name must follow naming rules according to item type.",
"type": "string",
"readOnly": false
},
"description": {
"description": "The OperationsAgent description. Maximum length is 256 characters.",
"type": "string",
"readOnly": false
},
"folderId": {
"description": "The folder ID. If not specified or null, the OperationsAgent is created with the workspace as its folder.",
"type": "string",
"format": "uuid",
"readOnly": false
},
"definition": {
"description": "The OperationsAgent public definition.",
"$ref": "#/definitions/OperationsAgentPublicDefinition",
"readOnly": false
}
}
},
"UpdateOperationsAgentDefinitionRequest": {
"description": "Update OperationsAgent public definition request payload.",
"required": ["definition"],
"properties": {
"definition": {
"$ref": "#/definitions/OperationsAgentPublicDefinition"
}
}
},
"OperationsAgentDefinitionResponse": {
"description": "OperationsAgent public definition response.",
"required": ["definition"],
"properties": {
"definition": {
"$ref": "#/definitions/OperationsAgentPublicDefinition",
"readOnly": true
}
}
},
"OperationsAgentPublicDefinition" : {
"description": "OperationsAgent public definition object. Refer to this [article](/rest/api/fabric/articles/item-management/definitions/operations-agent) for more details on how to craft a OperationsAgent public definition.",
"type": "object",
"required": ["parts"],
"properties": {
"format": {
"description": "The format of the item definition. Additional `format` types may be added over time.",
"type": "string",
"enum": [
"OperationsAgentV1"
],
"x-ms-enum": {
"name": "OperationsAgentDefinitionFormat",
"modelAsString": true,
"values": [
{
"value": "OperationsAgentV1",
"description": "The V1 json format for the OperationsAgent public definition, specifically designed to support CI/CD scenarios in Fabric. see [OperationsAgent - OperationsAgentV1 specification](/rest/api/fabric/articles/item-management/definitions/operations-agent/OperationsAgentV1) for more details."
}
]
},
"readOnly": false
},
"parts": {
"description": "A list of definition parts.",
"type": "array",
"items": {
"$ref": "#/definitions/OperationsAgentPublicDefinitionPart"
},
"readOnly": false
}
}
},
"OperationsAgentPublicDefinitionPart": {
"description": "OperationsAgent definition part object.",
"type": "object",
"properties": {
"path": {
"description": "The OperationsAgent public definition part path.",
"type": "string",
"readOnly": false
},
"payload": {
"description": "The OperationsAgent public definition part payload.",
"type": "string",
"readOnly": false
},
"payloadType":{
"description": "The payload type.",
"$ref": "../common/definitions.json#/definitions/PayloadType",
"readOnly": false
}
}
},
"UpdateOperationsAgentRequest": {
"description": "Update OperationsAgent request.",
"properties": {
"displayName": {
"description": "The OperationsAgent display name. The display name must follow naming rules according to item type.",
"type": "string",
"readOnly": false
},
"description": {
"description": "The OperationsAgent description. Maximum length is 256 characters.",
"type": "string",
"readOnly": false
}
}
}
}
}
operationsAgent/examples/CreateOperationsAgent.json
+42
View File
@@ -0,0 +1,42 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"createOperationsAgentRequest": {
"displayName": "OperationsAgent 1",
"description": "A OperationsAgent description.",
"definition": {
"format": "OperationsAgentV1",
"parts": [
{
"path": "OperationsAgentV1.json",
"payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
"payloadType": "InlineBase64"
},
{
"path": ".platform",
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
"payloadType": "InlineBase64"
}
]
}
}
},
"responses": {
"201": {
"body": {
"displayName": "OperationsAgent 1",
"description": "A OperationsAgent description.",
"type": "OperationsAgent",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"id": "5b218778-e7a5-4d73-8187-f10824047715"
}
},
"202": {
"headers": {
"Location": "https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6",
"x-ms-operation-id": "0acd697c-1550-43cd-b998-91bfbfbd47c6",
"Retry-After": 30
}
}
}
}
operationsAgent/examples/CreateOperationsAgentWithoutDefinition.json
+27
View File
@@ -0,0 +1,27 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"createOperationsAgentRequest": {
"displayName": "OperationsAgent 1",
"description": "A OperationsAgent description."
}
},
"responses": {
"201": {
"body": {
"displayName": "OperationsAgent 1",
"description": "A OperationsAgent description.",
"type": "OperationsAgent",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"id": "5b218778-e7a5-4d73-8187-f10824047715"
}
},
"202": {
"headers": {
"Location": "https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6",
"x-ms-operation-id": "0acd697c-1550-43cd-b998-91bfbfbd47c6",
"Retry-After": 30
}
}
}
}
operationsAgent/examples/DeleteOperationsAgent.json
+9
View File
@@ -0,0 +1,9 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"OperationsAgentId": "5b218778-e7a5-4d73-8187-f10824047715"
},
"responses": {
"200": {}
}
}
operationsAgent/examples/GetOperationsAgent.json
+20
View File
@@ -0,0 +1,20 @@
{
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"OperationsAgentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
},
"responses": {
"200": {
"body": {
"id": "5b218778-e7a5-4d73-8187-f10824047715",
"displayName": "OperationsAgent 1",
"description": "A OperationsAgent description.",
"type": "OperationsAgent",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"properties": {
"state": "Inactive"
}
}
}
}
}
operationsAgent/examples/GetOperationsAgentDefinition.json
+33
View File
@@ -0,0 +1,33 @@
{
"parameters": {
"workspaceId": "6e335e92-a2a2-4b5a-970a-bd6a89fbb765",
"OperationsAgentId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
},
"responses": {
"200": {
"body": {
"definition": {
"parts": [
{
"path": "OperationsAgentV1.json",
"payload": "ew0KICAiZXhlY3V0YW..OWRmNDhhY2ZmZTgifQ",
"payloadType": "InlineBase64"
},
{
"path": ".platform",
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
"payloadType": "InlineBase64"
}
]
}
}
},
"202": {
"headers": {
"Location": "https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
"x-ms-operation-id": "431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
"Retry-After": 30
}
}
}
}
operationsAgent/examples/ListOperationsAgentsInWorkspace.json
+33
View File
@@ -0,0 +1,33 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "3546052c-ae64-4526-b1a8-52af7761426f",
"displayName": "OperationsAgent Name 1",
"description": "A OperationsAgent description.",
"type": "OperationsAgent",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"properties": {
"state": "Inactive"
}
},
{
"id": "f697fb63-abd4-4399-9548-be7e3c3c0dac",
"displayName": "OperationsAgent Name 2",
"description": "A OperationsAgent description.",
"type": "OperationsAgent",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"properties": {
"state": "Inactive"
}
}
]
}
}
}
}
operationsAgent/examples/UpdateOperationsAgent.json
+21
View File
@@ -0,0 +1,21 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"OperationsAgentId": "5b218778-e7a5-4d73-8187-f10824047715",
"updateOperationsAgentRequest": {
"displayName": "OperationsAgent's New name",
"description": "OperationsAgent's New description"
}
},
"responses": {
"200": {
"body": {
"displayName": "OperationsAgent's New name",
"description": "OperationsAgent's New description",
"type": "OperationsAgent",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"id": "5b218778-e7a5-4d73-8187-f10824047715"
}
}
}
}
operationsAgent/examples/UpdateOperationsAgentDefinition.json
+34
View File
@@ -0,0 +1,34 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"OperationsAgentId": "5b218778-e7a5-4d73-8187-f10824047715",
"updateMetadata" : true,
"updateOperationsAgentDefinitionRequest": {
"definition": {
"parts": [
{
"path": "OperationsAgentV1.json",
"payload": "ew0KICAiZXhlY3V0YW..OWRmNDhhY2ZmZTgifQ==",
"payloadType": "InlineBase64"
},
{
"path": ".platform",
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
"payloadType": "InlineBase64"
}
]
}
}
},
"responses": {
"200": {
},
"202": {
"headers": {
"Location": "https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef",
"x-ms-operation-id": "427f6c34-b64e-4ee4-8ea5-b533c0e203ef",
"Retry-After": 30
}
}
}
}
operationsAgent/swagger.json
+469
View File
@@ -0,0 +1,469 @@
{
"swagger": "2.0",
"info": {
"title": "OperationsAgent REST APIs",
"version": "v1"
},
"schemes": [
"https"
],
"host": "api.fabric.microsoft.com",
"basePath": "/v1",
"paths": {
"/workspaces/{workspaceId}/OperationsAgents": {
"get": {
"summary": "Returns a list of OperationsAgents from the specified workspace.",
"description": "> [!NOTE]\n> OperationsAgent item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\n The caller must have a *viewer* workspace role. \n\n## Required Delegated Scopes\n\nWorkspace.Read.All or Workspace.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
"tags": [
"Items"
],
"operationId": "Items_ListOperationsAgents",
"x-ms-pageable": {
"nextLinkName": "continuationUri"
},
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "query",
"name": "continuationToken",
"description": "A token for retrieving the next page of results.",
"type": "string",
"required": false
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions.json#/definitions/OperationsAgents"
}
},
"default": {
"description": "Common error codes:\n\n* InvalidItemType - Invalid item type.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List OperationsAgents in workspace example": {
"$ref": "./examples/ListOperationsAgentsInWorkspace.json"
}
}
},
"post": {
"summary": "Creates a OperationsAgent in the specified workspace.",
"description": "> [!NOTE]\n> OperationsAgent item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n To create OperationsAgent with a definition, refer to [OperationsAgent](/rest/api/fabric/articles/item-management/definitions/operationsagent-definition) article. \n\n ## Permissions \n The caller must have a *contributor* workspace role. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All \n\n## Limitations \n- To create a OperationsAgent the workspace must be on a supported Fabric capacity. For more information see: [Microsoft Fabric license types](/fabric/enterprise/licenses#microsoft-fabric-license-types).\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
"tags": [
"Items"
],
"operationId": "Items_CreateOperationsAgent",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"x-ms-fabric-sdk-long-running-operation": true,
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "body",
"name": "createOperationsAgentRequest",
"description": "Create item request payload.",
"schema": {
"$ref": "./definitions.json#/definitions/CreateOperationsAgentRequest"
},
"required": true
}
],
"responses": {
"201": {
"description": "Successfully created",
"schema": {
"$ref": "./definitions.json#/definitions/OperationsAgent"
}
},
"202": {
"description": "Request accepted, OperationsAgent provisioning in progress.",
"headers": {
"Location": {
"description": "The URL of the operation status, which can be used to track the operation state.",
"type": "string"
},
"x-ms-operation-id": {
"description": "The operation ID which can be used with long running operations (LRO) APIs to track the operation state and get the result.",
"type": "string",
"format": "uuid"
},
"Retry-After": {
"type": "integer",
"description": "The number of seconds to wait before retrying the request."
}
}
},
"default": {
"description": "Common error codes:\n\n* InvalidItemType - Item type is invalid\n\n* ItemDisplayNameAlreadyInUse - Item display name is already used.\n\n* CorruptedPayload - The provided payload is corrupted.\n\n* WorkspaceItemsLimitExceeded - Workspace item limit exceeded.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Create a OperationsAgent example": {
"$ref": "./examples/CreateOperationsAgentWithoutDefinition.json"
},
"Create a OperationsAgent with public definition example": {
"$ref": "./examples/CreateOperationsAgent.json"
}
}
}
},
"/workspaces/{workspaceId}/OperationsAgents/{OperationsAgentId}": {
"get": {
"summary": "Returns properties of the specified OperationsAgent.",
"description": "> [!NOTE]\n> OperationsAgent item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\n## Permissions\n\n The caller must have *read* permissions for the OperationsAgent. \n\n## Required Delegated Scopes\n\n Item.Read.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
"tags": [
"Items"
],
"operationId": "Items_GetOperationsAgent",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "OperationsAgentId",
"description": "The OperationsAgent ID.",
"type": "string",
"format": "uuid",
"required": true
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions.json#/definitions/OperationsAgent"
}
},
"default": {
"description": "Common error codes:\n\n* ItemNotFound - The requested item was not found.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get a OperationsAgent example": {
"$ref": "./examples/GetOperationsAgent.json"
}
}
},
"patch": {
"summary": "Updates the properties of the specified OperationsAgent.",
"description": "> [!NOTE]\n> OperationsAgent item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\n## Permissions\n\n The caller must have *read and write* permissions for the OperationsAgent.\n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
"tags": [
"Items"
],
"operationId": "Items_UpdateOperationsAgent",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "OperationsAgentId",
"description": "The OperationsAgent ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "body",
"name": "updateOperationsAgentRequest",
"description": "Update OperationsAgent request payload.",
"schema": {
"$ref": "./definitions.json#/definitions/UpdateOperationsAgentRequest"
},
"required": true
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions.json#/definitions/OperationsAgent"
}
},
"default": {
"description": "Common error codes:\n\n* ItemNotFound - The requested item was not found. \n\n* InvalidRequest - Invalid update request.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Update a OperationsAgent example": {
"$ref": "./examples/UpdateOperationsAgent.json"
}
}
},
"delete": {
"summary": "Deletes the specified OperationsAgent.",
"description": "> [!NOTE]\n> OperationsAgent item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\n## Permissions\n\n The caller must have *write* permissions for the OperationsAgent. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
"tags": [
"Items"
],
"operationId": "Items_DeleteOperationsAgent",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "OperationsAgentId",
"description": "The OperationsAgent ID.",
"type": "string",
"format": "uuid",
"required": true
}
],
"responses": {
"200": {
"description": "Request completed successfully."
},
"default": {
"description": "Common error codes:\n\n* ItemNotFound - The requested item was not found.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete a OperationsAgent example": {
"$ref": "./examples/DeleteOperationsAgent.json"
}
}
}
},
"/workspaces/{workspaceId}/OperationsAgents/{OperationsAgentId}/getDefinition": {
"post": {
"summary": "Returns the specified OperationsAgent public definition.",
"description": "> [!NOTE]\n> OperationsAgent item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a OperationsAgent's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the OperationsAgent. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
"tags": [
"Items"
],
"operationId": "Items_GetOperationsAgentDefinition",
"produces": [
"application/json"
],
"x-ms-fabric-sdk-long-running-operation": true,
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "OperationsAgentId",
"description": "The OperationsAgent ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "query",
"name": "format",
"description": "The format of the OperationsAgent public definition. Additional `format` types may be added over time.",
"type": "string",
"enum": [
"OperationsAgentV1"
],
"x-ms-enum": {
"name": "OperationsAgentDefinitionFormat",
"modelAsString": true,
"values": [
{
"value": "OperationsAgentV1",
"description": "Custom format for the OperationsAgent public definition, specifically designed to support CI/CD scenarios in Fabric. see [OperationsAgent - OperationsAgentV1 specification](/rest/api/fabric/articles/item-management/definitions/operations-agent/operationsagentv1) for more details."
}
]
},
"required": false
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions.json#/definitions/OperationsAgentDefinitionResponse"
}
},
"202": {
"description": "Request accepted. Retrieving the definition is in progress.",
"headers": {
"Location": {
"description": "The URL of the operation status, which can be used to track the operation state.",
"type": "string"
},
"x-ms-operation-id": {
"description": "The operation ID which can be used with long running operations (LRO) APIs to track the operation state and get the result.",
"type": "string",
"format": "uuid"
},
"Retry-After": {
"type": "integer",
"description": "The number of seconds to wait before retrying the request."
}
}
},
"default": {
"description": "Common error codes:\n\n* OperationNotSupportedForItem - Operation not supported for requested item.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get a OperationsAgent public definition example": {
"$ref": "./examples/GetOperationsAgentDefinition.json"
}
}
}
},
"/workspaces/{workspaceId}/OperationsAgents/{OperationsAgentId}/updateDefinition": {
"post": {
"summary": "Overrides the definition for the specified OperationsAgent.",
"description": "> [!NOTE]\n> OperationsAgent item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n \nUpdating the OperationsAgent's definition, does not affect its sensitivity label. \n\n## Permissions\n\n The caller must have *read and write* permissions for the OperationsAgent. \n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
"tags": [
"Items"
],
"operationId": "Items_UpdateOperationsAgentDefinition",
"produces": [
"application/json"
],
"x-ms-fabric-sdk-long-running-operation": true,
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "OperationsAgentId",
"description": "The OperationsAgent ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "query",
"name": "updateMetadata",
"description": "When set to true and the .platform file is provided as part of the definition, the item's metadata is updated using the metadata in the .platform file",
"type": "boolean",
"required": false
},
{
"in": "body",
"name": "updateOperationsAgentDefinitionRequest",
"description": "Update OperationsAgent definition request payload.",
"schema": {
"$ref": "./definitions.json#/definitions/UpdateOperationsAgentDefinitionRequest"
},
"required": true
}
],
"responses": {
"200": {
"description": "Request completed successfully."
},
"202": {
"description": "Request accepted. Update definition is in progress.",
"headers": {
"Location": {
"description": "The URL of the operation status, which can be used to track the operation state.",
"type": "string"
},
"x-ms-operation-id": {
"description": "The operation ID which can be used with long running operations (LRO) APIs to track the operation state and get the result.",
"type": "string",
"format": "uuid"
},
"Retry-After": {
"type": "integer",
"description": "The number of seconds to wait before retrying the request."
}
}
},
"default": {
"description": "Common error codes:\n\n* OperationNotSupportedForItem - Operation not supported for requested item. \n\n* CorruptedPayload - The provided payload is corrupted.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Update a OperationsAgent public definition example": {
"$ref": "./examples/UpdateOperationsAgentDefinition.json"
}
}
}
}
},
"responses": {},
"security": [],
"tags": []
}
platform/definitions/platform.json
+37 -2
View File
@@ -1127,7 +1127,7 @@
"type": "string"
},
"target": {
"description": "An object that contains the target datasource, and it must specify exactly one of the supported destinations: OneLake, Amazon S3, ADLS Gen2, Google Cloud Storage, S3 compatible, Dataverse or Azure Blob storage.",
"description": "An object that contains the target datasource, and it must specify exactly one of the supported destinations: OneLake, Amazon S3, ADLS Gen2, Google Cloud Storage, S3 compatible, Dataverse, Azure Blob storage or OneDrive SharePoint.",
"type": "object",
"$ref": "#/definitions/CreatableShortcutTarget"
}
@@ -1325,6 +1325,11 @@
"description": "An object containing the properties of the target Azure Blob Storage data source.",
"type": "object",
"$ref": "#/definitions/AzureBlobStorage"
},
"oneDriveSharePoint": {
"description": "An object containing the properties of the target OneDrive for Business & SharePoint Online data source.",
"type": "object",
"$ref": "#/definitions/OneDriveSharePoint"
}
}
},
@@ -1336,7 +1341,7 @@
"type": {
"description": "The type object contains properties like target shortcut account type. Additional types may be added over time.",
"type": "string",
"enum": [ "OneLake", "AmazonS3", "AdlsGen2", "GoogleCloudStorage", "S3Compatible", "Dataverse", "ExternalDataShare", "AzureBlobStorage" ],
"enum": [ "OneLake", "AmazonS3", "AdlsGen2", "GoogleCloudStorage", "S3Compatible", "Dataverse", "ExternalDataShare", "AzureBlobStorage", "OneDriveSharePoint" ],
"x-ms-enum": {
"name": "Type",
"modelAsString": true,
@@ -1372,6 +1377,10 @@
{
"value": "AzureBlobStorage",
"description": "AzureBlobStorage"
},
{
"value": "OneDriveSharePoint",
"description": "OneDriveSharePoint"
}
]
}
@@ -1415,6 +1424,11 @@
"description": "An object containing the properties of the target Azure Blob Storage data source.",
"type": "object",
"$ref": "#/definitions/AzureBlobStorage"
},
"oneDriveSharePoint": {
"description": "An object containing the properties of the target OneDrive for Business & SharePoint Online data source.",
"type": "object",
"$ref": "#/definitions/OneDriveSharePoint"
}
}
},
@@ -1578,6 +1592,27 @@
}
}
},
"OneDriveSharePoint": {
"description": "An object containing the properties of the target OneDrive for Business or SharePoint Online data source.",
"type": "object",
"required": [ "location", "subpath", "connectionId" ],
"properties": {
"location": {
"description": "Specifies the location of the target OneDrive SharePoint container. The URI must be in the format `https://microsoft.sharepoint.com` which is the path of the target OneDrive SharePoint account.",
"type": "string",
"format": "uri"
},
"subpath": {
"description": "Specifies the container and subfolder within the OneDrive SharePoint account where the target folder is located. Must be of the format [container]/[subfolder]. [Container] is the name of the container that holds the files and folders. [Subfolder] is the name of the subfolder within the container and is optional. For example: /mycontainer/mysubfolder",
"type": "string"
},
"connectionId": {
"description": "A string representing the connection that is bound with the shortcut. The connectionId is a unique identifier used to establish a connection between the shortcut and the target datasource. To find this connection ID, first [create a cloud connection](/fabric/data-factory/data-source-management#add-a-data-source) to be used by the shortcut when connecting to the OneDrive SharePoint data location. Open the cloud connection's settings view and copy the GUID that is the connection ID.",
"type": "string",
"format": "uuid"
}
}
},
"ExternalDataShareTarget": {
"description": "An object containing the properties of the target external data share.",
"type": "object",
platform/examples/platform/CreateShortcutOneDriveSharePointTarget.json
+36
View File
@@ -0,0 +1,36 @@
{
"parameters": {
"workspaceId": "bf94607f-3ba1-4a95-8259-27649ccd7755",
"itemId": "884e71cd-f5b4-45f9-8e00-b71355f7ea5d",
"createShortcutRequest": {
"path": "Files",
"name": "MyOneDriveSharePoint",
"target": {
"oneDriveSharePoint": {
"location": "https://microsoft.sharepoint.com",
"subpath": "/Shared Documents/Test Folder",
"connectionId": "97e33458-1353-4911-96b1-6f4f4bbfd335"
}
}
}
},
"responses": {
"201": {
"headers": {
"Location": "https://api.fabric.microsoft.com/v1/workspaces/bf94607f-3ba1-4a95-8259-27649ccd7755/items/884e71cd-f5b4-45f9-8e00-b71355f7ea5d/shortcuts/Files/MyOneDriveSharePoint"
},
"body": {
"path": "Files",
"name": "MyOneDriveSharePoint",
"target": {
"type": "OneDriveSharePoint",
"oneDriveSharePoint": {
"location": "https://microsoft.sharepoint.com",
"subpath": "/Shared Documents/Test Folder",
"connectionId": "97e33458-1353-4911-96b1-6f4f4bbfd335"
}
}
}
}
}
}
platform/examples/platform/GetShortcutOneDriveSharePointTarget.json
+24
View File
@@ -0,0 +1,24 @@
{
"parameters": {
"workspaceId": "bf94607f-3ba1-4a95-8259-27649ccd7755",
"itemId": "884e71cd-f5b4-45f9-8e00-b71355f7ea5d",
"shortcutPath": "Files",
"shortcutName": "MyOneDriveSharePoint"
},
"responses": {
"200": {
"body": {
"path": "Files",
"name": "MyOneDriveSharePoint",
"target": {
"type": "OneDriveSharePoint",
"oneDriveSharePoint": {
"connectionId": "97e33458-1353-4911-96b1-6f4f4bbfd335",
"location": "https://microsoft.sharepoint.com",
"subpath": "/Shared Documents/Test Folder"
}
}
}
}
}
}
platform/examples/platform/RunOnDemandItemJob.json
+2 -2
View File
@@ -1,8 +1,8 @@
{
"parameters": {
"workspaceId": "4b218778-e7a5-4d73-8187-f10824047715",
"itemId": "431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
"jobType": "DefaultJob"
"jobType": "DefaultJob",
"itemId": "431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7"
},
"responses": {
"202": {
platform/swagger.json
+11 -3
View File
@@ -1462,10 +1462,12 @@
"$ref": "./examples/platform/ListItemJobInstancesWithContinuation.json"
}
}
},
}
},
"/workspaces/{workspaceId}/items/{itemId}/jobs/{jobType}/instances": {
"post": {
"summary": "Run on-demand item job instance.",
"description": "## Required Delegated Scopes\n\n For item APIs use these scope types: \n- Generic scope: Item.Execute.All \n- Specific scope: *itemType*.Execute.All (for example: Notebook.Execute.All) \n\n for more information about scopes, see: [scopes article](/rest/api/fabric/articles/scopes).\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"description": "> [!NOTE]\n> The URL for this API has been updated to include the job type as part of the path, replacing the previous use of a query parameter. For backward compatibility, invocations using the query parameter are still supported.\n\n ## Required Delegated Scopes\n\n For item APIs use these scope types: \n- Generic scope: Item.Execute.All \n- Specific scope: *itemType*.Execute.All (for example: Notebook.Execute.All) \n\n for more information about scopes, see: [scopes article](/rest/api/fabric/articles/scopes).\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"tags": [
"JobScheduler"
],
@@ -1491,7 +1493,7 @@
"required": true
},
{
"in": "query",
"in": "path",
"name": "jobType",
"description": "Job type",
"type": "string",
@@ -2784,6 +2786,9 @@
"Create shortcut Azure Blob Storage target example": {
"$ref": "./examples/platform/CreateShortcutAzureBlobStorageTarget.json"
},
"Create shortcut OneDriveSharePoint or OneDrive for Business or SharePoint Online target example": {
"$ref": "./examples/platform/CreateShortcutOneDriveSharePointTarget.json"
},
"Create or update shortcut target to OneLake": {
"$ref": "./examples/platform/CreateOrOverwriteShortcutOneLakeTarget.json"
},
@@ -2868,6 +2873,9 @@
},
"Get shortcut transform with One Lake target example": {
"$ref": "./examples/platform/GetShortcutTransformOneLakeTarget.json"
},
"Get shortcut OneDriveSharePoint or OneDrive for Business or SharePoint Online target example": {
"$ref": "./examples/platform/GetShortcutOneDriveSharePointTarget.json"
}
}
},
snowflakeDatabase/definitions.json
+272
View File
@@ -0,0 +1,272 @@
{
"swagger": "2.0",
"info": {
"title": "SnowflakeDatabase data types",
"version": "v1"
},
"paths": {},
"definitions": {
"SnowflakeDatabases": {
"description": "A list of Snowflake Databases.",
"required": [
"value"
],
"type": "object",
"properties": {
"value": {
"description": "A list of Snowflake Databases.",
"type": "array",
"items": {
"$ref": "#/definitions/SnowflakeDatabase"
}
}
},
"allOf": [
{
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
}
]
},
"SnowflakeDatabase": {
"description": "A Snowflake Database item.",
"type": "object",
"required": [
"type"
],
"allOf": [
{
"$ref": "../common/definitions.json#/definitions/Item"
}
],
"properties": {
"properties": {
"description": "The Snowflake Database properties.",
"$ref": "#/definitions/SnowflakeDatabaseProperties"
}
}
},
"SnowflakeDatabaseProperties": {
"description": "The Snowflake Database properties.",
"type": "object",
"properties": {
"snowflakeAccountURL": {
"description": "The Snowflake account URL.",
"type": "string"
},
"snowflakeDatabaseName": {
"description": "The Snowflake database name.",
"type": "string"
},
"connectionId": {
"description": "The connection ID for the Snowflake Database.",
"type": "string",
"format": "uuid"
},
"onelakeTablesPath": {
"description": "OneLake path to the Snowflake Database tables directory.",
"type": "string"
},
"snowflakeVolumePath": {
"description": "OneLake path to the Snowflake Database files directory.",
"type": "string"
},
"defaultSchema": {
"description": "The default schema name for the Snowflake Database.",
"type": "string"
},
"sqlEndpointProperties": {
"description": "An object containing the properties of the SQL endpoint.",
"$ref": "#/definitions/SqlEndpointProperties"
}
}
},
"SqlEndpointProperties": {
"required": [
"id",
"connectionString",
"provisioningStatus"
],
"description": "An object containing the properties of the SQL endpoint.",
"type": "object",
"properties": {
"id": {
"description": "SQL endpoint ID.",
"type": "string"
},
"connectionString": {
"description": "SQL endpoint connection string.",
"type": "string"
},
"provisioningStatus": {
"description": "SQL endpoint provisioning status. Additional statuses may be added over time.",
"type": "string",
"enum": [
"NotStarted",
"InProgress",
"Success",
"Failed"
],
"x-ms-enum": {
"name": "ProvisioningStatus",
"modelAsString": true,
"values": [
{
"value": "NotStarted",
"description": "The SQL endpoint provisioning is not started yet"
},
{
"value": "InProgress",
"description": "The SQL endpoint provisioning is currently in progress."
},
{
"value": "Success",
"description": "The SQL endpoint has been successfully provisioned."
},
{
"value": "Failed",
"description": "The SQL endpoint provisioning has failed."
}
]
}
}
}
},
"CreateSnowflakeDatabaseRequest": {
"description": "Request payload for creating a Snowflake Database.",
"type": "object",
"required": [
"displayName"
],
"properties": {
"displayName": {
"description": "The display name of the Snowflake Database.",
"type": "string"
},
"description": {
"description": "The description of the Snowflake Database.",
"type": "string"
},
"type": {
"description": "The type of the item. Additional types may be added over time.",
"type": "string",
"enum": [
"SnowflakeDatabase"
],
"x-ms-enum": {
"name": "SnowflakeDatabaseItemType",
"modelAsString": true,
"values": [
{
"value": "SnowflakeDatabase",
"description": "The Snowflake Database item type."
}
]
}
},
"creationPayload": {
"description": "The creation payload for the Snowflake Database.",
"$ref": "#/definitions/SnowflakeDatabaseCreationPayload"
},
"definition": {
"description": "The definition for the Snowflake Database.",
"$ref": "#/definitions/SnowflakeDatabaseDefinition"
}
}
},
"SnowflakeDatabaseCreationPayload": {
"description": "The creation payload for the Snowflake Database.",
"type": "object",
"properties": {
"snowflakeDatabaseName": {
"description": "The Snowflake database name.",
"type": "string"
},
"connectionId": {
"description": "The connection ID for the Snowflake Database.",
"type": "string",
"format": "uuid"
}
}
},
"UpdateSnowflakeDatabaseRequest": {
"description": "Request payload for updating a Snowflake Database.",
"type": "object",
"properties": {
"displayName": {
"description": "The display name of the Snowflake Database.",
"type": "string"
},
"description": {
"description": "The description of the Snowflake Database.",
"type": "string"
}
}
},
"UpdateSnowflakeDatabaseDefinitionRequest": {
"description": "Update Snowflake Database public definition request payload.",
"required": [
"definition"
],
"properties": {
"definition": {
"$ref": "#/definitions/SnowflakeDatabaseDefinition"
}
}
},
"SnowflakeDatabaseDefinitionResponse": {
"description": "Snowflake Database public definition response.",
"required": [
"definition"
],
"properties": {
"definition": {
"$ref": "#/definitions/SnowflakeDatabaseDefinition",
"readOnly": true
}
}
},
"SnowflakeDatabaseDefinition": {
"description": "Snowflake Database public definition object.",
"type": "object",
"required": [
"parts"
],
"properties": {
"format": {
"description": "The format of the item definition.",
"type": "string",
"readOnly": false
},
"parts": {
"description": "A list of definition parts.",
"type": "array",
"items": {
"$ref": "#/definitions/SnowflakeDatabaseDefinitionPart"
},
"readOnly": false
}
}
},
"SnowflakeDatabaseDefinitionPart": {
"description": "Snowflake Database definition part object.",
"type": "object",
"properties": {
"path": {
"description": "The Snowflake Database part path.",
"type": "string",
"readOnly": false
},
"payload": {
"description": "The Snowflake Database part payload.",
"type": "string",
"readOnly": false
},
"payloadType": {
"description": "The payload type.",
"$ref": "../common/definitions.json#/definitions/PayloadType",
"readOnly": false
}
}
}
}
}
snowflakeDatabase/examples/CreateSnowflakeDatabaseWithDefinition.json
+37
View File
@@ -0,0 +1,37 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"createSnowflakeDatabaseRequest": {
"displayName": "My Database",
"description": "This is an example Snowflake Database item.",
"type": "SnowflakeDatabase",
"definition": {
"parts": [
{
"path": "SnowflakeDatabaseProperties.json",
"payload": "eyJzbm93Zmxha2VEYXRhYmFzZU5hbWUiOiAiRXhhbXBsZURhdGFiYXNlIiwgImNvbm5lY3Rpb25JZCI6ICI0NTZlNzg5MC1lODliLTEyZDMtYTQ1Ni00MjY2MTQxNzQwMDIifQ==",
"payloadType": "InlineBase64"
}
]
}
}
},
"responses": {
"201": {
"body": {
"description": "This is an example Snowflake Database item.",
"displayName": "My Database",
"id": "123e4567-e89b-12d3-a456-426614174001",
"type": "SnowflakeDatabase",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
}
},
"202": {
"headers": {
"Location": "https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6",
"x-ms-operation-id": "0acd697c-1550-43cd-b998-91bfbfbd47c6",
"Retry-After": 30
}
}
}
}
snowflakeDatabase/examples/CreateSnowflakeDatabaseWithPayload.json
+32
View File
@@ -0,0 +1,32 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"createSnowflakeDatabaseRequest": {
"displayName": "My Database",
"description": "This is an example Snowflake Database item.",
"type": "SnowflakeDatabase",
"creationPayload": {
"snowflakeDatabaseName": "ExampleDatabase",
"connectionId": "456e7890-e89b-12d3-a456-426614174002"
}
}
},
"responses": {
"201": {
"body": {
"description": "This is an example Snowflake Database item.",
"displayName": "My Database",
"id": "123e4567-e89b-12d3-a456-426614174001",
"type": "SnowflakeDatabase",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
}
},
"202": {
"headers": {
"Location": "https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6",
"x-ms-operation-id": "0acd697c-1550-43cd-b998-91bfbfbd47c6",
"Retry-After": 30
}
}
}
}
snowflakeDatabase/examples/CreateSnowflakeDatabaseWithoutPayload.json
+27
View File
@@ -0,0 +1,27 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"createSnowflakeDatabaseRequest": {
"displayName": "My Database",
"description": "This is an example Snowflake Database item without creation payload."
}
},
"responses": {
"201": {
"body": {
"description": "This is an example Snowflake Database item without creation payload.",
"displayName": "My Database",
"id": "123e4567-e89b-12d3-a456-426614174001",
"type": "SnowflakeDatabase",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
}
},
"202": {
"headers": {
"Location": "https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6",
"x-ms-operation-id": "0acd697c-1550-43cd-b998-91bfbfbd47c6",
"Retry-After": 30
}
}
}
}
snowflakeDatabase/examples/DeleteSnowflakeDatabase.json
+9
View File
@@ -0,0 +1,9 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"snowflakeDatabaseId": "123e4567-e89b-12d3-a456-426614174001"
},
"responses": {
"200": {}
}
}
snowflakeDatabase/examples/GetSnowflakeDatabase.json
+29
View File
@@ -0,0 +1,29 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"snowflakeDatabaseId": "123e4567-e89b-12d3-a456-426614174001"
},
"responses": {
"200": {
"body": {
"description": "This is an example Snowflake Database item.",
"displayName": "My Database",
"id": "123e4567-e89b-12d3-a456-426614174001",
"properties": {
"snowflakeDatabaseName": "ExampleDatabase",
"connectionId": "456e7890-e89b-12d3-a456-426614174002",
"onelakeTablesPath": "https://onelake.dfs.fabric.microsoft.com/path/to/Tables",
"snowflakeVolumePath": "https://onelake.dfs.fabric.microsoft.com/path/to/SnowflakeVolume",
"sqlEndpointProperties": {
"connectionString": "qvrmbuxie7we7glrekxgy6npqu-6xgyei3x2xiejip4iime6knh5m.datawarehouse.fabric.microsoft.com",
"id": "123e4567-e89b-12d3-a456-426614174004",
"provisioningStatus": "Success"
},
"defaultSchema": "PUBLIC"
},
"type": "SnowflakeDatabase",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
}
}
}
}
snowflakeDatabase/examples/GetSnowflakeDatabaseDefinition.json
+28
View File
@@ -0,0 +1,28 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"snowflakeDatabaseId": "123e4567-e89b-12d3-a456-426614174001"
},
"responses": {
"200": {
"body": {
"definition": {
"parts": [
{
"path": "SnowflakeDatabaseProperties.json",
"payload": "eyJzbm93Zmxha2VEYXRhYmFzZU5hbWUiOiAiRXhhbXBsZURhdGFiYXNlIiwgImNvbm5lY3Rpb25JZCI6ICI0NTZlNzg5MC1lODliLTEyZDMtYTQ1Ni00MjY2MTQxNzQwMDIifQ==",
"payloadType": "InlineBase64"
}
]
}
}
},
"202": {
"headers": {
"Location": "https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6",
"x-ms-operation-id": "0acd697c-1550-43cd-b998-91bfbfbd47c6",
"Retry-After": 30
}
}
}
}
snowflakeDatabase/examples/ListSnowflakeDatabasesInWorkspace.json
+31
View File
@@ -0,0 +1,31 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
},
"responses": {
"200": {
"value": [
{
"description": "This is an example Snowflake Database item.",
"displayName": "My Database",
"id": "123e4567-e89b-12d3-a456-426614174001",
"properties": {
"snowflakeDatabaseName": "ExampleDatabase",
"onelakeTablesPath": "https://onelake.dfs.fabric.microsoft.com/path/to/Tables",
"snowflakeVolumePath": "https://onelake.dfs.fabric.microsoft.com/path/to/SnowflakeVolume",
"sqlEndpointProperties": {
"connectionString": "qvrmbuxie7we7glrekxgy6npqu-6xgyei3x2xiejip4iime6knh5m.datawarehouse.fabric.microsoft.com",
"id": "123e4567-e89b-12d3-a456-426614174004",
"provisioningStatus": "Success"
},
"defaultSchema": "PUBLIC"
},
"type": "SnowflakeDatabase",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
}
],
"continuationToken": "token123",
"continuationUri": "https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/snowflakeDatabases?continuationToken=token123"
}
}
}
snowflakeDatabase/examples/SnowflakeDatabase_LRO_Complete.json
+11
View File
@@ -0,0 +1,11 @@
{
"id": "12345678-1234-1234-1234-123456789012",
"name": "12345678-1234-1234-1234-123456789012",
"status": "Succeeded",
"startTime": "2023-10-01T00:00:00.0000000Z",
"endTime": "2023-10-01T00:05:30.0000000Z",
"percentComplete": 100,
"properties": {
"resourceLocation": "/workspaces/00000000-0000-0000-0000-000000000000/snowflakeDatabases/mySnowflakeDb"
}
}
snowflakeDatabase/examples/SnowflakeDatabase_LRO_Example.json
+22
View File
@@ -0,0 +1,22 @@
{
"value": {
"id": "/workspaces/00000000-0000-0000-0000-000000000000/snowflakeDatabases/mySnowflakeDb",
"name": "mySnowflakeDb",
"type": "Microsoft.Fabric/workspaces/snowflakeDatabases",
"properties": {
"provisioningState": "Creating",
"displayName": "My Snowflake Database",
"description": "Example Snowflake database integrated with Microsoft Fabric",
"connectionStatus": "Connecting",
"connectionDetails": {
"snowflakeAccount": "myaccount.snowflakecomputing.com",
"snowflakeWarehouse": "COMPUTE_WH",
"database": "MYDATABASE"
}
}
},
"status": 202,
"location": "https://api.fabric.microsoft.com/v1/workspaces/00000000-0000-0000-0000-000000000000/operations/12345678-1234-1234-1234-123456789012?api-version=2023-12-01",
"azureAsyncOperation": "https://api.fabric.microsoft.com/v1/workspaces/00000000-0000-0000-0000-000000000000/operations/12345678-1234-1234-1234-123456789012?api-version=2023-12-01",
"retryAfter": 30
}
snowflakeDatabase/examples/SnowflakeDatabase_LRO_Poll.json
+7
View File
@@ -0,0 +1,7 @@
{
"id": "12345678-1234-1234-1234-123456789012",
"name": "12345678-1234-1234-1234-123456789012",
"status": "InProgress",
"startTime": "2023-10-01T00:00:00.0000000Z",
"percentComplete": 75
}
snowflakeDatabase/examples/UpdateSnowflakeDatabase.json
+32
View File
@@ -0,0 +1,32 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"snowflakeDatabaseId": "123e4567-e89b-12d3-a456-426614174001",
"updateSnowflakeDatabaseRequest": {
"displayName": "Updated Database",
"description": "This is an updated Snowflake Database item."
}
},
"responses": {
"200": {
"body": {
"description": "This is an updated Snowflake Database item.",
"displayName": "Updated Database",
"id": "123e4567-e89b-12d3-a456-426614174001",
"properties": {
"snowflakeDatabaseName": "ExampleDatabase",
"onelakeTablesPath": "https://onelake.dfs.fabric.microsoft.com/path/to/Tables",
"snowflakeVolumePath": "https://onelake.dfs.fabric.microsoft.com/path/to/SnowflakeVolume",
"sqlEndpointProperties": {
"connectionString": "qvrmbuxie7we7glrekxgy6npqu-6xgyei3x2xiejip4iime6knh5m.datawarehouse.fabric.microsoft.com",
"id": "123e4567-e89b-12d3-a456-426614174004",
"provisioningStatus": "Success"
},
"defaultSchema": "PUBLIC"
},
"type": "SnowflakeDatabase",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
}
}
}
}
snowflakeDatabase/examples/UpdateSnowflakeDatabaseDefinition.json
+27
View File
@@ -0,0 +1,27 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"snowflakeDatabaseId": "123e4567-e89b-12d3-a456-426614174001",
"updateSnowflakeDatabaseDefinitionRequest": {
"definition": {
"parts": [
{
"path": "SnowflakeDatabaseProperties.json",
"payload": "eyJzbm93Zmxha2VEYXRhYmFzZU5hbWUiOiAiRXhhbXBsZURhdGFiYXNlIiwgImNvbm5lY3Rpb25JZCI6ICI0NTZlNzg5MC1lODliLTEyZDMtYTQ1Ni00MjY2MTQxNzQwMDIifQ==",
"payloadType": "InlineBase64"
}
]
}
}
},
"responses": {
"200": {},
"202": {
"headers": {
"Location": "https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef",
"x-ms-operation-id": "427f6c34-b64e-4ee4-8ea5-b533c0e203ef",
"Retry-After": 30
}
}
}
}
snowflakeDatabase/swagger.json
+445
View File
@@ -0,0 +1,445 @@
{
"swagger": "2.0",
"info": {
"title": "SnowflakeDatabase REST APIs",
"version": "v1"
},
"schemes": [
"https"
],
"host": "api.fabric.microsoft.com",
"basePath": "/v1",
"paths": {
"/workspaces/{workspaceId}/snowflakeDatabases": {
"get": {
"summary": "Returns a list of SnowflakeDatabase items from the specified Fabric workspace.",
"description": "> [!NOTE]\n> SnowflakeDatabase item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\n The caller must have a *viewer* workspace role. \n\n## Required Delegated Scopes \n\nWorkspace.Read.All or Workspace.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"tags": [
"Items"
],
"operationId": "Items_ListSnowflakeDatabases",
"x-ms-pageable": {
"nextLinkName": "continuationUri"
},
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "query",
"name": "continuationToken",
"description": "A token for retrieving the next page of results.",
"type": "string",
"required": false
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions.json#/definitions/SnowflakeDatabases"
}
},
"default": {
"description": "Common error codes:\n\n* InvalidItemType - Invalid item type",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Snowflake Databases in workspace example": {
"$ref": "./examples/ListSnowflakeDatabasesInWorkspace.json"
}
}
},
"post": {
"summary": "Creates a Snowflake Database item in the specified Fabric workspace.",
"description": "> [!NOTE]\n> SnowflakeDatabase item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\n The caller must have a *contributor* workspace role. \n\n## Required Delegated Scopes \n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"tags": [
"Items"
],
"operationId": "Items_CreateSnowflakeDatabase",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"x-ms-fabric-sdk-long-running-operation": true,
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "body",
"name": "createSnowflakeDatabaseRequest",
"description": "Create item request payload.",
"schema": {
"$ref": "./definitions.json#/definitions/CreateSnowflakeDatabaseRequest"
},
"required": true
}
],
"responses": {
"201": {
"description": "Successfully created",
"schema": {
"$ref": "./definitions.json#/definitions/SnowflakeDatabase"
}
},
"202": {
"description": "Request accepted, Snowflake Database provisioning in progress.",
"headers": {
"Location": {
"description": "The URL of the operation status, which can be used to track the operation state.",
"type": "string"
},
"x-ms-operation-id": {
"description": "The operation ID which can be used with long running operations (LRO) APIs to track the operation state and get the result.",
"type": "string",
"format": "uuid"
},
"Retry-After": {
"type": "integer",
"description": "The number of seconds to wait before retrying the request."
}
}
},
"default": {
"description": "Common error codes:\n\n* InvalidItemType - Item type is invalid\n\n* ItemDisplayNameAlreadyInUse - Item display name is already used. \n\n* CorruptedPayload - The provided payload is corrupted.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Create a Snowflake Database with creation payload example": {
"$ref": "./examples/CreateSnowflakeDatabaseWithPayload.json"
},
"Create a Snowflake Database without creation payload example": {
"$ref": "./examples/CreateSnowflakeDatabaseWithoutPayload.json"
},
"Create a Snowflake Database with definition example": {
"$ref": "./examples/CreateSnowflakeDatabaseWithDefinition.json"
}
}
}
},
"/workspaces/{workspaceId}/snowflakeDatabases/{snowflakeDatabaseId}": {
"get": {
"summary": "Returns properties of the specified Snowflake Database item.",
"description": "> [!NOTE]\n> SnowflakeDatabase item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\n## Permissions\n\n The caller must have *read* permissions for the snowflake database. \n\n## Required Delegated Scopes \n\n Item.Read.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"tags": [
"Items"
],
"operationId": "Items_GetSnowflakeDatabase",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "snowflakeDatabaseId",
"description": "The Snowflake Database ID.",
"type": "string",
"format": "uuid",
"required": true
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions.json#/definitions/SnowflakeDatabase"
}
},
"default": {
"description": "Common error codes:\n\n* ItemNotFound - Item not found",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Snowflake Database example": {
"$ref": "./examples/GetSnowflakeDatabase.json"
}
}
},
"delete": {
"summary": "Deletes the specified Snowflake Database item.",
"description": "> [!NOTE]\n> SnowflakeDatabase item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\n## Permissions\n\n The caller must have *write* permissions for the snowflake database. \n\n## Required Delegated Scopes \n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"tags": [
"Items"
],
"operationId": "Items_DeleteSnowflakeDatabase",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "snowflakeDatabaseId",
"description": "The Snowflake Database ID.",
"type": "string",
"format": "uuid",
"required": true
}
],
"responses": {
"200": {
"description": "Successfully deleted the Snowflake Database."
},
"default": {
"description": "Common error codes:\n\n* ItemNotFound - Item not found",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Snowflake Database example": {
"$ref": "./examples/DeleteSnowflakeDatabase.json"
}
}
},
"patch": {
"summary": "Update properties of the Snowflake Database item.",
"description": "> [!NOTE]\n> SnowflakeDatabase item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\n## Permissions\n\n The caller must have *read and write* permissions for the snowflake database. \n\n## Required Delegated Scopes \n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"tags": [
"Items"
],
"operationId": "Items_UpdateSnowflakeDatabase",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "snowflakeDatabaseId",
"description": "The Snowflake Database ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "body",
"name": "updateSnowflakeDatabaseRequest",
"description": "Update item payload.",
"schema": {
"$ref": "./definitions.json#/definitions/UpdateSnowflakeDatabaseRequest"
},
"required": true
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions.json#/definitions/SnowflakeDatabase"
}
},
"default": {
"description": "Common error codes:\n\n* ItemNotFound - Item not found",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Update Snowflake Database example": {
"$ref": "./examples/UpdateSnowflakeDatabase.json"
}
}
}
},
"/workspaces/{workspaceId}/snowflakeDatabases/{snowflakeDatabaseId}/getDefinition": {
"post": {
"summary": "Returns the specified Snowflake Database public definition.",
"description": "> [!NOTE]\n> SnowflakeDatabase item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\n The caller must have *read and write* permissions for the snowflake database. \n\n## Required Delegated Scopes \n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"tags": [
"Items"
],
"operationId": "Items_GetSnowflakeDatabaseDefinition",
"produces": [
"application/json"
],
"x-ms-fabric-sdk-long-running-operation": true,
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "snowflakeDatabaseId",
"description": "The Snowflake Database ID.",
"type": "string",
"format": "uuid",
"required": true
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions.json#/definitions/SnowflakeDatabaseDefinitionResponse"
}
},
"202": {
"description": "Request accepted. Retrieving the definition is in progress.",
"headers": {
"Location": {
"description": "The URL of the operation status, which can be used to track the operation state.",
"type": "string"
},
"x-ms-operation-id": {
"description": "The operation ID which can be used with long running operations (LRO) APIs to track the operation state and get the result.",
"type": "string",
"format": "uuid"
},
"Retry-After": {
"type": "integer",
"description": "The number of seconds to wait before retrying the request."
}
}
},
"default": {
"description": "Common error codes:\n\n* OperationNotSupportedForItem - Operation not supported for requested item.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Snowflake Database definition example": {
"$ref": "./examples/GetSnowflakeDatabaseDefinition.json"
}
}
}
},
"/workspaces/{workspaceId}/snowflakeDatabases/{snowflakeDatabaseId}/updateDefinition": {
"post": {
"summary": "Overrides the definition for the specified Snowflake Database.",
"description": "> [!NOTE]\n> SnowflakeDatabase item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\n The caller must have *read and write* permissions for the snowflake database. \n\n## Required Delegated Scopes \n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"tags": [
"Items"
],
"operationId": "Items_UpdateSnowflakeDatabaseDefinition",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"x-ms-fabric-sdk-long-running-operation": true,
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "snowflakeDatabaseId",
"description": "The Snowflake Database ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "body",
"name": "updateSnowflakeDatabaseDefinitionRequest",
"description": "Update Snowflake Database definition request payload.",
"schema": {
"$ref": "./definitions.json#/definitions/UpdateSnowflakeDatabaseDefinitionRequest"
},
"required": true
}
],
"responses": {
"200": {
"description": "Request completed successfully."
},
"202": {
"description": "Request accepted. Update definition is in progress.",
"headers": {
"Location": {
"description": "The URL of the operation status, which can be used to track the operation state.",
"type": "string"
},
"x-ms-operation-id": {
"description": "The operation ID which can be used with long running operations (LRO) APIs to track the operation state and get the result.",
"type": "string",
"format": "uuid"
},
"Retry-After": {
"type": "integer",
"description": "The number of seconds to wait before retrying the request."
}
}
},
"default": {
"description": "Common error codes:\n\n* OperationNotSupportedForItem - Operation not supported for requested item. \n\n* CorruptedPayload - The provided payload is corrupted.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Update Snowflake Database definition example": {
"$ref": "./examples/UpdateSnowflakeDatabaseDefinition.json"
}
}
}
}
}
}
spark/swagger.json
-90
View File
@@ -426,96 +426,6 @@
}
}
}
},
"/workspaces/{workspaceId}/spark/livySessions?preview=true": {
"get": {
"tags": [
"LivySessions"
],
"summary": "Returns a list of livy sessions from the specified workspace (preview).",
"description": "[!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\n**When calling this API, callers must specify `true` as the value for the query parameter `preview`.**\n\n This API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\nThe caller must have *viewer* or higher workspace role. \n\n## Required Delegated Scopes \n\nWorkspace.Read.All or Workspace.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"operationId": "LivySessions_List_Livy_Sessions_(preview)",
"x-ms-pageable": {
"nextLinkName": "continuationUri"
},
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace identifier.",
"format": "uuid",
"type": "string",
"required": true
},
{
"in": "query",
"name": "preview",
"description": "This required parameter must be set to `true` to access this API, which is currently in preview.",
"type": "boolean",
"required": true
},
{
"in": "query",
"name": "submittedDateTime",
"description": "Submitted date time filter. Filter the sessions based on the submitted date time in UTC, using the YYYY-MM-DDTHH:mm:ssZ format.",
"type": "string",
"format": "date-time",
"required": false
},
{
"in": "query",
"name": "endDateTime",
"description": "Ended date time filter. Filter the sessions based on the ended date time in UTC, using the YYYY-MM-DDTHH:mm:ssZ format.",
"type": "string",
"format": "date-time",
"required": false
},
{
"in": "query",
"name": "submitter.Id",
"description": "The GUID value of the user who submitted the session.",
"type": "string",
"format": "uuid",
"required": false
},
{
"in": "query",
"name": "state",
"description": "The state of the session. Possible values are: `NotStarted`, `InProgress`, `Cancelled`, `Failed`, `Succeeded`, `Unknown`. This value maps to the `state` field in the response.",
"type": "string",
"required": false
},
{
"in": "query",
"name": "continuationToken",
"description": "Token to retrieve the next page of results, if available.",
"type": "string",
"required": false
}
],
"responses": {
"200": {
"description": "OK -- Returns a list of all livy sessions associated to an itemId.",
"schema": {
"$ref": "../common/spark_definitions.json#/definitions/LivySessions"
}
},
"default": {
"description": "Common error codes:\n\n* UnknownError - An error occurred.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List all livy sessions (Preview) example": {
"$ref": "./examples/ListSessionsInItemId_preview.json"
}
}
}
}
},
"responses": {},
sparkjobdefinition/examples/GetSessionInItemId.json
+1 -8
View File
@@ -51,14 +51,7 @@
"capacityId": "3c0cd366-dc28-4b6d-a525-4d415a8666e7",
"operationName": "Batch Livy Run",
"runtimeVersion": "1.3",
"livySessionItemResourceUri": "",
"driverMemory": 4,
"driverCores": 2,
"executorMemory": 8,
"executorCores": 4,
"numExecutors": 10,
"isDynamicAllocationEnabled": true,
"dynamicAllocationMaxExecutors": 20
"livySessionItemResourceUri": ""
}
}
}
sparkjobdefinition/examples/ListSessionsInItemId.json
+1 -8
View File
@@ -54,14 +54,7 @@
"capacityId": "3c0cd366-dc28-4b6d-a525-4d415a8666e7",
"operationName": "Batch Livy Run",
"runtimeVersion": "1.3",
"livySessionItemResourceUri": "",
"driverMemory": 4,
"driverCores": 2,
"executorMemory": 8,
"executorCores": 4,
"numExecutors": 10,
"isDynamicAllocationEnabled": true,
"dynamicAllocationMaxExecutors": 20
"livySessionItemResourceUri": ""
}
]
}
sparkjobdefinition/examples/RunOnDemandSparkJobDefinitionNoBody.json
+1 -2
View File
@@ -1,8 +1,7 @@
{
"parameters": {
"workspaceId": "4b218778-e7a5-4d73-8187-f10824047715",
"sparkJobDefinitionId": "431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
"jobType": "sparkjob"
"sparkJobDefinitionId": "431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7"
},
"responses": {
"202": {
sparkjobdefinition/examples/RunOnDemandSparkJobDefinitionWithBody.json
-1
View File
@@ -2,7 +2,6 @@
"parameters": {
"workspaceId": "4b218778-e7a5-4d73-8187-f10824047715",
"sparkJobDefinitionId": "431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
"jobType": "sparkjob",
"runSparkJobDefinitionRequest": {
"executionData": {
"executableFile": "abfss://test@northcentralus-onelake.dfs.fabric.microsoft.com/salesdata.Lakehouse/Files/oneplusoneapp.jar",
sparkjobdefinition/swagger.json
+4 -109
View File
@@ -449,10 +449,10 @@
}
}
},
"/workspaces/{workspaceId}/sparkJobDefinitions/{sparkJobDefinitionId}/jobs/instances?jobType=sparkjob": {
"/workspaces/{workspaceId}/sparkJobDefinitions/{sparkJobDefinitionId}/jobs/sparkjob/instances": {
"post": {
"summary": "Run on-demand [Spark job definition](/fabric/data-engineering/run-spark-job-definition) job instance.",
"description": "## Required Delegated Scopes\n\nSparkJobDefinition.Execute.All or Item.Execute.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"description": "> [!NOTE]\n> The URL for this API has been updated to include the job type as part of the path, replacing the previous use of a query parameter. For backward compatibility, invocations using the query parameter are still supported.\n\n## Required Delegated Scopes\n\nSparkJobDefinition.Execute.All or Item.Execute.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"tags": [
"BackgroundJobs"
],
@@ -477,13 +477,6 @@
"format": "uuid",
"required": true
},
{
"in": "query",
"name": "jobType",
"description": "The supported job type for Spark job definition is `sparkjob`.",
"type": "string",
"required": true
},
{
"in": "body",
"name": "runSparkJobDefinitionRequest",
@@ -531,7 +524,7 @@
"LivySessions"
],
"summary": "Returns a list of livy sessions from the specified item identifier.",
"description": "This API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\n The caller must have *read* permissions for the spark job definition. \n\n## Required Delegated Scopes \n\n SparkJobDefinition.Read.All or SparkJobDefinition.ReadWrite.All or Item.Read.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"description": "This API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\n The caller must have *viewer* or higher workspace role. \n\n## Required Delegated Scopes \n\n SparkJobDefinition.Read.All or SparkJobDefinition.ReadWrite.All or Item.Read.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"operationId": "LivySessions_ListLivySessions",
"x-ms-pageable": {
"nextLinkName": "continuationUri"
@@ -584,104 +577,6 @@
}
}
},
"/workspaces/{workspaceId}/sparkJobDefinitions/{sparkJobDefinitionId}/livySessions?preview=true": {
"get": {
"tags": [
"LivySessions"
],
"summary": "Returns a list of livy sessions from the specified item identifier (preview).",
"description": "[!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\n**When calling this API, callers must specify `true` as the value for the query parameter `preview`.**\n\n This API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\n The caller must have *read* permissions for the spark job definition. \n\n## Required Delegated Scopes \n\n SparkJobDefinition.Read.All or SparkJobDefinition.ReadWrite.All or Item.Read.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"operationId": "LivySessions_List_Livy_Sessions_(preview)",
"x-ms-pageable": {
"nextLinkName": "continuationUri"
},
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace identifier.",
"format": "uuid",
"type": "string",
"required": true
},
{
"in": "path",
"name": "sparkJobDefinitionId",
"description": "The sparkJobDefinition ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "query",
"name": "preview",
"description": "This required parameter must be set to `true` to access this API, which is currently in preview.",
"type": "boolean",
"required": true
},
{
"in": "query",
"name": "submittedDateTime",
"description": "Submitted date time filter. Filter the sessions based on the submitted date time in UTC, using the YYYY-MM-DDTHH:mm:ssZ format.",
"type": "string",
"format": "date-time",
"required": false
},
{
"in": "query",
"name": "endDateTime",
"description": "Ended date time filter. Filter the sessions based on the ended date time in UTC, using the YYYY-MM-DDTHH:mm:ssZ format.",
"type": "string",
"format": "date-time",
"required": false
},
{
"in": "query",
"name": "submitter.Id",
"description": "The GUID value of the user who submitted the session.",
"type": "string",
"format": "uuid",
"required": false
},
{
"in": "query",
"name": "state",
"description": "The state of the session. Possible values are: `NotStarted`, `InProgress`, `Cancelled`, `Failed`, `Succeeded`, `Unknown`. This value maps to the `state` field in the response.",
"type": "string",
"required": false
},
{
"in": "query",
"name": "continuationToken",
"description": "Token to retrieve the next page of results, if available.",
"type": "string",
"required": false
}
],
"responses": {
"200": {
"description": "OK -- Returns a list of all livy sessions associated to an itemId.",
"schema": {
"$ref": "../common/spark_definitions.json#/definitions/LivySessions"
}
},
"default": {
"description": "Common error codes:\n\n* SparkCoreItemNotFound - SparkJobDefinition identifier does not exist\n\n* SparkCoreUnexpectedException - Unhandled exception ocurred.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List all livy sessions (Preview) example": {
"$ref": "./examples/ListSessionsInItemId_preview.json"
}
}
}
},
"/workspaces/{workspaceId}/sparkJobDefinitions/{sparkJobDefinitionId}/livySessions/{livyId}": {
"get": {
"tags": [
@@ -689,7 +584,7 @@
],
"operationId": "LivySessions_GetLivySession",
"summary": "Returns properties of the specified livy session.",
"description": "## Permissions\n\n The caller must have *read* permissions for the spark job definition. \n\n## Required Delegated Scopes \n\n SparkJobDefinition.Read.All or SparkJobDefinition.ReadWrite.All or Item.Read.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"description": "## Permissions\n\n The caller must have *viewer* or higher workspace role. \n\n## Required Delegated Scopes \n\n SparkJobDefinition.Read.All or SparkJobDefinition.ReadWrite.All or Item.Read.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"produces": [
"application/json"
],
userDataFunction/definitions.json
+1 -18
View File
@@ -14,24 +14,7 @@
{
"$ref": "../common/definitions.json#/definitions/Item"
}
],
"properties": {
"properties": {
"description": "The UserDataFunction properties.",
"$ref": "#/definitions/UserDataFunctionProperties"
}
}
},
"UserDataFunctionProperties": {
"description": "The UserDataFunction properties.",
"type": "object",
"required": ["oneLakeRootPath"],
"properties": {
"oneLakeRootPath": {
"description": "OneLake path to the UserDataFunction root directory.",
"type": "string"
}
}
]
},
"UserDataFunctions": {
"description": "A list of User Data Functions.",
userDataFunction/examples/CreateUserDataFunction.json
-1
View File
@@ -1,7 +1,6 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"preview": true,
"createUserDataFunctionRequest": {
"displayName": "UserDataFunction 1",
"description": "A UserDataFunction description.",
userDataFunction/examples/CreateUserDataFunctionWithoutDefinition.json
-1
View File
@@ -1,7 +1,6 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"preview": true,
"createUserDataFunctionRequest": {
"displayName": "UserDataFunction 1",
"description": "A UserDataFunction description."
userDataFunction/examples/DeleteUserDataFunction.json
+1 -2
View File
@@ -1,8 +1,7 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"UserDataFunctionId": "5b218778-e7a5-4d73-8187-f10824047715",
"preview": true
"UserDataFunctionId": "5b218778-e7a5-4d73-8187-f10824047715"
},
"responses": {
"200": {}
userDataFunction/examples/GetUserDataFunction.json
+2 -6
View File
@@ -1,8 +1,7 @@
{
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"UserDataFunctionId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
"preview": true
"UserDataFunctionId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
},
"responses": {
"200": {
@@ -11,10 +10,7 @@
"displayName": "UserDataFunction 1",
"description": "A UserDataFunction description.",
"type": "UserDataFunction",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"properties": {
"oneLakeRootPath": "https://onelake.dfs.fabric.microsoft.com/f089354e-8366-4e18-aea3-4cb4a3a50b48/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
}
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
}
}
}
userDataFunction/examples/GetUserDataFunctionDefinition.json
+1 -2
View File
@@ -1,8 +1,7 @@
{
"parameters": {
"workspaceId": "6e335e92-a2a2-4b5a-970a-bd6a89fbb765",
"UserDataFunctionId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"preview": true
"UserDataFunctionId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
},
"responses": {
"200": {
userDataFunction/examples/ListUserDataFunctionsInWorkspace.json
+3 -10
View File
@@ -1,7 +1,6 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"preview": true
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
},
"responses": {
"200": {
@@ -12,20 +11,14 @@
"displayName": "UserDataFunction Name 1",
"description": "A UserDataFunction description.",
"type": "UserDataFunction",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"properties": {
"oneLakeRootPath": "https://onelake.dfs.fabric.microsoft.com/f089354e-8366-4e18-aea3-4cb4a3a50b48/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
}
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
},
{
"id": "f697fb63-abd4-4399-9548-be7e3c3c0dac",
"displayName": "UserDataFunction Name 2",
"description": "A UserDataFunction description.",
"type": "UserDataFunction",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"properties": {
"oneLakeRootPath": "https://onelake.dfs.fabric.microsoft.com/f089354e-8366-4e18-aea3-4cb4a3a50b48/d8f6cf16-3aac-4440-9d76-a03d86b7ae3e"
}
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
}
]
}
userDataFunction/examples/UpdateUserDataFunction.json
-1
View File
@@ -2,7 +2,6 @@
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"UserDataFunctionId": "5b218778-e7a5-4d73-8187-f10824047715",
"preview": true,
"updateUserDataFunctionRequest": {
"displayName": "UserDataFunction's New name",
"description": "UserDataFunction's New description"
userDataFunction/examples/UpdateUserDataFunctionDefinition.json
-1
View File
@@ -2,7 +2,6 @@
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"UserDataFunctionId": "5b218778-e7a5-4d73-8187-f10824047715",
"preview": true,
"updateMetadata" : true,
"updateUserDataFunctionDefinitionRequest": {
"definition": {
userDataFunction/swagger.json
+2 -44
View File
@@ -38,14 +38,7 @@
"name": "continuationToken",
"description": "A token for retrieving the next page of results.",
"type": "string",
"required": false
"required": false
}
],
"responses": {
@@ -92,13 +85,6 @@
"required": true
},
{
"in": "body",
"name": "createUserDataFunctionRequest",
"description": "Create item request payload.",
@@ -237,13 +223,6 @@
"required": true
},
{
"in": "body",
"name": "updateUserDataFunctionRequest",
"description": "Update UserDataFunction request payload.",
@@ -298,14 +277,7 @@
"description": "The UserDataFunction ID.",
"type": "string",
"format": "uuid",
"required": true
"required": true
}
],
"responses": {
@@ -357,13 +329,6 @@
},
{
"in": "query",
"name": "format",
"description": "The format of the UserDataFunction public definition.",
"type": "string",
@@ -440,13 +405,6 @@
},
{
"in": "query",
"name": "updateMetadata",
"description": "When set to true and the .platform file is provided as part of the definition, the item's metadata is updated using the metadata in the .platform file",
"type": "boolean",