mirror of
https://github.com/microsoft/fabric-rest-api-specs.git
synced 2026-11-04 12:04:23 +00:00
Updating swagger files.
This commit is contained in:
Fabric-APIs-Publish-Specification-Pipeline committed
1 parent
2946344ff3
commit
2ae6f1938c
223 files changed
+15790
-2427
No files matched your search
@@ -141,6 +141,12 @@
|
||||
"format": "uuid",
|
||||
"readOnly": true,
|
||||
"description": "The capacity ID of the workspace."
|
||||
},
|
||||
"folderId": {
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"readOnly": true,
|
||||
"description": "The folder ID of the item."
|
||||
}
|
||||
}
|
||||
},
|
||||
|
||||
@@ -0,0 +1,119 @@
|
||||
{
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"version": "v1",
|
||||
"title": "SharingLinks - Admin APIs data types"
|
||||
},
|
||||
"paths": {},
|
||||
"definitions": {
|
||||
"BulkRemoveSharingLinksResponse": {
|
||||
"description": "A list of the unique IDs and sharing links removal status of the Fabric items in remove sharing links request",
|
||||
"properties": {
|
||||
"itemsRemoveSharingLinksStatus": {
|
||||
"type": "array",
|
||||
"description": "A list of items remove sharing link status.",
|
||||
"items": {
|
||||
"$ref": "#/definitions/ItemRemoveSharingLinksStatus"
|
||||
}
|
||||
},
|
||||
"sharingLinkType": {
|
||||
"description": "Specifies the type of sharing link that is requested for deletion for each Fabric item. Additional sharing link types may be added over time.",
|
||||
"readOnly": true,
|
||||
"$ref": "#/definitions/SharingLinkType"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ItemRemoveSharingLinksStatus": {
|
||||
"description": "The unique ID and sharing links removal status of a Fabric item",
|
||||
"required": [
|
||||
"status"
|
||||
],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "../definitions.json#/definitions/ItemInfo"
|
||||
}
|
||||
],
|
||||
"properties": {
|
||||
"status": {
|
||||
"description": "The status of sharing links removal operation. Additional property types may be added over time.",
|
||||
"readOnly": true,
|
||||
"$ref": "#/definitions/SharingLinksRemovalStatus"
|
||||
}
|
||||
}
|
||||
},
|
||||
"BulkRemoveSharingLinksRequest": {
|
||||
"description": "A list of items for which all sharing links and related access is required to be removed. Also accepts the type of sharing link to be removed.",
|
||||
"required": [
|
||||
"items",
|
||||
"sharingLinkType"
|
||||
],
|
||||
"properties": {
|
||||
"items": {
|
||||
"type": "array",
|
||||
"description": "A list of items. The list includes item ID and type.",
|
||||
"readOnly": false,
|
||||
"items": {
|
||||
"$ref": "../definitions.json#/definitions/ItemInfo"
|
||||
}
|
||||
},
|
||||
"sharingLinkType": {
|
||||
"description": "Specifies the type of sharing link that is required to be deleted for each Fabric item. Additional sharing link types may be added over time.",
|
||||
"readOnly": false,
|
||||
"$ref": "#/definitions/SharingLinkType"
|
||||
}
|
||||
}
|
||||
},
|
||||
"RemoveAllSharingLinksRequest": {
|
||||
"description": "Accepts the type of sharing link to be removed for all Fabric items in organization.",
|
||||
"required": [
|
||||
"sharingLinkType"
|
||||
],
|
||||
"properties": {
|
||||
"sharingLinkType": {
|
||||
"description": "Specifies the type of sharing link that is required to be deleted. Additional sharing link types may be added over time.",
|
||||
"readOnly": false,
|
||||
"$ref": "#/definitions/SharingLinkType"
|
||||
}
|
||||
}
|
||||
},
|
||||
"SharingLinksRemovalStatus": {
|
||||
"type": "string",
|
||||
"description": "The status of removal of sharing links. Additional `SharingLinksRemovalStatus` types may be added over time.",
|
||||
"enum": [
|
||||
"Succeeded",
|
||||
"NotFound"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "SharingLinksRemovalStatus",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "NotFound",
|
||||
"description": "The Fabric item ID, label or type wasn't found."
|
||||
},
|
||||
{
|
||||
"value": "Succeeded",
|
||||
"description": "All sharing links were removed."
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"SharingLinkType": {
|
||||
"type": "string",
|
||||
"description": "Specifies the type of sharing link that is required to be deleted for each Fabric item. Additional sharing link types may be added over time.",
|
||||
"enum": [
|
||||
"OrgLink"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "SharingLinkType",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "OrgLink",
|
||||
"description": "The sharing link grants access to entire organization (default value)."
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,109 @@
|
||||
{
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"version": "v1",
|
||||
"title": "Tag data types"
|
||||
},
|
||||
"paths": {},
|
||||
"definitions": {
|
||||
"CreateTagRequest": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"displayName"
|
||||
],
|
||||
"description": "The request payload for creating a tag.",
|
||||
"properties": {
|
||||
"displayName": {
|
||||
"description": "The tag display name.\nThe display name cannot contain more than 40 characters.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"CreateTagsRequest": {
|
||||
"required": [
|
||||
"createTagsRequest"
|
||||
],
|
||||
"description": "This is a request wrapper for a creating a list of tags.",
|
||||
"properties": {
|
||||
"createTagsRequest": {
|
||||
"type": "array",
|
||||
"description": "An array of createTagRequest",
|
||||
"items": {
|
||||
"$ref": "#/definitions/CreateTagRequest"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateTagRequest": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"displayName"
|
||||
],
|
||||
"description": "The request payload for updating a tag.",
|
||||
"properties": {
|
||||
"displayName": {
|
||||
"description": "The tag display name.\nThe display name cannot contain more than 40 characters.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"CreateTagsResponse": {
|
||||
"type": "object",
|
||||
"description": "A response wrapper for a list of created tags.",
|
||||
"required": [
|
||||
"tags"
|
||||
],
|
||||
"properties": {
|
||||
"tags": {
|
||||
"type": "array",
|
||||
"description": "An array of tags",
|
||||
"items": {
|
||||
"$ref": "../../common/definitions.json#/definitions/Tag"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"AdminTagInfo": {
|
||||
"type": "object",
|
||||
"description": "Represents a tag.",
|
||||
"required": [
|
||||
"id",
|
||||
"displayName"
|
||||
],
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
"description": "The tag object ID.",
|
||||
"format": "uuid"
|
||||
},
|
||||
"displayName": {
|
||||
"type": "string",
|
||||
"description": "The name of the tag."
|
||||
}
|
||||
}
|
||||
},
|
||||
"AdminTagsInfo": {
|
||||
"type": "object",
|
||||
"description": "A response wrapper for a list of tags.",
|
||||
"required": [
|
||||
"value"
|
||||
],
|
||||
"properties": {
|
||||
"value": {
|
||||
"type": "array",
|
||||
"description": "An array of tags",
|
||||
"items": {
|
||||
"$ref": "#/definitions/AdminTagInfo"
|
||||
}
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "../../common/definitions.json#/definitions/PaginatedResponse"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,40 @@
|
||||
{
|
||||
"parameters": {},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"value": [
|
||||
{
|
||||
"id": "bc23d4c6-cc92-4eb6-bcb5-0ff98429bbff",
|
||||
"displayName": "Finance"
|
||||
},
|
||||
{
|
||||
"id": "b0bca781-003c-4041-b1c4-f94d34ba76d4",
|
||||
"displayName": "Human resources"
|
||||
},
|
||||
{
|
||||
"id": "6af5a1b6-bc4c-4c0a-b60d-30c68e6e3034",
|
||||
"displayName": "Engineering P1"
|
||||
},
|
||||
{
|
||||
"id": "6c00e8eb-51d4-46f7-8b90-7e98520ea7a0",
|
||||
"displayName": "Marketing Q1"
|
||||
},
|
||||
{
|
||||
"id": "17df435d-9efd-48c1-a937-7d6fd70ab26a",
|
||||
"displayName": "HR Sales Q1"
|
||||
},
|
||||
{
|
||||
"id": "fb765fe3-d404-4f24-9d67-5916449c4c50",
|
||||
"displayName": "Root"
|
||||
},
|
||||
{
|
||||
"id": "bda31be4-7efe-4272-8b85-e1b2ff0f0592",
|
||||
"displayName": "Legal EMEA"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,42 @@
|
||||
{
|
||||
"parameters": {},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"value": [
|
||||
{
|
||||
"id": "bc23d4c6-cc92-4eb6-bcb5-0ff98429bbff",
|
||||
"displayName": "Finance"
|
||||
},
|
||||
{
|
||||
"id": "b0bca781-003c-4041-b1c4-f94d34ba76d4",
|
||||
"displayName": "Human resources"
|
||||
},
|
||||
{
|
||||
"id": "6af5a1b6-bc4c-4c0a-b60d-30c68e6e3034",
|
||||
"displayName": "Engineering P1"
|
||||
},
|
||||
{
|
||||
"id": "6c00e8eb-51d4-46f7-8b90-7e98520ea7a0",
|
||||
"displayName": "Marketing Q1"
|
||||
},
|
||||
{
|
||||
"id": "17df435d-9efd-48c1-a937-7d6fd70ab26a",
|
||||
"displayName": "HR Sales Q1"
|
||||
},
|
||||
{
|
||||
"id": "fb765fe3-d404-4f24-9d67-5916449c4c50",
|
||||
"displayName": "Root"
|
||||
},
|
||||
{
|
||||
"id": "bda31be4-7efe-4272-8b85-e1b2ff0f0592",
|
||||
"displayName": "Legal EMEA"
|
||||
}
|
||||
],
|
||||
"continuationToken": "LDEsMTAwMDAwLDA%3D",
|
||||
"continuationUri": "https://api.fabric.microsoft.com/v1/admin/tags?continuationToken=LDEsMTAwMDAwLDA%3D"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -27,7 +27,7 @@
|
||||
"expirationTimeUtc": "2024-12-13T00:00:00.000Z",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"itemId": "5b218778-e7a5-4d73-8187-f10824047715",
|
||||
"invitationUrl": "https://app.fabric.microsoft.com/externaldatasharing/accept?si=VyT5NJ3%2bNkySqEmf368Pjw-dccc162f-7a41-4720-83c3-5c7e81187959"
|
||||
"invitationUrl": "https://app.fabric.microsoft.com/externaldatasharing/accept?providerTenantId=34f92457-fe9d-4c36-92a8-499fdfaf0f8f&shareId=dccc162f-7a41-4720-83c3-5c7e81187959"
|
||||
},
|
||||
{
|
||||
"id": "96c21561-65b8-4b23-bb9a-ee8cef945c45",
|
||||
@@ -49,7 +49,7 @@
|
||||
"expirationTimeUtc": "2024-08-31T00:00:00.000Z",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"itemId": "5b218778-e7a5-4d73-8187-f10824047715",
|
||||
"invitationUrl": "https://app.fabric.microsoft.com/externaldatasharing/accept?si=VyT5NJ3%2bNkySqEmf368Pjw-96c21561-65b8-4b23-bb9a-ee8cef945c45",
|
||||
"invitationUrl": "https://app.fabric.microsoft.com/externaldatasharing/accept?providerTenantId=34f92457-fe9d-4c36-92a8-499fdfaf0f8f&shareId=96c21561-65b8-4b23-bb9a-ee8cef945c45",
|
||||
"acceptedByTenantId": "c51dc03f-268a-4da0-a879-25f24947ab8b"
|
||||
},
|
||||
{
|
||||
@@ -72,7 +72,7 @@
|
||||
"expirationTimeUtc": "2024-01-01T00:00:00.000Z",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"itemId": "5b218778-e7a5-4d73-8187-f10824047715",
|
||||
"invitationUrl": "https://app.fabric.microsoft.com/externaldatasharing/accept?si=VyT5NJ3%2bNkySqEmf368Pjw-0f40aeca-8f78-4a6f-a552-e5c45faadc60"
|
||||
"invitationUrl": "https://app.fabric.microsoft.com/externaldatasharing/accept?providerTenantId=34f92457-fe9d-4c36-92a8-499fdfaf0f8f&shareId=0f40aeca-8f78-4a6f-a552-e5c45faadc60"
|
||||
},
|
||||
{
|
||||
"id": "89e82a82-0140-4837-8eee-9c919e3e5952",
|
||||
@@ -94,7 +94,7 @@
|
||||
"expirationTimeUtc": "2024-12-01T00:00:00.000Z",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"itemId": "5b218778-e7a5-4d73-8187-f10824047715",
|
||||
"invitationUrl": "https://app.fabric.microsoft.com/externaldatasharing/accept?si=VyT5NJ3%2bNkySqEmf368Pjw-89e82a82-0140-4837-8eee-9c919e3e5952",
|
||||
"invitationUrl": "https://app.fabric.microsoft.com/externaldatasharing/accept?providerTenantId=34f92457-fe9d-4c36-92a8-499fdfaf0f8f&shareId=89e82a82-0140-4837-8eee-9c919e3e5952",
|
||||
"acceptedByTenantId": "c51dc03f-268a-4da0-a879-25f24947ab8b"
|
||||
}
|
||||
]
|
||||
|
||||
@@ -0,0 +1,61 @@
|
||||
{
|
||||
"parameters": {
|
||||
"bulkRemoveSharingLinksRequest": {
|
||||
"items": [
|
||||
{
|
||||
"id": "fe472f5e-636e-4c10-a1c6-7e9edc0b542a",
|
||||
"type": "Report"
|
||||
},
|
||||
{
|
||||
"id": "476fcafe-b514-495d-b13f-ca9a4f0b1d8b",
|
||||
"type": "Report"
|
||||
},
|
||||
{
|
||||
"id": "fe472f5e-636e-4c10-a1c6-7e9edc0b542c",
|
||||
"type": "Report"
|
||||
},
|
||||
{
|
||||
"id": "476fcafe-b514-495d-b13f-ca9a4f0b1d8f",
|
||||
"type": "Notebook"
|
||||
}
|
||||
],
|
||||
"sharingLinkType": "OrgLink"
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"itemsRemoveSharingLinksStatus": [
|
||||
{
|
||||
"id": "fe472f5e-636e-4c10-a1c6-7e9edc0b542a",
|
||||
"type": "Report",
|
||||
"status": "NotFound"
|
||||
},
|
||||
{
|
||||
"id": "476fcafe-b514-495d-b13f-ca9a4f0b1d8b",
|
||||
"type": "Report",
|
||||
"status": "Failed"
|
||||
},
|
||||
{
|
||||
"id": "fe472f5e-636e-4c10-a1c6-7e9edc0b542c",
|
||||
"type": "Report",
|
||||
"status": "Succeeded"
|
||||
},
|
||||
{
|
||||
"id": "476fcafe-b514-495d-b13f-ca9a4f0b1d8f",
|
||||
"type": "Notebook",
|
||||
"status": "Succeeded"
|
||||
}
|
||||
],
|
||||
"sharingLinkType": "OrgLink"
|
||||
}
|
||||
},
|
||||
"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
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,18 @@
|
||||
{
|
||||
"parameters": {
|
||||
"removeAllSharingLinksRequest": {
|
||||
"sharingLinkType": "OrgLink"
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
},
|
||||
"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
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,25 @@
|
||||
{
|
||||
"parameters": {
|
||||
"createTagsRequest": [
|
||||
{ "displayName": "Finance 2024" },
|
||||
{ "displayName": "HR 2024" }
|
||||
]
|
||||
},
|
||||
"responses": {
|
||||
"201": {
|
||||
"body": {
|
||||
"tags": [
|
||||
{
|
||||
"id": "e281785b-5608-41ac-a1a1-78b48b95b825",
|
||||
"displayName": "Finance 2024"
|
||||
},
|
||||
{
|
||||
"id": "24402490-9519-48b9-9d51-b2db4095a56b",
|
||||
"displayName": "HR 2024"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"parameters": {
|
||||
"tagId": "97dd1d38-a4c6-41ed-bc4f-1e383f8ddd0f"
|
||||
},
|
||||
"responses": {
|
||||
"200": {}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
{
|
||||
"parameters": {
|
||||
"tagId": "d889df97-7061-45f6-98b8-c53a83c2cf68",
|
||||
"updateTagRequest": {
|
||||
"displayName": "Tag's new name."
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"id": "d889df97-7061-45f6-98b8-c53a83c2cf68",
|
||||
"displayName": "Tag's new name."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
+307
-6
@@ -1543,6 +1543,190 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/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/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",
|
||||
"tags": [
|
||||
"Tags"
|
||||
],
|
||||
"operationId": "Tags_BulkCreateTags",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "body",
|
||||
"name": "createTagsRequest",
|
||||
"description": "The request payload for creating tags.",
|
||||
"schema": {
|
||||
"$ref": "./definitions/tags.json#/definitions/CreateTagsRequest"
|
||||
},
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"201": {
|
||||
"description": "Tags created successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions/tags.json#/definitions/CreateTagsResponse"
|
||||
}
|
||||
},
|
||||
"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",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Create tags in bulk example": {
|
||||
"$ref": "./examples/Tags/CreateTags.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",
|
||||
"tags": [
|
||||
"Tags"
|
||||
],
|
||||
"operationId": "Tags_DeleteTag",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "tagId",
|
||||
"description": "The tag ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Tag was deleted successfully."
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* UnknownError - An error occurred \n\n* EntityNotFound - Tag ID does not exist",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Delete a tag example": {
|
||||
"$ref": "./examples/tags/DeleteTag.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"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",
|
||||
"tags": [
|
||||
"Tags"
|
||||
],
|
||||
"operationId": "Tags_UpdateTag",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "tagId",
|
||||
"description": "The tag ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "body",
|
||||
"name": "updateTagRequest",
|
||||
"description": "The request payload for updating the tag.",
|
||||
"schema": {
|
||||
"$ref": "./definitions/tags.json#/definitions/UpdateTagRequest"
|
||||
},
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Tag was updated successfully.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/Tag"
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* UnknownError - An error occurred\n\n* EntityNotFound - Tag ID does not exist \n\n* EntityConflict - Tag display name already exist\n\n * InvalidInput - Invalid tag display name",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Update a tag example": {
|
||||
"$ref": "./examples/tags/UpdateTag.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/items/bulkRemoveLabels": {
|
||||
"post": {
|
||||
"summary": "Remove sensitivity labels from Fabric items (such as lakehouses and reports) by item ID. The sensitivity labels of the autogenerated items linked to the items in the call, are removed and their IDs aren't returned. Items with linked autogenerated items that are supported are: Lakehouse, Warehouse, Datamart, SQLDatabase, MirroredDatabase.",
|
||||
@@ -1638,11 +1822,11 @@
|
||||
"/items/externalDataShares": {
|
||||
"get": {
|
||||
"summary": "Lists the external data shares in the tenant.",
|
||||
"description": "\nThis API supports [pagination](/rest/api/fabric/articles/pagination).\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## Required Tenant Settings\n\nTo use this API, enable the 'External data sharing' admin switch for the calling principal.\n\n## Limitations\n\nMaximum 10 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",
|
||||
"description": "\nThis API supports [pagination](/rest/api/fabric/articles/pagination).\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## Required Tenant Settings\n\nTo use this API, enable the *External data sharing* admin switch for the calling principal.\n\n## Limitations\n\nMaximum 10 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": [
|
||||
"ExternalDataShares"
|
||||
"ExternalDataSharesProvider"
|
||||
],
|
||||
"operationId": "ExternalDataShares_ListExternalDataShares",
|
||||
"operationId": "ExternalDataSharesProvider_ListExternalDataShares",
|
||||
"x-ms-pageable": {
|
||||
"nextLinkName": "continuationUri",
|
||||
"itemName": "value"
|
||||
@@ -1683,11 +1867,11 @@
|
||||
"/workspaces/{workspaceId}/items/{itemId}/externalDataShares/{externalDataShareId}/revoke": {
|
||||
"post": {
|
||||
"summary": "Revokes the specified external data share. This action cannot be undone.",
|
||||
"description": "## Permissions\n\nThe caller must be a Fabric administrator.\n\n## Required Delegated Scopes\n\nTenant.ReadWrite.All\n\n## Required Tenant Settings\n\nTo use this API, enable the 'External data sharing' admin switch for the calling principal.\n\n## Limitations\n\nMaximum 10 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",
|
||||
"description": "## Permissions\n\nThe caller must be a Fabric administrator.\n\n## Required Delegated Scopes\n\nTenant.ReadWrite.All\n\n## Required Tenant Settings\n\nTo use this API, enable the *External data sharing* admin switch for the calling principal.\n\n## Limitations\n\nMaximum 10 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": [
|
||||
"ExternalDataShares"
|
||||
"ExternalDataSharesProvider"
|
||||
],
|
||||
"operationId": "ExternalDataShares_RevokeExternalDataShare",
|
||||
"operationId": "ExternalDataSharesProvider_RevokeExternalDataShare",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
@@ -1734,6 +1918,123 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/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/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"],
|
||||
"x-ms-fabric-sdk-long-running-operation": true,
|
||||
"parameters": [
|
||||
{
|
||||
"name": "removeAllSharingLinksRequest",
|
||||
"description": "Type of sharing links to be removed.",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"$ref": "./definitions/sharinglinks.json#/definitions/RemoveAllSharingLinksRequest"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully."
|
||||
},
|
||||
"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* Forbidden - The caller doesn't have permissions to call the API.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Remove all sharing links example": {
|
||||
"$ref": "./examples/sharinglinks/RemoveAllSharingLinks.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/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/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"],
|
||||
"x-ms-fabric-sdk-long-running-operation": true,
|
||||
"parameters": [
|
||||
{
|
||||
"name": "bulkRemoveSharingLinksRequest",
|
||||
"description": "A list of items.",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"$ref": "./definitions/sharinglinks.json#/definitions/BulkRemoveSharingLinksRequest"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions/sharinglinks.json#/definitions/BulkRemoveSharingLinksResponse"
|
||||
}
|
||||
},
|
||||
"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* Forbidden - The caller doesn't have permissions to call the API.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Remove sharing links for specific items example": {
|
||||
"$ref": "./examples/sharinglinks/BulkRemoveSharingLinksForItems.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {},
|
||||
|
||||
@@ -0,0 +1,136 @@
|
||||
{
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"title": "Apache Airflow job data types",
|
||||
"version": "v1"
|
||||
},
|
||||
"paths": {},
|
||||
"definitions": {
|
||||
"ApacheAirflowJob": {
|
||||
"description": "An Apache Airflow job object.",
|
||||
"type": "object",
|
||||
"required": ["type"],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "../common/definitions.json#/definitions/Item"
|
||||
}
|
||||
]
|
||||
},
|
||||
"ApacheAirflowJobs": {
|
||||
"description": "A list of Apache Airflow job objects.",
|
||||
"required": ["value"],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"value": {
|
||||
"description": "A list of Apache Airflow job objects.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/ApacheAirflowJob"
|
||||
}
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
|
||||
}
|
||||
]
|
||||
},
|
||||
"CreateApacheAirflowJobRequest": {
|
||||
"description": "Create request payload.",
|
||||
"required": ["displayName"],
|
||||
"properties": {
|
||||
"displayName": {
|
||||
"description": "The Apache Airflow job display name. The display name must follow naming rules according to item type.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"description": {
|
||||
"description": "The Apache Airflow job description. Maximum length is 256 characters.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"folderId": {
|
||||
"description": "The folder ID. If not specified or null, the Apache Airflow is created with the workspace as its folder.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"readOnly": false
|
||||
},
|
||||
"definition": {
|
||||
"description": "The Apache Airflow job public definition.",
|
||||
"$ref": "#/definitions/ApacheAirflowJobDefinition",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateApacheAirflowJobDefinitionRequest": {
|
||||
"description": "Update public definition request payload.",
|
||||
"required": ["definition"],
|
||||
"properties": {
|
||||
"definition": {
|
||||
"$ref": "#/definitions/ApacheAirflowJobDefinition"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ApacheAirflowJobDefinitionResponse": {
|
||||
"description": "Apache Airflow job public definition response.",
|
||||
"required": ["definition"],
|
||||
"properties": {
|
||||
"definition": {
|
||||
"$ref": "#/definitions/ApacheAirflowJobDefinition",
|
||||
"readOnly": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"ApacheAirflowJobDefinition" : {
|
||||
"description": "Apache Airflow job public definition object.",
|
||||
"type": "object",
|
||||
"required": ["parts"],
|
||||
"properties": {
|
||||
"parts": {
|
||||
"description": "A list of definition parts.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/ApacheAirflowJobDefinitionPart"
|
||||
},
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"ApacheAirflowJobDefinitionPart": {
|
||||
"description": "Apache Airflow job public definition part object.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"path": {
|
||||
"description": "The public definition part path.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"payload": {
|
||||
"description": "The public definition part payload.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"payloadType":{
|
||||
"description": "The payload type.",
|
||||
"$ref": "../common/definitions.json#/definitions/PayloadType",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateApacheAirflowJobRequest": {
|
||||
"description": "Update Apache Airflow job request.",
|
||||
"properties": {
|
||||
"displayName": {
|
||||
"description": "The Apache Airflow job display name. The display name must follow naming rules according to item type.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"description": {
|
||||
"description": "The Apache Airflow job description. Maximum length is 256 characters.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,27 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"createApacheAirflowJobRequest": {
|
||||
"displayName": "ApacheAirflowJob1",
|
||||
"description": "An Apache Airflow job description."
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"201": {
|
||||
"body": {
|
||||
"displayName": "ApacheAirflowJob1",
|
||||
"description": "An Apache Airflow job description.",
|
||||
"type": "ApacheAirflowJob",
|
||||
"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
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,27 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"createApacheAirflowJobRequest": {
|
||||
"displayName": "ApacheAirflowJob1",
|
||||
"description": "An Apache Airflow job description."
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"201": {
|
||||
"body": {
|
||||
"displayName": "ApacheAirflowJob1",
|
||||
"description": "An Apache Airflow job description.",
|
||||
"type": "ApacheAirflowJob",
|
||||
"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
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"ApacheAirflowJobId": "5b218778-e7a5-4d73-8187-f10824047715"
|
||||
},
|
||||
"responses": {
|
||||
"200": {}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,17 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
|
||||
"ApacheAirflowJobId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"id": "5b218778-e7a5-4d73-8187-f10824047715",
|
||||
"displayName": "ApacheAirflowJob1",
|
||||
"description": "An Apache Airflow job description.",
|
||||
"type": "ApacheAirflowJob",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,33 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "6e335e92-a2a2-4b5a-970a-bd6a89fbb765",
|
||||
"ApacheAirflowJobId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"definition": {
|
||||
"parts": [
|
||||
{
|
||||
"path": "ApacheAirflowJobV1.json",
|
||||
"payload": "ewogICJwcm9wZXJ0aWVzIjogewogICAgInR5cGUiOiAiQXBhY2hlQWlyZmxvd0pvYiIsCiAgICAidHlwZVByb3BlcnRpZXMiOiB7CiAgICAgICJhaXJmbG93UHJvcGVydGllcyI6IHsKICAgICAgICAiYWlyZmxvd1ZlcnNpb24iOiAiMi42LjMiLAogICAgICAgICJweXRob25WZXJzaW9uIjogIjMuOCIsCiAgICAgICAgImVudmlyb25tZW50VmFyaWFibGVzIjoge30sCiAgICAgICAgImFpcmZsb3dDb25maWd1cmF0aW9uT3ZlcnJpZGVzIjoge30sCiAgICAgICAgImFpcmZsb3dSZXF1aXJlbWVudHMiOiBbCiAgICAgICAgICAiZmxhc2stYmNyeXB0PT0wLjcuMSIKICAgICAgICBdLAogICAgICAgICJwYWNrYWdlUHJvdmlkZXJQYXRoIjogInBsdWdpbnMiLAogICAgICAgICJlbmFibGVBQURJbnRlZ3JhdGlvbiI6IHRydWUsCiAgICAgICAgImVuYWJsZVRyaWdnZXJlcnMiOiBmYWxzZSwKICAgICAgICAic2VjcmV0cyI6IFtdCiAgICAgIH0sCiAgICAgICJjb21wdXRlUHJvcGVydGllcyI6IHsKICAgICAgICAiY29tcHV0ZVBvb2wiOiAiU3RhcnRlclBvb2wiLAogICAgICAgICJsb2NhdGlvbiI6ICJDZW50cmFsIFVTIiwKICAgICAgICAiY29tcHV0ZVNpemUiOiAiU21hbGwiLAogICAgICAgICJleHRyYU5vZGVzIjogMCwKICAgICAgICAiZW5hYmxlQXZhaWxhYmlsaXR5Wm9uZXMiOiBmYWxzZSwKICAgICAgICAiZW5hYmxlQXV0b3NjYWxlIjogZmFsc2UKICAgICAgfQogICAgfQogIH0KfQ==",
|
||||
"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
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,27 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"value": [
|
||||
{
|
||||
"id": "3546052c-ae64-4526-b1a8-52af7761426f",
|
||||
"displayName": "ApacheAirflowJobName1",
|
||||
"description": "An Apache Airflow job description.",
|
||||
"type": "ApacheAirflowJob",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
|
||||
},
|
||||
{
|
||||
"id": "f697fb63-abd4-4399-9548-be7e3c3c0dac",
|
||||
"displayName": "ApacheAirflowJob2",
|
||||
"description": "An Apache Airflow job description.",
|
||||
"type": "ApacheAirflowJob",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,20 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"ApacheAirflowJobId": "5b218778-e7a5-4d73-8187-f10824047715",
|
||||
"updateApacheAirflowJobRequest": {
|
||||
"description": "Apache Airflow job's New description"
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"description": "Apache Airflow job's New description",
|
||||
"displayName": "ApacheAirflowJob1",
|
||||
"type": "ApacheAirflowJob",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"id": "5b218778-e7a5-4d73-8187-f10824047715"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,34 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"ApacheAirflowJobId": "5b218778-e7a5-4d73-8187-f10824047715",
|
||||
"updateMetadata" : true,
|
||||
"updateApacheAirflowJobDefinitionRequest": {
|
||||
"definition": {
|
||||
"parts": [
|
||||
{
|
||||
"path": "ApacheAirflowJobV1.json",
|
||||
"payload": "ewogICJwcm9wZXJ0aWVzIjogewogICAgInR5cGUiOiAiQXBhY2hlQWlyZmxvd0pvYiIsCiAgICAidHlwZVByb3BlcnRpZXMiOiB7CiAgICAgICJhaXJmbG93UHJvcGVydGllcyI6IHsKICAgICAgICAiYWlyZmxvd1ZlcnNpb24iOiAiMi42LjMiLAogICAgICAgICJweXRob25WZXJzaW9uIjogIjMuOCIsCiAgICAgICAgImVudmlyb25tZW50VmFyaWFibGVzIjoge30sCiAgICAgICAgImFpcmZsb3dDb25maWd1cmF0aW9uT3ZlcnJpZGVzIjoge30sCiAgICAgICAgImFpcmZsb3dSZXF1aXJlbWVudHMiOiBbCiAgICAgICAgICAiZmxhc2stYmNyeXB0PT0wLjcuMSIKICAgICAgICBdLAogICAgICAgICJwYWNrYWdlUHJvdmlkZXJQYXRoIjogInBsdWdpbnMiLAogICAgICAgICJlbmFibGVBQURJbnRlZ3JhdGlvbiI6IHRydWUsCiAgICAgICAgImVuYWJsZVRyaWdnZXJlcnMiOiBmYWxzZSwKICAgICAgICAic2VjcmV0cyI6IFtdCiAgICAgIH0sCiAgICAgICJjb21wdXRlUHJvcGVydGllcyI6IHsKICAgICAgICAiY29tcHV0ZVBvb2wiOiAiU3RhcnRlclBvb2wiLAogICAgICAgICJsb2NhdGlvbiI6ICJDZW50cmFsIFVTIiwKICAgICAgICAiY29tcHV0ZVNpemUiOiAiU21hbGwiLAogICAgICAgICJleHRyYU5vZGVzIjogMCwKICAgICAgICAiZW5hYmxlQXZhaWxhYmlsaXR5Wm9uZXMiOiBmYWxzZSwKICAgICAgICAiZW5hYmxlQXV0b3NjYWxlIjogZmFsc2UKICAgICAgfQogICAgfQogIH0KfQ==",
|
||||
"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
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,453 @@
|
||||
{
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"title": "Apache Airflow job REST APIs",
|
||||
"version": "v1"
|
||||
},
|
||||
"schemes": [
|
||||
"https"
|
||||
],
|
||||
"host": "api.fabric.microsoft.com",
|
||||
"basePath": "/v1",
|
||||
"paths": {
|
||||
"/workspaces/{workspaceId}/ApacheAirflowJobs": {
|
||||
"get": {
|
||||
"summary": "Returns a list of Apache Airflow jobs from the specified workspace.",
|
||||
"description": "This API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\n The caller must have a *viewer* workspace role. \n\n## Required Delegated Scopes\n\nWorkspace.Read.All or Workspace.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_ListApacheAirflowJobs",
|
||||
"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/ApacheAirflowJobs"
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* InvalidItemType - Invalid item type.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"List s in workspace example": {
|
||||
"$ref": "./examples/ListApacheAirflowJobsInWorkspace.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"post": {
|
||||
"summary": "Creates an Apache Airflow job in the specified workspace.",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n To create Apache Airflow job with a public definition, refer to [](/rest/api/fabric/articles/item-management/definitions/public-facing-name) article. \n\n ## Permissions \n The caller must have a *contributor* workspace role. \n\n## Required Delegated Scopes\n\n ApacheAirflowJob.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations \n- To create an Apache Airflow job 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_CreateApacheAirflowJob",
|
||||
"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": "createApacheAirflowJobRequest",
|
||||
"description": "Create item request payload.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/CreateApacheAirflowJobRequest"
|
||||
},
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"201": {
|
||||
"description": "Successfully created",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/ApacheAirflowJob"
|
||||
}
|
||||
},
|
||||
"202": {
|
||||
"description": "Request accepted, provisioning in progress.",
|
||||
"headers": {
|
||||
"Location": {
|
||||
"description": "The URL of the operation status, which can be used to track the operation state.",
|
||||
"type": "string"
|
||||
},
|
||||
"x-ms-operation-id": {
|
||||
"description": "The operation ID which can be used with long running operations (LRO) APIs to track the operation state and get the result.",
|
||||
"type": "string",
|
||||
"format": "uuid"
|
||||
},
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* InvalidItemType - Item type is invalid\n\n* ItemDisplayNameAlreadyInUse - Item display name is already used.\n\n* CorruptedPayload - The provided payload is corrupted.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Create an Apache Airflow job with public definition example": {
|
||||
"$ref": "./examples/CreateApacheAirflowJob.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/ApacheAirflowJobs/{ApacheAirflowJobId}": {
|
||||
"get": {
|
||||
"summary": "Returns properties of the specified Apache Airflow job.",
|
||||
"description": "## Permissions\n\n The caller must have *read* permissions for the apache airflow job. \n\n## Required Delegated Scopes\n\n ApacheAirflowJob.Read.All or ApacheAirflowJob.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_GetApacheAirflowJob",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "workspaceId",
|
||||
"description": "The workspace ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "ApacheAirflowJobId",
|
||||
"description": "The Apache Airflow job ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/ApacheAirflowJob"
|
||||
}
|
||||
},
|
||||
"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 an Apache Airflow job example": {
|
||||
"$ref": "./examples/GetApacheAirflowJob.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"patch": {
|
||||
"summary": "Updates the properties of the specified Apache Airflow job.",
|
||||
"description": "## Permissions\n\n The caller must have *read and write* permissions for the apache airflow job.\n\n## Required Delegated Scopes\n\n ApacheAirflowJob.ReadWrite.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_UpdateApacheAirflowJob",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "workspaceId",
|
||||
"description": "The workspace ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "ApacheAirflowJobId",
|
||||
"description": "The Apache Airflow job ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "body",
|
||||
"name": "updateApacheAirflowJobRequest",
|
||||
"description": "Update Apache Airflow job request payload.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/UpdateApacheAirflowJobRequest"
|
||||
},
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/ApacheAirflowJob"
|
||||
}
|
||||
},
|
||||
"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 an Apache Airflow job example": {
|
||||
"$ref": "./examples/UpdateApacheAirflowJob.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Deletes the specified Apache Airflow job.",
|
||||
"description": "## Permissions\n\n The caller must have *write* permissions for the apache airflow job. \n\n## Required Delegated Scopes\n\n ApacheAirflowJob.ReadWrite.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_DeleteApacheAirflowJob",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "workspaceId",
|
||||
"description": "The workspace ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "ApacheAirflowJobId",
|
||||
"description": "The Apache Airflow job 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 an Apache Airflow job example": {
|
||||
"$ref": "./examples/DeleteApacheAirflowJob.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/ApacheAirflowJobs/{ApacheAirflowJobId}/getDefinition": {
|
||||
"post": {
|
||||
"summary": "Returns the specified Apache Airflow job public definition.",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a '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 apache airflow job. \n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\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_GetApacheAirflowJobDefinition",
|
||||
"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": "ApacheAirflowJobId",
|
||||
"description": "The Apache Airflow job ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "format",
|
||||
"description": "The format of the public definition.",
|
||||
"type": "string",
|
||||
"required": false
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/ApacheAirflowJobDefinitionResponse"
|
||||
}
|
||||
},
|
||||
"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 an Apache Airflow job public definition example": {
|
||||
"$ref": "./examples/GetApacheAirflowJobDefinition.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/ApacheAirflowJobs/{ApacheAirflowJobId}/updateDefinition": {
|
||||
"post": {
|
||||
"summary": "Overrides the definition for the specified Apache Airflow job.",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n \nUpdating the 's definition, does not affect its sensitivity label. \n\n## Permissions\n\n The caller must have *read and write* permissions for the apache airflow job. \n## Required Delegated Scopes\n\n ApacheAirflowJob.ReadWrite.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_UpdateApacheAirflowJobDefinition",
|
||||
"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": "ApacheAirflowJobId",
|
||||
"description": "The Apache Airflow job 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": "updateApacheAirflowJobDefinitionRequest",
|
||||
"description": "Update Apache Airflow job definition request payload.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/UpdateApacheAirflowJobDefinitionRequest"
|
||||
},
|
||||
"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 an Apache Airflow job public definition example": {
|
||||
"$ref": "./examples/UpdateApacheAirflowJobDefinition.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {},
|
||||
"security": [],
|
||||
"tags": []
|
||||
}
|
||||
+107
-10
@@ -176,7 +176,7 @@
|
||||
"parentPrincipal": {
|
||||
"description": "The service principal profile's parent principal.",
|
||||
"$ref": "#/definitions/Principal",
|
||||
"readOnly": false,
|
||||
"readOnly": false,
|
||||
"type": "object"
|
||||
}
|
||||
},
|
||||
@@ -188,7 +188,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" ],
|
||||
"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" ],
|
||||
"x-ms-enum": {
|
||||
"name": "ItemType",
|
||||
"modelAsString": true,
|
||||
@@ -284,12 +284,15 @@
|
||||
{
|
||||
"value": "GraphQLApi",
|
||||
"description": "An API for GraphQL item."
|
||||
|
||||
},
|
||||
{
|
||||
"value": "MountedDataFactory",
|
||||
"description": "A MountedDataFactory."
|
||||
},
|
||||
{
|
||||
"value": "ApacheAirflowJob",
|
||||
"description": "An ApacheAirflowJob."
|
||||
},
|
||||
{
|
||||
"value": "SQLDatabase",
|
||||
"description": "A SQLDatabase."
|
||||
@@ -297,6 +300,30 @@
|
||||
{
|
||||
"value": "CopyJob",
|
||||
"description": "A Copy job."
|
||||
},
|
||||
{
|
||||
"value": "VariableLibrary",
|
||||
"description": "A VariableLibrary."
|
||||
},
|
||||
{
|
||||
"value": "MirroredAzureDatabricksCatalog",
|
||||
"description": "A mirrored azure databricks catalog."
|
||||
},
|
||||
{
|
||||
"value": "Dataflow",
|
||||
"description": "A Dataflow."
|
||||
},
|
||||
{
|
||||
"value": "WarehouseSnapshot",
|
||||
"description": "A Warehouse snapshot."
|
||||
},
|
||||
{
|
||||
"value": "DigitalTwinBuilder",
|
||||
"description": "A DigitalTwinBuilder."
|
||||
},
|
||||
{
|
||||
"value": "DigitalTwinBuilderFlow",
|
||||
"description": "A Digital Twin Builder Flow."
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -357,7 +384,7 @@
|
||||
"type": "string",
|
||||
"description": "Item permissions. Additional item permissions may be added over time.",
|
||||
"enum": ["Read", "Write", "Reshare", "Explore", "Execute"],
|
||||
"x-ms-enum": {
|
||||
"x-ms-enum": {
|
||||
"name": "ItemPermissions",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
@@ -449,6 +476,15 @@
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"readOnly": true
|
||||
},
|
||||
"tags": {
|
||||
"description": "List of applied tags.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/ItemTag"
|
||||
|
||||
},
|
||||
"readOnly": true
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -603,6 +639,66 @@
|
||||
}
|
||||
]
|
||||
},
|
||||
"Tag": {
|
||||
"type": "object",
|
||||
"description": "Represents a tag.",
|
||||
"required": [
|
||||
"id",
|
||||
"displayName"
|
||||
],
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
"description": "The tag object ID.",
|
||||
"format": "uuid"
|
||||
},
|
||||
"displayName": {
|
||||
"type": "string",
|
||||
"description": "The name of the tag."
|
||||
}
|
||||
}
|
||||
},
|
||||
"Tags": {
|
||||
"type": "object",
|
||||
"description": "A response wrapper for a list of tags.",
|
||||
"required": [
|
||||
"value"
|
||||
],
|
||||
"properties": {
|
||||
"value": {
|
||||
"type": "array",
|
||||
"description": "An array of tags",
|
||||
"items": {
|
||||
"$ref": "#/definitions/Tag"
|
||||
}
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/PaginatedResponse"
|
||||
}
|
||||
]
|
||||
},
|
||||
"ItemTag": {
|
||||
"type": "object",
|
||||
"description": "Represents a tag applied on an item.",
|
||||
"required": [
|
||||
"id",
|
||||
"displayName"
|
||||
],
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
"description": "The tag ID.",
|
||||
"format": "uuid"
|
||||
},
|
||||
"displayName": {
|
||||
"type": "string",
|
||||
"description": "The name of the tag."
|
||||
}
|
||||
}
|
||||
},
|
||||
|
||||
"ItemReference": {
|
||||
"description": "An item reference object.",
|
||||
"type": "object",
|
||||
@@ -618,20 +714,20 @@
|
||||
"ItemReferenceType": {
|
||||
"type": "string",
|
||||
"description": "The Item reference type. Additional `ItemReferenceType` types may be added over time.",
|
||||
"enum": ["WithWorkspaceById"],
|
||||
"enum": ["ById"],
|
||||
"x-ms-enum": {
|
||||
"name": "ItemReferenceType",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "WithWorkspaceById",
|
||||
"description": "The item is referenced by its ID with the ID of the item's workspace."
|
||||
"value": "ById",
|
||||
"description": "The item is referenced by its ID."
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"ItemReferenceWithWorkspaceById": {
|
||||
"description": "The item is referenced by its ID with the ID of the item's workspace.",
|
||||
"ItemReferenceById": {
|
||||
"description": "An item reference by ID object.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"itemId",
|
||||
@@ -654,7 +750,7 @@
|
||||
"$ref": "#/definitions/ItemReference"
|
||||
}
|
||||
],
|
||||
"x-ms-discriminator-value": "WithWorkspaceById"
|
||||
"x-ms-discriminator-value": "ById"
|
||||
},
|
||||
"Duration": {
|
||||
"description": "A duration.",
|
||||
@@ -700,3 +796,4 @@
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -0,0 +1,274 @@
|
||||
{
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"title": "Spark common setting data types",
|
||||
"version": "v1"
|
||||
},
|
||||
"paths": {},
|
||||
"definitions": {
|
||||
"LivySessions": {
|
||||
"required": [
|
||||
"value"
|
||||
],
|
||||
"description": "A paginated list of livy sessions.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"value": {
|
||||
"description": "A list of livy sessions.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/LivySession"
|
||||
}
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "./definitions.json#/definitions/PaginatedResponse"
|
||||
}
|
||||
]
|
||||
},
|
||||
"LivySession": {
|
||||
"type": "object",
|
||||
"description": "The livy session response",
|
||||
"properties": {
|
||||
"sparkApplicationId": {
|
||||
"type": "string",
|
||||
"description": "A Spark application ID is a unique identifier assigned to each Apache Spark application. It also appears in the Spark UI."
|
||||
},
|
||||
"state": {
|
||||
"description": "Current state of the job.",
|
||||
"$ref": "#/definitions/LivySessionState"
|
||||
},
|
||||
"livyId": {
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"description": "ID of the Livy session or Livy batch."
|
||||
},
|
||||
"origin": {
|
||||
"description": "Origin of the job.",
|
||||
"$ref": "#/definitions/LivySessionOrigin"
|
||||
},
|
||||
"attemptNumber": {
|
||||
"type": "integer",
|
||||
"description": "Current attempt number."
|
||||
},
|
||||
"maxNumberOfAttempts": {
|
||||
"type": "integer",
|
||||
"description": "Maximum number of attempts."
|
||||
},
|
||||
"livyName": {
|
||||
"type": "string",
|
||||
"description": "Name of the Livy session or Livy batch."
|
||||
},
|
||||
"submitter": {
|
||||
"description": "ID of the submitter.",
|
||||
"$ref": "./definitions.json#/definitions/Principal"
|
||||
},
|
||||
"item": {
|
||||
"description": "ID of the item.",
|
||||
"$ref": "./definitions.json#/definitions/ItemReferenceById"
|
||||
},
|
||||
"itemType": {
|
||||
"description": "The item type.",
|
||||
"$ref": "#/definitions/LivySessionItemType"
|
||||
},
|
||||
"itemName": {
|
||||
"type": "string",
|
||||
"description": "Name of the item."
|
||||
},
|
||||
"jobType": {
|
||||
"description": "Current state of the job.",
|
||||
"$ref": "#/definitions/LivySessionJobType"
|
||||
},
|
||||
"submittedDateTime": {
|
||||
"type": "string",
|
||||
"format": "date-time",
|
||||
"description": "Timestamp when the job was submitted in UTC, using the YYYY-MM-DDTHH:mm:ssZ format."
|
||||
},
|
||||
"startDateTime": {
|
||||
"type": "string",
|
||||
"format": "date-time",
|
||||
"description": "Timestamp when the job started in UTC, using the YYYY-MM-DDTHH:mm:ssZ format."
|
||||
},
|
||||
"endDateTime": {
|
||||
"type": "string",
|
||||
"format": "date-time",
|
||||
"description": "Timestamp when the job ended in UTC, using the YYYY-MM-DDTHH:mm:ssZ format."
|
||||
},
|
||||
"queuedDuration": {
|
||||
"description": "Duration for which the job was queued.",
|
||||
"$ref": "./definitions.json#/definitions/Duration"
|
||||
},
|
||||
"runningDuration": {
|
||||
"description": "Time it took the job to run.",
|
||||
"$ref": "./definitions.json#/definitions/Duration"
|
||||
},
|
||||
"totalDuration": {
|
||||
"description": "Total duration of the job.",
|
||||
"$ref": "./definitions.json#/definitions/Duration"
|
||||
},
|
||||
"jobInstanceId": {
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"description": "ID of the job instance."
|
||||
},
|
||||
"creatorItem": {
|
||||
"description": "ID of the item creator. When `isHighConcurrency` is set to `true` this value might be different than `itemId`.",
|
||||
"$ref": "./definitions.json#/definitions/ItemReferenceById"
|
||||
},
|
||||
"isHighConcurrency": {
|
||||
"type": "boolean",
|
||||
"description": "Flag indicating high concurrency."
|
||||
},
|
||||
"cancellationReason": {
|
||||
"type": "string",
|
||||
"description": "Reason for the job cancellation."
|
||||
},
|
||||
"capacityId": {
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"description": "ID of the capacity."
|
||||
},
|
||||
"operationName": {
|
||||
"type": "string",
|
||||
"description": "Name of the operation. Possible values include: _Notebook run_, _Notebook HC run_ and _Notebook pipeline run_."
|
||||
},
|
||||
"consumerId": {
|
||||
"description": "ID of the consumer.",
|
||||
"$ref": "./definitions.json#/definitions/Principal"
|
||||
},
|
||||
"runtimeVersion": {
|
||||
"type": "string",
|
||||
"description": "The fabric runtime version."
|
||||
},
|
||||
"livySessionItemResourceUri": {
|
||||
"type": "string",
|
||||
"description": "The URI used to retrieve all Livy sessions for a given item."
|
||||
}
|
||||
}
|
||||
},
|
||||
"LivySessionState": {
|
||||
"type": "string",
|
||||
"description": "Current state of the job. Values are: `NotStarted`, `InProgress`, `Cancelled`, `Succeeded`, `Stopped`, `Failed`, `Unknown`. Additional `LivySessionState` types may be added over time.",
|
||||
"enum": [
|
||||
"InProgress",
|
||||
"Cancelled",
|
||||
"NotStarted",
|
||||
"Succeeded",
|
||||
"Failed",
|
||||
"Unknown"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "State",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "InProgress",
|
||||
"description": "Job is in running or is cancelling state."
|
||||
},
|
||||
{
|
||||
"value": "Cancelled",
|
||||
"description": "Job got cancelled."
|
||||
},
|
||||
{
|
||||
"value": "NotStarted",
|
||||
"description": "Job is queued, is starting or in library packaging state."
|
||||
},
|
||||
{
|
||||
"value": "Succeeded",
|
||||
"description": "Job has stopped or is in success state."
|
||||
},
|
||||
{
|
||||
"value": "Failed",
|
||||
"description": "Job failed or its session timed out."
|
||||
},
|
||||
{
|
||||
"value": "Unknown",
|
||||
"description": "Job is in invalid state."
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"LivySessionOrigin": {
|
||||
"type": "string",
|
||||
"description": "Origin of the job. Values are: `SubmittedJob`, `PendingJob`. Additional `LivySessionOrigin` types may be added over time.",
|
||||
"enum": [
|
||||
"SubmittedJob",
|
||||
"PendingJob"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "Origin",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "SubmittedJob",
|
||||
"description": "Job is coming from submitted data source."
|
||||
},
|
||||
{
|
||||
"value": "PendingJob",
|
||||
"description": "Job is coming from pending data source."
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"LivySessionItemType": {
|
||||
"type": "string",
|
||||
"description": "The item type. Values are: `Lakehouse`, `SparkJobDefinition`, `Notebook`. Additional `LivySessionItemType` types may be added over time.",
|
||||
"enum": [
|
||||
"Lakehouse",
|
||||
"SparkJobDefinition",
|
||||
"Notebook"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "ItemType",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "Lakehouse",
|
||||
"description": "Item is a lakehouse item."
|
||||
},
|
||||
{
|
||||
"value": "SparkJobDefinition",
|
||||
"description": "Item is a spark job definition item."
|
||||
},
|
||||
{
|
||||
"value": "Notebook",
|
||||
"description": "Item is a notebook item."
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"LivySessionJobType": {
|
||||
"type": "string",
|
||||
"description": "Type of the job. Values are: `Unknown`, `SparkSession`, `SparkBatch`, `JupyterSession`. Additional `LivySessionJobType` types may be added over time.",
|
||||
"enum": [
|
||||
"Unknown",
|
||||
"SparkSession",
|
||||
"SparkBatch",
|
||||
"JupyterSession"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "JobType",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "Unknown",
|
||||
"description": "Job type is unknown."
|
||||
},
|
||||
{
|
||||
"value": "SparkSession",
|
||||
"description": "Job type is from a spark session."
|
||||
},
|
||||
{
|
||||
"value": "SparkBatch",
|
||||
"description": "Job type is from a spark batch."
|
||||
},
|
||||
{
|
||||
"value": "JupyterSession",
|
||||
"description": "Job type is from jupyter session."
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -49,6 +49,12 @@
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"folderId": {
|
||||
"description": "The folder ID. If not specified or null, the CopyJob is created with the workspace as its folder.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"readOnly": false
|
||||
},
|
||||
"definition": {
|
||||
"description": "The CopyJob public definition.",
|
||||
"$ref": "#/definitions/CopyJobDefinition",
|
||||
|
||||
@@ -13,7 +13,7 @@
|
||||
"/workspaces/{workspaceId}/copyJobs": {
|
||||
"get": {
|
||||
"summary": "Returns a list of CopyJobs from the specified workspace.",
|
||||
"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\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\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 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"
|
||||
],
|
||||
@@ -63,7 +63,7 @@
|
||||
},
|
||||
"post": {
|
||||
"summary": "Creates a CopyJob in the specified workspace.",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n To create CopyJob with a public definition, refer to [CopyJob](/rest/api/fabric/articles/item-management/definitions/CopyJob). \n\n ## Permissions \n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes\n\n CopyJob.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations \n- To create a CopyJob the workspace must be on a supported Fabric capacity. For more information see: [Microsoft Fabric license types](/fabric/enterprise/licenses#microsoft-fabric-license-types).\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n To create CopyJob with a public definition, refer to [CopyJob](/rest/api/fabric/articles/item-management/definitions/CopyJob). \n\n ## Permissions \n The caller must have a *contributor* workspace role. \n\n## Required Delegated Scopes\n\n CopyJob.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations \n- To create a CopyJob 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"
|
||||
],
|
||||
@@ -139,7 +139,7 @@
|
||||
"/workspaces/{workspaceId}/copyJobs/{copyJobId}": {
|
||||
"get": {
|
||||
"summary": "Returns properties of the specified CopyJob.",
|
||||
"description": "## Permissions\n\n The caller must have *viewer* or higher workspace role. \n\n## Required Delegated Scopes\n\n CopyJob.Read.All or CopyJob.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 copy job. \n\n## Required Delegated Scopes\n\n CopyJob.Read.All or CopyJob.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"
|
||||
],
|
||||
@@ -187,7 +187,7 @@
|
||||
},
|
||||
"patch": {
|
||||
"summary": "Updates the properties of the specified CopyJob.",
|
||||
"description": "## Permissions\n\n The caller must have *contributor* or higher workspace role.\n\n## Required Delegated Scopes\n\n CopyJob.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 copy job.\n\n## Required Delegated Scopes\n\n CopyJob.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"
|
||||
],
|
||||
@@ -247,7 +247,7 @@
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Deletes the specified CopyJob.",
|
||||
"description": "## Permissions\n\n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes\n\n CopyJob.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 *write* permissions for the copy job. \n\n## Required Delegated Scopes\n\n CopyJob.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"
|
||||
],
|
||||
@@ -294,7 +294,7 @@
|
||||
"/workspaces/{workspaceId}/copyJobs/{copyJobId}/getDefinition": {
|
||||
"post": {
|
||||
"summary": "Returns the specified CopyJob public definition.",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a CopyJob's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *contributor* or higher workspace role. \n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\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 [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a CopyJob'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 copy job. \n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\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"
|
||||
],
|
||||
@@ -370,7 +370,7 @@
|
||||
"/workspaces/{workspaceId}/copyJobs/{copyJobId}/updateDefinition": {
|
||||
"post": {
|
||||
"summary": "Overrides the definition for the specified CopyJob.",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n \nUpdating the CopyJob's definition, does not affect its sensitivity label. \n\n## Permissions\n\n The API caller must have *contributor* or higher workspace role. \n## Required Delegated Scopes\n\n CopyJob.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": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n \nUpdating the CopyJob's definition, does not affect its sensitivity label. \n\n## Permissions\n\n The caller must have *read and write* permissions for the copy job. \n## Required Delegated Scopes\n\n CopyJob.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"
|
||||
],
|
||||
|
||||
@@ -49,6 +49,12 @@
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"folderId": {
|
||||
"description": "The folder ID. If not specified or null, the dashboard is created with the workspace as its folder.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"readOnly": false
|
||||
},
|
||||
"definition": {
|
||||
"description": "The dashboard public definition.",
|
||||
"$ref": "#/definitions/DashboardDefinition",
|
||||
|
||||
@@ -13,7 +13,7 @@
|
||||
"/workspaces/{workspaceId}/dashboards": {
|
||||
"get": {
|
||||
"summary": "Returns a list of dashboards from the specified workspace.",
|
||||
"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\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
|
||||
"description": "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",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
|
||||
@@ -48,6 +48,12 @@
|
||||
"description": "The data pipeline description. Maximum length is 256 characters.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"folderId": {
|
||||
"description": "The folder ID. If not specified or null, the data pipeline is created with the workspace as its folder.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"readOnly": false
|
||||
},
|
||||
"definition": {
|
||||
"description": "The data pipeline public definition.",
|
||||
|
||||
@@ -13,7 +13,7 @@
|
||||
"/workspaces/{workspaceId}/dataPipelines": {
|
||||
"get": {
|
||||
"summary": "Returns a list of data pipelines from the specified workspace.",
|
||||
"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\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\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 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"
|
||||
],
|
||||
@@ -63,7 +63,7 @@
|
||||
},
|
||||
"post": {
|
||||
"summary": "Creates a data pipeline in the specified workspace.",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n ## Permissions \n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes\n\n DataPipeline.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations \n- To create a data pipeline, the workspace must be on a supported Fabric capacity.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\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 [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n ## Permissions \n The caller must have a *contributor* workspace role. \n\n## Required Delegated Scopes\n\n DataPipeline.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations \n- To create a data pipeline, the workspace must be on a supported Fabric capacity.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\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"
|
||||
],
|
||||
@@ -139,7 +139,7 @@
|
||||
"/workspaces/{workspaceId}/dataPipelines/{dataPipelineId}": {
|
||||
"get": {
|
||||
"summary": "Returns properties of the specified data pipeline.",
|
||||
"description": "## Permissions\n\n The caller must have *viewer* or higher workspace role. \n\n## Required Delegated Scopes\n\n DataPipeline.Read.All or DataPipeline.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 data pipeline. \n\n## Required Delegated Scopes\n\n DataPipeline.Read.All or DataPipeline.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"
|
||||
],
|
||||
@@ -187,7 +187,7 @@
|
||||
},
|
||||
"patch": {
|
||||
"summary": "Updates the properties of the specified data pipeline.",
|
||||
"description": "## Permissions\n\n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes\n\n DataPipeline.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 data pipeline. \n\n## Required Delegated Scopes\n\n DataPipeline.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"
|
||||
],
|
||||
@@ -247,7 +247,7 @@
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Deletes the specified data pipeline.",
|
||||
"description": "## Permissions\n\n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes\n\n DataPipeline.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 *write* permissions for the data pipeline. \n\n## Required Delegated Scopes\n\n DataPipeline.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"
|
||||
],
|
||||
@@ -294,7 +294,7 @@
|
||||
"/workspaces/{workspaceId}/dataPipelines/{dataPipelineId}/getDefinition": {
|
||||
"post": {
|
||||
"summary": "Returns the specified data pipeline public definition.",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a DataPipeline's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *contributor* or higher workspace role.\n## Required Delegated Scopes\n\n DataPipeline.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": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a DataPipeline'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 data pipeline.\n## Required Delegated Scopes\n\n DataPipeline.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"
|
||||
],
|
||||
@@ -370,7 +370,7 @@
|
||||
"/workspaces/{workspaceId}/dataPipelines/{dataPipelineId}/updateDefinition": {
|
||||
"post": {
|
||||
"summary": "Overrides the definition for the specified data pipeline.",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n \nUpdating the DataPipeline's definition, does not affect its sensitivity label. \n\n## Permissions\n\n The API caller must have *contributor* or higher workspace role.\n## Required Delegated Scopes\n\n DataPipeline.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": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n \nUpdating the DataPipeline's definition, does not affect its sensitivity label. \n\n## Permissions\n\n The caller must have *read and write* permissions for the data pipeline.\n## Required Delegated Scopes\n\n DataPipeline.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"
|
||||
],
|
||||
|
||||
@@ -0,0 +1,209 @@
|
||||
{
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"title": "Dataflow data types",
|
||||
"version": "v1"
|
||||
},
|
||||
"paths": {},
|
||||
"definitions": {
|
||||
"Dataflow": {
|
||||
"description": "A Dataflow object.",
|
||||
"type": "object",
|
||||
"required": [ "type" ],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "../common/definitions.json#/definitions/Item"
|
||||
}
|
||||
]
|
||||
},
|
||||
"Dataflows": {
|
||||
"description": "A list of Dataflows.",
|
||||
"required": [ "value" ],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"value": {
|
||||
"description": "A list of Dataflows.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/Dataflow"
|
||||
}
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
|
||||
}
|
||||
]
|
||||
},
|
||||
"CreateDataflowRequest": {
|
||||
"description": "Create Dataflow request payload.",
|
||||
"required": [ "displayName" ],
|
||||
"properties": {
|
||||
"displayName": {
|
||||
"description": "The Dataflow display name. The display name must follow naming rules according to item type.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"description": {
|
||||
"description": "The Dataflow description. Maximum length is 256 characters.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"folderId": {
|
||||
"description": "The folder ID. If not specified or null, the Dataflow is created with the workspace as its folder.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"readOnly": false
|
||||
},
|
||||
"definition": {
|
||||
"description": "The Dataflow public definition.",
|
||||
"$ref": "#/definitions/DataflowDefinition",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateDataflowDefinitionRequest": {
|
||||
"description": "Update Dataflow public definition request payload.",
|
||||
"required": [ "definition" ],
|
||||
"properties": {
|
||||
"definition": {
|
||||
"$ref": "#/definitions/DataflowDefinition"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DataflowDefinitionResponse": {
|
||||
"description": "Dataflow public definition response.",
|
||||
"required": [ "definition" ],
|
||||
"properties": {
|
||||
"definition": {
|
||||
"$ref": "#/definitions/DataflowDefinition",
|
||||
"readOnly": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"DataflowDefinition": {
|
||||
"description": "Dataflow public definition object. Refer to this [article](/rest/api/fabric/articles/item-management/definitions/dataflow-definition) for more details on how to craft a Dataflow public definition.",
|
||||
"type": "object",
|
||||
"required": [ "parts" ],
|
||||
"properties": {
|
||||
"parts": {
|
||||
"description": "A list of definition parts.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/DataflowDefinitionPart"
|
||||
},
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"DataflowDefinitionPart": {
|
||||
"description": "Dataflow definition part object.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"path": {
|
||||
"description": "The Dataflow public definition part path.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"payload": {
|
||||
"description": "The Dataflow public definition part payload.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"payloadType": {
|
||||
"description": "The payload type.",
|
||||
"$ref": "../common/definitions.json#/definitions/PayloadType",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateDataflowRequest": {
|
||||
"description": "Update Dataflow request.",
|
||||
"properties": {
|
||||
"displayName": {
|
||||
"description": "The Dataflow display name. The display name must follow naming rules according to item type.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"description": {
|
||||
"description": "The Dataflow description. Maximum length is 256 characters.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"DataflowSchedule": {
|
||||
"description": "Dataflow schedule.",
|
||||
"type": "object",
|
||||
"required": [ "id", "enabled" ],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "../platform/definitions/platform.json#/definitions/ItemSchedule"
|
||||
}
|
||||
]
|
||||
},
|
||||
"CreateDataflowExecuteScheduleRequest": {
|
||||
"description": "Create dataflow execute schedule plan request payload.",
|
||||
"type": "object",
|
||||
"required": [ "enabled", "configuration" ],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "../platform/definitions/platform.json#/definitions/CreateScheduleRequest"
|
||||
}
|
||||
]
|
||||
|
||||
},
|
||||
"CreateDataflowApplyChangesScheduleRequest": {
|
||||
"description": "Create dataflow apply changes schedule plan request payload.",
|
||||
"type": "object",
|
||||
"required": [ "enabled", "configuration" ],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "../platform/definitions/platform.json#/definitions/CreateScheduleRequest"
|
||||
}
|
||||
]
|
||||
},
|
||||
"RunOnDemandDataflowExecuteJobRequest": {
|
||||
"description": "Run on demand execute dataflow job instance payload",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"executionData": {
|
||||
"description": "Payload for run on-demand execute job request. Needed only if the dataflow has parameterization enabled.",
|
||||
"$ref": "#/definitions/DataflowExecutionPayload"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DataflowExecutionPayload": {
|
||||
"description": "The execution data payload for Dataflow",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"executeOption": {
|
||||
"description": "Options to run the execute operation. Additional executeOptions may be added over time.",
|
||||
"type": "string",
|
||||
"enum": [ "SkipApplyChanges", "ApplyChangesIfNeeded" ],
|
||||
"x-ms-enum": {
|
||||
"name": "ExecuteOption",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "SkipApplyChanges",
|
||||
"description": "Default Value. Apply Changes operation is skipped."
|
||||
},
|
||||
{
|
||||
"value": "ApplyChangesIfNeeded",
|
||||
"description": "Appply Changes operation is done if needed. Can be used when the latest changes are required for Execute."
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"parameters": {
|
||||
"description": "A list of parameters to override during execution.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "../platform/definitions/platform.json#/definitions/ItemJobParameter"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,46 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"createDataflowRequest": {
|
||||
"displayName": "TestDataflow",
|
||||
"description": "A Dataflow description.",
|
||||
"definition": {
|
||||
"parts": [
|
||||
{
|
||||
"path": "queryMetadata.json",
|
||||
"payload": "ewogICJmb3JtYXRWZXJzaW9uIjogIjIwMjUwMiIsCiAgImNvbXB1dGVFbmdpbmVTZXR0aW5ncyI6IHt9LAogICJuYW1lIjogIlRlc3REYXRhZmxvdyIsCiAgInF1ZXJ5R3JvdXBzIjogW10sCiAgImRvY3VtZW50TG9jYWxlIjogImVuLVVTIiwKICAicXVlcmllc01ldGFkYXRhIjogewogICAgInF1ZXJ5IjogewogICAgICAicXVlcnlJZCI6ICJiZTE3MjEwZi01YWNhLTQyMWEtOGMwYS1iZjYzMTQ4N2JiOGUiLAogICAgICAicXVlcnlOYW1lIjogIlF1ZXJ5IgogICAgfQogIH0sCiAgImNvbm5lY3Rpb25zIjogW10KfQ==",
|
||||
"payloadType": "InlineBase64"
|
||||
},
|
||||
{
|
||||
"path": "mashup.pq",
|
||||
"payload": "W1N0YWdpbmdEZWZpbml0aW9uID0gW0tpbmQgPSAiRmFzdENvcHkiXV0Kc2VjdGlvbiBTZWN0aW9uMTsKc2hhcmVkIFF1ZXJ5ID0gbGV0CiAgU291cmNlID0gVGFibGUuRnJvbVJvd3MoSnNvbi5Eb2N1bWVudChCaW5hcnkuRGVjb21wcmVzcyhCaW5hcnkuRnJvbVRleHQoImk0NVdNbFRTVVhMT3p5bk56VE9LUjdDTmdleFluV2dsSXlSWkl5UlpJNlhZV0FBPSIsIEJpbmFyeUVuY29kaW5nLkJhc2U2NCksIENvbXByZXNzaW9uLkRlZmxhdGUpKSwgbGV0IF90ID0gKCh0eXBlIG51bGxhYmxlIHRleHQpIG1ldGEgW1NlcmlhbGl6ZWQuVGV4dCA9IHRydWVdKSBpbiB0eXBlIHRhYmxlIFtDb2x1bW4xID0gX3QsIENvbHVtbjIgPSBfdCwgQ29sdW1uMyA9IF90XSksCiAgIyJDaGFuZ2VkIGNvbHVtbiB0eXBlIiA9IFRhYmxlLlRyYW5zZm9ybUNvbHVtblR5cGVzKFNvdXJjZSwge3siQ29sdW1uMSIsIEludDY0LlR5cGV9LCB7IkNvbHVtbjIiLCB0eXBlIHRleHR9LCB7IkNvbHVtbjMiLCB0eXBlIHRleHR9fSkKaW4KICAjIkNoYW5nZWQgY29sdW1uIHR5cGUiOwo=",
|
||||
"payloadType": "InlineBase64"
|
||||
},
|
||||
{
|
||||
"path": ".platform",
|
||||
"payload": "ewogICIkc2NoZW1hIjogImh0dHBzOi8vZGV2ZWxvcGVyLm1pY3Jvc29mdC5jb20vanNvbi1zY2hlbWFzL2ZhYnJpYy9naXRJbnRlZ3JhdGlvbi9wbGF0Zm9ybVByb3BlcnRpZXMvMi4wLjAvc2NoZW1hLmpzb24iLAogICJtZXRhZGF0YSI6IHsKICAgICJ0eXBlIjogIkRhdGFmbG93IiwKICAgICJkaXNwbGF5TmFtZSI6ICJUZXN0RGF0YWZsb3ciCiAgfSwKICAiY29uZmlnIjogewogICAgInZlcnNpb24iOiAiMi4wIiwKICAgICJsb2dpY2FsSWQiOiAiZjU4ZDJmODMtYTMwMC1iMTM1LTQ3ODgtMDU5NjgzY2Q1NzFjIgogIH0KfQ==",
|
||||
"payloadType": "InlineBase64"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"201": {
|
||||
"body": {
|
||||
"displayName": "TestDataflow",
|
||||
"description": "A Dataflow description.",
|
||||
"type": "Dataflow",
|
||||
"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
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,40 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1",
|
||||
"dataflowId": "dddddddd-9999-0000-1111-eeeeeeeeeeee",
|
||||
"jobType": "ApplyChanges",
|
||||
"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/ApplyChanges/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"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,40 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1",
|
||||
"dataflowId": "dddddddd-9999-0000-1111-eeeeeeeeeeee",
|
||||
"jobType": "Execute",
|
||||
"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/Execute/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"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,27 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"createDataflowRequest": {
|
||||
"displayName": "TestDataflow",
|
||||
"description": "A Dataflow description."
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"201": {
|
||||
"body": {
|
||||
"displayName": "TestDataflow",
|
||||
"description": "A Dataflow description.",
|
||||
"type": "Dataflow",
|
||||
"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
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"dataflowId": "5b218778-e7a5-4d73-8187-f10824047715"
|
||||
},
|
||||
"responses": {
|
||||
"200": {}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,17 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
|
||||
"dataflowId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"id": "5b218778-e7a5-4d73-8187-f10824047715",
|
||||
"displayName": "TestDataflow",
|
||||
"description": "A Dataflow description.",
|
||||
"type": "Dataflow",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,38 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "6e335e92-a2a2-4b5a-970a-bd6a89fbb765",
|
||||
"dataflowId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"definition": {
|
||||
"parts": [
|
||||
{
|
||||
"path": "queryMetadata.json",
|
||||
"payload": "ewogICJmb3JtYXRWZXJzaW9uIjogIjIwMjUwMiIsCiAgImNvbXB1dGVFbmdpbmVTZXR0aW5ncyI6IHt9LAogICJuYW1lIjogIlRlc3REYXRhZmxvdyIsCiAgInF1ZXJ5R3JvdXBzIjogW10sCiAgImRvY3VtZW50TG9jYWxlIjogImVuLVVTIiwKICAicXVlcmllc01ldGFkYXRhIjogewogICAgInF1ZXJ5IjogewogICAgICAicXVlcnlJZCI6ICJiZTE3MjEwZi01YWNhLTQyMWEtOGMwYS1iZjYzMTQ4N2JiOGUiLAogICAgICAicXVlcnlOYW1lIjogIlF1ZXJ5IgogICAgfQogIH0sCiAgImNvbm5lY3Rpb25zIjogW10KfQ==",
|
||||
"payloadType": "InlineBase64"
|
||||
},
|
||||
{
|
||||
"path": "mashup.pq",
|
||||
"payload": "W1N0YWdpbmdEZWZpbml0aW9uID0gW0tpbmQgPSAiRmFzdENvcHkiXV0Kc2VjdGlvbiBTZWN0aW9uMTsKc2hhcmVkIFF1ZXJ5ID0gbGV0CiAgU291cmNlID0gVGFibGUuRnJvbVJvd3MoSnNvbi5Eb2N1bWVudChCaW5hcnkuRGVjb21wcmVzcyhCaW5hcnkuRnJvbVRleHQoImk0NVdNbFRTVVhMT3p5bk56VE9LUjdDTmdleFluV2dsSXlSWkl5UlpJNlhZV0FBPSIsIEJpbmFyeUVuY29kaW5nLkJhc2U2NCksIENvbXByZXNzaW9uLkRlZmxhdGUpKSwgbGV0IF90ID0gKCh0eXBlIG51bGxhYmxlIHRleHQpIG1ldGEgW1NlcmlhbGl6ZWQuVGV4dCA9IHRydWVdKSBpbiB0eXBlIHRhYmxlIFtDb2x1bW4xID0gX3QsIENvbHVtbjIgPSBfdCwgQ29sdW1uMyA9IF90XSksCiAgIyJDaGFuZ2VkIGNvbHVtbiB0eXBlIiA9IFRhYmxlLlRyYW5zZm9ybUNvbHVtblR5cGVzKFNvdXJjZSwge3siQ29sdW1uMSIsIEludDY0LlR5cGV9LCB7IkNvbHVtbjIiLCB0eXBlIHRleHR9LCB7IkNvbHVtbjMiLCB0eXBlIHRleHR9fSkKaW4KICAjIkNoYW5nZWQgY29sdW1uIHR5cGUiOwo=",
|
||||
"payloadType": "InlineBase64"
|
||||
},
|
||||
{
|
||||
"path": ".platform",
|
||||
"payload": "ewogICIkc2NoZW1hIjogImh0dHBzOi8vZGV2ZWxvcGVyLm1pY3Jvc29mdC5jb20vanNvbi1zY2hlbWFzL2ZhYnJpYy9naXRJbnRlZ3JhdGlvbi9wbGF0Zm9ybVByb3BlcnRpZXMvMi4wLjAvc2NoZW1hLmpzb24iLAogICJtZXRhZGF0YSI6IHsKICAgICJ0eXBlIjogIkRhdGFmbG93IiwKICAgICJkaXNwbGF5TmFtZSI6ICJUZXN0RGF0YWZsb3ciCiAgfSwKICAiY29uZmlnIjogewogICAgInZlcnNpb24iOiAiMi4wIiwKICAgICJsb2dpY2FsSWQiOiAiZjU4ZDJmODMtYTMwMC1iMTM1LTQ3ODgtMDU5NjgzY2Q1NzFjIgogIH0KfQ==",
|
||||
"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
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,27 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"value": [
|
||||
{
|
||||
"id": "3546052c-ae64-4526-b1a8-52af7761426f",
|
||||
"displayName": "TestDataflow",
|
||||
"description": "A Dataflow description.",
|
||||
"type": "Dataflow",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
|
||||
},
|
||||
{
|
||||
"id": "f697fb63-abd4-4399-9548-be7e3c3c0dac",
|
||||
"displayName": "TestDataflow",
|
||||
"description": "A Dataflow description.",
|
||||
"type": "Dataflow",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,15 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1",
|
||||
"dataflowId": "dddddddd-9999-0000-1111-eeeeeeeeeeee",
|
||||
"jobType": "ApplyChanges"
|
||||
},
|
||||
"responses": {
|
||||
"202": {
|
||||
"headers": {
|
||||
"Location": "https://api.fabric.microsoft.com/v1/workspaces/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/items/dddddddd-9999-0000-1111-eeeeeeeeeeee/jobs/instances/bbbbbbbb-1111-2222-3333-cccccccccccc",
|
||||
"Retry-After": 60
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,15 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1",
|
||||
"dataflowId": "dddddddd-9999-0000-1111-eeeeeeeeeeee",
|
||||
"jobType": "Execute"
|
||||
},
|
||||
"responses": {
|
||||
"202": {
|
||||
"headers": {
|
||||
"Location": "https://api.fabric.microsoft.com/v1/workspaces/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/items/dddddddd-9999-0000-1111-eeeeeeeeeeee/jobs/instances/bbbbbbbb-1111-2222-3333-cccccccccccc",
|
||||
"Retry-After": 60
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,32 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1",
|
||||
"dataflowId": "dddddddd-9999-0000-1111-eeeeeeeeeeee",
|
||||
"jobType": "Execute",
|
||||
"runOnDemandItemJobRequest": {
|
||||
"executionData": {
|
||||
"executeOption": "ApplyChangesIfNeeded",
|
||||
"parameters": [
|
||||
{
|
||||
"parameterName": "OrderKey",
|
||||
"type": "Automatic",
|
||||
"value": 25
|
||||
},
|
||||
{
|
||||
"parameterName": "Threshold",
|
||||
"type": "Automatic",
|
||||
"value": "start"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"202": {
|
||||
"headers": {
|
||||
"Location": "https://api.fabric.microsoft.com/v1/workspaces/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/items/dddddddd-9999-0000-1111-eeeeeeeeeeee/jobs/instances/bbbbbbbb-1111-2222-3333-cccccccccccc",
|
||||
"Retry-After": 60
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,21 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"dataflowId": "5b218778-e7a5-4d73-8187-f10824047715",
|
||||
"updateDataflowRequest": {
|
||||
"displayName": "Dataflow's New name",
|
||||
"description": "Dataflow's New description"
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"displayName": "Dataflow's New name",
|
||||
"description": "Dataflow's New description",
|
||||
"type": "Dataflow",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"id": "5b218778-e7a5-4d73-8187-f10824047715"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,39 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"dataflowId": "5b218778-e7a5-4d73-8187-f10824047715",
|
||||
"updateMetadata": true,
|
||||
"updateDataflowDefinitionRequest": {
|
||||
"definition": {
|
||||
"parts": [
|
||||
{
|
||||
"path": "queryMetadata.json",
|
||||
"payload": "ewogICJmb3JtYXRWZXJzaW9uIjogIjIwMjUwMiIsCiAgImNvbXB1dGVFbmdpbmVTZXR0aW5ncyI6IHt9LAogICJuYW1lIjogIlRlc3REYXRhZmxvdyIsCiAgInF1ZXJ5R3JvdXBzIjogW10sCiAgImRvY3VtZW50TG9jYWxlIjogImVuLVVTIiwKICAicXVlcmllc01ldGFkYXRhIjogewogICAgInF1ZXJ5IjogewogICAgICAicXVlcnlJZCI6ICJiZTE3MjEwZi01YWNhLTQyMWEtOGMwYS1iZjYzMTQ4N2JiOGUiLAogICAgICAicXVlcnlOYW1lIjogIlF1ZXJ5IgogICAgfQogIH0sCiAgImNvbm5lY3Rpb25zIjogW10KfQ==",
|
||||
"payloadType": "InlineBase64"
|
||||
},
|
||||
{
|
||||
"path": "mashup.pq",
|
||||
"payload": "W1N0YWdpbmdEZWZpbml0aW9uID0gW0tpbmQgPSAiRmFzdENvcHkiXV0Kc2VjdGlvbiBTZWN0aW9uMTsKc2hhcmVkIFF1ZXJ5ID0gbGV0CiAgU291cmNlID0gVGFibGUuRnJvbVJvd3MoSnNvbi5Eb2N1bWVudChCaW5hcnkuRGVjb21wcmVzcyhCaW5hcnkuRnJvbVRleHQoImk0NVdNbFRTVVhMT3p5bk56VE9LUjdDTmdleFluV2dsSXlSWkl5UlpJNlhZV0FBPSIsIEJpbmFyeUVuY29kaW5nLkJhc2U2NCksIENvbXByZXNzaW9uLkRlZmxhdGUpKSwgbGV0IF90ID0gKCh0eXBlIG51bGxhYmxlIHRleHQpIG1ldGEgW1NlcmlhbGl6ZWQuVGV4dCA9IHRydWVdKSBpbiB0eXBlIHRhYmxlIFtDb2x1bW4xID0gX3QsIENvbHVtbjIgPSBfdCwgQ29sdW1uMyA9IF90XSksCiAgIyJDaGFuZ2VkIGNvbHVtbiB0eXBlIiA9IFRhYmxlLlRyYW5zZm9ybUNvbHVtblR5cGVzKFNvdXJjZSwge3siQ29sdW1uMSIsIEludDY0LlR5cGV9LCB7IkNvbHVtbjIiLCB0eXBlIHRleHR9LCB7IkNvbHVtbjMiLCB0eXBlIHRleHR9fSkKaW4KICAjIkNoYW5nZWQgY29sdW1uIHR5cGUiOwo=",
|
||||
"payloadType": "InlineBase64"
|
||||
},
|
||||
{
|
||||
"path": ".platform",
|
||||
"payload": "ewogICIkc2NoZW1hIjogImh0dHBzOi8vZGV2ZWxvcGVyLm1pY3Jvc29mdC5jb20vanNvbi1zY2hlbWFzL2ZhYnJpYy9naXRJbnRlZ3JhdGlvbi9wbGF0Zm9ybVByb3BlcnRpZXMvMi4wLjAvc2NoZW1hLmpzb24iLAogICJtZXRhZGF0YSI6IHsKICAgICJ0eXBlIjogIkRhdGFmbG93IiwKICAgICJkaXNwbGF5TmFtZSI6ICJUZXN0RGF0YWZsb3ciCiAgfSwKICAiY29uZmlnIjogewogICAgInZlcnNpb24iOiAiMi4wIiwKICAgICJsb2dpY2FsSWQiOiAiZjU4ZDJmODMtYTMwMC1iMTM1LTQ3ODgtMDU5NjgzY2Q1NzFjIgogIH0KfQ==",
|
||||
"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
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,719 @@
|
||||
{
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"title": "Dataflow REST APIs",
|
||||
"version": "v1"
|
||||
},
|
||||
"schemes": [
|
||||
"https"
|
||||
],
|
||||
"host": "api.fabric.microsoft.com",
|
||||
"basePath": "/v1",
|
||||
"paths": {
|
||||
"/workspaces/{workspaceId}/dataflows": {
|
||||
"get": {
|
||||
"summary": "Returns a list of Dataflows from the specified workspace.",
|
||||
"description": "This API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\n The caller must have a *viewer* workspace role. \n\n## Required Delegated Scopes\n\nWorkspace.Read.All or Workspace.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_ListDataflows",
|
||||
"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/Dataflows"
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* InvalidItemType - Invalid item type.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"List Dataflows in workspace example": {
|
||||
"$ref": "./examples/ListDataflowsInWorkspace.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"post": {
|
||||
"summary": "Creates a Dataflow in the specified workspace.",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n To create Dataflow with a public definition, refer to [Dataflow](/rest/api/fabric/articles/item-management/definitions/dataflow-definition) article. \n\n ## Permissions \n The caller must have a *contributor* workspace role. \n\n## Required Delegated Scopes\n\n Dataflow.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations \n- To create a Dataflow 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_CreateDataflow",
|
||||
"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": "createDataflowRequest",
|
||||
"description": "Create item request payload.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/CreateDataflowRequest"
|
||||
},
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"201": {
|
||||
"description": "Successfully created",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/Dataflow"
|
||||
}
|
||||
},
|
||||
"202": {
|
||||
"description": "Request accepted, Dataflow provisioning in progress.",
|
||||
"headers": {
|
||||
"Location": {
|
||||
"description": "The URL of the operation status, which can be used to track the operation state.",
|
||||
"type": "string"
|
||||
},
|
||||
"x-ms-operation-id": {
|
||||
"description": "The operation ID which can be used with long running operations (LRO) APIs to track the operation state and get the result.",
|
||||
"type": "string",
|
||||
"format": "uuid"
|
||||
},
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* InvalidItemType - Item type is invalid\n\n* ItemDisplayNameAlreadyInUse - Item display name is already used.\n\n* CorruptedPayload - The provided payload is corrupted.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Create a Dataflow example": {
|
||||
"$ref": "./examples/CreateDataflowWithoutDefinition.json"
|
||||
},
|
||||
"Create a Dataflow with public definition example": {
|
||||
"$ref": "./examples/CreateDataflow.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/dataflows/{dataflowId}": {
|
||||
"get": {
|
||||
"summary": "Returns properties of the specified Dataflow.",
|
||||
"description": "## Permissions\n\n The caller must have *read* permissions for the dataflow. \n\n## Required Delegated Scopes\n\n Dataflow.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_GetDataflow",
|
||||
"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
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/Dataflow"
|
||||
}
|
||||
},
|
||||
"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 Dataflow example": {
|
||||
"$ref": "./examples/GetDataflow.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"patch": {
|
||||
"summary": "Updates the properties of the specified Dataflow.",
|
||||
"description": "## Permissions\n\n The caller must have *read and write* permissions for the dataflow.\n\n## Required Delegated Scopes\n\n Dataflow.ReadWrite.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_UpdateDataflow",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"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": "body",
|
||||
"name": "updateDataflowRequest",
|
||||
"description": "Update Dataflow request payload.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/UpdateDataflowRequest"
|
||||
},
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/Dataflow"
|
||||
}
|
||||
},
|
||||
"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 Dataflow example": {
|
||||
"$ref": "./examples/UpdateDataflow.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Deletes the specified Dataflow.",
|
||||
"description": "## Permissions\n\n The caller must have *write* permissions for the dataflow. \n\n## Required Delegated Scopes\n\n Dataflow.ReadWrite.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_DeleteDataflow",
|
||||
"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
|
||||
}
|
||||
],
|
||||
"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 Dataflow example": {
|
||||
"$ref": "./examples/DeleteDataflow.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/dataflows/{dataflowId}/getDefinition": {
|
||||
"post": {
|
||||
"summary": "Returns the specified Dataflow public definition.",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a Dataflow'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 dataflow.\n## Required Delegated Scopes\n\n Dataflow.ReadWrite.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_GetDataflowDefinition",
|
||||
"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": "dataflowId",
|
||||
"description": "The Dataflow ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/DataflowDefinitionResponse"
|
||||
}
|
||||
},
|
||||
"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 Dataflow public definition example": {
|
||||
"$ref": "./examples/GetDataflowDefinition.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/dataflows/{dataflowId}/updateDefinition": {
|
||||
"post": {
|
||||
"summary": "Overrides the definition for the specified Dataflow.",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n \nUpdating the Dataflow's definition, does not affect its sensitivity label. \n\n## Permissions\n\n The caller must have *read and write* permissions for the dataflow. \n## Required Delegated Scopes\n\n Dataflow.ReadWrite.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_UpdateDataflowDefinition",
|
||||
"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": "dataflowId",
|
||||
"description": "The Dataflow 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": "updateDataflowDefinitionRequest",
|
||||
"description": "Update Dataflow definition request payload.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/UpdateDataflowDefinitionRequest"
|
||||
},
|
||||
"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 Dataflow public definition example": {
|
||||
"$ref": "./examples/UpdateDataflowDefinition.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",
|
||||
"tags": [
|
||||
"BackgroundJobs"
|
||||
],
|
||||
"operationId": "BackgroundJobs_ScheduleExecute",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "workspaceId",
|
||||
"description": "The workspace ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "dataflowId",
|
||||
"description": "The item ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "body",
|
||||
"name": "createScheduleRequest",
|
||||
"description": "A dataflow execute schedule create request.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/CreateDataflowExecuteScheduleRequest"
|
||||
},
|
||||
"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/DataflowSchedule"
|
||||
}
|
||||
},
|
||||
"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 dataflow Execute schedule example": {
|
||||
"$ref": "./examples/CreateDataflowExecuteSchedule.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/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",
|
||||
"tags": [
|
||||
"BackgroundJobs"
|
||||
],
|
||||
"operationId": "BackgroundJobs_ScheduleApplyChanges",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "workspaceId",
|
||||
"description": "The workspace ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "dataflowId",
|
||||
"description": "The item ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "body",
|
||||
"name": "createScheduleRequest",
|
||||
"description": "A apply changes dataflow schedule create request.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/CreateDataflowApplyChangesScheduleRequest"
|
||||
},
|
||||
"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/DataflowSchedule"
|
||||
}
|
||||
},
|
||||
"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 dataflow ApplyChanges schedule example": {
|
||||
"$ref": "./examples/CreateDataflowApplyChangesSchedule.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/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",
|
||||
"tags": [
|
||||
"BackgroundJobs"
|
||||
],
|
||||
"operationId": "BackgroundJobs_RunOnDemandExecute",
|
||||
"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": "jobType",
|
||||
"description": "*Execute* job type. *Refresh* can also be used as an alias for *Execute*.",
|
||||
"type": "string",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "body",
|
||||
"name": "runOnDemandItemJobRequest",
|
||||
"description": "Run on-demand item job request payload.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/RunOnDemandDataflowExecuteJobRequest"
|
||||
},
|
||||
"required": false
|
||||
}
|
||||
],
|
||||
"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* InsufficientPrivileges - 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 requests too many on-demand job requests.\n\n* ItemNotFound - Requested item ID not found.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Run dataflow Execute job instance with no request body example": {
|
||||
"$ref": "./examples/RunOnDemandDataflowExecuteJob.json"
|
||||
},
|
||||
"Run dataflow Execute job instance with request body containing parameters example": {
|
||||
"$ref": "./examples/RunOnDemandDataflowExecuteJobWithParameters.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/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",
|
||||
"tags": [
|
||||
"BackgroundJobs"
|
||||
],
|
||||
"operationId": "BackgroundJobs_RunOnDemandApplyChanges",
|
||||
"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": "jobType",
|
||||
"description": "*ApplyChanges* 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* InsufficientPrivileges - 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 requests too many on-demand job requests.\n\n* ItemNotFound - Requested item ID not found.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Run dataflow ApplyChanges job instance example": {
|
||||
"$ref": "./examples/RunOnDemandDataflowApplyChangesJob.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {},
|
||||
"security": [],
|
||||
"tags": []
|
||||
}
|
||||
@@ -13,7 +13,7 @@
|
||||
"/workspaces/{workspaceId}/datamarts": {
|
||||
"get": {
|
||||
"summary": "Returns a list of datamarts from the specified workspace.",
|
||||
"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\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
|
||||
"description": "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",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
|
||||
@@ -0,0 +1,135 @@
|
||||
{
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"version": "v1",
|
||||
"title": "DigitalTwinBuilder data types"
|
||||
},
|
||||
"paths": {},
|
||||
"definitions": {
|
||||
"DigitalTwinBuilders": {
|
||||
"description": "A list of digitaltwinbuilders.",
|
||||
"required": [ "value" ],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"value": {
|
||||
"description": "A list of digitaltwinbuilders.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/DigitalTwinBuilder"
|
||||
}
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
|
||||
}
|
||||
]
|
||||
},
|
||||
"DigitalTwinBuilder": {
|
||||
"description": "An digitaltwinbuilder object.",
|
||||
"type": "object",
|
||||
"required": [ "type" ],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "../common/definitions.json#/definitions/Item"
|
||||
}
|
||||
]
|
||||
},
|
||||
"CreateDigitalTwinBuilderRequest": {
|
||||
"description": "Create digitaltwinbuilder request payload.",
|
||||
"required": [ "displayName" ],
|
||||
"properties": {
|
||||
"displayName": {
|
||||
"description": "The digitaltwinbuilder display name. The display name must follow naming rules according to item type i.e., It should start with letter, only has numbers and letters or _ and is less than 100.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"description": {
|
||||
"description": "The digitaltwinbuilder description. Maximum length is 256 characters.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"definition": {
|
||||
"description": "The [DigitalTwinBuilder public definition](/rest/api/fabric/articles/item-management/definitions/digital-twin-builder-definition).",
|
||||
"$ref": "#/definitions/DigitalTwinBuilderDefinition",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateDigitalTwinBuilderDefinitionRequest": {
|
||||
"description": "Update digitaltwinbuilder public definition request payload.",
|
||||
"required": [ "definition" ],
|
||||
"properties": {
|
||||
"definition": {
|
||||
"$ref": "#/definitions/DigitalTwinBuilderDefinition"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DigitalTwinBuilderDefinitionResponse": {
|
||||
"description": "DigitalTwinBuilder public definition response.",
|
||||
"required": [ "definition" ],
|
||||
"properties": {
|
||||
"definition": {
|
||||
"$ref": "#/definitions/DigitalTwinBuilderDefinition",
|
||||
"readOnly": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"DigitalTwinBuilderDefinition": {
|
||||
"description": "DigitalTwinBuilder 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/DigitalTwinBuilderDefinitionPart"
|
||||
},
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"DigitalTwinBuilderDefinitionPart": {
|
||||
"description": "DigitalTwinBuilder definition part object.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"path": {
|
||||
"description": "The DigitalTwinBuilder part path.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"payload": {
|
||||
"description": "The DigitalTwinBuilder part payload.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"payloadType": {
|
||||
"description": "The payload type.",
|
||||
"$ref": "../common/definitions.json#/definitions/PayloadType",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateDigitalTwinBuilderRequest": {
|
||||
"description": "Update DigitalTwinBuilder request.",
|
||||
"properties": {
|
||||
"displayName": {
|
||||
"description": "The DigitalTwinBuilder display name. The display name must follow naming rules according to item type.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"description": {
|
||||
"description": "The DigitalTwinBuilder description. Maximum length is 256 characters.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,27 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"createDigitalTwinBuilderRequest": {
|
||||
"displayName": "DigitalTwinBuilder 1",
|
||||
"description": "A digitaltwinbuilder description."
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"201": {
|
||||
"body": {
|
||||
"displayName": "DigitalTwinBuilder 1",
|
||||
"description": "A digitaltwinbuilder description.",
|
||||
"type": "DigitalTwinBuilder",
|
||||
"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
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,41 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"createDigitalTwinBuilderRequest": {
|
||||
"displayName": "DigitalTwinBuilder_1",
|
||||
"description": "An digitaltwinbuilder description.",
|
||||
"definition": {
|
||||
"parts": [
|
||||
{
|
||||
"path": "definition.json",
|
||||
"payload": "ew0KICAibGFrZWhvdXNlSWQiOiAiYjliNWQzNmYtNDQ0NS00MDNiLWFjODctMDE2YjFjZDIwMjExIg0KfQ==",
|
||||
"payloadType": "InlineBase64"
|
||||
},
|
||||
{
|
||||
"path": ".platform",
|
||||
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
|
||||
"payloadType": "InlineBase64"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"201": {
|
||||
"body": {
|
||||
"displayName": "DigitalTwinBuilder_1",
|
||||
"description": "An digitaltwinbuilder description.",
|
||||
"type": "DigitalTwinBuilder",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"id": "5b218778-e7a5-4d73-8187-f10824047655"
|
||||
}
|
||||
},
|
||||
"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
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"digitaltwinbuilderId": "5b218778-e7a5-4d73-8187-f10824047715"
|
||||
},
|
||||
"responses": {
|
||||
"200": {}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,17 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"digitaltwinbuilderId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"id": "5b218778-e7a5-4d73-8187-f10824047715",
|
||||
"displayName": "DigitalTwinBuilder 1",
|
||||
"description": "A digitaltwinbuilder description.",
|
||||
"type": "DigitalTwinBuilder",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,33 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"digitaltwinbuilderId": "5b218778-e7a5-4d73-8187-f10824047715"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"definition": {
|
||||
"parts": [
|
||||
{
|
||||
"path": "definition.json",
|
||||
"payload": "ew0KICAibGFrZWhvdXNlSWQiOiAiYjliNWQzNmYtNDQ0NS00MDNiLWFjODctMDE2YjFjZDIwMjExIg0KfQ==",
|
||||
"payloadType": "InlineBase64"
|
||||
},
|
||||
{
|
||||
"path": ".platform",
|
||||
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
|
||||
"payloadType": "InlineBase64"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"202": {
|
||||
"headers": {
|
||||
"Location": "https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6",
|
||||
"x-ms-operation-id": "0acd697c-1550-43cd-b998-91bfbfbd47c6",
|
||||
"Retry-After": 30
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,27 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"value": [
|
||||
{
|
||||
"id": "3546052c-ae64-4526-b1a8-52af7761426f",
|
||||
"displayName": "DigitalTwinBuilder Name 1",
|
||||
"description": "A digitaltwinbuilder description.",
|
||||
"type": "DigitalTwinBuilder",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
|
||||
},
|
||||
{
|
||||
"id": "f697fb63-abd4-4399-9548-be7e3c3c0dac",
|
||||
"displayName": "DigitalTwinBuilder Name 2",
|
||||
"description": "A digitaltwinbuilder description.",
|
||||
"type": "DigitalTwinBuilder",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,21 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"digitaltwinbuilderId": "5b218778-e7a5-4d73-8187-f10824047715",
|
||||
"updateDigitalTwinBuilderRequest": {
|
||||
"displayName": "DigitalTwinBuilder_New_Name",
|
||||
"description": "A new description for digitaltwinbuilder."
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"displayName": "DigitalTwinBuilder_New_Name",
|
||||
"description": "A new description for digitaltwinbuilder.",
|
||||
"type": "DigitalTwinBuilder",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"id": "5b218778-e7a5-4d73-8187-f10824047715"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,33 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"digitaltwinbuilderId": "5b218778-e7a5-4d73-8187-f10824047715",
|
||||
"updateMetadata": true,
|
||||
"updateDigitalTwinBuilderDefinitionRequest": {
|
||||
"definition": {
|
||||
"parts": [
|
||||
{
|
||||
"path": "definition.json",
|
||||
"payload": "ew0KICAibGFrZWhvdXNlSWQiOiAiYjliNWQzNmYtNDQ0NS00MDNiLWFjODctMDE2YjFjZDIwMjExIg0KfQ==",
|
||||
"payloadType": "InlineBase64"
|
||||
},
|
||||
{
|
||||
"path": ".platform",
|
||||
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
|
||||
"payloadType": "InlineBase64"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {},
|
||||
"202": {
|
||||
"headers": {
|
||||
"Location": "https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6",
|
||||
"x-ms-operation-id": "0acd697c-1550-43cd-b998-91bfbfbd47c6",
|
||||
"Retry-After": 30
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,456 @@
|
||||
{
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"title": "DigitalTwinBuilder REST APIs",
|
||||
"version": "v1"
|
||||
},
|
||||
"schemes": [
|
||||
"https"
|
||||
],
|
||||
"host": "api.fabric.microsoft.com",
|
||||
"basePath": "/v1",
|
||||
"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",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_ListDigitalTwinBuilders",
|
||||
"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/DigitalTwinBuilders"
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* InvalidItemType - Invalid item type",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"List digitaltwinbuilders in workspace example": {
|
||||
"$ref": "./examples/ListDigitalTwinBuildersInWorkspace.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"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",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_CreateDigitalTwinBuilder",
|
||||
"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": "createDigitalTwinBuilderRequest",
|
||||
"description": "Create item request payload.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/CreateDigitalTwinBuilderRequest"
|
||||
},
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"201": {
|
||||
"description": "Successfully created",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/DigitalTwinBuilder"
|
||||
}
|
||||
},
|
||||
"202": {
|
||||
"description": "Request accepted, digitaltwinbuilder 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, 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 digitaltwinbuilder example": {
|
||||
"$ref": "./examples/CreateDigitalTwinBuilder.json"
|
||||
},
|
||||
"Create a digitaltwinbuilder with public definition example": {
|
||||
"$ref": "./examples/CreateDigitalTwinBuilderWithDefinition.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/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",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_GetDigitalTwinBuilder",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "workspaceId",
|
||||
"description": "The workspace ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "digitaltwinbuilderId",
|
||||
"description": "The digitaltwinbuilder ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/DigitalTwinBuilder"
|
||||
}
|
||||
},
|
||||
"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 digitaltwinbuilder example": {
|
||||
"$ref": "./examples/GetDigitalTwinBuilder.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"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",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_UpdateDigitalTwinBuilder",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "workspaceId",
|
||||
"description": "The workspace ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "digitaltwinbuilderId",
|
||||
"description": "The digitaltwinbuilder ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "body",
|
||||
"name": "updateDigitalTwinBuilderRequest",
|
||||
"description": "Update digitaltwinbuilder request payload.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/UpdateDigitalTwinBuilderRequest"
|
||||
},
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/DigitalTwinBuilder"
|
||||
}
|
||||
},
|
||||
"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 digitaltwinbuilder example": {
|
||||
"$ref": "./examples/UpdateDigitalTwinBuilder.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"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",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_DeleteDigitalTwinBuilder",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "workspaceId",
|
||||
"description": "The workspace ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "digitaltwinbuilderId",
|
||||
"description": "The digitaltwinbuilder 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 digitaltwinbuilder example": {
|
||||
"$ref": "./examples/DeleteDigitalTwinBuilder.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/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",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_GetDigitalTwinBuilderDefinition",
|
||||
"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": "digitaltwinbuilderId",
|
||||
"description": "The digitaltwinbuilder ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "format",
|
||||
"description": "The format of the DigitalTwinBuilder public definition.",
|
||||
"type": "string",
|
||||
"required": false
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/DigitalTwinBuilderDefinitionResponse"
|
||||
}
|
||||
},
|
||||
"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 digitaltwinbuilder definition example": {
|
||||
"$ref": "./examples/GetDigitalTwinBuilderDefinition.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/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",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_UpdateDigitalTwinBuilderDefinition",
|
||||
"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": "digitaltwinbuilderId",
|
||||
"description": "The digitaltwinbuilder ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "updateMetadata",
|
||||
"description": "Whether to update the item's metadata if it is provided in the `.platform` file. True - Update the metadata if it is provided in the `.platform` file as part of the definition, False - Do not update the metadata.",
|
||||
"type": "boolean",
|
||||
"required": false
|
||||
},
|
||||
{
|
||||
"in": "body",
|
||||
"name": "updateDigitalTwinBuilderDefinitionRequest",
|
||||
"description": "Update digitaltwinbuilder definition request payload.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/UpdateDigitalTwinBuilderDefinitionRequest"
|
||||
},
|
||||
"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 digitaltwinbuilder definition example": {
|
||||
"$ref": "./examples/UpdateDigitalTwinBuilderDefinition.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {},
|
||||
"security": [],
|
||||
"tags": []
|
||||
}
|
||||
@@ -0,0 +1,163 @@
|
||||
{
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"title": "DigitalTwinBuilderFlow data types",
|
||||
"version": "v1"
|
||||
},
|
||||
"paths": {},
|
||||
"definitions": {
|
||||
"DigitalTwinBuilderFlow": {
|
||||
"description": "A Digital Twin Builder Flow object.",
|
||||
"type": "object",
|
||||
"required": ["type"],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "../common/definitions.json#/definitions/Item"
|
||||
}
|
||||
],
|
||||
"properties": {
|
||||
"properties": {
|
||||
"description": "The Digital Twin Builder Flow properties.",
|
||||
"$ref": "#/definitions/DigitalTwinBuilderFlowProperties"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DigitalTwinBuilderFlowProperties": {
|
||||
"description": "The Digital Twin Builder Flow properties.",
|
||||
"type": "object",
|
||||
"required": ["digitalTwinBuilderItemReference"],
|
||||
"properties": {
|
||||
"digitalTwinBuilderItemReference": {
|
||||
"description": "The Digital Twin Builder Item Reference.",
|
||||
"$ref": "../common/definitions.json#/definitions/ItemReference"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DigitalTwinBuilderFlows": {
|
||||
"description": "A list of Digital Twin Builder Flows.",
|
||||
"required": ["value"],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"value": {
|
||||
"description": "A list of Digital Twin Builder Flows.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/DigitalTwinBuilderFlow"
|
||||
}
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
|
||||
}
|
||||
]
|
||||
},
|
||||
"DigitalTwinBuilderFlowCreationPayload": {
|
||||
"description": "The Digital Twin Builder Flow creation payload.",
|
||||
"type": "object",
|
||||
"required": ["digitalTwinBuilderItemReference"],
|
||||
"properties": {
|
||||
"digitalTwinBuilderItemReference": {
|
||||
"description": "The Digital Twin Builder Item Reference.",
|
||||
"$ref": "../common/definitions.json#/definitions/ItemReference"
|
||||
}
|
||||
}
|
||||
},
|
||||
"CreateDigitalTwinBuilderFlowRequest": {
|
||||
"description": "Create Digital Twin Builder Flow request payload.",
|
||||
"required": ["displayName"],
|
||||
"properties": {
|
||||
"displayName": {
|
||||
"description": "The Digital Twin Builder Flow display name. The display name must follow naming rules according to item type.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"description": {
|
||||
"description": "The Digital Twin Builder Flow description. Maximum length is 256 characters.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"creationPayload": {
|
||||
"description": "The creation payload. Use `definition` or `creationPayload`. You can't use both at the same time.",
|
||||
"$ref": "#/definitions/DigitalTwinBuilderFlowCreationPayload",
|
||||
"readOnly": false
|
||||
},
|
||||
"definition": {
|
||||
"description": "The Digital Twin Builder Flow public definition.",
|
||||
"$ref": "#/definitions/DigitalTwinBuilderFlowPublicDefinition",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateDigitalTwinBuilderFlowDefinitionRequest": {
|
||||
"description": "Update Digital Twin Builder Flow public definition request payload.",
|
||||
"required": ["definition"],
|
||||
"properties": {
|
||||
"definition": {
|
||||
"$ref": "#/definitions/DigitalTwinBuilderFlowPublicDefinition"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DigitalTwinBuilderFlowDefinitionResponse": {
|
||||
"description": "The Digital Twin Builder Flow public definition response.",
|
||||
"required": ["definition"],
|
||||
"properties": {
|
||||
"definition": {
|
||||
"$ref": "#/definitions/DigitalTwinBuilderFlowPublicDefinition",
|
||||
"readOnly": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"DigitalTwinBuilderFlowPublicDefinition" : {
|
||||
"description": "The Digital Twin Builder Flow public definition object. Refer to this [article](/rest/api/fabric/articles/item-management/definitions/digital-twin-builder-flow-definition) for more details on how to craft a Digital Twin Builder Flow public definition.",
|
||||
"type": "object",
|
||||
"required": ["parts"],
|
||||
"properties": {
|
||||
"parts": {
|
||||
"description": "A list of definition parts.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/DigitalTwinBuilderFlowPublicDefinitionPart"
|
||||
},
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"DigitalTwinBuilderFlowPublicDefinitionPart": {
|
||||
"description": "Digital Twin Builder Flow definition part object.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"path": {
|
||||
"description": "The Digital Twin Builder Flow public definition part path.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"payload": {
|
||||
"description": "The Digital Twin Builder Flow public definition part payload.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"payloadType":{
|
||||
"description": "The payload type.",
|
||||
"$ref": "../common/definitions.json#/definitions/PayloadType",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateDigitalTwinBuilderFlowRequest": {
|
||||
"description": "Update Digital Twin Builder Flow request.",
|
||||
"properties": {
|
||||
"displayName": {
|
||||
"description": "The Digital Twin Builder Flow display name. The display name must follow naming rules according to item type.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"description": {
|
||||
"description": "The Digital Twin Builder Flow description. Maximum length is 256 characters.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,41 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"createDigitalTwinBuilderFlowRequest": {
|
||||
"displayName": "DigitalTwinBuilderFlow 1",
|
||||
"description": "A Digital Twin Builder Flow description.",
|
||||
"definition": {
|
||||
"parts": [
|
||||
{
|
||||
"path": "definition.json",
|
||||
"payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
|
||||
"payloadType": "InlineBase64"
|
||||
},
|
||||
{
|
||||
"path": ".platform",
|
||||
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
|
||||
"payloadType": "InlineBase64"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"201": {
|
||||
"body": {
|
||||
"displayName": "DigitalTwinBuilderFlow 1",
|
||||
"description": "A Digital Twin Builder Flow description.",
|
||||
"type": "DigitalTwinBuilderFlow",
|
||||
"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
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,34 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"createDigitalTwinBuilderFlowRequest": {
|
||||
"displayName": "DigitalTwinBuilderFlow 1",
|
||||
"description": "A Digital Twin Builder Flow description.",
|
||||
"creationPayload": {
|
||||
"digitalTwinBuilderItemReference": {
|
||||
"referenceType": "ById",
|
||||
"itemId": "d96de2f4-7dd1-45ad-9ff6-37a2d6aa9861",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"201": {
|
||||
"body": {
|
||||
"displayName": "DigitalTwinBuilderFlow 1",
|
||||
"description": "A Digital Twin Builder Flow description.",
|
||||
"type": "DigitalTwinBuilderFlow",
|
||||
"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
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"digitalTwinBuilderFlowId": "5b218778-e7a5-4d73-8187-f10824047715"
|
||||
},
|
||||
"responses": {
|
||||
"200": {}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,24 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
|
||||
"digitalTwinBuilderFlowId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"id": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
|
||||
"displayName": "DigitalTwinBuilderFlow 1",
|
||||
"description": "A Digital Twin Builder Flow description.",
|
||||
"type": "DigitalTwinBuilderFlow",
|
||||
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
|
||||
"properties": {
|
||||
"digitalTwinBuilderItemReference": {
|
||||
"referenceType": "ById",
|
||||
"itemId": "d96de2f4-7dd1-45ad-9ff6-37a2d6aa9861",
|
||||
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,33 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "6e335e92-a2a2-4b5a-970a-bd6a89fbb765",
|
||||
"digitalTwinBuilderFlowId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"definition": {
|
||||
"parts": [
|
||||
{
|
||||
"path": "definition.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
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,41 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"value": [
|
||||
{
|
||||
"id": "3546052c-ae64-4526-b1a8-52af7761426f",
|
||||
"displayName": "DigitalTwinBuilderFlow Name 1",
|
||||
"description": "A Digital Twin Builder Flow description.",
|
||||
"type": "DigitalTwinBuilderFlow",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"properties": {
|
||||
"digitalTwinBuilderItemReference": {
|
||||
"referenceType": "ById",
|
||||
"itemId": "d96de2f4-7dd1-45ad-9ff6-37a2d6aa9861",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "f697fb63-abd4-4399-9548-be7e3c3c0dac",
|
||||
"displayName": "DigitalTwinBuilderFlow Name 2",
|
||||
"description": "A Digital Twin Builder Flow description.",
|
||||
"type": "DigitalTwinBuilderFlow",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"properties": {
|
||||
"digitalTwinBuilderItemReference": {
|
||||
"referenceType": "ById",
|
||||
"itemId": "d96de2f4-7dd1-45ad-9ff6-37a2d6aa9861",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,21 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"digitalTwinBuilderFlowId": "5b218778-e7a5-4d73-8187-f10824047715",
|
||||
"updateDigitalTwinBuilderFlowRequest": {
|
||||
"displayName": "DigitalTwinBuilderFlow's New name",
|
||||
"description": "DigitalTwinBuilderFlow's New description"
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"displayName": "DigitalTwinBuilderFlow's New name",
|
||||
"description": "DigitalTwinBuilderFlow's New description",
|
||||
"type": "DigitalTwinBuilderFlow",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"id": "5b218778-e7a5-4d73-8187-f10824047715"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,34 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"digitalTwinBuilderFlowId": "5b218778-e7a5-4d73-8187-f10824047715",
|
||||
"updateMetadata" : true,
|
||||
"updateDigitalTwinBuilderFlowDefinitionRequest": {
|
||||
"definition": {
|
||||
"parts": [
|
||||
{
|
||||
"path": "definition.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
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,449 @@
|
||||
{
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"title": "DigitalTwinBuilderFlow REST APIs",
|
||||
"version": "v1"
|
||||
},
|
||||
"schemes": [
|
||||
"https"
|
||||
],
|
||||
"host": "api.fabric.microsoft.com",
|
||||
"basePath": "/v1",
|
||||
"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",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_ListDigitalTwinBuilderFlows",
|
||||
"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/DigitalTwinBuilderFlows"
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* InvalidItemType - Invalid item type.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"List Digital Twin Builder Flows in workspace example": {
|
||||
"$ref": "./examples/ListDigitalTwinBuilderFlowsInWorkspace.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"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",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_CreateDigitalTwinBuilderFlow",
|
||||
"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": "createDigitalTwinBuilderFlowRequest",
|
||||
"description": "Create item request payload.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/CreateDigitalTwinBuilderFlowRequest"
|
||||
},
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"201": {
|
||||
"description": "Successfully created",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/DigitalTwinBuilderFlow"
|
||||
}
|
||||
},
|
||||
"202": {
|
||||
"description": "Request accepted, Digital Twin Builder Flow 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 Digital Twin Builder Flow example": {
|
||||
"$ref": "./examples/CreateDigitalTwinBuilderFlowWithoutDefinition.json"
|
||||
},
|
||||
"Create a Digital Twin Builder Flow with public definition example": {
|
||||
"$ref": "./examples/CreateDigitalTwinBuilderFlow.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/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",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_GetDigitalTwinBuilderFlow",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "workspaceId",
|
||||
"description": "The workspace ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "digitalTwinBuilderFlowId",
|
||||
"description": "The Digital Twin Builder Flow ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/DigitalTwinBuilderFlow"
|
||||
}
|
||||
},
|
||||
"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 Digital Twin Builder Flow example": {
|
||||
"$ref": "./examples/GetDigitalTwinBuilderFlow.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"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",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_UpdateDigitalTwinBuilderFlow",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "workspaceId",
|
||||
"description": "The workspace ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "digitalTwinBuilderFlowId",
|
||||
"description": "The Digital Twin Builder Flow ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "body",
|
||||
"name": "updateDigitalTwinBuilderFlowRequest",
|
||||
"description": "Update Digital Twin Builder Flow request payload.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/UpdateDigitalTwinBuilderFlowRequest"
|
||||
},
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/DigitalTwinBuilderFlow"
|
||||
}
|
||||
},
|
||||
"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 Digital Twin Builder Flow example": {
|
||||
"$ref": "./examples/UpdateDigitalTwinBuilderFlow.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"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",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_DeleteDigitalTwinBuilderFlow",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "workspaceId",
|
||||
"description": "The workspace ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "digitalTwinBuilderFlowId",
|
||||
"description": "The Digital Twin Builder Flow 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 Digital Twin Builder Flow example": {
|
||||
"$ref": "./examples/DeleteDigitalTwinBuilderFlow.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/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",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_GetDigitalTwinBuilderFlowDefinition",
|
||||
"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": "digitalTwinBuilderFlowId",
|
||||
"description": "The Digital Twin Builder Flow ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/DigitalTwinBuilderFlowDefinitionResponse"
|
||||
}
|
||||
},
|
||||
"202": {
|
||||
"description": "Request accepted. Retrieving the definition is in progress.",
|
||||
"headers": {
|
||||
"Location": {
|
||||
"description": "The URL of the operation status, which can be used to track the operation state.",
|
||||
"type": "string"
|
||||
},
|
||||
"x-ms-operation-id": {
|
||||
"description": "The operation ID which can be used with long running operations (LRO) APIs to track the operation state and get the result.",
|
||||
"type": "string",
|
||||
"format": "uuid"
|
||||
},
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* OperationNotSupportedForItem - Operation not supported for requested item.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Get a Digital Twin Builder Flow public definition example": {
|
||||
"$ref": "./examples/GetDigitalTwinBuilderFlowDefinition.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/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",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_UpdateDigitalTwinBuilderFlowDefinition",
|
||||
"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": "digitalTwinBuilderFlowId",
|
||||
"description": "The Digital Twin Builder Flow ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "updateMetadata",
|
||||
"description": "When set to true and the Digital Twin Builder Flow.platform file is provided as part of the definition, the item's metadata is updated using the metadata in the Digital Twin Builder Flow.platform file",
|
||||
"type": "boolean",
|
||||
"required": false
|
||||
},
|
||||
{
|
||||
"in": "body",
|
||||
"name": "updateDigitalTwinBuilderFlowDefinitionRequest",
|
||||
"description": "Update Digital Twin Builder Flow definition request payload.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/UpdateDigitalTwinBuilderFlowDefinitionRequest"
|
||||
},
|
||||
"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 Digital Twin Builder Flow public definition example": {
|
||||
"$ref": "./examples/UpdateDigitalTwinBuilderFlowDefinition.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {},
|
||||
"security": [],
|
||||
"tags": []
|
||||
}
|
||||
@@ -202,6 +202,12 @@
|
||||
"description": "The environment description. Maximum length is 256 characters.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"folderId": {
|
||||
"description": "The folder ID. If not specified or null, the environment is created with the workspace as its folder.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
|
||||
@@ -173,7 +173,7 @@
|
||||
"/workspaces/{workspaceId}/environments": {
|
||||
"get": {
|
||||
"summary": "Returns a list of environments from the specified workspace.",
|
||||
"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\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\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 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"
|
||||
],
|
||||
@@ -223,7 +223,7 @@
|
||||
},
|
||||
"post": {
|
||||
"summary": "Creates an environment in the specified workspace.",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n This API does not support create a environment with definition.\n\n ## Permissions \n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes\n\n Environment.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations \n- To create an environment, the workspace must be on a supported Fabric capacity.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\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 [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n This API does not support create a environment with definition.\n\n ## Permissions \n The caller must have a *contributor* workspace role. \n\n## Required Delegated Scopes\n\n Environment.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations \n- To create an environment, the workspace must be on a supported Fabric capacity.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\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,7 +296,7 @@
|
||||
"/workspaces/{workspaceId}/environments/{environmentId}": {
|
||||
"get": {
|
||||
"summary": "Returns properties of the specified environment.",
|
||||
"description": "## Required Delegated Scopes\n\nEnvironment.Read.All or Item.Read.All or Environment.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* permissions for the environment.\n\n## Required Delegated Scopes\n\nEnvironment.Read.All or Item.Read.All or Environment.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"
|
||||
],
|
||||
@@ -344,7 +344,7 @@
|
||||
},
|
||||
"patch": {
|
||||
"summary": "Updates the properties of the specified environment.",
|
||||
"description": "## Permissions\n\n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes\n\n Environment.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 environment. \n\n## Required Delegated Scopes\n\n Environment.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"
|
||||
],
|
||||
@@ -404,7 +404,7 @@
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Deletes the specified environment.",
|
||||
"description": "## Permissions\n\n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes\n\n Environment.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 *write* permissions for the environment. \n\n## Required Delegated Scopes\n\n Environment.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"
|
||||
],
|
||||
@@ -764,4 +764,4 @@
|
||||
"responses": {},
|
||||
"security": [],
|
||||
"tags": []
|
||||
}
|
||||
}
|
||||
@@ -86,6 +86,12 @@
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"folderId": {
|
||||
"description": "The folder ID. If not specified or null, the eventhouse is created with the workspace as its folder.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"readOnly": false
|
||||
},
|
||||
"creationPayload": {
|
||||
"description": "The eventhouse creation payload. Use `definition` or `creationPayload`. You can't use both at the same time.",
|
||||
"$ref": "#/definitions/EventhouseCreationPayload",
|
||||
|
||||
@@ -13,7 +13,7 @@
|
||||
"/workspaces/{workspaceId}/eventhouses": {
|
||||
"get": {
|
||||
"summary": "Returns a list of eventhouses from the specified workspace.",
|
||||
"description": "This API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\n The caller must have *viewer* or higher role on the workspace. \n\n## Required Delegated Scopes \n\nWorkspace.Read.All or Workspace.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"description": "This API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\n The caller must have a *viewer* workspace role. \n\n## Required Delegated Scopes \n\nWorkspace.Read.All or Workspace.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
@@ -63,7 +63,7 @@
|
||||
},
|
||||
"post": {
|
||||
"summary": "Creates an eventhouse in the specified workspace.",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n ## Permissions \n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes \n\n Eventhouse.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations \n- To create an eventhouse the workspace must be on a supported Fabric capacity. For more information see: [Microsoft Fabric license types](/fabric/enterprise/licenses#microsoft-fabric-license-types).\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n ## Permissions \n The caller must have a *contributor* workspace role. \n\n## Required Delegated Scopes \n\n Eventhouse.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations \n- To create an eventhouse 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"
|
||||
],
|
||||
@@ -142,7 +142,7 @@
|
||||
"/workspaces/{workspaceId}/eventhouses/{eventhouseId}": {
|
||||
"get": {
|
||||
"summary": "Returns properties of the specified eventhouse.",
|
||||
"description": "## Permissions\n\n The caller must have *viewer* or higher workspace role. \n\n## Required Delegated Scopes \n\n Eventhouse.Read.All or Eventhouse.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 eventhouse. \n\n## Required Delegated Scopes \n\n Eventhouse.Read.All or Eventhouse.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"
|
||||
],
|
||||
@@ -190,7 +190,7 @@
|
||||
},
|
||||
"patch": {
|
||||
"summary": "Updates the properties of the specified eventhouse.",
|
||||
"description": "## Permissions\n\n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes \n\n Eventhouse.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 eventhouse. \n\n## Required Delegated Scopes \n\n Eventhouse.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"
|
||||
],
|
||||
@@ -250,7 +250,7 @@
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Deletes the specified eventhouse.",
|
||||
"description": "## Permissions\n\n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes \n\n Eventhouse.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 *write* permissions for the eventhouse. \n\n## Required Delegated Scopes \n\n Eventhouse.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"
|
||||
],
|
||||
@@ -297,7 +297,7 @@
|
||||
"/workspaces/{workspaceId}/eventhouses/{eventhouseId}/getDefinition": {
|
||||
"post": {
|
||||
"summary": "Returns the specified eventhouse 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 *contributor* or higher workspace role. \n\n## Required Delegated Scopes \n\n Eventhouse.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": "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 eventhouse. \n\n## Required Delegated Scopes \n\n Eventhouse.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"
|
||||
],
|
||||
@@ -373,7 +373,7 @@
|
||||
"/workspaces/{workspaceId}/eventhouses/{eventhouseId}/updateDefinition": {
|
||||
"post": {
|
||||
"summary": "Overrides the definition for the specified eventhouse.",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes \n\n Eventhouse.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": "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 eventhouse. \n\n## Required Delegated Scopes \n\n Eventhouse.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"
|
||||
],
|
||||
|
||||
@@ -50,6 +50,12 @@
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"folderId": {
|
||||
"description": "The folder ID. If not specified or null, the eventstream is created with the workspace as its folder.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"readOnly": false
|
||||
},
|
||||
"definition": {
|
||||
"description": "The [eventstream public definition](/rest/api/fabric/articles/item-management/definitions/eventstream-definition).",
|
||||
"$ref": "#/definitions/EventstreamDefinition",
|
||||
|
||||
@@ -162,11 +162,8 @@
|
||||
"description": "The name of the EventHub."
|
||||
},
|
||||
"accessKeys": {
|
||||
"type": "object",
|
||||
"description": "The access keys.",
|
||||
"items": {
|
||||
"$ref": "#/definitions/AccessKeys"
|
||||
}
|
||||
"$ref": "#/definitions/AccessKeys",
|
||||
"description": "The access keys."
|
||||
}
|
||||
}
|
||||
},
|
||||
|
||||
@@ -12,6 +12,11 @@
|
||||
"payload": "SSdkIGxpa2UgdG8gdGVsbCBh..IGpva2UgZm9yIHlvdS4K",
|
||||
"payloadType": "InlineBase64"
|
||||
},
|
||||
{
|
||||
"path": "eventstreamProperties.json",
|
||||
"payload": "ewogICJyZXRlbnRpb25UaW1l..V2ZWwiOiAiTG93Igp9",
|
||||
"payloadType": "InlineBase64"
|
||||
},
|
||||
{
|
||||
"path": ".platform",
|
||||
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
|
||||
|
||||
@@ -13,6 +13,11 @@
|
||||
"payload": "SSdkIGxpa2UgdG8gdGVsbCBh..IGpva2UgZm9yIHlvdS4K",
|
||||
"payloadType": "InlineBase64"
|
||||
},
|
||||
{
|
||||
"path": "eventstreamProperties.json",
|
||||
"payload": "ewogICJyZXRlbnRpb25UaW1l..V2ZWwiOiAiTG93Igp9",
|
||||
"payloadType": "InlineBase64"
|
||||
},
|
||||
{
|
||||
"path": ".platform",
|
||||
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
|
||||
|
||||
@@ -8,6 +8,7 @@
|
||||
"compatibilityLevel": "1.0",
|
||||
"sources": [
|
||||
{
|
||||
"id": "514d0e11-cf65-44fb-a292-fc88a2a78618",
|
||||
"name": "AzureEventHubSource",
|
||||
"type": "AzureEventHub",
|
||||
"properties": {
|
||||
@@ -41,6 +42,7 @@
|
||||
"error": null
|
||||
},
|
||||
{
|
||||
"id": "0d9bf4db-bc7f-4854-8579-6fdf244ed503",
|
||||
"name": "CustomEndpointSource",
|
||||
"type": "CustomEndpoint",
|
||||
"properties": {},
|
||||
@@ -48,6 +50,7 @@
|
||||
"error": null
|
||||
},
|
||||
{
|
||||
"id": "19258e62-4de9-4c52-b45e-71502dc2ddea",
|
||||
"name": "SampleDataSource",
|
||||
"type": "SimpleData",
|
||||
"properties": {
|
||||
@@ -57,6 +60,7 @@
|
||||
"error": null
|
||||
},
|
||||
{
|
||||
"id": "7afaa265-1d67-416f-8183-e6e1b1ebb4ea",
|
||||
"name": "AmazonKinesisSource",
|
||||
"type": "AmazonKinesis",
|
||||
"properties": {
|
||||
@@ -67,6 +71,7 @@
|
||||
"error": null
|
||||
},
|
||||
{
|
||||
"id": "d020dd19-e84c-42e1-b4be-87e58145e1b5",
|
||||
"name": "AmazonMSKKafkaSource",
|
||||
"type": "AmazonMSKKafka",
|
||||
"properties": {
|
||||
@@ -81,6 +86,7 @@
|
||||
"error": null
|
||||
},
|
||||
{
|
||||
"id": "03a6dd4a-4627-422f-a287-2ccd7daf903d",
|
||||
"name": "ApacheKafkaSource",
|
||||
"type": "ApacheKafka",
|
||||
"properties": {
|
||||
@@ -95,6 +101,7 @@
|
||||
"error": null
|
||||
},
|
||||
{
|
||||
"id": "6f493321-6c12-40c6-9980-c2aa38804829",
|
||||
"name": "ConfluentCloudSource",
|
||||
"type": "ConfluentCloud",
|
||||
"properties": {
|
||||
@@ -107,6 +114,7 @@
|
||||
"error": null
|
||||
},
|
||||
{
|
||||
"id": "e7f88779-0349-47e3-bead-85afc9d3c9a4",
|
||||
"name": "AzureCosmosDBCDCSource",
|
||||
"type": "AzureCosmosDBCDC",
|
||||
"properties": {
|
||||
@@ -119,6 +127,7 @@
|
||||
"error": null
|
||||
},
|
||||
{
|
||||
"id": "da5ed80d-c672-4809-a7ac-6224aa2ab2c7",
|
||||
"name": "AzureSQLDBCDCSource",
|
||||
"type": "AzureSQLDBCDC",
|
||||
"properties": {
|
||||
@@ -129,6 +138,7 @@
|
||||
"error": null
|
||||
},
|
||||
{
|
||||
"id": "745e401f-aac6-463f-b107-c336a2440abe",
|
||||
"name": "AzureSQLMIDBCDCSource",
|
||||
"type": "AzureSQLMIDBCDC",
|
||||
"properties": {
|
||||
@@ -139,6 +149,7 @@
|
||||
"error": null
|
||||
},
|
||||
{
|
||||
"id": "759842ab-a968-498d-9f37-f46297da8b07",
|
||||
"name": "SQLServerOnVMDBCDCSource",
|
||||
"type": "SQLServerOnVMDBCDC",
|
||||
"properties": {
|
||||
@@ -149,6 +160,7 @@
|
||||
"error": null
|
||||
},
|
||||
{
|
||||
"id": "9791cd2a-19fb-4991-b878-2b061420a460",
|
||||
"name": "MySQLCDCSource",
|
||||
"type": "MySQLCDC",
|
||||
"properties": {
|
||||
@@ -161,6 +173,7 @@
|
||||
"error": null
|
||||
},
|
||||
{
|
||||
"id": "57b3394b-bcf3-479a-952b-22a815e1d684",
|
||||
"name": "PostgreSQLCDCSource",
|
||||
"type": "PostgreSQLCDC",
|
||||
"properties": {
|
||||
@@ -173,6 +186,7 @@
|
||||
"error": null
|
||||
},
|
||||
{
|
||||
"id": "d5f702ca-8b2b-4ac5-88e7-50697cb1b207",
|
||||
"name": "GooglePubSubSource",
|
||||
"type": "GooglePubSub",
|
||||
"properties": {
|
||||
@@ -184,6 +198,7 @@
|
||||
],
|
||||
"destinations": [
|
||||
{
|
||||
"id": "4642073b-c216-4675-a17c-ed2e75756330",
|
||||
"name": "CustomEndpointDestination",
|
||||
"type": "CustomEndpoint",
|
||||
"properties": {},
|
||||
@@ -196,6 +211,7 @@
|
||||
"error": null
|
||||
},
|
||||
{
|
||||
"id": "e1e2d0cc-87e5-46d9-977d-2a8eede7bef0",
|
||||
"name": "LakehouseDestination",
|
||||
"type": "Lakehouse",
|
||||
"properties": {
|
||||
@@ -221,6 +237,7 @@
|
||||
"error": null
|
||||
},
|
||||
{
|
||||
"id": "49b5d6ec-f8af-4ae9-a4d6-5e94645efe1f",
|
||||
"name": "EventhouseProcessedIngestionModeDestination",
|
||||
"type": "Eventhouse",
|
||||
"properties": {
|
||||
@@ -245,6 +262,7 @@
|
||||
"error": null
|
||||
},
|
||||
{
|
||||
"id": "c0ca1c2a-b8c5-482c-98da-40088f988e9c",
|
||||
"name": "EventhouseDirectIngestionModeDestination",
|
||||
"type": "Eventhouse",
|
||||
"properties": {
|
||||
@@ -265,6 +283,18 @@
|
||||
],
|
||||
"streams": [
|
||||
{
|
||||
"id": "8eff3cbe-f452-4d7f-bc2d-f35b4359c917",
|
||||
"name": "Eventstream-stream",
|
||||
"type": "DefaultStream",
|
||||
"properties": {},
|
||||
"inputNodes": [
|
||||
{
|
||||
"name": "AzureEventHubSource"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "0f6f0dd8-9de2-48e2-92e7-e15b755b22a6",
|
||||
"name": "DerivedStreamName",
|
||||
"type": "DerivedStream",
|
||||
"properties": {
|
||||
|
||||
@@ -11,6 +11,11 @@
|
||||
"payload": "SSdkIGxpa2UgdG8gdGVsbCBh..IGpva2UgZm9yIHlvdS4K",
|
||||
"payloadType": "InlineBase64"
|
||||
},
|
||||
{
|
||||
"path": "eventstreamProperties.json",
|
||||
"payload": "ewogICJyZXRlbnRpb25UaW1l..V2ZWwiOiAiTG93Igp9",
|
||||
"payloadType": "InlineBase64"
|
||||
},
|
||||
{
|
||||
"path": ".platform",
|
||||
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
|
||||
|
||||
@@ -13,7 +13,7 @@
|
||||
"/workspaces/{workspaceId}/eventstreams": {
|
||||
"get": {
|
||||
"summary": "Returns a list of eventstreams from the specified workspace.",
|
||||
"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\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\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 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"
|
||||
],
|
||||
@@ -63,7 +63,7 @@
|
||||
},
|
||||
"post": {
|
||||
"summary": "Creates an eventstream in the specified workspace.",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n To create eventstream with definition, refer to [Eventstream definition](/rest/api/fabric/articles/item-management/definitions/eventstream-definition). \n\n ## Permissions \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## Limitations \n- To create an eventstream the workspace must be on a supported Fabric capacity. For more information see: [Microsoft Fabric license types](/fabric/enterprise/licenses#microsoft-fabric-license-types).\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n To create eventstream with definition, refer to [Eventstream definition](/rest/api/fabric/articles/item-management/definitions/eventstream-definition). \n\n ## Permissions \n The caller must have a *contributor* workspace role. \n\n## Required Delegated Scopes \n\n Eventstream.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations \n- To create an eventstream 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"
|
||||
],
|
||||
@@ -139,7 +139,7 @@
|
||||
"/workspaces/{workspaceId}/eventstreams/{eventstreamId}": {
|
||||
"get": {
|
||||
"summary": "Returns properties 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": [
|
||||
"Items"
|
||||
],
|
||||
@@ -187,7 +187,7 @@
|
||||
},
|
||||
"patch": {
|
||||
"summary": "Updates the properties of the specified 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": [
|
||||
"Items"
|
||||
],
|
||||
@@ -247,7 +247,7 @@
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Deletes the specified 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 *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": [
|
||||
"Items"
|
||||
],
|
||||
@@ -294,7 +294,7 @@
|
||||
"/workspaces/{workspaceId}/eventstreams/{eventstreamId}/getDefinition": {
|
||||
"post": {
|
||||
"summary": "Returns the specified eventstream public definition.",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get an eventstream public definition, the sensitivity label is not a part of the definition.\n\n## 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## Limitations\n\n This API is blocked for an eventstream 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) | Yes |\n\n## Interface",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get an eventstream 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 eventstream. \n\n## Required Delegated Scopes \n\n Eventstream.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations\n\n This API is blocked for an eventstream 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) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
@@ -370,7 +370,7 @@
|
||||
"/workspaces/{workspaceId}/eventstreams/{eventstreamId}/updateDefinition": {
|
||||
"post": {
|
||||
"summary": "Updates the definition of a specified eventstream. 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 eventstream definition, does not affect its sensitivity label. \n\n## Permissions\n\n The API caller must have *contributor* or higher workspace role. \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": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n \nUpdating the eventstream definition, does not affect its sensitivity label. \n\n## Permissions\n\n The caller must have *read and write* permissions for the eventstream. \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": [
|
||||
"Items"
|
||||
],
|
||||
|
||||
@@ -44,11 +44,82 @@
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"description": {
|
||||
"description": "The API for GraphQL description. Maximum length is 256 characters.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
}
|
||||
"description": {
|
||||
"description": "The API for GraphQL description. Maximum length is 256 characters.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"folderId": {
|
||||
"description": "The folder ID. If not specified or null, the API for GraphQL is created with the workspace as its folder.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"readOnly": false
|
||||
},
|
||||
"definition": {
|
||||
"description": "The API for GraphQL public definition.",
|
||||
"$ref": "#/definitions/GraphQLApiPublicDefinition",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateGraphQLApiDefinitionRequest": {
|
||||
"description": "Update API for GraphQL public definition request payload.",
|
||||
"required": ["definition"],
|
||||
"properties": {
|
||||
"definition": {
|
||||
"$ref": "#/definitions/GraphQLApiPublicDefinition"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GraphQLApiDefinitionResponse": {
|
||||
"description": "API for GraphQL public definition response.",
|
||||
"required": ["definition"],
|
||||
"properties": {
|
||||
"definition": {
|
||||
"$ref": "#/definitions/GraphQLApiPublicDefinition",
|
||||
"readOnly": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"GraphQLApiPublicDefinition" : {
|
||||
"description": "API for GraphQL public definition object. To create the definition, see [GraphQLApi definition](/rest/api/fabric/articles/item-management/definitions/graphql-api-definition).",
|
||||
"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/GraphQLApiPublicDefinitionPart"
|
||||
},
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"GraphQLApiPublicDefinitionPart": {
|
||||
"description": "API for GraphQL definition part object.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"path": {
|
||||
"description": "The API for GraphQL definition part path.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"payload": {
|
||||
"description": "The API for GraphQL definition part payload.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"payloadType":{
|
||||
"description": "The payload type.",
|
||||
"$ref": "../common/definitions.json#/definitions/PayloadType",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateGraphQLApiRequest": {
|
||||
|
||||
@@ -0,0 +1,42 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"createGraphQLApiRequest": {
|
||||
"displayName": "GraphQLApi 1",
|
||||
"description": "An API for GraphQL item description.",
|
||||
"definition": {
|
||||
"format": "GraphQLApiV1",
|
||||
"parts": [
|
||||
{
|
||||
"path": "graphql-definition.json",
|
||||
"payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
|
||||
"payloadType": "InlineBase64"
|
||||
},
|
||||
{
|
||||
"path": ".platform",
|
||||
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
|
||||
"payloadType": "InlineBase64"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"201": {
|
||||
"body": {
|
||||
"displayName": "GraphQLApi 1",
|
||||
"description": "An API for GraphQL item description.",
|
||||
"type": "GraphQLApi",
|
||||
"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
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,33 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "6e335e92-a2a2-4b5a-970a-bd6a89fbb765",
|
||||
"GraphQLApiId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"definition": {
|
||||
"parts": [
|
||||
{
|
||||
"path": "graphql-definition.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
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,34 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"GraphQLApiId": "5b218778-e7a5-4d73-8187-f10824047715",
|
||||
"updateMetadata" : true,
|
||||
"updateGraphQLApiDefinitionRequest": {
|
||||
"definition": {
|
||||
"parts": [
|
||||
{
|
||||
"path": "graphql-definition.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
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
+169
-8
@@ -13,7 +13,7 @@
|
||||
"/workspaces/{workspaceId}/GraphQLApis": {
|
||||
"get": {
|
||||
"summary": "Returns a list of API for GraphQL items from the specified workspace.",
|
||||
"description": "\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\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\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": "\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"
|
||||
],
|
||||
@@ -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\n ## Permissions \n The caller must have *contributor* or higher 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",
|
||||
"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",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
@@ -102,7 +102,7 @@
|
||||
}
|
||||
},
|
||||
"202": {
|
||||
"description": "Request accepted, provisioning in progress.",
|
||||
"description": "Request accepted, GraphQLApi provisioning in progress.",
|
||||
"headers": {
|
||||
"Location": {
|
||||
"description": "The URL of the operation status, which can be used to track the operation state.",
|
||||
@@ -129,6 +129,9 @@
|
||||
"x-ms-examples": {
|
||||
"Create a API for GraphQL example": {
|
||||
"$ref": "./examples/CreateGraphQLApiWithoutDefinition.json"
|
||||
},
|
||||
"Create a GraphQLApi with public definition example": {
|
||||
"$ref": "./examples/CreateGraphQLApi.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -136,7 +139,7 @@
|
||||
"/workspaces/{workspaceId}/GraphQLApis/{GraphQLApiId}": {
|
||||
"get": {
|
||||
"summary": "Returns properties of the specified API for GraphQL.",
|
||||
"description": "## Permissions\n\n The caller must have *viewer* or higher workspace role. \n\n## Required Delegated Scopes\n\n GraphQLApi.Read.All or GraphQLApi.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 GraphQLApi. \n\n## Required Delegated Scopes\n\n GraphQLApi.Read.All or GraphQLApi.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"
|
||||
],
|
||||
@@ -177,14 +180,14 @@
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Get a example": {
|
||||
"Get a GraphQLApi example": {
|
||||
"$ref": "./examples/GetGraphQLApi.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"patch": {
|
||||
"summary": "Updates the properties of the specified API for GraphQL.",
|
||||
"description": "## Permissions\n\n The caller must have *contributor* or higher workspace role.\n\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",
|
||||
"description": "## Permissions\n\n The caller must have *read and write* permissions for the GraphQLApi.\n\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"
|
||||
],
|
||||
@@ -237,14 +240,14 @@
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Update a example": {
|
||||
"Update a GraphQLApi example": {
|
||||
"$ref": "./examples/UpdateGraphQLApi.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Deletes the specified API for GraphQL.",
|
||||
"description": "## Permissions\n\n The caller must have *contributor* or higher workspace role. \n\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",
|
||||
"description": "## Permissions\n\n The caller must have *write* permissions for the GraphQLApi. \n\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"
|
||||
],
|
||||
@@ -287,6 +290,164 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/GraphQLApis/{GraphQLApiId}/getDefinition": {
|
||||
"post": {
|
||||
"summary": "Returns the specified GraphQLApi public definition.",
|
||||
"description": "\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a [GraphQLApi public definition](/rest/api/fabric/articles/item-management/definitions/graphql-api-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 GraphQLApi . \n\n## Required Delegated Scopes\n\n GraphQLApi.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations\n\n This API is blocked for a 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) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_GetGraphQLApiDefinition",
|
||||
"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": "GraphQLApiId",
|
||||
"description": "The GraphQLApi ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "format",
|
||||
"description": "The format of the GraphQLApi public definition.",
|
||||
"type": "string",
|
||||
"required": false
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/GraphQLApiDefinitionResponse"
|
||||
}
|
||||
},
|
||||
"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 GraphQLApi public definition example": {
|
||||
"$ref": "./examples/GetGraphQLApiDefinition.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/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",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_UpdateGraphQLApiDefinition",
|
||||
"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": "GraphQLApiId",
|
||||
"description": "The GraphQLApi 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": "updateGraphQLApiDefinitionRequest",
|
||||
"description": "Update GraphQLApi definition request payload.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/UpdateGraphQLApiDefinitionRequest"
|
||||
},
|
||||
"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 GraphQLApi public definition example": {
|
||||
"$ref": "./examples/UpdateGraphQLApiDefinition.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {},
|
||||
|
||||
@@ -49,6 +49,12 @@
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"folderId": {
|
||||
"description": "The folder ID. If not specified or null, the KQL dashboard is created with the workspace as its folder.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"readOnly": false
|
||||
},
|
||||
"definition": {
|
||||
"description": "The KQL dashboard public definition.",
|
||||
"$ref": "#/definitions/KQLDashboardDefinition",
|
||||
|
||||
@@ -13,7 +13,7 @@
|
||||
"/workspaces/{workspaceId}/kqlDashboards": {
|
||||
"get": {
|
||||
"summary": "Returns a list of KQL dashboards from the specified workspace.",
|
||||
"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\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\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 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"
|
||||
],
|
||||
@@ -63,7 +63,7 @@
|
||||
},
|
||||
"post": {
|
||||
"summary": "Creates a KQL dashboard in the specified workspace.",
|
||||
"description": "To create a KQL dashboard with definition, refer to the [KQL dashboard definition article](/rest/api/fabric/articles/item-management/definitions/kql-dashboard-definition).\n\n ## Permissions\n\n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes \n\n KQLDashboard.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": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n To create a KQL dashboard with definition, refer to the [KQL dashboard definition article](/rest/api/fabric/articles/item-management/definitions/kql-dashboard-definition).\n\n ## Permissions\n\n The caller must have a *contributor* workspace role. \n\n## Required Delegated Scopes \n\n KQLDashboard.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"
|
||||
],
|
||||
@@ -74,6 +74,7 @@
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"x-ms-fabric-sdk-long-running-operation": true,
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
@@ -106,6 +107,24 @@
|
||||
"$ref": "./definitions.json#/definitions/KQLDashboard"
|
||||
}
|
||||
},
|
||||
"202": {
|
||||
"description": "Request accepted, the KQL dashboard creation 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* InvalidItemType - Invalid item type",
|
||||
"schema": {
|
||||
@@ -126,7 +145,7 @@
|
||||
"/workspaces/{workspaceId}/kqlDashboards/{kqlDashboardId}": {
|
||||
"get": {
|
||||
"summary": "Returns properties of the specified KQL dashboard.",
|
||||
"description": "## Permissions\n\n The caller must have *viewer* or higher workspace role. \n\n## Required Delegated Scopes \n\n KQLDashboard.Read.All or KQLDashboard.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 KQL dashboard. \n\n## Required Delegated Scopes \n\n KQLDashboard.Read.All or KQLDashboard.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"
|
||||
],
|
||||
@@ -174,7 +193,7 @@
|
||||
},
|
||||
"patch": {
|
||||
"summary": "Updates the properties of the specified KQL dashboard.",
|
||||
"description": "## Permissions\n\n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes \n\n KQLDashboard.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 KQL dashboard. \n\n## Required Delegated Scopes \n\n KQLDashboard.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"
|
||||
],
|
||||
@@ -234,7 +253,7 @@
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Deletes the specified KQL dashboard.",
|
||||
"description": "## Permissions\n\n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes \n\n KQLDashboard.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 *write* permissions for the KQL dashboard. \n\n## Required Delegated Scopes \n\n KQLDashboard.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"
|
||||
],
|
||||
@@ -281,7 +300,7 @@
|
||||
"/workspaces/{workspaceId}/kqlDashboards/{kqlDashboardId}/getDefinition": {
|
||||
"post": {
|
||||
"summary": "Returns the specified KQL dashboard public definition.",
|
||||
"description": "## Permissions\n\n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes \n\n KQLDashboard.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": "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 KQL dashboard. \n\n## Required Delegated Scopes \n\n KQLDashboard.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"
|
||||
],
|
||||
@@ -289,6 +308,7 @@
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"x-ms-fabric-sdk-long-running-operation": true,
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
@@ -321,6 +341,24 @@
|
||||
"$ref": "./definitions.json#/definitions/KQLDashboardDefinitionResponse"
|
||||
}
|
||||
},
|
||||
"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": {
|
||||
@@ -338,7 +376,7 @@
|
||||
"/workspaces/{workspaceId}/kqlDashboards/{kqlDashboardId}/updateDefinition": {
|
||||
"post": {
|
||||
"summary": "Overrides the definition for the specified KQL dashboard.",
|
||||
"description": "## Permissions\n\n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes \n\n KQLDashboard.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": "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 KQL dashboard. \n\n## Required Delegated Scopes \n\n KQLDashboard.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"
|
||||
],
|
||||
@@ -346,6 +384,7 @@
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"x-ms-fabric-sdk-long-running-operation": true,
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
@@ -384,6 +423,24 @@
|
||||
"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": {
|
||||
|
||||
@@ -61,6 +61,12 @@
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"folderId": {
|
||||
"description": "The folder ID. If not specified or null, the KQL database is created with the workspace as its folder.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"readOnly": false
|
||||
},
|
||||
"creationPayload": {
|
||||
"description": "The KQL database creation payload. Use `definition` or `creationPayload`. You can't use both at the same time.",
|
||||
"$ref": "#/definitions/KQLDatabaseCreationPayload",
|
||||
|
||||
@@ -13,7 +13,7 @@
|
||||
"/workspaces/{workspaceId}/kqlDatabases": {
|
||||
"get": {
|
||||
"summary": "Returns a list of KQL databases from the specified workspace.",
|
||||
"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\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\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 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"
|
||||
],
|
||||
@@ -63,7 +63,7 @@
|
||||
},
|
||||
"post": {
|
||||
"summary": "Creates a KQL database in the specified workspace.",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n ## Permissions \n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes \n\n KQLDatabase.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations \n- To create a KQL database the workspace must be on a supported Fabric capacity. For more information see: [Microsoft Fabric license types](/fabric/enterprise/licenses#microsoft-fabric-license-types).\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n ## Permissions \n The caller must have a *contributor* workspace role. \n\n## Required Delegated Scopes \n\n KQLDatabase.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations \n- To create a KQL database the workspace must be on a supported Fabric capacity. For more information see: [Microsoft Fabric license types](/fabric/enterprise/licenses#microsoft-fabric-license-types).\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
@@ -148,7 +148,7 @@
|
||||
"/workspaces/{workspaceId}/kqlDatabases/{kqlDatabaseId}": {
|
||||
"get": {
|
||||
"summary": "Returns properties of the specified KQL database.",
|
||||
"description": "## Permissions\n\n The caller must have *viewer* or higher workspace role. \n\n## Required Delegated Scopes \n\n KQLDatabase.Read.All or KQLDatabase.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 KQL database. \n\n## Required Delegated Scopes \n\n KQLDatabase.Read.All or KQLDatabase.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"
|
||||
],
|
||||
@@ -196,7 +196,7 @@
|
||||
},
|
||||
"patch": {
|
||||
"summary": "Updates the properties of the specified KQL database.",
|
||||
"description": "## Permissions\n\n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes \n\n KQLDatabase.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 KQL database. \n\n## Required Delegated Scopes \n\n KQLDatabase.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"
|
||||
],
|
||||
@@ -256,7 +256,7 @@
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Deletes the specified KQL database.",
|
||||
"description": "## Permissions\n\n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes \n\n KQLDatabase.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 *write* permissions for the KQL database. \n\n## Required Delegated Scopes \n\n KQLDatabase.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"
|
||||
],
|
||||
@@ -303,7 +303,7 @@
|
||||
"/workspaces/{workspaceId}/kqlDatabases/{kqlDatabaseId}/getDefinition": {
|
||||
"post": {
|
||||
"summary": "Returns the specified KQL database 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 *contributor* or higher workspace role. \n\n## Required Delegated Scopes \n\n KQLDatabase.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": "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 KQL database. \n\n## Required Delegated Scopes \n\n KQLDatabase.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"
|
||||
],
|
||||
@@ -379,7 +379,7 @@
|
||||
"/workspaces/{workspaceId}/kqlDatabases/{kqlDatabaseId}/updateDefinition": {
|
||||
"post": {
|
||||
"summary": "Overrides the definition for the specified KQL database.",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes \n\n KQLDatabase.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": "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 KQL database. \n\n## Required Delegated Scopes \n\n KQLDatabase.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"
|
||||
],
|
||||
|
||||
@@ -49,6 +49,12 @@
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"folderId": {
|
||||
"description": "The folder ID. If not specified or null, the KQL queryset is created with the workspace as its folder.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"readOnly": false
|
||||
},
|
||||
"definition": {
|
||||
"description": "The KQL queryset public definition.",
|
||||
"$ref": "#/definitions/KQLQuerysetDefinition",
|
||||
|
||||
@@ -13,7 +13,7 @@
|
||||
"/workspaces/{workspaceId}/kqlQuerysets": {
|
||||
"get": {
|
||||
"summary": "Returns a list of KQL querysets from the specified workspace.",
|
||||
"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\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\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 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"
|
||||
],
|
||||
@@ -63,7 +63,7 @@
|
||||
},
|
||||
"post": {
|
||||
"summary": "Creates a KQL queryset in the specified workspace.",
|
||||
"description": "To create a KQL queryset with definition, refer to the [KQL queryset definition article](/rest/api/fabric/articles/item-management/definitions/kql-queryset-definition).\n\n## Permissions\n\n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes \n\nKQLQueryset.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": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n To create a KQL queryset with definition, refer to the [KQL queryset definition article](/rest/api/fabric/articles/item-management/definitions/kql-queryset-definition).\n\n## Permissions\n\n The caller must have a *contributor* workspace role. \n\n## Required Delegated Scopes \n\nKQLQueryset.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"
|
||||
],
|
||||
@@ -74,6 +74,7 @@
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"x-ms-fabric-sdk-long-running-operation": true,
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
@@ -100,6 +101,24 @@
|
||||
"$ref": "./definitions.json#/definitions/KQLQueryset"
|
||||
}
|
||||
},
|
||||
"202": {
|
||||
"description": "Request accepted, the KQL queryset creation 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* 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": {
|
||||
@@ -120,7 +139,7 @@
|
||||
"/workspaces/{workspaceId}/kqlQuerysets/{kqlQuerysetId}": {
|
||||
"get": {
|
||||
"summary": "Returns properties of the specified KQL queryset.",
|
||||
"description": "## Permissions\n\n The caller must have *viewer* or higher workspace role. \n\n## Required Delegated Scopes \n\n KQLQueryset.Read.All or KQLQueryset.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 KQL qeryset. \n\n## Required Delegated Scopes \n\n KQLQueryset.Read.All or KQLQueryset.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"
|
||||
],
|
||||
@@ -168,7 +187,7 @@
|
||||
},
|
||||
"patch": {
|
||||
"summary": "Updates the properties of the specified KQL queryset.",
|
||||
"description": "## Permissions\n\n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes \n\n KQLQueryset.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 KQL queryset. \n\n## Required Delegated Scopes \n\n KQLQueryset.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"
|
||||
],
|
||||
@@ -228,7 +247,7 @@
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Deletes the specified KQL queryset.",
|
||||
"description": "## Permissions\n\n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes \n\n KQLQueryset.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 *write* permissions for the KQL queryset. \n\n## Required Delegated Scopes \n\n KQLQueryset.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"
|
||||
],
|
||||
@@ -275,7 +294,7 @@
|
||||
"/workspaces/{workspaceId}/kqlQuerysets/{kqlQuerysetId}/getDefinition": {
|
||||
"post": {
|
||||
"summary": "Returns the specified KQL queryset public definition.",
|
||||
"description": "## Permissions\n\n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes \n\n KQLQueryset.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": "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 KQL queryset. \n\n## Required Delegated Scopes \n\n KQLQueryset.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"
|
||||
],
|
||||
@@ -283,6 +302,7 @@
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"x-ms-fabric-sdk-long-running-operation": true,
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
@@ -315,6 +335,24 @@
|
||||
"$ref": "./definitions.json#/definitions/KQLQuerysetDefinitionResponse"
|
||||
}
|
||||
},
|
||||
"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": {
|
||||
@@ -332,7 +370,7 @@
|
||||
"/workspaces/{workspaceId}/kqlQuerysets/{kqlQuerysetId}/updateDefinition": {
|
||||
"post": {
|
||||
"summary": "Overrides the definition for the specified KQL queryset.",
|
||||
"description": "## Permissions\n\n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes \n\n KQLQueryset.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": "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 KQL queryset. \n\n## Required Delegated Scopes \n\n KQLQueryset.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"
|
||||
],
|
||||
@@ -340,6 +378,7 @@
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"x-ms-fabric-sdk-long-running-operation": true,
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
@@ -378,6 +417,24 @@
|
||||
"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": {
|
||||
|
||||
+77
-22
@@ -8,7 +8,9 @@
|
||||
"definitions": {
|
||||
"Lakehouses": {
|
||||
"description": "A list of lakehouses.",
|
||||
"required": ["value"],
|
||||
"required": [
|
||||
"value"
|
||||
],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"value": {
|
||||
@@ -28,7 +30,9 @@
|
||||
"Lakehouse": {
|
||||
"description": "A lakehouse item.",
|
||||
"type": "object",
|
||||
"required": ["type"],
|
||||
"required": [
|
||||
"type"
|
||||
],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "../common/definitions.json#/definitions/Item"
|
||||
@@ -42,7 +46,10 @@
|
||||
}
|
||||
},
|
||||
"LakehouseProperties": {
|
||||
"required": ["oneLakeTablesPath", "oneLakeFilesPath"],
|
||||
"required": [
|
||||
"oneLakeTablesPath",
|
||||
"oneLakeFilesPath"
|
||||
],
|
||||
"description": "The lakehouse properties.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@@ -65,7 +72,9 @@
|
||||
}
|
||||
},
|
||||
"SqlEndpointProperties": {
|
||||
"required": ["provisioningStatus"],
|
||||
"required": [
|
||||
"provisioningStatus"
|
||||
],
|
||||
"description": "An object containing the properties of the SQL endpoint.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@@ -86,7 +95,11 @@
|
||||
"SqlEndpointProvisioningStatus": {
|
||||
"type": "string",
|
||||
"description": "The SQL endpoint provisioning status type. Additional `SqlEndpointProvisioningStatus` types may be added over time.",
|
||||
"enum": ["InProgress", "Success", "Failed"],
|
||||
"enum": [
|
||||
"InProgress",
|
||||
"Success",
|
||||
"Failed"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "SqlEndpointProvisioningStatus",
|
||||
"modelAsString": true,
|
||||
@@ -108,7 +121,9 @@
|
||||
},
|
||||
"CreateLakehouseRequest": {
|
||||
"description": "Create lakehouse request payload.",
|
||||
"required": ["displayName"],
|
||||
"required": [
|
||||
"displayName"
|
||||
],
|
||||
"properties": {
|
||||
"displayName": {
|
||||
"description": "The lakehouse display name. The display name must follow naming rules according to item type.",
|
||||
@@ -120,6 +135,12 @@
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"folderId": {
|
||||
"description": "The folder ID. If not specified or null, the lakehouse is created with the workspace as its folder.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"readOnly": false
|
||||
},
|
||||
"creationPayload": {
|
||||
"description": "The lakehouse creation payload.",
|
||||
"$ref": "#/definitions/LakehouseCreationPayload",
|
||||
@@ -129,7 +150,9 @@
|
||||
},
|
||||
"UpdateLakehouseDefinitionRequest": {
|
||||
"description": "Update Lakehouse public definition request payload.",
|
||||
"required": ["definition"],
|
||||
"required": [
|
||||
"definition"
|
||||
],
|
||||
"properties": {
|
||||
"definition": {
|
||||
"$ref": "#/definitions/LakehouseDefinition"
|
||||
@@ -138,7 +161,9 @@
|
||||
},
|
||||
"LakehouseDefinitionResponse": {
|
||||
"description": "Lakehouse public definition response.",
|
||||
"required": ["definition"],
|
||||
"required": [
|
||||
"definition"
|
||||
],
|
||||
"properties": {
|
||||
"definition": {
|
||||
"$ref": "#/definitions/LakehouseDefinition",
|
||||
@@ -146,10 +171,12 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"LakehouseDefinition" : {
|
||||
"LakehouseDefinition": {
|
||||
"description": "Lakehouse public definition object.",
|
||||
"type": "object",
|
||||
"required": ["parts"],
|
||||
"required": [
|
||||
"parts"
|
||||
],
|
||||
"properties": {
|
||||
"format": {
|
||||
"description": "The format of the item definition.",
|
||||
@@ -180,7 +207,7 @@
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"payloadType":{
|
||||
"payloadType": {
|
||||
"description": "The payload type.",
|
||||
"$ref": "../common/definitions.json#/definitions/PayloadType",
|
||||
"readOnly": false
|
||||
@@ -205,7 +232,9 @@
|
||||
"LakehouseCreationPayload": {
|
||||
"description": "**(Preview)** Lakehouse item payload. This property is currently required due to the schema enabled lakehouse being in preview. It might become redundant upon General Availability (GA).",
|
||||
"type": "object",
|
||||
"required": ["enableSchemas"],
|
||||
"required": [
|
||||
"enableSchemas"
|
||||
],
|
||||
"properties": {
|
||||
"enableSchemas": {
|
||||
"description": "Create a schema enabled lakehouse when set to true. Only 'true' is allowed.",
|
||||
@@ -214,7 +243,9 @@
|
||||
}
|
||||
},
|
||||
"Tables": {
|
||||
"required": ["data"],
|
||||
"required": [
|
||||
"data"
|
||||
],
|
||||
"description": "A paginated list of tables.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@@ -236,7 +267,12 @@
|
||||
}
|
||||
},
|
||||
"Table": {
|
||||
"required": ["type", "name", "location", "format"],
|
||||
"required": [
|
||||
"type",
|
||||
"name",
|
||||
"location",
|
||||
"format"
|
||||
],
|
||||
"description": "Table information.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@@ -261,7 +297,10 @@
|
||||
"TableType": {
|
||||
"type": "string",
|
||||
"description": "The table type. Additional `TableType` types may be added over time.",
|
||||
"enum": ["Managed", "External"],
|
||||
"enum": [
|
||||
"Managed",
|
||||
"External"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "TableType",
|
||||
"modelAsString": true,
|
||||
@@ -280,7 +319,10 @@
|
||||
"LoadTableRequest": {
|
||||
"type": "object",
|
||||
"description": "Represents a load table operation request.",
|
||||
"required": ["relativePath", "pathType"],
|
||||
"required": [
|
||||
"relativePath",
|
||||
"pathType"
|
||||
],
|
||||
"properties": {
|
||||
"relativePath": {
|
||||
"pattern": "^Files(\\/[\\p{L}\\w]{1}([ \\p{L}\\w\\.-]*[\\p{L}\\w\\.-]{1})*)*$",
|
||||
@@ -290,7 +332,10 @@
|
||||
"pathType": {
|
||||
"type": "string",
|
||||
"description": "The type of `relativePath`, either file or folder. Additional `PathType` types may be added over time.",
|
||||
"enum": ["File", "Folder"],
|
||||
"enum": [
|
||||
"File",
|
||||
"Folder"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "PathType",
|
||||
"modelAsString": true,
|
||||
@@ -314,7 +359,10 @@
|
||||
"mode": {
|
||||
"type": "string",
|
||||
"description": "The load table operation mode, overwrite or append. Additional mode types may be added over time.",
|
||||
"enum": ["Overwrite", "Append"],
|
||||
"enum": [
|
||||
"Overwrite",
|
||||
"Append"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "ModeType",
|
||||
"modelAsString": true,
|
||||
@@ -343,12 +391,17 @@
|
||||
"type": "object",
|
||||
"description": "Abstract type of data file format options.",
|
||||
"discriminator": "format",
|
||||
"required": ["format"],
|
||||
"required": [
|
||||
"format"
|
||||
],
|
||||
"properties": {
|
||||
"format": {
|
||||
"type": "string",
|
||||
"description": "Data file format name. Additional file format types may be added over time.",
|
||||
"enum": ["Csv", "Parquet"],
|
||||
"enum": [
|
||||
"Csv",
|
||||
"Parquet"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "FileFormat",
|
||||
"modelAsString": true,
|
||||
@@ -413,7 +466,9 @@
|
||||
"TableMaintenanceExecutionData": {
|
||||
"type": "object",
|
||||
"description": "Run on demand lakehouse table maintenance instance payload",
|
||||
"required": ["tableName"],
|
||||
"required": [
|
||||
"tableName"
|
||||
],
|
||||
"properties": {
|
||||
"tableName": {
|
||||
"type": "string",
|
||||
@@ -464,4 +519,4 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,58 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "f8113ba8-dd81-443e-811a-b385340f3f05",
|
||||
"lakehouseId": "8cee7699-2e81-4121-9a53-cc9025046193",
|
||||
"livyId": "9611f500-bf44-42e0-a0de-78dacb374398"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"sparkApplicationId": "application_1730933685452_0001",
|
||||
"state": "Cancelled",
|
||||
"livyId": "9611f500-bf44-42e0-a0de-78dacb374398",
|
||||
"origin": "SubmittedJob",
|
||||
"attemptNumber": 1,
|
||||
"maxNumberOfAttempts": 1,
|
||||
"livyName": "random_test_name_app",
|
||||
"submitter": {
|
||||
"id": "6f23a8a6-d954-4550-b91a-4df73ccd0311",
|
||||
"type": "User"
|
||||
},
|
||||
"item": {
|
||||
"workspaceId": "f8113ba8-dd81-443e-811a-b385340f3f05",
|
||||
"itemId": "8cee7699-2e81-4121-9a53-cc9025046193",
|
||||
"referenceType": "ById"
|
||||
},
|
||||
"itemName": "lh_itemName",
|
||||
"itemType": "Lakehouse",
|
||||
"jobType": "SparkBatch",
|
||||
"submittedDateTime": "2025-01-31T15:32:03Z",
|
||||
"startDateTime": "2025-01-31T15:34:11Z",
|
||||
"endDateTime": "2025-01-31T15:37:30Z",
|
||||
"queuedDuration": {
|
||||
"value": 1,
|
||||
"timeUnit": "Seconds"
|
||||
},
|
||||
"runningDuration": {
|
||||
"value": 180,
|
||||
"timeUnit": "Seconds"
|
||||
},
|
||||
"totalDuration": {
|
||||
"value": 360,
|
||||
"timeUnit": "Seconds"
|
||||
},
|
||||
"jobInstanceId": "c2baabbd-5327-430c-87a6-ff4f98285601",
|
||||
"creatorItem": {
|
||||
"workspaceId": "f8113ba8-dd81-443e-811a-b385340f3f05",
|
||||
"itemId": "8cee7699-2e81-4121-9a53-cc9025046193",
|
||||
"referenceType": "ById"
|
||||
},
|
||||
"cancellationReason": "User cancelled the Spark batch",
|
||||
"capacityId": "3c0cd366-dc28-4b6d-a525-4d415a8666e7",
|
||||
"operationName": "Batch Livy Run",
|
||||
"runtimeVersion": "1.3",
|
||||
"livySessionItemResourceUri": ""
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,63 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "f8113ba8-dd81-443e-811a-b385340f3f05",
|
||||
"lakehouseId": "8cee7699-2e81-4121-9a53-cc9025046193"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"continuationToken": null,
|
||||
"continuationUri": null,
|
||||
"value": [
|
||||
{
|
||||
"sparkApplicationId": "application_1730933685452_0001",
|
||||
"state": "Cancelled",
|
||||
"livyId": "9611f500-bf44-42e0-a0de-78dacb374398",
|
||||
"origin": "SubmittedJob",
|
||||
"attemptNumber": 1,
|
||||
"maxNumberOfAttempts": 1,
|
||||
"livyName": "random_test_name_app",
|
||||
"submitter": {
|
||||
"id": "6f23a8a6-d954-4550-b91a-4df73ccd0311",
|
||||
"type": "User"
|
||||
},
|
||||
"item": {
|
||||
"workspaceId": "f8113ba8-dd81-443e-811a-b385340f3f05",
|
||||
"itemId": "8cee7699-2e81-4121-9a53-cc9025046193",
|
||||
"referenceType": "ById"
|
||||
},
|
||||
"itemName": "lh_itemName",
|
||||
"itemType": "Lakehouse",
|
||||
"jobType": "SparkBatch",
|
||||
"submittedDateTime": "2025-01-31T15:32:03Z",
|
||||
"startDateTime": "2025-01-31T15:34:11Z",
|
||||
"endDateTime": "2025-01-31T15:37:30Z",
|
||||
"queuedDuration": {
|
||||
"value": 1,
|
||||
"timeUnit": "Seconds"
|
||||
},
|
||||
"runningDuration": {
|
||||
"value": 180,
|
||||
"timeUnit": "Seconds"
|
||||
},
|
||||
"totalDuration": {
|
||||
"value": 360,
|
||||
"timeUnit": "Seconds"
|
||||
},
|
||||
"jobInstanceId": "c2baabbd-5327-430c-87a6-ff4f98285601",
|
||||
"creatorItem": {
|
||||
"workspaceId": "f8113ba8-dd81-443e-811a-b385340f3f05",
|
||||
"itemId": "8cee7699-2e81-4121-9a53-cc9025046193",
|
||||
"referenceType": "ById"
|
||||
},
|
||||
"cancellationReason": "User cancelled the Spark batch",
|
||||
"capacityId": "3c0cd366-dc28-4b6d-a525-4d415a8666e7",
|
||||
"operationName": "Batch Livy Run",
|
||||
"runtimeVersion": "1.3",
|
||||
"livySessionItemResourceUri": ""
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
+123
-8
@@ -13,7 +13,7 @@
|
||||
"/workspaces/{workspaceId}/lakehouses": {
|
||||
"get": {
|
||||
"summary": "Returns a list of lakehouses from the specified workspace.",
|
||||
"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\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\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 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"
|
||||
],
|
||||
@@ -63,7 +63,7 @@
|
||||
},
|
||||
"post": {
|
||||
"summary": "Creates a lakehouse in the specified workspace.",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nThis API does not support create a lakehouse with definition.\n\n## Permissions\n\n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes \n\n 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) | Yes |\n\n## Interface",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nThis API does not support create a lakehouse with definition.\n\n## Permissions\n\n The caller must have a *contributor* workspace role. \n\n## Required Delegated Scopes \n\n 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) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
@@ -139,7 +139,7 @@
|
||||
"/workspaces/{workspaceId}/lakehouses/{lakehouseId}": {
|
||||
"get": {
|
||||
"summary": "Returns properties of the specified lakehouse.",
|
||||
"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",
|
||||
"description": "## Permissions\n\n The caller must have *read* permissions for the lakehouse. \n\n## Required Delegated Scopes \n\n Lakehouse.Read.All or Lakehouse.ReadWrite.All or Item.Read.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
@@ -190,7 +190,7 @@
|
||||
},
|
||||
"patch": {
|
||||
"summary": "Updates the properties of the specified lakehouse.",
|
||||
"description": "## Permissions\n\n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes \n\n 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) | Yes |\n\n## Interface",
|
||||
"description": "## Permissions\n\n The caller must have *read and write* permissions for the lakehouse. \n\n## Required Delegated Scopes \n\n 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) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
@@ -250,7 +250,7 @@
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Deletes the specified lakehouse.",
|
||||
"description": "## Permissions\n\n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes \n\n 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) | Yes |\n\n## Interface",
|
||||
"description": "## Permissions\n\n The caller must have *write* permissions for the lakehouse. \n\n## Required Delegated Scopes \n\n 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) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
@@ -297,7 +297,7 @@
|
||||
"/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). A maximum of 100 records can be returned per request. With the URI provided in the response, you can get the next page of records. \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",
|
||||
"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",
|
||||
"tags": [
|
||||
"Tables"
|
||||
],
|
||||
@@ -452,7 +452,7 @@
|
||||
"/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) | No |\n\n## Interface",
|
||||
"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",
|
||||
"tags": [
|
||||
"BackgroundJobs"
|
||||
],
|
||||
@@ -527,9 +527,124 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/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"
|
||||
},
|
||||
"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"
|
||||
}
|
||||
}
|
||||
},
|
||||
"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"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Get a livy session example": {
|
||||
"$ref": "./examples/GetSessionInItemId.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {},
|
||||
"security": [],
|
||||
"tags": []
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,636 @@
|
||||
{
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"title": "MirroredAzureDatabricksCatalog data types",
|
||||
"version": "v1"
|
||||
},
|
||||
"paths": {},
|
||||
"definitions": {
|
||||
"MirroredAzureDatabricksCatalogs": {
|
||||
"description": "A list of MirroredAzureDatabricksCatalogs.",
|
||||
"required": [
|
||||
"value"
|
||||
],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"value": {
|
||||
"description": "A list of MirroredAzureDatabricksCatalogs.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/MirroredAzureDatabricksCatalog"
|
||||
}
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
|
||||
}
|
||||
]
|
||||
},
|
||||
"MirroredAzureDatabricksCatalog": {
|
||||
"description": "A MirroredAzureDatabricksCatalog item.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"type"
|
||||
],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "../common/definitions.json#/definitions/Item"
|
||||
}
|
||||
],
|
||||
"properties": {
|
||||
"properties": {
|
||||
"description": "The MirroredAzureDatabricksCatalog properties.",
|
||||
"$ref": "#/definitions/MirroredAzureDatabricksCatalogProperties"
|
||||
}
|
||||
}
|
||||
},
|
||||
"MirroredAzureDatabricksCatalogProperties": {
|
||||
"required": [
|
||||
"oneLakeTablesPath",
|
||||
"catalogName",
|
||||
"databricksWorkspaceConnectionId",
|
||||
"autoSync",
|
||||
"mirroringMode"
|
||||
],
|
||||
"description": "The MirroredAzureDatabricksCatalog properties.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"catalogName": {
|
||||
"description": "Azure databricks catalog name.",
|
||||
"type": "string"
|
||||
},
|
||||
"databricksWorkspaceConnectionId": {
|
||||
"description": "The Azure databricks workspace connection id.",
|
||||
"type": "string",
|
||||
"format": "uuid"
|
||||
},
|
||||
"oneLakeTablesPath": {
|
||||
"description": "OneLake path to the MirroredAzureDatabricksCatalog tables directory.",
|
||||
"type": "string"
|
||||
},
|
||||
"sqlEndpointProperties": {
|
||||
"description": "An object containing the properties of the SQL endpoint.",
|
||||
"$ref": "#/definitions/SqlEndpointProperties"
|
||||
},
|
||||
"autoSync": {
|
||||
"description": "Auto sync the catalog. Additional `autoSync` types may be added over time.",
|
||||
"$ref": "#/definitions/AutoSync"
|
||||
},
|
||||
"mirroringMode": {
|
||||
"description": "Mirroring mode. Additional mirroringMode may be added over time.",
|
||||
"$ref": "#/definitions/MirroringModes"
|
||||
},
|
||||
"syncDetails": {
|
||||
"description": "The MirroredAzureDatabricksCatalog sync status.",
|
||||
"$ref": "#/definitions/SyncDetails"
|
||||
},
|
||||
"mirrorStatus": {
|
||||
"description": "The MirroredAzureDatabricksCatalog sync status.",
|
||||
"$ref": "#/definitions/MirrorStatus"
|
||||
},
|
||||
"storageConnectionId": {
|
||||
"description": "The storage connection id.",
|
||||
"type": "string",
|
||||
"format": "uuid"
|
||||
}
|
||||
}
|
||||
},
|
||||
"SqlEndpointProperties": {
|
||||
"required": [
|
||||
"id",
|
||||
"connectionString"
|
||||
],
|
||||
"description": "An object containing the properties of the SQL endpoint.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"description": "SQL endpoint ID.",
|
||||
"type": "string"
|
||||
},
|
||||
"connectionString": {
|
||||
"description": "SQL endpoint connection string.",
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"SyncDetails": {
|
||||
"required": [
|
||||
"status",
|
||||
"lastSyncDateTime"
|
||||
],
|
||||
"description": "The MirroredAzureDatabricksCatalog mirroring status.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"status": {
|
||||
"description": "The sync status. Additional status may be added over time.",
|
||||
"enum": [
|
||||
"NotStarted",
|
||||
"InProgress",
|
||||
"Success",
|
||||
"Failed"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "Status",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "NotStarted",
|
||||
"description": "The catalog mirroring is not started yet"
|
||||
},
|
||||
{
|
||||
"value": "InProgress",
|
||||
"description": "The mirroring process is currently in progress."
|
||||
},
|
||||
{
|
||||
"value": "Success",
|
||||
"description": "The catalog has been successfully mirrored."
|
||||
},
|
||||
{
|
||||
"value": "Failed",
|
||||
"description": "The mirroring process has failed."
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"lastSyncDateTime": {
|
||||
"description": "The last sync date time in UTC, using the YYYY-MM-DDTHH:mm:ssZ format.",
|
||||
"type": "string",
|
||||
"format": "date-time"
|
||||
},
|
||||
"errorInfo": {
|
||||
"description": "The error information.",
|
||||
"$ref": "#/definitions/ErrorInfo"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ErrorInfo": {
|
||||
"required": [
|
||||
"errorCode",
|
||||
"errorMessage"
|
||||
],
|
||||
"description": "The error information.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"errorCode": {
|
||||
"description": "The error code.",
|
||||
"type": "string"
|
||||
},
|
||||
"errorMessage": {
|
||||
"description": "The error message.",
|
||||
"type": "string"
|
||||
},
|
||||
"errorDetails": {
|
||||
"description": "The error details.",
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"CreateMirroredAzureDatabricksCatalogRequest": {
|
||||
"description": "Create MirroredAzureDatabricksCatalog request payload.",
|
||||
"required": [
|
||||
"displayName"
|
||||
],
|
||||
"properties": {
|
||||
"displayName": {
|
||||
"description": "The MirroredAzureDatabricksCatalog display name. The display name must follow naming rules according to item type.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"description": {
|
||||
"description": "The MirroredAzureDatabricksCatalog description. Maximum length is 256 characters.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"creationPayload": {
|
||||
"description": "The MirroredAzureDatabricksCatalog creation payload.",
|
||||
"$ref": "#/definitions/MirroredAzureDatabricksCatalogCreationPayload",
|
||||
"readOnly": false
|
||||
},
|
||||
"definition": {
|
||||
"description": "The MirroredAzureDatabricksCatalog public definition. Use `definition` or `creationPayload`. You can't use both at the same time.",
|
||||
"$ref": "#/definitions/MirroredAzureDatabricksCatalogPublicDefinition",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateMirroredAzureDatabricksCatalogRequest": {
|
||||
"description": "Update MirroredAzureDatabricksCatalog request.",
|
||||
"properties": {
|
||||
"displayName": {
|
||||
"description": "The MirroredAzureDatabricksCatalog display name. The display name must follow naming rules according to item type.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"description": {
|
||||
"description": "The MirroredAzureDatabricksCatalog description. Maximum length is 256 characters.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"publicUpdateableExtendedProperties": {
|
||||
"description": "The MirroredAzureDatabricksCatalog updateable properties payload.",
|
||||
"$ref": "#/definitions/MirroredAzureDatabricksCatalogUpdatePayload",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"MirroredAzureDatabricksCatalogCreationPayload": {
|
||||
"description": "MirroredAzureDatabricksCatalog create item payload.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"catalogName",
|
||||
"databricksWorkspaceConnectionId",
|
||||
"mirroringMode"
|
||||
],
|
||||
"properties": {
|
||||
"catalogName": {
|
||||
"description": "Azure databricks catalog name.",
|
||||
"type": "string"
|
||||
},
|
||||
"databricksWorkspaceConnectionId": {
|
||||
"description": "The Azure databricks workspace connection id.",
|
||||
"type": "string",
|
||||
"format": "uuid"
|
||||
},
|
||||
"mirroringMode": {
|
||||
"description": "Mirroring mode.",
|
||||
"$ref": "#/definitions/MirroringModes"
|
||||
},
|
||||
"storageConnectionId": {
|
||||
"description": "The storage connection id.",
|
||||
"type": "string",
|
||||
"format": "uuid"
|
||||
}
|
||||
}
|
||||
},
|
||||
"MirroredAzureDatabricksCatalogUpdatePayload": {
|
||||
"description": "MirroredAzureDatabricksCatalog update item payload.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"autoSync": {
|
||||
"description": "Auto sync the catalog.",
|
||||
"$ref": "#/definitions/AutoSync"
|
||||
},
|
||||
"mirroringMode": {
|
||||
"description": "Mirroring mode.",
|
||||
"$ref": "#/definitions/MirroringModes"
|
||||
},
|
||||
"storageConnectionId": {
|
||||
"description": "The storage connection id.",
|
||||
"type": "string",
|
||||
"format": "uuid"
|
||||
}
|
||||
}
|
||||
},
|
||||
"MirroredAzureDatabricksCatalogDefinitionResponse": {
|
||||
"description": "API for mirroredAzureDatabricksCatalog public definition response.",
|
||||
"required": [
|
||||
"definition"
|
||||
],
|
||||
"properties": {
|
||||
"definition": {
|
||||
"$ref": "#/definitions/MirroredAzureDatabricksCatalogPublicDefinition",
|
||||
"readOnly": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"MirroredAzureDatabricksCatalogPublicDefinition": {
|
||||
"description": "MirroredAzureDatabricksCatalog public definition object. Refer to this [article](/rest/api/fabric/articles/item-management/definitions/mirroredazuredatabrickscatalog-definition) for more details on how to craft a MirroredAzureDatabricksCatalog definition public definition.",
|
||||
"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/MirroredAzureDatabricksCatalogPublicDefinitionPart"
|
||||
},
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"MirroredAzureDatabricksCatalogPublicDefinitionPart": {
|
||||
"description": "MirroredAzureDatabricksCatalog definition part object.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"path",
|
||||
"payload",
|
||||
"payloadType"
|
||||
],
|
||||
"properties": {
|
||||
"path": {
|
||||
"description": "The MirroredAzureDatabricksCatalog part path.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"payload": {
|
||||
"description": "The MirroredAzureDatabricksCatalog part payload.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"payloadType": {
|
||||
"description": "The payload type.",
|
||||
"$ref": "../common/definitions.json#/definitions/PayloadType",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdatemirroredAzureDatabricksCatalogDefinitionRequest": {
|
||||
"description": "Update MirroredAzureDatabricksCatalog public definition request payload.",
|
||||
"required": [
|
||||
"definition"
|
||||
],
|
||||
"properties": {
|
||||
"definition": {
|
||||
"$ref": "#/definitions/MirroredAzureDatabricksCatalogPublicDefinition"
|
||||
}
|
||||
}
|
||||
},
|
||||
"AutoSync": {
|
||||
"description": "Enable or disable automatic synchronization for the catalog. When enabled, all metadata changes, including schemas and tables, are automatically synchronized every 15 minutes. When disabled, users must manually refresh the metadata. This setting can only be modified during an update request. Additional `autoSync` types may be added over time.",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"Enabled",
|
||||
"Disabled"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "AutoSync",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "Enabled",
|
||||
"description": "Automatic synchronization is enabled."
|
||||
},
|
||||
{
|
||||
"value": "Disabled",
|
||||
"description": "Automatic synchronization is disabled."
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"MirroringModes": {
|
||||
"description": "Mode for mirroring. Additional mirroringMode may be added over time.",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"Full",
|
||||
"Partial"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "MirroringModes",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "Full",
|
||||
"description": "Mirror everything inside a catalog except specifically excluded schemas and tables. Everything is synced by default if no exclusion is provided."
|
||||
},
|
||||
{
|
||||
"value": "Partial",
|
||||
"description": "Only selected schemas and tables are mirrored. Nothing is synced by default."
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"MirrorStatus": {
|
||||
"description": "Status of mirroring. Additional status may be added over time.",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"Mirrored",
|
||||
"NotMirrored"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "MirrorStatus",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "Mirrored",
|
||||
"description": "Indicates that the entire catalog has been successfully mirrored, ensuring that all schemas and tables from the source are fully synchronized with the MirroredAzureDatabricksCatalog item."
|
||||
},
|
||||
{
|
||||
"value": "NotMirrored",
|
||||
"description": "Indicates that the catalog has not been mirrored yet. No schemas or tables are synchronized by default unless explicitly configured."
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"DatabricksCatalogs": {
|
||||
"description": "A list of catalogs from Unity Catalog.",
|
||||
"required": [
|
||||
"value"
|
||||
],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"value": {
|
||||
"description": "A list of Catalogs.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/DatabricksCatalog"
|
||||
}
|
||||
},
|
||||
"Error": {
|
||||
"description": "Error is set if unable to fetch catalogs",
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
|
||||
}
|
||||
]
|
||||
},
|
||||
"DatabricksCatalog": {
|
||||
"description": "A catalog from Unity Catalog",
|
||||
"required": [
|
||||
"name",
|
||||
"catalogType",
|
||||
"storageLocation",
|
||||
"fullName"
|
||||
],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {
|
||||
"description": "The name of the catalog.",
|
||||
"type": "string"
|
||||
},
|
||||
"catalogType": {
|
||||
"description": "The type of the catalog.",
|
||||
"$ref": "#/definitions/CatalogType"
|
||||
},
|
||||
"storageLocation": {
|
||||
"description": "The storage location of the catalog.",
|
||||
"type": "string"
|
||||
},
|
||||
"fullName": {
|
||||
"description": "The full name of the catalog. This variable depends on name.",
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"CatalogType": {
|
||||
"description": "The type of the catalog. Additional CatalogType types may be added over time.",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"MANAGED_CATALOG"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "CatalogType",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "MANAGED_CATALOG",
|
||||
"description": "Managed Catalog"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"DatabricksSchemas": {
|
||||
"description": "A list of schemas from Unity Catalog.",
|
||||
"required": [
|
||||
"value"
|
||||
],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"value": {
|
||||
"description": "A list of Databricks schemas.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/DatabricksSchema"
|
||||
}
|
||||
},
|
||||
"Error": {
|
||||
"description": "Error is set if unable to fetch schemas",
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
|
||||
}
|
||||
]
|
||||
},
|
||||
"DatabricksSchema": {
|
||||
"description": "A schema from Unity Catalog",
|
||||
"required": [
|
||||
"name",
|
||||
"fullName"
|
||||
],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {
|
||||
"description": "The name of the schema, relative to the parent catalog.",
|
||||
"type": "string"
|
||||
},
|
||||
"storageLocation": {
|
||||
"description": "The storage location of the schema.",
|
||||
"type": "string"
|
||||
},
|
||||
"fullName": {
|
||||
"description": "The full name of the schema, in the form of catalog_name.schema_name.",
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DatabricksTables": {
|
||||
"description": "A list of tables from Unity Catalog.",
|
||||
"required": [
|
||||
"value"
|
||||
],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"value": {
|
||||
"description": "A list of Databricks tables.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/DatabricksTable"
|
||||
}
|
||||
},
|
||||
"Error": {
|
||||
"description": "Error is set if unable to fetch tables",
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
|
||||
}
|
||||
]
|
||||
},
|
||||
"DatabricksTable": {
|
||||
"description": "A table from Unity Catalog",
|
||||
"required": [
|
||||
"name",
|
||||
"storageLocation",
|
||||
"fullName",
|
||||
"tableType",
|
||||
"dataSourceFormat"
|
||||
],
|
||||
"properties": {
|
||||
"name": {
|
||||
"description": "The name of the table, relative to the parent schema.",
|
||||
"type": "string"
|
||||
},
|
||||
"storageLocation": {
|
||||
"description": "The storage location of the table.",
|
||||
"type": "string"
|
||||
},
|
||||
"fullName": {
|
||||
"description": "The full name of the table, in the form of catalog_name.schema_name.table_name.",
|
||||
"type": "string"
|
||||
},
|
||||
"tableType": {
|
||||
"description": "The type of the table.",
|
||||
"$ref": "#/definitions/TableType"
|
||||
},
|
||||
"dataSourceFormat": {
|
||||
"description": "The data source format of the table.",
|
||||
"$ref": "#/definitions/DataSourceFormat"
|
||||
}
|
||||
}
|
||||
},
|
||||
"TableType": {
|
||||
"description": "The type of the table. Additional TableType types may be added over time.",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"MANAGED",
|
||||
"EXTERNAL"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "TableType",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "MANAGED",
|
||||
"description": "Managed Table"
|
||||
},
|
||||
{
|
||||
"value": "EXTERNAL",
|
||||
"description": "External Table"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"DataSourceFormat": {
|
||||
"description": "The data source format of the table. Additional DataSourceFormat types may be added over time.",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"DELTA"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "DataSourceFormat",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "DELTA",
|
||||
"description": "Delta format"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
+41
@@ -0,0 +1,41 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"createMirroredAzureDatabricksCatalogRequest": {
|
||||
"displayName": "MirroredAzureDatabricksCatalog_created_with_definition",
|
||||
"description": "A MirroredAzureDatabricksCatalog created with definition.",
|
||||
"definition": {
|
||||
"parts": [
|
||||
{
|
||||
"path": "mirroredAzureDatabricksCatalog.json",
|
||||
"payload": "eyAicHJvcGVydGllcy..WJsZSIgfSB9IH0gXSB9IH0",
|
||||
"payloadType": "InlineBase64"
|
||||
},
|
||||
{
|
||||
"path": ".platform",
|
||||
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
|
||||
"payloadType": "InlineBase64"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"201": {
|
||||
"body": {
|
||||
"displayName": "MirroredAzureDatabricksCatalog_created_with_definition",
|
||||
"description": "A MirroredAzureDatabricksCatalog created with definition.",
|
||||
"type": "MirroredAzureDatabricksCatalog",
|
||||
"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
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
+33
@@ -0,0 +1,33 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"createMirroredAzureDatabricksCatalogRequest": {
|
||||
"displayName": "MirroredAzureDatabricksCatalog_created_with_creationPayload",
|
||||
"description": "A MirroredAzureDatabricksCatalog created with creation payload.",
|
||||
"creationPayload": {
|
||||
"catalogName": "catalog_1",
|
||||
"databricksWorkspaceConnectionId": "c1128f28-d84f-417c-8234-0feb91e35f86",
|
||||
"mirroringMode": "Full",
|
||||
"storageConnectionId": "c1128f28-d84f-417c-8234-0feb91e35f87"
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"201": {
|
||||
"body": {
|
||||
"displayName": "MirroredAzureDatabricksCatalog_created_with_creationPayload",
|
||||
"description": "A MirroredAzureDatabricksCatalog created with creation payload.",
|
||||
"type": "MirroredAzureDatabricksCatalog",
|
||||
"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
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"mirroredAzureDatabricksCatalogId": "5b218778-e7a5-4d73-8187-f10824047715"
|
||||
},
|
||||
"responses": {
|
||||
"200": {}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,28 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"databricksWorkspaceConnectionId": "c1128f28-d84f-417c-8234-0feb91e35f86"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"value": [
|
||||
{
|
||||
"name": "catalog_1",
|
||||
"catalogType": "MANAGED_CATALOG",
|
||||
"storageLocation": "abfss://default@externalaccount.dfs.core.windows.net/__unitystorage/catalogs/230217cd-94f2-4017-907d-768298b02e2b",
|
||||
"fullName": "catalog_1"
|
||||
},
|
||||
{
|
||||
"name": "catalog_2",
|
||||
"catalogType": "MANAGED_CATALOG",
|
||||
"storageLocation": "abfss://default@externalaccount.dfs.core.windows.net/__unitystorage/catalogs/230217cd-94f2-4017-907d-768298b02e2b",
|
||||
"fullName": "catalog_2"
|
||||
}
|
||||
],
|
||||
"continuationToken": null,
|
||||
"continuationUri": null
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,26 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"catalogName": "catalog_1",
|
||||
"databricksWorkspaceConnectionId": "c1128f28-d84f-417c-8234-0feb91e35f86"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"value": [
|
||||
{
|
||||
"name": "schema_1",
|
||||
"fullName": "catalog_1.schema_1",
|
||||
"storageLocation": "abfss://default@externalaccount.dfs.core.windows.net/__unitystorage/schemas/230217cd-94f2-4017-907d-768298b02e2b"
|
||||
},
|
||||
{
|
||||
"name": "schema_2",
|
||||
"fullName": "catalog_1.schema_2"
|
||||
}
|
||||
],
|
||||
"continuationToken": null,
|
||||
"continuationUri": null
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,32 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"catalogName": "catalog_1",
|
||||
"schemaName": "schema_1",
|
||||
"databricksWorkspaceConnectionId": "c1128f28-d84f-417c-8234-0feb91e35f86"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"value": [
|
||||
{
|
||||
"name": "table_1",
|
||||
"fullName": "catalog_1.schema_1.table_1",
|
||||
"storageLocation": "abfss://default@externalaccount.dfs.core.windows.net/__unitystorage/schemas/230217cd-94f2-4017-907d-768298b02e2b",
|
||||
"tableType": "MANAGED",
|
||||
"dataSourceFormat": "DELTA"
|
||||
},
|
||||
{
|
||||
"name": "table_2",
|
||||
"fullName": "catalog_1.schema_1.table_2",
|
||||
"storageLocation": "abfss://default@externalaccount.dfs.core.windows.net/__unitystorage/schemas/230217cd-94f2-4017-907d-768298b02e2b",
|
||||
"tableType": "MANAGED",
|
||||
"dataSourceFormat": "DELTA"
|
||||
}
|
||||
],
|
||||
"continuationToken": null,
|
||||
"continuationUri": null
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,35 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"mirroredAzureDatabricksCatalogId": "5b218778-e7a5-4d73-8187-f10824047715"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"id": "3546052c-ae64-4526-b1a8-52af7761426f",
|
||||
"displayName": "MirroredAzureDatabricksCatalog_1",
|
||||
"description": "A MirroredAzureDatabricksCatalog description.",
|
||||
"type": "MirroredAzureDatabricksCatalog",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"properties": {
|
||||
"catalogName": "catalog_1",
|
||||
"mirroringMode": "Full",
|
||||
"databricksWorkspaceConnectionId": "c1128f28-d84f-417c-8234-0feb91e35f86",
|
||||
"oneLakeTablesPath": "https://onelake.dfs.fabric.microsoft.com/2382cdf5-d577-44d0-a1fc-42184f29a7eb/e5fb215b-1934-413e-b33a-debaf844afde/Tables",
|
||||
"sqlEndpointProperties": {
|
||||
"connectionString": "qvrmbuxie7we7glrekxgy6npqu-6xgyei3x2xiejip4iime6knh5m.datawarehouse.fabric.microsoft.com",
|
||||
"id": "37dc8a41-dea9-465d-b528-3e95043b2356"
|
||||
},
|
||||
"syncDetails": {
|
||||
"status": "Success",
|
||||
"lastSyncDateTime": "2024-12-26T09:40:38.8583698Z",
|
||||
"errorInfo": null
|
||||
},
|
||||
"mirrorStatus": "Mirrored",
|
||||
"autoSync": "Enabled",
|
||||
"storageConnectionId": "c1128f28-d84f-417c-8234-0feb91e35f86"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Loaded 100 of 223 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user