diff --git a/admin/definitions/externaldatasharing.json b/admin/definitions/externaldatasharing.json index b1b6619..9c273db 100644 --- a/admin/definitions/externaldatasharing.json +++ b/admin/definitions/externaldatasharing.json @@ -53,7 +53,7 @@ }, "recipient": { "description": "The recipient who was invited to accept the external data share.", - "$ref": "#/definitions/ExternalDataShareRecipient", + "$ref": "#/definitions/BaseExternalDataShareRecipient", "readOnly": true }, "status": { @@ -136,6 +136,85 @@ "description": "The recipient's tenant ID." } } + }, + "BaseExternalDataShareRecipient": { + "description": "The recipient of an external data share. Use 'ExternalDataShareUserRecipient' to share with a user by email, or 'ExternalDataShareSPRecipient' to share with a service principal by object ID. If 'type' is not specified, it defaults to 'User'.", + "type": "object", + "required": ["type"], + "discriminator": "type", + "properties": { + "type": { + "description": "The type of the external data share recipient. Additional recipient types may be added over time.", + "$ref": "#/definitions/ExternalDataShareRecipientType" + } + } + }, + "ExternalDataShareRecipientType": { + "description": "The type of the external data share recipient. Defaults to 'User' if not provided. Additional recipient types may be added over time.", + "type": "string", + "default": "User", + "enum": ["ServicePrincipal", "User"], + "x-ms-enum": { + "name": "ExternalDataShareRecipientType", + "modelAsString": true, + "values": [ + { + "value": "ServicePrincipal", + "description": "The recipient is a service principal, identified by object ID and tenant ID." + }, + { + "value": "User", + "description": "The recipient is a user, identified by user principal name (email address)." + + } + ] + } + }, + "ExternalDataShareSPRecipient": { + "description": "An external data share recipient that is a service principal, identified by principal ID and tenant ID.", + "type": "object", + "required": ["principalId", "tenantId"], + "x-ms-discriminator-value": "ServicePrincipal", + "allOf": [ + { + "$ref": "#/definitions/BaseExternalDataShareRecipient" + } + ], + "properties": { + "principalId": { + "type": "string", + "format": "uuid", + "description": "The principal ID of the service principal recipient. This is equivalent to the Entra ID object ID." + }, + "tenantId": { + "type": "string", + "format": "uuid", + "description": "The tenant ID of the service principal recipient." + } + } + }, + "ExternalDataShareUserRecipient": { + "description": "An external data share recipient that is a user, identified by user principal name (email address). This is the default recipient type.", + "type": "object", + "required": ["userPrincipalName"], + "x-ms-discriminator-value": "User", + "allOf": [ + { + "$ref": "#/definitions/BaseExternalDataShareRecipient" + } + ], + "properties": { + "userPrincipalName": { + "type": "string", + "description": "The user principal name (email address) of the recipient.", + "maxLength": 256 + }, + "tenantId": { + "type": "string", + "format": "uuid", + "description": "The tenant ID of the user recipient. Optional." + } + } } } } diff --git a/admin/examples/externaldatasharing/ListExternalDataShares.json b/admin/examples/externaldatasharing/ListExternalDataShares.json index 7e629f2..77a055d 100644 --- a/admin/examples/externaldatasharing/ListExternalDataShares.json +++ b/admin/examples/externaldatasharing/ListExternalDataShares.json @@ -21,6 +21,7 @@ } }, "recipient": { + "type": "User", "userPrincipalName": "lisa@fabrikam.com" }, "status": "Pending", @@ -43,6 +44,7 @@ } }, "recipient": { + "type": "User", "userPrincipalName": "lisa@fabrikam.com" }, "status": "Active", @@ -66,6 +68,7 @@ } }, "recipient": { + "type": "User", "userPrincipalName": "lisa@fabrikam.com" }, "status": "InvitationExpired", @@ -87,8 +90,10 @@ "userPrincipalName": "eric@contoso.com" } }, - "recipient": { - "userPrincipalName": "lisa@fabrikam.com" + "recipient": { + "type": "ServicePrincipal", + "principalId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "tenantId": "c51dc03f-268a-4da0-a879-25f24947ab8b" }, "status": "Revoked", "expirationTimeUtc": "2024-12-01T00:00:00.000Z", diff --git a/anomalyDetector/definitions.json b/anomalyDetector/definitions.json index ab9fac2..82546dc 100644 --- a/anomalyDetector/definitions.json +++ b/anomalyDetector/definitions.json @@ -92,7 +92,7 @@ "required": ["parts"], "properties": { "format": { - "description": "The format of the item definition. Additional `format` types may be added over time.", + "description": "The format of the anomaly detector definition. Additional `format` types may be added over time.", "type": "string", "enum": [ "AnomalyDetectorV1" diff --git a/apacheAirflowJob/definitions.json b/apacheAirflowJob/definitions.json index 65e72aa..c81213b 100644 --- a/apacheAirflowJob/definitions.json +++ b/apacheAirflowJob/definitions.json @@ -91,6 +91,11 @@ "type": "object", "required": ["parts"], "properties": { + "format": { + "description": "The format of the Apache Airflow job definition.", + "type": "string", + "readOnly": false + }, "parts": { "description": "A list of definition parts.", "type": "array", diff --git a/copyJob/definitions.json b/copyJob/definitions.json index 65f10d3..3533bbf 100644 --- a/copyJob/definitions.json +++ b/copyJob/definitions.json @@ -92,7 +92,7 @@ "required": [ "parts" ], "properties": { "format": { - "description": "The format of the item definition.", + "description": "The format of the copy job definition.", "type": "string", "readOnly": false }, diff --git a/cosmosDbDatabase/definitions.json b/cosmosDbDatabase/definitions.json index ea4f80e..09ddd20 100644 --- a/cosmosDbDatabase/definitions.json +++ b/cosmosDbDatabase/definitions.json @@ -95,6 +95,11 @@ "type": "object", "required": ["parts"], "properties": { + "format": { + "description": "The format of the Cosmos DB database definition.", + "type": "string", + "readOnly": false + }, "parts": { "description": "A list of definition parts.", "type": "array", diff --git a/cosmosDbDatabase/swagger.json b/cosmosDbDatabase/swagger.json index ba5c393..951814d 100644 --- a/cosmosDbDatabase/swagger.json +++ b/cosmosDbDatabase/swagger.json @@ -409,6 +409,13 @@ "type": "string", "format": "uuid", "required": true + }, + { + "in": "query", + "name": "format", + "description": "The format of the Cosmos DB database public definition.", + "type": "string", + "required": false } ], "responses": { diff --git a/dashboard/definitions.json b/dashboard/definitions.json index 4b575fd..94289a1 100644 --- a/dashboard/definitions.json +++ b/dashboard/definitions.json @@ -92,7 +92,7 @@ "required": ["parts"], "properties": { "format": { - "description": "The format of the item definition.", + "description": "The format of the dashboard definition.", "type": "string", "readOnly": false }, diff --git a/dataAgent/definitions.json b/dataAgent/definitions.json index 2e23ad2..6343867 100644 --- a/dataAgent/definitions.json +++ b/dataAgent/definitions.json @@ -91,6 +91,11 @@ "type": "object", "required": ["parts"], "properties": { + "format": { + "description": "The format of the data agent definition.", + "type": "string", + "readOnly": false + }, "parts": { "description": "A list of definition parts.", "type": "array", diff --git a/dataAgent/swagger.json b/dataAgent/swagger.json index 1218f34..b41cd6c 100644 --- a/dataAgent/swagger.json +++ b/dataAgent/swagger.json @@ -409,6 +409,13 @@ "type": "string", "format": "uuid", "required": true + }, + { + "in": "query", + "name": "format", + "description": "The format of the data agent public definition.", + "type": "string", + "required": false } ], "responses": { diff --git a/dataPipeline/definitions.json b/dataPipeline/definitions.json index 7f92d44..2b96f57 100644 --- a/dataPipeline/definitions.json +++ b/dataPipeline/definitions.json @@ -92,7 +92,7 @@ "required": ["parts"], "properties": { "format": { - "description": "The format of the item definition.", + "description": "The format of the data pipeline definition.", "type": "string", "readOnly": false }, diff --git a/dataflow/definitions.json b/dataflow/definitions.json index 3ce84db..5d5b076 100644 --- a/dataflow/definitions.json +++ b/dataflow/definitions.json @@ -91,6 +91,11 @@ "type": "object", "required": [ "parts" ], "properties": { + "format": { + "description": "The format of the data flow definition.", + "type": "string", + "readOnly": false + }, "parts": { "description": "A list of definition parts.", "type": "array", diff --git a/dataflow/swagger.json b/dataflow/swagger.json index 336c159..6912201 100644 --- a/dataflow/swagger.json +++ b/dataflow/swagger.json @@ -409,6 +409,13 @@ "type": "string", "format": "uuid", "required": true + }, + { + "in": "query", + "name": "format", + "description": "The format of the dataflow public definition.", + "type": "string", + "required": false } ], "responses": { diff --git a/digitalTwinBuilder/definitions.json b/digitalTwinBuilder/definitions.json index 047d1a9..eca8ef2 100644 --- a/digitalTwinBuilder/definitions.json +++ b/digitalTwinBuilder/definitions.json @@ -86,7 +86,7 @@ "required": [ "parts" ], "properties": { "format": { - "description": "The format of the item definition.", + "description": "The format of the digital twin builder definition.", "type": "string", "readOnly": false }, diff --git a/digitalTwinBuilderFlow/definitions.json b/digitalTwinBuilderFlow/definitions.json index 79df9a7..b0e78b5 100644 --- a/digitalTwinBuilderFlow/definitions.json +++ b/digitalTwinBuilderFlow/definitions.json @@ -59,7 +59,7 @@ "properties": { "digitalTwinBuilderItemReference": { "description": "The Digital Twin Builder Item Reference.", - "$ref": "../common/definitions.json#/definitions/ItemReference" + "$ref": "../common/definitions.json#/definitions/ItemReferenceById" } } }, @@ -118,6 +118,11 @@ "type": "object", "required": ["parts"], "properties": { + "format": { + "description": "The format of the digital twin builder flow definition.", + "type": "string", + "readOnly": false + }, "parts": { "description": "A list of definition parts.", "type": "array", diff --git a/digitalTwinBuilderFlow/swagger.json b/digitalTwinBuilderFlow/swagger.json index 09bf437..ac47159 100644 --- a/digitalTwinBuilderFlow/swagger.json +++ b/digitalTwinBuilderFlow/swagger.json @@ -409,6 +409,13 @@ "type": "string", "format": "uuid", "required": true + }, + { + "in": "query", + "name": "format", + "description": "The format of the Digital Twin Builder Flow public definition.", + "type": "string", + "required": false } ], "responses": { diff --git a/environment/swagger.json b/environment/swagger.json index c7fe414..17a6b0a 100644 --- a/environment/swagger.json +++ b/environment/swagger.json @@ -16,7 +16,7 @@ "Staging" ], "summary": "Get environment staging spark compute.", - "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. This beta API will be deprecated on **April 30, 2026**, and replaced by a stable version, available [here](/rest/api/fabric/environment/staging/get-spark-compute). The new version introduces breaking changes and is not backward compatible.\n**When calling this API, callers must specify `true` as the value for the query parameter `beta` (`preview` query parameter has been replaced by `beta`. For backward compatibility, `beta` is still supported and behaves the same as `beta`).**\n\n## Deprecation Notice\n\nA new query parameter `beta` has been introduced to facilitate this transition:\n* The `beta` query parameter currently defaults to `true`.\n* Set the value of the `beta` query parameter to `false` to use the stable Release version of this API.\n* Starting April 30, 2026, the default value for `beta` will change to `false`.\n\nTo ensure compatibility, explicitly set the `beta` parameter to your desired value (`true` or `false`).\n\nIt is recommended to migrate your integration to use the Release version as soon as possible by specifying `false` for the `beta` query parameter (**the default value for the `beta` query parameter will be set to `false` on API's deprecation date**).\n\nThe following incompatible changes were introduced in the Release version:\n* Response property `sparkProperties`'s type was changed from `object` to the list of `SparkProperty`.\n\n## Permissions\n\nRead permission for the environment item. \n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All or Environment.Read.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/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": "> [!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. This beta API will be deprecated on **August 31, 2026**, and replaced by a stable version, available [here](/rest/api/fabric/environment/staging/get-spark-compute). The new version introduces breaking changes and is not backward compatible.\n**When calling this API, callers must specify `true` as the value for the query parameter `beta` (`preview` query parameter has been replaced by `beta`. For backward compatibility, `beta` is still supported and behaves the same as `beta`).**\n\n## Deprecation Notice\n\nA new query parameter `beta` has been introduced to facilitate this transition:\n* The `beta` query parameter currently defaults to `true`.\n* Set the value of the `beta` query parameter to `false` to use the stable Release version of this API.\n* Starting August 31, 2026, the default value for `beta` will change to `false`.\n\nTo ensure compatibility, explicitly set the `beta` parameter to your desired value (`true` or `false`).\n\nIt is recommended to migrate your integration to use the Release version as soon as possible by specifying `false` for the `beta` query parameter (**the default value for the `beta` query parameter will be set to `false` on API's deprecation date**).\n\nThe following incompatible changes were introduced in the Release version:\n* Response property `sparkProperties`'s type was changed from `object` to the list of `SparkProperty`.\n\n## Permissions\n\nRead permission for the environment item. \n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All or Environment.Read.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", "operationId": "Staging_Get_Spark_Compute_(beta)", "produces": [ "application/json" @@ -41,14 +41,14 @@ { "name": "beta", "in": "query", - "description": "This parameter specifies which version of the API to use. Set to `true` to use the beta version described on this page, or to `false` to use the Release version detailed [here](/rest/api/fabric/environment/staging/get-spark-compute).\nStarting April 30, 2026, the default value for `beta` will change to `false`.", + "description": "This parameter specifies which version of the API to use. Set to `true` to use the beta version described on this page, or to `false` to use the Release version detailed [here](/rest/api/fabric/environment/staging/get-spark-compute).\nStarting August 31, 2026, the default value for `beta` will change to `false`.", "required": true, "type": "boolean", "x-ms-deprecation": { - "defaultChangeDate": "2026-04-30", + "defaultChangeDate": "2026-08-31", "currentDefault": true, "newDefault": false, - "description": "The default value will change from `true` to `false` on **April 30, 2026**." + "description": "The default value will change from `true` to `false` on **August 31, 2026**." } } ], @@ -90,7 +90,7 @@ "Staging" ], "summary": "Update environment staging spark compute. If you want to delete a spark property, set its value as null.", - "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. This beta API will be deprecated on **April 30, 2026**, and replaced by a stable version, available [here](/rest/api/fabric/environment/staging/update-spark-compute). The new version introduces breaking changes and is not backward compatible.\n**When calling this API, callers must specify `true` as the value for the query parameter `beta` (`preview` query parameter has been replaced by `beta`. For backward compatibility, `preview` is still supported and behaves the same as `beta`).**\n\n## Deprecation Notice\n\nA new query parameter `beta` has been introduced to facilitate this transition:\n* The `beta` query parameter currently defaults to `true`.\n* Set the value of the `beta` query parameter to `false` to use the stable Release version of this API.\n* Starting April 30, 2026, the default value for `beta` will change to `false`.\n\nTo ensure compatibility, explicitly set the `beta` parameter to your desired value (`true` or `false`).\n\nIt is recommended to migrate your integration to use the Release version as soon as possible by specifying `false` for the `beta` query parameter (**the default value for the `beta` query parameter will be set to `false` on API's deprecation date**).\n\nThe following incompatible changes were introduced in the Release version:\n* Request and response property `sparkProperties`'s type was changed from `object` to the list of `SparkProperty`.\n\n## Permissions\n\nWrite permission for the environment item. \n\n## Required Delegated Scopes\n\nItem.ReadWrite.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/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": "> [!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. This beta API will be deprecated on **August 31, 2026**, and replaced by a stable version, available [here](/rest/api/fabric/environment/staging/update-spark-compute). The new version introduces breaking changes and is not backward compatible.\n**When calling this API, callers must specify `true` as the value for the query parameter `beta` (`preview` query parameter has been replaced by `beta`. For backward compatibility, `preview` is still supported and behaves the same as `beta`).**\n\n## Deprecation Notice\n\nA new query parameter `beta` has been introduced to facilitate this transition:\n* The `beta` query parameter currently defaults to `true`.\n* Set the value of the `beta` query parameter to `false` to use the stable Release version of this API.\n* Starting August 31, 2026, the default value for `beta` will change to `false`.\n\nTo ensure compatibility, explicitly set the `beta` parameter to your desired value (`true` or `false`).\n\nIt is recommended to migrate your integration to use the Release version as soon as possible by specifying `false` for the `beta` query parameter (**the default value for the `beta` query parameter will be set to `false` on API's deprecation date**).\n\nThe following incompatible changes were introduced in the Release version:\n* Request and response property `sparkProperties`'s type was changed from `object` to the list of `SparkProperty`.\n\n## Permissions\n\nWrite permission for the environment item. \n\n## Required Delegated Scopes\n\nItem.ReadWrite.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", "operationId": "Staging_Update_Spark_Compute_(beta)", "consumes": [ "application/json" @@ -118,14 +118,14 @@ { "name": "beta", "in": "query", - "description": "This parameter specifies which version of the API to use. Set to `true` to use the beta version described on this page, or to `false` to use the Release version detailed [here](/rest/api/fabric/environment/staging/update-spark-compute).\nStarting April 30, 2026, the default value for `beta` will change to `false`.", + "description": "This parameter specifies which version of the API to use. Set to `true` to use the beta version described on this page, or to `false` to use the Release version detailed [here](/rest/api/fabric/environment/staging/update-spark-compute).\nStarting August 31, 2026, the default value for `beta` will change to `false`.", "required": true, "type": "boolean", "x-ms-deprecation": { - "defaultChangeDate": "2026-04-30", + "defaultChangeDate": "2026-08-31", "currentDefault": true, "newDefault": false, - "description": "The default value will change from `true` to `false` on **April 30, 2026**." + "description": "The default value will change from `true` to `false` on **August 31, 2026**." } }, { @@ -178,7 +178,7 @@ "Published" ], "summary": "Get environment spark compute.", - "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. This beta API will be deprecated on **April 30, 2026**, and replaced by a stable version, available [here](/rest/api/fabric/environment/published/get-spark-compute). The new version introduces breaking changes and is not backward compatible.\n**When calling this API, callers must specify `true` as the value for the query parameter `beta` (`preview` query parameter has been replaced by `beta`. For backward compatibility, `preview` is still supported and behaves the same as `beta`).**\n\n## Deprecation Notice\n\nA new query parameter `beta` has been introduced to facilitate this transition:\n* The `beta` query parameter currently defaults to `true`.\n* Set the value of the `beta` query parameter to `false` to use the stable Release version of this API.\n* Starting April 30, 2026, the default value for `beta` will change to `false`.\n\nTo ensure compatibility, explicitly set the `beta` parameter to your desired value (`true` or `false`).\n\nIt is recommended to migrate your integration to use the Release version as soon as possible by specifying `false` for the `beta` query parameter (**the default value for the `beta` query parameter will be set to `false` on API's deprecation date**).\n\nThe following incompatible changes were introduced in the Release version:\n* Response property `sparkProperties`'s type was changed from `object` to the list of `SparkProperty`.\n\n## Permissions\n\nRead permission for the environment item. \n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All or Environment.Read.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/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": "> [!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. This beta API will be deprecated on **August 31, 2026**, and replaced by a stable version, available [here](/rest/api/fabric/environment/published/get-spark-compute). The new version introduces breaking changes and is not backward compatible.\n**When calling this API, callers must specify `true` as the value for the query parameter `beta` (`preview` query parameter has been replaced by `beta`. For backward compatibility, `preview` is still supported and behaves the same as `beta`).**\n\n## Deprecation Notice\n\nA new query parameter `beta` has been introduced to facilitate this transition:\n* The `beta` query parameter currently defaults to `true`.\n* Set the value of the `beta` query parameter to `false` to use the stable Release version of this API.\n* Starting August 31, 2026, the default value for `beta` will change to `false`.\n\nTo ensure compatibility, explicitly set the `beta` parameter to your desired value (`true` or `false`).\n\nIt is recommended to migrate your integration to use the Release version as soon as possible by specifying `false` for the `beta` query parameter (**the default value for the `beta` query parameter will be set to `false` on API's deprecation date**).\n\nThe following incompatible changes were introduced in the Release version:\n* Response property `sparkProperties`'s type was changed from `object` to the list of `SparkProperty`.\n\n## Permissions\n\nRead permission for the environment item. \n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All or Environment.Read.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", "operationId": "Published_Get_Spark_Compute_(beta)", "produces": [ "application/json" @@ -203,14 +203,14 @@ { "name": "beta", "in": "query", - "description": "This parameter specifies which version of the API to use. Set to `true` to use the beta version described on this page, or to `false` to use the Release version detailed [here](/rest/api/fabric/environment/published/get-spark-compute).\nStarting April 30, 2026, the default value for `beta` will change to `false`.", + "description": "This parameter specifies which version of the API to use. Set to `true` to use the beta version described on this page, or to `false` to use the Release version detailed [here](/rest/api/fabric/environment/published/get-spark-compute).\nStarting August 31, 2026, the default value for `beta` will change to `false`.", "required": true, "type": "boolean", "x-ms-deprecation": { - "defaultChangeDate": "2026-04-30", + "defaultChangeDate": "2026-08-31", "currentDefault": true, "newDefault": false, - "description": "The default value will change from `true` to `false` on **April 30, 2026**." + "description": "The default value will change from `true` to `false` on **August 31, 2026**." } } ], @@ -254,7 +254,7 @@ "Staging" ], "summary": "Get environment staging spark compute.", - "description": "> [!NOTE]\n> This API is a release version of a beta version due to be deprecated on April 30, 2026.\n**When calling this API - callers must set the query parameter `beta` to the value `false`**.\n\n## Permissions\n\nRead permission for the environment item. \n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All or Environment.Read.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/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": "> [!NOTE]\n> This API is a release version of a beta version due to be deprecated on August 31, 2026.\n**When calling this API - callers must set the query parameter `beta` to the value `false`**.\n\n## Permissions\n\nRead permission for the environment item. \n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All or Environment.Read.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", "operationId": "Staging_GetSparkCompute", "produces": [ "application/json" @@ -283,10 +283,10 @@ "required": true, "type": "boolean", "x-ms-deprecation": { - "defaultChangeDate": "2026-04-30", + "defaultChangeDate": "2026-08-31", "currentDefault": true, "newDefault": false, - "description": "The default value will change from `true` to `false` on **April 30, 2026**." + "description": "The default value will change from `true` to `false` on **August 31, 2026**." } } ], @@ -328,7 +328,7 @@ "Staging" ], "summary": "Update environment staging spark compute. If you want to delete a spark property, set its value as null.", - "description": "> [!NOTE]\n> This API is a release version of a beta version due to be deprecated on April 30, 2026.\n**When calling this API - callers must set the query parameter `beta` to the value `false`**\n\n## Permissions\n\nWrite permission for the environment item. \n\n## Required Delegated Scopes\n\nItem.ReadWrite.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/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": "> [!NOTE]\n> This API is a release version of a beta version due to be deprecated on August 31, 2026.\n**When calling this API - callers must set the query parameter `beta` to the value `false`**\n\n## Permissions\n\nWrite permission for the environment item. \n\n## Required Delegated Scopes\n\nItem.ReadWrite.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", "operationId": "Staging_UpdateSparkCompute", "consumes": [ "application/json" @@ -360,10 +360,10 @@ "required": true, "type": "boolean", "x-ms-deprecation": { - "defaultChangeDate": "2026-04-30", + "defaultChangeDate": "2026-08-31", "currentDefault": true, "newDefault": false, - "description": "The default value will change from `true` to `false` on **April 30, 2026**." + "description": "The default value will change from `true` to `false` on **August 31, 2026**." } }, { @@ -419,7 +419,7 @@ "Published" ], "summary": "Get environment spark compute.", - "description": "> [!NOTE]\n> This API is a release version of a beta version due to be deprecated on April 30, 2026.\n**When calling this API - callers must set the query parameter `beta` to the value `false`**\n\n## Permissions\n\nRead permission for the environment item. \n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All or Environment.Read.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/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": "> [!NOTE]\n> This API is a release version of a beta version due to be deprecated on August 31, 2026.\n**When calling this API - callers must set the query parameter `beta` to the value `false`**\n\n## Permissions\n\nRead permission for the environment item. \n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All or Environment.Read.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", "operationId": "Published_GetSparkCompute", "produces": [ "application/json" @@ -448,10 +448,10 @@ "required": true, "type": "boolean", "x-ms-deprecation": { - "defaultChangeDate": "2026-04-30", + "defaultChangeDate": "2026-08-31", "currentDefault": true, "newDefault": false, - "description": "The default value will change from `true` to `false` on **April 30, 2026**." + "description": "The default value will change from `true` to `false` on **August 31, 2026**." } } ], @@ -1047,7 +1047,7 @@ "/workspaces/{workspaceId}/environments/{environmentId}/staging/libraries?beta=false": { "get": { "summary": "Get a list of libraries staged into environment.", - "description": "> [!NOTE]\n> This API is a release version of a beta version due to be deprecated on April 30, 2026.\n**When calling this API - callers must set the query parameter `beta` to the value `false`**\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\nRead permission for the environment item. \n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All or Environment.Read.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/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": "> [!NOTE]\n> This API is a release version of a beta version due to be deprecated on August 31, 2026.\n**When calling this API - callers must set the query parameter `beta` to the value `false`**\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\nRead permission for the environment item. \n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All or Environment.Read.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/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": [ "Staging" ], @@ -1083,10 +1083,10 @@ "required": true, "type": "boolean", "x-ms-deprecation": { - "defaultChangeDate": "2026-04-30", + "defaultChangeDate": "2026-08-31", "currentDefault": true, "newDefault": false, - "description": "The default value will change from `true` to `false` on **April 30, 2026**." + "description": "The default value will change from `true` to `false` on **August 31, 2026**." } }, { @@ -1134,7 +1134,7 @@ "/workspaces/{workspaceId}/environments/{environmentId}/staging/libraries": { "post": { "summary": "Upload spark library into environment.", - "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. This beta API will be deprecated on **April 30, 2026**, and replaced by a stable version, available [here](/rest/api/fabric/environment/staging/upload-custom-library).\nThe new version introduces breaking changes and is not backward compatible.**\n\n## Deprecation Notice\n\nIt is recommended to migrate your integration to use the Release version.\n\nThe following incompatible changes were introduced in the Release version:\n* The request URL structure has changed: the library name to be added is now specified directly in the URL path.\n* The request now supports `application/octet-stream` as `Content-Type` instead of `multipart/form-data`.\n\nThis API allows one file upload at a time. The supported file formats are .jar, .py, .whl, .tar.gz, or environment.yml.\n\n## Limitations\n\nThe maximum request size allowed is 100MB.\n\nNetwork issues may impact the upload size and may result in timeouts.\n\n## Content-Type\n\nThe library file needs to be upload using `Content-Type` as `multipart/form-data`.\n\n## Permissions\n\nWrite permission for the environment item. \n\n## Required Delegated Scopes\n\nEnvironment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/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": "> [!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. This beta API will be deprecated on **August 31, 2026**, and replaced by a stable version, available [here](/rest/api/fabric/environment/staging/upload-custom-library).\nThe new version introduces breaking changes and is not backward compatible.**\n\n## Deprecation Notice\n\nIt is recommended to migrate your integration to use the Release version.\n\nThe following incompatible changes were introduced in the Release version:\n* The request URL structure has changed: the library name to be added is now specified directly in the URL path.\n* The request now supports `application/octet-stream` as `Content-Type` instead of `multipart/form-data`.\n\nThis API allows one file upload at a time. The supported file formats are .jar, .py, .whl, .tar.gz, or environment.yml.\n\n## Limitations\n\nThe maximum request size allowed is 100MB.\n\nNetwork issues may impact the upload size and may result in timeouts.\n\n## Content-Type\n\nThe library file needs to be upload using `Content-Type` as `multipart/form-data`.\n\n## Permissions\n\nWrite permission for the environment item. \n\n## Required Delegated Scopes\n\nEnvironment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/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": [ "Staging" ], @@ -1195,7 +1195,7 @@ }, "delete": { "summary": "Deletes a library from environment. It supports deleting one file at a time.", - "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. This beta API will be deprecated on **April 30, 2026**, and replaced by a stable version, available [here](/rest/api/fabric/environment/staging/delete-custom-library).\nThe new version introduces breaking changes and is not backward compatible.**\n\n## Deprecation Notice\n\nIt is recommended to migrate your integration to use the Release version.\n\nThe following incompatible changes were introduced in the Release version:\n* The request URL structure has changed: the library name to be removed is now specified directly in the URL path, rather than as a query parameter in the libraries collection.\n\n## Permissions\n\nWrite permission for the environment item. \n\n## Required Delegated Scopes\n\nEnvironment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/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": "> [!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. This beta API will be deprecated on **August 31, 2026**, and replaced by a stable version, available [here](/rest/api/fabric/environment/staging/delete-custom-library).\nThe new version introduces breaking changes and is not backward compatible.**\n\n## Deprecation Notice\n\nIt is recommended to migrate your integration to use the Release version.\n\nThe following incompatible changes were introduced in the Release version:\n* The request URL structure has changed: the library name to be removed is now specified directly in the URL path, rather than as a query parameter in the libraries collection.\n\n## Permissions\n\nWrite permission for the environment item. \n\n## Required Delegated Scopes\n\nEnvironment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/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": [ "Staging" ], @@ -1262,7 +1262,7 @@ "/workspaces/{workspaceId}/environments/{environmentId}/staging/libraries?beta=true": { "get": { "summary": "Get environment staging libraries.", - "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. This beta API will be deprecated on **April 30, 2026**, and replaced by a stable version, available [here](/rest/api/fabric/environment/staging/list-libraries). The new version introduces breaking changes and is not backward compatible.\n**When calling this API, callers must specify `true` as the value for the query parameter `beta` (`preview` query parameter has been replaced by `beta`. For backward compatibility, `preview` is still supported and behaves the same as `beta`).**\n\n## Deprecation Notice\n\nA new query parameter `beta` has been introduced to facilitate this transition:\n* The `beta` query parameter currently defaults to `true`.\n* Set the value of the `beta` query parameter to `false` to use the stable Release version of this API.\n* Starting April 30, 2026, the default value for `beta` will change to `false`.\n\nIt is recommended to migrate your integration to use the Release version as soon as possible by specifying `false` for the `beta` query parameter (**the default value for the `beta` query parameter will be set to `false` on API's deprecation date**).\n\nThe following incompatible changes were introduced in the Release version:\n* Different response format and schema structure\n* Enhanced library properties in the response\n* Updated field names and data types\n* Improved error handling and messages\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\nRead permission for the environment item. \n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All or Environment.Read.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/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": "> [!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. This beta API will be deprecated on **August 31, 2026**, and replaced by a stable version, available [here](/rest/api/fabric/environment/staging/list-libraries). The new version introduces breaking changes and is not backward compatible.\n**When calling this API, callers must specify `true` as the value for the query parameter `beta` (`preview` query parameter has been replaced by `beta`. For backward compatibility, `preview` is still supported and behaves the same as `beta`).**\n\n## Deprecation Notice\n\nA new query parameter `beta` has been introduced to facilitate this transition:\n* The `beta` query parameter currently defaults to `true`.\n* Set the value of the `beta` query parameter to `false` to use the stable Release version of this API.\n* Starting August 31, 2026, the default value for `beta` will change to `false`.\n\nIt is recommended to migrate your integration to use the Release version as soon as possible by specifying `false` for the `beta` query parameter (**the default value for the `beta` query parameter will be set to `false` on API's deprecation date**).\n\nThe following incompatible changes were introduced in the Release version:\n* Different response format and schema structure\n* Enhanced library properties in the response\n* Updated field names and data types\n* Improved error handling and messages\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\nRead permission for the environment item. \n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All or Environment.Read.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/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": [ "Staging" ], @@ -1290,14 +1290,14 @@ { "name": "beta", "in": "query", - "description": "This parameter specifies which version of the API to use. Set to `true` to use the beta version described on this page, or to `false` to use the Release version detailed [here](/rest/api/fabric/environment/staging/list-libraries).\nStarting April 30, 2026, the default value for `beta` will change to `false`.", + "description": "This parameter specifies which version of the API to use. Set to `true` to use the beta version described on this page, or to `false` to use the Release version detailed [here](/rest/api/fabric/environment/staging/list-libraries).\nStarting August 31, 2026, the default value for `beta` will change to `false`.", "required": true, "type": "boolean", "x-ms-deprecation": { - "defaultChangeDate": "2026-04-30", + "defaultChangeDate": "2026-08-31", "currentDefault": true, "newDefault": false, - "description": "The default value will change from `true` to `false` on **April 30, 2026**." + "description": "The default value will change from `true` to `false` on **August 31, 2026**." } } ], @@ -1668,7 +1668,7 @@ "/workspaces/{workspaceId}/environments/{environmentId}/libraries?beta=false": { "get": { "summary": "Get environment published libraries.", - "description": "> [!NOTE]\n> This API is a release version of a beta version due to be deprecated on April 30, 2026.\n**When calling this API - callers must set the query parameter `beta` to the value `false` (`preview` query parameter has been replaced by `beta`. For backward compatibility, `preview` is still supported and behaves the same as `beta`)**\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\nRead permission for the environment item. \n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All or Environment.Read.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/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": "> [!NOTE]\n> This API is a release version of a beta version due to be deprecated on August 31, 2026.\n**When calling this API - callers must set the query parameter `beta` to the value `false` (`preview` query parameter has been replaced by `beta`. For backward compatibility, `preview` is still supported and behaves the same as `beta`)**\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\nRead permission for the environment item. \n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All or Environment.Read.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/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": [ "Published" ], @@ -1711,10 +1711,10 @@ "required": true, "type": "boolean", "x-ms-deprecation": { - "defaultChangeDate": "2026-04-30", + "defaultChangeDate": "2026-08-31", "currentDefault": true, "newDefault": false, - "description": "The default value will change from `true` to `false` on **April 30, 2026**." + "description": "The default value will change from `true` to `false` on **August 31, 2026**." } } ], @@ -1755,7 +1755,7 @@ "/workspaces/{workspaceId}/environments/{environmentId}/libraries?beta=true": { "get": { "summary": "Get environment published libraries.", - "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. This beta API will be deprecated on **April 30, 2026**, and replaced by a stable version, available [here](/rest/api/fabric/environment/published/list-libraries). The new version introduces breaking changes and is not backward compatible.\n**When calling this API, callers must specify `true` as the value for the query parameter `beta` (`preview` query parameter has been replaced by `beta`. For backward compatibility, `preview` is still supported and behaves the same as `beta`).**\n\n## Deprecation Notice\n\nA new query parameter `beta` has been introduced to facilitate this transition:\n* The `beta` query parameter currently defaults to `true`.\n* Set the value of the `beta` query parameter to `false` to use the stable Release version of this API.\n* Starting April 30, 2026, the default value for `beta` will change to `false`.\n\nIt is recommended to migrate your integration to use the Release version as soon as possible by specifying `false` for the `beta` query parameter (**the default value for the `beta` query parameter will be set to `false` on API's deprecation date**).\n\nThe following incompatible changes were introduced in the Release version:\n* Different response format and schema structure\n* Enhanced library properties in the response\n* Updated field names and data types\n* Improved error handling and messages\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\nRead permission for the environment item. \n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All or Environment.Read.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/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": "> [!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. This beta API will be deprecated on **August 31, 2026**, and replaced by a stable version, available [here](/rest/api/fabric/environment/published/list-libraries). The new version introduces breaking changes and is not backward compatible.\n**When calling this API, callers must specify `true` as the value for the query parameter `beta` (`preview` query parameter has been replaced by `beta`. For backward compatibility, `preview` is still supported and behaves the same as `beta`).**\n\n## Deprecation Notice\n\nA new query parameter `beta` has been introduced to facilitate this transition:\n* The `beta` query parameter currently defaults to `true`.\n* Set the value of the `beta` query parameter to `false` to use the stable Release version of this API.\n* Starting August 31, 2026, the default value for `beta` will change to `false`.\n\nIt is recommended to migrate your integration to use the Release version as soon as possible by specifying `false` for the `beta` query parameter (**the default value for the `beta` query parameter will be set to `false` on API's deprecation date**).\n\nThe following incompatible changes were introduced in the Release version:\n* Different response format and schema structure\n* Enhanced library properties in the response\n* Updated field names and data types\n* Improved error handling and messages\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\nRead permission for the environment item. \n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All or Environment.Read.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/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": [ "Published" ], @@ -1783,14 +1783,14 @@ { "name": "beta", "in": "query", - "description": "This parameter specifies which version of the API to use. Set to `true` to use the beta version described on this page, or to `false` to use the Release version detailed [here](/rest/api/fabric/environment/published/list-libraries).\nStarting April 30, 2026, the default value for `beta` will change to `false`.", + "description": "This parameter specifies which version of the API to use. Set to `true` to use the beta version described on this page, or to `false` to use the Release version detailed [here](/rest/api/fabric/environment/published/list-libraries).\nStarting August 31, 2026, the default value for `beta` will change to `false`.", "required": true, "type": "boolean", "x-ms-deprecation": { - "defaultChangeDate": "2026-04-30", + "defaultChangeDate": "2026-08-31", "currentDefault": true, "newDefault": false, - "description": "The default value will change from `true` to `false` on **April 30, 2026**." + "description": "The default value will change from `true` to `false` on **August 31, 2026**." } } ], @@ -1891,7 +1891,7 @@ "/workspaces/{workspaceId}/environments/{environmentId}/staging/publish?beta=false": { "post": { "summary": "Trigger an environment publish operation.", - "description": "> [!NOTE]\n> This API is a release version of a beta version due to be deprecated on April 30, 2026.\n**When calling this API - callers must set the query parameter `beta` to the value `false`**\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\nWrite permission for the environment item. \n\n## Required Delegated Scopes\n\nItem.ReadWrite.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/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": "> [!NOTE]\n> This API is a release version of a beta version due to be deprecated on August 31, 2026.\n**When calling this API - callers must set the query parameter `beta` to the value `false`**\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\nWrite permission for the environment item. \n\n## Required Delegated Scopes\n\nItem.ReadWrite.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/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" ], @@ -1924,16 +1924,16 @@ "required": true, "type": "boolean", "x-ms-deprecation": { - "defaultChangeDate": "2026-04-30", + "defaultChangeDate": "2026-08-31", "currentDefault": true, "newDefault": false, - "description": "The default value will change from `true` to `false` on **April 30, 2026**." + "description": "The default value will change from `true` to `false` on **August 31, 2026**." } } ], "responses": { "202": { - "description": "Request accepted, publish operation is in progress. Returns the GA contract when `beta=false` (default after April 30, 2026).", + "description": "Request accepted, publish operation is in progress. Returns the GA contract when `beta=false` (default after August 31, 2026).", "headers": { "Location": { "description": "The URL of the operation status, which can be used to track the operation state.", @@ -1986,7 +1986,7 @@ "/workspaces/{workspaceId}/environments/{environmentId}/staging/publish?beta=true": { "post": { "summary": "Trigger an environment publish operation.", - "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. This beta API will be deprecated on **April 30, 2026**, and replaced by a stable version, available [here](/rest/api/fabric/environment/items/publish-environment). The new version introduces breaking changes and is not backward compatible.\n**When calling this API, callers must specify `true` as the value for the query parameter `beta` (`preview` query parameter has been replaced by `beta`. For backward compatibility, `preview` is still supported and behaves the same as `beta`).**\n\n## Deprecation Notice\n\nA new query parameter `beta` has been introduced to facilitate this transition:\n* The `beta` query parameter currently defaults to `true`.\n* Set the value of the `beta` query parameter to `false` to use the stable Release version of this API.\n* Starting April 30, 2026, the default value for `beta` will change to `false`.\n\nIt is recommended to migrate your integration to use the Release version as soon as possible by specifying `false` for the `beta` query parameter (**the default value for the `beta` query parameter will be set to `false` on API's deprecation date**).\n\nThe following incompatible changes were introduced in the Release version:\n* Response is following [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation) pattern and HTTP response code 202 may be returned.\n\n## Permissions\n\nWrite permission for the environment item. \n\n## Required Delegated Scopes\n\nItem.ReadWrite.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/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": "> [!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. This beta API will be deprecated on **August 31, 2026**, and replaced by a stable version, available [here](/rest/api/fabric/environment/items/publish-environment). The new version introduces breaking changes and is not backward compatible.\n**When calling this API, callers must specify `true` as the value for the query parameter `beta` (`preview` query parameter has been replaced by `beta`. For backward compatibility, `preview` is still supported and behaves the same as `beta`).**\n\n## Deprecation Notice\n\nA new query parameter `beta` has been introduced to facilitate this transition:\n* The `beta` query parameter currently defaults to `true`.\n* Set the value of the `beta` query parameter to `false` to use the stable Release version of this API.\n* Starting August 31, 2026, the default value for `beta` will change to `false`.\n\nIt is recommended to migrate your integration to use the Release version as soon as possible by specifying `false` for the `beta` query parameter (**the default value for the `beta` query parameter will be set to `false` on API's deprecation date**).\n\nThe following incompatible changes were introduced in the Release version:\n* Response is following [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation) pattern and HTTP response code 202 may be returned.\n\n## Permissions\n\nWrite permission for the environment item. \n\n## Required Delegated Scopes\n\nItem.ReadWrite.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/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" ], @@ -2014,14 +2014,14 @@ { "name": "beta", "in": "query", - "description": "This parameter specifies which version of the API to use. Set to `true` to use the beta version described on this page, or to `false` to use the Release version detailed [here](/rest/api/fabric/environment/items/publish-environment).\nStarting April 30, 2026, the default value for `beta` will change to `false`.", + "description": "This parameter specifies which version of the API to use. Set to `true` to use the beta version described on this page, or to `false` to use the Release version detailed [here](/rest/api/fabric/environment/items/publish-environment).\nStarting August 31, 2026, the default value for `beta` will change to `false`.", "required": true, "type": "boolean", "x-ms-deprecation": { - "defaultChangeDate": "2026-04-30", + "defaultChangeDate": "2026-08-31", "currentDefault": true, "newDefault": false, - "description": "The default value will change from `true` to `false` on **April 30, 2026**." + "description": "The default value will change from `true` to `false` on **August 31, 2026**." } } ], diff --git a/eventSchemaSet/definitions.json b/eventSchemaSet/definitions.json index 67cc4c7..9391c56 100644 --- a/eventSchemaSet/definitions.json +++ b/eventSchemaSet/definitions.json @@ -101,13 +101,13 @@ "description": "The format of the item definition. ", "type": "string" }, - "EventSchemaSetPublicDefinition": { + "EventSchemaSetPublicDefinition": { "description": "EventSchemaSet public definition object. Refer to this [article](/rest/api/fabric/articles/item-management/definitions/eventschemaset-definition) for more details on the structure of the EventSchemaSet definition.", "type": "object", "required": [ "parts" ], "properties": { "format": { - "description": "The format of the item definition. ", + "description": "The format of the event schema set definition. ", "readOnly": false }, "parts": { diff --git a/eventhouse/definitions.json b/eventhouse/definitions.json index b2f50c9..0d5c1bc 100644 --- a/eventhouse/definitions.json +++ b/eventhouse/definitions.json @@ -142,7 +142,7 @@ "required": ["parts"], "properties": { "format": { - "description": "The format of the item definition.", + "description": "The format of the eventhouse definition.", "type": "string", "readOnly": false }, diff --git a/eventstream/definitions.json b/eventstream/definitions.json index f333136..9455073 100644 --- a/eventstream/definitions.json +++ b/eventstream/definitions.json @@ -95,7 +95,7 @@ "required": ["parts"], "properties": { "format": { - "description": "The format of the item definition.", + "description": "The format of the eventstream definition.", "type": "string", "readOnly": false }, diff --git a/graphModel/definitions.json b/graphModel/definitions.json index c3e300d..2ed887f 100644 --- a/graphModel/definitions.json +++ b/graphModel/definitions.json @@ -104,7 +104,7 @@ ], "properties": { "format": { - "description": "The format of the item definition. Additional `format` types may be added over time.", + "description": "The format of the graph model definition. Additional `format` types may be added over time.", "type": "string", "enum": [ "json" diff --git a/graphQLApi/definitions.json b/graphQLApi/definitions.json index c92b2ba..e6937b4 100644 --- a/graphQLApi/definitions.json +++ b/graphQLApi/definitions.json @@ -92,7 +92,7 @@ "required": ["parts"], "properties": { "format": { - "description": "The format of the item definition.", + "description": "The format of the GraphQL definition.", "type": "string", "readOnly": false }, diff --git a/graphQuerySet/definitions.json b/graphQuerySet/definitions.json index 4facb08..745d1c1 100644 --- a/graphQuerySet/definitions.json +++ b/graphQuerySet/definitions.json @@ -86,7 +86,7 @@ "required": ["parts"], "properties": { "format": { - "description": "The format of the item definition. Currently we support json format.", + "description": "The format of the graph query set definition. Currently we support json format.", "type": "string", "readOnly": false }, diff --git a/kqlDashboard/definitions.json b/kqlDashboard/definitions.json index de4074b..2633ac2 100644 --- a/kqlDashboard/definitions.json +++ b/kqlDashboard/definitions.json @@ -73,7 +73,7 @@ "required": ["parts"], "properties": { "format": { - "description": "The format of the item definition.", + "description": "The format of the KQL dashboard definition.", "type": "string", "readOnly": false }, diff --git a/kqlDatabase/definitions.json b/kqlDatabase/definitions.json index d4b11c6..bb76ed0 100644 --- a/kqlDatabase/definitions.json +++ b/kqlDatabase/definitions.json @@ -163,7 +163,7 @@ ], "properties": { "format": { - "description": "The format of the item definition.", + "description": "The format of the KQL database definition.", "type": "string", "readOnly": false }, diff --git a/kqlQueryset/definitions.json b/kqlQueryset/definitions.json index dde5d1f..dbb58af 100644 --- a/kqlQueryset/definitions.json +++ b/kqlQueryset/definitions.json @@ -92,7 +92,7 @@ "required": ["parts"], "properties": { "format": { - "description": "The format of the item definition.", + "description": "The format of the KQL queryset definition.", "type": "string", "readOnly": false }, diff --git a/lakehouse/definitions.json b/lakehouse/definitions.json index b66723b..18daecf 100644 --- a/lakehouse/definitions.json +++ b/lakehouse/definitions.json @@ -197,7 +197,7 @@ "required": ["parts"], "properties": { "format": { - "description": "The format of the item definition.", + "description": "The format of the lakehouse definition.", "type": "string", "readOnly": false }, diff --git a/map/definitions.json b/map/definitions.json index 433b73d..63cbc7f 100644 --- a/map/definitions.json +++ b/map/definitions.json @@ -92,7 +92,7 @@ "required": ["parts"], "properties": { "format": { - "description": "The format of the item definition. Additional `format` types may be added over time.", + "description": "The format of the map definition. Additional `format` types may be added over time.", "type": "string", "readOnly": false }, diff --git a/mirroredAzureDatabricksCatalog/definitions.json b/mirroredAzureDatabricksCatalog/definitions.json index febcee2..04d0bec 100644 --- a/mirroredAzureDatabricksCatalog/definitions.json +++ b/mirroredAzureDatabricksCatalog/definitions.json @@ -307,7 +307,7 @@ ], "properties": { "format": { - "description": "The format of the item definition.", + "description": "The format of the mirrored Azure Databricks catalog definition.", "type": "string", "readOnly": false }, diff --git a/mirroredAzureDatabricksCatalog/swagger.json b/mirroredAzureDatabricksCatalog/swagger.json index 07b3895..c6e98e1 100644 --- a/mirroredAzureDatabricksCatalog/swagger.json +++ b/mirroredAzureDatabricksCatalog/swagger.json @@ -412,6 +412,13 @@ "type": "string", "format": "uuid", "required": true + }, + { + "in": "query", + "name": "format", + "description": "The format of the Mirrored Azure Databricks Catalog public definition.", + "type": "string", + "required": false } ], "responses": { diff --git a/mirroredCatalog/definitions.json b/mirroredCatalog/definitions.json index 58220b0..a885f21 100644 --- a/mirroredCatalog/definitions.json +++ b/mirroredCatalog/definitions.json @@ -215,7 +215,7 @@ ], "properties": { "format": { - "description": "The format of the item definition.", + "description": "The format of the mirrored catalog definition.", "type": "string", "readOnly": false }, diff --git a/mirroredCatalog/swagger.json b/mirroredCatalog/swagger.json index 8ebe612..446dba0 100644 --- a/mirroredCatalog/swagger.json +++ b/mirroredCatalog/swagger.json @@ -396,6 +396,13 @@ "type": "string", "format": "uuid", "required": true + }, + { + "in": "query", + "name": "format", + "description": "The format of the Mirrored Catalog public definition.", + "type": "string", + "required": false } ], "responses": { diff --git a/mirroredDatabase/definitions.json b/mirroredDatabase/definitions.json index c94de21..0973445 100644 --- a/mirroredDatabase/definitions.json +++ b/mirroredDatabase/definitions.json @@ -128,6 +128,11 @@ "parts" ], "properties": { + "format": { + "description": "The format of the mirrored database definition.", + "type": "string", + "readOnly": false + }, "parts": { "description": "A list of definition parts.", "type": "array", diff --git a/mirroredDatabase/swagger.json b/mirroredDatabase/swagger.json index 192d06f..01dd09c 100644 --- a/mirroredDatabase/swagger.json +++ b/mirroredDatabase/swagger.json @@ -388,6 +388,13 @@ "type": "string", "format": "uuid", "required": true + }, + { + "in": "query", + "name": "format", + "description": "The format of the Mirrored Database public definition.", + "type": "string", + "required": false } ], "responses": { diff --git a/mlExperiment/definitions.json b/mlExperiment/definitions.json index ee4de88..d973411 100644 --- a/mlExperiment/definitions.json +++ b/mlExperiment/definitions.json @@ -105,7 +105,7 @@ "required": ["parts"], "properties": { "format": { - "description": "The format of the item definition.", + "description": "The format of the machine learning experiment definition.", "type": "string", "readOnly": false }, diff --git a/mlModel/definitions.json b/mlModel/definitions.json index ae19b73..1ca4ef1 100644 --- a/mlModel/definitions.json +++ b/mlModel/definitions.json @@ -87,7 +87,7 @@ "required": [ "parts" ], "properties": { "format": { - "description": "The format of the item definition.", + "description": "The format of the machine learning model definition.", "type": "string", "readOnly": false }, diff --git a/mountedDataFactory/definitions.json b/mountedDataFactory/definitions.json index 7c6e866..943305b 100644 --- a/mountedDataFactory/definitions.json +++ b/mountedDataFactory/definitions.json @@ -92,7 +92,7 @@ "required": ["parts"], "properties": { "format": { - "description": "The format of the item definition. Supported format: `MountedDataFactoryV1`.", + "description": "The format of the mounted data factory definition. Supported format: `MountedDataFactoryV1`.", "type": "string", "readOnly": false }, diff --git a/ontology/definitions.json b/ontology/definitions.json index 50f05a8..d7eed14 100644 --- a/ontology/definitions.json +++ b/ontology/definitions.json @@ -86,7 +86,7 @@ "required": [ "parts" ], "properties": { "format": { - "description": "The format of the item definition.", + "description": "The format of the Ontology definition.", "type": "string", "readOnly": false }, diff --git a/operationsAgent/definitions.json b/operationsAgent/definitions.json index e13e5f7..d93fcc2 100644 --- a/operationsAgent/definitions.json +++ b/operationsAgent/definitions.json @@ -129,7 +129,7 @@ "required": ["parts"], "properties": { "format": { - "description": "The format of the item definition. Additional `format` types may be added over time.", + "description": "The format of the operations agent definition. Additional `format` types may be added over time.", "type": "string", "enum": [ "OperationsAgentV1" diff --git a/platform/definitions/catalog.json b/platform/definitions/catalog.json index 04a7969..ead15a3 100644 --- a/platform/definitions/catalog.json +++ b/platform/definitions/catalog.json @@ -57,6 +57,11 @@ "description": "The Fabric item type.", "type": "string", "$ref": "../../common/definitions.json#/definitions/ItemType" + }, + "hierarchy": { + "description": "The hierarchy of the catalog entry.", + "type": "object", + "$ref": "#/definitions/ItemCatalogEntryHierarchy" } }, "allOf": [ @@ -66,12 +71,38 @@ ], "x-ms-discriminator-value": "FabricItem" }, + "ItemCatalogEntryHierarchy": { + "description": "The immediate ancestors of the item in Fabric's data architecture. Only applicable levels are returned.", + "type": "object", + "properties": { + "workspace": { + "description": "The workspace that contains the item.", + "type": "object", + "$ref": "#/definitions/CatalogWorkspace" + } + } + }, + "CatalogWorkspace": { + "description": "The workspace for the catalog entry.", + "type": "object", + "properties": { + "displayName": { + "description": "The display name of the workspace.", + "type": "string" + }, + "id": { + "description": "The ID of the workspace.", + "type": "string", + "format": "uuid" + } + } + }, "CatalogQueryRequest": { "type": "object", "description": "The query for the search.", "properties": { "search": { - "description": "The text query for the search. This field supports searching across the display name and description of the CatalogEntry.", + "description": "The text query for the search. This field supports searching across the display name, workspace display name and description of the CatalogEntry.", "type": "string" }, "pageSize": { diff --git a/platform/definitions/externaldatasharing.json b/platform/definitions/externaldatasharing.json index 38885ae..5b2fe7f 100644 --- a/platform/definitions/externaldatasharing.json +++ b/platform/definitions/externaldatasharing.json @@ -22,7 +22,7 @@ }, "recipient": { "description": "The recipient who is invited to accept the external data share.", - "$ref": "#/definitions/ExternalDataShareRecipient", + "$ref": "#/definitions/BaseExternalDataShareRecipient", "readOnly": false } } @@ -74,7 +74,7 @@ }, "recipient": { "description": "The recipient who was invited to accept the external data share.", - "$ref": "#/definitions/ExternalDataShareRecipient", + "$ref": "#/definitions/BaseExternalDataShareRecipient", "readOnly": true }, "status": { @@ -158,6 +158,84 @@ } } }, + "BaseExternalDataShareRecipient": { + "description": "The recipient of an external data share. Use 'ExternalDataShareUserRecipient' to share with a user by email, or 'ExternalDataShareSPRecipient' to share with a service principal by object ID. If 'type' is not specified, it defaults to 'User'.", + "type": "object", + "required": ["type"], + "discriminator": "type", + "properties": { + "type": { + "description": "The type of the external data share recipient. Defaults to 'User' if not provided. Additional recipient types may be added over time.", + "$ref": "#/definitions/ExternalDataShareRecipientType" + } + } + }, + "ExternalDataShareRecipientType": { + "description": "The type of the external data share recipient. Defaults to 'User' if not provided. Additional recipient types may be added over time.", + "type": "string", + "default": "User", + "enum": ["ServicePrincipal", "User"], + "x-ms-enum": { + "name": "ExternalDataShareRecipientType", + "modelAsString": true, + "values": [ + { + "value": "ServicePrincipal", + "description": "The recipient is a service principal, identified by object ID and tenant ID." + }, + { + "value": "User", + "description": "The recipient is a user, identified by user principal name (email address). This is the default value." + } + ] + } + }, + "ExternalDataShareSPRecipient": { + "description": "An external data share recipient that is a service principal, identified by principal ID and tenant ID.", + "type": "object", + "required": ["principalId", "tenantId"], + "x-ms-discriminator-value": "ServicePrincipal", + "allOf": [ + { + "$ref": "#/definitions/BaseExternalDataShareRecipient" + } + ], + "properties": { + "principalId": { + "type": "string", + "format": "uuid", + "description": "The principal ID of the service principal recipient. This is equivalent to the Entra ID object ID." + }, + "tenantId": { + "type": "string", + "format": "uuid", + "description": "The tenant ID of the service principal recipient." + } + } + }, + "ExternalDataShareUserRecipient": { + "description": "An external data share recipient that is a user, identified by user principal name (email address). This is the default recipient type.", + "type": "object", + "required": ["userPrincipalName"], + "x-ms-discriminator-value": "User", + "allOf": [ + { + "$ref": "#/definitions/BaseExternalDataShareRecipient" + } + ], + "properties": { + "userPrincipalName": { + "type": "string", + "description": "The user principal name (email address) of the recipient.", + "maxLength": 256 + }, + "tenantId": { + "type": "string", + "format": "uuid", + "description": "The tenant ID of the user recipient. Optional." + } + } + }, "ExternalDataShareInvitationDetails": { "type": "object", "description": "External data share invitation details.", diff --git a/platform/definitions/platform.json b/platform/definitions/platform.json index 034cef1..bb4bd25 100644 --- a/platform/definitions/platform.json +++ b/platform/definitions/platform.json @@ -2549,7 +2549,7 @@ "x-ms-discriminator-value": "Lakehouse", "properties": { "lakehouse": { - "description": "Reference to the destination lakehouse.", + "description": "Reference to the destination lakehouse. Currently, only ItemReferenceById is supported.", "$ref": "../../common/definitions.json#/definitions/ItemReference", "readOnly": false } @@ -2691,3 +2691,4 @@ } } } + diff --git a/platform/examples/externaldatasharing/CreateExternalDataShare.json b/platform/examples/externaldatasharing/CreateExternalDataShare.json index e773e93..03639b4 100644 --- a/platform/examples/externaldatasharing/CreateExternalDataShare.json +++ b/platform/examples/externaldatasharing/CreateExternalDataShare.json @@ -7,6 +7,7 @@ "Files/Sales/Contoso_Sales_2023" ], "recipient": { + "type": "User", "userPrincipalName": "lisa@fabrikam.com" } } @@ -26,6 +27,7 @@ "type": "User" }, "recipient": { + "type": "User", "userPrincipalName": "lisa@fabrikam.com" }, "status": "Pending", diff --git a/platform/examples/externaldatasharing/CreateExternalDataShareWithMultiplePaths.json b/platform/examples/externaldatasharing/CreateExternalDataShareWithMultiplePaths.json index bba6a9a..c061add 100644 --- a/platform/examples/externaldatasharing/CreateExternalDataShareWithMultiplePaths.json +++ b/platform/examples/externaldatasharing/CreateExternalDataShareWithMultiplePaths.json @@ -9,6 +9,7 @@ "Files/Sales/Contoso_Sales_2024/SubFolder2/SubFolder3" ], "recipient": { + "type": "User", "userPrincipalName": "lisa@fabrikam.com" } } @@ -30,6 +31,7 @@ "type": "User" }, "recipient": { + "type": "User", "userPrincipalName": "lisa@fabrikam.com" }, "status": "Pending", diff --git a/platform/examples/externaldatasharing/CreateExternalDataShareWithRecipientObjectId.json b/platform/examples/externaldatasharing/CreateExternalDataShareWithRecipientObjectId.json new file mode 100644 index 0000000..64cf5da --- /dev/null +++ b/platform/examples/externaldatasharing/CreateExternalDataShareWithRecipientObjectId.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229", + "itemId": "5b218778-e7a5-4d73-8187-f10824047715", + "createExternalDataShareRequest": { + "paths": [ + "Files/Sales/Contoso_Sales_2023" + ], + "recipient": { + "type": "ServicePrincipal", + "principalId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "tenantId": "c51dc03f-268a-4da0-a879-25f24947ab8b" + } + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items/5b218778-e7a5-4d73-8187-f10824047715/externalDataShares/dccc162f-7a41-4720-83c3-5c7e81187959" + }, + "body": { + "id": "dccc162f-7a41-4720-83c3-5c7e81187959", + "paths": [ + "Files/Sales/Contoso_Sales_2023" + ], + "creatorPrincipal": { + "id": "f3052d1c-61a9-46fb-8df9-0d78916ae041", + "type": "User" + }, + "recipient": { + "type": "ServicePrincipal", + "principalId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "tenantId": "c51dc03f-268a-4da0-a879-25f24947ab8b" + }, + "status": "Pending", + "expirationTimeUtc": "2024-12-13T00:00:00.000Z", + "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229", + "itemId": "5b218778-e7a5-4d73-8187-f10824047715", + "invitationUrl": "https://app.fabric.microsoft.com/externaldatasharing/accept?providerTenantId=34f92457-fe9d-4c36-92a8-499fdfaf0f8f&shareId=dccc162f-7a41-4720-83c3-5c7e81187959" + } + } + } +} diff --git a/platform/examples/externaldatasharing/CreateExternalDataShareWithRecipientTenantId.json b/platform/examples/externaldatasharing/CreateExternalDataShareWithRecipientTenantId.json index 054aacb..c47e38e 100644 --- a/platform/examples/externaldatasharing/CreateExternalDataShareWithRecipientTenantId.json +++ b/platform/examples/externaldatasharing/CreateExternalDataShareWithRecipientTenantId.json @@ -7,6 +7,7 @@ "Files/Sales/Contoso_Sales_2023" ], "recipient": { + "type": "User", "userPrincipalName": "lisa@fabrikam.com", "tenantId": "c51dc03f-268a-4da0-a879-25f24947ab8b" } @@ -27,6 +28,7 @@ "type": "User" }, "recipient": { + "type": "User", "userPrincipalName": "lisa@fabrikam.com", "tenantId": "c51dc03f-268a-4da0-a879-25f24947ab8b" }, diff --git a/platform/examples/externaldatasharing/GetExternalDataShare.json b/platform/examples/externaldatasharing/GetExternalDataShare.json index abd7aa7..03dc7e4 100644 --- a/platform/examples/externaldatasharing/GetExternalDataShare.json +++ b/platform/examples/externaldatasharing/GetExternalDataShare.json @@ -16,6 +16,7 @@ "type": "User" }, "recipient": { + "type": "User", "userPrincipalName": "lisa@fabrikam.com" }, "status": "Pending", diff --git a/platform/examples/externaldatasharing/ListExternalDataSharesInItem.json b/platform/examples/externaldatasharing/ListExternalDataSharesInItem.json index 32e0f3f..82cf94e 100644 --- a/platform/examples/externaldatasharing/ListExternalDataSharesInItem.json +++ b/platform/examples/externaldatasharing/ListExternalDataSharesInItem.json @@ -17,7 +17,9 @@ "type": "User" }, "recipient": { - "userPrincipalName": "lisa@fabrikam.com" + "type": "ServicePrincipal", + "principalId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "tenantId": "c51dc03f-268a-4da0-a879-25f24947ab8b" }, "status": "Pending", "expirationTimeUtc": "2024-12-13T00:00:00.000Z", @@ -35,6 +37,7 @@ "type": "User" }, "recipient": { + "type": "User", "userPrincipalName": "lisa@fabrikam.com" }, "status": "Active", @@ -54,6 +57,7 @@ "type": "User" }, "recipient": { + "type": "User", "userPrincipalName": "lisa@fabrikam.com" }, "status": "InvitationExpired", @@ -72,6 +76,7 @@ "type": "User" }, "recipient": { + "type": "User", "userPrincipalName": "lisa@fabrikam.com" }, "status": "Revoked", diff --git a/platform/examples/platform/CatalogSearch.json b/platform/examples/platform/CatalogSearch.json index b89cad0..fa2b952 100644 --- a/platform/examples/platform/CatalogSearch.json +++ b/platform/examples/platform/CatalogSearch.json @@ -10,23 +10,35 @@ "200": { "body": { "value": [ - { - "id": "0acd697c-1550-43cd-b998-91bfb12347c6", - "type": "Report", - "catalogEntryType": "FabricItem", - "displayName": "Monthly Sales Revenue", - "description": "Consolidated revenue report for the current fiscal year." - }, - { - "id": "123d697c-7848-77cd-b887-91bfb12347cc", - "type": "Lakehouse", - "catalogEntryType": "FabricItem", - "displayName": "Yeartly Sales Revenue", - "description": "Consolidated revenue report for the current fiscal year." - } - ], - "continuationToken": "lyJ1257lksfdfG==" + { + "id": "0acd697c-1550-43cd-b998-91bfb12347c6", + "type": "Report", + "catalogEntryType": "FabricItem", + "displayName": "Monthly Sales Revenue", + "description": "Consolidated revenue report for the current fiscal year.", + "hierarchy": { + "workspace": { + "id": "7f2c8a91-3b4d-4e5f-a6b7-c8d9e0f1a2b3", + "displayName": "Sales Analytics" + } + } + }, + { + "id": "5e8f2a1b-9c3d-4e7f-b6a5-d4c3b2a1e0f9", + "type": "Lakehouse", + "catalogEntryType": "FabricItem", + "displayName": "Sales Revenue Lakehouse", + "description": "Central lakehouse for sales transaction data.", + "hierarchy": { + "workspace": { + "id": "a2b3c4d5-e6f7-4a8b-9c0d-1e2f3a4b5c6d", + "displayName": "Finance Platform" + } + } + } + ], + "continuationToken": "eyJza2lwIjoyLCJ0YWtl..." } } } -} +} \ No newline at end of file diff --git a/platform/swagger.json b/platform/swagger.json index f4ab4d7..d78f7c2 100644 --- a/platform/swagger.json +++ b/platform/swagger.json @@ -6115,6 +6115,9 @@ "Create an external data share with a specific recipient tenant ID example": { "$ref": "./examples/externaldatasharing/CreateExternalDataShareWithRecipientTenantID.json" }, + "Create an external data share with recipient object ID example": { + "$ref": "./examples/externaldatasharing/CreateExternalDataShareWithRecipientObjectId.json" + }, "Create an external data share with multiple paths example": { "$ref": "./examples/externaldatasharing/CreateExternalDataShareWithMultiplePaths.json" } @@ -6400,7 +6403,7 @@ "/externalDataShares/invitations/{invitationId}": { "get": { "summary": "Returns information about an external data share invitation.", - "description": "## Required Delegated Scopes\n\nExternalDataShare.Accept.All\n\n## Required Tenant Settings\n\nTo use this API, enable the *Users can accept external data shares* admin switch for the calling principal.\n\n## Limitations\n\nMaximum 10 requests per minute.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface", + "description": "## Required Delegated Scopes\n\nExternalDataShare.Accept.All\n\n## Required Tenant Settings\n\nTo use this API, enable the *Users can accept external data shares* admin switch for the calling principal.\n\n## Limitations\n\nMaximum 10 requests per minute.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", "tags": [ "ExternalDataSharesRecipient" ], @@ -6463,7 +6466,7 @@ "/externalDataShares/invitations/{invitationId}/accept": { "post": { "summary": "Accepts an external data share invitation into a specified data item.", - "description": "## Permissions\n\nThe caller must have *write* permissions on the item.\n\n## Required Delegated Scopes\n\nExternalDataShare.Accept.All and for the specified item, one of the 2 types of scopes:\n- Generic scope: Item.ReadWrite.All\n- Specific scope: *itemType*.ReadWrite.All (for example: Lakehouse.ReadWrite.All)\n\n For more information about scopes, see [scopes article](/rest/api/fabric/articles/scopes).\n\n## Required Tenant Settings\n\nTo use this API, enable the *Users can accept external data shares* admin switch for the calling principal.\n\n## Limitations\n\nMaximum 10 requests per minute.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface", + "description": "## Permissions\n\nThe caller must have *write* permissions on the item.\n\n## Required Delegated Scopes\n\nExternalDataShare.Accept.All and for the specified item, one of the 2 types of scopes:\n- Generic scope: Item.ReadWrite.All\n- Specific scope: *itemType*.ReadWrite.All (for example: Lakehouse.ReadWrite.All)\n\n For more information about scopes, see [scopes article](/rest/api/fabric/articles/scopes).\n\n## Required Tenant Settings\n\nTo use this API, enable the *Users can accept external data shares* admin switch for the calling principal.\n\n## Limitations\n\nMaximum 10 requests per minute.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", "tags": [ "ExternalDataSharesRecipient" ], diff --git a/reflex/definitions.json b/reflex/definitions.json index 0925674..e37da47 100644 --- a/reflex/definitions.json +++ b/reflex/definitions.json @@ -92,7 +92,7 @@ "required": ["parts"], "properties": { "format": { - "description": "The format of the item definition. Supported format: `json`.", + "description": "The format of the reflex definition. Supported format: `json`.", "type": "string", "readOnly": false }, diff --git a/report/definitions.json b/report/definitions.json index e2f15af..00c9c8b 100644 --- a/report/definitions.json +++ b/report/definitions.json @@ -107,7 +107,7 @@ "required": ["parts"], "properties": { "format": { - "description": "The format of the item definition.", + "description": "The format of the report definition.", "type": "string", "readOnly": false }, diff --git a/report/swagger.json b/report/swagger.json index 6d11b02..467291c 100644 --- a/report/swagger.json +++ b/report/swagger.json @@ -406,6 +406,13 @@ "type": "string", "format": "uuid", "required": true + }, + { + "in": "query", + "name": "format", + "description": "The format of the report public definition.", + "type": "string", + "required": false } ], "responses": { diff --git a/semanticModel/definitions.json b/semanticModel/definitions.json index 489bea0..2a8838f 100644 --- a/semanticModel/definitions.json +++ b/semanticModel/definitions.json @@ -107,7 +107,7 @@ "required": ["parts"], "properties": { "format": { - "description": "The format of the item definition.", + "description": "The format of the semantic model definition.", "type": "string", "readOnly": false }, diff --git a/snowflakeDatabase/definitions.json b/snowflakeDatabase/definitions.json index ea14bcd..edc53f4 100644 --- a/snowflakeDatabase/definitions.json +++ b/snowflakeDatabase/definitions.json @@ -221,7 +221,7 @@ ], "properties": { "format": { - "description": "The format of the item definition.", + "description": "The format of the snowflake database definition.", "type": "string", "readOnly": false }, diff --git a/snowflakeDatabase/swagger.json b/snowflakeDatabase/swagger.json index edfb2e5..ab0d126 100644 --- a/snowflakeDatabase/swagger.json +++ b/snowflakeDatabase/swagger.json @@ -412,6 +412,13 @@ "type": "string", "format": "uuid", "required": true + }, + { + "in": "query", + "name": "format", + "description": "The format of the Snowflake database public definition.", + "type": "string", + "required": false } ], "responses": { diff --git a/sparkjobdefinition/definitions.json b/sparkjobdefinition/definitions.json index 154ad2c..dbb105a 100644 --- a/sparkjobdefinition/definitions.json +++ b/sparkjobdefinition/definitions.json @@ -210,11 +210,11 @@ }, "environmentId": { "description": "The environment ID that will be used for the Spark job definition. Can be used to specify Spark settings.", - "$ref": "../common/definitions.json#/definitions/ItemReference" + "$ref": "../common/definitions.json#/definitions/ItemReferenceById" }, "defaultLakehouseId": { "description": "The lakehouse ID that will be used as the default lakehouse of the Spark job definition.", - "$ref": "../common/definitions.json#/definitions/ItemReference" + "$ref": "../common/definitions.json#/definitions/ItemReferenceById" } } }, diff --git a/sqlDatabase/definitions.json b/sqlDatabase/definitions.json index 16af3d1..b05712b 100644 --- a/sqlDatabase/definitions.json +++ b/sqlDatabase/definitions.json @@ -271,7 +271,7 @@ }, "sourceDatabaseReference": { "description": "Set the reference for the source database to be restored from.", - "$ref": "../common/definitions.json#/definitions/ItemReference" + "$ref": "../common/definitions.json#/definitions/ItemReferenceById" } }, "allOf": [ @@ -311,6 +311,11 @@ "type": "object", "required": ["parts"], "properties": { + "format": { + "description": "The format of the SQL database definition.", + "type": "string", + "readOnly": false + }, "parts": { "description": "A list of definition parts.", "type": "array", diff --git a/sqlDatabase/swagger.json b/sqlDatabase/swagger.json index 92e61cc..8530611 100644 --- a/sqlDatabase/swagger.json +++ b/sqlDatabase/swagger.json @@ -415,6 +415,13 @@ "type": "string", "format": "uuid", "required": true + }, + { + "in": "query", + "name": "format", + "description": "The format of the SQL database public definition.", + "type": "string", + "required": false } ], "responses": { diff --git a/userDataFunction/definitions.json b/userDataFunction/definitions.json index ef0c704..ab24d77 100644 --- a/userDataFunction/definitions.json +++ b/userDataFunction/definitions.json @@ -86,7 +86,7 @@ "required": ["parts"], "properties": { "format": { - "description": "The format of the item definition.", + "description": "The format of the user data function definition.", "type": "string", "readOnly": false }, diff --git a/variableLibrary/definitions.json b/variableLibrary/definitions.json index 161914e..55b93e0 100644 --- a/variableLibrary/definitions.json +++ b/variableLibrary/definitions.json @@ -111,7 +111,7 @@ "required": ["parts"], "properties": { "format": { - "description": "The format of the item definition. Supported format: `VariableLibraryV1`.", + "description": "The format of the variable library definition. Supported format: `VariableLibraryV1`.", "type": "string", "readOnly": false }, diff --git a/warehouse/definitions.json b/warehouse/definitions.json index 1416c27..06c8a0c 100644 --- a/warehouse/definitions.json +++ b/warehouse/definitions.json @@ -155,7 +155,7 @@ "required": ["parts"], "properties": { "format": { - "description": "The format of the item definition.", + "description": "The format of the warehouse definition.", "type": "string", "readOnly": false },