From 198c6f5ba5097c8477b5e67f1122c14d3547dd34 Mon Sep 17 00:00:00 2001 From: Fabric-APIs-Publish-Specification-Pipeline Date: Tue, 8 Sep 2026 22:14:41 +0000 Subject: [PATCH] Updating swagger files. --- admin/swagger.json | 14 +-- common/spark_definitions.json | 6 + environment/definitions.json | 57 +++++++++ .../examples/GetEnvironmentSparkCompute.json | 11 +- .../UpdateEnvironmentSparkCompute.json | 21 +++- ...ronmentSparkComputeInstancePoolWithId.json | 3 +- platform/definitions/gateways.json | 18 +-- platform/definitions/gitIntegration.json | 70 ++++++++++- platform/definitions/platform.json | 38 ++++++ .../CommitToGit_FileLevelSelective.json | 33 +++++ .../GetStatus_WithFileDetails.json | 71 +++++++++++ .../BulkExportItemDefinitionsAll.json | 1 - .../BulkExportItemDefinitionsSelective.json | 1 - .../platform/BulkImportItemDefinitions.json | 1 - .../GetOneLakeSettingsWithAllSettings.json | 3 +- ...odifyOneLakeAccessTimeTrackingDisable.json | 11 ++ ...ModifyOneLakeAccessTimeTrackingEnable.json | 11 ++ platform/swagger.json | 118 ++++++++++++++---- 18 files changed, 433 insertions(+), 55 deletions(-) create mode 100644 platform/examples/gitIntegration/CommitToGit_FileLevelSelective.json create mode 100644 platform/examples/gitIntegration/GetStatus_WithFileDetails.json create mode 100644 platform/examples/platform/ModifyOneLakeAccessTimeTrackingDisable.json create mode 100644 platform/examples/platform/ModifyOneLakeAccessTimeTrackingEnable.json diff --git a/admin/swagger.json b/admin/swagger.json index 0eabe82..6f917f2 100644 --- a/admin/swagger.json +++ b/admin/swagger.json @@ -71,7 +71,7 @@ "/tenantsettings/{tenantSettingName}/update": { "post": { "summary": "Update a given tenant setting.", - "description": "> [!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\n## Permissions\n\nThe caller must be a Fabric administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\n Tenant.ReadWrite.All\n\n## Limitations\n\nMaximum 25 requests per minute.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "description": "## Permissions\n\nThe caller must be a Fabric administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.ReadWrite.All\n\n## Limitations\n\nMaximum 25 requests per minute.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", "tags": [ "Tenants" ], @@ -134,7 +134,7 @@ "/capacities/delegatedTenantSettingOverrides": { "get": { "summary": "Returns list of tenant setting overrides that override at the capacities.", - "description": "> [!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination). A maximum of 10,000 records can be returned per request. With the continuation token provided in the response, you can get the next 10,000 records.\n\nThe user must be a Fabric Service Administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All\n\n## Limitations\n\nMaximum 25 requests per minute.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "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 Service Administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All\n\n## Limitations\n\nMaximum 25 requests per minute.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", "tags": [ "Tenants" ], @@ -192,7 +192,7 @@ "/capacities/{capacityId}/delegatedTenantSettingOverrides": { "get": { "summary": "Returns list of tenant setting overrides that override for given capacity Id.", - "description": "> [!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\n## Permissions\n\nThe caller must be a Fabric administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All\n\n## Limitations\n\nMaximum 100 requests per minute.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "description": "## Permissions\n\nThe caller must be a Fabric administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All\n\n## Limitations\n\nMaximum 100 requests per minute.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", "tags": [ "Tenants" ], @@ -258,7 +258,7 @@ "/capacities/{capacityId}/delegatedTenantSettingOverrides/{tenantSettingName}": { "delete": { "summary": "Remove given tenant setting override for given capacity Id.", - "description": "> [!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\n## Permissions\n\nThe caller must be a Fabric administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.ReadWrite.All\n\n## Limitations\n\nMaximum 25 requests per minute.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "description": "## Permissions\n\nThe caller must be a Fabric administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.ReadWrite.All\n\n## Limitations\n\nMaximum 25 requests per minute.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", "tags": [ "Tenants" ], @@ -317,7 +317,7 @@ "/capacities/{capacityId}/delegatedTenantSettingOverrides/{tenantSettingName}/update": { "post": { "summary": "Update given tenant setting override for given capacity Id.", - "description": "> [!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\n## Permissions\n\nThe caller must be a Fabric administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.ReadWrite.All\n\n## Limitations\n\nMaximum 25 requests per minute.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "description": "## Permissions\n\nThe caller must be a Fabric administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.ReadWrite.All\n\n## Limitations\n\nMaximum 25 requests per minute.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", "tags": [ "Tenants" ], @@ -388,7 +388,7 @@ "/domains/delegatedTenantSettingOverrides": { "get": { "summary": "Returns list of domain delegation setting overrides.", - "description": "> [!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination). A maximum of 10,000 records can be returned per request. With the continuation token provided in the response, you can get the next 10,000 records.\n\nThe user must be a Fabric Service Administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All\n\n## Limitations\n\nMaximum 25 requests per minute.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "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 Service Administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All\n\n## Limitations\n\nMaximum 25 requests per minute.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", "tags": [ "Tenants" ], @@ -446,7 +446,7 @@ "/workspaces/delegatedTenantSettingOverrides": { "get": { "summary": "Returns list of workspace delegation setting overrides.", - "description": "> [!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination). A maximum of 10,000 records can be returned per request. With the continuation token provided in the response, you can get the next 10,000 records.\n\nThe user must be a Fabric Service Administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All\n\n## Limitations\n\nMaximum 25 requests per minute.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "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 Service Administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All\n\n## Limitations\n\nMaximum 25 requests per minute.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", "tags": [ "Tenants" ], diff --git a/common/spark_definitions.json b/common/spark_definitions.json index 899c0d9..6506cb5 100644 --- a/common/spark_definitions.json +++ b/common/spark_definitions.json @@ -313,6 +313,12 @@ "format": "uuid", "description": "Instance pool ID.", "type": "string" + }, + "maxClustersToHydrateLimit": { + "description": "Server-computed upper bound for the live pool `maxClustersToHydrate` setting, determined by the capacity size associated with this pool.", + "format": "int32", + "type": "integer", + "readOnly": true } } }, diff --git a/environment/definitions.json b/environment/definitions.json index 03ed5ef..7189f8a 100644 --- a/environment/definitions.json +++ b/environment/definitions.json @@ -126,6 +126,14 @@ "runtimeVersion": { "description": "Runtime version, find the supported [fabric runtimes](/fabric/data-engineering/runtime). For example: 1.3", "type": "string" + }, + "customLivePoolSupport": { + "description": "Controls whether the live pool is enabled. When `Enabled`, clusters are pre-hydrated according to the hydration settings so that workloads start without cold-start latency.", + "$ref": "#/definitions/CustomLivePoolSupport" + }, + "customLivePoolSettings": { + "description": "Live pool hydration settings. Controls how clusters are pre-hydrated when live pool support is enabled.", + "$ref": "#/definitions/CustomLivePoolSettings" } } }, @@ -171,6 +179,14 @@ "runtimeVersion": { "description": "Runtime version, find the supported [fabric runtimes](/fabric/data-engineering/runtime). For example: 1.3", "type": "string" + }, + "customLivePoolSupport": { + "description": "Controls whether the live pool is active. Setting `Disabled` turns it off but retains the hydration settings. Omit to leave the existing value unchanged.", + "$ref": "#/definitions/CustomLivePoolSupport" + }, + "customLivePoolSettings": { + "description": "Live pool hydration settings. Pass `null` to remove the hydration settings entirely. Omit to leave the existing value unchanged.", + "$ref": "#/definitions/CustomLivePoolSettings" } } }, @@ -650,6 +666,47 @@ } } }, + "CustomLivePoolSettings": { + "description": "Live pool hydration settings on the environment's spark compute.", + "type": "object", + "properties": { + "maxClustersToHydrate": { + "description": "Maximum number of clusters to pre-hydrate during each activation cycle. Minimum: 1. The maximum allowed value is determined by the capacity size and is exposed on the instance pool settings as `InstancePool.maxClustersToHydrateLimit`.", + "format": "int32", + "type": "integer", + "minimum": 1 + }, + "clusterIdleTimeout": { + "description": "Idle-time threshold after which a hydrated cluster is released, using the ISO 8601 duration format. Minimum: PT20M. Maximum: PT24H.", + "format": "duration", + "type": "string" + }, + "customLivePoolLifespan": { + "description": "Maximum lifetime of a live pool activation, using the ISO 8601 duration format. The live pool job runs for this duration and then terminates. Minimum: PT30M. Maximum: PT24H.", + "format": "duration", + "type": "string" + } + } + }, + "CustomLivePoolSupport": { + "type": "string", + "description": "Flag controlling whether live pool support is active. Additional `CustomLivePoolSupport` values may be added over time.", + "enum": ["Enabled", "Disabled"], + "x-ms-enum": { + "name": "CustomLivePoolSupport", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "Live pool support is active." + }, + { + "value": "Disabled", + "description": "Live pool support is inactive. Configuration is retained." + } + ] + } + }, "LibrariesPreview": { "description": "Environment libraries.", "type": "object", diff --git a/environment/examples/GetEnvironmentSparkCompute.json b/environment/examples/GetEnvironmentSparkCompute.json index 569b0a2..dfe83c4 100644 --- a/environment/examples/GetEnvironmentSparkCompute.json +++ b/environment/examples/GetEnvironmentSparkCompute.json @@ -10,7 +10,8 @@ "instancePool": { "name": "MyWorkspacePool", "type": "Workspace", - "id": "78942136-106c-4f3e-80fc-7ff4eae11603" + "id": "78942136-106c-4f3e-80fc-7ff4eae11603", + "maxClustersToHydrateLimit": 10 }, "driverCores": 4, "driverMemory": "56g", @@ -27,7 +28,13 @@ "value": "false" } ], - "runtimeVersion": "1.2" + "runtimeVersion": "1.2", + "customLivePoolSupport": "Enabled", + "customLivePoolSettings": { + "maxClustersToHydrate": 4, + "clusterIdleTimeout": "PT20M", + "customLivePoolLifespan": "PT1H" + } } } } diff --git a/environment/examples/UpdateEnvironmentSparkCompute.json b/environment/examples/UpdateEnvironmentSparkCompute.json index 8faea57..81f7f2c 100644 --- a/environment/examples/UpdateEnvironmentSparkCompute.json +++ b/environment/examples/UpdateEnvironmentSparkCompute.json @@ -27,7 +27,13 @@ "value": null } ], - "runtimeVersion": "1.2" + "runtimeVersion": "1.2", + "customLivePoolSupport": "Enabled", + "customLivePoolSettings": { + "maxClustersToHydrate": 4, + "clusterIdleTimeout": "PT20M", + "customLivePoolLifespan": "PT1H" + } } }, "responses": { @@ -36,7 +42,8 @@ "instancePool": { "name": "MyWorkspacePool", "type": "Workspace", - "id": "78942136-106c-4f3e-80fc-7ff4eae11603" + "id": "78942136-106c-4f3e-80fc-7ff4eae11603", + "maxClustersToHydrateLimit": 10 }, "driverCores": 4, "driverMemory": "56g", @@ -53,8 +60,14 @@ "value": "false" } ], - "runtimeVersion": "1.2" + "runtimeVersion": "1.2", + "customLivePoolSupport": "Enabled", + "customLivePoolSettings": { + "maxClustersToHydrate": 4, + "clusterIdleTimeout": "PT20M", + "customLivePoolLifespan": "PT1H" + } } } } -} \ No newline at end of file +} diff --git a/environment/examples/UpdateEnvironmentSparkComputeInstancePoolWithId.json b/environment/examples/UpdateEnvironmentSparkComputeInstancePoolWithId.json index 2e7dd8e..ed3be2f 100644 --- a/environment/examples/UpdateEnvironmentSparkComputeInstancePoolWithId.json +++ b/environment/examples/UpdateEnvironmentSparkComputeInstancePoolWithId.json @@ -15,7 +15,8 @@ "instancePool": { "name": "MyWorkspacePool", "type": "Workspace", - "id": "78942136-106c-4f3e-80fc-7ff4eae11603" + "id": "78942136-106c-4f3e-80fc-7ff4eae11603", + "maxClustersToHydrateLimit": 10 }, "driverCores": 4, "driverMemory": "56g", diff --git a/platform/definitions/gateways.json b/platform/definitions/gateways.json index 0a38c8e..b2c7e4a 100644 --- a/platform/definitions/gateways.json +++ b/platform/definitions/gateways.json @@ -200,17 +200,17 @@ "type": "integer" }, "numberOfMemberGateways": { - "description": "The number of member gateways. A number between 1 and 9.", + "description": "The number of member gateways. A number between 1 and 11.", "type": "integer", "readOnly": false }, "maxMemberGatewayCount": { - "description": "The maximum number of member gateways. A number between 1 and 9.", + "description": "The maximum number of member gateways. A number between 1 and 11.", "type": "integer", "readOnly": false }, "minMemberGatewayCount": { - "description": "The minimum number of member gateways. A number between 1 and 9.", + "description": "The minimum number of member gateways. A number between 1 and 11.", "type": "integer", "readOnly": false } @@ -295,17 +295,17 @@ "type": "integer" }, "numberOfMemberGateways": { - "description": "The number of member gateways. A number between 1 and 9. Cannot be used together with maxMemberGatewayCount and minMemberGatewayCount.", + "description": "The number of member gateways. A number between 1 and 11. Cannot be used together with maxMemberGatewayCount and minMemberGatewayCount.", "type": "integer", "readOnly": false }, "maxMemberGatewayCount": { - "description": "The maximum number of member gateways. A number between 1 and 9. Cannot be used together with numberOfMemberGateways. minMemberGatewayCount must also be specified. maxMemberGatewayCount value must be greater than or equal to minMemberGatewayCount value.", + "description": "The maximum number of member gateways. A number between 1 and 11. Cannot be used together with numberOfMemberGateways. minMemberGatewayCount must also be specified. maxMemberGatewayCount value must be greater than or equal to minMemberGatewayCount value.", "type": "integer", "readOnly": false }, "minMemberGatewayCount": { - "description": "The minimum number of member gateways. A number between 1 and 9. Cannot be used together with numberOfMemberGateways. maxMemberGatewayCount must also be specified. minMemberGatewayCount value must be less than or equal to maxMemberGatewayCount value.", + "description": "The minimum number of member gateways. A number between 1 and 11. Cannot be used together with numberOfMemberGateways. maxMemberGatewayCount must also be specified. minMemberGatewayCount value must be less than or equal to maxMemberGatewayCount value.", "type": "integer", "readOnly": false } @@ -390,17 +390,17 @@ "type": "integer" }, "numberOfMemberGateways": { - "description": "The number of member gateways. A number between 1 and 9. Cannot be used together with maxMemberGatewayCount and minMemberGatewayCount.", + "description": "The number of member gateways. A number between 1 and 11. Cannot be used together with maxMemberGatewayCount and minMemberGatewayCount.", "type": "integer", "readOnly": false }, "maxMemberGatewayCount": { - "description": "The maximum number of member gateways. A number between 1 and 9. Cannot be used together with numberOfMemberGateways. minMemberGatewayCount must also be specified. maxMemberGatewayCount value must be greater than or equal to minMemberGatewayCount value.", + "description": "The maximum number of member gateways. A number between 1 and 11. Cannot be used together with numberOfMemberGateways. minMemberGatewayCount must also be specified. maxMemberGatewayCount value must be greater than or equal to minMemberGatewayCount value.", "type": "integer", "readOnly": false }, "minMemberGatewayCount": { - "description": "The minimum number of member gateways. A number between 1 and 9. Cannot be used together with numberOfMemberGateways. maxMemberGatewayCount must also be specified. minMemberGatewayCount value must be less than or equal to maxMemberGatewayCount value.", + "description": "The minimum number of member gateways. A number between 1 and 11. Cannot be used together with numberOfMemberGateways. maxMemberGatewayCount must also be specified. minMemberGatewayCount value must be less than or equal to maxMemberGatewayCount value.", "type": "integer", "readOnly": false } diff --git a/platform/definitions/gitIntegration.json b/platform/definitions/gitIntegration.json index bd232fc..d23a4cc 100644 --- a/platform/definitions/gitIntegration.json +++ b/platform/definitions/gitIntegration.json @@ -300,6 +300,33 @@ ] } }, + "GitFileChange": { + "description": "Contains information about a file-level change within an item.", + "type": "object", + "required": ["path", "conflictType"], + "properties": { + "path": { + "type": "string", + "description": "The file path relative to the item root. It uses forward slashes and has no leading slash.", + "readOnly": true + }, + "workspaceChange": { + "$ref": "#/definitions/ChangeType", + "description": "Change on the workspace side.", + "readOnly": true + }, + "remoteChange": { + "$ref": "#/definitions/ChangeType", + "description": "Change on the remote Git side.", + "readOnly": true + }, + "conflictType": { + "$ref": "#/definitions/ConflictType", + "description": "The conflict state for this file.", + "readOnly": true + } + } + }, "ItemIdentifier": { "description": "Contains the item identifier. At least one of the properties must be defined.", "type": "object", @@ -318,6 +345,24 @@ } } }, + "ItemIdentifierWithFileSelection": { + "description": "Contains the item identifier with optional file-level selection for commit operations.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ItemIdentifier" + } + ], + "properties": { + "selectedFiles": { + "type": "array", + "description": "File paths to commit, relative to the item root. Paths use forward slashes only, no leading slash, full file paths only (no directories or wildcards), no empty or whitespace-only segments, and segments cannot end with a dot or trailing whitespace. If null or empty, all files for this item are committed.", + "items": { + "type": "string" + } + } + } + }, "ItemMetadata": { "description": "Contains the item metadata.", "type": "object", @@ -364,6 +409,14 @@ "$ref": "#/definitions/ConflictType", "description": "When there are changes on both the workspace side and the remote Git side.", "readOnly": true + }, + "fileChanges": { + "type": "array", + "description": "A list of file-level changes within the item. Only populated when the includeFilesDetails query parameter is set to true.", + "readOnly": true, + "items": { + "$ref": "#/definitions/GitFileChange" + } } } }, @@ -395,7 +448,7 @@ "CommitMode": { "type": "string", "description": "Modes for the commit operation. Additional modes may be added over time.", - "enum": ["All", "Selective"], + "enum": ["All", "Selective", "FileLevelSelective"], "x-ms-enum": { "name": "CommitMode", "modelAsString": true, @@ -406,7 +459,11 @@ }, { "value": "Selective", - "description": "Commit a specified items list that has uncommitted changes." + "description": "Commit a specified list of items that have uncommitted changes. Use the `items` property to specify items." + }, + { + "value": "FileLevelSelective", + "description": "Commit specified files within specified items. Use the `itemsWithFileSelection` property to specify items and files." } ] } @@ -431,10 +488,17 @@ }, "items": { "type": "array", - "description": "Specific items to commit.\nThis is relevant only for Selective commit mode.\nThe items can be retrieved from the [Git Status](/rest/api/fabric/core/git/get-status) API.", + "description": "Specific items to commit. This is relevant only for the Selective commit mode. Mutually exclusive with itemsWithFileSelection.\nThe items can be retrieved from the [Git Status](/rest/api/fabric/core/git/get-status) API.", "items": { "$ref": "#/definitions/ItemIdentifier" } + }, + "itemsWithFileSelection": { + "type": "array", + "description": "Items with per-file selection for the FileLevelSelective commit mode. Mutually exclusive with items.\nEach entry specifies an item and optionally a list of file paths to commit. If selectedFiles is null or empty for an item, all files for that item are committed.", + "items": { + "$ref": "#/definitions/ItemIdentifierWithFileSelection" + } } } }, diff --git a/platform/definitions/platform.json b/platform/definitions/platform.json index d585bd2..666d9e1 100644 --- a/platform/definitions/platform.json +++ b/platform/definitions/platform.json @@ -2656,6 +2656,44 @@ "policy": { "description": "Indicates whether there is at least one active lifecycle rule in the workspace.", "$ref": "#/definitions/OneLakeLifecyclePolicyStatus" + }, + "accessTimeTracking": { + "description": "Indicates whether Azure Storage access time tracking (LastAccessTime updates) is enabled for OneLake files in the workspace.", + "$ref": "#/definitions/AccessTimeTrackingStatus" + } + } + }, + "AccessTimeTrackingStatus": { + "description": "The status of OneLake access time tracking. When enabled, Azure Storage updates the LastAccessTime property on file reads and writes. Additional status values may be added over time.", + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "AccessTimeTrackingStatus", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "Access time tracking is enabled. Azure Storage updates LastAccessTime on file reads and writes." + }, + { + "value": "Disabled", + "description": "Access time tracking is disabled. LastAccessTime is not updated on file access." + } + ] + } + }, + "ModifyAccessTimeTrackingRequest": { + "description": "Modify OneLake access time tracking request.", + "type": "object", + "required": [ "status" ], + "properties": { + "status": { + "description": "The desired access time tracking status.", + "$ref": "#/definitions/AccessTimeTrackingStatus", + "readOnly": false } } }, diff --git a/platform/examples/gitIntegration/CommitToGit_FileLevelSelective.json b/platform/examples/gitIntegration/CommitToGit_FileLevelSelective.json new file mode 100644 index 0000000..2c4df18 --- /dev/null +++ b/platform/examples/gitIntegration/CommitToGit_FileLevelSelective.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "workspaceId": "1565e6a3-c020-4c0c-dda7-92bafe99eec5", + "commitToGitRequest": { + "mode": "FileLevelSelective", + "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4", + "comment": "Commit only the metadata change from MyNotebook", + "itemsWithFileSelection": [ + { + "objectId": "cfafbeb1-8037-4d0c-896e-28c4f2e65573", + "selectedFiles": [ + "metadata.json" + ] + }, + { + "objectId": "d5a2b3c4-1234-5678-abcd-ef0123456789", + "selectedFiles": [] + } + ] + } + }, + "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 + } + } + } +} diff --git a/platform/examples/gitIntegration/GetStatus_WithFileDetails.json b/platform/examples/gitIntegration/GetStatus_WithFileDetails.json new file mode 100644 index 0000000..4ff4d72 --- /dev/null +++ b/platform/examples/gitIntegration/GetStatus_WithFileDetails.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "workspaceId": "1455b6a2-c120-4c1c-dda7-92bafe99bec3", + "includeFilesDetails": true + }, + "responses": { + "200": { + "body": { + "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4", + "remoteCommitHash": "7d03b2918bf6aa62f96d0a4307293f3853201705", + "changes": [ + { + "itemMetadata": { + "itemIdentifier": { + "objectId": "cfafbeb1-8037-4d0c-896e-28c4f2e65573" + }, + "itemType": "Notebook", + "displayName": "MyNotebook" + }, + "workspaceChange": "Modified", + "remoteChange": "Modified", + "conflictType": "Conflict", + "fileChanges": [ + { + "path": "notebook-content.py", + "workspaceChange": "Modified", + "remoteChange": "Modified", + "conflictType": "Conflict" + }, + { + "path": "metadata.json", + "workspaceChange": "Modified", + "conflictType": "None" + }, + { + "path": "config/settings.json", + "remoteChange": "Added", + "conflictType": "None" + } + ] + }, + { + "itemMetadata": { + "itemIdentifier": { + "objectId": "d5a2b3c4-1234-5678-abcd-ef0123456789" + }, + "itemType": "Report", + "displayName": "SalesReport" + }, + "workspaceChange": "Modified", + "conflictType": "None", + "fileChanges": [ + { + "path": "pages/page1.json", + "workspaceChange": "Modified", + "conflictType": "None" + } + ] + } + ] + } + }, + "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 + } + } + } +} diff --git a/platform/examples/platform/BulkExportItemDefinitionsAll.json b/platform/examples/platform/BulkExportItemDefinitionsAll.json index 2ea5c60..e562df5 100644 --- a/platform/examples/platform/BulkExportItemDefinitionsAll.json +++ b/platform/examples/platform/BulkExportItemDefinitionsAll.json @@ -1,7 +1,6 @@ { "parameters": { "workspaceId": "9d19eb70-17d7-43b5-b6ce-943658e246be", - "beta": true, "bulkExportItemDefinitionsRequest": { "mode": "All" } diff --git a/platform/examples/platform/BulkExportItemDefinitionsSelective.json b/platform/examples/platform/BulkExportItemDefinitionsSelective.json index 0a59979..a8c95ce 100644 --- a/platform/examples/platform/BulkExportItemDefinitionsSelective.json +++ b/platform/examples/platform/BulkExportItemDefinitionsSelective.json @@ -1,7 +1,6 @@ { "parameters": { "workspaceId": "9d19eb70-17d7-43b5-b6ce-943658e246be", - "beta": true, "bulkExportItemDefinitionsRequest": { "items": [ { diff --git a/platform/examples/platform/BulkImportItemDefinitions.json b/platform/examples/platform/BulkImportItemDefinitions.json index 22374be..62f1369 100644 --- a/platform/examples/platform/BulkImportItemDefinitions.json +++ b/platform/examples/platform/BulkImportItemDefinitions.json @@ -1,7 +1,6 @@ { "parameters": { "workspaceId": "24d305d1-9db8-4785-b038-714e07e7394f", - "beta": true, "bulkImportItemDefinitionsRequest": { "definitionParts": [ { diff --git a/platform/examples/platform/GetOneLakeSettingsWithAllSettings.json b/platform/examples/platform/GetOneLakeSettingsWithAllSettings.json index a8cfb7a..aedca05 100644 --- a/platform/examples/platform/GetOneLakeSettingsWithAllSettings.json +++ b/platform/examples/platform/GetOneLakeSettingsWithAllSettings.json @@ -24,7 +24,8 @@ ], "lifecycle": { "defaultTier": "Cool", - "policy": "Active" + "policy": "Active", + "accessTimeTracking": "Enabled" } } } diff --git a/platform/examples/platform/ModifyOneLakeAccessTimeTrackingDisable.json b/platform/examples/platform/ModifyOneLakeAccessTimeTrackingDisable.json new file mode 100644 index 0000000..adb925b --- /dev/null +++ b/platform/examples/platform/ModifyOneLakeAccessTimeTrackingDisable.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff227", + "modifyAccessTimeTrackingRequest": { + "status": "Disabled" + } + }, + "responses": { + "200": {} + } +} diff --git a/platform/examples/platform/ModifyOneLakeAccessTimeTrackingEnable.json b/platform/examples/platform/ModifyOneLakeAccessTimeTrackingEnable.json new file mode 100644 index 0000000..81ed009 --- /dev/null +++ b/platform/examples/platform/ModifyOneLakeAccessTimeTrackingEnable.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff227", + "modifyAccessTimeTrackingRequest": { + "status": "Enabled" + } + }, + "responses": { + "200": {} + } +} diff --git a/platform/swagger.json b/platform/swagger.json index 701222f..fe68aec 100644 --- a/platform/swagger.json +++ b/platform/swagger.json @@ -1297,14 +1297,14 @@ } } }, - "/workspaces/{workspaceId}/items/bulkExportDefinitions?beta=true": { + "/workspaces/{workspaceId}/items/bulkExportDefinitions": { "post": { "summary": "Bulk export item definitions from the workspace.", - "description": "> [!NOTE]\n> This API is part of a Beta release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n**When calling this API, callers must specify `true` as the value for the query parameter `beta`.**\n\nExports item definitions from multiple items in a workspace in a single operation. This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation). You can export all supported item definitions or selectively export specific items from the specified workspace. To see the supported item types, see [Item definition overview](/rest/api/fabric/articles/item-management/definitions/item-definition-overview).\n\n## Permissions\n\nThe caller must have a *contributor* or higher role for the workspace.\n\nWhen exporting all items in a workspace: Only the Items that the caller has both *read* and *write* permissions for are exported.\n\nWhen exporting specific items: The caller must have *read* and *write* permissions for **all** specified items.\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) | Only when all the [items](/rest/api/fabric/articles/item-management/item-management-overview) involved in the operation support service principals |\n\n## Interface", + "description": "Exports item definitions from multiple items in a workspace in a single operation. This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation). You can export all supported item definitions or selectively export specific items from the specified workspace. To see the supported item types, see [Item definition overview](/rest/api/fabric/articles/item-management/definitions/item-definition-overview).\n\n## Permissions\n\nThe caller must have a *contributor* or higher role for the workspace.\n\nWhen exporting all items in a workspace: Only the Items that the caller has both *read* and *write* permissions for are exported.\n\nWhen exporting specific items: The caller must have *read* and *write* permissions for **all** specified items.\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) | Only when all the [items](/rest/api/fabric/articles/item-management/item-management-overview) involved in the operation support service principals |\n\n## Interface", "tags": [ "Items" ], - "operationId": "Items_Bulk_Export_Item_Definitions_(beta)", + "operationId": "Items_BulkExportItemDefinitions", "consumes": [ "application/json" ], @@ -1321,13 +1321,6 @@ "format": "uuid", "required": true }, - { - "in": "query", - "name": "beta", - "description": "This required parameter must be set to `true` to access this API, which is currently in beta.", - "type": "boolean", - "required": true - }, { "in": "body", "name": "bulkExportItemDefinitionsRequest", @@ -1392,14 +1385,14 @@ } } }, - "/workspaces/{workspaceId}/items/bulkImportDefinitions?beta=true": { + "/workspaces/{workspaceId}/items/bulkImportDefinitions": { "post": { "summary": "Bulk import item definitions into the workspace.", - "description": "> [!NOTE]\n> This API is part of a Beta release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n**When calling this API, callers must specify `true` as the value for the query parameter `beta`.**\n\nImports item definitions for multiple items into a workspace in a single operation. This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation). Each item definition in the request will be processed, creating new items or updating existing ones as determined by the system based on whether the item already exists. To see the supported item types, see [Item definition overview](/rest/api/fabric/articles/item-management/definitions/item-definition-overview).\n\n## Permissions\n\nThe caller must have a *contributor* or higher role for the workspace.\n\nThe caller must have *read and write* permissions for each item being updated.\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) | Only when all the [items](/rest/api/fabric/articles/item-management/item-management-overview) involved in the operation support service principals |\n\n## Interface", + "description": "Imports item definitions for multiple items into a workspace in a single operation. This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation). Each item definition in the request will be processed, creating new items or updating existing ones as determined by the system based on whether the item already exists. To see the supported item types, see [Item definition overview](/rest/api/fabric/articles/item-management/definitions/item-definition-overview).\n\n## Permissions\n\nThe caller must have a *contributor* or higher role for the workspace.\n\nThe caller must have *read and write* permissions for each item being updated.\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) | Only when all the [items](/rest/api/fabric/articles/item-management/item-management-overview) involved in the operation support service principals |\n\n## Interface", "tags": [ "Items" ], - "operationId": "Items_Bulk_Import_Item_Definitions_(beta)", + "operationId": "Items_BulkImportItemDefinitions", "consumes": [ "application/json" ], @@ -1416,13 +1409,6 @@ "format": "uuid", "required": true }, - { - "in": "query", - "name": "beta", - "description": "This required parameter must be set to `true` to access this API, which is currently in beta.", - "type": "boolean", - "required": true - }, { "in": "body", "name": "bulkImportItemDefinitionsRequest", @@ -2811,6 +2797,14 @@ "type": "string", "format": "uuid", "required": true + }, + { + "in": "query", + "name": "includeFilesDetails", + "description": "When true, each item change in the response includes a fileChanges array with per-file change details.", + "type": "boolean", + "default": false, + "required": false } ], "responses": { @@ -2867,6 +2861,9 @@ }, "Get status with conflict example": { "$ref": "./examples/gitIntegration/GetStatus_Conflict.json" + }, + "Get status with file details example": { + "$ref": "./examples/gitIntegration/GetStatus_WithFileDetails.json" } } } @@ -2874,7 +2871,7 @@ "/workspaces/{workspaceId}/git/commitToGit": { "post": { "summary": "Commits the changes made in the workspace to the connected remote branch.", - "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nTo use this API, the caller's Git credentials must be configured using [Update My Git Credentials](/rest/api/fabric/core/git/update-my-git-credentials) API. You can use the [Get My Git Credentials](/rest/api/fabric/core/git/get-my-git-credentials) API to check the Git credentials configuration.\n\nYou can choose to commit all changes or only specific changed items. To sync the workspace for the first time, use this API after the [Connect](/rest/api/fabric/core/git/connect) and [Initialize Connection](/rest/api/fabric/core/git/initialize-connection) APIs.\n\n## Permissions\n\nThe caller must have a *contributor* or higher workspace role.\n\n## Required Delegated Scopes\n\nWorkspace.GitCommit.All.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Only supported when all the [items](/rest/api/fabric/articles/item-management/item-management-overview) involved in the operation support service principals |\n\n## Interface", + "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nTo use this API, the caller's Git credentials must be configured using [Update My Git Credentials](/rest/api/fabric/core/git/update-my-git-credentials) API. You can use the [Get My Git Credentials](/rest/api/fabric/core/git/get-my-git-credentials) API to check the Git credentials configuration.\n\nYou can choose to commit all changes, specific items, or specific files within items using the FileLevelSelective mode. To sync the workspace for the first time, use this API after the [Connect](/rest/api/fabric/core/git/connect) and [Initialize Connection](/rest/api/fabric/core/git/initialize-connection) APIs.\n\n## Permissions\n\nThe caller must have a *contributor* or higher workspace role.\n\n## Required Delegated Scopes\n\nWorkspace.GitCommit.All.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Only supported when all the [items](/rest/api/fabric/articles/item-management/item-management-overview) involved in the operation support service principals |\n\n## Interface", "tags": [ "Git" ], @@ -2953,6 +2950,9 @@ }, "Commit selective items to Git example": { "$ref": "./examples/gitIntegration/CommitToGit_Selective.json" + }, + "Commit file-level selective to Git example": { + "$ref": "./examples/gitIntegration/CommitToGit_FileLevelSelective.json" } } } @@ -4620,6 +4620,74 @@ } } }, + "/workspaces/{workspaceId}/onelake/settings/modifyAccessTimeTracking": { + "post": { + "summary": "Enables or disables OneLake access time tracking for a workspace.", + "description": "Enables or disables Azure Storage `LastAccessTime` tracking for OneLake files in the workspace. When enabled, file reads and writes update the file's last access timestamp; metadata-only operations, such as checking properties, metadata, or tags, do not. Changes take effect immediately.\n\n## Permissions\n\nThe caller must have an *admin* workspace role.\n\n## Required Delegated Scopes\n\nOneLake.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/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": [ + "OneLakeSettings" + ], + "operationId": "OneLakeSettings_ModifyAccessTimeTracking", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-fabric-sdk-long-running-operation": false, + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "description": "The workspace ID.", + "type": "string", + "format": "uuid", + "required": true + }, + { + "in": "body", + "name": "modifyAccessTimeTrackingRequest", + "description": "The modify access time tracking request object.", + "required": true, + "schema": { + "$ref": "./definitions/platform.json#/definitions/ModifyAccessTimeTrackingRequest" + } + } + ], + "responses": { + "200": { + "description": "Request completed successfully." + }, + "429": { + "description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.", + "x-ms-error-response": true, + "headers": { + "Retry-After": { + "type": "integer", + "description": "The number of seconds to wait before retrying the request." + } + }, + "schema": { + "$ref": "../common/definitions.json#/definitions/ErrorResponse" + } + }, + "default": { + "description": "Common error codes:\n\n* WorkspaceNotFound - Workspace not found.\n\n* UserNotAuthorized - User is not authorized. The caller must have an *admin* workspace role.\n\n* OneLakeNotProvisioned - The workspace has no items, so OneLake storage is not provisioned.\n\n* UnknownError - An error occurred.", + "schema": { + "$ref": "../common/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Enable access time tracking example": { + "$ref": "./examples/platform/ModifyOneLakeAccessTimeTrackingEnable.json" + }, + "Disable access time tracking example": { + "$ref": "./examples/platform/ModifyOneLakeAccessTimeTrackingDisable.json" + } + } + } + }, "/workspaces/{workspaceId}/onelake/lifecycle/exportPolicy": { "post": { "summary": "Exports the OneLake lifecycle management policy for a workspace.", @@ -7773,8 +7841,8 @@ }, "/workspaces/{workspaceId}/items/bulkMove": { "post": { - "summary": "Move multiple items to a folder. Children items are moved with their parent items. You can't move children items without their parent items.", - "description": "> [!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\n## Permissions\n\n The caller must have *contributor* or higher role on the workspace.\n\n## Required Delegated Scopes\n\nWorkspace.ReadWrite.All\n\n## Limitations\n\n A single request can't contain more than 50 items.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/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": "Moves multiple items to a folder.", + "description": "Moves multiple items to a folder. Child items are moved with their parent items. You can't move a child item without its parent item.\n\n## Permissions\n\n The caller must have *contributor* or higher role on the workspace.\n\n## Required Delegated Scopes\n\nWorkspace.ReadWrite.All\n\n## Limitations\n\n A single request can't contain more than 50 items.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/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" ], @@ -7843,8 +7911,8 @@ }, "/workspaces/{workspaceId}/items/{itemId}/move": { "post": { - "summary": "Move the specified item to a folder within the same workspace. Child items are moved with their parent item. You can't move a child item without its parent item.", - "description": "> [!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\n## Permissions\n\n The caller must have *contributor* or higher role on the workspace.\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", + "summary": "Moves the specified item to a folder.", + "description": "Moves the specified item to a folder within the same workspace. Child items are moved with their parent item. You can't move a child item without its parent item.\n\n## Permissions\n\n The caller must have *contributor* or higher role on the workspace.\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": [ "Items" ],