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
96f5abcf1e
commit
3dd4d339aa
24 files changed
+1809
-1215
No files matched your search
@@ -26,6 +26,9 @@
|
||||
],
|
||||
"description": "This is a request wrapper for a creating a list of tags.",
|
||||
"properties": {
|
||||
"scope": {
|
||||
"$ref": "../../common/definitions.json#/definitions/TagScope"
|
||||
},
|
||||
"createTagsRequest": {
|
||||
"type": "array",
|
||||
"description": "An array of createTagRequest",
|
||||
@@ -70,7 +73,8 @@
|
||||
"description": "Represents a tag.",
|
||||
"required": [
|
||||
"id",
|
||||
"displayName"
|
||||
"displayName",
|
||||
"scope"
|
||||
],
|
||||
"properties": {
|
||||
"id": {
|
||||
@@ -81,6 +85,9 @@
|
||||
"displayName": {
|
||||
"type": "string",
|
||||
"description": "The name of the tag."
|
||||
},
|
||||
"scope": {
|
||||
"$ref": "../../common/definitions.json#/definitions/TagScope"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
||||
@@ -6,31 +6,55 @@
|
||||
"value": [
|
||||
{
|
||||
"id": "bc23d4c6-cc92-4eb6-bcb5-0ff98429bbff",
|
||||
"displayName": "Finance"
|
||||
"displayName": "Finance",
|
||||
"scope": {
|
||||
"type": "Tenant"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "b0bca781-003c-4041-b1c4-f94d34ba76d4",
|
||||
"displayName": "Human resources"
|
||||
"displayName": "Human resources",
|
||||
"scope": {
|
||||
"type": "Tenant"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "6af5a1b6-bc4c-4c0a-b60d-30c68e6e3034",
|
||||
"displayName": "Engineering P1"
|
||||
"displayName": "Engineering P1",
|
||||
"scope": {
|
||||
"type": "Tenant"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "6c00e8eb-51d4-46f7-8b90-7e98520ea7a0",
|
||||
"displayName": "Marketing Q1"
|
||||
"displayName": "Marketing Q1",
|
||||
"scope": {
|
||||
"type": "Tenant"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "17df435d-9efd-48c1-a937-7d6fd70ab26a",
|
||||
"displayName": "HR Sales Q1"
|
||||
"displayName": "HR Sales Q1",
|
||||
"scope": {
|
||||
"type": "Domain",
|
||||
"domainId": "2443f5f3-b2bb-46ad-a240-1550f1938569"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "fb765fe3-d404-4f24-9d67-5916449c4c50",
|
||||
"displayName": "Root"
|
||||
"displayName": "Root",
|
||||
"scope": {
|
||||
"type": "Domain",
|
||||
"domainId": "2443f5f3-b2bb-46ad-a240-1550f1938569"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "bda31be4-7efe-4272-8b85-e1b2ff0f0592",
|
||||
"displayName": "Legal EMEA"
|
||||
"displayName": "Legal EMEA",
|
||||
"scope": {
|
||||
"type": "Domain",
|
||||
"domainId": "2443f5f3-b2bb-46ad-a240-1550f1938569"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
@@ -6,31 +6,55 @@
|
||||
"value": [
|
||||
{
|
||||
"id": "bc23d4c6-cc92-4eb6-bcb5-0ff98429bbff",
|
||||
"displayName": "Finance"
|
||||
"displayName": "Finance",
|
||||
"scope": {
|
||||
"type": "Tenant"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "b0bca781-003c-4041-b1c4-f94d34ba76d4",
|
||||
"displayName": "Human resources"
|
||||
"displayName": "Human resources",
|
||||
"scope": {
|
||||
"type": "Tenant"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "6af5a1b6-bc4c-4c0a-b60d-30c68e6e3034",
|
||||
"displayName": "Engineering P1"
|
||||
"displayName": "Engineering P1",
|
||||
"scope": {
|
||||
"type": "Tenant"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "6c00e8eb-51d4-46f7-8b90-7e98520ea7a0",
|
||||
"displayName": "Marketing Q1"
|
||||
"displayName": "Marketing Q1",
|
||||
"scope": {
|
||||
"type": "Tenant"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "17df435d-9efd-48c1-a937-7d6fd70ab26a",
|
||||
"displayName": "HR Sales Q1"
|
||||
"displayName": "HR Sales Q1",
|
||||
"scope": {
|
||||
"type": "Domain",
|
||||
"domainId": "2443f5f3-b2bb-46ad-a240-1550f1938569"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "fb765fe3-d404-4f24-9d67-5916449c4c50",
|
||||
"displayName": "Root"
|
||||
"displayName": "Root",
|
||||
"scope": {
|
||||
"type": "Domain",
|
||||
"domainId": "2443f5f3-b2bb-46ad-a240-1550f1938569"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "bda31be4-7efe-4272-8b85-e1b2ff0f0592",
|
||||
"displayName": "Legal EMEA"
|
||||
"displayName": "Legal EMEA",
|
||||
"scope": {
|
||||
"type": "Domain",
|
||||
"domainId": "2443f5f3-b2bb-46ad-a240-1550f1938569"
|
||||
}
|
||||
}
|
||||
],
|
||||
"continuationToken": "LDEsMTAwMDAwLDA%3D",
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
{
|
||||
"parameters": {
|
||||
"scope": {
|
||||
"type": "Domain",
|
||||
"domainId": "e408a2ca-0e43-49d6-86d3-f2558508d32a"
|
||||
},
|
||||
"createTagsRequest": [
|
||||
{ "displayName": "Finance 2024" },
|
||||
{ "displayName": "HR 2024" }
|
||||
]
|
||||
},
|
||||
"responses": {
|
||||
"201": {
|
||||
"body": {
|
||||
"tags": [
|
||||
{
|
||||
"id": "e281785b-5608-41ac-a1a1-78b48b95b825",
|
||||
"displayName": "Finance 2024",
|
||||
"scope": {
|
||||
"type": "Domain",
|
||||
"domainId": "e408a2ca-0e43-49d6-86d3-f2558508d32a"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "24402490-9519-48b9-9d51-b2db4095a56b",
|
||||
"displayName": "HR 2024",
|
||||
"scope": {
|
||||
"type": "Domain",
|
||||
"domainId": "e408a2ca-0e43-49d6-86d3-f2558508d32a"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
{
|
||||
"parameters": {
|
||||
"createTagsRequest": [
|
||||
{ "displayName": "Finance 2024" },
|
||||
{ "displayName": "HR 2024" }
|
||||
]
|
||||
},
|
||||
"responses": {
|
||||
"201": {
|
||||
"body": {
|
||||
"tags": [
|
||||
{
|
||||
"id": "e281785b-5608-41ac-a1a1-78b48b95b825",
|
||||
"displayName": "Finance 2024",
|
||||
"scope": {
|
||||
"type": "Tenant"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "24402490-9519-48b9-9d51-b2db4095a56b",
|
||||
"displayName": "HR 2024",
|
||||
"scope": {
|
||||
"type": "Tenant"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,34 @@
|
||||
{
|
||||
"parameters": {
|
||||
"scope": {
|
||||
"type": "Tenant"
|
||||
},
|
||||
"createTagsRequest": [
|
||||
{ "displayName": "Finance 2024" },
|
||||
{ "displayName": "HR 2024" }
|
||||
]
|
||||
},
|
||||
"responses": {
|
||||
"201": {
|
||||
"body": {
|
||||
"tags": [
|
||||
{
|
||||
"id": "e281785b-5608-41ac-a1a1-78b48b95b825",
|
||||
"displayName": "Finance 2024",
|
||||
"scope": {
|
||||
"type": "Tenant"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "24402490-9519-48b9-9d51-b2db4095a56b",
|
||||
"displayName": "HR 2024",
|
||||
"scope": {
|
||||
"type": "Tenant"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -9,7 +9,10 @@
|
||||
"200": {
|
||||
"body": {
|
||||
"id": "d889df97-7061-45f6-98b8-c53a83c2cf68",
|
||||
"displayName": "Tag's new name."
|
||||
"displayName": "Tag's new name.",
|
||||
"scope": {
|
||||
"type": "Tenant"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
+9
-3
@@ -1623,15 +1623,21 @@
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* UnknownError - An error occurred \n\n* InvalidInputs - Invalid input was provided \n\n* EntityConflict - Tag display name already exists",
|
||||
"description": "Common error codes:\n\n* UnknownError - An error occurred \n\n* InvalidInputs - Invalid input was provided \n\n* EntityConflict - Tag display name already exists \n\n* EntityNotFound - Domain ID does not exist",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Create tags in bulk example": {
|
||||
"$ref": "./examples/Tags/CreateTags.json"
|
||||
"Create tenant tags in bulk example": {
|
||||
"$ref": "./examples/Tags/CreateTenantTags.json"
|
||||
},
|
||||
"Create tenant tags in bulk example with explicit scope": {
|
||||
"$ref": "./examples/Tags/CreateTenantTagsExplicit.json"
|
||||
},
|
||||
"Create domain tags in bulk example": {
|
||||
"$ref": "./examples/Tags/CreateDomainTags.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
+66
-2
@@ -644,7 +644,8 @@
|
||||
"description": "Represents a tag.",
|
||||
"required": [
|
||||
"id",
|
||||
"displayName"
|
||||
"displayName",
|
||||
"scope"
|
||||
],
|
||||
"properties": {
|
||||
"id": {
|
||||
@@ -655,6 +656,10 @@
|
||||
"displayName": {
|
||||
"type": "string",
|
||||
"description": "The name of the tag."
|
||||
},
|
||||
"scope": {
|
||||
"$ref": "#/definitions/TagScope",
|
||||
"description": "The scope of the tag."
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -698,7 +703,66 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
|
||||
"TagScope": {
|
||||
"type": "object",
|
||||
"description": "Represents a tag scope",
|
||||
"discriminator": "type",
|
||||
"required": [
|
||||
"type"
|
||||
],
|
||||
"properties": {
|
||||
"type":{
|
||||
"description": "Denotes tag scope. Additional tag scopes may be added over time.",
|
||||
"type": "string",
|
||||
"enum": ["Tenant", "Domain"],
|
||||
"x-ms-enum": {
|
||||
"name": "TagScopeType",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "Tenant",
|
||||
"description": "Tag is a tenant level tag."
|
||||
},
|
||||
{
|
||||
"value": "Domain",
|
||||
"description": "Tag is a domain level tag."
|
||||
}
|
||||
]
|
||||
},
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"TenantTagScope": {
|
||||
"type": "object",
|
||||
"description": "Represents tenant tag scope.",
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/TagScope"
|
||||
}
|
||||
],
|
||||
"x-ms-discriminator-value": "Tenant"
|
||||
},
|
||||
"DomainTagScope": {
|
||||
"type": "object",
|
||||
"description": "Represents domain tag scope.",
|
||||
"required": [
|
||||
"domainId"
|
||||
],
|
||||
"properties": {
|
||||
"domainId": {
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"description": "Domain object ID"
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/TagScope"
|
||||
}
|
||||
],
|
||||
"x-ms-discriminator-value": "Domain"
|
||||
},
|
||||
"ItemReference": {
|
||||
"description": "An item reference object.",
|
||||
"type": "object",
|
||||
|
||||
@@ -384,10 +384,10 @@
|
||||
"type": "object",
|
||||
"description": "Represents an operation on a column.",
|
||||
"required": [
|
||||
"operationType"
|
||||
"type"
|
||||
],
|
||||
"properties": {
|
||||
"operationType": {
|
||||
"type": {
|
||||
"type": "string",
|
||||
"description": "The operation type.",
|
||||
"enum": [
|
||||
@@ -396,7 +396,7 @@
|
||||
"Rename"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "operationType",
|
||||
"name": "type",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
@@ -419,7 +419,7 @@
|
||||
"description": "The alias of the operation."
|
||||
}
|
||||
},
|
||||
"discriminator": "operationType"
|
||||
"discriminator": "type"
|
||||
},
|
||||
"ManageFieldsFunctionCallOperation": {
|
||||
"type": "object",
|
||||
|
||||
@@ -6,28 +6,30 @@
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"id": "2e4c91e7-0c4a-4cc4-abe3-cc7ba4310a37",
|
||||
"name": "LakehouseDestination",
|
||||
"type": "Lakehouse",
|
||||
"properties": {
|
||||
"workspaceId": "9625b495-17b3-4d6c-aeea-a81ae76ba369",
|
||||
"itemId": "ee579458-85ea-4652-bd77-5c7d7c298b2a",
|
||||
"schema": "dbo",
|
||||
"deltaTable": "deltaTable",
|
||||
"inputSerialization": {
|
||||
"type": "Json",
|
||||
"properties": {
|
||||
"encoding": "UTF8"
|
||||
"body": {
|
||||
"id": "2e4c91e7-0c4a-4cc4-abe3-cc7ba4310a37",
|
||||
"name": "LakehouseDestination",
|
||||
"type": "Lakehouse",
|
||||
"properties": {
|
||||
"workspaceId": "9625b495-17b3-4d6c-aeea-a81ae76ba369",
|
||||
"itemId": "ee579458-85ea-4652-bd77-5c7d7c298b2a",
|
||||
"schema": "dbo",
|
||||
"deltaTable": "deltaTable",
|
||||
"inputSerialization": {
|
||||
"type": "Json",
|
||||
"properties": {
|
||||
"encoding": "UTF8"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"inputNodes": [
|
||||
{
|
||||
"name": "InputNodeName"
|
||||
}
|
||||
],
|
||||
"status": "Running",
|
||||
"error": null
|
||||
},
|
||||
"inputNodes": [
|
||||
{
|
||||
"name": "InputNodeName"
|
||||
}
|
||||
],
|
||||
"status": "Running",
|
||||
"error": null
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -6,14 +6,16 @@
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"fullyQualifiedNamespace": "namespace.servicebus.windows.net",
|
||||
"eventHubName": "eventhub",
|
||||
"consumerGroupName": "$Default",
|
||||
"accessKeys": {
|
||||
"primaryKey": "key1",
|
||||
"secondaryKey": "key2",
|
||||
"primaryConnectionString": "connectionString1",
|
||||
"secondaryConnectionString": "connectionString2"
|
||||
"body": {
|
||||
"fullyQualifiedNamespace": "namespace.servicebus.windows.net",
|
||||
"eventHubName": "eventhub",
|
||||
"consumerGroupName": "$Default",
|
||||
"accessKeys": {
|
||||
"primaryKey": "key1",
|
||||
"secondaryKey": "key2",
|
||||
"primaryConnectionString": "connectionString1",
|
||||
"secondaryConnectionString": "connectionString2"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -6,21 +6,23 @@
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"id": "e2886002-d696-4c05-969c-51361365cc24",
|
||||
"name": "AzureEventHubSource",
|
||||
"type": "AzureEventHub",
|
||||
"properties": {
|
||||
"dataConnectionId": "9c500070-073f-4a88-b478-8fabe1941c52",
|
||||
"consumerGroupName": "$Default",
|
||||
"inputSerialization": {
|
||||
"type": "Json",
|
||||
"properties": {
|
||||
"encoding": "UTF8"
|
||||
"body": {
|
||||
"id": "e2886002-d696-4c05-969c-51361365cc24",
|
||||
"name": "AzureEventHubSource",
|
||||
"type": "AzureEventHub",
|
||||
"properties": {
|
||||
"dataConnectionId": "9c500070-073f-4a88-b478-8fabe1941c52",
|
||||
"consumerGroupName": "$Default",
|
||||
"inputSerialization": {
|
||||
"type": "Json",
|
||||
"properties": {
|
||||
"encoding": "UTF8"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"status": "Running",
|
||||
"error": null
|
||||
},
|
||||
"status": "Running",
|
||||
"error": null
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -6,13 +6,15 @@
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"fullyQualifiedNamespace": "namespace.servicebus.windows.net",
|
||||
"eventHubName": "eventhub",
|
||||
"accessKeys": {
|
||||
"primaryKey": "key1",
|
||||
"secondaryKey": "key2",
|
||||
"primaryConnectionString": "connectionString1",
|
||||
"secondaryConnectionString": "connectionString2"
|
||||
"body": {
|
||||
"fullyQualifiedNamespace": "namespace.servicebus.windows.net",
|
||||
"eventHubName": "eventhub",
|
||||
"accessKeys": {
|
||||
"primaryKey": "key1",
|
||||
"secondaryKey": "key2",
|
||||
"primaryConnectionString": "connectionString1",
|
||||
"secondaryConnectionString": "connectionString2"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
File diff suppressed because it is too large.
Load diff
@@ -720,8 +720,8 @@
|
||||
},
|
||||
"/workspaces/{workspaceId}/eventstreams/{eventstreamId}/sources/{sourceId}/connection": {
|
||||
"get": {
|
||||
"summary": "Returns the connection information of specified source of the eventstream. Only custom endpoints sources are supported.",
|
||||
"description": "## Permissions\n\n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes \n\n Eventstream.ReadWrite.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"summary": "Returns the connection information of specified source of the eventstream.",
|
||||
"description": "## Permissions\n\n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes \n\n Eventstream.ReadWrite.All or Item.ReadWrite.All\n\n## Limitations\n\n Only custom endpoints sources are supported.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Topology"
|
||||
],
|
||||
@@ -778,8 +778,8 @@
|
||||
},
|
||||
"/workspaces/{workspaceId}/eventstreams/{eventstreamId}/destinations/{destinationId}/connection": {
|
||||
"get": {
|
||||
"summary": "Returns the connection information of a specified destination of the eventstream. Only custom endpoints destinations are supported.",
|
||||
"description": "## Permissions\n\n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes \n\n Eventstream.ReadWrite.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"summary": "Returns the connection information of a specified destination of the eventstream.",
|
||||
"description": "## Permissions\n\n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes \n\n Eventstream.ReadWrite.All or Item.ReadWrite.All\n\n## Limitations\n\n Only custom endpoints destinations are supported.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Topology"
|
||||
],
|
||||
|
||||
+543
-513
File diff suppressed because it is too large.
Load diff
@@ -0,0 +1,40 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1",
|
||||
"lakehouseId": "dddddddd-9999-0000-1111-eeeeeeeeeeee",
|
||||
"jobType": "RefreshMaterializedLakeViews",
|
||||
"createScheduleRequest": {
|
||||
"enabled": true,
|
||||
"configuration": {
|
||||
"startDateTime": "2025-04-28T00:00:00",
|
||||
"endDateTime": "2025-04-30T23:59:00",
|
||||
"localTimeZoneId": "Central Standard Time",
|
||||
"type": "Cron",
|
||||
"interval": 10
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"201": {
|
||||
"headers": {
|
||||
"Location": "https://api.fabric.microsoft.com/v1/workspaces/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/items/dddddddd-9999-0000-1111-eeeeeeeeeeee/jobs/RefreshMaterializedLakeViews/schedules/bbbbbbbb-1111-2222-3333-cccccccccccc"
|
||||
},
|
||||
"body": {
|
||||
"id": "bbbbbbbb-1111-2222-3333-cccccccccccc",
|
||||
"enabled": true,
|
||||
"createdDateTime": "2024-05-28T05:35:20.5366667",
|
||||
"configuration": {
|
||||
"startDateTime": "2025-04-28T00:00:00",
|
||||
"endDateTime": "2025-04-30T23:59:00",
|
||||
"localTimeZoneId": "Central Standard Time",
|
||||
"type": "Cron",
|
||||
"interval": 10
|
||||
},
|
||||
"owner": {
|
||||
"id": "33dd33dd-ee44-ff55-aa66-77bb77bb77bb",
|
||||
"type": "User"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,10 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1",
|
||||
"lakehouseId": "dddddddd-9999-0000-1111-eeeeeeeeeeee",
|
||||
"scheduleId": "bbbbbbbb-1111-2222-3333-cccccccccccc"
|
||||
},
|
||||
"responses": {
|
||||
"200": {}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,37 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1",
|
||||
"lakehouseId": "dddddddd-9999-0000-1111-eeeeeeeeeeee",
|
||||
"scheduleId": "bbbbbbbb-1111-2222-3333-cccccccccccc",
|
||||
"updateScheduleRequest": {
|
||||
"enabled": false,
|
||||
"configuration": {
|
||||
"startDateTime": "2025-05-01T00:00:00",
|
||||
"endDateTime": "2025-05-31T23:59:00",
|
||||
"localTimeZoneId": "Pacific Standard Time",
|
||||
"type": "Cron",
|
||||
"interval": 15
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"id": "bbbbbbbb-1111-2222-3333-cccccccccccc",
|
||||
"enabled": false,
|
||||
"createdDateTime": "2024-05-28T05:35:20.5366667",
|
||||
"configuration": {
|
||||
"startDateTime": "2025-05-01T00:00:00",
|
||||
"endDateTime": "2025-05-31T23:59:00",
|
||||
"localTimeZoneId": "Pacific Standard Time",
|
||||
"type": "Cron",
|
||||
"interval": 15
|
||||
},
|
||||
"owner": {
|
||||
"id": "33dd33dd-ee44-ff55-aa66-77bb77bb77bb",
|
||||
"type": "User"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
+189
-1
@@ -528,6 +528,71 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/lakehouses/{lakehouseId}/jobs/RefreshMaterializedLakeViews/schedules": {
|
||||
"post": {
|
||||
"summary": "Create a new Refresh MaterializedLakeViews schedule for a lakehouse.",
|
||||
"description": "> [!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\n## Required Delegated Scopes: \n\n(Lakehouse.Execute.All or Item.Execute.All) and (Lakehouse.ReadWrite.All or Item.ReadWrite.All)\n\n## Limitations \n- A lakehouse can create maximum 20 schedulers.\n- Materialized Lake View supports only one active refresh schedule per lineage.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
|
||||
"tags": [
|
||||
"BackgroundJobs"
|
||||
],
|
||||
"operationId": "BackgroundJobs_CreateRefreshMaterializedLakeViewsSchedule",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "workspaceId",
|
||||
"description": "The workspace ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "lakehouseId",
|
||||
"description": "The lakehouse ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "body",
|
||||
"name": "createScheduleRequest",
|
||||
"description": "A lakehouse refresh materialized lake views schedule create request.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/CreateLakehouseRefreshMaterializedLakeViewsScheduleRequest"
|
||||
},
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"201": {
|
||||
"description": "Successfully create the schedule.",
|
||||
"headers": {
|
||||
"Location": {
|
||||
"description": "The URL of the newly created schedule.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/LakehouseRefreshMaterializedLakeViewsSchedule"
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* InsufficientPrivileges - The caller does not have sufficient permissions to access the item\n\n* ItemNotFound - Requested item id not found\n\n* ScheduleExceedsLimit - The number of created schedules for the item exceeds the limit",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Create lakehouse Refresh MaterializedLakeViews schedule example": {
|
||||
"$ref": "./examples/CreateLakehouseRefreshMaterializedLakeViewsSchedule.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/lakehouses/{lakehouseId}/livySessions": {
|
||||
"get": {
|
||||
"tags": [
|
||||
@@ -694,7 +759,7 @@
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* MissingMinimalPermisisons - The caller does not have sufficient permissions to run job instance. n\n* InvalidJobType - The requested job type is invalid. \n\n* TooManyRequestsForJobs - The caller is making to many run on-demand job requests. \n\n* ItemNotFound - Requested item id not found.",
|
||||
"description": "Common error codes:\n\n* MissingMinimalPermissions - The caller does not have sufficient permissions to run job instance. n\n* InvalidJobType - The requested job type is invalid. \n\n* TooManyRequestsForJobs - The caller is making too many run on-demand job requests. \n\n* ItemNotFound - Requested item id not found.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
@@ -706,6 +771,129 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/lakehouses/{lakehouseId}/jobs/RefreshMaterializedLakeViews/schedules/{scheduleId}": {
|
||||
"patch": {
|
||||
"summary": "Update an existing Refresh MaterializedLakeViews schedule for a lakehouse.",
|
||||
"description": "> [!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\n## Required Delegated Scopes: \n\n(Lakehouse.Execute.All or Item.Execute.All) and (Lakehouse.ReadWrite.All or Item.ReadWrite.All)\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
|
||||
"tags": [
|
||||
"BackgroundJobs"
|
||||
],
|
||||
"operationId": "BackgroundJobs_UpdateRefreshMaterializedLakeViewsSchedule",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "workspaceId",
|
||||
"description": "The workspace ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "lakehouseId",
|
||||
"description": "The lakehouse ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "scheduleId",
|
||||
"description": "The lakehouse schedule ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "body",
|
||||
"name": "updateScheduleRequest",
|
||||
"description": "A lakehouse refresh materialized lake views schedule update request.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/UpdateLakehouseRefreshMaterializedLakeViewsScheduleRequest"
|
||||
},
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/LakehouseRefreshMaterializedLakeViewsSchedule"
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* InsufficientPrivileges - The caller does not have sufficient permissions to access the item\n\n* ItemNotFound - Requested item id not found",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Update lakehouse Refresh MaterializedLakeViews schedule example": {
|
||||
"$ref": "./examples/UpdateLakehouseRefreshMaterializedLakeViewsSchedule.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Delete an existing Refresh MaterializedLakeViews schedule for a lakehouse.",
|
||||
"description": "> [!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\n## Required Delegated Scopes\n\nLakehouse.ReadWrite.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
|
||||
"tags": [
|
||||
"BackgroundJobs"
|
||||
],
|
||||
"operationId": "BackgroundJobs_DeleteRefreshMaterializedLakeViewsSchedule",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "workspaceId",
|
||||
"description": "The workspace ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "lakehouseId",
|
||||
"description": "The lakehouse ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "scheduleId",
|
||||
"description": "The lakehouse schedule ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully."
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* InsufficientPrivileges - The caller does not have sufficient permissions to access the item\n\n* ItemNotFound - Requested item ID not found",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Delete lakehouse Refresh MaterializedLakeViews schedule example": {
|
||||
"$ref": "./examples/DeleteLakehouseRefreshMaterializedLakeViewsSchedule.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {},
|
||||
|
||||
@@ -1949,6 +1949,7 @@
|
||||
},
|
||||
"UpdateScheduleRequest": {
|
||||
"description": "Update item schedule plan request payload.",
|
||||
"type": "object",
|
||||
"required": [ "enabled", "configuration" ],
|
||||
"properties": {
|
||||
"enabled": {
|
||||
|
||||
@@ -6,31 +6,55 @@
|
||||
"value": [
|
||||
{
|
||||
"id": "bc23d4c6-cc92-4eb6-bcb5-0ff98429bbff",
|
||||
"displayName": "Finance"
|
||||
"displayName": "Finance",
|
||||
"scope": {
|
||||
"type": "Tenant"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "b0bca781-003c-4041-b1c4-f94d34ba76d4",
|
||||
"displayName": "Human resources"
|
||||
"displayName": "Human resources",
|
||||
"scope": {
|
||||
"type": "Tenant"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "6af5a1b6-bc4c-4c0a-b60d-30c68e6e3034",
|
||||
"displayName": "Engineering P1"
|
||||
"displayName": "Engineering P1",
|
||||
"scope": {
|
||||
"type": "Tenant"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "6c00e8eb-51d4-46f7-8b90-7e98520ea7a0",
|
||||
"displayName": "Marketing Q1"
|
||||
"displayName": "Marketing Q1",
|
||||
"scope": {
|
||||
"type": "Tenant"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "17df435d-9efd-48c1-a937-7d6fd70ab26a",
|
||||
"displayName": "HR Sales Q1"
|
||||
"displayName": "HR Sales Q1",
|
||||
"scope": {
|
||||
"type": "Domain",
|
||||
"domainId": "2443f5f3-b2bb-46ad-a240-1550f1938569"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "fb765fe3-d404-4f24-9d67-5916449c4c50",
|
||||
"displayName": "Root"
|
||||
"displayName": "Root",
|
||||
"scope": {
|
||||
"type": "Domain",
|
||||
"domainId": "2443f5f3-b2bb-46ad-a240-1550f1938569"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "bda31be4-7efe-4272-8b85-e1b2ff0f0592",
|
||||
"displayName": "Legal EMEA"
|
||||
"displayName": "Legal EMEA",
|
||||
"scope": {
|
||||
"type": "Domain",
|
||||
"domainId": "2443f5f3-b2bb-46ad-a240-1550f1938569"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
@@ -6,31 +6,55 @@
|
||||
"value": [
|
||||
{
|
||||
"id": "bc23d4c6-cc92-4eb6-bcb5-0ff98429bbff",
|
||||
"displayName": "Finance"
|
||||
"displayName": "Finance",
|
||||
"scope": {
|
||||
"type": "Tenant"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "b0bca781-003c-4041-b1c4-f94d34ba76d4",
|
||||
"displayName": "Human resources"
|
||||
"displayName": "Human resources",
|
||||
"scope": {
|
||||
"type": "Tenant"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "6af5a1b6-bc4c-4c0a-b60d-30c68e6e3034",
|
||||
"displayName": "Engineering P1"
|
||||
"displayName": "Engineering P1",
|
||||
"scope": {
|
||||
"type": "Tenant"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "6c00e8eb-51d4-46f7-8b90-7e98520ea7a0",
|
||||
"displayName": "Marketing Q1"
|
||||
"displayName": "Marketing Q1",
|
||||
"scope": {
|
||||
"type": "Tenant"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "17df435d-9efd-48c1-a937-7d6fd70ab26a",
|
||||
"displayName": "HR Sales Q1"
|
||||
"displayName": "HR Sales Q1",
|
||||
"scope": {
|
||||
"type": "Domain",
|
||||
"domainId": "2443f5f3-b2bb-46ad-a240-1550f1938569"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "fb765fe3-d404-4f24-9d67-5916449c4c50",
|
||||
"displayName": "Root"
|
||||
"displayName": "Root",
|
||||
"scope": {
|
||||
"type": "Domain",
|
||||
"domainId": "2443f5f3-b2bb-46ad-a240-1550f1938569"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "bda31be4-7efe-4272-8b85-e1b2ff0f0592",
|
||||
"displayName": "Legal EMEA"
|
||||
"displayName": "Legal EMEA",
|
||||
"scope": {
|
||||
"type": "Domain",
|
||||
"domainId": "2443f5f3-b2bb-46ad-a240-1550f1938569"
|
||||
}
|
||||
}
|
||||
],
|
||||
"continuationToken": "LDEsMTAwMDAwLDA%3D",
|
||||
|
||||
Reference in new issue
Block a user