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
0671eb13a7
commit
ace2b54cfe
7 files changed
+183
-9
No files matched your search
+1
-1
@@ -504,7 +504,7 @@
|
||||
"/workspaces": {
|
||||
"get": {
|
||||
"summary": "Returns a list of workspaces.",
|
||||
"description": "> [!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination). A maximum of 10,000 records can be returned per request. With the continuation token provided in the response, you can get the next 10,000 records.\n\n## Permissions\n\nThe caller must be a Fabric administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All\n\n## Limitations\n\nMaximum 200 requests per hour.\n\nThe `encryptionStatus` filter is applied only when the `include` parameter contains `encryption`.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/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). A maximum of 10,000 records can be returned per request. With the continuation token provided in the response, you can get the next 10,000 records.\n\n## Permissions\n\nThe caller must be a Fabric administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All\n\n## Limitations\n\nMaximum 200 requests per hour.\n\nThe `encryptionStatus` filter is applied only when the `include` parameter contains `encryption`.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Workspaces"
|
||||
],
|
||||
|
||||
@@ -11012,7 +11012,7 @@
|
||||
"/workspaces/{workspaceId}/encryption": {
|
||||
"get": {
|
||||
"summary": "Gets the workspace Customer-Managed Key (CMK) encryption settings.",
|
||||
"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\nReturns the CMK encryption settings and status for the specified workspace. \n\n## Permissions\n\n The caller must have *viewer* or higher workspace role. \n\n## Required Delegated Scopes\n\nWorkspace.Read.All or Workspace.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"description": "Returns the CMK encryption settings and status for the specified workspace. \n\n## Permissions\n\n The caller must have *viewer* or higher workspace role. \n\n## Required Delegated Scopes\n\nWorkspace.Read.All or Workspace.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Workspaces"
|
||||
],
|
||||
@@ -11070,7 +11070,7 @@
|
||||
"/workspaces/{workspaceId}/encryption/assign": {
|
||||
"post": {
|
||||
"summary": "Assigns a Customer-Managed Key (CMK) to a workspace.",
|
||||
"description": "> [!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\nEnables CMK encryption for the workspace or rotates the encryption key for the workspace. \n\n## Permissions\n\nThe caller must have an *admin* workspace role.\n\n## Required Delegated Scopes \n\nWorkspace.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"description": "Enables CMK encryption for the workspace or rotates the encryption key for the workspace. \n\n## Permissions\n\nThe caller must have an *admin* workspace role.\n\n## Required Delegated Scopes \n\nWorkspace.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Workspaces"
|
||||
],
|
||||
@@ -11131,7 +11131,7 @@
|
||||
"/workspaces/{workspaceId}/encryption/reset": {
|
||||
"post": {
|
||||
"summary": "Resets the workspace encryption by removing the Customer-Managed Key (CMK) encryption configuration.",
|
||||
"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\nAfter reset, the workspace data remains encrypted using Fabric's default Microsoft-managed keys. \n\n## Permissions\n\nThe caller must have an *admin* workspace role.\n\n## Required Delegated Scopes \n\nWorkspace.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"description": "After reset, the workspace data remains encrypted using Fabric's default Microsoft-managed keys. \n\n## Permissions\n\nThe caller must have an *admin* workspace role.\n\n## Required Delegated Scopes \n\nWorkspace.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Workspaces"
|
||||
],
|
||||
|
||||
@@ -36,15 +36,45 @@
|
||||
]
|
||||
},
|
||||
"SqlEndpointRefreshMetadataRequest": {
|
||||
"description": "Refresh SQL analaytics endpoint request payload.",
|
||||
"description": "The request payload for refreshing a SQL analytics endpoint.",
|
||||
"properties": {
|
||||
"timeout": {
|
||||
"description": "The request duration before timing out. The default value is 15 minutes.",
|
||||
"$ref": "../common/definitions.json#/definitions/Duration"
|
||||
},
|
||||
"recreateTables": {
|
||||
"description": "When set to true, this property instructs the system to drop and recreate all tables on SQL analytics endpoint during the refresh process. Use this option if you need to fully rebuild tables from their source definitions, for example to resolve inconsistencies or ensure a clean refresh. The default value is false.",
|
||||
"description": "When set to true, this property instructs the system to drop and recreate all tables on the SQL analytics endpoint during the refresh process. Use this option if you need to fully rebuild tables from their source definitions, for example, to resolve inconsistencies or ensure a clean refresh. When combined with `tables`, the sync state reset is scoped only to the specified tables. The default value is false.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"tables": {
|
||||
"description": "When provided, scopes the refresh to only the listed tables. When omitted or empty, all tables are refreshed. Each entry specifies a schema and one or more table names to refresh under that schema. The maximum number of tables that can be synchronized in a single request is 25. Table resolution depends on whether the SQL endpoint's parent item is schema-enabled. For schema-enabled items, tables are resolved using the caller-provided schema. For non-schema-enabled items, all tables resolve under the default schema regardless of the caller-provided schema value; tables under a non-default schema cannot be resolved and will be reported with a `DeltaTableNotFound` error.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/TableDefinition"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"TableDefinition": {
|
||||
"description": "A pair of schema and table names for scoping a selective refresh.",
|
||||
"type": "object",
|
||||
"required": ["schema", "tableNames"],
|
||||
"properties": {
|
||||
"schema": {
|
||||
"description": "The schema name for table resolution. Must not be a reserved system schema.",
|
||||
"type": "string",
|
||||
"minLength": 1,
|
||||
"maxLength": 128
|
||||
},
|
||||
"tableNames": {
|
||||
"description": "One or more table names to refresh under the specified schema.",
|
||||
"type": "array",
|
||||
"minItems": 1,
|
||||
"items": {
|
||||
"type": "string",
|
||||
"minLength": 1,
|
||||
"maxLength": 128
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -74,7 +104,7 @@
|
||||
],
|
||||
"properties": {
|
||||
"tableName": {
|
||||
"description": "The name of the table that synchronized.",
|
||||
"description": "The name of the table that synchronized. For schema-enabled items, the table name is prefixed with the schema name (e.g., \"schema.tableName\").",
|
||||
"type": "string"
|
||||
},
|
||||
"startDateTime": {
|
||||
|
||||
@@ -0,0 +1,51 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"sqlEndpointId": "5b218778-e7a5-4d73-8187-f10824047715",
|
||||
"sqlEndpointRefreshMetadataRequest": {
|
||||
"tables": [
|
||||
{
|
||||
"schema": "dbo",
|
||||
"tableNames": ["Orders", "OrderDetails"]
|
||||
},
|
||||
{
|
||||
"schema": "dbo",
|
||||
"tableNames": ["DailySummary"]
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"value": [
|
||||
{
|
||||
"tableName": "Orders",
|
||||
"startDateTime": "2026-06-09T14:31:22.2708973Z",
|
||||
"endDateTime": "2026-06-09T14:31:25.9651741Z",
|
||||
"status": "Success",
|
||||
"lastSuccessfulSyncDateTime": "2026-06-09T14:31:25.9651741Z"
|
||||
},
|
||||
{
|
||||
"tableName": "OrderDetails",
|
||||
"startDateTime": "2026-06-09T14:31:22.2708973Z",
|
||||
"endDateTime": "2026-06-09T14:31:26.5329616Z",
|
||||
"status": "Failure",
|
||||
"error": {
|
||||
"errorCode": "DeltaTableNotFound",
|
||||
"message": "Delta table 'Tables\\OrderDetails\\_delta_log' not found."
|
||||
},
|
||||
"lastSuccessfulSyncDateTime": "2026-06-08T10:31:26.5329616Z"
|
||||
},
|
||||
{
|
||||
"tableName": "DailySummary",
|
||||
"startDateTime": "2026-06-09T14:31:22.2708973Z",
|
||||
"endDateTime": "2026-06-09T14:31:24.9183509Z",
|
||||
"status": "NotRun",
|
||||
"lastSuccessfulSyncDateTime": "2026-06-08T08:32:53.3890146Z"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,37 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"sqlEndpointId": "5b218778-e7a5-4d73-8187-f10824047715",
|
||||
"sqlEndpointRefreshMetadataRequest": {
|
||||
"recreateTables": true,
|
||||
"tables": [
|
||||
{
|
||||
"schema": "dbo",
|
||||
"tableNames": ["Orders", "OrderDetails"]
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"value": [
|
||||
{
|
||||
"tableName": "Orders",
|
||||
"startDateTime": "2026-06-09T14:31:22.2708973Z",
|
||||
"endDateTime": "2026-06-09T14:31:25.9651741Z",
|
||||
"status": "Success",
|
||||
"lastSuccessfulSyncDateTime": "2026-06-09T14:31:25.9651741Z"
|
||||
},
|
||||
{
|
||||
"tableName": "OrderDetails",
|
||||
"startDateTime": "2026-06-09T14:31:22.2708973Z",
|
||||
"endDateTime": "2026-06-09T14:31:26.5329616Z",
|
||||
"status": "Success",
|
||||
"lastSuccessfulSyncDateTime": "2026-06-09T14:31:26.5329616Z"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,47 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"sqlEndpointId": "5b218778-e7a5-4d73-8187-f10824047715",
|
||||
"sqlEndpointRefreshMetadataRequest": {
|
||||
"tables": [
|
||||
{
|
||||
"schema": "sales",
|
||||
"tableNames": ["Orders", "OrderDetails"]
|
||||
},
|
||||
{
|
||||
"schema": "analytics",
|
||||
"tableNames": ["DailySummary"]
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"value": [
|
||||
{
|
||||
"tableName": "sales.Orders",
|
||||
"startDateTime": "2026-06-09T14:31:22.2708973Z",
|
||||
"endDateTime": "2026-06-09T14:31:25.9651741Z",
|
||||
"status": "Success",
|
||||
"lastSuccessfulSyncDateTime": "2026-06-09T14:31:25.9651741Z"
|
||||
},
|
||||
{
|
||||
"tableName": "sales.OrderDetails",
|
||||
"startDateTime": "2026-06-09T14:31:22.2708973Z",
|
||||
"endDateTime": "2026-06-09T14:31:26.5329616Z",
|
||||
"status": "Success",
|
||||
"lastSuccessfulSyncDateTime": "2026-06-09T14:31:26.5329616Z"
|
||||
},
|
||||
{
|
||||
"tableName": "analytics.DailySummary",
|
||||
"startDateTime": "2026-06-09T14:31:22.2708973Z",
|
||||
"endDateTime": "2026-06-09T14:31:24.9183509Z",
|
||||
"status": "Success",
|
||||
"lastSuccessfulSyncDateTime": "2026-06-09T14:31:24.9183509Z"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -92,8 +92,8 @@
|
||||
},
|
||||
"/workspaces/{workspaceId}/sqlEndpoints/{sqlEndpointId}/refreshMetadata": {
|
||||
"post": {
|
||||
"summary": "Refreshes all tables within a SQL analytics endpoint.",
|
||||
"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\nItem.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/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": "Refreshes tables within a SQL analytics endpoint.",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen `tables` is provided in the request body, only the specified tables are refreshed. When omitted or empty, all tables are refreshed.\n\n## Permissions\n\nThe caller must have *contributor* or higher workspace role.\n\n## Required Delegated Scopes\n\nItem.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/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"
|
||||
],
|
||||
@@ -179,6 +179,15 @@
|
||||
"x-ms-examples": {
|
||||
"Refresh all tables for a specified SQL analytics endpoint in a workspace": {
|
||||
"$ref": "./examples/RefreshAllTablesInSqlEndpoint.json"
|
||||
},
|
||||
"Refresh selective tables for a specified SQL analytics endpoint in a workspace": {
|
||||
"$ref": "./examples/RefreshSelectiveTablesInSqlEndpoint.json"
|
||||
},
|
||||
"Refresh selective tables with recreate tables for a specified SQL analytics endpoint in a workspace": {
|
||||
"$ref": "./examples/RefreshSelectiveTablesWithRecreateTables.json"
|
||||
},
|
||||
"Refresh selective tables with user defined schemas for a specified SQL analytics endpoint in a workspace": {
|
||||
"$ref": "./examples/RefreshSelectiveTablesWithUserDefinedSchemas.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Reference in new issue
Block a user