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 (#901)

Browse Source 
* Update static resources

* item definitions

* Make links absolute

* Make links absolute 2

* Remove locale
This commit is contained in:
Amos Hersch authored and GitHub committed 2025-10-21 19:38:59 +03:00
1 parent 435ff9c503
commit f7b5b9e056
228 files changed
+19165 -4451
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
+6
View File
@@ -54,6 +54,12 @@
"format": "uuid",
"readOnly": true,
"description": "The capacity ID of the workspace."
},
"domainId": {
"type": "string",
"format": "uuid",
"readOnly": true,
"description": "The domain ID of the workspace."
}
}
},
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/admin/definitions/domains.json
+119 -14
View File
@@ -6,13 +6,12 @@
},
"paths": {},
"definitions": {
"Domain": {
"DomainBase": {
"type": "object",
"description": "Represents a domain or subdomain.",
"required": [
"id",
"displayName",
"contributorsScope"
"displayName"
],
"properties": {
"id": {
@@ -32,11 +31,46 @@
"type": "string",
"description": "The domain parent object ID.",
"format": "uuid"
},
}
}
},
"DomainPreview": {
"properties": {
"contributorsScope": {
"description": "The domain contributors scope.",
"$ref": "#/definitions/ContributorsScopeType"
}
},
"allOf": [
{
"$ref": "#/definitions/DomainBase"
}
]
},
"Domain": {
"properties": {
"defaultLabelId": {
"type": "string",
"description": "The domain default sensitivity label.",
"format": "uuid"
}
},
"allOf": [
{
"$ref": "#/definitions/DomainBase"
}
]
},
"DomainsResponsePreview": {
"description": "This is a response wrapper for a list of all domains.",
"properties": {
"domains": {
"type": "array",
"description": "The list of domains.",
"items": {
"$ref": "#/definitions/DomainPreview"
}
}
}
},
"DomainsResponse": {
@@ -87,7 +121,8 @@
}
]
},
"UpdateDomainRequest": {
"UpdateDomainRequestBase": {
"type": "object",
"description": "The request payload for updating a domain.",
"properties": {
"displayName": {
@@ -99,12 +134,35 @@
"type": "string",
"description": "The domain description.\nThe description cannot contain more than 256 characters.",
"readOnly": false
},
}
}
},
"UpdateDomainRequestPreview": {
"properties": {
"contributorsScope": {
"description": "The domain contributors scope.",
"$ref": "#/definitions/ContributorsScopeType"
}
}
},
"allOf": [
{
"$ref": "#/definitions/UpdateDomainRequestBase"
}
]
},
"UpdateDomainRequest": {
"properties": {
"defaultLabelId": {
"type": "string",
"description": "The domain default sensitivity label.\n\nTo remove the defaultLabelId from a domain, set its value to an empty UUID in your request: \"00000000-0000-0000-0000-000000000000\".",
"format": "uuid"
}
},
"allOf": [
{
"$ref": "#/definitions/UpdateDomainRequestBase"
}
]
},
"DomainRoleUnassignmentRequest": {
"description": "The request payload for unassigning domain members by principal.",
@@ -144,6 +202,18 @@
}
}
},
"SyncRoleAssignmentsToSubdomainsRequest": {
"description": "The request payload for syncing domain members to subdomains.",
"required": [
"role"
],
"properties": {
"role": {
"description": "Specifies the role of members to be synchronized with subdomains.",
"$ref": "#/definitions/DomainRole"
}
}
},
"AssignDomainWorkspacesByPrincipalsRequest": {
"description": "The request payload for assigning workspaces to a domain by principal.",
"properties": {
@@ -222,20 +292,20 @@
"type": "string",
"description": "Represents the domain members by the principal's request type. Additional request types may be added over time.",
"enum": [
"Admins",
"Contributors"
"Admin",
"Contributor"
],
"x-ms-enum": {
"name": "DomainRole",
"modelAsString": true,
"values": [
{
"value": "Admins",
"description": "Domain admins request type."
"value": "Admin",
"description": "Domain admin."
},
{
"value": "Contributors",
"description": "Domain contributors request type."
"value": "Contributor",
"description": "Domain contributor."
}
]
}
@@ -266,6 +336,41 @@
}
]
}
},
"DomainRoleAssignment": {
"type": "object",
"description": "Represents a domain role assignment.",
"required": [
"role",
"principal"
],
"properties": {
"role": {
"description": "The domain role of the principal.",
"$ref": "#/definitions/DomainRole"
},
"principal": {
"description": "The principal.",
"$ref": "../../common/definitions.json#/definitions/Principal"
}
}
},
"DomainRoleAssignments": {
"description": "A response wrapper for a list of domain role assignments with a continuation token.",
"properties": {
"value": {
"type": "array",
"description": "The list of the domain role assignments.",
"items": {
"$ref": "#/definitions/DomainRoleAssignment"
}
}
},
"allOf": [
{
"$ref": "../../common/definitions.json#/definitions/PaginatedResponse"
}
]
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/admin/definitions/tags.json
+8 -1
View File
@@ -26,6 +26,9 @@
],
"description": "This is a request wrapper for a creating a list of tags.",
"properties": {
"scope": {
"$ref": "../../common/definitions.json#/definitions/TagScope"
},
"createTagsRequest": {
"type": "array",
"description": "An array of createTagRequest",
@@ -70,7 +73,8 @@
"description": "Represents a tag.",
"required": [
"id",
"displayName"
"displayName",
"scope"
],
"properties": {
"id": {
@@ -81,6 +85,9 @@
"displayName": {
"type": "string",
"description": "The name of the tag."
},
"scope": {
"$ref": "../../common/definitions.json#/definitions/TagScope"
}
}
},
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/admin/examples/AdminListTags.json
+31 -7
View File
@@ -6,31 +6,55 @@
"value": [
{
"id": "bc23d4c6-cc92-4eb6-bcb5-0ff98429bbff",
"displayName": "Finance"
"displayName": "Finance",
"scope": {
"type": "Tenant"
}
},
{
"id": "b0bca781-003c-4041-b1c4-f94d34ba76d4",
"displayName": "Human resources"
"displayName": "Human resources",
"scope": {
"type": "Tenant"
}
},
{
"id": "6af5a1b6-bc4c-4c0a-b60d-30c68e6e3034",
"displayName": "Engineering P1"
"displayName": "Engineering P1",
"scope": {
"type": "Tenant"
}
},
{
"id": "6c00e8eb-51d4-46f7-8b90-7e98520ea7a0",
"displayName": "Marketing Q1"
"displayName": "Marketing Q1",
"scope": {
"type": "Tenant"
}
},
{
"id": "17df435d-9efd-48c1-a937-7d6fd70ab26a",
"displayName": "HR Sales Q1"
"displayName": "HR Sales Q1",
"scope": {
"type": "Domain",
"domainId": "2443f5f3-b2bb-46ad-a240-1550f1938569"
}
},
{
"id": "fb765fe3-d404-4f24-9d67-5916449c4c50",
"displayName": "Root"
"displayName": "Root",
"scope": {
"type": "Domain",
"domainId": "2443f5f3-b2bb-46ad-a240-1550f1938569"
}
},
{
"id": "bda31be4-7efe-4272-8b85-e1b2ff0f0592",
"displayName": "Legal EMEA"
"displayName": "Legal EMEA",
"scope": {
"type": "Domain",
"domainId": "2443f5f3-b2bb-46ad-a240-1550f1938569"
}
}
]
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/admin/examples/AdminListTagsWithContinuation.json
+31 -7
View File
@@ -6,31 +6,55 @@
"value": [
{
"id": "bc23d4c6-cc92-4eb6-bcb5-0ff98429bbff",
"displayName": "Finance"
"displayName": "Finance",
"scope": {
"type": "Tenant"
}
},
{
"id": "b0bca781-003c-4041-b1c4-f94d34ba76d4",
"displayName": "Human resources"
"displayName": "Human resources",
"scope": {
"type": "Tenant"
}
},
{
"id": "6af5a1b6-bc4c-4c0a-b60d-30c68e6e3034",
"displayName": "Engineering P1"
"displayName": "Engineering P1",
"scope": {
"type": "Tenant"
}
},
{
"id": "6c00e8eb-51d4-46f7-8b90-7e98520ea7a0",
"displayName": "Marketing Q1"
"displayName": "Marketing Q1",
"scope": {
"type": "Tenant"
}
},
{
"id": "17df435d-9efd-48c1-a937-7d6fd70ab26a",
"displayName": "HR Sales Q1"
"displayName": "HR Sales Q1",
"scope": {
"type": "Domain",
"domainId": "2443f5f3-b2bb-46ad-a240-1550f1938569"
}
},
{
"id": "fb765fe3-d404-4f24-9d67-5916449c4c50",
"displayName": "Root"
"displayName": "Root",
"scope": {
"type": "Domain",
"domainId": "2443f5f3-b2bb-46ad-a240-1550f1938569"
}
},
{
"id": "bda31be4-7efe-4272-8b85-e1b2ff0f0592",
"displayName": "Legal EMEA"
"displayName": "Legal EMEA",
"scope": {
"type": "Domain",
"domainId": "2443f5f3-b2bb-46ad-a240-1550f1938569"
}
}
],
"continuationToken": "LDEsMTAwMDAwLDA%3D",
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/admin/examples/GetWorkspaceById.json
+2 -1
View File
@@ -9,7 +9,8 @@
"name": "test report",
"type": "Workspace",
"state": "Active",
"capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84"
"capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84",
"domainId": "8badadb6-9945-4e07-8134-00e0defec00b"
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/admin/examples/ListWorkspaces.json
+2 -1
View File
@@ -9,7 +9,8 @@
"name": "test report",
"type": "Workspace",
"state": "Active",
"capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84"
"capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84",
"domainId": "039bd896-b39c-4540-93e3-e9926de135f9"
}
],
"continuationUri": "https://api.fabric.microsoft.com/v1/admin/workspaces?continuationToken='LDEsMTAwMDAwLDA%3D'",
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/admin/examples/domains/CreateDomain.json
+3 -3
View File
@@ -4,7 +4,8 @@
"displayName": "Finance",
"description": "This domain is used for identifying financial data and reports.",
"parentDomainId": "5f6552c3-816c-43e7-8289-842f8b35f9df"
}
},
"preview": "false"
},
"responses": {
"201": {
@@ -12,8 +13,7 @@
"id": "9eba6944-daff-4441-b9b5-630ce34238fd",
"displayName": "Finance",
"description": "This domain is used for identifying financial data and reports.",
"parentDomainId": "5f6552c3-816c-43e7-8289-842f8b35f9df",
"contributorsScope": "AllTenant"
"parentDomainId": "5f6552c3-816c-43e7-8289-842f8b35f9df"
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/admin/examples/domains/CreateDomainPreview.json
+21
View File
@@ -0,0 +1,21 @@
{
"parameters": {
"createDomainRequest": {
"displayName": "Finance",
"description": "This domain is used for identifying financial data and reports.",
"parentDomainId": "5f6552c3-816c-43e7-8289-842f8b35f9df"
},
"preview": true
},
"responses": {
"201": {
"body": {
"id": "9eba6944-daff-4441-b9b5-630ce34238fd",
"displayName": "Finance",
"description": "This domain is used for identifying financial data and reports.",
"parentDomainId": "5f6552c3-816c-43e7-8289-842f8b35f9df",
"contributorsScope": "AllTenant"
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/admin/examples/domains/GetDomainById.json
+3 -2
View File
@@ -1,6 +1,7 @@
{
"parameters": {
"domainId": "f2f6a374-789e-4d1d-9cc7-6e0b934fc529"
"domainId": "f2f6a374-789e-4d1d-9cc7-6e0b934fc529",
"preview": "false"
},
"responses": {
"200": {
@@ -9,7 +10,7 @@
"displayName": "Finance",
"description": "This domain is used for identifying financial data and reports.",
"parentDomainId": null,
"contributorsScope": "SpecificUsersAndGroups"
"defaultLabelId": "b2b6fdcc-f8d9-44d9-ae14-2d1fccc0a38f"
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/admin/examples/domains/GetDomainByIdPreview.json
+17
View File
@@ -0,0 +1,17 @@
{
"parameters": {
"domainId": "f2f6a374-789e-4d1d-9cc7-6e0b934fc529",
"preview": true
},
"responses": {
"200": {
"body": {
"id": "f2f6a374-789e-4d1d-9cc7-6e0b934fc529",
"displayName": "Finance",
"description": "This domain is used for identifying financial data and reports.",
"parentDomainId": null,
"contributorsScope": "SpecificUsersAndGroups"
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/admin/examples/domains/ListDomainRoleAssignments.json
+36
View File
@@ -0,0 +1,36 @@
{
"parameters": {
"domainId": "00cb3785-58b5-408e-9e5f-7a26d28f0b9b"
},
"responses": {
"200": {
"body": {
"value": [
{
"role": "Admin",
"principal": {
"displayName": "Eric Solomon",
"id": "81fac5e1-2a81-421b-a168-110b1c72fa11",
"type": "User",
"userDetails": {
"userPrincipalName": "eric@microsoft.com"
}
}
},
{
"role": "Contributor",
"principal": {
"id": "f51b705f-a409-4d40-9197-c5d5f349e2f0",
"displayName": "TestSecurityGroup",
"type": "Group",
"groupDetails": {
"groupType": "SecurityGroup"
}
}
}
]
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/admin/examples/domains/ListDomains.json
+14 -18
View File
@@ -1,5 +1,7 @@
{
"parameters": {},
"parameters": {
"preview": "false"
},
"responses": {
"200": {
"body": {
@@ -9,51 +11,45 @@
"displayName": "Finance",
"description": "This domain is used for identifying financial data and reports.",
"parentDomainId": null,
"contributorsScope": "AdminsOnly"
"defaultLabelId": "e9d82d27-a651-49e6-a000-068f4c40dd30"
},
{
"id": "b0bca781-003c-4041-b1c4-f94d34ba76d4",
"displayName": "Human resources",
"description": null,
"parentDomainId": null,
"contributorsScope": "AllTenant"
"description": "",
"parentDomainId": null
},
{
"id": "6af5a1b6-bc4c-4c0a-b60d-30c68e6e3034",
"displayName": "HR Sales",
"description": null,
"parentDomainId": "bc23d4c6-cc92-4eb6-bcb5-0ff98429bbff",
"contributorsScope": "AllTenant"
"description": "",
"parentDomainId": "bc23d4c6-cc92-4eb6-bcb5-0ff98429bbff"
},
{
"id": "6c00e8eb-51d4-46f7-8b90-7e98520ea7a0",
"displayName": "Marketing",
"parentDomainId": null,
"contributorsScope": "SpecificUsersAndGroups"
"parentDomainId": null
},
{
"id": "17df435d-9efd-48c1-a937-7d6fd70ab26a",
"displayName": "AdminsOnly",
"description": "Admins only",
"parentDomainId": "f2f6a374-789e-4d1d-9cc7-6e0b934fc529",
"contributorsScope": "AllTenant"
"parentDomainId": "f2f6a374-789e-4d1d-9cc7-6e0b934fc529"
},
{
"id": "fb765fe3-d404-4f24-9d67-5916449c4c50",
"displayName": "Root",
"description": null,
"parentDomainId": null,
"contributorsScope": "AllTenant"
"description": "",
"parentDomainId": null
},
{
"id": "bda31be4-7efe-4272-8b85-e1b2ff0f0592",
"displayName": "Legal",
"description": "This domain is used for identifying legal data and reports.",
"parentDomainId": null,
"contributorsScope": "AllTenant"
"parentDomainId": null
}
]
}
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/admin/examples/domains/ListDomainsPreview.json
+61
View File
@@ -0,0 +1,61 @@
{
"parameters": {
"preview": true
},
"responses": {
"200": {
"body": {
"domains": [
{
"id": "bc23d4c6-cc92-4eb6-bcb5-0ff98429bbff",
"displayName": "Finance",
"description": "This domain is used for identifying financial data and reports.",
"parentDomainId": null,
"contributorsScope": "AdminsOnly"
},
{
"id": "b0bca781-003c-4041-b1c4-f94d34ba76d4",
"displayName": "Human resources",
"description": "",
"parentDomainId": null,
"contributorsScope": "AllTenant"
},
{
"id": "6af5a1b6-bc4c-4c0a-b60d-30c68e6e3034",
"displayName": "HR Sales",
"description": "",
"parentDomainId": "bc23d4c6-cc92-4eb6-bcb5-0ff98429bbff",
"contributorsScope": "AllTenant"
},
{
"id": "6c00e8eb-51d4-46f7-8b90-7e98520ea7a0",
"displayName": "Marketing",
"parentDomainId": null,
"contributorsScope": "SpecificUsersAndGroups"
},
{
"id": "17df435d-9efd-48c1-a937-7d6fd70ab26a",
"displayName": "AdminsOnly",
"description": "Admins only",
"parentDomainId": "f2f6a374-789e-4d1d-9cc7-6e0b934fc529",
"contributorsScope": "AllTenant"
},
{
"id": "fb765fe3-d404-4f24-9d67-5916449c4c50",
"displayName": "Root",
"description": "",
"parentDomainId": null,
"contributorsScope": "AllTenant"
},
{
"id": "bda31be4-7efe-4272-8b85-e1b2ff0f0592",
"displayName": "Legal",
"description": "This domain is used for identifying legal data and reports.",
"parentDomainId": null,
"contributorsScope": "AllTenant"
}
]
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/admin/examples/domains/ListNonEmptyDomains.json
+9 -11
View File
@@ -1,6 +1,7 @@
{
"parameters": {
"nonEmptyOnly": true
"nonEmptyOnly": true,
"preview": "false"
},
"responses": {
"200": {
@@ -11,30 +12,27 @@
"displayName": "Finance",
"description": "This domain is used for identifying financial data and reports.",
"parentDomainId": null,
"contributorsScope": "AdminsOnly"
"defaultLabelId": "95c04e91-79d3-4287-b282-dbd62e11f566"
},
{
"id": "b0bca781-003c-4041-b1c4-f94d34ba76d4",
"displayName": "Human resources",
"description": null,
"parentDomainId": null,
"contributorsScope": "AllTenant"
"description": "",
"parentDomainId": null
},
{
"id": "6af5a1b6-bc4c-4c0a-b60d-30c68e6e3034",
"displayName": "HR Sales",
"description": null,
"parentDomainId": "bc23d4c6-cc92-4eb6-bcb5-0ff98429bbff",
"contributorsScope": "AllTenant"
"description": "",
"parentDomainId": "bc23d4c6-cc92-4eb6-bcb5-0ff98429bbff"
},
{
"id": "6c00e8eb-51d4-46f7-8b90-7e98520ea7a0",
"displayName": "Marketing",
"parentDomainId": null,
"contributorsScope": "SpecificUsersAndGroups"
"parentDomainId": null
}
]
}
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/admin/examples/domains/ListNonEmptyDomainsPreview.json
+41
View File
@@ -0,0 +1,41 @@
{
"parameters": {
"nonEmptyOnly": true,
"preview": true
},
"responses": {
"200": {
"body": {
"domains": [
{
"id": "bc23d4c6-cc92-4eb6-bcb5-0ff98429bbff",
"displayName": "Finance",
"description": "This domain is used for identifying financial data and reports.",
"parentDomainId": null,
"contributorsScope": "AdminsOnly"
},
{
"id": "b0bca781-003c-4041-b1c4-f94d34ba76d4",
"displayName": "Human resources",
"description": "",
"parentDomainId": null,
"contributorsScope": "AllTenant"
},
{
"id": "6af5a1b6-bc4c-4c0a-b60d-30c68e6e3034",
"displayName": "HR Sales",
"description": "",
"parentDomainId": "bc23d4c6-cc92-4eb6-bcb5-0ff98429bbff",
"contributorsScope": "AllTenant"
},
{
"id": "6c00e8eb-51d4-46f7-8b90-7e98520ea7a0",
"displayName": "Marketing",
"parentDomainId": null,
"contributorsScope": "SpecificUsersAndGroups"
}
]
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/admin/examples/domains/SyncRoleAssignmentsToSubdomains.json
+11
View File
@@ -0,0 +1,11 @@
{
"parameters": {
"domainId": "d27d5b23-4a7e-4185-b81e-ac2b20cdd9a8",
"syncRoleAssignmentsToSubdomainsRequest": {
"role": "Contributor"
}
},
"responses": {
"200": {}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/admin/examples/domains/UpdateDomain.json
+4 -3
View File
@@ -4,8 +4,9 @@
"updateDomainRequest": {
"displayName": "Domain's new name",
"description": "Domain's new description",
"contributorsScope": "SpecificUsersAndGroups"
}
"defaultLabelId": "d9a6c724-a08f-429d-9fa9-9659c5181b7f"
},
"preview": "false"
},
"responses": {
"200": {
@@ -14,7 +15,7 @@
"displayName": "Domain's new name",
"description": "Domain's new description",
"parentDomainId": null,
"contributorsScope": "SpecificUsersAndGroups"
"defaultLabelId": "d9a6c724-a08f-429d-9fa9-9659c5181b7f"
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/admin/examples/domains/UpdateDomainPreview.json
+22
View File
@@ -0,0 +1,22 @@
{
"parameters": {
"domainId": "97dd1d38-a4c6-41ed-bc4f-1e383f8ddd0f",
"updateDomainRequest": {
"displayName": "Domain's new name",
"description": "Domain's new description",
"contributorsScope": "SpecificUsersAndGroups"
},
"preview": true
},
"responses": {
"200": {
"body": {
"id": "f2f6a374-789e-4d1d-9cc7-6e0b934fc529",
"displayName": "Domain's new name",
"description": "Domain's new description",
"parentDomainId": null,
"contributorsScope": "SpecificUsersAndGroups"
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/admin/examples/tags/CreateDomainTags.json
+37
View File
@@ -0,0 +1,37 @@
{
"parameters": {
"scope": {
"type": "Domain",
"domainId": "e408a2ca-0e43-49d6-86d3-f2558508d32a"
},
"createTagsRequest": [
{ "displayName": "Finance 2024" },
{ "displayName": "HR 2024" }
]
},
"responses": {
"201": {
"body": {
"tags": [
{
"id": "e281785b-5608-41ac-a1a1-78b48b95b825",
"displayName": "Finance 2024",
"scope": {
"type": "Domain",
"domainId": "e408a2ca-0e43-49d6-86d3-f2558508d32a"
}
},
{
"id": "24402490-9519-48b9-9d51-b2db4095a56b",
"displayName": "HR 2024",
"scope": {
"type": "Domain",
"domainId": "e408a2ca-0e43-49d6-86d3-f2558508d32a"
}
}
]
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/admin/examples/tags/CreateTenantTags.json
+31
View File
@@ -0,0 +1,31 @@
{
"parameters": {
"createTagsRequest": [
{ "displayName": "Finance 2024" },
{ "displayName": "HR 2024" }
]
},
"responses": {
"201": {
"body": {
"tags": [
{
"id": "e281785b-5608-41ac-a1a1-78b48b95b825",
"displayName": "Finance 2024",
"scope": {
"type": "Tenant"
}
},
{
"id": "24402490-9519-48b9-9d51-b2db4095a56b",
"displayName": "HR 2024",
"scope": {
"type": "Tenant"
}
}
]
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/admin/examples/tags/CreateTenantTagsExplicit.json
+34
View File
@@ -0,0 +1,34 @@
{
"parameters": {
"scope": {
"type": "Tenant"
},
"createTagsRequest": [
{ "displayName": "Finance 2024" },
{ "displayName": "HR 2024" }
]
},
"responses": {
"201": {
"body": {
"tags": [
{
"id": "e281785b-5608-41ac-a1a1-78b48b95b825",
"displayName": "Finance 2024",
"scope": {
"type": "Tenant"
}
},
{
"id": "24402490-9519-48b9-9d51-b2db4095a56b",
"displayName": "HR 2024",
"scope": {
"type": "Tenant"
}
}
]
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/admin/examples/tags/UpdateTag.json
+4 -1
View File
@@ -9,7 +9,10 @@
"200": {
"body": {
"id": "d889df97-7061-45f6-98b8-c53a83c2cf68",
"displayName": "Tag's new name."
"displayName": "Tag's new name.",
"scope": {
"type": "Tenant"
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/admin/swagger.json
+473 -129
View File
@@ -57,8 +57,8 @@
},
"/tenantsettings/{tenantSettingName}/update": {
"post": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nUpdate a given tenant setting.",
"description": "## Permissions\n\nThe caller must be a Fabric administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\n Tenant.ReadWrite.All\n\n## Limitations\n\nMaximum 25 requests per minute.\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": "Update a given tenant setting.",
"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 be a Fabric administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\n Tenant.ReadWrite.All\n\n## Limitations\n\nMaximum 25 requests per minute.\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": [
"Tenants"
],
@@ -107,8 +107,8 @@
},
"/capacities/delegatedTenantSettingOverrides": {
"get": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nReturns list of tenant setting overrides that override at the capacities.",
"description": "\nThis API supports [pagination](/rest/api/fabric/articles/pagination). A maximum of 10,000 records can be returned per request. With the continuation token provided in the response, you can get the next 10,000 records.\n\nThe user must be a Fabric Service Administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All\n\n## Limitations\n\nMaximum 25 requests per minute.\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 list of tenant setting overrides that override at the capacities.",
"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\nThis API supports [pagination](/rest/api/fabric/articles/pagination). A maximum of 10,000 records can be returned per request. With the continuation token provided in the response, you can get the next 10,000 records.\n\nThe user must be a Fabric Service Administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All\n\n## Limitations\n\nMaximum 25 requests per minute.\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": [
"Tenants"
],
@@ -150,10 +150,10 @@
}
}
},
"/capacities/{capacityId}/delegatedTenantSettingOverrides":{
"/capacities/{capacityId}/delegatedTenantSettingOverrides": {
"get": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nReturns list of tenant setting overrides that override for given capacity Id.",
"description": "## Permissions\n\nThe caller must be a Fabric administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All\n\n## Limitations\n\nMaximum 100 requests per minute.\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 list of tenant setting overrides that override for given capacity Id.",
"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 be a Fabric administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All\n\n## Limitations\n\nMaximum 100 requests per minute.\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": [
"Tenants"
],
@@ -205,8 +205,8 @@
},
"/capacities/{capacityId}/delegatedTenantSettingOverrides/{tenantSettingName}": {
"delete": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nRemove given tenant setting override for given capacity Id.",
"description": "## Permissions\n\nThe caller must be a Fabric administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.ReadWrite.All\n\n## Limitations\n\nMaximum 25 requests per minute.\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": "Remove given tenant setting override for given capacity Id.",
"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 be a Fabric administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.ReadWrite.All\n\n## Limitations\n\nMaximum 25 requests per minute.\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": [
"Tenants"
],
@@ -251,8 +251,8 @@
},
"/capacities/{capacityId}/delegatedTenantSettingOverrides/{tenantSettingName}/update": {
"post": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nUpdate given tenant setting override for given capacity Id.",
"description": "## Permissions\n\nThe caller must be a Fabric administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.ReadWrite.All\n\n## Limitations\n\nMaximum 25 requests per minute.\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": "Update given tenant setting override for given capacity Id.",
"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 be a Fabric administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.ReadWrite.All\n\n## Limitations\n\nMaximum 25 requests per minute.\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": [
"Tenants"
],
@@ -309,8 +309,8 @@
},
"/domains/delegatedTenantSettingOverrides": {
"get": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nReturns list of domain delegation setting overrides.",
"description": "\nThis API supports [pagination](/rest/api/fabric/articles/pagination). A maximum of 10,000 records can be returned per request. With the continuation token provided in the response, you can get the next 10,000 records.\n\nThe user must be a Fabric Service Administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All\n\n## Limitations\n\nMaximum 25 requests per minute.\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 list of domain delegation setting overrides.",
"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\nThis API supports [pagination](/rest/api/fabric/articles/pagination). A maximum of 10,000 records can be returned per request. With the continuation token provided in the response, you can get the next 10,000 records.\n\nThe user must be a Fabric Service Administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All\n\n## Limitations\n\nMaximum 25 requests per minute.\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": [
"Tenants"
],
@@ -324,18 +324,18 @@
],
"parameters": [
{
"in": "query",
"name": "continuationToken",
"description": "A token for retrieving the next page of results.",
"type": "string",
"required": false
"in": "query",
"name": "continuationToken",
"description": "A token for retrieving the next page of results.",
"type": "string",
"required": false
}
],
"responses": {
"200": {
"description": "The operation was successful.",
"schema": {
"$ref": "./definitions.json#/definitions/DomainTenantSettingOverrides"
"$ref": "./definitions.json#/definitions/DomainTenantSettingOverrides"
}
},
"default": {
@@ -354,8 +354,8 @@
},
"/workspaces/delegatedTenantSettingOverrides": {
"get": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nReturns list of workspace delegation setting overrides.",
"description": "\nThis API supports [pagination](/rest/api/fabric/articles/pagination). A maximum of 10,000 records can be returned per request. With the continuation token provided in the response, you can get the next 10,000 records.\n\nThe user must be a Fabric Service Administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All\n\n## Limitations\n\nMaximum 25 requests per minute.\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 list of workspace delegation setting overrides.",
"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\nThis API supports [pagination](/rest/api/fabric/articles/pagination). A maximum of 10,000 records can be returned per request. With the continuation token provided in the response, you can get the next 10,000 records.\n\nThe user must be a Fabric Service Administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All\n\n## Limitations\n\nMaximum 25 requests per minute.\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": [
"Tenants"
],
@@ -369,18 +369,18 @@
],
"parameters": [
{
"in": "query",
"name": "continuationToken",
"description": "A token for retrieving the next page of results.",
"type": "string",
"required": false
"in": "query",
"name": "continuationToken",
"description": "A token for retrieving the next page of results.",
"type": "string",
"required": false
}
],
"responses": {
"200": {
"description": "The operation was successful.",
"schema": {
"$ref": "./definitions.json#/definitions/WorkspaceTenantSettingOverrides"
"$ref": "./definitions.json#/definitions/WorkspaceTenantSettingOverrides"
}
},
"default": {
@@ -399,8 +399,8 @@
},
"/workspaces": {
"get": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nReturns a list of workspaces.",
"description": "\nThis API supports [pagination](/rest/api/fabric/articles/pagination). A maximum of 10,000 records can be returned per request. With the continuous token provided in the response, you can get the next 10,000 records.\n\n## Permissions\n\nThe caller must be a Fabric administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All\n\n## Limitations\n\nMaximum 200 requests per hour.\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 a list of workspaces.",
"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\nThis API supports [pagination](/rest/api/fabric/articles/pagination). A maximum of 10,000 records can be returned per request. With the continuous token provided in the response, you can get the next 10,000 records.\n\n## Permissions\n\nThe caller must be a Fabric administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All\n\n## Limitations\n\nMaximum 200 requests per hour.\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"
],
@@ -476,8 +476,8 @@
},
"/workspaces/discoverGitConnections": {
"get": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nReturns a list of Git connections.",
"description": "\nThis API supports [pagination](/rest/api/fabric/articles/pagination). A maximum of 1,000 records can be returned per request. With the continuous token provided in the response, you can get the next 1,000 records.\n\n## Permissions\n\nThe caller must be a Fabric administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All\n\n## Limitations\n\nMaximum 25 requests per minute.\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 a list of Git connections.",
"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\nThis API supports [pagination](/rest/api/fabric/articles/pagination). A maximum of 1,000 records can be returned per request. With the continuous token provided in the response, you can get the next 1,000 records.\n\n## Permissions\n\nThe caller must be a Fabric administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All\n\n## Limitations\n\nMaximum 25 requests per minute.\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"
],
@@ -520,8 +520,8 @@
},
"/workspaces/{workspaceId}": {
"get": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nReturns the specified workspace.",
"description": "## Permissions\n\nThe caller must be a Fabric administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All\n\n## Limitations\n\nMaximum 200 requests per hour.\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 specified workspace.",
"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 be a Fabric administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All\n\n## Limitations\n\nMaximum 200 requests per hour.\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"
],
@@ -562,8 +562,8 @@
},
"/workspaces/{workspaceId}/users": {
"get": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nReturns a list of users (including groups and ServicePrincipals) that have access to the specified workspace.",
"description": "## Permissions\n\nThe caller must be a Fabric administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All\n\n## Limitations\n\nMaximum 200 requests per hour.\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 a list of users (including groups and ServicePrincipals) that have access to the specified workspace.",
"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 be a Fabric administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All\n\n## Limitations\n\nMaximum 200 requests per hour.\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"
],
@@ -604,8 +604,8 @@
},
"/items": {
"get": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nReturns a list of active Fabric and PowerBI items.",
"description": "\nThis API supports [pagination](/rest/api/fabric/articles/pagination). A maximum of 10,000 records can be returned per request. With the continuous token provided in the response, you can get the next 10,000 records.\n\nPage order:\n 1. Fabric items\n 2. Datamarts\n 3. Reports\n 4. Dashboards\n 5. SemanticModels\n 6. Apps\n 7. Dataflows\n\n## Permissions\n\nThe caller must be a Fabric administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All\n\n## Limitations\n\nMaximum 200 requests per hour.\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 a list of active Fabric and PowerBI items.",
"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\nThis API supports [pagination](/rest/api/fabric/articles/pagination). A maximum of 10,000 records can be returned per request. With the continuous token provided in the response, you can get the next 10,000 records.\n\nPage order:\n 1. Fabric items\n 2. Datamarts\n 3. Reports\n 4. Dashboards\n 5. SemanticModels\n 6. Apps\n 7. Dataflows\n\n## Permissions\n\nThe caller must be a Fabric administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All\n\n## Limitations\n\nMaximum 200 requests per hour.\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"
],
@@ -685,8 +685,8 @@
},
"/workspaces/{workspaceId}/items/{itemId}": {
"get": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nReturns the specified Fabric or PowerBI item.",
"description": "## Permissions\n\nThe caller must be a Fabric administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All\n\n## Limitations\n\nMaximum 200 requests per hour.\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 specified Fabric or PowerBI item.",
"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 be a Fabric administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All\n\n## Limitations\n\nMaximum 200 requests per hour.\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"
],
@@ -745,8 +745,8 @@
},
"/workspaces/{workspaceId}/items/{itemId}/users": {
"get": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nReturns a list of users (including groups and service principals) and lists their workspace roles.",
"description": "## Permissions\n\nThe caller must be a Fabric administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All\n\n## Limitations\n\nMaximum 200 requests per hour.\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 a list of users (including groups and service principals) and lists their workspace roles.",
"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 be a Fabric administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All\n\n## Limitations\n\nMaximum 200 requests per hour.\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"
],
@@ -805,8 +805,8 @@
},
"/workspaces/{workspaceId}/restore": {
"post": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nRestores a deleted workspace.",
"description": "## Permissions\n\nThe caller must have Fabric administrator rights.\n\n## Required Delegated Scopes\n\nTenant.ReadWrite.All.\n\n## Limitations\n\nMaximum ten requests per minute.\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": "Restores a deleted workspace.",
"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 Fabric administrator rights.\n\n## Required Delegated Scopes\n\nTenant.ReadWrite.All.\n\n## Limitations\n\nMaximum ten requests per minute.\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"
],
@@ -853,8 +853,8 @@
},
"/users/{userId}/access": {
"get": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nReturns a list of permission details for Fabric and PowerBI items the specified user can access.",
"description": "\nThis API supports [pagination](/rest/api/fabric/articles/pagination). A maximum of 10,000 records can be returned per request. With the continuous token provided in the response, you can get the next 10,000 records.\n\nPage order:\n 1. Fabric items\n 2. Datamarts\n 3. Reports\n 4. Dashboards\n 5. SemanticModels\n 6. Apps\n 7. Dataflows\n\n## Permissions\n\nThe caller must be a Fabric administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All\n\n## Limitations\n\nMaximum 200 requests per hour.\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 a list of permission details for Fabric and PowerBI items the specified user can access.",
"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\nThis API supports [pagination](/rest/api/fabric/articles/pagination). A maximum of 10,000 records can be returned per request. With the continuous token provided in the response, you can get the next 10,000 records.\n\nPage order:\n 1. Fabric items\n 2. Datamarts\n 3. Reports\n 4. Dashboards\n 5. SemanticModels\n 6. Apps\n 7. Dataflows\n\n## Permissions\n\nThe caller must be a Fabric administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All\n\n## Limitations\n\nMaximum 200 requests per hour.\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": [
"Users"
],
@@ -916,10 +916,109 @@
}
}
},
"/domains": {
"/domains?preview=true": {
"get": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nReturns info for all domains.",
"description": "## Permissions\n\nThe caller must be a Fabric administrator.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All.\n\n## Limitations\n\nMaximum 25 requests per one minute per principal.\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 info for all domains (preview).",
"description": "> [!NOTE]\n> This preview API will be deprecated on March 31, 2026, and replaced by a stable version, available [here](/rest/api/fabric/admin/domains/list-domains).\nThe new version introduces breaking changes and is not backward compatible. **When calling this API, callers must specify `true` as the value for the query parameter `preview`.**\n\n## Deprecation Notice\n\nA new query parameter `preview` has been introduced to facilitate this transition:\n* The `preview` query parameter currently defaults to `true`. \n* Set the value of the `preview` query parameter to `false` to use the Release version of this API.\n* Starting March 31, 2026, the default value for `preview` will change to `false`.\n\nIt is recommended to migrate your integration to use the Release version as soon as possible by specifying `false` for the `preview` query parameter (**the default value for the `preview` query parameter will be set to `false` on API's deprecation date**).\n\nThe following incompatible changes were introduced in the Release version:\n* Response property `contributorsScope` was removed.\n\n## Permissions\n\nThe caller must be a Fabric administrator.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All.\n\n## Limitations\n\nMaximum 25 requests per one minute per principal.\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": [
"Domains"
],
"operationId": "Domains_List_Domains_(preview)",
"produces": [
"application/json"
],
"parameters": [
{
"in": "query",
"name": "nonEmptyOnly",
"description": "When true, only return domains that have at least one workspace containing an item. Default: false.",
"type": "boolean",
"required": false
},
{
"name": "preview",
"in": "query",
"description": "This parameter specifies which version of the API to use. Set to `true` to use the preview version described on this page, or to `false` to use the Release version detailed [here](/rest/api/fabric/admin/domains/list-domains).\nStarting March 31, 2026, the default value for `preview` will change to `false`.",
"required": true,
"type": "boolean"
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions/domains.json#/definitions/DomainsResponsePreview"
}
},
"default": {
"description": "Common error codes:\n\n* UnknownError - An error occurred.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get info for all domains example": {
"$ref": "./examples/domains/ListDomainsPreview.json"
},
"Get all non-empty domains example": {
"$ref": "./examples/domains/ListNonEmptyDomainsPreview.json"
}
}
},
"post": {
"summary": "Creates a new domain (preview).",
"description": "> [!NOTE]\n> This preview API will be deprecated on March 31, 2026, and replaced by a stable version, available [here](/rest/api/fabric/admin/domains/create-domain). The new version introduces breaking changes and is not backward compatible. **When calling this API, callers must specify `true` as the value for the query parameter `preview`.**\n\n## Deprecation Notice\n\nA new query parameter `preview` has been introduced to facilitate this transition:\n* The `preview` query parameter currently defaults to `true`.\n* Set the value of the `preview` query parameter to `false` to use the Release version of this API.\n* Starting March 31, 2026, the default value for `preview` will change to `false`.\n\nIt is recommended to migrate your integration to use the Release version as soon as possible by specifying `false` for the `preview` query parameter (**the default value for the `preview` query parameter will be set to `false` on API's deprecation date**).\n\nThe following incompatible changes were introduced in the Release version:\n* Response property `contributorsScope` was removed.\n\n## Permissions\n\nThe caller must be a Fabric administrator.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All.\n\n## Limitations\n\nMaximum 25 requests per one minute per principal.\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": [
"Domains"
],
"operationId": "Domains_Create_Domain_(preview)",
"produces": [
"application/json"
],
"parameters": [
{
"in": "body",
"name": "createDomainRequest",
"description": "The request payload for creating the domain.",
"schema": {
"$ref": "./definitions/domains.json#/definitions/CreateDomainRequest"
},
"required": true
},
{
"name": "preview",
"in": "query",
"description": "This parameter specifies which version of the API to use. Set to `true` to use the preview version described on this page, or to `false` to use the Release version detailed [here](/rest/api/fabric/admin/domains/create-domain).\nStarting March 31, 2026, the default value for `preview` will change to `false`.",
"required": true,
"type": "boolean"
}
],
"responses": {
"201": {
"description": "Domain created successfully.",
"schema": {
"$ref": "./definitions/domains.json#/definitions/DomainPreview"
}
},
"default": {
"description": "Common error codes:\n\n* EntityNotFound - Create domain failed because parent domain ID not found.\n\n* EntityConflict - Create domain failed because domain display name already exists.\n\n* InvalidInput - Invalid parent domain ID.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Create a domain example": {
"$ref": "./examples/domains/CreateDomainPreview.json"
}
}
}
},
"/domains?preview=false": {
"get": {
"summary": "Returns info for all domains.",
"description": "> [!NOTE]\n> This API is a release version of a preview version due to be deprecated on March 31, 2026.\n**When calling this API - callers must set the query parameter `preview` to the value `false`**\n\n## Permissions\n\nThe caller must be a Fabric administrator.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All.\n\n## Limitations\n\nMaximum 25 requests per one minute per principal.\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": [
"Domains"
],
@@ -934,6 +1033,13 @@
"description": "When true, only return domains that have at least one workspace containing an item. Default: false.",
"type": "boolean",
"required": false
},
{
"name": "preview",
"in": "query",
"description": "This parameter specifies which version of the API to use. Set to `false` to use the release version.",
"required": true,
"type": "boolean"
}
],
"responses": {
@@ -960,8 +1066,8 @@
}
},
"post": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nCreates a new domain.",
"description": "## Permissions\n\nThe caller must be a Fabric administrator.\n\n## Required Delegated Scopes\n\nTenant.ReadWrite.All.\n\n## Limitations\n\nMaximum 25 requests per one minute per principal.\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": "Creates a new domain.",
"description": "> [!NOTE]\n> This API is a release version of a preview version due to be deprecated on March 31, 2026.\n**When calling this API - callers must set the query parameter `preview` to the value `false`**\n\n## Permissions\n\nThe caller must be a Fabric administrator.\n\n## Required Delegated Scopes\n\nTenant.ReadWrite.All.\n\n## Limitations\n\nMaximum 25 requests per one minute per principal.\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": [
"Domains"
],
@@ -978,6 +1084,13 @@
"$ref": "./definitions/domains.json#/definitions/CreateDomainRequest"
},
"required": true
},
{
"name": "preview",
"in": "query",
"description": "This parameter specifies which version of the API to use. Set to `false` to use the release version.",
"required": true,
"type": "boolean"
}
],
"responses": {
@@ -1001,14 +1114,14 @@
}
}
},
"/domains/{domainId}": {
"/domains/{domainId}?preview=true": {
"get": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nReturns the specified domain info.",
"description": "## Permissions\n\nThe caller must be a Fabric administrator.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All.\n\n## Limitations\n\nMaximum 25 requests per one minute per principal.\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 specified domain info (preview).",
"description": "> [!NOTE]\n> This preview API will be deprecated on March 31, 2026, and replaced by a stable version, available [here](/rest/api/fabric/admin/domains/get-domain). The new version introduces breaking changes and is not backward compatible. **When calling this API, callers must specify `true` as the value for the query parameter `preview`.**\n\n## Deprecation Notice\n\nA new query parameter `preview` has been introduced to facilitate this transition:\n* The `preview` query parameter currently defaults to `true`.\n* Set the value of the `preview` query parameter to `false` to use the Release version of this API.\n* Starting March 31, 2026, the default value for `preview` will change to `false`.\n\nIt is recommended to migrate your integration to use the Release version as soon as possible by specifying `false` for the `preview` query parameter (**the default value for the `preview` query parameter will be set to `false` on API's deprecation date**).\n\nThe following incompatible changes were introduced in the Release version:\n* Response property `contributorsScope` was removed.\n\n## Permissions\n\nThe caller must be a Fabric administrator.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All.\n\n## Limitations\n\nMaximum 25 requests per one minute per principal.\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": [
"Domains"
],
"operationId": "Domains_GetDomain",
"operationId": "Domains_Get_Domain_(preview)",
"produces": [
"application/json"
],
@@ -1020,13 +1133,20 @@
"type": "string",
"format": "uuid",
"required": true
},
{
"name": "preview",
"in": "query",
"description": "This parameter specifies which version of the API to use. Set to `true` to use the preview version described on this page, or to `false` to use the Release version detailed [here](/rest/api/fabric/admin/domains/get-domain).\nStarting March 31, 2026, the default value for `preview` will change to `false`.",
"required": true,
"type": "boolean"
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions/domains.json#/definitions/Domain"
"$ref": "./definitions/domains.json#/definitions/DomainPreview"
}
},
"default": {
@@ -1038,12 +1158,70 @@
},
"x-ms-examples": {
"Get a domain example": {
"$ref": "./examples/domains/GetDomainById.json"
"$ref": "./examples/domains/GetDomainByIdPreview.json"
}
}
},
"patch": {
"summary": "Updates the specified domain info (preview).",
"description": "> [!NOTE]\n> This preview API will be deprecated on March 31, 2026, and replaced by a stable version, available [here](/rest/api/fabric/admin/domains/update-domain). The new version introduces breaking changes and is not backward compatible. **When calling this API, callers must specify `true` as the value for the query parameter `preview`.**\n\n## Deprecation Notice\n\nA new query parameter `preview` has been introduced to facilitate this transition:\n* The `preview` query parameter currently defaults to `true`.\n* Set the value of the `preview` query parameter to `false` to use the Release version of this API.\n* Starting March 31, 2026, the default value for `preview` will change to `false`.\n\nIt is recommended to migrate your integration to use the Release version as soon as possible by specifying `false` for the `preview` query parameter (**the default value for the `preview` query parameter will be set to `false` on API's deprecation date**).\n\nThe following incompatible changes were introduced in the Release version:\n* Request property `contributorsScope` was removed.\n* Response property `contributorsScope` was removed.\n\n## Permissions\n\nThe caller must be a Fabric administrator.\n\n## Required Delegated Scopes\n\nTenant.ReadWrite.All.\n\n## Limitations\n\nMaximum 25 requests per one minute per principal.\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": [
"Domains"
],
"operationId": "Domains_Update_Domain_(preview)",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "domainId",
"description": "The domain ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "body",
"name": "updateDomainRequest",
"description": "The request payload for updating the domain.",
"schema": {
"$ref": "./definitions/domains.json#/definitions/UpdateDomainRequestPreview"
},
"required": true
},
{
"name": "preview",
"in": "query",
"description": "This parameter specifies which version of the API to use. Set to `true` to use the preview version described on this page, or to `false` to use the Release version detailed [here](/rest/api/fabric/admin/domains/update-domain).\nStarting March 31, 2026, the default value for `preview` will change to `false`.",
"required": true,
"type": "boolean"
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions/domains.json#/definitions/DomainPreview"
}
},
"default": {
"description": "Common error codes:\n\n* UnknownError - An error occurred.\n\n* EntityConflict - Update domain failed because domain display name already exists.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Update a domain example": {
"$ref": "./examples/domains/UpdateDomainPreview.json"
}
}
}
},
"/domains/{domainId}": {
"delete": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nDeletes the specified domain.",
"summary": "Deletes the specified domain.",
"description": "## Permissions\n\nThe caller must be a Fabric administrator.\n\n## Required Delegated Scopes\n\nTenant.ReadWrite.All.\n\n## Limitations\n\nMaximum 25 requests per one minute per principal.\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": [
"Domains"
@@ -1078,10 +1256,59 @@
"$ref": "./examples/domains/DeleteDomain.json"
}
}
}
},
"/domains/{domainId}?preview=false": {
"get": {
"summary": "Returns the specified domain info.",
"description": "> [!NOTE]\n> This API is a release version of a preview version due to be deprecated on March 31, 2026.\n**When calling this API - callers must set the query parameter `preview` to the value `false`**\n\n## Permissions\n\nThe caller must be a Fabric administrator.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All.\n\n## Limitations\n\nMaximum 25 requests per one minute per principal.\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": [
"Domains"
],
"operationId": "Domains_GetDomain",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "domainId",
"description": "The domain ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"name": "preview",
"in": "query",
"description": "This parameter specifies which version of the API to use. Set to `false` to use the release version.",
"required": true,
"type": "boolean"
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions/domains.json#/definitions/Domain"
}
},
"default": {
"description": "Common error codes:\n\n* UnknownError - An error occurred.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get a domain example": {
"$ref": "./examples/domains/GetDomainById.json"
}
}
},
"patch": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nUpdates the specified domain info.",
"description": "## Permissions\n\nThe caller must be a Fabric administrator.\n\n## Required Delegated Scopes\n\nTenant.ReadWrite.All.\n\n## Limitations\n\nMaximum 25 requests per one minute per principal.\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": "Updates the specified domain info.",
"description": "> [!NOTE]\n> This API is a release version of a preview version due to be deprecated on March 31, 2026.\n**When calling this API - callers must set the query parameter `preview` to the value `false`**\n\n## Permissions\n\nThe caller must be a Fabric administrator.\n\n## Required Delegated Scopes\n\nTenant.ReadWrite.All.\n\n## Limitations\n\nMaximum 25 requests per one minute per principal.\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": [
"Domains"
],
@@ -1098,6 +1325,13 @@
"format": "uuid",
"required": true
},
{
"name": "preview",
"in": "query",
"description": "This parameter specifies which version of the API to use. Set to `false` to use the release version.",
"required": true,
"type": "boolean"
},
{
"in": "body",
"name": "updateDomainRequest",
@@ -1131,7 +1365,7 @@
},
"/domains/{domainId}/workspaces": {
"get": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nReturns a list of the workspaces assigned to the specified domain.",
"summary": "Returns a list of the workspaces assigned to the specified domain.",
"description": "This API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\nThe caller must be a Fabric administrator.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All.\n\n## Limitations\n\nMaximum 25 requests per one minute per principal.\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": [
"Domains"
@@ -1181,7 +1415,7 @@
},
"/domains/{domainId}/assignWorkspaces": {
"post": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nAssign workspaces to the specified domain by workspace ID.",
"summary": "Assign workspaces to the specified domain by workspace ID.",
"description": "Preexisting domain assignments will be overridden unless bulk reassignment is blocked by domain management tenant settings.\n\n## Permissions\n\nThe caller must be a Fabric administrator.\n\n## Required Delegated Scopes\n\nTenant.ReadWrite.All.\n\n## Limitations\n\nMaximum 10 requests per one minute per principal.\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": [
"Domains"
@@ -1229,7 +1463,7 @@
},
"/domains/{domainId}/unassignWorkspaces": {
"post": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nUnassign workspaces from the specified domain by workspace ID.",
"summary": "Unassign workspaces from the specified domain by workspace ID.",
"description": "## Permissions\n\nThe caller must be a Fabric administrator.\n\n## Required Delegated Scopes\n\nTenant.ReadWrite.All.\n\n## Limitations\n\nMaximum 25 requests per one minute per principal.\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": [
"Domains"
@@ -1276,7 +1510,7 @@
},
"/domains/{domainId}/unassignAllWorkspaces": {
"post": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nUnassign all workspaces from the specified domain.",
"summary": "Unassign all workspaces from the specified domain.",
"description": "## Permissions\n\nThe caller must be a Fabric administrator.\n\n## Required Delegated Scopes\n\nTenant.ReadWrite.All.\n\n## Limitations\n\nMaximum 10 requests per one minute per principal.\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": [
"Domains"
@@ -1313,9 +1547,61 @@
}
}
},
"/domains/{domainId}/roleAssignments": {
"get": {
"summary": "Returns a list of domain role assignments.",
"description": "## Permissions\n\nThe caller must be a Fabric administrator.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.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": [
"Domains"
],
"operationId": "Domains_ListRoleAssignments",
"x-ms-pageable": {
"nextLinkName": "continuationUri"
},
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "domainId",
"description": "The domain 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/domains.json#/definitions/DomainRoleAssignments"
}
},
"default": {
"description": "Common error codes:\n\n* DomainNotFound - The provided domain was not found\n\n* UnknownError - An error occurred.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List domain role assignments example": {
"$ref": "./examples/domains/ListDomainRoleAssignments.json"
}
}
}
},
"/domains/{domainId}/roleAssignments/bulkAssign": {
"post": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nAssign the specified admins or contributors to the domain.",
"summary": "Assign the specified admins or contributors to the domain.",
"description": "## Permissions\n\nThe caller must be a Fabric administrator.\n\n## Required Delegated Scopes\n\nTenant.ReadWrite.All.\n\n## Limitations\n\nMaximum 25 requests per one minute per principal.\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": [
"Domains"
@@ -1348,7 +1634,7 @@
"description": "Request completed successfully."
},
"default": {
"description": "Common error codes:\n\n* UnknownError - An error occurred.",
"description": "Common error codes:\n\n* PrincipalWithDomainRoleAssignmentAlreadyExists - The principal is already assigned to the domain with the specified role.\n\n* UnsupportedPrincipalTypeForDomainAdminAssignment - Using unsupported principal type for assigning or unassigning domain admin roles.\n\n* UnknownError - An error occurred.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
@@ -1366,7 +1652,7 @@
},
"/domains/{domainId}/roleAssignments/bulkUnassign": {
"post": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nUnassign the specified admins or contributors from the domain.",
"summary": "Unassign the specified admins or contributors from the domain.",
"description": "## Permissions\n\nThe caller must be a Fabric administrator.\n\n## Required Delegated Scopes\n\nTenant.ReadWrite.All.\n\n## Limitations\n\nMaximum 25 requests per one minute per principal.\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": [
"Domains"
@@ -1399,7 +1685,7 @@
"description": "Request completed successfully."
},
"default": {
"description": "Common error codes:\n\n* DomainSpecificUsersScopeCannotBeEmptyError - Unassigning domain members failed because when the contributors scope is set to 'Specific Users And Groups', the users or groups list can't be empty.",
"description": "Common error codes:\n\n* PrincipalWithDomainRoleAssignmentNotFound - The principal is not assigned to the domain with the specified role.\n\n* UnsupportedPrincipalTypeForDomainAdminAssignment - Using unsupported principal type for assigning or unassigning domain admin roles.\n\n* UnknownError - An error occurred.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
@@ -1415,9 +1701,57 @@
}
}
},
"/domains/{domainId}/roleAssignments/syncToSubdomains": {
"post": {
"summary": "Sync the role assignments from the specified domain to its subdomains.",
"description": "## Permissions\n\nThe caller must be a Fabric administrator.\n\n## Required Delegated Scopes\n\nTenant.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": [
"Domains"
],
"operationId": "Domains_SyncRoleAssignmentsToSubdomains",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "domainId",
"description": "The domain ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "body",
"name": "syncRoleAssignmentsToSubdomainsRequest",
"description": "The request payload for syncing domain members to its subdomains.",
"schema": {
"$ref": "./definitions/domains.json#/definitions/SyncRoleAssignmentsToSubdomainsRequest"
},
"required": true
}
],
"responses": {
"200": {
"description": "Request completed successfully."
},
"default": {
"description": "Common error codes:\n\n* SyncingAdminsToSubdomainsIsNotSupported - Syncing admins to subdomains is not supported\n\n* DomainNotFound - The provided domain was not found\n\n* UnknownError - An error occurred.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Assign domain contributors to subdomains example": {
"$ref": "./examples/domains/SyncRoleAssignmentsToSubdomains.json"
}
}
}
},
"/domains/{domainId}/assignWorkspacesByCapacities": {
"post": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nAssign all workspaces that reside on the specified capacities to the specified domain.",
"summary": "Assign all workspaces that reside on the specified capacities to the specified domain.",
"description": "Preexisting domain assignments will be overridden unless bulk reassignment is blocked by domain management tenant settings.\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\nThe caller must be a Fabric administrator.\n\n## Required Delegated Scopes\n\nTenant.ReadWrite.All.\n\n## Limitations\n\nMaximum 10 requests per one minute per principal.\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": [
"Domains"
@@ -1481,7 +1815,7 @@
},
"/domains/{domainId}/assignWorkspacesByPrincipals": {
"post": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nAssign workspaces to the specified domain, when one of the specified principals has admin permission in the workspace.",
"summary": "Assign workspaces to the specified domain, when one of the specified principals has admin permission in the workspace.",
"description": "Preexisting domain assignments will be overridden unless bulk reassignment is blocked by domain management tenant settings.\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\nThe caller must be a Fabric administrator.\n\n## Required Delegated Scopes\n\nTenant.ReadWrite.All.\n\n## Limitations\n\nMaximum 10 requests per one minute per principal.\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": [
"Domains"
@@ -1543,57 +1877,57 @@
}
}
},
"/tags":{
"get": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nReturns a list of all the tenant's tags.",
"description": "## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All\n\n## Limitations\n\nMaximum 25 requests per one minute per principal. \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": [
"Tags"
],
"operationId": "Tags_ListTags",
"x-ms-pageable": {
"nextLinkName": "continuationUri"
},
"produces": [
"application/json"
],
"parameters": [
{
"in": "query",
"name": "continuationToken",
"description": "A token for retrieving the next page of results.",
"type": "string",
"required": false
}
],
"responses": {
"200": {
"description": "The request was successful.",
"schema": {
"$ref": "./definitions/tags.json#/definitions/AdminTagsInfo"
}
},
"default": {
"description": "Common error codes:\n\n* UnknownError - An error occurred",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List of all tenant's tags example": {
"$ref": "./examples/AdminListTags.json"
},
"List of all tenant's tags with continuation example": {
"$ref": "./examples/AdminListTagsWithContinuation.json"
}
"/tags": {
"get": {
"summary": "Returns a list of all the tenant's tags.",
"description": "> [!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All\n\n## Limitations\n\nMaximum 25 requests per one minute per principal. \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": [
"Tags"
],
"operationId": "Tags_ListTags",
"x-ms-pageable": {
"nextLinkName": "continuationUri"
},
"produces": [
"application/json"
],
"parameters": [
{
"in": "query",
"name": "continuationToken",
"description": "A token for retrieving the next page of results.",
"type": "string",
"required": false
}
],
"responses": {
"200": {
"description": "The request was successful.",
"schema": {
"$ref": "./definitions/tags.json#/definitions/AdminTagsInfo"
}
},
"default": {
"description": "Common error codes:\n\n* UnknownError - An error occurred",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List of all tenant's tags example": {
"$ref": "./examples/AdminListTags.json"
},
"List of all tenant's tags with continuation example": {
"$ref": "./examples/AdminListTagsWithContinuation.json"
}
}
}
},
"/tags/bulkCreateTags": {
"post": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nCreate new tags.",
"description": "## Permissions\n\nThe caller must have administrator rights such as Fabric administrator.\n\n## Required Delegated Scopes\n\nTenant.ReadWrite.All.\n\n## Limitations\n\nMaximum 25 requests per one minute per principal. \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": "Create new tags.",
"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 administrator rights such as Fabric administrator.\n\n## Required Delegated Scopes\n\nTenant.ReadWrite.All.\n\n## Limitations\n\nMaximum 25 requests per one minute per principal. \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": [
"Tags"
],
@@ -1623,23 +1957,29 @@
}
},
"default": {
"description": "Common error codes:\n\n* UnknownError - An error occurred \n\n* InvalidInputs - Invalid input was provided \n\n* EntityConflict - Tag display name already exists",
"description": "Common error codes:\n\n* UnknownError - An error occurred \n\n* InvalidInputs - Invalid input was provided \n\n* EntityConflict - Tag display name already exists \n\n* EntityNotFound - Domain ID does not exist",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Create tags in bulk example": {
"$ref": "./examples/Tags/CreateTags.json"
"Create tenant tags in bulk example": {
"$ref": "./examples/Tags/CreateTenantTags.json"
},
"Create tenant tags in bulk example with explicit scope": {
"$ref": "./examples/Tags/CreateTenantTagsExplicit.json"
},
"Create domain tags in bulk example": {
"$ref": "./examples/Tags/CreateDomainTags.json"
}
}
}
},
"/tags/{tagId}": {
"delete": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nDelete the specified tag.",
"description": "## Permissions\n\nThe caller must have administrator rights such as Fabric administrator.\n\n## Required Delegated Scopes\n\nTenant.ReadWrite.All.\n\n## Limitations\n\nMaximum 10 requests per one minute per principal. \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": "Delete the specified tag.",
"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 administrator rights such as Fabric administrator.\n\n## Required Delegated Scopes\n\nTenant.ReadWrite.All.\n\n## Limitations\n\nMaximum 10 requests per one minute per principal. \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": [
"Tags"
],
@@ -1675,8 +2015,8 @@
}
},
"patch": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nUpdates the specified tag.",
"description": "## Permissions\n\nThe caller must have administrator rights such as Fabric administrator.\n\n## Required Delegated Scopes\n\nTenant.ReadWrite.All.\n\n## Limitations\n\nMaximum 25 requests per one minute per principal.\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": "Updates the specified tag.",
"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 administrator rights such as Fabric administrator.\n\n## Required Delegated Scopes\n\nTenant.ReadWrite.All.\n\n## Limitations\n\nMaximum 25 requests per one minute per principal.\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": [
"Tags"
],
@@ -1921,13 +2261,15 @@
},
"/items/removeAllSharingLinks": {
"post": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nDeletes all organization sharing links for all Fabric items in the tenant. This action cannot be undone.",
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nUse [LinksSharedToWholeOrganization](https://learn.microsoft.com/rest/api/power-bi/admin) PowerBI Admin REST API to get Power BI Reports shared via organizational sharing links.\n\n## Permissions\n\nThe caller must be a Fabric administrator.\n\n## Required Delegated Scopes\n\nTenant.ReadWrite.All\n\n## Limitations\n\n- Maximum 10 requests per minute.\n- Only Power BI Reports are supported.\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": "Deletes all organization sharing links for all Fabric items in the tenant. This action cannot be undone.",
"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\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nUse [LinksSharedToWholeOrganization](https://learn.microsoft.com/en-us/rest/api/power-bi/admin) PowerBI Admin REST API to get Power BI Reports shared via organizational sharing links.\n\n## Permissions\n\nThe caller must be a Fabric administrator.\n\n## Required Delegated Scopes\n\nTenant.ReadWrite.All\n\n## Limitations\n\n- Maximum 10 requests per minute.\n- Only Power BI Reports are supported.\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": [
"SharingLinks"
],
"operationId": "SharingLinks_RemoveAllSharingLinks",
"produces": ["application/json"],
"produces": [
"application/json"
],
"x-ms-fabric-sdk-long-running-operation": true,
"parameters": [
{
@@ -1978,13 +2320,15 @@
},
"/items/bulkRemoveSharingLinks": {
"post": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nDeletes all organization sharing links for the specified Fabric items. This action cannot be undone.",
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nUse [LinksSharedToWholeOrganization](https://learn.microsoft.com/rest/api/power-bi/admin) PowerBI Admin REST API to get Power BI Reports shared via organizational sharing links.\n\n## Permissions\n\nThe caller must be a Fabric administrator.\n\n## Required Delegated Scopes\n\nTenant.ReadWrite.All\n\n## Limitations\n\n- Maximum 10 requests per minute.\n- Each request can delete organization sharing links for up to 500 Fabric items.\n- Only Power BI Reports are supported.\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": "Deletes all organization sharing links for the specified Fabric items. This action cannot be undone.",
"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\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nUse [LinksSharedToWholeOrganization](https://learn.microsoft.com/en-us/rest/api/power-bi/admin) PowerBI Admin REST API to get Power BI Reports shared via organizational sharing links.\n\n## Permissions\n\nThe caller must be a Fabric administrator.\n\n## Required Delegated Scopes\n\nTenant.ReadWrite.All\n\n## Limitations\n\n- Maximum 10 requests per minute.\n- Each request can delete organization sharing links for up to 500 Fabric items.\n- Only Power BI Reports are supported.\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": [
"SharingLinks"
],
"operationId": "SharingLinks_BulkRemoveSharingLinks",
"produces": ["application/json"],
"produces": [
"application/json"
],
"x-ms-fabric-sdk-long-running-operation": true,
"parameters": [
{
@@ -2040,4 +2384,4 @@
"responses": {},
"security": [],
"tags": []
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/anomalyDetector/definitions.json
+171
View File
@@ -0,0 +1,171 @@
{
"swagger": "2.0",
"info": {
"title": "AnomalyDetector data types",
"version": "v1"
},
"paths": {},
"definitions": {
"AnomalyDetector": {
"description": "A AnomalyDetector object.",
"type": "object",
"required": ["type"],
"allOf": [
{
"$ref": "../common/definitions.json#/definitions/Item"
}
],
"properties": {
"properties": {
"description": "The AnomalyDetector properties.",
"$ref": "#/definitions/AnomalyDetectorProperties"
}
}
},
"AnomalyDetectorProperties": {
"description": "The AnomalyDetector properties.",
"type": "object",
"required": ["oneLakeRootPath"],
"properties": {
"oneLakeRootPath": {
"description": "OneLake path to the AnomalyDetector root directory.",
"type": "string"
}
}
},
"AnomalyDetectors": {
"description": "A list of Collection Names.",
"required": ["value"],
"type": "object",
"properties": {
"value": {
"description": "A list of Collection Names.",
"type": "array",
"items": {
"$ref": "#/definitions/AnomalyDetector"
}
}
},
"allOf": [
{
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
}
]
},
"CreateAnomalyDetectorRequest": {
"description": "Create AnomalyDetector request payload.",
"required": ["displayName"],
"properties": {
"displayName": {
"description": "The AnomalyDetector display name. The display name must follow naming rules according to item type.",
"type": "string",
"readOnly": false
},
"description": {
"description": "The AnomalyDetector description. Maximum length is 256 characters.",
"type": "string",
"readOnly": false
},
"folderId": {
"description": "The folder ID. If not specified or null, the AnomalyDetector is created with the workspace as its folder.",
"type": "string",
"format": "uuid",
"readOnly": false
},
"definition": {
"description": "The AnomalyDetector definition.",
"$ref": "#/definitions/AnomalyDetectorDefinition",
"readOnly": false
}
}
},
"UpdateAnomalyDetectorDefinitionRequest": {
"description": "Update AnomalyDetector definition request payload.",
"required": ["definition"],
"properties": {
"definition": {
"$ref": "#/definitions/AnomalyDetectorDefinition"
}
}
},
"AnomalyDetectorDefinitionResponse": {
"description": "AnomalyDetector definition response.",
"required": ["definition"],
"properties": {
"definition": {
"$ref": "#/definitions/AnomalyDetectorDefinition",
"readOnly": true
}
}
},
"AnomalyDetectorDefinition" : {
"description": "AnomalyDetector definition object. Refer to this [article](/rest/api/fabric/articles/item-management/definitions/anomalydetector-definition) for more details on how to craft a AnomalyDetector 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": [
"AnomalyDetectorV1"
],
"x-ms-enum": {
"name": "AnomalyDetectorDefinitionFormat",
"modelAsString": true,
"values": [
{
"value": "AnomalyDetectorV1",
"description": "Custom format for the AnomalyDetector definition, specifically designed to support CI/CD scenarios in Fabric. see [AnomalyDetector - AnomalyDetectorV1 specification](/rest/api/fabric/articles/item-management/definitions/anomalydetector-definition) for more details."
}
]
},
"readOnly": false
},
"parts": {
"description": "A list of definition parts.",
"type": "array",
"items": {
"$ref": "#/definitions/AnomalyDetectorDefinitionPart"
},
"readOnly": false
}
}
},
"AnomalyDetectorDefinitionPart": {
"description": "AnomalyDetector definition part object.",
"type": "object",
"properties": {
"path": {
"description": "The AnomalyDetector definition part path.",
"type": "string",
"readOnly": false
},
"payload": {
"description": "The AnomalyDetector definition part payload.",
"type": "string",
"readOnly": false
},
"payloadType":{
"description": "The payload type.",
"$ref": "../common/definitions.json#/definitions/PayloadType",
"readOnly": false
}
}
},
"UpdateAnomalyDetectorRequest": {
"description": "Update AnomalyDetector request.",
"properties": {
"displayName": {
"description": "The AnomalyDetector display name. The display name must follow naming rules according to item type.",
"type": "string",
"readOnly": false
},
"description": {
"description": "The AnomalyDetector description. Maximum length is 256 characters.",
"type": "string",
"readOnly": false
}
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/anomalyDetector/examples/CreateAnomalyDetector.json
+42
View File
@@ -0,0 +1,42 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"createAnomalyDetectorRequest": {
"displayName": "AnomalyDetector 1",
"description": "A AnomalyDetector description.",
"definition": {
"format": "AnomalyDetectorV1",
"parts": [
{
"path": "Configurations.json",
"payload": "eyANCiAgIiRpZCI6ICJodHRwczovL2RldmVsb3Blci5taWNyb3NvZnQuY29tL2pzb24tc2NoZW1hcy9mYWJyaWMvaXRlbS9hbm9tYWx5RGV0ZWN0b3IvZGVmaW5pdGlvbi8xLjAuMC9zY2hlbWEuanNvbiIsDQogICIkc2NoZW1hIjogImh0dHBzOi8vanNvbi1zY2hlbWEub3JnL2RyYWZ0LTA3L3NjaGVtYSMiLA0KICAidW5pdmFyaWF0ZUNvbmZpZ3VyYXRpb25zIjogWw0KICBdDQp9",
"payloadType": "InlineBase64"
},
{
"path": ".platform",
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
"payloadType": "InlineBase64"
}
]
}
}
},
"responses": {
"201": {
"body": {
"displayName": "AnomalyDetector 1",
"description": "A AnomalyDetector description.",
"type": "AnomalyDetector",
"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/anomalyDetector/examples/CreateAnomalyDetectorWithoutDefinition.json
+27
View File
@@ -0,0 +1,27 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"createAnomalyDetectorRequest": {
"displayName": "AnomalyDetector 1",
"description": "A AnomalyDetector description."
}
},
"responses": {
"201": {
"body": {
"displayName": "AnomalyDetector 1",
"description": "A AnomalyDetector description.",
"type": "AnomalyDetector",
"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/anomalyDetector/examples/DeleteAnomalyDetector.json
+9
View File
@@ -0,0 +1,9 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"anomalyDetectorId": "5b218778-e7a5-4d73-8187-f10824047715"
},
"responses": {
"200": {}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/anomalyDetector/examples/GetAnomalyDetector.json
+20
View File
@@ -0,0 +1,20 @@
{
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"anomalyDetectorId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
},
"responses": {
"200": {
"body": {
"id": "5b218778-e7a5-4d73-8187-f10824047715",
"displayName": "AnomalyDetector 1",
"description": "A AnomalyDetector description.",
"type": "AnomalyDetector",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"properties": {
"oneLakeRootPath": "https://onelake.dfs.fabric.microsoft.com/f089354e-8366-4e18-aea3-4cb4a3a50b48/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
}
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/anomalyDetector/examples/GetAnomalyDetectorDefinition.json
+34
View File
@@ -0,0 +1,34 @@
{
"parameters": {
"workspaceId": "6e335e92-a2a2-4b5a-970a-bd6a89fbb765",
"anomalyDetectorId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
},
"responses": {
"200": {
"body": {
"definition": {
"format": "AnomalyDetectorV1",
"parts": [
{
"path": "Configurations.json",
"payload": "eyANCiAgIiRpZCI6ICJodHRwczovL2RldmVsb3Blci5taWNyb3NvZnQuY29tL2pzb24tc2NoZW1hcy9mYWJyaWMvaXRlbS9hbm9tYWx5RGV0ZWN0b3IvZGVmaW5pdGlvbi8xLjAuMC9zY2hlbWEuanNvbiIsDQogICIkc2NoZW1hIjogImh0dHBzOi8vanNvbi1zY2hlbWEub3JnL2RyYWZ0LTA3L3NjaGVtYSMiLA0KICAidW5pdmFyaWF0ZUNvbmZpZ3VyYXRpb25zIjogWw0KICBdDQp9",
"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/anomalyDetector/examples/ListAnomalyDetectorsInWorkspace.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": "AnomalyDetector Name 1",
"description": "A AnomalyDetector description.",
"type": "AnomalyDetector",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"properties": {
"oneLakeRootPath": "https://onelake.dfs.fabric.microsoft.com/f089354e-8366-4e18-aea3-4cb4a3a50b48/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
}
},
{
"id": "f697fb63-abd4-4399-9548-be7e3c3c0dac",
"displayName": "AnomalyDetector Name 2",
"description": "A AnomalyDetector description.",
"type": "AnomalyDetector",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"properties": {
"oneLakeRootPath": "https://onelake.dfs.fabric.microsoft.com/f089354e-8366-4e18-aea3-4cb4a3a50b48/d8f6cf16-3aac-4440-9d76-a03d86b7ae3e"
}
}
]
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/anomalyDetector/examples/UpdateAnomalyDetector.json
+21
View File
@@ -0,0 +1,21 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"anomalyDetectorId": "5b218778-e7a5-4d73-8187-f10824047715",
"updateAnomalyDetectorRequest": {
"displayName": "AnomalyDetector's New name",
"description": "AnomalyDetector's New description"
}
},
"responses": {
"200": {
"body": {
"displayName": "AnomalyDetector's New name",
"description": "AnomalyDetector's New description",
"type": "AnomalyDetector",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"id": "5b218778-e7a5-4d73-8187-f10824047715"
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/anomalyDetector/examples/UpdateAnomalyDetectorDefinition.json
+35
View File
@@ -0,0 +1,35 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"anomalyDetectorId": "5b218778-e7a5-4d73-8187-f10824047715",
"updateMetadata" : true,
"updateAnomalyDetectorDefinitionRequest": {
"definition": {
"format": "AnomalyDetectorV1",
"parts": [
{
"path": "Configurations.json",
"payload": "eyANCiAgIiRpZCI6ICJodHRwczovL2RldmVsb3Blci5taWNyb3NvZnQuY29tL2pzb24tc2NoZW1hcy9mYWJyaWMvaXRlbS9hbm9tYWx5RGV0ZWN0b3IvZGVmaW5pdGlvbi8xLjAuMC9zY2hlbWEuanNvbiIsDQogICIkc2NoZW1hIjogImh0dHBzOi8vanNvbi1zY2hlbWEub3JnL2RyYWZ0LTA3L3NjaGVtYSMiLA0KICAidW5pdmFyaWF0ZUNvbmZpZ3VyYXRpb25zIjogWw0KICBdDQp9",
"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/anomalyDetector/swagger.json
+469
View File
@@ -0,0 +1,469 @@
{
"swagger": "2.0",
"info": {
"title": "AnomalyDetector REST APIs",
"version": "v1"
},
"schemes": [
"https"
],
"host": "api.fabric.microsoft.com",
"basePath": "/v1",
"paths": {
"/workspaces/{workspaceId}/anomalydetectors": {
"get": {
"summary": "Returns a list of AnomalyDetectors from the specified workspace.",
"description": "> [!NOTE]\n> AnomalyDetector 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_ListAnomalyDetectors",
"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/AnomalyDetectors"
}
},
"default": {
"description": "Common error codes:\n\n* InvalidItemType - Invalid item type.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List AnomalyDetectors in workspace example": {
"$ref": "./examples/ListAnomalyDetectorsInWorkspace.json"
}
}
},
"post": {
"summary": "Creates a AnomalyDetector in the specified workspace.",
"description": "> [!NOTE]\n> AnomalyDetector 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 AnomalyDetector with a definition, refer to [AnomalyDetector](/rest/api/fabric/articles/item-management/definitions/anomalydetector-definition) article. \n\n ## Permissions \n The caller must have a *contributor* workspace role. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All \n\n## Limitations \n- To create a AnomalyDetector 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_CreateAnomalyDetector",
"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": "createAnomalyDetectorRequest",
"description": "Create item request payload.",
"schema": {
"$ref": "./definitions.json#/definitions/CreateAnomalyDetectorRequest"
},
"required": true
}
],
"responses": {
"201": {
"description": "Successfully created",
"schema": {
"$ref": "./definitions.json#/definitions/AnomalyDetector"
}
},
"202": {
"description": "Request accepted, AnomalyDetector 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 AnomalyDetector example": {
"$ref": "./examples/CreateAnomalyDetectorWithoutDefinition.json"
},
"Create a AnomalyDetector with definition example": {
"$ref": "./examples/CreateAnomalyDetector.json"
}
}
}
},
"/workspaces/{workspaceId}/anomalydetectors/{anomalyDetectorId}": {
"get": {
"summary": "Returns properties of the specified AnomalyDetector.",
"description": "> [!NOTE]\n> AnomalyDetector item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\n## Permissions\n\n The caller must have *read* permissions for the AnomalyDetector. \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_GetAnomalyDetector",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "anomalyDetectorId",
"description": "The AnomalyDetector ID.",
"type": "string",
"format": "uuid",
"required": true
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions.json#/definitions/AnomalyDetector"
}
},
"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 AnomalyDetector example": {
"$ref": "./examples/GetAnomalyDetector.json"
}
}
},
"patch": {
"summary": "Updates the properties of the specified AnomalyDetector.",
"description": "> [!NOTE]\n> AnomalyDetector 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 AnomalyDetector.\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_UpdateAnomalyDetector",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "anomalyDetectorId",
"description": "The AnomalyDetector ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "body",
"name": "updateAnomalyDetectorRequest",
"description": "Update AnomalyDetector request payload.",
"schema": {
"$ref": "./definitions.json#/definitions/UpdateAnomalyDetectorRequest"
},
"required": true
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions.json#/definitions/AnomalyDetector"
}
},
"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 AnomalyDetector example": {
"$ref": "./examples/UpdateAnomalyDetector.json"
}
}
},
"delete": {
"summary": "Deletes the specified AnomalyDetector.",
"description": "> [!NOTE]\n> AnomalyDetector item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\n## Permissions\n\n The caller must have *write* permissions for the AnomalyDetector. \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_DeleteAnomalyDetector",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "anomalyDetectorId",
"description": "The AnomalyDetector 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 AnomalyDetector example": {
"$ref": "./examples/DeleteAnomalyDetector.json"
}
}
}
},
"/workspaces/{workspaceId}/anomalydetectors/{anomalyDetectorId}/getDefinition": {
"post": {
"summary": "Returns the specified AnomalyDetector definition.",
"description": "> [!NOTE]\n> AnomalyDetector 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 AnomalyDetector's 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 AnomalyDetector. \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_GetAnomalyDetectorDefinition",
"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": "anomalyDetectorId",
"description": "The AnomalyDetector ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "query",
"name": "format",
"description": "The format of the AnomalyDetector definition. Additional `format` types may be added over time.",
"type": "string",
"enum": [
"AnomalyDetectorV1"
],
"x-ms-enum": {
"name": "AnomalyDetectorDefinitionFormat",
"modelAsString": true,
"values": [
{
"value": "AnomalyDetectorV1",
"description": "Format for the AnomalyDetector definition, specifically designed to support CI/CD scenarios in Fabric. see [AnomalyDetector - AnomalyDetectorV1 specification](/rest/api/fabric/articles/item-management/definitions/anomalydetector-definition) for more details."
}
]
},
"required": false
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions.json#/definitions/AnomalyDetectorDefinitionResponse"
}
},
"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 AnomalyDetector definition example": {
"$ref": "./examples/GetAnomalyDetectorDefinition.json"
}
}
}
},
"/workspaces/{workspaceId}/anomalydetectors/{anomalyDetectorId}/updateDefinition": {
"post": {
"summary": "Overrides the definition for the specified AnomalyDetector.",
"description": "> [!NOTE]\n> AnomalyDetector 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 AnomalyDetector's definition, does not affect its sensitivity label. \n\n## Permissions\n\n The caller must have *read and write* permissions for the AnomalyDetector. \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_UpdateAnomalyDetectorDefinition",
"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": "anomalyDetectorId",
"description": "The AnomalyDetector 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": "updateAnomalyDetectorDefinitionRequest",
"description": "Update AnomalyDetector definition request payload.",
"schema": {
"$ref": "./definitions.json#/definitions/UpdateAnomalyDetectorDefinitionRequest"
},
"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 AnomalyDetector definition example": {
"$ref": "./examples/UpdateAnomalyDetectorDefinition.json"
}
}
}
}
},
"responses": {},
"security": [],
"tags": []
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/common/definitions.json
+141 -7
View File
@@ -88,7 +88,7 @@
"type":{
"description": "The type of the principal. Additional principal types may be added over time.",
"type": "string",
"enum": ["User", "ServicePrincipal", "Group", "ServicePrincipalProfile"],
"enum": ["User", "ServicePrincipal", "Group", "ServicePrincipalProfile", "EntireTenant"],
"x-ms-enum": {
"name": "PrincipalType",
"modelAsString": true,
@@ -108,6 +108,10 @@
{
"value": "ServicePrincipalProfile",
"description": "Principal is a service principal profile."
},
{
"value": "EntireTenant",
"description": "Principal represents all tenant users."
}
]
},
@@ -188,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" ],
"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" ],
"x-ms-enum": {
"name": "ItemType",
"modelAsString": true,
@@ -324,6 +328,18 @@
{
"value": "DigitalTwinBuilderFlow",
"description": "A Digital Twin Builder Flow."
},
{
"value": "AnomalyDetector",
"description": "An Anomaly Detector."
},
{
"value": "Map",
"description": "A Map."
},
{
"value": "UserDataFunction",
"description": "A User Data Function."
}
]
},
@@ -644,7 +660,8 @@
"description": "Represents a tag.",
"required": [
"id",
"displayName"
"displayName",
"scope"
],
"properties": {
"id": {
@@ -655,6 +672,10 @@
"displayName": {
"type": "string",
"description": "The name of the tag."
},
"scope": {
"$ref": "#/definitions/TagScope",
"description": "The scope of the tag."
}
}
},
@@ -698,7 +719,66 @@
}
}
},
"TagScope": {
"type": "object",
"description": "Represents a tag scope",
"discriminator": "type",
"required": [
"type"
],
"properties": {
"type":{
"description": "Denotes tag scope. Additional tag scopes may be added over time.",
"type": "string",
"enum": ["Tenant", "Domain"],
"x-ms-enum": {
"name": "TagScopeType",
"modelAsString": true,
"values": [
{
"value": "Tenant",
"description": "Tag is a tenant level tag."
},
{
"value": "Domain",
"description": "Tag is a domain level tag."
}
]
},
"readOnly": false
}
}
},
"TenantTagScope": {
"type": "object",
"description": "Represents tenant tag scope.",
"allOf": [
{
"$ref": "#/definitions/TagScope"
}
],
"x-ms-discriminator-value": "Tenant"
},
"DomainTagScope": {
"type": "object",
"description": "Represents domain tag scope.",
"required": [
"domainId"
],
"properties": {
"domainId": {
"type": "string",
"format": "uuid",
"description": "Domain object ID"
}
},
"allOf": [
{
"$ref": "#/definitions/TagScope"
}
],
"x-ms-discriminator-value": "Domain"
},
"ItemReference": {
"description": "An item reference object.",
"type": "object",
@@ -792,8 +872,62 @@
}
}
}
},
"SqlAuditSettings": {
"type": "object",
"description": "The current state of audit settings for an item.",
"required": ["state", "retentionDays", "auditActionsAndGroups"],
"properties": {
"state": {
"description": "Audit settings state type.",
"$ref": "#/definitions/AuditSettingsState"
},
"retentionDays": {
"description": "Retention days. 0 indicates indefinite retention period.",
"type": "integer"
},
"auditActionsAndGroups": {
"description": "Audit actions and groups.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"SqlAuditSettingsUpdate": {
"type": "object",
"description": "Audit settings update request.",
"properties": {
"state": {
"description": "Audit settings state type.",
"$ref": "#/definitions/AuditSettingsState"
},
"retentionDays": {
"description": "Retention days.",
"type": "integer",
"default": 0
}
}
},
"AuditSettingsState": {
"description": "Audit settings state. Additional AuditSettingsState may be added over time.",
"type": "string",
"enum": ["Enabled", "Disabled"],
"x-ms-enum": {
"name": "AuditSettingsState",
"modelAsString": true,
"values": [
{
"value": "Enabled",
"description": "Enable the SQL audit."
},
{
"value": "Disabled",
"description": "Disable the SQL audit."
}
]
}
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/dataflow/definitions.json
+244 -1
View File
@@ -204,6 +204,249 @@
}
}
}
},
"DataflowParameters": {
"description": "A list of Dataflow parameters.",
"type": "object",
"required": [ "value" ],
"properties": {
"value": {
"description": "A list of parameters defined in the Dataflow.",
"type": "array",
"items": {
"$ref": "#/definitions/DataflowParameter"
}
}
},
"allOf": [
{
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
}
]
},
"DataflowParameter": {
"description": "Base type for a Dataflow parameter that contains the corresponding properties for all parameters.",
"type": "object",
"discriminator": "type",
"required": [ "name", "type", "isRequired", "description" ],
"properties": {
"name": {
"description": "The name of the parameter.",
"type": "string"
},
"description": {
"description": "A description of the parameter.",
"type": "string"
},
"isRequired": {
"description": "Indicates whether the parameter is required.",
"type": "boolean"
},
"type": {
"description": "The type of the parameter. Additional type types may be added over time.",
"type": "string",
"enum": [ "String", "Boolean", "Integer", "Number", "DateTime", "DateTimeZone", "Date", "Time", "Duration" ],
"x-ms-enum": {
"name": "ParameterType",
"modelAsString": true,
"values": [
{
"value": "String",
"description": "The parameter value is of type string."
},
{
"value": "Boolean",
"description": "The parameter value is of type boolean."
},
{
"value": "Integer",
"description": "The parameter value is of type long."
},
{
"value": "Number",
"description": "The parameter value is of type double."
},
{
"value": "DateTime",
"description": "The parameter value is of type DateTime. The time is in UTC, using the YYYY-MM-DDTHH:mm:ssZ format."
},
{
"value": "DateTimeZone",
"description": "The parameter value is of type DateTimeZone. String in the format `yyyy-MM-ddTHH:mm:sszzz`."
},
{
"value": "Date",
"description": "The parameter value is of type Date. String in the format `yyyy-MM-dd`."
},
{
"value": "Time",
"description": "The parameter value is of type Time. String in the format `HH:mm:ss`."
},
{
"value": "Duration",
"description": "The parameter value is of type Duration. String in the format `\\Pd\\DTH\\Hm\\Ms\\S`."
}
]
}
}
}
},
"DataflowStringParameter": {
"type": "object",
"description": "A Dataflow parameter of type String.",
"required": [ "defaultValue" ],
"properties": {
"defaultValue": {
"description": "The value with which the parameter will be refreshed if none is provided when executing the dataflow .",
"type": "string"
}
},
"allOf": [
{
"$ref": "#/definitions/DataflowParameter"
}
],
"x-ms-discriminator-value": "String"
},
"DataflowBooleanParameter": {
"type": "object",
"description": "A Dataflow parameter of type Boolean.",
"required": [ "defaultValue" ],
"properties": {
"defaultValue": {
"description": "The value with which the parameter will be refreshed if none is provided when executing the dataflow.",
"type": "boolean"
}
},
"allOf": [
{
"$ref": "#/definitions/DataflowParameter"
}
],
"x-ms-discriminator-value": "Boolean"
},
"DataflowIntegerParameter": {
"type": "object",
"description": "A Dataflow parameter of type Long.",
"required": [ "defaultValue" ],
"properties": {
"defaultValue": {
"description": "The value with which the parameter will be refreshed if none is provided when executing the dataflow.",
"type": "integer",
"format": "int64"
}
},
"allOf": [
{
"$ref": "#/definitions/DataflowParameter"
}
],
"x-ms-discriminator-value": "Integer"
},
"DataflowNumberParameter": {
"type": "object",
"description": "A Dataflow parameter of type double.",
"required": [ "defaultValue" ],
"properties": {
"defaultValue": {
"description": "The value with which the parameter will be refreshed if none is provided when executing the dataflow.",
"type": "number",
"format": "double"
}
},
"allOf": [
{
"$ref": "#/definitions/DataflowParameter"
}
],
"x-ms-discriminator-value": "Number"
},
"DataflowDateTimeParameter": {
"type": "object",
"description": "A Dataflow parameter of type DateTime. String in the format `yyyy-MM-ddTHH:mm:ss.xxxZ` (Example: `2025-09-15T21:45:00.000Z`).",
"required": [ "defaultValue" ],
"properties": {
"defaultValue": {
"description": "The value with which the parameter will be refreshed if none is provided when executing the dataflow.",
"type": "string",
"format": "date-time"
}
},
"allOf": [
{
"$ref": "#/definitions/DataflowParameter"
}
],
"x-ms-discriminator-value": "DateTime"
},
"DataflowDateTimeZoneParameter": {
"type": "object",
"description": "A Dataflow parameter of type DateTimeZone. String in the format `yyyy-MM-ddTHH:mm:sszzz` (Example: `2025-09-15T21:45:00+02:00`). Use \"Automatic\" type to override this type of parameter when executing the dataflow.",
"required": [ "defaultValue" ],
"properties": {
"defaultValue": {
"description": "The value with which the parameter will be refreshed if none is provided when executing the dataflow.",
"type": "string"
}
},
"allOf": [
{
"$ref": "#/definitions/DataflowParameter"
}
],
"x-ms-discriminator-value": "DateTimeZone"
},
"DataflowDateParameter": {
"type": "object",
"description": "A Dataflow parameter of type Date. String in the format `yyyy-MM-dd` (Example: `2025-09-15` for the date Sep 15, 2025). Use \"Automatic\" type to override this type of parameter when executing the dataflow.",
"required": [ "defaultValue" ],
"properties": {
"defaultValue": {
"description": "The value with which the parameter will be refreshed if none is provided when executing the dataflow.",
"type": "string"
}
},
"allOf": [
{
"$ref": "#/definitions/DataflowParameter"
}
],
"x-ms-discriminator-value": "Date"
},
"DataflowTimeParameter": {
"type": "object",
"description": "A Dataflow parameter of type Time. String in the format `HH:mm:ss` (Example: `21:45:00` for 9:45 PM). Use \"Automatic\" type to override this type of parameter when executing the dataflow.",
"required": [ "defaultValue" ],
"properties": {
"defaultValue": {
"description": "The value with which the parameter will be refreshed if none is provided when executing the dataflow.",
"type": "string"
}
},
"allOf": [
{
"$ref": "#/definitions/DataflowParameter"
}
],
"x-ms-discriminator-value": "Time"
},
"DataflowDurationParameter": {
"type": "object",
"description": "A Dataflow parameter of type Duration. String in the format `\\Pd\\DTH\\Hm\\Ms\\S` (Example: `P5DT14H35M30S` for 5 days, 14 hours, 35 minutes and 30 seconds). Use \"Automatic\" type to override this type of parameter when executing the dataflow.",
"required": [ "defaultValue" ],
"properties": {
"defaultValue": {
"description": "The value with which the parameter will be refreshed if none is provided when executing the dataflow.",
"type": "string"
}
},
"allOf": [
{
"$ref": "#/definitions/DataflowParameter"
}
],
"x-ms-discriminator-value": "Duration"
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/dataflow/examples/DiscoverDataflowParameters.json
+77
View File
@@ -0,0 +1,77 @@
{
"parameters": {
"workspaceId": "a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1",
"dataflowId": "dddddddd-9999-0000-1111-eeeeeeeeeeee"
},
"responses": {
"200": {
"body": {
"value": [
{
"name": "manufacturer",
"isRequired": true,
"description": "Manufacturer of the item",
"type": "String",
"defaultValue": "test-value"
},
{
"name": "isImported",
"isRequired": false,
"description": "Is the item imported",
"type": "Boolean",
"defaultValue": true
},
{
"name": "quantity",
"isRequired": false,
"description": "Quantity of item",
"type": "Integer",
"defaultValue": 123456789
},
{
"name": "weightThreshold",
"isRequired": true,
"description": "Weight threshold for item",
"type": "Number",
"defaultValue": 3.14
},
{
"name": "datetimeOfOrder",
"isRequired": true,
"description": "Datetime of order",
"type": "DateTime",
"defaultValue": "2025-09-15T21:45:00.000Z"
},
{
"name": "datetimeZoneOfOrder",
"isRequired": true,
"description": "DatetimeZone of order",
"type": "DateTimeZone",
"defaultValue": "2025-09-15T21:45:00+02:00"
},
{
"name": "dateOfImport",
"isRequired": true,
"description": "Date of import",
"type": "Date",
"defaultValue": "2025-09-15"
},
{
"name": "timeOfImport",
"isRequired": true,
"description": "Time of import",
"type": "Time",
"defaultValue": "21:45:00"
},
{
"name": "durationOfImport",
"isRequired": true,
"description": "Duration of import",
"type": "Duration",
"defaultValue": "P5DT21H35M30S"
}
]
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/dataflow/swagger.json
+69 -9
View File
@@ -442,10 +442,70 @@
}
}
},
"/workspaces/{workspaceId}/dataflows/{dataflowId}/parameters": {
"get": {
"summary": "Retrieves all parameters defined in the specified Dataflow.",
"description": "## Permissions\n\nThe caller must have *read* permissions for the dataflow.\n\n## Required Delegated Scopes\n\nDataflow.Read.All or Dataflow.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_DiscoverDataflowParameters",
"x-ms-pageable": {
"nextLinkName": "continuationUri"
},
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "dataflowId",
"description": "The Dataflow 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/DataflowParameters"
}
},
"default": {
"description": "Common error codes:\n\n* ItemNotFound - The requested item was not found \n\n* DataflowNotParametricError - The requested dataflow is not parametric",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Dataflow Parameters example": {
"$ref": "./examples/DiscoverDataflowParameters.json"
}
}
}
},
"/workspaces/{workspaceId}/dataflows/{dataflowId}/jobs/Execute/schedules": {
"post": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nCreate a new execute schedule for a dataflow. A dataflow can create maximum 20 schedulers.",
"description": "## Required Delegated Scopes: \n\nDataflow.Execute.All and Dataflow.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",
"summary": "Create a new execute schedule for a dataflow. A dataflow can create maximum 20 schedulers.",
"description": "> [!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\n## Required Delegated Scopes: \n\nDataflow.Execute.All and Dataflow.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": [
"BackgroundJobs"
],
@@ -509,8 +569,8 @@
},
"/workspaces/{workspaceId}/dataflows/{dataflowId}/jobs/ApplyChanges/schedules": {
"post": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nCreate a new apply changes schedule for a dataflow. A dataflow can create maximum 20 schedulers.",
"description": "## Required Delegated Scopes: \n\nDataflow.Execute.All and Dataflow.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",
"summary": "Create a new apply changes schedule for a dataflow. A dataflow can create maximum 20 schedulers.",
"description": "> [!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\n## Required Delegated Scopes: \n\nDataflow.Execute.All and Dataflow.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": [
"BackgroundJobs"
],
@@ -574,8 +634,8 @@
},
"/workspaces/{workspaceId}/dataflows/{dataflowId}/jobs/instances?jobType=Execute": {
"post": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nRun on-demand execute job instance.",
"description": "## Required Delegated Scopes\n\n For dataflows APIs use these scope types: \n- Specific scope: Dataflow.Execute.All \n\n for more information about scopes, see: [scopes article](/rest/api/fabric/articles/scopes).\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
"summary": "Run on-demand execute job instance.",
"description": "> [!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\n## Required Delegated Scopes\n\n For dataflows APIs use these scope types: \n- Specific scope: Dataflow.Execute.All \n\n for more information about scopes, see: [scopes article](/rest/api/fabric/articles/scopes).\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
"tags": [
"BackgroundJobs"
],
@@ -650,8 +710,8 @@
},
"/workspaces/{workspaceId}/dataflows/{dataflowId}/jobs/instances?jobType=ApplyChanges": {
"post": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nRun on-demand apply changes job instance.",
"description": "## Required Delegated Scopes\n\n For dataflows APIs use these scope types: \n- Specific scope: Dataflow.Execute.All \n\n for more information about scopes, see: [scopes article](/rest/api/fabric/articles/scopes).\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
"summary": "Run on-demand apply changes job instance.",
"description": "> [!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\n## Required Delegated Scopes\n\n For dataflows APIs use these scope types: \n- Specific scope: Dataflow.Execute.All \n\n for more information about scopes, see: [scopes article](/rest/api/fabric/articles/scopes).\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
"tags": [
"BackgroundJobs"
],
@@ -716,4 +776,4 @@
"responses": {},
"security": [],
"tags": []
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/digitalTwinBuilder/swagger.json
+15 -15
View File
@@ -12,8 +12,8 @@
"paths": {
"/workspaces/{workspaceId}/digitaltwinbuilders": {
"get": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nReturns a list of DigitalTwinBuilders 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) | No |\n\n## Interface",
"summary": "Returns a list of DigitalTwinBuilders from the specified workspace.",
"description": "> [!NOTE]\n> Digital Twin Builder 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"
],
@@ -62,8 +62,8 @@
}
},
"post": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nCreates a DigitalTwinBuilder in the specified workspace.",
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n To create digitaltwinbuilder with definition, refer to [DigitalTwinBuilder definition](/rest/api/fabric/articles/item-management/definitions/digital-twin-builder-definition). \n\n ## Permissions \n The caller must have a *contributor* workspace role. \n\n## Required Delegated Scopes \n\n DigitalTwinBuilder.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations \n- To create a digitaltwinbuilder 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",
"summary": "Creates a DigitalTwinBuilder in the specified workspace.",
"description": "> [!NOTE]\n> Digital Twin Builder 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 digitaltwinbuilder with definition, refer to [DigitalTwinBuilder definition](/rest/api/fabric/articles/item-management/definitions/digital-twin-builder-definition). \n\n ## Permissions \n The caller must have a *contributor* workspace role. \n\n## Required Delegated Scopes \n\n DigitalTwinBuilder.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations \n- To create a digitaltwinbuilder 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"
],
@@ -138,8 +138,8 @@
},
"/workspaces/{workspaceId}/digitaltwinbuilders/{digitaltwinbuilderId}": {
"get": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nReturns properties of the specified DigitalTwinBuilder.",
"description": "## Permissions\n\n The caller must have *read* permissions for the digital twin builder. \n\n## Required Delegated Scopes \n\n DigitalTwinBuilder.Read.All or DigitalTwinBuilder.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) | No |\n\n## Interface",
"summary": "Returns properties of the specified DigitalTwinBuilder.",
"description": "> [!NOTE]\n> Digital Twin Builder item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\n## Permissions\n\n The caller must have *read* permissions for the digital twin builder. \n\n## Required Delegated Scopes \n\n DigitalTwinBuilder.Read.All or DigitalTwinBuilder.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) | No |\n\n## Interface",
"tags": [
"Items"
],
@@ -186,8 +186,8 @@
}
},
"patch": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nUpdates the properties of the specified DigitalTwinBuilder.",
"description": "## Permissions\n\n The caller must have *read and write* permissions for the digital twin builder. \n\n## Required Delegated Scopes \n\n DigitalTwinBuilder.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) | No |\n\n## Interface",
"summary": "Updates the properties of the specified DigitalTwinBuilder.",
"description": "> [!NOTE]\n> Digital Twin Builder 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 digital twin builder. \n\n## Required Delegated Scopes \n\n DigitalTwinBuilder.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) | No |\n\n## Interface",
"tags": [
"Items"
],
@@ -246,8 +246,8 @@
}
},
"delete": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nDeletes the specified DigitalTwinBuilder.",
"description": "## Permissions\n\n The caller must have *write* permissions for the digital twin builder. \n\n## Required Delegated Scopes \n\n DigitalTwinBuilder.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) | No |\n\n## Interface",
"summary": "Deletes the specified DigitalTwinBuilder.",
"description": "> [!NOTE]\n> Digital Twin Builder item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\n## Permissions\n\n The caller must have *write* permissions for the digital twin builder. \n\n## Required Delegated Scopes \n\n DigitalTwinBuilder.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) | No |\n\n## Interface",
"tags": [
"Items"
],
@@ -293,8 +293,8 @@
},
"/workspaces/{workspaceId}/digitaltwinbuilders/{digitaltwinbuilderId}/getDefinition": {
"post": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nReturns the specified DigitalTwinBuilder public definition.",
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a digitaltwinbuilder 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 digital twin builder. \n\n## Required Delegated Scopes \n\n DigitalTwinBuilder.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations\n\n This API is blocked for a digitaltwinbuilder with an encrypted sensitivity label.\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",
"summary": "Returns the specified DigitalTwinBuilder public definition.",
"description": "> [!NOTE]\n> Digital Twin Builder 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 digitaltwinbuilder 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 digital twin builder. \n\n## Required Delegated Scopes \n\n DigitalTwinBuilder.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations\n\n This API is blocked for a digitaltwinbuilder with an encrypted sensitivity label.\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"
],
@@ -369,8 +369,8 @@
},
"/workspaces/{workspaceId}/digitaltwinbuilders/{digitaltwinbuilderId}/updateDefinition": {
"post": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nUpdates the definition of a specified DigitalTwinBuilder. The update overrides the current definition.",
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n \nUpdating the digitaltwinbuilder definition, does not affect its sensitivity label. \n\n## Permissions\n\n The caller must have *read and write* permissions for the digital twin builder. \n## Required Delegated Scopes \n\n DigitalTwinBuilder.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) | No |\n\n## Interface",
"summary": "Updates the definition of a specified DigitalTwinBuilder. The update overrides the current definition.",
"description": "> [!NOTE]\n> Digital Twin Builder 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 digitaltwinbuilder definition, does not affect its sensitivity label. \n\n## Permissions\n\n The caller must have *read and write* permissions for the digital twin builder. \n## Required Delegated Scopes \n\n DigitalTwinBuilder.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) | No |\n\n## Interface",
"tags": [
"Items"
],
@@ -453,4 +453,4 @@
"responses": {},
"security": [],
"tags": []
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/digitalTwinBuilderFlow/swagger.json
+15 -15
View File
@@ -12,8 +12,8 @@
"paths": {
"/workspaces/{workspaceId}/DigitalTwinBuilderFlows": {
"get": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nReturns a list of Digital Twin Builder Flows 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",
"summary": "Returns a list of Digital Twin Builder Flows from the specified workspace.",
"description": "> [!NOTE]\n> Digital Twin Builder Flow item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\n The caller must have a *viewer* workspace role. \n\n## Required Delegated Scopes\n\nWorkspace.Read.All or Workspace.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"tags": [
"Items"
],
@@ -62,8 +62,8 @@
}
},
"post": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nCreates a Digital Twin Builder Flow in the specified workspace.",
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n To create Digital Twin Builder Flow with a public definition, refer to [](/rest/api/fabric/articles/item-management/definitions/digital-twin-builder-flow-definition) article. \n\n ## Permissions \n The caller must have a *contributor* workspace role. \n\n## Required Delegated Scopes\n\n DigitalTwinBuilderFlow.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations \n- To create a Digital Twin Builder Flow 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",
"summary": "Creates a Digital Twin Builder Flow in the specified workspace.",
"description": "> [!NOTE]\n> Digital Twin Builder Flow 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 Digital Twin Builder Flow with a public definition, refer to [](/rest/api/fabric/articles/item-management/definitions/digital-twin-builder-flow-definition) article. \n\n ## Permissions \n The caller must have a *contributor* workspace role. \n\n## Required Delegated Scopes\n\n DigitalTwinBuilderFlow.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations \n- To create a Digital Twin Builder Flow 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"
],
@@ -138,8 +138,8 @@
},
"/workspaces/{workspaceId}/DigitalTwinBuilderFlows/{digitalTwinBuilderFlowId}": {
"get": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nReturns properties of the specified Digital Twin Builder Flow.",
"description": "## Permissions\n\n The caller must have *read* permissions for the digital twin builder flow. \n\n## Required Delegated Scopes\n\n DigitalTwinBuilderFlow.Read.All or DigitalTwinBuilderFlow.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",
"summary": "Returns properties of the specified Digital Twin Builder Flow.",
"description": "> [!NOTE]\n> Digital Twin Builder Flow item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\n## Permissions\n\n The caller must have *read* permissions for the digital twin builder flow. \n\n## Required Delegated Scopes\n\n DigitalTwinBuilderFlow.Read.All or DigitalTwinBuilderFlow.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"
],
@@ -186,8 +186,8 @@
}
},
"patch": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nUpdates the properties of the specified Digital Twin Builder Flow.",
"description": "## Permissions\n\n The caller must have *read and write* permissions for the digital twin builder flow.\n\n## Required Delegated Scopes\n\n DigitalTwinBuilderFlow.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",
"summary": "Updates the properties of the specified Digital Twin Builder Flow.",
"description": "> [!NOTE]\n> Digital Twin Builder Flow 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 digital twin builder flow.\n\n## Required Delegated Scopes\n\n DigitalTwinBuilderFlow.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"
],
@@ -246,8 +246,8 @@
}
},
"delete": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nDeletes the specified Digital Twin Builder Flow.",
"description": "## Permissions\n\n The caller must have *write* permissions for the digital twin builder flow. \n\n## Required Delegated Scopes\n\n DigitalTwinBuilderFlow.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",
"summary": "Deletes the specified Digital Twin Builder Flow.",
"description": "> [!NOTE]\n> Digital Twin Builder Flow item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\n## Permissions\n\n The caller must have *write* permissions for the digital twin builder flow. \n\n## Required Delegated Scopes\n\n DigitalTwinBuilderFlow.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"
],
@@ -293,8 +293,8 @@
},
"/workspaces/{workspaceId}/DigitalTwinBuilderFlows/{digitalTwinBuilderFlowId}/getDefinition": {
"post": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nReturns the specified Digital Twin Builder Flow public definition.",
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a Digital Twin Builder Flow'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 digital twin builder flow. \n\n## Required Delegated Scopes\n\n DigitalTwinBuilderFlow.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",
"summary": "Returns the specified Digital Twin Builder Flow public definition.",
"description": "> [!NOTE]\n> Digital Twin Builder Flow 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 Digital Twin Builder Flow'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 digital twin builder flow. \n\n## Required Delegated Scopes\n\n DigitalTwinBuilderFlow.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"
],
@@ -362,8 +362,8 @@
},
"/workspaces/{workspaceId}/DigitalTwinBuilderFlows/{digitalTwinBuilderFlowId}/updateDefinition": {
"post": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nOverrides the definition for the specified Digital Twin Builder Flow.",
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n \nUpdating the Digital Twin Builder Flow's definition, does not affect its sensitivity label. \n\n## Permissions\n\n The caller must have *read and write* permissions for the digital twin builder flow. \n## Required Delegated Scopes\n\n DigitalTwinBuilderFlow.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",
"summary": "Overrides the definition for the specified Digital Twin Builder Flow.",
"description": "> [!NOTE]\n> Digital Twin Builder Flow 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 Digital Twin Builder Flow's definition, does not affect its sensitivity label. \n\n## Permissions\n\n The caller must have *read and write* permissions for the digital twin builder flow. \n## Required Delegated Scopes\n\n DigitalTwinBuilderFlow.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"
],
@@ -446,4 +446,4 @@
"responses": {},
"security": [],
"tags": []
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/environment/definitions.json
+309 -20
View File
@@ -6,7 +6,7 @@
},
"paths": {},
"definitions": {
"EnvironmentSparkCompute": {
"EnvironmentSparkComputePreview": {
"type": "object",
"properties": {
"instancePool": {
@@ -14,7 +14,7 @@
"$ref": "#/definitions/InstancePool"
},
"driverCores": {
"description": "Spark driver core.",
"description": "Spark driver core. Must be one of the following values: 4, 8, 16, 32, 64.",
"format": "int32",
"type": "integer"
},
@@ -23,7 +23,7 @@
"type": "string"
},
"executorCores": {
"description": "Spark executor core.",
"description": "Spark executor core. Must be one of the following values: 4, 8, 16, 32, 64.",
"format": "int32",
"type": "integer"
},
@@ -37,15 +37,15 @@
},
"sparkProperties": {
"type": "object",
"description": "Spark properties."
"description": "Spark properties. The dictionary-based contract for defining Spark properties will be deprecated on January 31, 2026. Please migrate to using a list of key-value pairs instead."
},
"runtimeVersion": {
"description": "Runtime version, find the supported [fabric runtimes](/fabric/data-engineering/runtime). For example: 1.3",
"description": "Runtime version, find the supported [fabric runtimes](/fabric/data-engineering/runtime).",
"type": "string"
}
}
},
"UpdateEnvironmentSparkComputeRequest": {
"UpdateEnvironmentSparkComputeRequestPreview": {
"type": "object",
"properties": {
"instancePool": {
@@ -77,7 +77,51 @@
},
"sparkProperties": {
"type": "object",
"description": "Spark properties."
"description": "Spark properties. The dictionary-based contract for defining Spark properties will be deprecated on January 31, 2026. Please migrate to using a list of key-value pairs instead."
},
"runtimeVersion": {
"description": "Runtime version, find the supported [fabric runtimes](/fabric/data-engineering/runtime).",
"type": "string"
}
}
},
"EnvironmentSparkCompute": {
"type": "object",
"properties": {
"instancePool": {
"description": "Environment pool has to be a valid custom pool. \"Starter Pool\" means use starter pool.",
"$ref": "#/definitions/InstancePool"
},
"driverCores": {
"description": "Spark driver core. Must be one of the following values: 4, 8, 16, 32, 64.",
"format": "int32",
"type": "integer"
},
"driverMemory": {
"description": "Spark driver memory.",
"type": "string",
"$ref": "#/definitions/CustomPoolMemory"
},
"executorCores": {
"description": "Spark executor core. Must be one of the following values: 4, 8, 16, 32, 64.",
"format": "int32",
"type": "integer"
},
"executorMemory": {
"description": "Spark executor memory.",
"type": "string",
"$ref": "#/definitions/CustomPoolMemory"
},
"dynamicExecutorAllocation": {
"description": "Dynamic executor allocation.",
"$ref": "#/definitions/DynamicExecutorAllocationProperties"
},
"sparkProperties": {
"type": "array",
"description": "Spark properties.",
"items": {
"$ref": "#/definitions/SparkProperty"
}
},
"runtimeVersion": {
"description": "Runtime version, find the supported [fabric runtimes](/fabric/data-engineering/runtime). For example: 1.3",
@@ -85,11 +129,97 @@
}
}
},
"UpdateEnvironmentSparkComputeRequest": {
"type": "object",
"properties": {
"instancePool": {
"description": "Environment pool has to be a valid custom pool. The name for a default workspace pool is *Starter Pool*.",
"$ref": "#/definitions/InstancePool",
"type": "object"
},
"driverCores": {
"description": "Spark driver core. Must be one of the following values: 4, 8, 16, 32, 64.",
"format": "int32",
"type": "integer"
},
"driverMemory": {
"description": "Spark driver memory.",
"type": "string",
"$ref": "#/definitions/CustomPoolMemory"
},
"executorCores": {
"description": "Spark executor core. Must be one of the following values: 4, 8, 16, 32, 64.",
"format": "int32",
"type": "integer"
},
"executorMemory": {
"description": "Spark executor memory.",
"type": "string",
"$ref": "#/definitions/CustomPoolMemory"
},
"dynamicExecutorAllocation": {
"description": "Dynamic executor allocation.",
"$ref": "#/definitions/DynamicExecutorAllocationProperties"
},
"sparkProperties": {
"type": "array",
"description": "Spark properties.",
"items": {
"$ref": "#/definitions/SparkProperty"
}
},
"runtimeVersion": {
"description": "Runtime version, find the supported [fabric runtimes](/fabric/data-engineering/runtime). For example: 1.3",
"type": "string"
}
}
},
"CustomPoolMemory": {
"type": "string",
"description": "Custom pool memory for Spark driver or Spark executor. Additional `CustomPoolMemory` types may be added over time.",
"enum": ["28g", "56g", "112g", "224g", "400g"],
"x-ms-enum": {
"name": "CustomPoolMemory",
"modelAsString": true,
"values": [
{
"value": "28g",
"description": "28GB memory."
},
{
"value": "56g",
"description": "56G memory."
},
{
"value": "112g",
"description": "112G memory."
},
{
"value": "224g",
"description": "224G memory."
},
{
"value": "400g",
"description": "400G memory."
}
]
}
},
"SparkProperty": {
"type": "object",
"description": "A Spark property key and its value.",
"properties": {
"key": {
"description": "The Spark property key.",
"type": "string"
},
"value": {
"description": "The Spark property value.",
"type": "string"
}
}
},
"InstancePool": {
"required": [
"name",
"type"
],
"type": "object",
"description": "An instance of a pool.",
"properties": {
@@ -141,13 +271,13 @@
"type": "boolean"
},
"minExecutors": {
"description": "The minimum executor number for dynamic allocation and the minimum for this property is 1.",
"description": "The minimum executor number for dynamic allocation and the minimum for this property is 1. The maximum value has to be lower than `maxExecutors`.",
"format": "int32",
"type": "integer",
"minimum": 1
},
"maxExecutors": {
"description": "The maximum executor number for dynamic allocation and the minimum for this property is 1",
"description": "The maximum executor number for dynamic allocation and the minimum for this property is 1. The maximum value has to be lower than the instance pool `maxNodeCount`.",
"format": "int32",
"type": "integer",
"minimum": 1
@@ -185,7 +315,7 @@
"properties": {
"properties": {
"description": "The environment properties.",
"$ref": "#/definitions/EnvironmentPublishInfo"
"$ref": "#/definitions/EnvironmentProperties"
}
}
},
@@ -208,6 +338,71 @@
"type": "string",
"format": "uuid",
"readOnly": false
},
"definition": {
"description": "The environment public definition.",
"$ref": "#/definitions/EnvironmentDefinition",
"readOnly": false
}
}
},
"UpdateEnvironmentDefinitionRequest": {
"description": "Update environment public definition request payload.",
"required": ["definition"],
"properties": {
"definition": {
"$ref": "#/definitions/EnvironmentDefinition"
}
}
},
"EnvironmentDefinitionResponse": {
"description": "Environment public definition response.",
"required": ["definition"],
"properties": {
"definition": {
"$ref": "#/definitions/EnvironmentDefinition",
"readOnly": true
}
}
},
"EnvironmentDefinition" : {
"description": "Environment public definition object. Refer to this [article](/rest/api/fabric/articles/item-management/definitions/environment-definition) for more details on how to craft a environment public definition.",
"type": "object",
"required": ["parts"],
"properties": {
"format": {
"description": "The format of the Environment definition.",
"type": "string",
"readOnly": false
},
"parts": {
"description": "A list of definition parts.",
"type": "array",
"items": {
"$ref": "#/definitions/EnvironmentDefinitionPart"
},
"readOnly": false
}
}
},
"EnvironmentDefinitionPart": {
"description": "Environment definition part object.",
"type": "object",
"properties": {
"path": {
"description": "The environment part path.",
"type": "string",
"readOnly": false
},
"payload": {
"description": "The environment part payload.",
"type": "string",
"readOnly": false
},
"payloadType":{
"description": "The payload type.",
"$ref": "../common/definitions.json#/definitions/PayloadType",
"readOnly": false
}
}
},
@@ -226,8 +421,8 @@
}
}
},
"EnvironmentPublishInfo": {
"description": "Environment publish information.",
"EnvironmentProperties": {
"description": "Environment properties.",
"type": "object",
"required": ["publishDetails"],
"properties": {
@@ -283,15 +478,15 @@
"type": "string"
},
"startTime": {
"description": "Start time of publish operation.",
"description": "Start time of publish operation in UTC, using the YYYY-MM-DDTHH:mm:ss.sssssssZ format.",
"format": "date-time",
"type": "string"
},
"endTime": {
"description": "End time of publish operation.",
"description": "End time of publish operation in UTC, using the YYYY-MM-DDTHH:mm:ss.sssssssZ format.",
"format": "date-time",
"type": "string"
},
},
"componentPublishInfo": {
"description": "Environment component publish information.",
"$ref": "#/definitions/ComponentPublishInfo"
@@ -394,7 +589,101 @@
}
}
},
"EnvironmentLibraries": {
"LibraryType": {
"type": "string",
"description": "A library type. Additional types may be added over time.",
"enum": ["Custom", "External"],
"x-ms-enum": {
"name": "LibraryType",
"modelAsString": true,
"values": [
{
"value": "Custom",
"description": "Custom libraries"
},
{
"value": "External",
"description": "External libraries"
}
]
}
},
"Libraries": {
"description": "Environment libraries.",
"type": "object",
"properties": {
"libraries": {
"type": "array",
"description": "All custom and external libraries (.py, .whl, .jar, .tar.gz and external).",
"items": {
"$ref": "#/definitions/Library"
}
}
},
"allOf": [
{
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
}
]
},
"Library": {
"description": "Custom or external library.",
"type": "object",
"discriminator": "libraryType",
"required": ["libraryType", "name"],
"properties": {
"libraryType": {
"$ref": "#/definitions/LibraryType"
},
"name": {
"type": "string",
"description": "The name of library."
}
}
},
"CustomLibrary": {
"type": "object",
"description": "Custom library.",
"x-ms-discriminator-value": "Custom",
"allOf": [
{
"$ref": "#/definitions/Library"
}
]
},
"ExternalLibrary": {
"type": "object",
"description": "External library.",
"required": ["version"],
"x-ms-discriminator-value": "External",
"properties": {
"version": {
"type": "string",
"description": "The version of external library."
}
},
"allOf": [
{
"$ref": "#/definitions/Library"
}
]
},
"RemoveExternalLibrariesRequest": {
"type": "object",
"description": "Request to delete an external library.",
"required": ["name", "version"],
"properties": {
"name": {
"type": "string",
"description": "The name of library."
},
"version": {
"type": "string",
"description": "The version of external library."
}
}
},
"LibrariesPreview": {
"description": "Environment libraries.",
"type": "object",
"properties": {
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/environment/examples/CreateEnvironment.json
+41 -2
View File
@@ -3,14 +3,53 @@
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"createEnvironmentRequest": {
"displayName": "Environment_1",
"description": "An environment description"
"description": "An environment description.",
"definition": {
"parts": [
{
"path": "Libraries/CustomLibraries/samplelibrary.jar",
"payload": "eyJuYmZvcm1hdCI6N..",
"payloadType": "InlineBase64"
},
{
"path": "Libraries/CustomLibraries/samplepython.py",
"payload": "FyJuYmZvcm1hdCI6N..",
"payloadType": "InlineBase64"
},
{
"path": "Libraries/CustomLibraries/samplewheel-0.18.0-py2.py3-none-any.whl",
"payload": "LyJuYmZvcm1hdCI6N..",
"payloadType": "InlineBase64"
},
{
"path": "Libraries/CustomLibraries/sampleR.tar.gz",
"payload": "ZyJuYmZvcm1hdCI6N..",
"payloadType": "InlineBase64"
},
{
"path": "Libraries/PublicLibraries/environment.yml",
"payload": "IyJuYmZvcm1hdCI6N..",
"payloadType": "InlineBase64"
},
{
"path": "Setting/Sparkcompute.yml",
"payload": "GyJuYmZvcm1hdCI6N..",
"payloadType": "InlineBase64"
},
{
"path": ".platform",
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc",
"payloadType": "InlineBase64"
}
]
}
}
},
"responses": {
"201": {
"body": {
"displayName": "Environment_1",
"description": "An environment description",
"description": "An environment description.",
"type": "Environment",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"id": "5b218778-e7a5-4d73-8187-f10824047715"
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/environment/examples/CreateEnvironmentWithoutDefinition.json
+27
View File
@@ -0,0 +1,27 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"createEnvironmentRequest": {
"displayName": "Environment_1",
"description": "An environment description."
}
},
"responses": {
"201": {
"body": {
"displayName": "Environment_1",
"description": "An environment description.",
"type": "Environment",
"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/environment/examples/DeleteCustomLibrary.json
+11
View File
@@ -0,0 +1,11 @@
{
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"environmentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
"libraryName": "samplelibrary.jar"
},
"responses": {
"200": {
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/environment/examples/DeleteCustomLibraryPreview.json
+11
View File
@@ -0,0 +1,11 @@
{
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"environmentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
"libraryToDelete": "samplelibrary.jar"
},
"responses": {
"200": {
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/environment/examples/ExportPublishedExternalLibraries.json
+10
View File
@@ -0,0 +1,10 @@
{
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"environmentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
},
"responses": {
"200": {
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/environment/examples/ExportStagingExternalLibraries.json
+10
View File
@@ -0,0 +1,10 @@
{
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"environmentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
},
"responses": {
"200": {
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/environment/examples/GetEnvironmentDefinition.json
+58
View File
@@ -0,0 +1,58 @@
{
"parameters": {
"workspaceId": "6e335e92-a2a2-4b5a-970a-bd6a89fbb765",
"environmentId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
},
"responses": {
"200": {
"body": {
"definition": {
"parts": [
{
"path": "Libraries/CustomLibraries/samplelibrary.jar",
"payload": "eyJuYmZvcm1hdCI6N..",
"payloadType": "InlineBase64"
},
{
"path": "Libraries/CustomLibraries/samplepython.py",
"payload": "FyJuYmZvcm1hdCI6N..",
"payloadType": "InlineBase64"
},
{
"path": "Libraries/CustomLibraries/samplewheel-0.18.0-py2.py3-none-any.whl",
"payload": "LyJuYmZvcm1hdCI6N..",
"payloadType": "InlineBase64"
},
{
"path": "Libraries/CustomLibraries/sampleR.tar.gz",
"payload": "ZyJuYmZvcm1hdCI6N..",
"payloadType": "InlineBase64"
},
{
"path": "Libraries/PublicLibraries/environment.yml",
"payload": "IyJuYmZvcm1hdCI6N..",
"payloadType": "InlineBase64"
},
{
"path": "Setting/Sparkcompute.yml",
"payload": "GyJuYmZvcm1hdCI6N..",
"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/environment/examples/GetEnvironmentPreview.json
+34
View File
@@ -0,0 +1,34 @@
{
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"environmentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
"preview": true
},
"responses": {
"200": {
"body": {
"displayName": "Environment_1",
"description": "An Environment description",
"type": "Environment",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"id": "5b218778-e7a5-4d73-8187-f10824047715",
"properties": {
"publishDetails": {
"state": "Success",
"targetVersion": "46838a80-5450-4414-bea0-40fb6f3e0c0d",
"startTime": "2024-03-29T14:17:09.0697022Z",
"endTime": "2024-03-29T14:48:09.0697022Z",
"componentPublishInfo": {
"sparkLibraries": {
"state": "Success"
},
"sparkSettings": {
"state": "Success"
}
}
}
}
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/environment/examples/GetEnvironmentSparkCompute.json
+8 -4
View File
@@ -1,7 +1,8 @@
{
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"environmentId": "707cfd07-cbf1-41da-aad7-dd157ddb8c11"
"environmentId": "707cfd07-cbf1-41da-aad7-dd157ddb8c11",
"preview": "false"
},
"responses": {
"200": {
@@ -20,9 +21,12 @@
"minExecutors": 1,
"maxExecutors": 1
},
"sparkProperties": {
"spark.acls.enable": "false"
},
"sparkProperties": [
{
"key": "spark.acls.enable",
"value": "false"
}
],
"runtimeVersion": "1.2"
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/environment/examples/GetEnvironmentSparkComputePreview.json
+31
View File
@@ -0,0 +1,31 @@
{
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"environmentId": "707cfd07-cbf1-41da-aad7-dd157ddb8c11",
"preview": true
},
"responses": {
"200": {
"body": {
"instancePool": {
"name": "MyWorkspacePool",
"type": "Workspace",
"id": "78942136-106c-4f3e-80fc-7ff4eae11603"
},
"driverCores": 4,
"driverMemory": "56g",
"executorCores": 4,
"executorMemory": "56g",
"dynamicExecutorAllocation": {
"enabled": false,
"minExecutors": 1,
"maxExecutors": 1
},
"sparkProperties": {
"spark.acls.enable": "false"
},
"runtimeVersion": "1.2"
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/environment/examples/GetPublishedLibraries.json
+32 -16
View File
@@ -1,26 +1,42 @@
{
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"environmentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
"environmentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
"preview": "false"
},
"responses": {
"200": {
"body": {
"customLibraries": {
"wheelFiles": [
"samplewheel-0.18.0-py2.py3-none-any.whl"
],
"pyFiles": [
"samplepython.py"
],
"jarFiles": [
"samplejar.jar"
],
"rTarFiles": [
"sampleR.tar.gz"
]
},
"environmentYml": "dependencies:\r\n- pip:\r\n - matplotlib==3.4.3"
"libraries": [
{
"name": "samplewheel-0.18.0-py2.py3-none-any.whl",
"libraryType": "Custom"
},
{
"name": "samplepython.py",
"libraryType": "Custom"
},
{
"name": "samplejar.jar",
"libraryType": "Custom"
},
{
"name": "sampleR.tar.gz",
"libraryType": "Custom"
},
{
"name": "fuzzywuzzy",
"libraryType": "External",
"version": "0.0.1"
},
{
"name": "matplotlib",
"libraryType": "External",
"version": "0.0.1"
}
],
"continuationToken": "null",
"continuationUri": "null"
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/environment/examples/GetPublishedLibrariesPreview.json
+28
View File
@@ -0,0 +1,28 @@
{
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"environmentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
"preview": true
},
"responses": {
"200": {
"body": {
"customLibraries": {
"wheelFiles": [
"samplewheel-0.18.0-py2.py3-none-any.whl"
],
"pyFiles": [
"samplepython.py"
],
"jarFiles": [
"samplejar.jar"
],
"rTarFiles": [
"sampleR.tar.gz"
]
},
"environmentYml": "name: sample-environment\ndependencies:\n - fuzzywuzzy==0.0.1\n - matplotlib==0.0.1"
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/environment/examples/GetStagingLibraries.json
+32 -16
View File
@@ -1,26 +1,42 @@
{
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"environmentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
"environmentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
"preview": "false"
},
"responses": {
"200": {
"body": {
"customLibraries": {
"wheelFiles": [
"samplewheel-0.18.0-py2.py3-none-any.whl"
],
"pyFiles": [
"samplepython.py"
],
"jarFiles": [
"samplejar.jar"
],
"rTarFiles": [
"sampleR.tar.gz"
]
},
"environmentYml": "dependencies:\r\n- pip:\r\n - matplotlib==3.4.3"
"libraries": [
{
"name": "samplewheel-0.18.0-py2.py3-none-any.whl",
"libraryType": "Custom"
},
{
"name": "samplepython.py",
"libraryType": "Custom"
},
{
"name": "samplejar.jar",
"libraryType": "Custom"
},
{
"name": "sampleR.tar.gz",
"libraryType": "Custom"
},
{
"name": "fuzzywuzzy",
"libraryType": "External",
"version": "0.0.1"
},
{
"name": "matplotlib",
"libraryType": "External",
"version": "0.0.1"
}
],
"continuationToken": "null",
"continuationUri": "null"
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/environment/examples/GetStagingLibrariesPreview.json
+28
View File
@@ -0,0 +1,28 @@
{
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"environmentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
"preview": true
},
"responses": {
"200": {
"body": {
"customLibraries": {
"wheelFiles": [
"samplewheel-0.18.0-py2.py3-none-any.whl"
],
"pyFiles": [
"samplepython.py"
],
"jarFiles": [
"samplejar.jar"
],
"rTarFiles": [
"sampleR.tar.gz"
]
},
"environmentYml": "name: sample-environment\ndependencies:\n - fuzzywuzzy==0.0.1\n - matplotlib==0.0.1"
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/environment/examples/ImportExternalLibraries.json
+10
View File
@@ -0,0 +1,10 @@
{
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"environmentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
},
"responses": {
"200": {
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/environment/examples/PublishCancellation.json
+4 -3
View File
@@ -1,7 +1,8 @@
{
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"environmentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
"environmentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
"preview": false
},
"responses": {
"200": {
@@ -9,8 +10,8 @@
"publishDetails": {
"state": "Cancelled",
"targetVersion": "d9d95b01-248f-4ef4-bd7e-9d3f1f6447be",
"startTime": "2024-03-29T15:00:33.4359355Z",
"endTime": "2024-03-29T15:00:47.1407904Z",
"startTime": "2024-03-29T14:17:09.0697022Z",
"endTime": "2024-03-29T14:48:18.0697022Z",
"componentPublishInfo": {
"sparkLibraries": {
"state": "Cancelled"
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/environment/examples/PublishEnvironment.json
+9 -1
View File
@@ -1,7 +1,8 @@
{
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"environmentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
"environmentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
"preview": "false"
},
"responses": {
"200": {
@@ -20,6 +21,13 @@
}
}
}
},
"202": {
"headers": {
"Location": "https://api.fabric.microsoft.com/v1/operations/abcdef00-9d7e-469a-abf1-fca847a0ea69",
"x-ms-operation-id": "abcdef00-9d7e-469a-abf1-fca847a0ea69",
"Retry-After": 120
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/environment/examples/PublishEnvironmentPreview.json
+26
View File
@@ -0,0 +1,26 @@
{
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"environmentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
"preview": true
},
"responses": {
"200": {
"body": {
"publishDetails": {
"state": "Running",
"targetVersion": "46838a80-5450-4414-bea0-40fb6f3e0c0d",
"startTime": "2024-03-29T14:17:09.0697022Z",
"componentPublishInfo": {
"sparkLibraries": {
"state": "Running"
},
"sparkSettings": {
"state": "Running"
}
}
}
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/environment/examples/RemoveExternalLibraries.json
+14
View File
@@ -0,0 +1,14 @@
{
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"environmentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
"removeExternalLibraryRequest": {
"name": "fuzzywuzzy",
"version": "0.0.1"
}
},
"responses": {
"200": {
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/environment/examples/UpdateEnvironmentDefinition.json
+59
View File
@@ -0,0 +1,59 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"environmentId": "5b218778-e7a5-4d73-8187-f10824047715",
"updateMetadata" : true,
"updateEnvironmentDefinitionRequest": {
"definition": {
"parts": [
{
"path": "Libraries/CustomLibraries/samplelibrary.jar",
"payload": "eyJuYmZvcm1hdCI6N..",
"payloadType": "InlineBase64"
},
{
"path": "Libraries/CustomLibraries/samplepython.py",
"payload": "FyJuYmZvcm1hdCI6N..",
"payloadType": "InlineBase64"
},
{
"path": "Libraries/CustomLibraries/samplewheel-0.18.0-py2.py3-none-any.whl",
"payload": "LyJuYmZvcm1hdCI6N..",
"payloadType": "InlineBase64"
},
{
"path": "Libraries/CustomLibraries/sampleR.tar.gz",
"payload": "ZyJuYmZvcm1hdCI6N..",
"payloadType": "InlineBase64"
},
{
"path": "Libraries/PublicLibraries/environment.yml",
"payload": "IyJuYmZvcm1hdCI6N..",
"payloadType": "InlineBase64"
},
{
"path": "Setting/Sparkcompute.yml",
"payload": "GyJuYmZvcm1hdCI6N..",
"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/environment/examples/UpdateEnvironmentSparkCompute.json
+17 -8
View File
@@ -2,6 +2,7 @@
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"environmentId": "707cfd07-cbf1-41da-aad7-dd157ddb8c11",
"preview": "false",
"updateEnvironmentSparkComputeRequest": {
"instancePool": {
"name": "MyWorkspacePool",
@@ -16,11 +17,16 @@
"minExecutors": 1,
"maxExecutors": 1
},
"sparkProperties": {
"spark.acls.enable": "false",
"spark.admin.acls": null
},
"sparkProperties": [
{
"key": "spark.acls.enable",
"value": "false"
},
{
"key": "spark.admin.acls",
"value": null
}
],
"runtimeVersion": "1.2"
}
},
@@ -41,9 +47,12 @@
"minExecutors": 1,
"maxExecutors": 1
},
"sparkProperties": {
"spark.acls.enable": "false"
},
"sparkProperties": [
{
"key": "spark.acls.enable",
"value": "false"
}
],
"runtimeVersion": "1.2"
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/environment/examples/UpdateEnvironmentSparkComputeInstancePoolWithId.json
+39
View File
@@ -0,0 +1,39 @@
{
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"environmentId": "707cfd07-cbf1-41da-aad7-dd157ddb8c11",
"preview": "false",
"updateEnvironmentSparkComputeRequest": {
"instancePool": {
"id": "78942136-106c-4f3e-80fc-7ff4eae11603"
}
}
},
"responses": {
"200": {
"body": {
"instancePool": {
"name": "MyWorkspacePool",
"type": "Workspace",
"id": "78942136-106c-4f3e-80fc-7ff4eae11603"
},
"driverCores": 4,
"driverMemory": "56g",
"executorCores": 4,
"executorMemory": "56g",
"dynamicExecutorAllocation": {
"enabled": false,
"minExecutors": 1,
"maxExecutors": 1
},
"sparkProperties": [
{
"key": "spark.acls.enable",
"value": "false"
}
],
"runtimeVersion": "1.2"
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/environment/examples/UpdateEnvironmentSparkComputePreview.json
+51
View File
@@ -0,0 +1,51 @@
{
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"environmentId": "707cfd07-cbf1-41da-aad7-dd157ddb8c11",
"preview": true,
"updateEnvironmentSparkComputeRequest": {
"instancePool": {
"name": "MyWorkspacePool",
"type": "Workspace"
},
"driverCores": 4,
"driverMemory": "56g",
"executorCores": 4,
"executorMemory": "56g",
"dynamicExecutorAllocation": {
"enabled": false,
"minExecutors": 1,
"maxExecutors": 1
},
"sparkProperties": {
"spark.acls.enable": "false",
"spark.admin.acls": null
},
"runtimeVersion": "1.2"
}
},
"responses": {
"200": {
"body": {
"instancePool": {
"name": "MyWorkspacePool",
"type": "Workspace",
"id": "78942136-106c-4f3e-80fc-7ff4eae11603"
},
"driverCores": 4,
"driverMemory": "56g",
"executorCores": 4,
"executorMemory": "56g",
"dynamicExecutorAllocation": {
"enabled": false,
"minExecutors": 1,
"maxExecutors": 1
},
"sparkProperties": {
"spark.acls.enable": "false"
},
"runtimeVersion": "1.2"
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/environment/examples/UploadCustomLibrary.json
+11
View File
@@ -0,0 +1,11 @@
{
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"environmentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
"libraryName": "samplelibrary.jar"
},
"responses": {
"200": {
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/environment/examples/UploadCustomLibraryPreview.json
+10
View File
@@ -0,0 +1,10 @@
{
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"environmentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
},
"responses": {
"200": {
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/environment/swagger.json
+1039 -66
View File
File diff suppressed because it is too large. Load diff
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/eventstream/definitions/operatorCommon.json
+4 -4
View File
@@ -384,10 +384,10 @@
"type": "object",
"description": "Represents an operation on a column.",
"required": [
"operationType"
"type"
],
"properties": {
"operationType": {
"type": {
"type": "string",
"description": "The operation type.",
"enum": [
@@ -396,7 +396,7 @@
"Rename"
],
"x-ms-enum": {
"name": "operationType",
"name": "type",
"modelAsString": true,
"values": [
{
@@ -419,7 +419,7 @@
"description": "The alias of the operation."
}
},
"discriminator": "operationType"
"discriminator": "type"
},
"ManageFieldsFunctionCallOperation": {
"type": "object",
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/eventstream/definitions/source.json
+5 -5
View File
@@ -975,7 +975,7 @@
},
"filters": {
"type": "object",
"description": "The advanced filters defined in https://learn.microsoft.com/azure/event-grid/event-filtering#advanced-filtering."
"description": "The advanced filters defined in https://learn.microsoft.com/en-us/azure/event-grid/event-filtering#advanced-filtering."
}
}
},
@@ -1017,7 +1017,7 @@
},
"filters": {
"type": "object",
"description": "The advanced filters defined in https://learn.microsoft.com/azure/event-grid/event-filtering#advanced-filtering."
"description": "The advanced filters defined in https://learn.microsoft.com/en-us/azure/event-grid/event-filtering#advanced-filtering."
}
}
},
@@ -1062,7 +1062,7 @@
},
"filters": {
"type": "object",
"description": "The advanced filters defined in https://learn.microsoft.com/azure/event-grid/event-filtering#advanced-filtering."
"description": "The advanced filters defined in https://learn.microsoft.com/en-us/azure/event-grid/event-filtering#advanced-filtering."
}
}
},
@@ -1103,9 +1103,9 @@
},
"filters": {
"type": "object",
"description": "The advanced filters defined in https://learn.microsoft.com/azure/event-grid/event-filtering#advanced-filtering."
"description": "The advanced filters defined in https://learn.microsoft.com/en-us/azure/event-grid/event-filtering#advanced-filtering."
}
}
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/eventstream/examples/GetEventstreamDestination.json
+23 -21
View File
@@ -6,28 +6,30 @@
},
"responses": {
"200": {
"id": "2e4c91e7-0c4a-4cc4-abe3-cc7ba4310a37",
"name": "LakehouseDestination",
"type": "Lakehouse",
"properties": {
"workspaceId": "9625b495-17b3-4d6c-aeea-a81ae76ba369",
"itemId": "ee579458-85ea-4652-bd77-5c7d7c298b2a",
"schema": "dbo",
"deltaTable": "deltaTable",
"inputSerialization": {
"type": "Json",
"properties": {
"encoding": "UTF8"
"body": {
"id": "2e4c91e7-0c4a-4cc4-abe3-cc7ba4310a37",
"name": "LakehouseDestination",
"type": "Lakehouse",
"properties": {
"workspaceId": "9625b495-17b3-4d6c-aeea-a81ae76ba369",
"itemId": "ee579458-85ea-4652-bd77-5c7d7c298b2a",
"schema": "dbo",
"deltaTable": "deltaTable",
"inputSerialization": {
"type": "Json",
"properties": {
"encoding": "UTF8"
}
}
}
},
"inputNodes": [
{
"name": "InputNodeName"
}
],
"status": "Running",
"error": null
},
"inputNodes": [
{
"name": "InputNodeName"
}
],
"status": "Running",
"error": null
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/eventstream/examples/GetEventstreamDestinationConnection.json
+10 -8
View File
@@ -6,14 +6,16 @@
},
"responses": {
"200": {
"fullyQualifiedNamespace": "namespace.servicebus.windows.net",
"eventHubName": "eventhub",
"consumerGroupName": "$Default",
"accessKeys": {
"primaryKey": "key1",
"secondaryKey": "key2",
"primaryConnectionString": "connectionString1",
"secondaryConnectionString": "connectionString2"
"body": {
"fullyQualifiedNamespace": "namespace.servicebus.windows.net",
"eventHubName": "eventhub",
"consumerGroupName": "$Default",
"accessKeys": {
"primaryKey": "key1",
"secondaryKey": "key2",
"primaryConnectionString": "connectionString1",
"secondaryConnectionString": "connectionString2"
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/eventstream/examples/GetEventstreamSource.json
+16 -14
View File
@@ -6,21 +6,23 @@
},
"responses": {
"200": {
"id": "e2886002-d696-4c05-969c-51361365cc24",
"name": "AzureEventHubSource",
"type": "AzureEventHub",
"properties": {
"dataConnectionId": "9c500070-073f-4a88-b478-8fabe1941c52",
"consumerGroupName": "$Default",
"inputSerialization": {
"type": "Json",
"properties": {
"encoding": "UTF8"
"body": {
"id": "e2886002-d696-4c05-969c-51361365cc24",
"name": "AzureEventHubSource",
"type": "AzureEventHub",
"properties": {
"dataConnectionId": "9c500070-073f-4a88-b478-8fabe1941c52",
"consumerGroupName": "$Default",
"inputSerialization": {
"type": "Json",
"properties": {
"encoding": "UTF8"
}
}
}
},
"status": "Running",
"error": null
},
"status": "Running",
"error": null
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/eventstream/examples/GetEventstreamSourceConnection.json
+9 -7
View File
@@ -6,13 +6,15 @@
},
"responses": {
"200": {
"fullyQualifiedNamespace": "namespace.servicebus.windows.net",
"eventHubName": "eventhub",
"accessKeys": {
"primaryKey": "key1",
"secondaryKey": "key2",
"primaryConnectionString": "connectionString1",
"secondaryConnectionString": "connectionString2"
"body": {
"fullyQualifiedNamespace": "namespace.servicebus.windows.net",
"eventHubName": "eventhub",
"accessKeys": {
"primaryKey": "key1",
"secondaryKey": "key2",
"primaryConnectionString": "connectionString1",
"secondaryConnectionString": "connectionString2"
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/eventstream/examples/GetEventstreamTopology.json
+610 -608
View File
File diff suppressed because it is too large. Load diff
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/eventstream/swagger.json
+13 -13
View File
@@ -452,7 +452,7 @@
"/workspaces/{workspaceId}/eventstreams/{eventstreamId}/topology": {
"get": {
"summary": "Returns the topology of the specified eventstream.",
"description": "## Permissions\n\n The caller must have *viewer* or higher workspace role. \n\n## Required Delegated Scopes \n\n Eventstream.Read.All or Eventstream.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 eventstream. \n\n## Required Delegated Scopes \n\n Eventstream.Read.All or Eventstream.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": [
"Topology"
],
@@ -502,7 +502,7 @@
"/workspaces/{workspaceId}/eventstreams/{eventstreamId}/pause": {
"post": {
"summary": "Pause running all supported sources and destinations of the eventstream.",
"description": "## Permissions\n\n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes \n\n Eventstream.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",
"description": "## Permissions\n\n The caller must have *read and write* permissions for the eventstream. \n\n## Required Delegated Scopes \n\n Eventstream.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": [
"Topology"
],
@@ -549,7 +549,7 @@
"/workspaces/{workspaceId}/eventstreams/{eventstreamId}/resume": {
"post": {
"summary": "Resume running all supported sources and destinations of the eventstream.",
"description": "## Permissions\n\n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes \n\n Eventstream.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",
"description": "## Permissions\n\n The caller must have *read and write* permissions for the eventstream. \n\n## Required Delegated Scopes \n\n Eventstream.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": [
"Topology"
],
@@ -605,7 +605,7 @@
"/workspaces/{workspaceId}/eventstreams/{eventstreamId}/sources/{sourceId}": {
"get": {
"summary": "Returns the specified source of the eventstream.",
"description": "## Permissions\n\n The caller must have *viewer* or higher workspace role. \n\n## Required Delegated Scopes \n\n Eventstream.Read.All or Eventstream.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 eventstream. \n\n## Required Delegated Scopes \n\n Eventstream.Read.All or Eventstream.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": [
"Topology"
],
@@ -663,7 +663,7 @@
"/workspaces/{workspaceId}/eventstreams/{eventstreamId}/destinations/{destinationId}": {
"get": {
"summary": "Returns the specified destination of the eventstream.",
"description": "## Permissions\n\n The caller must have *viewer* or higher workspace role. \n\n## Required Delegated Scopes \n\n Eventstream.Read.All or Eventstream.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 eventstream. \n\n## Required Delegated Scopes \n\n Eventstream.Read.All or Eventstream.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": [
"Topology"
],
@@ -720,8 +720,8 @@
},
"/workspaces/{workspaceId}/eventstreams/{eventstreamId}/sources/{sourceId}/connection": {
"get": {
"summary": "Returns the connection information of specified source of the eventstream. Only custom endpoints sources are supported.",
"description": "## Permissions\n\n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes \n\n Eventstream.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",
"summary": "Returns the connection information of specified source of the eventstream.",
"description": "## Permissions\n\n The caller must have *read and write* permissions for the eventstream. \n\n## Required Delegated Scopes \n\n Eventstream.ReadWrite.All or Item.ReadWrite.All\n\n## Limitations\n\n Only custom endpoints sources are supported.\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": [
"Topology"
],
@@ -778,8 +778,8 @@
},
"/workspaces/{workspaceId}/eventstreams/{eventstreamId}/destinations/{destinationId}/connection": {
"get": {
"summary": "Returns the connection information of a specified destination of the eventstream. Only custom endpoints destinations are supported.",
"description": "## Permissions\n\n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes \n\n Eventstream.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",
"summary": "Returns the connection information of a specified destination of the eventstream.",
"description": "## Permissions\n\n The caller must have *read and write* permissions for the eventstream. \n\n## Required Delegated Scopes \n\n Eventstream.ReadWrite.All or Item.ReadWrite.All\n\n## Limitations\n\n Only custom endpoints destinations are supported.\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": [
"Topology"
],
@@ -837,7 +837,7 @@
"/workspaces/{workspaceId}/eventstreams/{eventstreamId}/sources/{sourceId}/pause": {
"post": {
"summary": "Pause running the specified source in the eventstream.",
"description": "## Permissions\n\n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes \n\n Eventstream.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",
"description": "## Permissions\n\n The caller must have *read and write* permissions for the eventstream. \n\n## Required Delegated Scopes \n\n Eventstream.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": [
"Topology"
],
@@ -892,7 +892,7 @@
"/workspaces/{workspaceId}/eventstreams/{eventstreamId}/sources/{sourceId}/resume": {
"post": {
"summary": "Resume running the specified source in the eventstream.",
"description": "## Permissions\n\n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes \n\n Eventstream.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",
"description": "## Permissions\n\n The caller must have *read and write* permissions for the eventstream. \n\n## Required Delegated Scopes \n\n Eventstream.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": [
"Topology"
],
@@ -956,7 +956,7 @@
"/workspaces/{workspaceId}/eventstreams/{eventstreamId}/destinations/{destinationId}/pause": {
"post": {
"summary": "Pause running the specified destination in the eventstream.",
"description": "## Permissions\n\n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes \n\n Eventstream.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",
"description": "## Permissions\n\n The caller must have *read and write* permissions for the eventstream. \n\n## Required Delegated Scopes \n\n Eventstream.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": [
"Topology"
],
@@ -1011,7 +1011,7 @@
"/workspaces/{workspaceId}/eventstreams/{eventstreamId}/destinations/{destinationId}/resume": {
"post": {
"summary": "Resume running the specified destination in the eventstream.",
"description": "## Permissions\n\n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes \n\n Eventstream.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",
"description": "## Permissions\n\n The caller must have *read and write* permissions for the eventstream. \n\n## Required Delegated Scopes \n\n Eventstream.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": [
"Topology"
],
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/graphQLApi/swagger.json
+3 -3
View File
@@ -63,7 +63,7 @@
},
"post": {
"summary": "Creates a API for GraphQL item in the specified workspace.",
"description": "\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nTo create GraphQLApi item with a public definition, refer to [GraphQLApi definition](/rest/api/fabric/articles/item-management/definitions/graphql-api-definition).\n\n ## Permissions \n The caller must have a *contributor* workspace role. \n\n## Required Delegated Scopes\n\n GraphQLApi.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations \n- To create a GraphQLApi 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, except for definition payload with SQL analytics endpoint |\n\n## Interface",
"description": "\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nTo create GraphQLApi item with a public definition, refer to [GraphQLApi definition](/rest/api/fabric/articles/item-management/definitions/graphql-api-definition).\n\n ## Permissions \n The caller must have a *contributor* workspace role. \n\n## Required Delegated Scopes\n\n GraphQLApi.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations \n- To create a GraphQLApi 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"
],
@@ -369,8 +369,8 @@
},
"/workspaces/{workspaceId}/GraphQLApis/{GraphQLApiId}/updateDefinition": {
"post": {
"summary": "Overrides the definition for the specified .",
"description": "\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n \nUpdating the GraphQLApi's definition, does not affect its sensitivity label. \n\n## Permissions\n\n The caller must have *read and write* permissions for the GraphQLApi. \n## Required Delegated Scopes\n\n GraphQLApi.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, except for definition payload with SQL analytics endpoint |\n\n## Interface",
"summary": "Overrides the definition for the specified API for GraphQL.",
"description": "\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n \nUpdating the GraphQLApi's definition, does not affect its sensitivity label. \n\n## Permissions\n\n The caller must have *read and write* permissions for the GraphQLApi. \n## Required Delegated Scopes\n\n GraphQLApi.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"
],
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/lakehouse/definitions.json
+543 -513
View File
File diff suppressed because it is too large. Load diff
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/lakehouse/examples/CreateLakehouseRefreshMaterializedLakeViewsSchedule.json
+40
View File
@@ -0,0 +1,40 @@
{
"parameters": {
"workspaceId": "a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1",
"lakehouseId": "dddddddd-9999-0000-1111-eeeeeeeeeeee",
"jobType": "RefreshMaterializedLakeViews",
"createScheduleRequest": {
"enabled": true,
"configuration": {
"startDateTime": "2025-04-28T00:00:00",
"endDateTime": "2025-04-30T23:59:00",
"localTimeZoneId": "Central Standard Time",
"type": "Cron",
"interval": 10
}
}
},
"responses": {
"201": {
"headers": {
"Location": "https://api.fabric.microsoft.com/v1/workspaces/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/items/dddddddd-9999-0000-1111-eeeeeeeeeeee/jobs/RefreshMaterializedLakeViews/schedules/bbbbbbbb-1111-2222-3333-cccccccccccc"
},
"body": {
"id": "bbbbbbbb-1111-2222-3333-cccccccccccc",
"enabled": true,
"createdDateTime": "2024-05-28T05:35:20.5366667",
"configuration": {
"startDateTime": "2025-04-28T00:00:00",
"endDateTime": "2025-04-30T23:59:00",
"localTimeZoneId": "Central Standard Time",
"type": "Cron",
"interval": 10
},
"owner": {
"id": "33dd33dd-ee44-ff55-aa66-77bb77bb77bb",
"type": "User"
}
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/lakehouse/examples/DeleteLakehouseRefreshMaterializedLakeViewsSchedule.json
+10
View File
@@ -0,0 +1,10 @@
{
"parameters": {
"workspaceId": "a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1",
"lakehouseId": "dddddddd-9999-0000-1111-eeeeeeeeeeee",
"scheduleId": "bbbbbbbb-1111-2222-3333-cccccccccccc"
},
"responses": {
"200": {}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/lakehouse/examples/RunOnDemandRefreshMaterializedLakeViewsNoBody.json
+15
View File
@@ -0,0 +1,15 @@
{
"parameters": {
"workspaceId": "4b218778-e7a5-4d73-8187-f10824047715",
"lakehouseId": "431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
"jobType": "RefreshMaterializedLakeViews"
},
"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/lakehouse/examples/UpdateLakehouseRefreshMaterializedLakeViewsSchedule.json
+37
View File
@@ -0,0 +1,37 @@
{
"parameters": {
"workspaceId": "a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1",
"lakehouseId": "dddddddd-9999-0000-1111-eeeeeeeeeeee",
"scheduleId": "bbbbbbbb-1111-2222-3333-cccccccccccc",
"updateScheduleRequest": {
"enabled": false,
"configuration": {
"startDateTime": "2025-05-01T00:00:00",
"endDateTime": "2025-05-31T23:59:00",
"localTimeZoneId": "Pacific Standard Time",
"type": "Cron",
"interval": 15
}
}
},
"responses": {
"200": {
"body": {
"id": "bbbbbbbb-1111-2222-3333-cccccccccccc",
"enabled": false,
"createdDateTime": "2024-05-28T05:35:20.5366667",
"configuration": {
"startDateTime": "2025-05-01T00:00:00",
"endDateTime": "2025-05-31T23:59:00",
"localTimeZoneId": "Pacific Standard Time",
"type": "Cron",
"interval": 15
},
"owner": {
"id": "33dd33dd-ee44-ff55-aa66-77bb77bb77bb",
"type": "User"
}
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/lakehouse/swagger.json
+360 -108
View File
@@ -296,8 +296,8 @@
},
"/workspaces/{workspaceId}/lakehouses/{lakehouseId}/tables": {
"get": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nReturns a list of lakehouse Tables.",
"description": "This API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Required Delegated Scopes \n\nLakehouse.Read.All or Lakehouse.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 a list of lakehouse Tables.",
"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\nThis API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Required Delegated Scopes \n\nLakehouse.Read.All or Lakehouse.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": [
"Tables"
],
@@ -368,8 +368,8 @@
},
"/workspaces/{workspaceId}/lakehouses/{lakehouseId}/tables/{tableName}/load": {
"post": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nStarts a load table operation and returns the operation status URL in the response location header.",
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\nWrite permission to the lakehouse item. \n\n## Required Delegated Scopes \n\nLakehouse.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": "Starts a load table operation and returns the operation status URL in the response location header.",
"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\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\nWrite permission to the lakehouse item. \n\n## Required Delegated Scopes \n\nLakehouse.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": [
"Tables"
],
@@ -451,8 +451,8 @@
},
"/workspaces/{workspaceId}/lakehouses/{lakehouseId}/jobs/instances?jobType=TableMaintenance": {
"post": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nRun on-demand [table maintenance](/fabric/data-engineering/lakehouse-table-maintenance) job instance.",
"description": "## Required Delegated Scopes \n\nLakehouse.Execute.All or Item.Execute.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"summary": "Run on-demand [table maintenance](/fabric/data-engineering/lakehouse-table-maintenance) job instance.",
"description": "> [!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\n## Required Delegated Scopes \n\nLakehouse.Execute.All or Item.Execute.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"tags": [
"BackgroundJobs"
],
@@ -528,119 +528,371 @@
}
}
},
"/workspaces/{workspaceId}/lakehouses/{lakehouseId}/jobs/RefreshMaterializedLakeViews/schedules": {
"post": {
"summary": "Create a new Refresh MaterializedLakeViews schedule for a lakehouse.",
"description": "> [!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\n## Required Delegated Scopes: \n\n(Lakehouse.Execute.All or Item.Execute.All) and (Lakehouse.ReadWrite.All or Item.ReadWrite.All)\n\n## Limitations \n- A lakehouse can create maximum 20 schedulers.\n- Materialized Lake View supports only one active refresh schedule per lineage.\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_CreateRefreshMaterializedLakeViewsSchedule",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "lakehouseId",
"description": "The lakehouse ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "body",
"name": "createScheduleRequest",
"description": "A lakehouse refresh materialized lake views schedule create request.",
"schema": {
"$ref": "./definitions.json#/definitions/CreateLakehouseRefreshMaterializedLakeViewsScheduleRequest"
},
"required": true
}
],
"responses": {
"201": {
"description": "Successfully create the schedule.",
"headers": {
"Location": {
"description": "The URL of the newly created schedule.",
"type": "string"
}
},
"schema": {
"$ref": "./definitions.json#/definitions/LakehouseRefreshMaterializedLakeViewsSchedule"
}
},
"default": {
"description": "Common error codes:\n\n* InsufficientPrivileges - The caller does not have sufficient permissions to access the item\n\n* ItemNotFound - Requested item id not found\n\n* ScheduleExceedsLimit - The number of created schedules for the item exceeds the limit",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Create lakehouse Refresh MaterializedLakeViews schedule example": {
"$ref": "./examples/CreateLakehouseRefreshMaterializedLakeViewsSchedule.json"
}
}
}
},
"/workspaces/{workspaceId}/lakehouses/{lakehouseId}/livySessions": {
"get": {
"tags": [
"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",
"operationId": "LivySessions_ListLivySessions",
"x-ms-pageable": {
"nextLinkName": "continuationUri"
"tags": [
"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",
"operationId": "LivySessions_ListLivySessions",
"x-ms-pageable": {
"nextLinkName": "continuationUri"
},
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace identifier.",
"required": true,
"type": "string"
},
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace identifier.",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "lakehouseId",
"description": "The lakehouse ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"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"
}
}
{
"in": "path",
"name": "lakehouseId",
"description": "The lakehouse ID.",
"type": "string",
"format": "uuid",
"required": true
},
"x-ms-examples": {
"List all livy sessions example": {
"$ref": "./examples/ListSessionsInItemId.json"
}
{
"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 example": {
"$ref": "./examples/ListSessionsInItemId.json"
}
}
}
},
"/workspaces/{workspaceId}/lakehouses/{lakehouseId}/livySessions/{livyId}": {
"get": {
"tags": [
"LivySessions"
],
"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 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",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace identifier.",
"type": "string",
"required": true
},
{
"in": "path",
"name": "lakehouseId",
"description": "The lakehouse ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "livyId",
"description": "The session identifier.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK -- Returns a livy session by its id.",
"schema": {
"$ref": "../common/spark_definitions.json#/definitions/LivySession"
}
},
"default": {
"description": "Common error codes:\n\n* SparkCoreSessionNotFound - Livy identifier does not exist\n\n* SparkCoreUnexpectedException - Unhandled exception ocurred.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
"tags": [
"LivySessions"
],
"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 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",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace identifier.",
"type": "string",
"required": true
},
"x-ms-examples": {
"Get a livy session example": {
"$ref": "./examples/GetSessionInItemId.json"
}
{
"in": "path",
"name": "lakehouseId",
"description": "The lakehouse ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "livyId",
"description": "The session identifier.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK -- Returns a livy session by its id.",
"schema": {
"$ref": "../common/spark_definitions.json#/definitions/LivySession"
}
},
"default": {
"description": "Common error codes:\n\n* SparkCoreSessionNotFound - Livy identifier does not exist\n\n* SparkCoreUnexpectedException - Unhandled exception ocurred.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get a livy session example": {
"$ref": "./examples/GetSessionInItemId.json"
}
}
}
},
"/workspaces/{workspaceId}/lakehouses/{lakehouseId}/jobs/instances?jobType=RefreshMaterializedLakeViews": {
"post": {
"summary": "Run on-demand [Refresh MaterializedLakeViews](/fabric/data-engineering/materialized-lake-views/refresh-materialized-lake-view) job instance.",
"description": "> [!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\n## Required Delegated Scopes\n\nLakehouse.Execute.All or Item.Execute.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
"tags": [
"BackgroundJobs"
],
"operationId": "BackgroundJobs_RunOnDemandRefreshMaterializedLakeViews",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "lakehouseId",
"description": "The lakehouse ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "query",
"name": "jobType",
"description": "*RefreshMaterializedLakeViews* job type.",
"type": "string",
"required": true
}
],
"responses": {
"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* MissingMinimalPermissions - 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 too 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 RefreshMaterializedLakeViews with no request body.": {
"$ref": "./examples/RunOnDemandRefreshMaterializedLakeViewsNoBody.json"
}
}
}
},
"/workspaces/{workspaceId}/lakehouses/{lakehouseId}/jobs/RefreshMaterializedLakeViews/schedules/{scheduleId}": {
"patch": {
"summary": "Update an existing Refresh MaterializedLakeViews schedule for a lakehouse.",
"description": "> [!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\n## Required Delegated Scopes: \n\n(Lakehouse.Execute.All or Item.Execute.All) and (Lakehouse.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) | No |\n\n## Interface",
"tags": [
"BackgroundJobs"
],
"operationId": "BackgroundJobs_UpdateRefreshMaterializedLakeViewsSchedule",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "lakehouseId",
"description": "The lakehouse ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "scheduleId",
"description": "The lakehouse schedule ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "body",
"name": "updateScheduleRequest",
"description": "A lakehouse refresh materialized lake views schedule update request.",
"schema": {
"$ref": "./definitions.json#/definitions/UpdateLakehouseRefreshMaterializedLakeViewsScheduleRequest"
},
"required": true
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions.json#/definitions/LakehouseRefreshMaterializedLakeViewsSchedule"
}
},
"default": {
"description": "Common error codes:\n\n* InsufficientPrivileges - The caller does not have sufficient permissions to access the item\n\n* ItemNotFound - Requested item id not found",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Update lakehouse Refresh MaterializedLakeViews schedule example": {
"$ref": "./examples/UpdateLakehouseRefreshMaterializedLakeViewsSchedule.json"
}
}
},
"delete": {
"summary": "Delete an existing Refresh MaterializedLakeViews schedule for a lakehouse.",
"description": "> [!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\n## Required Delegated Scopes\n\nLakehouse.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) | No |\n\n## Interface",
"tags": [
"BackgroundJobs"
],
"operationId": "BackgroundJobs_DeleteRefreshMaterializedLakeViewsSchedule",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "lakehouseId",
"description": "The lakehouse ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "scheduleId",
"description": "The lakehouse schedule ID.",
"type": "string",
"format": "uuid",
"required": true
}
],
"responses": {
"200": {
"description": "Request completed successfully."
},
"default": {
"description": "Common error codes:\n\n* InsufficientPrivileges - The caller does not have sufficient permissions to access the item\n\n* ItemNotFound - Requested item ID not found",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete lakehouse Refresh MaterializedLakeViews schedule example": {
"$ref": "./examples/DeleteLakehouseRefreshMaterializedLakeViewsSchedule.json"
}
}
}
}
},
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/map/definitions.json
+141
View File
@@ -0,0 +1,141 @@
{
"swagger": "2.0",
"info": {
"title": "Map data types",
"version": "v1"
},
"paths": {},
"definitions": {
"Map": {
"description": "A Map object.",
"type": "object",
"required": ["type"],
"allOf": [
{
"$ref": "../common/definitions.json#/definitions/Item"
}
]
},
"Maps": {
"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/Map"
}
}
},
"allOf": [
{
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
}
]
},
"CreateMapRequest": {
"description": "Create Map request payload.",
"required": ["displayName"],
"properties": {
"displayName": {
"description": "The Map display name. The display name must follow naming rules according to item type.",
"type": "string",
"readOnly": false
},
"description": {
"description": "The Map description. Maximum length is 256 characters.",
"type": "string",
"readOnly": false
},
"folderId": {
"description": "The folder ID. If not specified or null, the Map is created with the workspace as its folder.",
"type": "string",
"format": "uuid",
"readOnly": false
},
"definition": {
"description": "The Map public definition.",
"$ref": "#/definitions/MapPublicDefinition",
"readOnly": false
}
}
},
"UpdateMapDefinitionRequest": {
"description": "Update Map public definition request payload.",
"required": ["definition"],
"properties": {
"definition": {
"$ref": "#/definitions/MapPublicDefinition"
}
}
},
"MapDefinitionResponse": {
"description": "Map public definition response.",
"required": ["definition"],
"properties": {
"definition": {
"$ref": "#/definitions/MapPublicDefinition",
"readOnly": true
}
}
},
"MapPublicDefinition" : {
"description": "Map public definition object. Refer to this [article](/rest/api/fabric/articles/item-management/definitions/map) for more details on how to craft a Map 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",
"readOnly": false
},
"parts": {
"description": "A list of definition parts.",
"type": "array",
"items": {
"$ref": "#/definitions/MapPublicDefinitionPart"
},
"readOnly": false
}
}
},
"MapPublicDefinitionPart": {
"description": "Map definition part object.",
"type": "object",
"properties": {
"path": {
"description": "The Map public definition part path.",
"type": "string",
"readOnly": false
},
"payload": {
"description": "The Map public definition part payload.",
"type": "string",
"readOnly": false
},
"payloadType":{
"description": "The payload type.",
"$ref": "../common/definitions.json#/definitions/PayloadType",
"readOnly": false
}
}
},
"UpdateMapRequest": {
"description": "Update Map request.",
"properties": {
"displayName": {
"description": "The Map display name. The display name must follow naming rules according to item type.",
"type": "string",
"readOnly": false
},
"description": {
"description": "The Map description. Maximum length is 256 characters.",
"type": "string",
"readOnly": false
}
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/map/examples/CreateMap.json
+41
View File
@@ -0,0 +1,41 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"createMapRequest": {
"displayName": "Map 1",
"description": "A Map description.",
"definition": {
"parts": [
{
"path": "map.json",
"payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
"payloadType": "InlineBase64"
},
{
"path": ".platform",
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
"payloadType": "InlineBase64"
}
]
}
}
},
"responses": {
"201": {
"body": {
"displayName": "Map 1",
"description": "A Map description.",
"type": "Map",
"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/map/examples/CreateMapWithoutDefinition.json
+27
View File
@@ -0,0 +1,27 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"createMapRequest": {
"displayName": "Map 1",
"description": "A Map description."
}
},
"responses": {
"201": {
"body": {
"displayName": "Map 1",
"description": "A Map description.",
"type": "Map",
"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/map/examples/DeleteMap.json
+9
View File
@@ -0,0 +1,9 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"MapId": "5b218778-e7a5-4d73-8187-f10824047715"
},
"responses": {
"200": {}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/map/examples/GetMap.json
+17
View File
@@ -0,0 +1,17 @@
{
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"MapId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
},
"responses": {
"200": {
"body": {
"id": "5b218778-e7a5-4d73-8187-f10824047715",
"displayName": "Map 1",
"description": "A Map description.",
"type": "Map",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/map/examples/GetMapDefinition.json
+33
View File
@@ -0,0 +1,33 @@
{
"parameters": {
"workspaceId": "6e335e92-a2a2-4b5a-970a-bd6a89fbb765",
"MapId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
},
"responses": {
"200": {
"body": {
"definition": {
"parts": [
{
"path": "map.json",
"payload": "ew0KICAiZXhlY3V0YW..OWRmNDhhY2ZmZTgifQ",
"payloadType": "InlineBase64"
},
{
"path": ".platform",
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
"payloadType": "InlineBase64"
}
]
}
}
},
"202": {
"headers": {
"Location": "https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
"x-ms-operation-id": "431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
"Retry-After": 30
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/map/examples/ListMapsInWorkspace.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": "Map Name 1",
"description": "A Map description.",
"type": "Map",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
},
{
"id": "f697fb63-abd4-4399-9548-be7e3c3c0dac",
"displayName": "Map Name 2",
"description": "A Map description.",
"type": "Map",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
}
]
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/map/examples/UpdateMap.json
+21
View File
@@ -0,0 +1,21 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"MapId": "5b218778-e7a5-4d73-8187-f10824047715",
"updateMapRequest": {
"displayName": "Map's New name",
"description": "Map's New description"
}
},
"responses": {
"200": {
"body": {
"displayName": "Map's New name",
"description": "Map's New description",
"type": "Map",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"id": "5b218778-e7a5-4d73-8187-f10824047715"
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/map/examples/UpdateMapDefinition.json
+34
View File
@@ -0,0 +1,34 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"MapId": "5b218778-e7a5-4d73-8187-f10824047715",
"updateMetadata" : true,
"updateMapDefinitionRequest": {
"definition": {
"parts": [
{
"path": "map.json",
"payload": "ew0KICAiZXhlY3V0YW..OWRmNDhhY2ZmZTgifQ==",
"payloadType": "InlineBase64"
},
{
"path": ".platform",
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
"payloadType": "InlineBase64"
}
]
}
}
},
"responses": {
"200": {
},
"202": {
"headers": {
"Location": "https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef",
"x-ms-operation-id": "427f6c34-b64e-4ee4-8ea5-b533c0e203ef",
"Retry-After": 30
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/map/swagger.json
+456
View File
@@ -0,0 +1,456 @@
{
"swagger": "2.0",
"info": {
"title": "Map REST APIs",
"version": "v1"
},
"schemes": [
"https"
],
"host": "api.fabric.microsoft.com",
"basePath": "/v1",
"paths": {
"/workspaces/{workspaceId}/Maps": {
"get": {
"summary": "Returns a list of Maps from the specified workspace.",
"description": "> [!NOTE]\n> Map item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\n The caller must have a *viewer* workspace role. \n\n## Required Delegated Scopes\n\nWorkspace.Read.All or Workspace.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"tags": [
"Items"
],
"operationId": "Items_ListMaps",
"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/Maps"
}
},
"default": {
"description": "Common error codes:\n\n* InvalidItemType - Invalid item type.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Maps in workspace example": {
"$ref": "./examples/ListMapsInWorkspace.json"
}
}
},
"post": {
"summary": "Creates a Map in the specified workspace.",
"description": "> [!NOTE]\n> Map 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 Map with a public definition, refer to [Map](/rest/api/fabric/articles/item-management/definitions/map-definition) article. \n\n ## Permissions \n The caller must have a *contributor* workspace role. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All \n\n## Limitations \n- To create a Map 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_CreateMap",
"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": "createMapRequest",
"description": "Create item request payload.",
"schema": {
"$ref": "./definitions.json#/definitions/CreateMapRequest"
},
"required": true
}
],
"responses": {
"201": {
"description": "Successfully created",
"schema": {
"$ref": "./definitions.json#/definitions/Map"
}
},
"202": {
"description": "Request accepted, Map 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 Map example": {
"$ref": "./examples/CreateMapWithoutDefinition.json"
},
"Create a Map with public definition example": {
"$ref": "./examples/CreateMap.json"
}
}
}
},
"/workspaces/{workspaceId}/Maps/{MapId}": {
"get": {
"summary": "Returns properties of the specified Map.",
"description": "> [!NOTE]\n> Map item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\n## Permissions\n\n The caller must have *read* permissions for the Map. \n\n## Required Delegated Scopes\n\n Item.Read.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"tags": [
"Items"
],
"operationId": "Items_GetMap",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "MapId",
"description": "The Map ID.",
"type": "string",
"format": "uuid",
"required": true
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions.json#/definitions/Map"
}
},
"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 Map example": {
"$ref": "./examples/GetMap.json"
}
}
},
"patch": {
"summary": "Updates the properties of the specified Map.",
"description": "> [!NOTE]\n> Map 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 Map.\n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"tags": [
"Items"
],
"operationId": "Items_UpdateMap",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "MapId",
"description": "The Map ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "body",
"name": "updateMapRequest",
"description": "Update Map request payload.",
"schema": {
"$ref": "./definitions.json#/definitions/UpdateMapRequest"
},
"required": true
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions.json#/definitions/Map"
}
},
"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 Map example": {
"$ref": "./examples/UpdateMap.json"
}
}
},
"delete": {
"summary": "Deletes the specified Map.",
"description": "> [!NOTE]\n> Map item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\n## Permissions\n\n The caller must have *write* permissions for the Map. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"tags": [
"Items"
],
"operationId": "Items_DeleteMap",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "MapId",
"description": "The Map 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 Map example": {
"$ref": "./examples/DeleteMap.json"
}
}
}
},
"/workspaces/{workspaceId}/Maps/{MapId}/getDefinition": {
"post": {
"summary": "Returns the specified Map public definition.",
"description": "> [!NOTE]\n> Map 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 Map'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 Map. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"tags": [
"Items"
],
"operationId": "Items_GetMapDefinition",
"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": "MapId",
"description": "The Map ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "query",
"name": "format",
"description": "The format of the Map public definition. Additional `format` types may be added over time.",
"type": "string",
"required": false
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions.json#/definitions/MapDefinitionResponse"
}
},
"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 Map public definition example": {
"$ref": "./examples/GetMapDefinition.json"
}
}
}
},
"/workspaces/{workspaceId}/Maps/{MapId}/updateDefinition": {
"post": {
"summary": "Overrides the definition for the specified Map.",
"description": "> [!NOTE]\n> Map 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 Map's definition, does not affect its sensitivity label. \n\n## Permissions\n\n The caller must have *read and write* permissions for the Map. \n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"tags": [
"Items"
],
"operationId": "Items_UpdateMapDefinition",
"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": "MapId",
"description": "The Map 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": "updateMapDefinitionRequest",
"description": "Update Map definition request payload.",
"schema": {
"$ref": "./definitions.json#/definitions/UpdateMapDefinitionRequest"
},
"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 Map public definition example": {
"$ref": "./examples/UpdateMapDefinition.json"
}
}
}
}
},
"responses": {},
"security": [],
"tags": []
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/mirroredAzureDatabricksCatalog/swagger.json
+23 -23
View File
@@ -12,8 +12,8 @@
"paths": {
"/workspaces/{workspaceId}/mirroredAzureDatabricksCatalogs": {
"get": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nReturns a list of mirroredAzureDatabricksCatalogs 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) | No |\n\n## Interface",
"summary": "Returns a list of mirroredAzureDatabricksCatalogs from the specified workspace.",
"description": "> [!NOTE]\n> Mirrored Azure Databricks Catalog item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\n The caller must have a *viewer* workspace role. \n\n## Required Delegated Scopes \n\nWorkspace.Read.All or Workspace.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"tags": [
"Items"
],
@@ -62,8 +62,8 @@
}
},
"post": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nCreates a mirroredAzureDatabricksCatalog in the specified workspace.",
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\n The caller must have a *contributor* workspace role. \n\n## Required Delegated Scopes \n\n MirroredAzureDatabricksCatalog.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) | No |\n\n## Interface",
"summary": "Creates a mirroredAzureDatabricksCatalog in the specified workspace.",
"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 a *contributor* workspace role. \n\n## Required Delegated Scopes \n\n MirroredAzureDatabricksCatalog.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"
],
@@ -138,8 +138,8 @@
},
"/workspaces/{workspaceId}/mirroredAzureDatabricksCatalogs/{mirroredAzureDatabricksCatalogId}": {
"get": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nReturns properties of the specified mirroredAzureDatabricksCatalog.",
"description": "## Permissions\n\n The caller must have *read* permissions for the mirrored azure databricks catalog. \n\n## Required Delegated Scopes \n\n MirroredAzureDatabricksCatalog.Read.All or MirroredAzureDatabricksCatalog.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) | No |\n\n## Interface",
"summary": "Returns 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* permissions for the mirrored azure databricks catalog. \n\n## Required Delegated Scopes \n\n MirroredAzureDatabricksCatalog.Read.All or MirroredAzureDatabricksCatalog.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"
],
@@ -186,8 +186,8 @@
}
},
"patch": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nUpdates the properties of the specified mirroredAzureDatabricksCatalog.",
"description": "## 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## 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",
"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",
"tags": [
"Items"
],
@@ -249,8 +249,8 @@
}
},
"delete": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nDeletes the specified mirroredAzureDatabricksCatalog.",
"description": "## Permissions\n\n The caller must have *write* permissions for the mirrored azure databricks catalog. \n\n## Required Delegated Scopes \n\n MirroredAzureDatabricksCatalog.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) | No |\n\n## Interface",
"summary": "Deletes 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 *write* permissions for the mirrored azure databricks catalog. \n\n## Required Delegated Scopes \n\n MirroredAzureDatabricksCatalog.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"
],
@@ -296,8 +296,8 @@
},
"/workspaces/{workspaceId}/mirroredAzureDatabricksCatalogs/{mirroredAzureDatabricksCatalogId}/getDefinition": {
"post": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nReturns the specified mirroredAzureDatabricksCatalog public definition.",
"description": "This 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\n## Required Delegated Scopes \n\n MirroredAzureDatabricksCatalog.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) | No |\n\n## Interface",
"summary": "Returns the specified mirroredAzureDatabricksCatalog public definition.",
"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\n## Required Delegated Scopes \n\n MirroredAzureDatabricksCatalog.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"
],
@@ -365,8 +365,8 @@
},
"/workspaces/{workspaceId}/mirroredAzureDatabricksCatalogs/{mirroredAzureDatabricksCatalogId}/updateDefinition": {
"post": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nOverrides the definition for the specified mirroredAzureDatabricksCatalog.",
"description": "This 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## 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",
"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",
"tags": [
"Items"
],
@@ -440,8 +440,8 @@
},
"/workspaces/{workspaceId}/mirroredAzureDatabricksCatalogs/{mirroredAzureDatabricksCatalogId}/refreshCatalogMetadata": {
"post": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nRefresh Databricks catalog metadata in mirroredAzureDatabricksCatalogs Item.",
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\n The API caller must have *contributor* or higher workspace role. \n## Required Delegated Scopes \n\n MirroredAzureDatabricksCatalog.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) | No |\n\n## Interface",
"summary": "Refresh Databricks catalog metadata in mirroredAzureDatabricksCatalogs Item.",
"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 API caller must have *contributor* or higher workspace role. \n## Required Delegated Scopes \n\n MirroredAzureDatabricksCatalog.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": [
"Refresh"
],
@@ -506,8 +506,8 @@
},
"/workspaces/{workspaceId}/azuredatabricks/catalogs": {
"get": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nReturns a list of catalogs from Unity Catalog.",
"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\nWorkspace.Read.All or Workspace.ReadWrite.All or DatabricksCatalog.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) | No |\n\n## Interface",
"summary": "Returns a list of catalogs from Unity Catalog.",
"description": "> [!NOTE]\n> Mirrored Azure Databricks Catalog 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 *viewer* or higher workspace role. \n\n## Required Delegated Scopes \n\nWorkspace.Read.All or Workspace.ReadWrite.All or DatabricksCatalog.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",
"tags": [
"Discovery"
],
@@ -573,8 +573,8 @@
},
"/workspaces/{workspaceId}/azuredatabricks/catalogs/{catalogName}/schemas": {
"get": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nReturns a list of schemas in the given catalog from Unity Catalog.",
"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\nWorkspace.Read.All or Workspace.ReadWrite.All or DatabricksCatalog.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) | No |\n\n## Interface",
"summary": "Returns a list of schemas in the given catalog from Unity Catalog.",
"description": "> [!NOTE]\n> Mirrored Azure Databricks Catalog 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 *viewer* or higher workspace role. \n\n## Required Delegated Scopes \n\nWorkspace.Read.All or Workspace.ReadWrite.All or DatabricksCatalog.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",
"tags": [
"Discovery"
],
@@ -647,8 +647,8 @@
},
"/workspaces/{workspaceId}/azuredatabricks/catalogs/{catalogName}/schemas/{schemaName}/tables": {
"get": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nReturns a list of tables in the given schema from Unity Catalog.",
"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\nWorkspace.Read.All or Workspace.ReadWrite.All or DatabricksCatalog.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) | No |\n\n## Interface",
"summary": "Returns a list of tables in the given schema from Unity Catalog.",
"description": "> [!NOTE]\n> Mirrored Azure Databricks Catalog 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 *viewer* or higher workspace role. \n\n## Required Delegated Scopes \n\nWorkspace.Read.All or Workspace.ReadWrite.All or DatabricksCatalog.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",
"tags": [
"Discovery"
],
@@ -730,4 +730,4 @@
"responses": {},
"security": [],
"tags": []
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/mirroredDatabase/definitions.json
+5
View File
@@ -358,6 +358,11 @@
"format": "date-time",
"type": "string",
"description": "Last processed time of the table in in UTC, using the YYYY-MM-DDTHH:mm:ssZ format."
},
"lastSyncLatencyInSeconds": {
"format": "int32",
"type": "integer",
"description": "Latency in seconds between source commit time and target commit time of last processed change. For sources whose source commit time is not available, this value is not returned."
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/mirroredDatabase/examples/GetTablesMirroringStatus.json
+2 -1
View File
@@ -15,7 +15,8 @@
"metrics": {
"processedBytes": 1247,
"processedRows": 6,
"lastSyncDateTime": "2024-10-08T05:07:11.0663362Z"
"lastSyncDateTime": "2024-10-08T05:07:11.0663362Z",
"lastSyncLatencyInSeconds": 15
}
}
]
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/mirroredDatabase/swagger.json
+4 -4
View File
@@ -417,7 +417,7 @@
"/workspaces/{workspaceId}/mirroredDatabases/{mirroredDatabaseId}/startMirroring": {
"post": {
"summary": "Starts the mirroring.",
"description": "## Permissions\n\n The API caller must have *contributor* or higher workspace role. \n## Required Delegated Scopes \n\n MirroredDatabase.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",
"description": "## Permissions\n\n The caller must have *read and write* permissions for the mirrored database. \n## Required Delegated Scopes \n\n MirroredDatabase.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": [
"Mirroring"
],
@@ -465,7 +465,7 @@
"/workspaces/{workspaceId}/mirroredDatabases/{mirroredDatabaseId}/stopMirroring": {
"post": {
"summary": "Stops the mirroring.",
"description": "## Permissions\n\n The API caller must have *contributor* or higher workspace role. \n## Required Delegated Scopes \n\n MirroredDatabase.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",
"description": "## Permissions\n\n The caller must have *read and write* permissions for the mirrored database. \n## Required Delegated Scopes \n\n MirroredDatabase.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": [
"Mirroring"
],
@@ -513,7 +513,7 @@
"/workspaces/{workspaceId}/mirroredDatabases/{mirroredDatabaseId}/getMirroringStatus": {
"post": {
"summary": "Get the status of the mirrored database.",
"description": "## Permissions\n\n The caller must have *viewer* or higher workspace role. \n\n## Required Delegated Scopes \n\n MirroredDatabase.Read.All or MirroredDatabase.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 mirrored database. \n\n## Required Delegated Scopes \n\n MirroredDatabase.Read.All or MirroredDatabase.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": [
"Mirroring"
],
@@ -564,7 +564,7 @@
"/workspaces/{workspaceId}/mirroredDatabases/{mirroredDatabaseId}/getTablesMirroringStatus": {
"post": {
"summary": "Get the mirroring status of the tables.",
"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 MirroredDatabase.Read.All or MirroredDatabase.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 mirrored database. \n\n## Required Delegated Scopes \n\n MirroredDatabase.Read.All or MirroredDatabase.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": [
"Mirroring"
],
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/mlModel/definitions.json
+437 -118
View File
@@ -1,131 +1,450 @@
{
"swagger": "2.0",
"info": {
"version": "v1",
"title": "MLModel data types"
"version": "v1",
"title": "MLModel data types"
},
"paths": {},
"definitions": {
"MLModels": {
"description": "A list of machine learning models.",
"MLModels": {
"description": "A list of machine learning models.",
"required": ["value"],
"type": "object",
"properties": {
"value": {
"description": "A list of machine learning models.",
"type": "array",
"items": {
"$ref": "#/definitions/MLModel"
}
}
},
"allOf": [
{
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
}
]
"type": "object",
"properties": {
"value": {
"description": "A list of machine learning models.",
"type": "array",
"items": {
"$ref": "#/definitions/MLModel"
}
}
},
"MLModel": {
"description": "A machine learning model object.",
"type": "object",
"allOf": [
{
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
}
]
},
"MLModel": {
"description": "A machine learning model object.",
"type": "object",
"required": ["type"],
"allOf": [
{
"$ref": "../common/definitions.json#/definitions/Item"
}
]
},
"CreateMLModelRequest": {
"description": "Create machine learning model request payload.",
"allOf": [
{
"$ref": "../common/definitions.json#/definitions/Item"
}
]
},
"CreateMLModelRequest": {
"description": "Create machine learning model request payload.",
"required": ["displayName"],
"properties": {
"displayName": {
"description": "The machine learning model display name. The display name must follow naming rules according to item type.",
"type": "string",
"readOnly": false
},
"description": {
"description": "The machine learning model description. Maximum length is 256 characters.",
"type": "string",
"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
}
}
},
"UpdateMLModelDefinitionRequest": {
"description": "Update machine learning model public definition request payload.",
"required": ["definition"],
"properties": {
"definition": {
"$ref": "#/definitions/MLModelDefinition"
}
}
},
"MLModelDefinitionResponse": {
"description": "Machine learning model public definition response.",
"required": ["definition"],
"properties": {
"definition": {
"$ref": "#/definitions/MLModelDefinition",
"readOnly": true
}
}
},
"MLModelDefinition" : {
"description": "Machine learning model public definition object.",
"type": "object",
"required": ["parts"],
"properties": {
"format": {
"description": "The format of the item definition.",
"type": "string",
"readOnly": false
},
"parts": {
"description": "A list of definition parts.",
"type": "array",
"items": {
"$ref": "#/definitions/MLModelDefinitionPart"
},
"readOnly": false
}
}
},
"MLModelDefinitionPart": {
"description": "Machine learning model definition part object.",
"type": "object",
"properties": {
"path": {
"description": "The machine learning model part path.",
"type": "string",
"readOnly": false
},
"payload": {
"description": "The machine learning model part payload.",
"type": "string",
"readOnly": false
},
"payloadType":{
"description": "The payload type.",
"$ref": "../common/definitions.json#/definitions/PayloadType",
"readOnly": false
}
}
},
"UpdateMLModelRequest": {
"description": "Update machine learning model request.",
"properties": {
"description": {
"description": "The machine learning model description. Maximum length is 256 characters.",
"type": "string",
"readOnly": false
}
}
"properties": {
"displayName": {
"description": "The machine learning model display name. The display name must follow naming rules according to item type.",
"type": "string",
"readOnly": false
},
"description": {
"description": "The machine learning model description. Maximum length is 256 characters.",
"type": "string",
"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
}
}
},
"UpdateMLModelDefinitionRequest": {
"description": "Update machine learning model public definition request payload.",
"required": ["definition"],
"properties": {
"definition": {
"$ref": "#/definitions/MLModelDefinition"
}
}
},
"MLModelDefinitionResponse": {
"description": "Machine learning model public definition response.",
"required": ["definition"],
"properties": {
"definition": {
"$ref": "#/definitions/MLModelDefinition",
"readOnly": true
}
}
},
"MLModelDefinition" : {
"description": "Machine learning model public definition object.",
"type": "object",
"required": ["parts"],
"properties": {
"format": {
"description": "The format of the item definition.",
"type": "string",
"readOnly": false
},
"parts": {
"description": "A list of definition parts.",
"type": "array",
"items": {
"$ref": "#/definitions/MLModelDefinitionPart"
},
"readOnly": false
}
}
},
"MLModelDefinitionPart": {
"description": "Machine learning model definition part object.",
"type": "object",
"properties": {
"path": {
"description": "The machine learning model part path.",
"type": "string",
"readOnly": false
},
"payload": {
"description": "The machine learning model part payload.",
"type": "string",
"readOnly": false
},
"payloadType":{
"description": "The payload type.",
"$ref": "../common/definitions.json#/definitions/PayloadType",
"readOnly": false
}
}
},
"UpdateMLModelRequest": {
"description": "Update machine learning model request.",
"properties": {
"description": {
"description": "The machine learning model description. Maximum length is 256 characters.",
"type": "string",
"readOnly": false
}
}
},
"MLModelEndpoint": {
"description": "A machine learning model endpoint object.",
"required": [
"defaultVersionAssignmentBehavior",
"defaultVersionName",
"defaultVersionInfo"
],
"type": "object",
"properties": {
"defaultVersionAssignmentBehavior": {
"$ref": "#/definitions/EndpointDefaultVersionConfigurationPolicy"
},
"defaultVersionName": {
"type": "string",
"description": "Default machine learning model endpoint version name."
},
"defaultVersionInfo": {
"$ref": "#/definitions/MLModelEndpointVersionInfo"
}
}
},
"EndpointDefaultVersionConfigurationPolicy": {
"type": "string",
"description": "The default version assignment behavior of a given machine learning model endpoint. Additional EndpointDefaultVersionConfigurationPolicy types may be added over time.",
"enum": [
"StaticallyConfigured",
"NotConfigured"
],
"x-ms-enum": {
"name": "EndpointDefaultVersionConfigurationPolicy",
"modelAsString": true,
"values": [
{
"value": "StaticallyConfigured",
"description": "The default version is statically configured."
},
{
"value": "NotConfigured",
"description": "No default version has been configured."
}
]
}
},
"MLModelEndpointVersions": {
"description": "All MLModel Versions Endpoints info.",
"required": [
"value"
],
"type": "object",
"properties": {
"value": {
"type": "array",
"description": "The information about all versions available as endpoint for this MLModel.",
"items": {
"$ref": "#/definitions/MLModelEndpointVersionInfo"
}
}
},
"allOf": [
{
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
}
]
},
"MLModelEndpointVersionInfo": {
"description": "Machine Learning Model Endpoint version information.",
"required": [
"versionName",
"status"
],
"type": "object",
"properties": {
"versionName": {
"type": "string",
"description": "The machine learning model version name",
"readOnly": true
},
"status": {
"$ref": "#/definitions/MLModelEndpointVersionStatus",
"readOnly": true
},
"inputSignature": {
"type": "array",
"description": "The input signature for this version of the machine learning model.",
"readOnly": true,
"items": {
"$ref": "#/definitions/MLModelDataSchema"
}
},
"outputSignature": {
"type": "array",
"description": "The output signature for this version of the machine learning model.",
"readOnly": true,
"items": {
"$ref": "#/definitions/MLModelDataSchema"
}
},
"scaleRule": {
"$ref": "#/definitions/ScaleRule"
}
}
},
"MLModelDataSchema": {
"description": "Machine learning model data schema.",
"required": [
"type",
"name",
"required"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The type of the signature."
},
"name": {
"type": "string",
"description": "The name of the signature."
},
"required": {
"type": "boolean",
"description": "The boolean value to indicate if the signature is required or no. True - Required, False - Not Required."
}
}
},
"MLModelEndpointVersionStatus": {
"type": "string",
"description": "The status of a given machine learning model endpoint version. Additional ModelEndpointVersionStatus types may be added over time.",
"enum": [
"Deactivated",
"Activating",
"Deactivating",
"Active",
"Failed"
],
"x-ms-enum": {
"name": "ModelEndpointVersionStatus",
"modelAsString": true,
"values": [
{
"value": "Deactivated",
"description": "All resources are deactivated."
},
{
"value": "Activating",
"description": "Machine learning model endpoint activation is under progress."
},
{
"value": "Deactivating",
"description": "Machine learning model endpoint deactivation is in progress."
},
{
"value": "Active",
"description": "Machine learning model endpoint is available to serve score requests."
},
{
"value": "Failed",
"description": "Machine learning model endpoint is in failed state."
}
]
}
},
"ScoreDataRequest": {
"description": "Machine learning model endpoint request to score the given input data.",
"type": "object",
"required": [
"inputs"
],
"properties": {
"formatType": {
"$ref": "#/definitions/FormatType"
},
"orientation": {
"$ref": "#/definitions/Orientation"
},
"inputs": {
"type": "array",
"description": "Machine learning inputs to score in the form of Pandas dataset arrays that can include strings, numbers, integers and booleans.",
"items": {
"type": "array",
"description": "Machine learning inputs to score in the form of Pandas dataset arrays that can include strings, numbers, integers and booleans.",
"items": {
"type": "object",
"description": "Machine learning inputs to score in the form of Pandas dataset arrays that can include strings, numbers, integers and booleans."
}
},
"readOnly": false
}
}
},
"ScoreDataResponse": {
"description": "Machine learning model endpoint response to score the given input data.",
"type": "object",
"required": [
"formatType",
"orientation",
"predictions"
],
"properties": {
"formatType": {
"$ref": "#/definitions/FormatType"
},
"orientation": {
"$ref": "#/definitions/Orientation"
},
"predictions": {
"type": "array",
"description": "Machine learning predictions represented in the form of Pandas dataset arrays that can include strings, numbers, integers and booleans.",
"items": {
"type": "array",
"description": "Machine learning predictions represented in the form of Pandas dataset arrays that can include strings, numbers, integers and booleans.",
"items": {
"type": "object",
"description": "Machine learning predictions represented in the form of Pandas dataset arrays that can include strings, numbers, integers and booleans."
}
},
"readOnly": true
}
}
},
"UpdateMLModelEndpointRequest": {
"description": "Machine learning model endpoint request body to update Model Endpoint properties.",
"type": "object",
"properties": {
"defaultVersionName": {
"description": "Default machine learning model endpoint version name.",
"type": "string",
"readOnly": false
},
"defaultVersionAssignmentBehavior": {
"$ref": "#/definitions/EndpointDefaultVersionConfigurationPolicy"
}
}
},
"UpdateMLModelEndpointVersionRequest": {
"description": "Machine learning model endpoint version configuration info.",
"type": "object",
"properties": {
"scaleRule": {
"$ref": "#/definitions/ScaleRule"
}
}
},
"ScaleRule": {
"description": "Machine learning model endpoint scale rule. Additional ScaleRule types may be added over time.",
"type": "string",
"enum": [
"AlwaysOn",
"AllowScaleToZero"
],
"x-ms-enum": {
"name": "ScaleRule",
"modelAsString": true,
"values": [
{
"value": "AlwaysOn",
"description": "Machine learning model endpoint should be AlwaysOn."
},
{
"value": "AllowScaleToZero",
"description": "Machine learning model endpoint can be scaled to zero after a period of inactivity."
}
]
}
},
"FormatType": {
"type": "string",
"description": "Format type of data. Additional Format types may be added over time.",
"enum": [
"dataframe"
],
"x-ms-enum": {
"name": "FormatType",
"modelAsString": true,
"values": [
{
"value": "dataframe",
"description": "Dataframe format type."
}
]
}
},
"Orientation": {
"type": "string",
"description": "Orientation of data. Additional Orientation types may be added over time.",
"enum": [
"split",
"values",
"record",
"index",
"table"
],
"x-ms-enum": {
"name": "Orientation",
"modelAsString": true,
"values": [
{
"value": "split",
"description": "Split orientation."
},
{
"value": "values",
"description": "Values orientation."
},
{
"value": "record",
"description": "Record orientation."
},
{
"value": "index",
"description": "Index orientation."
},
{
"value": "table",
"description": "Table orientation."
}
]
}
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/mlModel/examples/ActivateMLModelEndpointVersion.json
+19
View File
@@ -0,0 +1,19 @@
{
"parameters": {
"workspaceId": "cf5fef71-f7f3-43f3-ae7f-3c427922bef1",
"modelId": "7e92a6fc-3ef5-40bf-96df-ddae3fcde313",
"name": "1"
},
"responses": {
"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
}
},
"200": {
"description": "Provisioning completed successfully."
}
}
}
tools/Fabric.Mcp.Tools.PublicApi/src/Resources/fabric-rest-api-specs/contents/mlModel/examples/DeactivateMLModelEndpoint.json
+18
View File
@@ -0,0 +1,18 @@
{
"parameters": {
"workspaceId": "cf5fef71-f7f3-43f3-ae7f-3c427922bef1",
"modelId": "7e92a6fc-3ef5-40bf-96df-ddae3fcde313"
},
"responses": {
"200": {
"description": "Deactivation completed successfully."
},
"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/mlModel/examples/DeactivateMLModelEndpointVersion.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": {
"description": "Deactivation completed successfully."
},
"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
}
}
}
}
Loaded 100 of 228 files, more files were not shown because too many files have changed in this diff. Show more