nprasad2077/mcp-microsoft
1
0 Fork 0
mirror of https://github.com/microsoft/mcp.git synced 2026-11-04 12:01:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update Fabric MCP static resources (#1195)

Browse Source 
* Fabric MCP: Update static resources

* Add definition articles
This commit is contained in:
Amos Hersch authored and GitHub committed 2025-11-16 14:33:29 +02:00
1 parent e6c1e41bd0
commit dd130f4d62
76 files changed
+4725 -218
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/admin/definitions.json
+8
View File
@@ -153,6 +153,14 @@
"format": "uuid",
"readOnly": true,
"description": "The folder ID of the item."
},
"tags": {
"description": "List of applied tags.",
"type": "array",
"items": {
"$ref": "../common/definitions.json#/definitions/ItemTag"
},
"readOnly": true
}
}
},
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/admin/examples/ListItems.json
+12 -2
View File
@@ -20,7 +20,17 @@
"userDetails": {
"userPrincipalName": "caleb@example.com"
}
}
},
"tags": [
{
"displayName": "Tag 1",
"id": "b4e54dd6-1d37-4e7a-9e9a-49a596ff4470"
},
{
"displayName": "Tag 2",
"id": "62d18d7e-3878-478a-b89b-2f38b73c18a4"
}
]
},
{
"id": "37d8929d-ab32-46d1-858b-fdea74e93bff",
@@ -46,4 +56,4 @@
}
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/admin/examples/ListItemsByDatamartType.json
+8 -2
View File
@@ -21,7 +21,13 @@
"userDetails": {
"userPrincipalName": "jacob@example.com"
}
}
},
"tags": [
{
"displayName": "Tag 1",
"id": "b4e54dd6-1d37-4e7a-9e9a-49a596ff4470"
}
]
}
],
"continuationUri": null,
@@ -29,4 +35,4 @@
}
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/admin/examples/ListItemsByType.json
+12 -2
View File
@@ -21,7 +21,17 @@
"userDetails": {
"userPrincipalName": "Jacob@example.com"
}
}
},
"tags": [
{
"displayName": "Tag 1",
"id": "b4e54dd6-1d37-4e7a-9e9a-49a596ff4470"
},
{
"displayName": "Tag 2",
"id": "62d18d7e-3878-478a-b89b-2f38b73c18a4"
}
]
}
],
"continuationUri": null,
@@ -29,4 +39,4 @@
}
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/common/definitions.json
+9 -1
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" ],
"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" ],
"x-ms-enum": {
"name": "ItemType",
"modelAsString": true,
@@ -340,6 +340,14 @@
{
"value": "UserDataFunction",
"description": "A User Data Function."
},
{
"value": "GraphModel",
"description": "A GraphModel."
},
{
"value": "GraphQuerySet",
"description": "A Graph QuerySet."
}
]
},
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/common/spark_definitions.json
+28 -1
View File
@@ -144,6 +144,33 @@
"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. "
}
}
},
@@ -220,7 +247,7 @@
"Notebook"
],
"x-ms-enum": {
"name": "ItemType",
"name": "LivySessionItemType",
"modelAsString": true,
"values": [
{
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/graphModel/definitions.json
+323
View File
@@ -0,0 +1,323 @@
{
"swagger": "2.0",
"info": {
"title": "GraphModel data types",
"version": "v1"
},
"paths": {},
"definitions": {
"GraphModel": {
"description": "A GraphModel object.",
"type": "object",
"required": [
"type"
],
"allOf": [
{
"$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.",
"required": [
"value"
],
"type": "object",
"properties": {
"value": {
"description": "A list of Public Facing Collection Names.",
"type": "array",
"items": {
"$ref": "#/definitions/GraphModel"
}
}
},
"allOf": [
{
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
}
]
},
"CreateGraphModelRequest": {
"description": "Create GraphModel request payload.",
"required": [
"displayName"
],
"properties": {
"displayName": {
"description": "The GraphModel display name. The display name must follow naming rules according to item type.",
"type": "string",
"readOnly": false
},
"description": {
"description": "The GraphModel description. Maximum length is 256 characters.",
"type": "string",
"readOnly": false
},
"folderId": {
"description": "The folder ID. If not specified or null, the GraphModel is created with the workspace as its folder.",
"type": "string",
"format": "uuid",
"readOnly": false
},
"definition": {
"description": "The GraphModel public definition.",
"$ref": "#/definitions/GraphModelPublicDefinition",
"readOnly": false
}
}
},
"UpdateGraphModelDefinitionRequest": {
"description": "Update GraphModel public definition request payload.",
"required": [
"definition"
],
"properties": {
"definition": {
"$ref": "#/definitions/GraphModelPublicDefinition"
}
}
},
"GraphModelDefinitionResponse": {
"description": "GraphModel public definition response.",
"required": [
"definition"
],
"properties": {
"definition": {
"$ref": "#/definitions/GraphModelPublicDefinition",
"readOnly": true
}
}
},
"GraphModelPublicDefinition": {
"description": "GraphModel public definition object. Refer to this [article](/rest/api/fabric/articles/item-management/definitions/graph-model) for more details on how to craft a GraphModel 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": [
"json"
],
"x-ms-enum": {
"name": "GraphModelDefinitionFormat",
"modelAsString": true,
"values": [
{
"value": "json",
"description": "JSON format for the GraphModel public definition, specifically designed to support CI/CD scenarios in Fabric."
}
]
},
"readOnly": false
},
"parts": {
"description": "A list of definition parts.",
"type": "array",
"items": {
"$ref": "#/definitions/GraphModelPublicDefinitionPart"
},
"readOnly": false
}
}
},
"GraphModelPublicDefinitionPart": {
"description": "GraphModel definition part object.",
"type": "object",
"properties": {
"path": {
"description": "The GraphModel public definition part path.",
"type": "string",
"readOnly": false
},
"payload": {
"description": "The GraphModel public definition part payload.",
"type": "string",
"readOnly": false
},
"payloadType": {
"description": "The payload type.",
"$ref": "../common/definitions.json#/definitions/PayloadType",
"readOnly": false
}
}
},
"UpdateGraphModelRequest": {
"description": "Update GraphModel request.",
"properties": {
"displayName": {
"description": "The GraphModel display name. The display name must follow naming rules according to item type.",
"type": "string",
"readOnly": false
},
"description": {
"description": "The GraphModel description. Maximum length is 256 characters.",
"type": "string",
"readOnly": false
}
}
},
"ExecuteQueryRequest": {
"description": "Execute query request payload.",
"required": [
"query"
],
"properties": {
"query": {
"description": "The query string.",
"type": "string",
"readOnly": false
}
}
},
"GraphType": {
"description": "The graph type that specifies the structure of a graph.",
"type": "object",
"properties": {
"nodeTypes": {
"description": "A list of graph node types.",
"type": "array",
"items": {
"$ref": "#/definitions/NodeType"
}
},
"edgeTypes": {
"description": "A list of graph edge types.",
"type": "array",
"items": {
"$ref": "#/definitions/EdgeType"
}
}
}
},
"NodeType": {
"description": "A graph node type.",
"type": "object",
"required": [
"alias",
"labels",
"primaryKeyProperties"
],
"properties": {
"alias": {
"description": "The node type alias.",
"type": "string"
},
"labels": {
"description": "The node type labels.",
"type": "array",
"items": {
"type": "string"
}
},
"properties": {
"description": "A list of node type properties.",
"type": "array",
"items": {
"$ref": "#/definitions/Property"
}
},
"primaryKeyProperties": {
"description": "A list of node type primary key properties.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"EdgeType": {
"description": "A graph edge type.",
"type": "object",
"required": [
"alias",
"labels",
"sourceNodeType",
"destinationNodeType"
],
"properties": {
"alias": {
"description": "The edge type alias.",
"type": "string"
},
"labels": {
"description": "The edge type labels.",
"type": "array",
"items": {
"type": "string"
}
},
"properties": {
"description": "A list of edge type properties.",
"type": "array",
"items": {
"$ref": "#/definitions/Property"
}
},
"sourceNodeType": {
"description": "The source node type.",
"$ref": "#/definitions/NodeTypeReference"
},
"destinationNodeType": {
"description": "The target node type.",
"$ref": "#/definitions/NodeTypeReference"
}
}
},
"Property": {
"description": "A graph element property.",
"type": "object",
"required": [
"name",
"type"
],
"properties": {
"name": {
"description": "The property name.",
"type": "string"
},
"type": {
"description": "The property type.",
"type": "string"
}
}
},
"NodeTypeReference": {
"description": "A reference to a node type.",
"type": "object",
"required": [
"alias"
],
"properties": {
"alias": {
"description": "The node type alias.",
"type": "string"
}
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/graphModel/examples/CreateGraphModel.json
+57
View File
@@ -0,0 +1,57 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"createGraphModelRequest": {
"displayName": "GraphModel 1",
"description": "A GraphModel description.",
"definition": {
"format": "json",
"parts": [
{
"path": "graphType.json",
"payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
"payloadType": "InlineBase64"
},
{
"path": "graphDefinition.json",
"payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
"payloadType": "InlineBase64"
},
{
"path": "dataSources.json",
"payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
"payloadType": "InlineBase64"
},
{
"path": "stylingConfiguration.json",
"payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
"payloadType": "InlineBase64"
},
{
"path": ".platform",
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
"payloadType": "InlineBase64"
}
]
}
}
},
"responses": {
"201": {
"body": {
"displayName": "GraphModel 1",
"description": "A GraphModel description.",
"type": "GraphModel",
"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
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/graphModel/examples/CreateGraphModelWithoutDefinition.json
+27
View File
@@ -0,0 +1,27 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"createGraphModelRequest": {
"displayName": "GraphModel 1",
"description": "A GraphModel description."
}
},
"responses": {
"201": {
"body": {
"displayName": "GraphModel 1",
"description": "A GraphModel description.",
"type": "GraphModel",
"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
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/graphModel/examples/DeleteGraphModel.json
+9
View File
@@ -0,0 +1,9 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"GraphModelId": "5b218778-e7a5-4d73-8187-f10824047715"
},
"responses": {
"200": {}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/graphModel/examples/ExecuteQuery.json
+67
View File
@@ -0,0 +1,67 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"GraphModelId": "5b218778-e7a5-4d73-8187-f10824047715",
"createQueryResultRequest": {
"query": "MATCH (node_station:`station`) RETURN TO_JSON_STRING(node_station) AS `station` LIMIT 10;"
},
"preview": true
},
"responses": {
"200": {
"body": {
"status": {
"code": "00000",
"description": "note: successful completion",
"diagnostics": {
"OPERATION": "query",
"OPERATION_CODE": "0",
"CURRENT_SCHEMA": "/"
}
},
"result": {
"kind": "TABLE",
"columns": [
{
"name": "station",
"gqlType": "STRING",
"jsonType": "string"
}
],
"data": [
{
"station": "{\u0022labels\u0022:[\u0022station\u0022],\u0022oid\u0022:\u00221688849860263937\u0022,\u0022properties\u0022:{\u0022stationFrom\u0022:\u0022Holborn\u0022,\u0022stationTo\u0022:\u0022Chancery_Lane\u0022}}"
},
{
"station": "{\u0022labels\u0022:[\u0022station\u0022],\u0022oid\u0022:\u00221688849860263938\u0022,\u0022properties\u0022:{\u0022stationFrom\u0022:\u0022Chancery_Lane\u0022,\u0022stationTo\u0022:\u0022St_Paul\u0027s\u0022}}"
},
{
"station": "{\u0022labels\u0022:[\u0022station\u0022],\u0022oid\u0022:\u00221688849860263939\u0022,\u0022properties\u0022:{\u0022stationFrom\u0022:\u0022Hyde_Park_Corner\u0022,\u0022stationTo\u0022:\u0022Green_Park\u0022}}"
},
{
"station": "{\u0022labels\u0022:[\u0022station\u0022],\u0022oid\u0022:\u00221688849860263940\u0022,\u0022properties\u0022:{\u0022stationFrom\u0022:\u0022Holborn\u0022,\u0022stationTo\u0022:\u0022Russel_Square\u0022}}"
},
{
"station": "{\u0022labels\u0022:[\u0022station\u0022],\u0022oid\u0022:\u00221688849860263941\u0022,\u0022properties\u0022:{\u0022stationFrom\u0022:\u0022Euston\u0022,\u0022stationTo\u0022:\u0022Warren_Street\u0022}}"
},
{
"station": "{\u0022labels\u0022:[\u0022station\u0022],\u0022oid\u0022:\u00221688849860263942\u0022,\u0022properties\u0022:{\u0022stationFrom\u0022:\u0022Victoria\u0022,\u0022stationTo\u0022:\u0022Pimlico\u0022}}"
},
{
"station": "{\u0022labels\u0022:[\u0022station\u0022],\u0022oid\u0022:\u00221688849860263943\u0022,\u0022properties\u0022:{\u0022stationFrom\u0022:\u0022London_Bridge\u0022,\u0022stationTo\u0022:\u0022Monument\u0022}}"
},
{
"station": "{\u0022labels\u0022:[\u0022station\u0022],\u0022oid\u0022:\u00221688849860263944\u0022,\u0022properties\u0022:{\u0022stationFrom\u0022:\u0022Moorgate\u0022,\u0022stationTo\u0022:\u0022Old_Street\u0022}}"
},
{
"station": "{\u0022labels\u0022:[\u0022station\u0022],\u0022oid\u0022:\u00221688849860263945\u0022,\u0022properties\u0022:{\u0022stationFrom\u0022:\u0022South_Kensington\u0022,\u0022stationTo\u0022:\u0022Sloane_Square\u0022}}"
},
{
"station": "{\u0022labels\u0022:[\u0022station\u0022],\u0022oid\u0022:\u00221688849860263946\u0022,\u0022properties\u0022:{\u0022stationFrom\u0022:\u0022Victoria\u0022,\u0022stationTo\u0022:\u0022St_James\u0027s_Park\u0022}}"
}
]
}
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/graphModel/examples/GetGraphModel.json
+20
View File
@@ -0,0 +1,20 @@
{
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"GraphModelId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
},
"responses": {
"200": {
"body": {
"id": "5b218778-e7a5-4d73-8187-f10824047715",
"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"
}
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/graphModel/examples/GetGraphModelDefinition.json
+49
View File
@@ -0,0 +1,49 @@
{
"parameters": {
"workspaceId": "6e335e92-a2a2-4b5a-970a-bd6a89fbb765",
"GraphModelId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
},
"responses": {
"200": {
"body": {
"definition": {
"format": "json",
"parts": [
{
"path": "graphType.json",
"payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
"payloadType": "InlineBase64"
},
{
"path": "graphDefinition.json",
"payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
"payloadType": "InlineBase64"
},
{
"path": "dataSources.json",
"payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
"payloadType": "InlineBase64"
},
{
"path": "stylingConfiguration.json",
"payload": "eyJleGVjdXRhYmxlRm..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
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/graphModel/examples/GetQueryableGraphType.json
+100
View File
@@ -0,0 +1,100 @@
{
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"GraphModelId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
"preview": true
},
"responses": {
"200": {
"body": {
"nodeTypes": [
{
"alias": "096a5133-fd82-4000-ac8a-404532ab6fd6",
"primaryKeyProperties": [
"customerIDK"
],
"labels": [
"customer"
],
"properties": [
{
"name": "customerIDK",
"type": "INT"
},
{
"name": "firstName",
"type": "STRING"
},
{
"name": "lastName",
"type": "STRING"
},
{
"name": "fullName",
"type": "STRING"
}
]
},
{
"alias": "dced4642-b93d-4da4-815c-a171932043a4",
"primaryKeyProperties": [
"productIDK"
],
"labels": [
"products"
],
"properties": [
{
"name": "productIDK",
"type": "INT"
},
{
"name": "productNumber",
"type": "STRING"
},
{
"name": "productName",
"type": "STRING"
},
{
"name": "modelName",
"type": "STRING"
},
{
"name": "makeFlag",
"type": "INT"
},
{
"name": "standardCost",
"type": "FLOAT"
},
{
"name": "listPrice",
"type": "FLOAT"
},
{
"name": "subCategoryIDFK",
"type": "INT"
}
]
}
],
"edgeTypes": [
{
"alias": "3ef6a474-ef38-4923-abcf-6f2e9230f1eb",
"labels": [
"customerProducts"
],
"sourceNodeType": {
"alias": "096a5133-fd82-4000-ac8a-404532ab6fd6"
},
"destinationNodeType": {
"alias": "dced4642-b93d-4da4-815c-a171932043a4"
},
"properties": []
}
]
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/graphModel/examples/ListGraphModelsInWorkspace.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": "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"
}
},
{
"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"
}
}
]
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/graphModel/examples/RunOnDemandRefreshGraph.json
+15
View File
@@ -0,0 +1,15 @@
{
"parameters": {
"workspaceId": "4b218778-e7a5-4d73-8187-f10824047715",
"GraphModelId": "431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
"jobType": "RefreshGraph"
},
"responses": {
"202": {
"headers": {
"Location": "https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/items/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7/jobs/instances/f2d65699-dd22-4889-980c-15226deb0e1b",
"Retry-After": 60
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/graphModel/examples/UpdateGraphModel.json
+21
View File
@@ -0,0 +1,21 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"GraphModelId": "5b218778-e7a5-4d73-8187-f10824047715",
"updateGraphModelRequest": {
"displayName": "GraphModel's New name",
"description": "GraphModel's New description"
}
},
"responses": {
"200": {
"body": {
"displayName": "GraphModel's New name",
"description": "GraphModel's New description",
"type": "GraphModel",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"id": "5b218778-e7a5-4d73-8187-f10824047715"
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/graphModel/examples/UpdateGraphModelDefinition.json
+49
View File
@@ -0,0 +1,49 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"GraphModelId": "5b218778-e7a5-4d73-8187-f10824047715",
"updateMetadata": true,
"updateGraphModelDefinitionRequest": {
"definition": {
"format": "json",
"parts": [
{
"path": "graphType.json",
"payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
"payloadType": "InlineBase64"
},
{
"path": "graphDefinition.json",
"payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
"payloadType": "InlineBase64"
},
{
"path": "dataSources.json",
"payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
"payloadType": "InlineBase64"
},
{
"path": "stylingConfiguration.json",
"payload": "eyJleGVjdXRhYmxlRm..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
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/graphModel/swagger.json
+643
View File
@@ -0,0 +1,643 @@
{
"swagger": "2.0",
"info": {
"title": "GraphModel REST APIs",
"version": "v1"
},
"schemes": [
"https"
],
"host": "api.fabric.microsoft.com",
"basePath": "/v1",
"paths": {
"/workspaces/{workspaceId}/GraphModels": {
"get": {
"summary": "Returns a list of GraphModels from the specified workspace.",
"description": "> [!NOTE]\n> GraphModel 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_ListGraphModels",
"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/GraphModels"
}
},
"default": {
"description": "Common error codes:\n\n* InvalidItemType - Invalid item type.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List GraphModels in workspace example": {
"$ref": "./examples/ListGraphModelsInWorkspace.json"
}
}
},
"post": {
"summary": "Creates a GraphModel in the specified workspace.",
"description": "> [!NOTE]\n> GraphModel 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 GraphModel with a public definition, refer to [GraphModel](/rest/api/fabric/articles/item-management/definitions/graph-model) 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 GraphModel 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_CreateGraphModel",
"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": "createGraphModelRequest",
"description": "Create item request payload.",
"schema": {
"$ref": "./definitions.json#/definitions/CreateGraphModelRequest"
},
"required": true
}
],
"responses": {
"201": {
"description": "Successfully created",
"schema": {
"$ref": "./definitions.json#/definitions/GraphModel"
}
},
"202": {
"description": "Request accepted, GraphModel 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 GraphModel example": {
"$ref": "./examples/CreateGraphModelWithoutDefinition.json"
},
"Create a GraphModel with public definition example": {
"$ref": "./examples/CreateGraphModel.json"
}
}
}
},
"/workspaces/{workspaceId}/GraphModels/{GraphModelId}": {
"get": {
"summary": "Returns properties of the specified GraphModel.",
"description": "> [!NOTE]\n> GraphModel item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\n## Permissions\n\n The caller must have *read* permissions for the GraphModel. \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_GetGraphModel",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "GraphModelId",
"description": "The GraphModel ID.",
"type": "string",
"format": "uuid",
"required": true
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions.json#/definitions/GraphModel"
}
},
"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 GraphModel example": {
"$ref": "./examples/GetGraphModel.json"
}
}
},
"patch": {
"summary": "Updates the properties of the specified GraphModel.",
"description": "> [!NOTE]\n> GraphModel 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 GraphModel.\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_UpdateGraphModel",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "GraphModelId",
"description": "The GraphModel ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "body",
"name": "updateGraphModelRequest",
"description": "Update GraphModel request payload.",
"schema": {
"$ref": "./definitions.json#/definitions/UpdateGraphModelRequest"
},
"required": true
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions.json#/definitions/GraphModel"
}
},
"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 GraphModel example": {
"$ref": "./examples/UpdateGraphModel.json"
}
}
},
"delete": {
"summary": "Deletes the specified GraphModel.",
"description": "> [!NOTE]\n> GraphModel item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\n## Permissions\n\n The caller must have *write* permissions for the GraphModel. \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_DeleteGraphModel",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "GraphModelId",
"description": "The GraphModel 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 GraphModel example": {
"$ref": "./examples/DeleteGraphModel.json"
}
}
}
},
"/workspaces/{workspaceId}/GraphModels/{GraphModelId}/getDefinition": {
"post": {
"summary": "Returns the specified GraphModel public definition.",
"description": "> [!NOTE]\n> GraphModel 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 GraphModel'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 GraphModel. \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_GetGraphModelDefinition",
"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": "GraphModelId",
"description": "The GraphModel ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "query",
"name": "format",
"description": "The format of the GraphModel public definition.",
"type": "string",
"required": false
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions.json#/definitions/GraphModelDefinitionResponse"
}
},
"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 GraphModel public definition example": {
"$ref": "./examples/GetGraphModelDefinition.json"
}
}
}
},
"/workspaces/{workspaceId}/GraphModels/{GraphModelId}/updateDefinition": {
"post": {
"summary": "Overrides the definition for the specified GraphModel.",
"description": "> [!NOTE]\n> GraphModel 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 GraphModel's definition, does not affect its sensitivity label. \n\n## Permissions\n\n The caller must have *read and write* permissions for the GraphModel. \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_UpdateGraphModelDefinition",
"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": "GraphModelId",
"description": "The GraphModel 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": "updateGraphModelDefinitionRequest",
"description": "Update GraphModel definition request payload.",
"schema": {
"$ref": "./definitions.json#/definitions/UpdateGraphModelDefinitionRequest"
},
"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 GraphModel public definition example": {
"$ref": "./examples/UpdateGraphModelDefinition.json"
}
}
}
},
"/workspaces/{workspaceId}/GraphModels/{GraphModelId}/jobs/RefreshGraph/instances": {
"post": {
"summary": "Run on-demand RefreshGraph job model.",
"description": "> [!NOTE]\n> GraphModel item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\n## Required Delegated Scopes\n\nGraphModel.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"
],
"operationId": "BackgroundJobs_RunOnDemandRefreshGraph",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "GraphModelId",
"description": "The GraphModel item ID.",
"type": "string",
"format": "uuid",
"required": true
}
],
"responses": {
"200": {
"description": "Request completed successfully."
},
"202": {
"description": "Request accepted, job execution is in progress.",
"headers": {
"Location": {
"type": "string",
"description": "The URL to the job instance resource."
},
"Retry-After": {
"type": "integer",
"description": "The number of seconds to wait before retrying the request."
}
}
},
"default": {
"description": "Common error codes:\n\n* MissingMinimalPermisisons - The caller does not have sufficient permissions to run job instance. n\n* InvalidJobType - The requested job type is invalid. \n\n* TooManyRequestsForJobs - The caller is making to many run on-demand job requests. \n\n* ItemNotFound - Requested item id not found.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Run on demand refresh graph job.": {
"$ref": "./examples/RunOnDemandRefreshGraph.json"
}
}
}
},
"/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",
"tags": [
"Items"
],
"operationId": "Items_ExecuteQuery_(preview)",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "GraphModelId",
"description": "The GraphModel ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "body",
"name": "createQueryResultRequest",
"description": "Execute query request payload.",
"schema": {
"$ref": "./definitions.json#/definitions/ExecuteQueryRequest"
},
"required": true
},
{
"name": "preview",
"in": "query",
"required": true,
"type": "boolean",
"description": "This required parameter must be set to `true` to access this API, which is currently in preview."
}
],
"responses": {
"200": {
"description": "Query execution completed successfully. Results are in JSON format. Refer to the [MSFT GQL API](https://aka.ms/msft-gqlapi) on how to read the data.",
"schema": {
"type": "file",
"format": "binary"
}
},
"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": {
"Execute a graph query example": {
"$ref": "./examples/ExecuteQuery.json"
}
}
}
},
"/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",
"tags": [
"Items"
],
"operationId": "Items_GetQueryableGraphType_(preview)",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "GraphModelId",
"description": "The GraphModel ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"name": "preview",
"in": "query",
"required": true,
"type": "boolean",
"description": "This required parameter must be set to `true` to access this API, which is currently in preview."
}
],
"responses": {
"200": {
"description": "The current queryable graph type.",
"schema": {
"$ref": "./definitions.json#/definitions/GraphType"
}
},
"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 queryable graph type example": {
"$ref": "./examples/GetQueryableGraphType.json"
}
}
}
}
},
"responses": {},
"security": [],
"tags": []
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/graphQuerySet/definitions.json
+135
View File
@@ -0,0 +1,135 @@
{
"swagger": "2.0",
"info": {
"title": "GraphQuerySet data types",
"version": "v1"
},
"paths": {},
"definitions": {
"GraphQuerySet": {
"description": "A graph queryset object.",
"type": "object",
"required": ["type"],
"allOf": [
{
"$ref": "../common/definitions.json#/definitions/Item"
}
]
},
"GraphQuerySets": {
"description": "A list of graph queryset objects.",
"required": ["value"],
"type": "object",
"properties": {
"value": {
"description": "A list of graph queryset objects.",
"type": "array",
"items": {
"$ref": "#/definitions/GraphQuerySet"
}
}
},
"allOf": [
{
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
}
]
},
"CreateGraphQuerySetRequest": {
"description": "Create GraphQuerySet request payload.",
"required": ["displayName"],
"properties": {
"displayName": {
"description": "The GraphQuerySet display name. The display name must follow naming rules according to item type.",
"type": "string",
"readOnly": false
},
"description": {
"description": "The GraphQuerySet description. Maximum length is 256 characters.",
"type": "string",
"readOnly": false
},
"definition": {
"description": "The GraphQuerySet public definition.",
"$ref": "#/definitions/GraphQuerySetPublicDefinition",
"readOnly": false
}
}
},
"UpdateGraphQuerySetDefinitionRequest": {
"description": "Update GraphQuerySet public definition request payload.",
"required": ["definition"],
"properties": {
"definition": {
"$ref": "#/definitions/GraphQuerySetPublicDefinition"
}
}
},
"GraphQuerySetDefinitionResponse": {
"description": "GraphQuerySet public definition response.",
"required": ["definition"],
"properties": {
"definition": {
"$ref": "#/definitions/GraphQuerySetPublicDefinition",
"readOnly": true
}
}
},
"GraphQuerySetPublicDefinition" : {
"description": "GraphQuerySet public definition object. Refer to this [article](/rest/api/fabric/articles/item-management/definitions/graph-queryset) for more details on how to craft a GraphQuerySet public definition.",
"type": "object",
"required": ["parts"],
"properties": {
"format": {
"description": "The format of the item definition. Currently we support json format.",
"type": "string",
"readOnly": false
},
"parts": {
"description": "A list of definition parts.",
"type": "array",
"items": {
"$ref": "#/definitions/GraphQuerySetPublicDefinitionPart"
},
"readOnly": false
}
}
},
"GraphQuerySetPublicDefinitionPart": {
"description": "GraphQuerySet definition part object.",
"type": "object",
"properties": {
"path": {
"description": "The GraphQuerySet public definition part path.",
"type": "string",
"readOnly": false
},
"payload": {
"description": "The GraphQuerySet public definition part payload.",
"type": "string",
"readOnly": false
},
"payloadType":{
"description": "The payload type.",
"$ref": "../common/definitions.json#/definitions/PayloadType",
"readOnly": false
}
}
},
"UpdateGraphQuerySetRequest": {
"description": "Update GraphQuerySet request.",
"properties": {
"displayName": {
"description": "The GraphQuerySet display name. The display name must follow naming rules according to item type.",
"type": "string",
"readOnly": false
},
"description": {
"description": "The GraphQuerySet description. Maximum length is 256 characters.",
"type": "string",
"readOnly": false
}
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/graphQuerySet/examples/CreateGraphQuerySet.json
+37
View File
@@ -0,0 +1,37 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"createGraphQuerySetRequest": {
"displayName": "GraphQuerySet 1",
"description": "A GraphQuerySet description.",
"definition": {
"format": "json",
"parts": [
{
"path": "graphQuerySet.json",
"payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
"payloadType": "InlineBase64"
}
]
}
}
},
"responses": {
"201": {
"body": {
"displayName": "GraphQuerySet 1",
"description": "A GraphQuerySet description.",
"type": "GraphQuerySet",
"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
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/graphQuerySet/examples/CreateGraphQuerySetWithoutDefinition.json
+27
View File
@@ -0,0 +1,27 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"createGraphQuerySetRequest": {
"displayName": "GraphQuerySet 1",
"description": "A GraphQuerySet description."
}
},
"responses": {
"201": {
"body": {
"displayName": "GraphQuerySet 1",
"description": "A GraphQuerySet description.",
"type": "GraphQuerySet",
"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
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/graphQuerySet/examples/DeleteGraphQuerySet.json
+9
View File
@@ -0,0 +1,9 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"GraphQuerySetId": "5b218778-e7a5-4d73-8187-f10824047715"
},
"responses": {
"200": {}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/graphQuerySet/examples/GetGraphQuerySet.json
+17
View File
@@ -0,0 +1,17 @@
{
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"GraphQuerySetId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
},
"responses": {
"200": {
"body": {
"id": "5b218778-e7a5-4d73-8187-f10824047715",
"displayName": "GraphQuerySet 1",
"description": "A GraphQuerySet description.",
"type": "GraphQuerySet",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/graphQuerySet/examples/GetGraphQuerySetDefinition.json
+29
View File
@@ -0,0 +1,29 @@
{
"parameters": {
"workspaceId": "6e335e92-a2a2-4b5a-970a-bd6a89fbb765",
"GraphQuerySetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
},
"responses": {
"200": {
"body": {
"definition": {
"format": "json",
"parts": [
{
"path": "graphQuerySet.json",
"payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
"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
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/graphQuerySet/examples/ListGraphQuerySetsInWorkspace.json
+27
View File
@@ -0,0 +1,27 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "3546052c-ae64-4526-b1a8-52af7761426f",
"displayName": "GraphQuerySet Name 1",
"description": "A GraphQuerySet description.",
"type": "GraphQuerySet",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
},
{
"id": "f697fb63-abd4-4399-9548-be7e3c3c0dac",
"displayName": "GraphQuerySet Name 2",
"description": "A GraphQuerySet description.",
"type": "GraphQuerySet",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
}
]
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/graphQuerySet/examples/UpdateGraphQuerySet.json
+21
View File
@@ -0,0 +1,21 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"GraphQuerySetId": "5b218778-e7a5-4d73-8187-f10824047715",
"updateGraphQuerySetRequest": {
"displayName": "GraphQuerySet's New name",
"description": "GraphQuerySet's New description"
}
},
"responses": {
"200": {
"body": {
"displayName": "GraphQuerySet's New name",
"description": "GraphQuerySet's New description",
"type": "GraphQuerySet",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"id": "5b218778-e7a5-4d73-8187-f10824047715"
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/graphQuerySet/examples/UpdateGraphQuerySetDefinition.json
+30
View File
@@ -0,0 +1,30 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"GraphQuerySetId": "5b218778-e7a5-4d73-8187-f10824047715",
"updateMetadata" : true,
"updateGraphQuerySetDefinitionRequest": {
"definition": {
"format": "json",
"parts": [
{
"path": "graphQuerySet.json",
"payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
"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
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/graphQuerySet/swagger.json
+456
View File
@@ -0,0 +1,456 @@
{
"swagger": "2.0",
"info": {
"title": "GraphQuerySet REST APIs",
"version": "v1"
},
"schemes": [
"https"
],
"host": "api.fabric.microsoft.com",
"basePath": "/v1",
"paths": {
"/workspaces/{workspaceId}/GraphQuerySets": {
"get": {
"summary": "Returns a list of graph querysets from the specified workspace.",
"description": "This 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_ListGraphQuerySets",
"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/GraphQuerySets"
}
},
"default": {
"description": "Common error codes:\n\n* InvalidItemType - Invalid item type.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List GraphQuerySets in workspace example": {
"$ref": "./examples/ListGraphQuerySetsInWorkspace.json"
}
}
},
"post": {
"summary": "Creates a GraphQuerySet in the specified workspace.",
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n To create GraphQuerySet with a public definition, refer to [GraphQuerySet](/rest/api/fabric/articles/item-management/definitions/graph-queryset) article. \n\n ## Permissions \n The caller must have a *contributor* workspace role. \n\n## Required Delegated Scopes\n\n GraphQuerySet.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations \n- To create a GraphQuerySet 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) | Yes |\n\n## Interface",
"tags": [
"Items"
],
"operationId": "Items_CreateGraphQuerySet",
"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": "createGraphQuerySetRequest",
"description": "Create item request payload.",
"schema": {
"$ref": "./definitions.json#/definitions/CreateGraphQuerySetRequest"
},
"required": true
}
],
"responses": {
"201": {
"description": "Successfully created",
"schema": {
"$ref": "./definitions.json#/definitions/GraphQuerySet"
}
},
"202": {
"description": "Request accepted, GraphQuerySet 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 GraphQuerySet example": {
"$ref": "./examples/CreateGraphQuerySetWithoutDefinition.json"
},
"Create a GraphQuerySet with public definition example": {
"$ref": "./examples/CreateGraphQuerySet.json"
}
}
}
},
"/workspaces/{workspaceId}/GraphQuerySets/{GraphQuerySetId}": {
"get": {
"summary": "Returns properties of the specified GraphQuerySet.",
"description": "## Permissions\n\n The caller must have *read* permissions for the workspace. \n\n## Required Delegated Scopes\n\n GraphQuerySet.Read.All or GraphQuerySet.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",
"tags": [
"Items"
],
"operationId": "Items_GetGraphQuerySet",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "GraphQuerySetId",
"description": "The GraphQuerySet ID.",
"type": "string",
"format": "uuid",
"required": true
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions.json#/definitions/GraphQuerySet"
}
},
"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 GraphQuerySet example": {
"$ref": "./examples/GetGraphQuerySet.json"
}
}
},
"patch": {
"summary": "Updates the properties of the specified GraphQuerySet.",
"description": "## Permissions\n\n The caller must have *read and write* permissions for the workspace.\n\n## Required Delegated Scopes\n\n GraphQuerySet.ReadWrite.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_UpdateGraphQuerySet",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "GraphQuerySetId",
"description": "The GraphQuerySet ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "body",
"name": "updateGraphQuerySetRequest",
"description": "Update GraphQuerySet request payload.",
"schema": {
"$ref": "./definitions.json#/definitions/UpdateGraphQuerySetRequest"
},
"required": true
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions.json#/definitions/GraphQuerySet"
}
},
"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 GraphQuerySet example": {
"$ref": "./examples/UpdateGraphQuerySet.json"
}
}
},
"delete": {
"summary": "Deletes the specified GraphQuerySet.",
"description": "## Permissions\n\n The caller must have *write* permissions for the workspace. \n\n## Required Delegated Scopes\n\n GraphQuerySet.ReadWrite.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_DeleteGraphQuerySet",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "GraphQuerySetId",
"description": "The GraphQuerySet 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 GraphQuerySet example": {
"$ref": "./examples/DeleteGraphQuerySet.json"
}
}
}
},
"/workspaces/{workspaceId}/GraphQuerySets/{GraphQuerySetId}/getDefinition": {
"post": {
"summary": "Returns the specified graph queryset public definition.",
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a GraphQuerySet'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 workspace. \n\n## Required Delegated Scopes\n\n GraphQuerySet.ReadWrite.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_GetGraphQuerySetDefinition",
"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": "GraphQuerySetId",
"description": "The GraphQuerySet ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "query",
"name": "format",
"description": "The format of the GraphQuerySet public definition.",
"type": "string",
"required": false
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions.json#/definitions/GraphQuerySetDefinitionResponse"
}
},
"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 GraphQuerySet public definition example": {
"$ref": "./examples/GetGraphQuerySetDefinition.json"
}
}
}
},
"/workspaces/{workspaceId}/GraphQuerySets/{GraphQuerySetId}/updateDefinition": {
"post": {
"summary": "Overrides the definition for the specified graph queryset.",
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n \nUpdating the GraphQuerySet's definition, does not affect its sensitivity label. \n\n## Permissions\n\n The caller must have *read and write* permissions for the workspace. \n## Required Delegated Scopes\n\n GraphQuerySet.ReadWrite.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_UpdateGraphQuerySetDefinition",
"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": "GraphQuerySetId",
"description": "The GraphQuerySet 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": "updateGraphQuerySetDefinitionRequest",
"description": "Update GraphQuerySet definition request payload.",
"schema": {
"$ref": "./definitions.json#/definitions/UpdateGraphQuerySetDefinitionRequest"
},
"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 GraphQuerySet public definition example": {
"$ref": "./examples/UpdateGraphQuerySetDefinition.json"
}
}
}
}
},
"responses": {},
"security": [],
"tags": []
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/lakehouse/examples/GetSessionInItemId.json
+8 -1
View File
@@ -51,7 +51,14 @@
"capacityId": "3c0cd366-dc28-4b6d-a525-4d415a8666e7",
"operationName": "Batch Livy Run",
"runtimeVersion": "1.3",
"livySessionItemResourceUri": ""
"livySessionItemResourceUri": "",
"driverMemory": 4,
"driverCores": 2,
"executorMemory": 8,
"executorCores": 4,
"numExecutors": 10,
"isDynamicAllocationEnabled": true,
"dynamicAllocationMaxExecutors": 20
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/lakehouse/examples/ListSessionsInItemId.json
+8 -1
View File
@@ -54,7 +54,14 @@
"capacityId": "3c0cd366-dc28-4b6d-a525-4d415a8666e7",
"operationName": "Batch Livy Run",
"runtimeVersion": "1.3",
"livySessionItemResourceUri": ""
"livySessionItemResourceUri": "",
"driverMemory": 4,
"driverCores": 2,
"executorMemory": 8,
"executorCores": 4,
"numExecutors": 10,
"isDynamicAllocationEnabled": true,
"dynamicAllocationMaxExecutors": 20
}
]
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/lakehouse/examples/ListSessionsInItemId_preview.json
+72
View File
@@ -0,0 +1,72 @@
{
"parameters": {
"workspaceId": "f8113ba8-dd81-443e-811a-b385340f3f05",
"lakehouseId": "8cee7699-2e81-4121-9a53-cc9025046193",
"preview": true,
"submitter.id": "6f23a8a6-d954-4550-b91a-4df73ccd0311"
},
"responses": {
"200": {
"body": {
"continuationToken": null,
"continuationUri": null,
"value": [
{
"sparkApplicationId": "application_1730933685452_0001",
"state": "Cancelled",
"livyId": "9611f500-bf44-42e0-a0de-78dacb374398",
"origin": "SubmittedJob",
"attemptNumber": 1,
"maxNumberOfAttempts": 1,
"livyName": "random_test_name_app",
"submitter": {
"id": "6f23a8a6-d954-4550-b91a-4df73ccd0311",
"type": "User"
},
"item": {
"workspaceId": "f8113ba8-dd81-443e-811a-b385340f3f05",
"itemId": "8cee7699-2e81-4121-9a53-cc9025046193",
"referenceType": "ById"
},
"itemName": "lh_itemName",
"itemType": "Lakehouse",
"jobType": "SparkBatch",
"submittedDateTime": "2025-01-31T15:32:03Z",
"startDateTime": "2025-01-31T15:34:11Z",
"endDateTime": "2025-01-31T15:37:30Z",
"queuedDuration": {
"value": 1,
"timeUnit": "Seconds"
},
"runningDuration": {
"value": 180,
"timeUnit": "Seconds"
},
"totalDuration": {
"value": 360,
"timeUnit": "Seconds"
},
"jobInstanceId": "c2baabbd-5327-430c-87a6-ff4f98285601",
"creatorItem": {
"workspaceId": "f8113ba8-dd81-443e-811a-b385340f3f05",
"itemId": "8cee7699-2e81-4121-9a53-cc9025046193",
"referenceType": "ById"
},
"cancellationReason": "User cancelled the Spark batch",
"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
}
]
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/lakehouse/swagger.json
+99 -1
View File
@@ -599,7 +599,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 *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",
"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",
"operationId": "LivySessions_ListLivySessions",
"x-ms-pageable": {
"nextLinkName": "continuationUri"
@@ -652,6 +652,104 @@
}
}
},
"/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": [
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/mirroredAzureDatabricksCatalog/examples/CreateMirroredAzureDatabricksCatalogWithDefinition.json
+1 -1
View File
@@ -7,7 +7,7 @@
"definition": {
"parts": [
{
"path": "mirroredAzureDatabricksCatalog.json",
"path": "definition.json",
"payload": "eyAicHJvcGVydGllcy..WJsZSIgfSB9IH0gXSB9IH0",
"payloadType": "InlineBase64"
},
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/mirroredAzureDatabricksCatalog/examples/GetMirroredAzureDatabricksCatalogDefinition.json
+1 -1
View File
@@ -9,7 +9,7 @@
"definition": {
"parts": [
{
"path": "mirroredAzureDatabricksCatalog.json",
"path": "definition.json",
"payload": "eyAicHJvcGVydGllcy..WJsZSIgfSB9IH0gXSB9IH0",
"payloadType": "InlineBase64"
},
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/mirroredAzureDatabricksCatalog/examples/UpdateMirroredAzureDatabricksCatalogDefinition.json
+1 -1
View File
@@ -7,7 +7,7 @@
"definition": {
"parts": [
{
"path": "mirroredAzureDatabricksCatalog.json",
"path": "definition.json",
"payload": "eyAicHJvcGVydGllcy..WJsZSIgfSB9IH0gXSB9IH0",
"payloadType": "InlineBase64"
},
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/mirroredAzureDatabricksCatalog/swagger.json
+2 -2
View File
@@ -187,7 +187,7 @@
},
"patch": {
"summary": "Updates the properties of the specified mirroredAzureDatabricksCatalog.",
"description": "> [!NOTE]\n> Mirrored Azure Databricks Catalog 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 mirrored azure databricks catalog. \n\n## Required Delegated Scopes \n\n MirroredAzureDatabricksCatalog.ReadWrite.All or Item.ReadWrite.All\n\n [!NOTE]\n> Item.Execute.All is required if you are updating AutoSync property.\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> Mirrored Azure Databricks Catalog 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 mirrored azure databricks catalog. \n\n## Required Delegated Scopes \n\n MirroredAzureDatabricksCatalog.ReadWrite.All or Item.ReadWrite.All\n\n > [!NOTE]\n> Item.Execute.All is required if you are updating AutoSync property.\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"
],
@@ -366,7 +366,7 @@
"/workspaces/{workspaceId}/mirroredAzureDatabricksCatalogs/{mirroredAzureDatabricksCatalogId}/updateDefinition": {
"post": {
"summary": "Overrides the definition for the specified mirroredAzureDatabricksCatalog.",
"description": "> [!NOTE]\n> Mirrored Azure Databricks Catalog 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 mirrored azure databricks catalog. \n## Required Delegated Scopes \n\n MirroredAzureDatabricksCatalog.ReadWrite.All or Item.ReadWrite.All\n\n [!NOTE]\n> Item.Execute.All is required if you are updating AutoSync property.\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> Mirrored Azure Databricks Catalog 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 mirrored azure databricks catalog. \n## Required Delegated Scopes \n\n MirroredAzureDatabricksCatalog.ReadWrite.All or Item.ReadWrite.All\n\n> [!NOTE]\n> Item.Execute.All is required if you are updating AutoSync property.\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"
],
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/mlModel/definitions.json
+21 -12
View File
@@ -8,7 +8,7 @@
"definitions": {
"MLModels": {
"description": "A list of machine learning models.",
"required": ["value"],
"required": [ "value" ],
"type": "object",
"properties": {
"value": {
@@ -28,7 +28,7 @@
"MLModel": {
"description": "A machine learning model object.",
"type": "object",
"required": ["type"],
"required": [ "type" ],
"allOf": [
{
"$ref": "../common/definitions.json#/definitions/Item"
@@ -37,7 +37,7 @@
},
"CreateMLModelRequest": {
"description": "Create machine learning model request payload.",
"required": ["displayName"],
"required": [ "displayName" ],
"properties": {
"displayName": {
"description": "The machine learning model display name. The display name must follow naming rules according to item type.",
@@ -50,16 +50,16 @@
"readOnly": false
},
"folderId": {
"description": "The folder ID. If not specified or null, the machine learning model is created with the workspace as its folder.",
"type": "string",
"format": "uuid",
"readOnly": false
"description": "The folder ID. If not specified or null, the machine learning model is created with the workspace as its folder.",
"type": "string",
"format": "uuid",
"readOnly": false
}
}
},
"UpdateMLModelDefinitionRequest": {
"description": "Update machine learning model public definition request payload.",
"required": ["definition"],
"required": [ "definition" ],
"properties": {
"definition": {
"$ref": "#/definitions/MLModelDefinition"
@@ -68,7 +68,7 @@
},
"MLModelDefinitionResponse": {
"description": "Machine learning model public definition response.",
"required": ["definition"],
"required": [ "definition" ],
"properties": {
"definition": {
"$ref": "#/definitions/MLModelDefinition",
@@ -76,10 +76,10 @@
}
}
},
"MLModelDefinition" : {
"MLModelDefinition": {
"description": "Machine learning model public definition object.",
"type": "object",
"required": ["parts"],
"required": [ "parts" ],
"properties": {
"format": {
"description": "The format of the item definition.",
@@ -110,7 +110,7 @@
"type": "string",
"readOnly": false
},
"payloadType":{
"payloadType": {
"description": "The payload type.",
"$ref": "../common/definitions.json#/definitions/PayloadType",
"readOnly": false
@@ -226,6 +226,15 @@
},
"scaleRule": {
"$ref": "#/definitions/ScaleRule"
},
"failureDetails": {
"description": "Activation Failure details.",
"type": "object",
"allOf": [
{
"$ref": "../common/definitions.json#/definitions/ErrorResponseDetails"
}
]
}
}
},
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/mlModel/examples/GetMLModel.json
+1 -1
View File
@@ -14,4 +14,4 @@
}
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/mlModel/examples/GetMLModelEndpoint.json
+75 -75
View File
@@ -1,78 +1,78 @@
{
"parameters": {
"workspaceId": "cf5fef71-f7f3-43f3-ae7f-3c427922bef1",
"modelId": "7e92a6fc-3ef5-40bf-96df-ddae3fcde313"
},
"responses": {
"200": {
"body": {
"defaultVersionAssignmentBehavior": "StaticallyConfigured",
"defaultVersionName": "1",
"defaultVersionInfo": {
"versionName": "1",
"status": "Running",
"inputSignature": [
{
"type": "double",
"name": "age",
"required": true
},
{
"type": "double",
"name": "sex",
"required": true
},
{
"type": "double",
"name": "bmi",
"required": true
},
{
"type": "double",
"name": "bp",
"required": true
},
{
"type": "double",
"name": "s1",
"required": true
},
{
"type": "double",
"name": "s2",
"required": true
},
{
"type": "double",
"name": "s3",
"required": true
},
{
"type": "double",
"name": "s4",
"required": true
},
{
"type": "double",
"name": "s5",
"required": true
},
{
"type": "double",
"name": "s6",
"required": true
}
],
"outputSignature": [
{
"type": "double",
"name": "target",
"required": true
}
],
"scaleRule": "AlwaysOn"
}
"parameters": {
"workspaceId": "cf5fef71-f7f3-43f3-ae7f-3c427922bef1",
"modelId": "7e92a6fc-3ef5-40bf-96df-ddae3fcde313"
},
"responses": {
"200": {
"body": {
"defaultVersionAssignmentBehavior": "StaticallyConfigured",
"defaultVersionName": "1",
"defaultVersionInfo": {
"versionName": "1",
"status": "Running",
"inputSignature": [
{
"type": "double",
"name": "age",
"required": true
},
{
"type": "double",
"name": "sex",
"required": true
},
{
"type": "double",
"name": "bmi",
"required": true
},
{
"type": "double",
"name": "bp",
"required": true
},
{
"type": "double",
"name": "s1",
"required": true
},
{
"type": "double",
"name": "s2",
"required": true
},
{
"type": "double",
"name": "s3",
"required": true
},
{
"type": "double",
"name": "s4",
"required": true
},
{
"type": "double",
"name": "s5",
"required": true
},
{
"type": "double",
"name": "s6",
"required": true
}
],
"outputSignature": [
{
"type": "double",
"name": "target",
"required": true
}
],
"scaleRule": "AlwaysOn"
}
}
}
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/mlModel/examples/GetMLModelEndpointVersionWithFailureDetails.json
+19
View File
@@ -0,0 +1,19 @@
{
"parameters": {
"workspaceId": "cf5fef71-f7f3-43f3-ae7f-3c427922bef1",
"modelId": "7e92a6fc-3ef5-40bf-96df-ddae3fcde313",
"name": "1"
},
"responses": {
"200": {
"body": {
"versionName": "1",
"status": "Failed",
"failureDetails": {
"errorCode": "InvalidInput",
"message": "Tensor-based models are not supported yet."
}
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/mlModel/examples/GetMLModelEndpointWithFailureDetails.json
+22
View File
@@ -0,0 +1,22 @@
{
"parameters": {
"workspaceId": "cf5fef71-f7f3-43f3-ae7f-3c427922bef1",
"modelId": "7e92a6fc-3ef5-40bf-96df-ddae3fcde313"
},
"responses": {
"200": {
"body": {
"defaultVersionAssignmentBehavior": "StaticallyConfigured",
"defaultVersionName": "1",
"defaultVersionInfo": {
"versionName": "1",
"status": "Failed",
"failureDetails": {
"errorCode": "InvalidInput",
"message": "Tensor-based models are not supported yet."
}
}
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/mlModel/examples/ListMLModelEndpointVersions.json
+5 -1
View File
@@ -73,7 +73,11 @@
},
{
"versionName": "2",
"status": "Deactivated"
"status": "Failed",
"failureDetails": {
"errorCode": "InvalidInput",
"message": "Tensor-based models are not supported yet."
}
}
]
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/mlModel/examples/UpdateMLModelEndpointVersionWithFailureDetails.json
+22
View File
@@ -0,0 +1,22 @@
{
"parameters": {
"workspaceId": "cf5fef71-f7f3-43f3-ae7f-3c427922bef1",
"modelId": "7e92a6fc-3ef5-40bf-96df-ddae3fcde313",
"name": "1",
"updateMLModelEndpointVersionRequest": {
"scaleRule": "AllowScaleToZero"
}
},
"responses": {
"200": {
"body": {
"versionName": "1",
"status": "Failed",
"failureDetails": {
"errorCode": "InvalidInput",
"message": "Tensor-based models are not supported yet."
}
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/mlModel/examples/UpdateMLModelEndpointWithFailureDetails.json
+26
View File
@@ -0,0 +1,26 @@
{
"parameters": {
"workspaceId": "cf5fef71-f7f3-43f3-ae7f-3c427922bef1",
"modelId": "7e92a6fc-3ef5-40bf-96df-ddae3fcde313",
"updateMLModelEndpointRequest": {
"defaultVersionAssignmentBehavior": "StaticallyConfigured",
"defaultVersionName": "1"
}
},
"responses": {
"200": {
"body": {
"defaultVersionAssignmentBehavior": "StaticallyConfigured",
"defaultVersionName": "1",
"defaultVersionInfo": {
"versionName": "1",
"status": "Failed",
"failureDetails": {
"errorCode": "InvalidInput",
"message": "Tensor-based models are not supported yet."
}
}
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/mlModel/swagger.json
+18 -5
View File
@@ -330,8 +330,11 @@
}
},
"x-ms-examples": {
"Example": {
"Example of Get ML Model Endpoint": {
"$ref": "./examples/GetMLModelEndpoint.json"
},
"Example of Get ML Model Endpoint with an Activation Failure": {
"$ref": "./examples/GetMLModelEndpointWithFailureDetails.json"
}
}
},
@@ -386,8 +389,11 @@
}
},
"x-ms-examples": {
"Example": {
"Example of Update ML Model Endpoint": {
"$ref": "./examples/UpdateMLModelEndpoint.json"
},
"Example of Update ML Model Endpoint with an Activation Failure": {
"$ref": "./examples/UpdateMLModelEndpointWithFailureDetails.json"
}
}
}
@@ -563,8 +569,11 @@
}
},
"x-ms-examples": {
"Example": {
"Example of Get ML Model Endpoint Version": {
"$ref": "./examples/GetMLModelEndpointVersion.json"
},
"Example of Get ML Model Endpoint Version with an Activation Failure": {
"$ref": "./examples/GetMLModelEndpointVersionWithFailureDetails.json"
}
}
},
@@ -626,8 +635,11 @@
}
},
"x-ms-examples": {
"Example": {
"Example of Update ML Model Endpoint Version": {
"$ref": "./examples/UpdateMLModelEndpointVersion.json"
},
"Example of Update ML Model Endpoint Version with an Activation Failure": {
"$ref": "./examples/UpdateMLModelEndpointVersionWithFailureDetails.json"
}
}
}
@@ -930,7 +942,8 @@
}
},
"x-ms-examples": {
"Example": {
"Example":
{
"$ref": "./examples/ScoreMLModelEndpointVersion.json"
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/notebook/examples/GetSessionInItemId.json
+8 -1
View File
@@ -51,7 +51,14 @@
"capacityId": "3c0cd366-dc28-4b6d-a525-4d415a8666e7",
"operationName": "Batch Livy Run",
"runtimeVersion": "1.3",
"livySessionItemResourceUri": ""
"livySessionItemResourceUri": "",
"driverMemory": 4,
"driverCores": 2,
"executorMemory": 8,
"executorCores": 4,
"numExecutors": 10,
"isDynamicAllocationEnabled": true,
"dynamicAllocationMaxExecutors": 20
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/notebook/examples/ListSessionsInItemId.json
+8 -1
View File
@@ -54,7 +54,14 @@
"capacityId": "3c0cd366-dc28-4b6d-a525-4d415a8666e7",
"operationName": "Batch Livy Run",
"runtimeVersion": "1.3",
"livySessionItemResourceUri": ""
"livySessionItemResourceUri": "",
"driverMemory": 4,
"driverCores": 2,
"executorMemory": 8,
"executorCores": 4,
"numExecutors": 10,
"isDynamicAllocationEnabled": true,
"dynamicAllocationMaxExecutors": 20
}
]
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/notebook/examples/ListSessionsInItemId_preview.json
+72
View File
@@ -0,0 +1,72 @@
{
"parameters": {
"workspaceId": "f8113ba8-dd81-443e-811a-b385340f3f05",
"notebookId": "8cee7699-2e81-4121-9a53-cc9025046193",
"preview": true,
"submitter.id": "6f23a8a6-d954-4550-b91a-4df73ccd0311"
},
"responses": {
"200": {
"body": {
"continuationToken": null,
"continuationUri": null,
"value": [
{
"sparkApplicationId": "application_1730933685452_0001",
"state": "Cancelled",
"livyId": "9611f500-bf44-42e0-a0de-78dacb374398",
"origin": "SubmittedJob",
"attemptNumber": 1,
"maxNumberOfAttempts": 1,
"livyName": "random_test_name_app",
"submitter": {
"id": "6f23a8a6-d954-4550-b91a-4df73ccd0311",
"type": "User"
},
"item": {
"workspaceId": "f8113ba8-dd81-443e-811a-b385340f3f05",
"itemId": "8cee7699-2e81-4121-9a53-cc9025046193",
"referenceType": "ById"
},
"itemName": "nb_itemName",
"itemType": "Notebook",
"jobType": "SparkBatch",
"submittedDateTime": "2025-01-31T15:32:03Z",
"startDateTime": "2025-01-31T15:34:11Z",
"endDateTime": "2025-01-31T15:37:30Z",
"queuedDuration": {
"value": 1,
"timeUnit": "Seconds"
},
"runningDuration": {
"value": 180,
"timeUnit": "Seconds"
},
"totalDuration": {
"value": 360,
"timeUnit": "Seconds"
},
"jobInstanceId": "c2baabbd-5327-430c-87a6-ff4f98285601",
"creatorItem": {
"workspaceId": "f8113ba8-dd81-443e-811a-b385340f3f05",
"itemId": "8cee7699-2e81-4121-9a53-cc9025046193",
"referenceType": "ById"
},
"cancellationReason": "User cancelled the Spark batch",
"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
}
]
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/notebook/swagger.json
+101 -3
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 *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",
"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",
"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,6 +517,104 @@
}
}
},
"/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": [
@@ -524,7 +622,7 @@
],
"operationId": "LivySessions_GetLivySession",
"summary": "Returns properties of the specified livy session.",
"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",
"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",
"produces": [
"application/json"
],
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/platform/definitions/platform.json
+7 -7
View File
@@ -1,10 +1,10 @@
{
"swagger": "2.0",
"info": {
"version": "v1",
"title": "Platform data types"
},
"paths": {},
"swagger": "2.0",
"info": {
"version": "v1",
"title": "Platform data types"
},
"paths": {},
"definitions": {
"Workspaces": {
"required": [ "value" ],
@@ -1727,7 +1727,7 @@
"type": "string",
"enum": [ "NotStarted", "InProgress", "Completed", "Failed", "Cancelled", "Deduped" ],
"x-ms-enum": {
"name": "Status",
"name": "ItemJobStatus",
"modelAsString": true,
"values": [
{
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/platform/definitions/workspaceNetworkingPolicy.json
+150
View File
@@ -68,6 +68,156 @@
}
]
}
},
"WorkspaceOutboundConnections": {
"type": "object",
"description": "Represents the complete set of outbound access protection cloud connection rules configured for a workspace as part of its networking communication policy. \nThis object defines the connection rules that govern which external endpoints and workspaces are permitted or denied for outbound communication",
"properties": {
"defaultAction": {
"description": "Defines the default behavior for all cloud connection types that are not explicitly listed in the rules array. \n If set to \"Allow\", all unspecified connection types are permitted by default. \nIf set to \"Deny\", all unspecified connection types are blocked by default unless explicitly allowed. \nThis setting acts as a global fallback policy and is critical for enforcing a secure default posture in environments where only known and trusted connections should be permitted.",
"$ref": "#/definitions/ConnectionAccessActionType"
},
"rules": {
"type": "array",
"description": "A list of rules that define outbound access behavior for specific cloud connection types. Each rule may include endpoint-based or workspace-based restrictions depending on supported connection types.",
"items": {
"$ref": "#/definitions/OutboundConnectionRule"
}
}
}
},
"OutboundConnectionRule": {
"type": "object",
"description": "Defines an outbound access rule for a specific cloud connection.",
"required": [
"connectionType"
],
"properties": {
"connectionType": {
"type": "string",
"description": "Specifies the cloud connection type to which the rule applies. The behavior and applicability of other rule properties (such as allowedEndpoints or allowedWorkspaces) may vary depending on the capabilities of connection type."
},
"defaultAction": {
"description": "Defines the default outbound access behavior for the connectionType. This field determines whether connections of this type are permitted or blocked by default, unless further refined by allowedEndpoints or allowedWorkspaces. \n If set to \"Allow\": All connections of this type are permitted unless explicitly denied by a more specific rule. This field provides fine-grained control over each connection type and complements the global fallback behavior defined by defaultAction.",
"$ref": "#/definitions/ConnectionAccessActionType"
},
"allowedEndpoints": {
"type": "array",
"description": "Defines a list of explicitly permitted external endpoints for the connectionType. Each entry in the array represents a hostname pattern that is allowed for outbound communication from the workspace. This field is applicable only to connection types that support endpoint-based filtering (e.g., SQL, MySQL, Web, etc.). If defaultAction is set to \"Deny\" for the connection type, only the endpoints listed here will be allowed; all others will be blocked.",
"items": {
"$ref": "#/definitions/ConnectionRuleEndpointMetadata"
}
},
"allowedWorkspaces": {
"type": "array",
"description": "Specifies a list of workspace IDs that are explicitly permitted for outbound communication for the given fabric connectionType. This field is applicable only to fabric connection types that support workspace-based filtering, limited to Lakehouse, Warehouse, FabricSql, and PowerPlatformDataflows. When defaultAction is set to \"Deny\" for a connection type, only the workspaces listed in allowedWorkspaces will be allowed for outbound access; all others will be blocked.",
"items": {
"$ref": "#/definitions/ConnectionRuleWorkspaceMetadata"
}
}
}
},
"ConnectionRuleEndpointMetadata": {
"type": "object",
"description": "Represents a single endpoint-level exception rule that allows outbound communication to a specific external domain or host. This object is used within the allowedEndpoints array of a connection rule to explicitly authorize outbound access to trusted endpoints for a given connectionType. This is applicable only to connection types that support endpoint-based filtering (e.g., SQL, MySQL, Web, etc.).",
"properties": {
"hostNamePattern": {
"type": "string",
"description": "A wildcard-supported pattern that defines the allowed external endpoint. Examples include *.microsoft.com, api.contoso.com, or data.partner.org."
}
},
"required": [
"hostNamePattern"
]
},
"ConnectionRuleWorkspaceMetadata": {
"type": "object",
"description": "Represents a workspace-level exception rule that allows outbound communication to a specific workspace for a given connectionType. This object is used within the allowedWorkspaces array of a connection rule to explicitly authorize cross-workspace access. This is applicable only to connection types that support workspace-based filtering, such as Lakehouse, Warehouse, FabricSql, and PowerPlatformDataflows.",
"properties": {
"workspaceId": {
"type": "string",
"format": "uuid",
"description": "The unique identifier (GUID) of the target workspace that is allowed to be connected from current workspace."
}
},
"required": [
"workspaceId"
]
},
"ConnectionAccessActionType": {
"type": "string",
"description": "Defines the access control behavior for outbound connections. This enum is used for the field defaultAction to specify whether outbound communication should be allowed or denied by default. \nThis type enables both global and connection-specific control over outbound access, helping enforce secure and predictable network communication policies. Additional connection access action types may be added over time.",
"enum": [
"Allow",
"Deny"
],
"x-ms-enum": {
"name": "ConnectionAccessActionType",
"modelAsString": true,
"values": [
{
"value": "Allow",
"description": "Permits outbound connections. When used as a default action, all cloud connections are allowed."
},
{
"value": "Deny",
"description": "Blocks outbound connections. When used as a default action, all cloud connections are denied unless explicitly allowed."
}
]
}
},
"WorkspaceOutboundGateways": {
"type": "object",
"description": "Represents the complete set of gateway outbound access protection rules configured for a workspace as part of its networking communication policy. \nThis object defines the gateway rules that govern outbound communication",
"properties": {
"defaultAction": {
"description": "Defines the default behavior for all gateways that are not explicitly listed in the allowed list array. \n If set to \"Allow\", all unspecified gateways are permitted by default. \nIf set to \"Deny\", all unspecified gateways are blocked.",
"$ref": "#/definitions/GatewayAccessActionType"
},
"allowedGateways": {
"type": "array",
"description": "A list of rules that define outbound access behavior for gateways.",
"items": {
"$ref": "#/definitions/GatewayAccessRuleMetadata"
}
}
}
},
"GatewayAccessRuleMetadata": {
"type": "object",
"description": "Represents a gateway that is allowed for outbound communication. This object is used within the allowedGateways to explicitly authorize outbound access.",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Gateway Id to be allowed."
}
},
"required": [
"id"
]
},
"GatewayAccessActionType": {
"type": "string",
"description": "Defines the access control behavior for outbound gateways. This enum is used for the field defaultAction to specify whether outbound communication should be allowed or denied by default. \nThis type enables both global and gateway-specific control over outbound access, helping enforce secure and predictable network communication policies. Additional gateway access action types may be added over time.",
"enum": [
"Allow",
"Deny"
],
"x-ms-enum": {
"name": "GatewayAccessActionType",
"modelAsString": true,
"values": [
{
"value": "Allow",
"description": "Permits outbound gateways. When used as a default action, all gateways are allowed."
},
{
"value": "Deny",
"description": "Blocks outbound gateways. When used as a default action, all gateways are denied unless explicitly allowed."
}
]
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/platform/examples/platform/GetWorkspaceGitNetworkingCommunicationPolicy.json
+15
View File
@@ -0,0 +1,15 @@
{
"parameters": {
"workspaceId": "47482db6-4583-4672-86dd-999d0f8f4d7a"
},
"responses": {
"200": {
"body": {
"defaultAction": "Deny"
},
"headers": {
"ETag": "0f8fad5b-d9cb-469f-a165-70867728950e"
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/platform/examples/platform/GetWorkspaceOutboundConnections.json
+39
View File
@@ -0,0 +1,39 @@
{
"parameters": {
"workspaceId": "47482db6-4583-4672-86dd-999d0f8f4d7a"
},
"responses": {
"200": {
"body": {
"defaultAction": "Deny",
"rules": [
{
"connectionType": "SQL",
"defaultAction": "Deny",
"allowedEndpoints": [
{
"hostNamePattern": "*.microsoft.com"
}
]
},
{
"connectionType": "LakeHouse",
"defaultAction": "Deny",
"allowedWorkspaces": [
{
"workspaceId": "91c5ae74-e82d-4dd3-bfeb-6b1814030123"
}
]
},
{
"connectionType": "Web",
"defaultAction": "Allow"
}
]
},
"headers": {
"ETag": "0f8fad5b-d9cb-469f-a165-70867728950e"
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/platform/examples/platform/GetWorkspaceOutboundGateways.json
+20
View File
@@ -0,0 +1,20 @@
{
"parameters": {
"workspaceId": "47482db6-4583-4672-86dd-999d0f8f4d7a"
},
"responses": {
"200": {
"body": {
"defaultAction": "Deny",
"allowedGateways": [
{
"id": "91c5ae74-e82d-4dd3-bfeb-6b1814030123"
}
]
},
"headers": {
"ETag": "0f8fad5b-d9cb-469f-a165-70867728950e"
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/platform/examples/platform/SetWorkspaceGitNetworkingCommunicationPolicy.json
+15
View File
@@ -0,0 +1,15 @@
{
"parameters": {
"workspaceId": "47482db6-4583-4672-86dd-999d0f8f4d7a",
"SetWorkspaceGitNetworkingCommunicationPolicy": {
"defaultAction": "Allow"
}
},
"responses": {
"200": {
"headers": {
"ETag": "0f8fad5b-d9cb-469f-a165-70867728950e"
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/platform/examples/platform/SetWorkspaceOutboundConnections.json
+39
View File
@@ -0,0 +1,39 @@
{
"parameters": {
"workspaceId": "47482db6-4583-4672-86dd-999d0f8f4d7a",
"WorkspaceOutboundConnections": {
"defaultAction": "Deny",
"rules": [
{
"connectionType": "SQL",
"defaultAction": "Deny",
"allowedEndpoints": [
{
"hostNamePattern": "*.microsoft.com"
}
]
},
{
"connectionType": "LakeHouse",
"defaultAction": "Deny",
"allowedWorkspaces": [
{
"workspaceId": "91c5ae74-e82d-4dd3-bfeb-6b1814030123"
}
]
},
{
"connectionType": "Web",
"defaultAction": "Allow"
}
]
}
},
"responses": {
"200": {
"headers": {
"ETag": "0f8fad5b-d9cb-469f-a165-70867728950e"
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/platform/examples/platform/SetWorkspaceOutboundGateways.json
+23
View File
@@ -0,0 +1,23 @@
{
"parameters": {
"workspaceId": "47482db6-4583-4672-86dd-999d0f8f4d7a",
"WorkspaceOutboundGateways": {
"defaultAction": "Deny",
"allowedGateways": [
{
"id": "91c5ae74-e82d-4dd3-bfeb-6b1814030123"
},
{
"id": "25bac802-080d-4f73-8a42-1b406eb1fceb"
}
]
}
},
"responses": {
"200": {
"headers": {
"ETag": "0f8fad5b-d9cb-469f-a165-70867728950e"
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/platform/swagger.json
+325 -87
View File
@@ -2486,66 +2486,66 @@
],
"x-ms-fabric-sdk-long-running-operation": true,
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The ID of the workspace.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "itemId",
"description": "The ID of the data item.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "query",
"name": "shortcutConflictPolicy",
"description": "When provided, it defines the action to take when a shortcut with the same name and path already exists. The default action is 'Abort'. Additional ShortcutConflictPolicy types may be added over time.",
"type": "string",
"enum": [
"Abort",
"GenerateUniqueName",
"CreateOrOverwrite",
"OverwriteOnly"
],
"x-ms-enum": {
"name": "ShortcutConflictPolicy",
"modelAsString": true,
"values": [
{
"value": "Abort",
"description": "When a shortcut with the same name and path already exists the shortcut creation will be cancelled."
},
{
"value": "GenerateUniqueName",
"description": "When a shortcut with the same name and path already exists the shortcut creation will continue with a new unique shortcut name."
},
{
"value": "CreateOrOverwrite",
"description": "When a shortcut with the same name and path already exists the shortcut creation will overwrite the existing shortcut. Create shortcut if it does not exist."
},
{
"value": "OverwriteOnly",
"description": "When a shortcut with the same name and path already exists the shortcut creation will overwrite the existing shortcut."
}
]
{
"in": "path",
"name": "workspaceId",
"description": "The ID of the workspace.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "itemId",
"description": "The ID of the data item.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "query",
"name": "shortcutConflictPolicy",
"description": "When provided, it defines the action to take when a shortcut with the same name and path already exists. The default action is 'Abort'. Additional ShortcutConflictPolicy types may be added over time.",
"type": "string",
"enum": [
"Abort",
"GenerateUniqueName",
"CreateOrOverwrite",
"OverwriteOnly"
],
"x-ms-enum": {
"name": "ShortcutConflictPolicy",
"modelAsString": true,
"values": [
{
"value": "Abort",
"description": "When a shortcut with the same name and path already exists the shortcut creation will be cancelled."
},
"required": false
},
{
"in": "body",
"name": "bulkCreateShortcutsRequest",
"description": "A shortcut bulk create request includes an array of shortcut objects, each representing a reference pointing to internal or external storage locations within OneLake.",
"schema": {
"$ref": "./definitions/platform.json#/definitions/BulkCreateShortcutsRequest"
{
"value": "GenerateUniqueName",
"description": "When a shortcut with the same name and path already exists the shortcut creation will continue with a new unique shortcut name."
},
"required": true
}
{
"value": "CreateOrOverwrite",
"description": "When a shortcut with the same name and path already exists the shortcut creation will overwrite the existing shortcut. Create shortcut if it does not exist."
},
{
"value": "OverwriteOnly",
"description": "When a shortcut with the same name and path already exists the shortcut creation will overwrite the existing shortcut."
}
]
},
"required": false
},
{
"in": "body",
"name": "bulkCreateShortcutsRequest",
"description": "A shortcut bulk create request includes an array of shortcut objects, each representing a reference pointing to internal or external storage locations within OneLake.",
"schema": {
"$ref": "./definitions/platform.json#/definitions/BulkCreateShortcutsRequest"
},
"required": true
}
],
"responses": {
"202": {
@@ -3025,7 +3025,7 @@
}
}
},
"/domains/{domainId}":{
"/domains/{domainId}": {
"get": {
"summary": "Returns specified domain information.",
"description": "## Required Delegated Scopes\n\nDomain.Read.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",
@@ -5500,7 +5500,7 @@
"/workspaces/{workspaceId}/managedPrivateEndpoints": {
"get": {
"summary": "Returns a list of managed private endpoints associated with the specified workspace.",
"description": "## Permissions\n\n The 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",
"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## Permissions\n\n The 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",
"tags": [
"ManagedPrivateEndpoints"
],
@@ -5553,7 +5553,7 @@
},
"post": {
"summary": "Creates a managed private endpoint in the specified workspace.",
"description": "## Permissions\n\nThe caller must have *admin* workspace role.\n\n## Required Delegated Scopes \n\nWorkspace.ReadWrite.All.\n\n## Limitations \n- To create managed private endpoint 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) | 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\n## Permissions\n\nThe caller must have *admin* workspace role.\n\n## Required Delegated Scopes \n\nWorkspace.ReadWrite.All.\n\n## Limitations \n- To create managed private endpoint 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) | Yes |\n\n## Interface",
"tags": [
"ManagedPrivateEndpoints"
],
@@ -5606,9 +5606,6 @@
"x-ms-examples": {
"Create a managed private endpoint example": {
"$ref": "./examples/managedPrivateEndpoint/CreateManagedPrivateEndpoint.json"
},
"Create a managed private endpont with FQDNs example": {
"$ref": "./examples/managedPrivateEndpoint/CreateManagedPrivateEndpointWithFQDNs.json"
}
}
}
@@ -5616,7 +5613,7 @@
"/workspaces/{workspaceId}/managedPrivateEndpoints/{managedPrivateEndpointId}": {
"delete": {
"summary": "Deletes the specified managed private endpoint.",
"description": "## Permissions\n\nThe caller must have *admin* workspace role.\n\n## Required Delegated Scopes \n\nWorkspace.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 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## Permissions\n\nThe caller must have *admin* workspace role.\n\n## Required Delegated Scopes \n\nWorkspace.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": [
"ManagedPrivateEndpoints"
],
@@ -5661,7 +5658,7 @@
},
"get": {
"summary": "Gets the specified managed private endpoint.",
"description": "## 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",
"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## 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",
"tags": [
"ManagedPrivateEndpoints"
],
@@ -7022,17 +7019,255 @@
}
}
},
"/workspaces/{workspaceId}/managedPrivateEndpoints/{managedPrivateEndpointId}/targetFQDNs": {
"/workspaces/{workspaceId}/networking/communicationPolicy/outbound/connections": {
"get": {
"summary": "Returns a list of fully qualified domain names (FQDNs) associated with the specified managed private endpoint.",
"description": "## Permissions\n\n The 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",
"summary": "Returns the cloud connection rules for the workspace enabled with Outbound Access Protection (OAP). This API is designed to help workspace administrators view the effective outbound network communication policies that are enforced for cloud connections. Outbound access protection cloud connection rules are only returned and applied if the workspace’s network communication policy has `outbound.publicAccessRules.defaultAction` set to Deny. If OAP is not enabled on workspace, API fails as outbound connections are not being restricted. This feature is currently in 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## Permissions\n\n The 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",
"tags": [
"ManagedPrivateEndpoints"
"Workspaces"
],
"operationId": "ManagedPrivateEndpoints_ListFQDNs",
"x-ms-pageable": {
"nextLinkName": "continuationUri"
"operationId": "Workspaces_GetOutboundCloudConnectionRules",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "Unique identifier of the workspace whose outbound rules are being queried.",
"type": "string",
"format": "uuid",
"required": true
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions/workspaceNetworkingPolicy.json#/definitions/WorkspaceOutboundConnections"
},
"headers": {
"ETag": {
"type": "string"
}
}
},
"default": {
"description": "Common error codes:\n\n* UnknownError - An error occurred.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get workspace outbound access protection cloud connection rule for example": {
"$ref": "./examples/platform/GetWorkspaceOutboundConnections.json"
}
}
},
"put": {
"summary": "Sets the outbound access protection cloud connection rules for the workspace. This API enables workspace administrators to set of outbound network communication rules that control which cloud connection types and their external endpoints/workspaces where ever applicable are to be allowed from the workspace. This feature is currently in 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> [!NOTE]\n> Outbound access protection rules are only enforced if the workspace’s network communication policy has outbound.publicAccessRules.defaultAction set to Deny. If OAP is not enabled on workspace, API fails as outbound connections are not being restricted. \n\n> [!NOTE]\n> This API uses the PUT method and will overwrite all outbound access connections for the workspace. Remaining policy will be set to default value if partial policy is provided in the request body. Always run Get first and provide full policy in the request body.\n\n## Permissions\n\nThe caller must have *admin* workspace role.\n\n## Required Delegated Scopes \n\nWorkspace.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": [
"Workspaces"
],
"operationId": "Workspaces_SetOutboundCloudConnectionRules",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "Unique identifier of the workspace to update.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "body",
"name": "WorkspaceOutboundConnections",
"description": "Set outbound access protection cloud connection rules for the workspace request payload.",
"schema": {
"$ref": "./definitions/workspaceNetworkingPolicy.json#/definitions/WorkspaceOutboundConnections"
},
"required": true
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"headers": {
"ETag": {
"type": "string"
}
}
},
"default": {
"description": "Common error codes:\n\n* UnknownError - An error occurred.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Set workspace outbound access protection cloud connection rule for example": {
"$ref": "./examples/platform/SetWorkspaceOutboundConnections.json"
}
}
}
},
"/workspaces/{workspaceId}/networking/communicationPolicy/outbound/gateways": {
"get": {
"summary": "Returns the gateway rules for the workspace enabled with Outbound Access Protection (OAP). This API is designed to help workspace administrators view the effective outbound network communication policies that are enforced for On-prem and Vnet Data gateways. Outbound access protection gateway rules are only returned and applied if the workspace’s network communication policy has outbound.publicAccessRules.defaultAction set to Deny. If OAP is not enabled on workspace, API fails as outbound connections are not being restricted. This feature is currently in 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## Permissions\n\n The 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",
"tags": [
"Workspaces"
],
"operationId": "Workspaces_GetOutboundGatewayRules",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "Unique identifier of the workspace whose outbound rules are being queried.",
"type": "string",
"format": "uuid",
"required": true
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions/workspaceNetworkingPolicy.json#/definitions/WorkspaceOutboundGateways"
},
"headers": {
"ETag": {
"type": "string"
}
}
},
"default": {
"description": "Common error codes:\n\n* UnknownError - An error occurred.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get workspace outbound access protection gateway rule for example": {
"$ref": "./examples/platform/GetWorkspaceOutboundGateways.json"
}
}
},
"put": {
"summary": "Sets the gateway rules for the workspace enabled with Outbound Access Protection (OAP). This API enables workspace administrators to define, replace, or override the set of outbound network communication policies that control which on-prem /Vnet Data Gateways are to be allowed from current workspace. This feature is currently in 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> [!NOTE]\n> Outbound access protection rules are only enforced if the workspace’s network communication policy has outbound.publicAccessRules.defaultAction set to Deny. If OAP is not enabled on workspace, API fails as outbound connections are not being restricted. \n\n> [!NOTE]\n>This API uses the PUT method and will overwrite all outbound access gateways for the workspace. Remaining policy will be set to default value if partial policy is provided in the request body. Always run Get first and provide full policy in the request body.\n\n## Permissions\n\nThe caller must have *admin* workspace role.\n\n## Required Delegated Scopes \n\nWorkspace.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": [
"Workspaces"
],
"operationId": "Workspaces_SetOutboundGatewayRules",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "Unique identifier of the workspace to update.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "body",
"name": "WorkspaceOutboundGateways",
"description": "Set outbound access protection gateway rules for the workspace request payload.",
"schema": {
"$ref": "./definitions/workspaceNetworkingPolicy.json#/definitions/WorkspaceOutboundGateways"
},
"required": true
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"headers": {
"ETag": {
"type": "string"
}
}
},
"default": {
"description": "Common error codes:\n\n* UnknownError - An error occurred.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Set workspace outbound access protection gateway rule for example": {
"$ref": "./examples/platform/SetWorkspaceOutboundGateways.json"
}
}
}
},
"/workspaces/{workspaceId}/networking/communicationPolicy/outbound/git": {
"get": {
"summary": "Returns Git Outbound policy for the specified workspace.",
"description": "In cases the workspace restricts outbound policy, a workspace admin needs to allow the use of Git integration on the specified workspace. \n\n## Permissions\n\n The 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",
"tags": [
"Workspaces"
],
"operationId": "Workspaces_GetGitOutboundPolicy",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions/workspaceNetworkingPolicy.json#/definitions/NetworkRules"
},
"headers": {
"ETag": {
"type": "string"
}
}
},
"default": {
"description": "Common error codes:\n\n* UnknownError - An error occurred.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get workspace networking communication policy example": {
"$ref": "./examples/platform/GetWorkspaceGitNetworkingCommunicationPolicy.json"
}
}
},
"put": {
"summary": "Sets Git Outbound policy for the specified workspace, when Outbound policy is set to 'Deny'.",
"description": "This API uses the PUT method and will overwrite all settings. In cases the workspace restrict outbound policy, a workspace admin needs to allow the use of Git integration on the specified workspace. When there's no outbound restriction on the workspace, changing this property will fail and it will not impact Git integration setting. \nAlways run Get Git outbound Policy first and provide full policy in the request body.\n\n## Permissions\n\nThe caller must have *admin* workspace role.\n\n## Required Delegated Scopes \n\nWorkspace.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": [
"Workspaces"
],
"operationId": "Workspaces_SetGitOutboundPolicy",
"produces": [
"application/json"
],
@@ -7046,26 +7281,29 @@
"required": true
},
{
"in": "path",
"name": "managedPrivateEndpointId",
"description": "The managed private endpoint ID.",
"type": "string",
"format": "uuid",
"in": "body",
"name": "SetWorkspaceGitNetworkingCommunicationPolicy",
"description": "Set workspace Git outbound policy request payload.",
"schema": {
"$ref": "./definitions/workspaceNetworkingPolicy.json#/definitions/NetworkRules"
},
"required": true
},
{
"in": "query",
"name": "continuationToken",
"description": "A token for retrieving the next page of results.",
"type": "string",
"required": false
"in": "header",
"name": "If-Match",
"description": "An ETag value. The ETag must be specified in quotes. If provided, the call will succeed only if the resource's ETag matches the provided ETag.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions/managedPrivateEndpoint.json#/definitions/ManagedPrivateEndpointTargetFQDNs"
"headers": {
"ETag": {
"type": "string"
}
}
},
"default": {
@@ -7076,8 +7314,8 @@
}
},
"x-ms-examples": {
"List managed private endpoints in workspace example": {
"$ref": "./examples/managedPrivateEndpoint/ListFQDNsInManagedPrivateEndpoint.json"
"Set workspace networking communication policy example": {
"$ref": "./examples/platform/SetWorkspacegitNetworkingCommunicationPolicy.json"
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/spark/examples/ListSessionsInItemId_preview.json
+71
View File
@@ -0,0 +1,71 @@
{
"parameters": {
"workspaceId": "f8113ba8-dd81-443e-811a-b385340f3f05",
"preview": true,
"submitter.id": "6f23a8a6-d954-4550-b91a-4df73ccd0311"
},
"responses": {
"200": {
"body": {
"continuationToken": null,
"continuationUri": null,
"value": [
{
"sparkApplicationId": "application_1730933685452_0001",
"state": "Cancelled",
"livyId": "9611f500-bf44-42e0-a0de-78dacb374398",
"origin": "SubmittedJob",
"attemptNumber": 1,
"maxNumberOfAttempts": 1,
"livyName": "random_test_name_app",
"submitter": {
"id": "6f23a8a6-d954-4550-b91a-4df73ccd0311",
"type": "User"
},
"item": {
"workspaceId": "f8113ba8-dd81-443e-811a-b385340f3f05",
"itemId": "8cee7699-2e81-4121-9a53-cc9025046193",
"referenceType": "ById"
},
"itemName": "spark_itemName",
"itemType": "Spark",
"jobType": "SparkBatch",
"submittedDateTime": "2025-01-31T15:32:03Z",
"startDateTime": "2025-01-31T15:34:11Z",
"endDateTime": "2025-01-31T15:37:30Z",
"queuedDuration": {
"value": 1,
"timeUnit": "Seconds"
},
"runningDuration": {
"value": 180,
"timeUnit": "Seconds"
},
"totalDuration": {
"value": 360,
"timeUnit": "Seconds"
},
"jobInstanceId": "c2baabbd-5327-430c-87a6-ff4f98285601",
"creatorItem": {
"workspaceId": "f8113ba8-dd81-443e-811a-b385340f3f05",
"itemId": "8cee7699-2e81-4121-9a53-cc9025046193",
"referenceType": "ById"
},
"cancellationReason": "User cancelled the Spark batch",
"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
}
]
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/spark/swagger.json
+90
View File
@@ -426,6 +426,96 @@
}
}
}
},
"/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": {},
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/sparkjobdefinition/examples/GetSessionInItemId.json
+8 -1
View File
@@ -51,7 +51,14 @@
"capacityId": "3c0cd366-dc28-4b6d-a525-4d415a8666e7",
"operationName": "Batch Livy Run",
"runtimeVersion": "1.3",
"livySessionItemResourceUri": ""
"livySessionItemResourceUri": "",
"driverMemory": 4,
"driverCores": 2,
"executorMemory": 8,
"executorCores": 4,
"numExecutors": 10,
"isDynamicAllocationEnabled": true,
"dynamicAllocationMaxExecutors": 20
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/sparkjobdefinition/examples/ListSessionsInItemId.json
+8 -1
View File
@@ -54,7 +54,14 @@
"capacityId": "3c0cd366-dc28-4b6d-a525-4d415a8666e7",
"operationName": "Batch Livy Run",
"runtimeVersion": "1.3",
"livySessionItemResourceUri": ""
"livySessionItemResourceUri": "",
"driverMemory": 4,
"driverCores": 2,
"executorMemory": 8,
"executorCores": 4,
"numExecutors": 10,
"isDynamicAllocationEnabled": true,
"dynamicAllocationMaxExecutors": 20
}
]
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/sparkjobdefinition/examples/ListSessionsInItemId_preview.json
+72
View File
@@ -0,0 +1,72 @@
{
"parameters": {
"workspaceId": "f8113ba8-dd81-443e-811a-b385340f3f05",
"sparkJobDefinitionId": "8cee7699-2e81-4121-9a53-cc9025046193",
"preview": true,
"submitter.Id": "6f23a8a6-d954-4550-b91a-4df73ccd0311"
},
"responses": {
"200": {
"body": {
"continuationToken": null,
"continuationUri": null,
"value": [
{
"sparkApplicationId": "application_1730933685452_0001",
"state": "Cancelled",
"livyId": "9611f500-bf44-42e0-a0de-78dacb374398",
"origin": "SubmittedJob",
"attemptNumber": 1,
"maxNumberOfAttempts": 1,
"livyName": "random_test_name_app",
"submitter": {
"id": "6f23a8a6-d954-4550-b91a-4df73ccd0311",
"type": "User"
},
"item": {
"workspaceId": "f8113ba8-dd81-443e-811a-b385340f3f05",
"itemId": "8cee7699-2e81-4121-9a53-cc9025046193",
"referenceType": "ById"
},
"itemName": "lh_itemName",
"itemType": "SparkJobDefinition",
"jobType": "SparkBatch",
"submittedDateTime": "2025-01-31T15:32:03Z",
"startDateTime": "2025-01-31T15:34:11Z",
"endDateTime": "2025-01-31T15:37:30Z",
"queuedDuration": {
"value": 1,
"timeUnit": "Seconds"
},
"runningDuration": {
"value": 180,
"timeUnit": "Seconds"
},
"totalDuration": {
"value": 360,
"timeUnit": "Seconds"
},
"jobInstanceId": "c2baabbd-5327-430c-87a6-ff4f98285601",
"creatorItem": {
"workspaceId": "f8113ba8-dd81-443e-811a-b385340f3f05",
"itemId": "8cee7699-2e81-4121-9a53-cc9025046193",
"referenceType": "ById"
},
"cancellationReason": "User cancelled the Spark batch",
"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
}
]
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/sparkjobdefinition/swagger.json
+100 -2
View File
@@ -531,7 +531,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 *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",
"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",
"operationId": "LivySessions_ListLivySessions",
"x-ms-pageable": {
"nextLinkName": "continuationUri"
@@ -584,6 +584,104 @@
}
}
},
"/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": [
@@ -591,7 +689,7 @@
],
"operationId": "LivySessions_GetLivySession",
"summary": "Returns properties of the specified livy session.",
"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",
"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",
"produces": [
"application/json"
],
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/sqlDatabase/definitions.json
+171 -2
View File
@@ -8,7 +8,7 @@
"definitions": {
"SQLDatabase": {
"description": "A SQL database object.",
"type": "object",
"type": "object",
"required": ["type"],
"allOf": [
{
@@ -57,6 +57,21 @@
"serverFqdn": {
"description": "The server fully qualified domain name (FQDN).",
"type": "string"
},
"earliestRestorePoint": {
"description": "The earliest restore point of the database in UTC, using the YYYY-MM-DDTHH:mm:ssZ format.",
"type": "string",
"format": "date-time"
},
"latestRestorePoint": {
"description": "The latest restore point of the database in UTC, using the YYYY-MM-DDTHH:mm:ssZ format.",
"type": "string",
"format": "date-time"
},
"backupRetentionDays": {
"description": "The backup retention period in days.",
"type": "integer",
"format": "int32"
}
}
},
@@ -79,6 +94,16 @@
"type": "string",
"format": "uuid",
"readOnly": false
},
"creationPayload": {
"description": "The SQL database creation payload.",
"$ref": "#/definitions/SQLDatabaseCreationPayload",
"readOnly": false
},
"definition": {
"description": "The SQL database definition.",
"$ref": "#/definitions/SQLDatabaseDefinition",
"readOnly": false
}
}
},
@@ -91,7 +116,151 @@
"readOnly": false
}
}
}
},
"UpdateSQLDatabaseDefinitionRequest": {
"description": "Update SQL database public definition request payload.",
"required": ["definition"],
"properties": {
"definition": {
"$ref": "#/definitions/SQLDatabaseDefinition"
}
}
},
"SQLDatabaseDefinitionResponse": {
"description": "The SQL database public definition response.",
"required": ["definition"],
"properties": {
"definition": {
"$ref": "#/definitions/SQLDatabaseDefinition",
"readOnly": true
}
}
},
"SQLDatabaseCreationPayload": {
"description": "SQL database item payload.",
"type": "object",
"required": [
"creationMode"
],
"discriminator": "creationMode",
"properties": {
"creationMode": {
"description": "The creation mode of the SQL database creation.",
"$ref": "#/definitions/CreationMode"
},
"backupRetentionDays": {
"description": "Set the backup retention period in days. The minimum is 1 days. The maximum is 35 days.",
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 35
},
"restorePointInTime": {
"description": "Set the time to restore the source database in UTC, using the YYYY-MM-DDTHH:mm:ssZ format.",
"type": "string",
"format": "date-time"
},
"sourceDatabaseReference": {
"description": "Set the reference for the source database to be restored from.",
"$ref": "../common/definitions.json#/definitions/ItemReference"
}
}
},
"CreationMode": {
"description": "The creation mode of the creation payload. Additional CreationMode types may be added over time.",
"type": "string",
"enum": [ "New", "Restore" ],
"x-ms-enum": {
"name": "CreationMode",
"modelAsString": true,
"values": [
{
"value": "New",
"description": "The default creation mode. 'backupRetentionDays' object is accepted in this creation mode."
},
{
"value": "Restore",
"description": "The creation mode of restoring from a source database. 'sourceDatabaseReference' object and 'restorePointInTime' object are required for this creation mode. 'backupRetentionDays' object is not accepted."
}
]
}
},
"NewSQLDatabaseCreationPayload": {
"description": "Create a SQL database item creation payload with supported settings",
"type": "object",
"properties": {
"backupRetentionDays": {
"description": "Set the backup retention period in days. The minimum is 1 days. The maximum is 35 days.",
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 35
}
},
"allOf": [
{
"$ref": "#/definitions/SQLDatabaseCreationPayload"
}
],
"x-ms-discriminator-value": "New"
},
"RestoreSQLDatabaseCreationPayload": {
"description": "Create a SQL database item creation payload with restoring from a source database",
"type": "object",
"properties": {
"restorePointInTime": {
"description": "Set the time to restore the source database in UTC, using the YYYY-MM-DDTHH:mm:ssZ format.",
"type": "string",
"format": "date-time"
},
"sourceDatabaseReference": {
"description": "Set the reference for the source database to be restored from.",
"$ref": "../common/definitions.json#/definitions/ItemReference"
}
},
"allOf": [
{
"$ref": "#/definitions/SQLDatabaseCreationPayload"
}
],
"x-ms-discriminator-value": "Restore"
},
"SQLDatabaseDefinition" : {
"description": "The SQL database public definition object. Refer to this [article](/rest/api/fabric/articles/item-management/definitions/sql-database-definition) for more details on how to craft a SQL database public definition.",
"type": "object",
"required": ["parts"],
"properties": {
"parts": {
"description": "A list of definition parts.",
"type": "array",
"items": {
"$ref": "#/definitions/SQLDatabasePublicDefinitionPart"
},
"readOnly": false
}
}
},
"SQLDatabasePublicDefinitionPart": {
"description": "SQL database definition part object.",
"type": "object",
"properties": {
"path": {
"description": "The SQL database public definition part path.",
"type": "string",
"readOnly": false
},
"payload": {
"description": "The SQL database public definition part payload.",
"type": "string",
"readOnly": false
},
"payloadType":{
"description": "The payload type.",
"$ref": "../common/definitions.json#/definitions/PayloadType",
"readOnly": false
}
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/sqlDatabase/examples/CreateSQLDatabaseWithDefinition.json
+36
View File
@@ -0,0 +1,36 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"createSQLDatabaseRequest": {
"displayName": "SQLDatabase1",
"description": "A SQLDatabase description.",
"definition": {
"parts": [
{
"path": "definition.dacpac",
"payload": "ew0KICAibGFrZWhvdXNlSWQiOiAiYjliNWQzNmYtNDQ0NS00MDNiLWFjODctMDE2YjFjZDIwMjExIg0KfQ==",
"payloadType": "InlineBase64"
}
]
}
}
},
"responses": {
"201": {
"body": {
"displayName": "SQLDatabase 1",
"description": "A SQLDatabase description.",
"type": "SQLDatabase",
"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
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/sqlDatabase/examples/CreateSQLDatabaseWithPayload.json
+36
View File
@@ -0,0 +1,36 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"createSQLDatabaseRequest": {
"displayName": "SQLDatabase1",
"description": "A SQLDatabase description.",
"creationPayload": {
"creationMode": "Restore",
"sourceDatabaseReference": {
"referenceType": "ById",
"itemId": "d96de2f4-7dd1-45ad-9ff6-37a2d6aa9861",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
},
"restorePointInTime": "2024-12-01T00:00:00.000Z"
}
}
},
"responses": {
"201": {
"body": {
"displayName": "SQLDatabase 1",
"description": "A SQLDatabase description.",
"type": "SQLDatabase",
"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
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/sqlDatabase/examples/GetSQLDatabase.json
+4 -1
View File
@@ -14,7 +14,10 @@
"properties": {
"connectionString": "Data Source=fvzeldvqgvce3b2hxvbg4hnjqu-nowrtjcsie2e3ny6v4ojbd3esa.database.fabric.microsoft.com,1433;Initial Catalog=SQLDatabase1-45c6e7cf-89b1-4a69-b4e1-5495271c7e45;MultipleActiveResultSets=False;Connect Timeout=30;Encrypt=True;TrustServerCertificate=False",
"databaseName": "SQLDatabase1-45c6e7cf-89b1-4a69-b4e1-5495271c7e45",
"serverFqdn": "fvzeldvqgvce3b2hxvbg4hnjqu-nowrtjcsie2e3ny6v4ojbd3esa.database.fabric.microsoft.com,1433"
"serverFqdn": "fvzeldvqgvce3b2hxvbg4hnjqu-nowrtjcsie2e3ny6v4ojbd3esa.database.fabric.microsoft.com,1433",
"earliestRestorePoint": "2024-12-01T00:00:00.000Z",
"latestRestorePoint": "2024-12-02T00:00:00.000Z",
"backupRetentionDays": 7
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/sqlDatabase/examples/GetSQLDatabaseDefinition.json
+33
View File
@@ -0,0 +1,33 @@
{
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"SQLDatabaseId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
},
"responses": {
"200": {
"body": {
"definition": {
"parts": [
{
"path": "definition.dacpac",
"payload": "ew0KICAibGFrZWhvdXNlSWQiOiAiYjliNWQzNmYtNDQ0NS00MDNiLWFjODctMDE2YjFjZDIwMjExIg0KfQ==",
"payloadType": "InlineBase64"
},
{
"path": ".platform",
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
"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
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/sqlDatabase/examples/StartMirroring.json
+9
View File
@@ -0,0 +1,9 @@
{
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"SQLDatabaseId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
},
"responses": {
"200": {}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/sqlDatabase/examples/StopMirroring.json
+9
View File
@@ -0,0 +1,9 @@
{
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"SQLDatabaseId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
},
"responses": {
"200": {}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/sqlDatabase/examples/UpdateSQLDatabaseDefinition.json
+33
View File
@@ -0,0 +1,33 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"SQLDatabaseId": "5b218778-e7a5-4d73-8187-f10824047715",
"updateMetadata": true,
"updateSQLDatabaseDefinitionRequest": {
"definition": {
"parts": [
{
"path": "definition.dacpac",
"payload": "ew0KICAibGFrZWhvdXNlSWQiOiAiYjliNWQzNmYtNDQ0NS00MDNiLWFjODctMDE2YjFjZDIwMjExIg0KfQ==",
"payloadType": "InlineBase64"
},
{
"path": ".platform",
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
"payloadType": "InlineBase64"
}
]
}
}
},
"responses": {
"200": {},
"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
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/sqlDatabase/swagger.json
+251 -2
View File
@@ -63,7 +63,7 @@
},
"post": {
"summary": "Creates a SQL database in the specified workspace.",
"description": "> [!NOTE]\n> SQL Database 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 This API does not support create a SQL database with definition. \n\n## Permissions\n\nThe caller must have a *contributor* workspace role.\n\n## Required Delegated Scopes\n\n SQLDatabase.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations \n- To create a SQL database 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) | Yes |\n\n## Interface",
"description": "> [!NOTE]\n> SQL Database 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 a SQL database with a public definition, refer to [SQLDatabase definition](/rest/api/fabric/articles/item-management/definitions/sql-database) article. \n\n## Permissions\n\nThe caller must have a *contributor* workspace role.\n\n## Required Delegated Scopes\n\n SQLDatabase.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations \n- To create a SQL database 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) | Yes |\n\n## Interface",
"tags": [
"Items"
],
@@ -129,6 +129,12 @@
"x-ms-examples": {
"Create a SQLDatabase example": {
"$ref": "./examples/CreateSQLDatabase.json"
},
"Create a SQLDatabase with payload example": {
"$ref": "./examples/CreateSQLDatabaseWithPayload.json"
},
"Create a SQLDatabase with definition example": {
"$ref": "./examples/CreateSQLDatabaseWithDefinition.json"
}
}
}
@@ -287,7 +293,250 @@
}
}
}
}
},
"/workspaces/{workspaceId}/sqlDatabases/{SQLDatabaseId}/getDefinition": {
"post": {
"summary": "Returns the specified SQL database public definition.",
"description": "> [!NOTE]\n> SQL database 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 SQL database'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 SQL database. \n\n## Required Delegated Scopes\n\n SQLDatabase.ReadWrite.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_GetSQLDatabaseDefinition",
"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": "SQLDatabaseId",
"description": "The SQL database ID.",
"type": "string",
"format": "uuid",
"required": true
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions.json#/definitions/SQLDatabaseDefinitionResponse"
}
},
"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 Digital Twin Builder Flow public definition example": {
"$ref": "./examples/GetSQLDatabaseDefinition.json"
}
}
}
},
"/workspaces/{workspaceId}/sqlDatabases/{SQLDatabaseId}/updateDefinition": {
"post": {
"summary": "Overrides the definition for the specified SQL database.",
"description": "> [!NOTE]\n> SQL database 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 Updating the SQL database's definition, does not affect its sensitivity label. \n\n## Permissions\n\n The caller must have *read and write* permissions for the SQL database. \n## Required Delegated Scopes\n\n SQLDatabase.ReadWrite.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_UpdateSQLDatabasesDefinition",
"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": "SQLDatabaseId",
"description": "The SQL database ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "query",
"name": "updateMetadata",
"description": "When set to true and the SQL database.platform file is provided as part of the definition, the item's metadata is updated using the metadata in the SQL database.platform file",
"type": "boolean",
"required": false
},
{
"in": "body",
"name": "updateSQLDatabaseDefinitionRequest",
"description": "Update SQL database definition request payload.",
"schema": {
"$ref": "./definitions.json#/definitions/UpdateSQLDatabaseDefinitionRequest"
},
"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 SQL database public definition example": {
"$ref": "./examples/UpdateSQLDatabaseDefinition.json"
}
}
}
},
"/workspaces/{workspaceId}/sqlDatabases/{SQLDatabaseId}/startMirroring": {
"post": {
"tags": [
"Mirroring"
],
"operationId": "StartMirroring",
"summary": "Starts the mirroring of the specified SQL database..",
"description": "> [!NOTE]\n> SQL database 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 SQL database. \n## Required Delegated Scopes\n\n SQLDatabase.ReadWrite.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"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace identifier.",
"type": "string",
"required": true
},
{
"in": "path",
"name": "SQLDatabaseId",
"description": "The SQL database 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": {
"Start mirroring example": {
"$ref": "./examples/StartMirroring.json"
}
}
}
},
"/workspaces/{workspaceId}/sqlDatabases/{SQLDatabaseId}/stopMirroring": {
"post": {
"tags": [
"Mirroring"
],
"operationId": "StopMirroring",
"summary": "Stops the mirroring of the specified SQL database.",
"description": "> [!NOTE]\n> SQL database 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 SQL database. \n## Required Delegated Scopes\n\n SQLDatabase.ReadWrite.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"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace identifier.",
"type": "string",
"required": true
},
{
"in": "path",
"name": "SQLDatabaseId",
"description": "The SQL database 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": {
"Stop mirroring example": {
"$ref": "./examples/StopMirroring.json"
}
}
}
}
},
"responses": {},
"security": [],
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/item-definitions/dbtjob-definition.md
+153
View File
@@ -0,0 +1,153 @@
---
title: DataBuildToolJob item definition
description: Learn how to create a dbt job item definition when using the Microsoft Fabric REST API.
ms.title: DataBuildToolJob item definition
author: dylanb-microsoft
ms.author: dylanboliske
ms.service: fabric
ms.date: 10/28/2024
---
# DataBuildToolJob item definition
This article provides a breakdown of the definition structure for dbt job (DataBuildToolJob) items.
## Definition parts
This table lists the definition parts.
| Definition part path | type | Required | Description |
|--|--|--|--|
| `dbtjob-content.json` | [ContentDetails](#contentdetails) (JSON) | true | Describes properties and settings of the item like profile and operation |
| `.platform` | PlatformDetails (JSON) | false | Describes common details of the item |
## ContentDetails
Describes content of payload
| Name | Type | Description |
|-----------------------|---------------------|-------------------------------------|
| project | [DbtJobProject](#description-for-dbtjobproject-contents) | dbt job item project settings.|
| profile | [DbtJobProfile](#description-for-dbtjobprofile-contents) | dbt job item profile settings.|
| command | [DbtJobCommand](#description-for-dbtjobcommand-contents) | dbt job item command settings.|
### Description for DbtJobProject contents
| Name | Type | Required | Description |
|-----------------------|-----------------|-----------------|-------------------|
| projectType | String | true | Type of dbt project. Possible values: `OneLake`, `Lakehouse`. |
| folderPath | String | false | Path to the dbt project folder. |
| connectionSettings | [DbtJobConnectionSettings](#description-for-dbtjobconnectionsettings-contents) | true | Connection settings for the dbt project. |
### Description for DbtJobProfile contents
Describes the fields for the dbt profile. Here, depending on the type, either connectionSettings or externalReferences can be used.
| Name | Type | Required | Description |
|-----------------------|-----------------|-----------------|-------------------|
| profileType | String | true | Type of dbt profile. |
| schema | String | false | Specifies the schema. |
| database | String | false | Name of the database. |
| externalReferences | [ExternalReferences](#description-for-externalreferences-contents) | false | Connection settings for the dbt profile. |
| connectionSettings | [DbtJobConnectionSettings](#description-for-dbtjobconnectionsettings-contents) | false | Connection settings for the dbt profile. |
### Description for DbtJobCommand contents
| Name | Type | Required | Description |
|-----------------------|-----------------|-----------------|-------------------|
| operation | String | true | Type of dbt command. Possible values: `run`, `build`, `show`, `seed`, `compile`, `test`, `snapshot`. |
| arguments | [DbtJobCommandArgument](#description-for-dbtjobcommandargument-contents) | false | Other arguments for the dbt command. |
### Description for DbtJobCommandArgument contents
| Name | Type | Required | Description |
|-----------------------|-----------------|-----------------|-------------------|
| select | String | false | Comma separated list of models to include. |
| exclude | String | false | Comma separated list of models to exclude. |
| fullRefresh | Boolean | false | Specifies if dbt should rebuild all models. |
| failFast | Boolean | false | Specifies if dbt should exit as soon as a model fails. |
| threads | Integer | false | Specifies the number of threads to use. |
| selectorName | String | false | Specifies the selector to use. |
### Description for ExternalReferences contents
| Name | Type | Required | Description |
|-----------------------|-----------------|-----------------|-------------------|
| connection | String (Guid) | true | Specifies the ID of the connection.|
### Description for DbtJobConnectionSettings contents
Describes the fields for Connection Settings.
| Name | Type | Required | Description |
|-----------------------|-----------------|-----------------|-------------------|
| type | String | true | Describes the type of connection. |
| properties | [DbtJobConnectionTypeProperties](#description-for-dbtjobconnectiontypeproperties-contents) | true | Describes the properties for the connection.|
### Description for DbtJobConnectionTypeProperties contents
| Name | Type | Required | Description |
|-----------------------|-----------------|-----------------|-------------------|
| workspaceId | String (Guid) | true | Specifies the ID for the workspace in which the connected item exists.|
| artifactId | String (Guid) | true | Specifies the ID for the connected item.|
| rootFolder | String | false | Specifies the root folder.|
| endpoint | String | false | Specifies the endpoint.|
### ContentDetails Example 1
```json
{
"project": {
"projectType": "OneLake",
"connectionSettings": {
"type": "OneLake"
}
},
"profile": {
"profileType": "DataWarehouse",
"schema": "analytics_schema",
"connectionSettings": {
"type": "DataWarehouse",
"properties": {
"workspaceId": "00000000-0000-0000-0000-000000000000",
"artifactId": "cccccccc-3333-4444-5555-dddddddddddd"
}
}
},
"command": {
"operation": "run",
"arguments": {
"select": "model_a,model_b",
"fullRefresh": true,
"threads": 4
}
}
}
```
### ContentDetails Example 2
```json
{
"project": {
"projectType": "OneLake",
"connectionSettings": {
"type": "OneLake"
}
},
"profile": {
"profileType": "PostgreSql",
"schema": "analytics_schema",
"externalReferences": {
"connection": "bbbbbbbb-9999-aaaa-bbbb-cccccccccccc"
}
},
"command": {
"operation": "build",
"arguments": {
"fullRefresh": true,
"failFast": true
}
}
}
```
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/item-definitions/operations-agent-definition.md
+140
View File
@@ -0,0 +1,140 @@
---
title: Operations agent definition
description: Learn how to structure an operations agent item definition when using the Microsoft Fabric REST API.
ms.title: Microsoft Fabric operations agent item definition
author: jeromez
ms.author: jeromez
ms.service: fabric
ms.date: 09/18/2025
---
# Operations Agent definition
This article provides a breakdown of the definition structure for operations agent items.
## Definition parts
| Definition part path | type | Required | Description |
|--|--|--|--|
| `Configurations.json` | [OperationsAgentDefinition](#operationsagentdefinition-contents) (JSON) | true | Root definition containing configuration (goals, instructions, data sources, actions), playbook, and run state |
## OperationsAgentDefinition contents
Root shape of the definition payload.
| Name | Type | Required | Description |
|------|------|----------|-------------|
| configuration | [OperationsAgentConfiguration](#operationsagentconfiguration-contents) | true | User-authored configuration: goals, instructions, data sources, and actions |
| playbook | Object | true | Playbook definition (reserved for future expansion). Provide an empty object `{}` if not authored |
| shouldRun | Boolean | true | Whether the agent should currently run (`true`) or stay stopped (`false`) |
### OperationsAgentConfiguration contents
| Name | Type | Required | Description |
|------|------|----------|-------------|
| goals | String | true | Business goals for the agent to accomplish |
| instructions | String | true | Explicit instructions / procedures the agent should follow |
| dataSources | Object (dictionary of [DataSource](#datasource-contents)) | true | Map of user-chosen data source aliases to data source objects |
| actions | Object (dictionary of [Action](#action-contents)) | true | Map of user-chosen action aliases to action objects |
| recipient | String | false | Recipient of the operation |
Notes:
- The keys inside `dataSources` and `actions` are user-defined aliases (for example, `primaryKusto`, `notifyFlow`).
- Provide at least one data source and one action for a meaningful agent.
### DataSource contents
Represents a Fabric data source the agent can read from.
| Name | Type | Required | Description |
|------|------|----------|-------------|
| id | String (GUID) | true | Unique identifier for the data source reference |
| type | String (enum) | true | Data source type. Currently only `KustoDatabase` is supported |
| workspaceId | String (GUID) | true | Workspace ID containing the data source |
Supported `type` values:
- `KustoDatabase`
### Action contents
Represents an action the agent can invoke (for example, a Power Automate flow action).
| Name | Type | Required | Description |
|------|------|----------|-------------|
| id | String (GUID) | true | Unique identifier for the action reference |
| displayName | String | true | The display name for the action |
| description | String | true | The description for the action |
| kind | String (enum) | true | Action kind. Currently only `PowerAutomateAction` is supported |
| parameters | [Parameter](#parameter-contents)[] | false | Optional parameter metadata list |
Supported `kind` values:
- `PowerAutomateAction`
### Parameter contents
Metadata describing an action parameter (name & optional description). Doesn't include value binding (values are supplied operationally when the action runs or elsewhere in configuration not shown here).
| Name | Type | Required | Description |
|------|------|----------|-------------|
| name | String | true | Parameter name |
| description | String | false | Human-friendly description |
## OperationsAgentDefinition JSON skeleton
Minimal structural skeleton (showing required properties):
```json
{
"configuration": {
"goals": "<business goals>",
"instructions": "<agent instructions>",
"dataSources": {},
"actions": {}
},
"playbook": {},
"shouldRun": true
}
```
## OperationsAgentDefinition example
```json
{
"configuration": {
"goals": "Reduce manual triage of operations logs.",
"instructions": "Monitor Kusto database metrics and trigger flow on thresholds.",
"dataSources": {
"primaryKusto": {
"id": "11111111-2222-3333-4444-555555555555",
"type": "KustoDatabase",
"workspaceId": "66666666-7777-8888-9999-aaaaaaaaaaaa"
}
},
"actions": {
"notifyFlow": {
"id": "bbbbbbbb-cccc-dddd-eeee-ffffffffffff",
"kind": "PowerAutomateAction",
"displayName": "PowerAutomateAlert",
"description": "A PowerAutomate action to send out alert",
"parameters": [
{ "name": "Severity", "description": "Alert severity level" }
]
}
},
"recipient": "test@consoto.com"
},
"playbook": {},
"shouldRun": true
}
```
## Notes
- All GUID strings must be valid UUIDs.
- Provide an empty object for `playbook` until extended schema details are published.
- Use concise, action-oriented statements in `goals` and imperative steps in `instructions`.
- Keys under `dataSources` and `actions` should be unique within their respective objects.
- Future schema versions may introduce more data source `type` values and action `kind` values; validation rejects unknown values.