From 9d7c3c28bae8e986cc3d1dedd1e0ecb76d18ee3d Mon Sep 17 00:00:00 2001 From: Fabric-APIs-Publish-Specification-Pipeline Date: Tue, 2 Jun 2026 22:07:48 +0000 Subject: [PATCH] Updating swagger files. --- apacheAirflowJob/definitions.json | 2 +- .../CreateApacheAirflowJobWithDefinition.json | 44 ++ apacheAirflowJob/swagger.json | 57 +-- appBackend/definitions.json | 81 ++++ .../CreateAppBackendWithoutDefinition.json | 27 ++ appBackend/examples/DeleteAppBackend.json | 9 + appBackend/examples/GetAppBackend.json | 17 + .../examples/ListAppBackendsInWorkspace.json | 27 ++ appBackend/examples/UpdateAppBackend.json | 21 + appBackend/swagger.json | 375 ++++++++++++++++++ common/definitions.json | 7 +- cosmosDbDatabase/definitions.json | 23 +- .../examples/GetCosmosDBDatabase.json | 4 + .../ListCosmosDBDatabasesInWorkspace.json | 10 +- platform/swagger.json | 8 +- 15 files changed, 677 insertions(+), 35 deletions(-) create mode 100644 apacheAirflowJob/examples/CreateApacheAirflowJobWithDefinition.json create mode 100644 appBackend/definitions.json create mode 100644 appBackend/examples/CreateAppBackendWithoutDefinition.json create mode 100644 appBackend/examples/DeleteAppBackend.json create mode 100644 appBackend/examples/GetAppBackend.json create mode 100644 appBackend/examples/ListAppBackendsInWorkspace.json create mode 100644 appBackend/examples/UpdateAppBackend.json create mode 100644 appBackend/swagger.json diff --git a/apacheAirflowJob/definitions.json b/apacheAirflowJob/definitions.json index c81213b..b1122d9 100644 --- a/apacheAirflowJob/definitions.json +++ b/apacheAirflowJob/definitions.json @@ -50,7 +50,7 @@ "readOnly": false }, "folderId": { - "description": "The folder ID. If not specified or null, the Apache Airflow is created with the workspace as its folder.", + "description": "The folder ID. If not specified or null, the Apache Airflow job is created with the workspace as its folder.", "type": "string", "format": "uuid", "readOnly": false diff --git a/apacheAirflowJob/examples/CreateApacheAirflowJobWithDefinition.json b/apacheAirflowJob/examples/CreateApacheAirflowJobWithDefinition.json new file mode 100644 index 0000000..8d86383 --- /dev/null +++ b/apacheAirflowJob/examples/CreateApacheAirflowJobWithDefinition.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229", + "createApacheAirflowJobRequest": { + "displayName": "ApacheAirflowJob1", + "description": "An Apache Airflow job description.", + "definition": { + "parts": [ + { + "path": "ApacheAirflowJobV1.json", + "payload": "ewogICJwcm9wZXJ0aWVzIjogewogICAgInR5cGUiOiAiQXBhY2hlQWlyZmxvd0pvYiIsCiAgICAidHlwZVByb3BlcnRpZXMiOiB7CiAgICAgICJhaXJmbG93UHJvcGVydGllcyI6IHsKICAgICAgICAiYWlyZmxvd1ZlcnNpb24iOiAiMi42LjMiLAogICAgICAgICJweXRob25WZXJzaW9uIjogIjMuOCIsCiAgICAgICAgImVudmlyb25tZW50VmFyaWFibGVzIjoge30sCiAgICAgICAgImFpcmZsb3dDb25maWd1cmF0aW9uT3ZlcnJpZGVzIjoge30sCiAgICAgICAgImFpcmZsb3dSZXF1aXJlbWVudHMiOiBbCiAgICAgICAgICAiZmxhc2stYmNyeXB0PT0wLjcuMSIKICAgICAgICBdLAogICAgICAgICJwYWNrYWdlUHJvdmlkZXJQYXRoIjogInBsdWdpbnMiLAogICAgICAgICJlbmFibGVBQURJbnRlZ3JhdGlvbiI6IHRydWUsCiAgICAgICAgImVuYWJsZVRyaWdnZXJlcnMiOiBmYWxzZSwKICAgICAgICAic2VjcmV0cyI6IFtdCiAgICAgIH0sCiAgICAgICJjb21wdXRlUHJvcGVydGllcyI6IHsKICAgICAgICAiY29tcHV0ZVBvb2wiOiAiU3RhcnRlclBvb2wiLAogICAgICAgICJsb2NhdGlvbiI6ICJDZW50cmFsIFVTIiwKICAgICAgICAiY29tcHV0ZVNpemUiOiAiU21hbGwiLAogICAgICAgICJleHRyYU5vZGVzIjogMCwKICAgICAgICAiZW5hYmxlQXZhaWxhYmlsaXR5Wm9uZXMiOiBmYWxzZSwKICAgICAgICAiZW5hYmxlQXV0b3NjYWxlIjogZmFsc2UKICAgICAgfQogICAgfQogIH0KfQ==", + "payloadType": "InlineBase64" + }, + { + "path": ".platform", + "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=", + "payloadType": "InlineBase64" + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "displayName": "ApacheAirflowJob1", + "description": "An Apache Airflow job description.", + "type": "ApacheAirflowJob", + "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229", + "id": "5b218778-e7a5-4d73-8187-f10824047715", + "sensitivityLabel": { + "id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f" + } + } + }, + "202": { + "headers": { + "Location": "https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6", + "x-ms-operation-id": "0acd697c-1550-43cd-b998-91bfbfbd47c6", + "Retry-After": 30 + } + } + } +} diff --git a/apacheAirflowJob/swagger.json b/apacheAirflowJob/swagger.json index c678215..3d2d91c 100644 --- a/apacheAirflowJob/swagger.json +++ b/apacheAirflowJob/swagger.json @@ -13,7 +13,7 @@ "/workspaces/{workspaceId}/apacheAirflowJobs": { "get": { "summary": "Returns a list of Apache Airflow jobs from the specified workspace.", - "description": "This API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\n The caller must have a *viewer* workspace role. \n\n## Required Delegated Scopes\n\nWorkspace.Read.All or Workspace.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "description": "This API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\nThe caller must have a *viewer* workspace role.\n\n## Required Delegated Scopes\n\nWorkspace.Read.All or Workspace.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", "tags": [ "Items" ], @@ -91,7 +91,7 @@ }, "post": { "summary": "Creates an Apache Airflow job in the specified workspace.", - "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\n The caller must have a *contributor* workspace role. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All \n\n## Limitations \n- To create an Apache Airflow job the workspace must be on a supported Fabric capacity. For more information see: [Microsoft Fabric license types](/fabric/enterprise/licenses#microsoft-fabric-license-types).\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\nThe caller must have a *contributor* workspace role.\n\n## Required Delegated Scopes\n\nItem.ReadWrite.All\n\n## Limitations\n\n- To create an Apache Airflow job, the workspace must be on a supported Fabric capacity. For more information, see: [Microsoft Fabric license types](/fabric/enterprise/licenses#microsoft-fabric-license-types).\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", "tags": [ "Items" ], @@ -168,8 +168,11 @@ } }, "x-ms-examples": { + "Create an Apache Airflow job example": { + "$ref": "./examples/CreateApacheAirflowJobWithoutDefinition.json" + }, "Create an Apache Airflow job with public definition example": { - "$ref": "./examples/CreateApacheAirflowJob.json" + "$ref": "./examples/CreateApacheAirflowJobWithDefinition.json" } } } @@ -177,7 +180,7 @@ "/workspaces/{workspaceId}/apacheAirflowJobs/{apacheAirflowJobId}": { "get": { "summary": "Returns properties of the specified Apache Airflow job.", - "description": "## Permissions\n\n The caller must have *read* permissions for the Apache Airflow job. \n\n## Required Delegated Scopes\n\n Item.Read.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "description": "## Permissions\n\nThe caller must have *read* permissions for the Apache Airflow job.\n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", "tags": [ "Items" ], @@ -238,7 +241,7 @@ }, "patch": { "summary": "Updates the properties of the specified Apache Airflow job.", - "description": "## Permissions\n\n The caller must have *read and write* permissions for the apache airflow job.\n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "description": "## Permissions\n\nThe caller must have *read and write* permissions for the Apache Airflow job.\n\n## Required Delegated Scopes\n\nItem.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", "tags": [ "Items" ], @@ -311,7 +314,7 @@ }, "delete": { "summary": "Deletes the specified Apache Airflow job.", - "description": "## Permissions\n\n The caller must have *write* permissions for the Apache Airflow job. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "description": "## Permissions\n\nThe caller must have *write* permissions for the Apache Airflow job.\n\n## Required Delegated Scopes\n\nItem.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", "tags": [ "Items" ], @@ -381,7 +384,7 @@ "/workspaces/{workspaceId}/apacheAirflowJobs/{apacheAirflowJobId}/getDefinition": { "post": { "summary": "Returns the specified Apache Airflow job public definition.", - "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get an Apache Airflow job's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the apache airflow job. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get an Apache Airflow job's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\nThe caller must have *read and write* permissions for the Apache Airflow job.\n\n## Required Delegated Scopes\n\nItem.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", "tags": [ "Items" ], @@ -410,7 +413,7 @@ { "in": "query", "name": "format", - "description": "The format of the public definition.", + "description": "The format of the Apache Airflow job public definition. If no format is provided, the default Apache Airflow job definition format is used.", "type": "string", "required": false } @@ -470,7 +473,7 @@ "/workspaces/{workspaceId}/apacheAirflowJobs/{apacheAirflowJobId}/updateDefinition": { "post": { "summary": "Overrides the definition for the specified Apache Airflow job.", - "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n \nUpdating the Apache Airflow job's definition, does not affect its sensitivity label. \n\n## Permissions\n\n The caller must have *read and write* permissions for the apache airflow job. \n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nUpdating an Apache Airflow job's definition does not affect its sensitivity label. \n\n## Permissions\n\nThe caller must have *read and write* permissions for the Apache Airflow job.\n\n## Required Delegated Scopes\n\nItem.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", "tags": [ "Items" ], @@ -565,7 +568,7 @@ "/workspaces/{workspaceId}/apacheAirflowJobs/{apacheAirflowJobId}/environment/start?beta=true": { "post": { "summary": "Starts an Apache Airflow job 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.\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\n The caller must have *execute* permissions for the Apache Airflow job. \n\n## Required Delegated Scopes\n\n Item.Execute.All\n\nSet the `beta` query parameter to `true` to call this API.\n\n**When calling this API, callers must specify `true` as the value for the query parameter `beta`.**\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.\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\nThe caller must have *read and write* permissions for the Apache Airflow job.\n\n## Required Delegated Scopes\n\nItem.ReadWrite.All\n\nSet the `beta` query parameter to `true` to call this API.\n\n**When calling this API, callers must specify `true` as the value for the query parameter `beta`.**\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": [ "Environment" ], @@ -652,7 +655,7 @@ "/workspaces/{workspaceId}/apacheAirflowJobs/{apacheAirflowJobId}/environment/stop?beta=true": { "post": { "summary": "Stops an Apache Airflow job 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.\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\n The caller must have *execute* permissions for the Apache Airflow job. \n\n## Required Delegated Scopes\n\n Item.Execute.All\n\nSet the `beta` query parameter to `true` to call this API.\n\n**When calling this API, callers must specify `true` as the value for the query parameter `beta`.**\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.\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\nThe caller must have *read and write* permissions for the Apache Airflow job.\n\n## Required Delegated Scopes\n\nItem.ReadWrite.All\n\nSet the `beta` query parameter to `true` to call this API.\n\n**When calling this API, callers must specify `true` as the value for the query parameter `beta`.**\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": [ "Environment" ], @@ -739,7 +742,7 @@ "/workspaces/{workspaceId}/apacheAirflowJobs/{apacheAirflowJobId}/environment?beta=true": { "get": { "summary": "Gets the Apache Airflow environment for the specified Apache Airflow job.", - "description": "> [!NOTE]\n> This API is part of a Beta release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\n## Permissions\n\n The caller must have *read* permissions for the Apache Airflow job. \n\n## Required Delegated Scopes\n\n Item.Read.All or Item.ReadWrite.All\n\nSet the `beta` query parameter to `true` to call this API.\n\n**When calling this API, callers must specify `true` as the value for the query parameter `beta`.**\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.\n\n## Permissions\n\nThe caller must have *read* permissions for the Apache Airflow job.\n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All\n\nSet the `beta` query parameter to `true` to call this API.\n\n**When calling this API, callers must specify `true` as the value for the query parameter `beta`.**\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": [ "Environment" ], @@ -810,7 +813,7 @@ "/workspaces/{workspaceId}/apacheAirflowJobs/{apacheAirflowJobId}/environment/libraries?beta=true": { "get": { "summary": "Returns a list of installed libraries for the specified Apache Airflow job 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.\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\n The caller must have *read* permissions for the Apache Airflow job. \n\n## Required Delegated Scopes\n\n Item.Read.All or Item.ReadWrite.All\n\nSet the `beta` query parameter to `true` to call this API.\n\n**When calling this API, callers must specify `true` as the value for the query parameter `beta`.**\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.\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\nThe caller must have *read* permissions for the Apache Airflow job.\n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All\n\nSet the `beta` query parameter to `true` to call this API.\n\n**When calling this API, callers must specify `true` as the value for the query parameter `beta`.**\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": [ "Requirements" ], @@ -891,7 +894,7 @@ "/workspaces/{workspaceId}/apacheAirflowJobs/{apacheAirflowJobId}/environment/deployRequirements?beta=true": { "post": { "summary": "Deploys requirements for an Apache Airflow job 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.\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\n The caller must have *write* permissions for the Apache Airflow job. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\nSet the `beta` query parameter to `true` to call this API.\n\n**When calling this API, callers must specify `true` as the value for the query parameter `beta`.**\n\n**You can deploy requirements by either including the `filePath` query parameter pointing to an existing requirements file, or by providing the requirements file content directly in the request body.**\n\n**When calling this API, the Apache Airflow job must be in 'Started' state.**\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.\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\nThe caller must have *read and write* permissions for the Apache Airflow job.\n\n## Required Delegated Scopes\n\nItem.ReadWrite.All\n\nSet the `beta` query parameter to `true` to call this API.\n\n**When calling this API, callers must specify `true` as the value for the query parameter `beta`.**\n\n**You can deploy requirements by either including the `filePath` query parameter pointing to an existing requirements file, or by providing the requirements file content directly in the request body.**\n\n**When calling this API, the Apache Airflow job must be in 'Started' state.**\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": [ "Requirements" ], @@ -1000,7 +1003,7 @@ "/workspaces/{workspaceId}/apacheAirflowJobs/{apacheAirflowJobId}/environment/settings?beta=true": { "get": { "summary": "Returns the environment settings for the specified Apache Airflow job.", - "description": "> [!NOTE]\n> This API is part of a Beta release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\n## Permissions\n\n The caller must have *read* permissions for the Apache Airflow job. \n\n## Required Delegated Scopes\n\n Item.Read.All or Item.ReadWrite.All\n\nSet the `beta` query parameter to `true` to call this API.\n\n**When calling this API, callers must specify `true` as the value for the query parameter `beta`.**\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.\n\n## Permissions\n\nThe caller must have *read* permissions for the Apache Airflow job.\n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All\n\nSet the `beta` query parameter to `true` to call this API.\n\n**When calling this API, callers must specify `true` as the value for the query parameter `beta`.**\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": [ "Settings" ], @@ -1071,7 +1074,7 @@ "/workspaces/{workspaceId}/apacheAirflowJobs/{apacheAirflowJobId}/environment/updateSettings?beta=true": { "post": { "summary": "Updates the settings for an Apache Airflow job 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.\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\n The caller must have *write* permissions for the Apache Airflow job. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\nSet the `beta` query parameter to `true` to call this API.\n\n**When calling this API, callers must specify `true` as the value for the query parameter `beta`.**\n\n**When updating list values (environmentVariables, airflowConfigurationOverrides), users must submit the complete set of desired values; existing values will be replaced.**\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.\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\nThe caller must have *read and write* permissions for the Apache Airflow job.\n\n## Required Delegated Scopes\n\nItem.ReadWrite.All\n\nSet the `beta` query parameter to `true` to call this API.\n\n**When calling this API, callers must specify `true` as the value for the query parameter `beta`.**\n\n**When updating list values (environmentVariables, airflowConfigurationOverrides), users must submit the complete set of desired values; existing values will be replaced.**\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": [ "Settings" ], @@ -1170,7 +1173,7 @@ "/workspaces/{workspaceId}/apacheAirflowJobs/{apacheAirflowJobId}/environment/compute?beta=true": { "get": { "summary": "Returns the compute configuration for the specified Apache Airflow job 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.\n\n## Permissions\n\n The caller must have *read* permissions for the Apache Airflow job. \n\n## Required Delegated Scopes\n\n Item.Read.All or Item.ReadWrite.All\n\nSet the `beta` query parameter to `true` to call this API.\n\n**When calling this API, callers must specify `true` as the value for the query parameter `beta`.**\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.\n\n## Permissions\n\nThe caller must have *read* permissions for the Apache Airflow job.\n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All\n\nSet the `beta` query parameter to `true` to call this API.\n\n**When calling this API, callers must specify `true` as the value for the query parameter `beta`.**\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": [ "Compute" ], @@ -1241,7 +1244,7 @@ "/workspaces/{workspaceId}/apacheAirflowJobs/{apacheAirflowJobId}/files?beta=true": { "get": { "summary": "Returns a list of Apache Airflow job files from the specified Apache Airflow job.", - "description": "> [!NOTE]\n> This API is part of a Beta release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\n The caller must have *read* permissions for the Apache Airflow job. \n\n## Required Delegated Scopes \n\n Item.Read.All or Item.ReadWrite.All\n\n## Limitations\n- Root path query parameter must start with `dags/` or `plugins/`.\n- Listing files is not recursive; only the specified folder is returned.\n- Set the `beta` query parameter to `true` to call this API.\n\n**When calling this API, callers must specify `true` as the value for the query parameter `beta`.**\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.\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\nThe caller must have *read* permissions for the Apache Airflow job.\n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All\n\n## Limitations\n- Root path query parameter must start with `dags/` or `plugins/`.\n- Listing files is not recursive; only the specified folder is returned.\n- Set the `beta` query parameter to `true` to call this API.\n\n**When calling this API, callers must specify `true` as the value for the query parameter `beta`.**\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": [ "Files" ], @@ -1329,7 +1332,7 @@ "/workspaces/{workspaceId}/apacheAirflowJobs/{apacheAirflowJobId}/files/{filePath}?beta=true": { "get": { "summary": "Returns the specified Apache Airflow job file.", - "description": "> [!NOTE]\n> This API is part of a Beta release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\n## Permissions\n\n The caller must have *read* permissions for the Apache Airflow job. \n\n## Required Delegated Scopes\n\n Item.Read.All or Item.ReadWrite.All\n\n## Limitations\n- Files must be located within the `dags/` or `plugins/` folders.\n- The maximum supported file size is 2 MB.\n- Text files are returned using UTF-8 encoding; binary files are returned as-is.\n- Set the `beta` query parameter to `true` to call this API.\n\n**When calling this API, callers must specify `true` as the value for the query parameter `beta`.**\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.\n\n## Permissions\n\nThe caller must have *read* permissions for the Apache Airflow job.\n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All\n\n## Limitations\n- Files must be located within the `dags/` or `plugins/` folders.\n- The maximum supported file size is 2 MB.\n- Text files are returned using UTF-8 encoding; binary files are returned as-is.\n- Set the `beta` query parameter to `true` to call this API.\n\n**When calling this API, callers must specify `true` as the value for the query parameter `beta`.**\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": [ "Files" ], @@ -1406,7 +1409,7 @@ }, "put": { "summary": "Creates or updates an Apache Airflow job file.", - "description": "> [!NOTE]\n> This API is part of a Beta release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\n## Permissions\n\n The caller must have *write* permissions for the Apache Airflow job. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Limitations\n- Files must be located within the `dags/` or `plugins/` folders.\n- The maximum supported file size is 2 MB.\n- Supported file types include binary files (sent as-is) and UTF-8 encoded text files such as Python, YAML, XML, JSON, and SQL.\n- Set the `beta` query parameter to `true` to call this API.\n\n**When calling this API, callers must specify `true` as the value for the query parameter `beta`.**\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.\n\n## Permissions\n\nThe caller must have *read and write* permissions for the Apache Airflow job.\n\n## Required Delegated Scopes\n\nItem.ReadWrite.All\n\n## Limitations\n- Files must be located within the `dags/` or `plugins/` folders.\n- The maximum supported file size is 2 MB.\n- Supported file types include binary files (sent as-is) and UTF-8 encoded text files such as Python, YAML, XML, JSON, and SQL.\n- Set the `beta` query parameter to `true` to call this API.\n\n**When calling this API, callers must specify `true` as the value for the query parameter `beta`.**\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": [ "Files" ], @@ -1495,7 +1498,7 @@ }, "delete": { "summary": "Deletes the specified Apache Airflow job file.", - "description": "> [!NOTE]\n> This API is part of a Beta release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\n## Permissions\n\n The caller must have *write* permissions for the Apache Airflow job. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Limitations\n- Files must be located within the `dags/` or `plugins/` folders.\n- Set the `beta` query parameter to `true` to call this API.\n\n**When calling this API, callers must specify `true` as the value for the query parameter `beta`.**\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.\n\n## Permissions\n\nThe caller must have *read and write* permissions for the Apache Airflow job.\n\n## Required Delegated Scopes\n\nItem.ReadWrite.All\n\n## Limitations\n- Files must be located within the `dags/` or `plugins/` folders.\n- Set the `beta` query parameter to `true` to call this API.\n\n**When calling this API, callers must specify `true` as the value for the query parameter `beta`.**\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": [ "Files" ], @@ -1573,7 +1576,7 @@ "WorkspaceSettings" ], "summary": "Get Apache Airflow workspace settings.", - "description": "> [!NOTE]\n> This API is part of a Beta release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\n## Permissions\n\nThe caller must have *viewer* or higher workspace role. \n\n## Required Delegated Scopes \n\nWorkspace.Read.All or Workspace.ReadWrite.All\n\n**When calling this API, callers must specify `true` as the value for the query parameter `beta`.**\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.\n\n## Permissions\n\nThe caller must have *viewer* or higher workspace role.\n\n## Required Delegated Scopes\n\nWorkspace.Read.All or Workspace.ReadWrite.All\n\n**When calling this API, callers must specify `true` as the value for the query parameter `beta`.**\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": "WorkspaceSettings_Get_Airflow_Workspace_Settings_(beta)", "produces": [ "application/json" @@ -1634,7 +1637,7 @@ "WorkspaceSettings" ], "summary": "Update Apache Airflow workspace settings.", - "description": "> [!NOTE]\n> This API is part of a Beta release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\n## Permissions\n\nThe caller must have *admin* workspace role.\n\n## Required Delegated Scopes \n\nWorkspace.ReadWrite.All\n\n**When calling this API, callers must specify `true` as the value for the query parameter `beta`.**\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.\n\n## Permissions\n\nThe caller must have *admin* workspace role.\n\n## Required Delegated Scopes\n\nWorkspace.ReadWrite.All\n\n**When calling this API, callers must specify `true` as the value for the query parameter `beta`.**\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": "WorkspaceSettings_Update_Airflow_Workspace_Settings_(beta)", "consumes": [ "application/json" @@ -1709,7 +1712,7 @@ "PoolManagement" ], "summary": "List Apache Airflow pool templates.", - "description": "> [!NOTE]\n> This API is part of a Beta release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\nThe caller must have *viewer* or higher workspace role. \n\n## Required Delegated Scopes \n\nWorkspace.Read.All or Workspace.ReadWrite.All\n\n**When calling this API, callers must specify `true` as the value for the query parameter `beta`.**\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.\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\nThe caller must have *viewer* or higher workspace role.\n\n## Required Delegated Scopes\n\nWorkspace.Read.All or Workspace.ReadWrite.All\n\n**When calling this API, callers must specify `true` as the value for the query parameter `beta`.**\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": "PoolManagement_List_Airflow_Pool_Templates_(beta)", "x-ms-pageable": { "nextLinkName": "continuationUri", @@ -1781,7 +1784,7 @@ "PoolManagement" ], "summary": "Create an Apache Airflow pool template.", - "description": "> [!NOTE]\n> This API is part of a Beta release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\n## Permissions\n\nThe caller must have *admin* workspace role.\n\n## Required Delegated Scopes \n\nWorkspace.ReadWrite.All\n\n**When calling this API, callers must specify `true` as the value for the query parameter `beta`.**\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.\n\n## Permissions\n\nThe caller must have *admin* workspace role.\n\n## Required Delegated Scopes\n\nWorkspace.ReadWrite.All\n\n**When calling this API, callers must specify `true` as the value for the query parameter `beta`.**\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": "PoolManagement_Create_Airflow_Pool_Template_(beta)", "consumes": [ "application/json" @@ -1862,7 +1865,7 @@ "PoolManagement" ], "summary": "Get an Apache Airflow pool template.", - "description": "> [!NOTE]\n> This API is part of a Beta release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\n## Permissions\n\nThe caller must have *viewer* or higher workspace role. \n\n## Required Delegated Scopes \n\nWorkspace.Read.All or Workspace.ReadWrite.All\n\n**When calling this API, callers must specify `true` as the value for the query parameter `beta`.**\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.\n\n## Permissions\n\nThe caller must have *viewer* or higher workspace role.\n\n## Required Delegated Scopes\n\nWorkspace.Read.All or Workspace.ReadWrite.All\n\n**When calling this API, callers must specify `true` as the value for the query parameter `beta`.**\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": "PoolManagement_Get_Airflow_Pool_Template_(beta)", "produces": [ "application/json" @@ -1931,7 +1934,7 @@ "PoolManagement" ], "summary": "Delete an Apache Airflow pool template.", - "description": "> [!NOTE]\n> This API is part of a Beta release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\nDeleting the default pool template will reset the workspace back to the starter pool.\n\n## Permissions\n\nThe caller must have *admin* workspace role. \n\n## Required Delegated Scopes \n\nWorkspace.ReadWrite.All\n\n**When calling this API, callers must specify `true` as the value for the query parameter `beta`.**\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.\n\nDeleting the default pool template will reset the workspace back to the starter pool.\n\n## Permissions\n\nThe caller must have *admin* workspace role.\n\n## Required Delegated Scopes\n\nWorkspace.ReadWrite.All\n\n**When calling this API, callers must specify `true` as the value for the query parameter `beta`.**\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": "PoolManagement_Delete_Airflow_Pool_Template_(beta)", "produces": [ "application/json" diff --git a/appBackend/definitions.json b/appBackend/definitions.json new file mode 100644 index 0000000..69a264c --- /dev/null +++ b/appBackend/definitions.json @@ -0,0 +1,81 @@ +{ + "swagger": "2.0", + "info": { + "title": "AppBackend data types", + "version": "v1" + }, + "paths": {}, + "definitions": { + "AppBackend": { + "description": "An AppBackend object.", + "type": "object", + "required": ["type"], + "allOf": [ + { + "$ref": "../common/definitions.json#/definitions/Item" + } + ] + }, + "AppBackends": { + "description": "A list of AppBackends.", + "required": ["value"], + "type": "object", + "properties": { + "value": { + "description": "A list of AppBackends.", + "type": "array", + "items": { + "$ref": "#/definitions/AppBackend" + } + } + }, + "allOf": [ + { + "$ref": "../common/definitions.json#/definitions/PaginatedResponse" + } + ] + }, + "CreateAppBackendRequest": { + "description": "Create an AppBackend request payload.", + "required": ["displayName"], + "properties": { + "displayName": { + "description": "The AppBackend display name. The name can't exceed 91 characters, can't use special characters (< > * % & : \\ / ? # ! [ ] = @ ^ \" ' ; ( ) `), can't end with a period or space, and can't be a reserved name (master, msdb, model, tempdb, resource).", + "type": "string", + "readOnly": false + }, + "description": { + "description": "The AppBackend description. Maximum length is 256 characters.", + "type": "string", + "readOnly": false + }, + "folderId": { + "description": "The folder ID. If not specified or null, the AppBackend is created with the workspace as its folder.", + "type": "string", + "format": "uuid", + "readOnly": false + }, + "sensitivityLabelSettings": { + "description": "The sensitivity label settings for the AppBackend.", + "$ref": "../common/definitions.json#/definitions/SensitivityLabelSettings", + "readOnly": false + } + } + }, + "UpdateAppBackendRequest": { + "description": "The update AppBackend request payload.", + "properties": { + "displayName": { + "description": "The AppBackend display name. The name can't exceed 91 characters, can't use special characters (< > * % & : \\ / ? # ! [ ] = @ ^ \" ' ; ( ) `), can't end with a period or space, and can't be a reserved name (master, msdb, model, tempdb, resource).", + "type": "string", + "readOnly": false + }, + "description": { + "description": "The AppBackend description. Maximum length is 256 characters.", + "type": "string", + "readOnly": false + } + } + } + } +} diff --git a/appBackend/examples/CreateAppBackendWithoutDefinition.json b/appBackend/examples/CreateAppBackendWithoutDefinition.json new file mode 100644 index 0000000..c462162 --- /dev/null +++ b/appBackend/examples/CreateAppBackendWithoutDefinition.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229", + "createAppBackendRequest": { + "displayName": "AppBackend 1", + "description": "An AppBackend description." + } + }, + "responses": { + "201": { + "body": { + "displayName": "AppBackend 1", + "description": "An AppBackend description.", + "type": "AppBackend", + "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229", + "id": "5b218778-e7a5-4d73-8187-f10824047715" + } + }, + "202": { + "headers": { + "Location": "https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6", + "x-ms-operation-id": "0acd697c-1550-43cd-b998-91bfbfbd47c6", + "Retry-After": 30 + } + } + } +} diff --git a/appBackend/examples/DeleteAppBackend.json b/appBackend/examples/DeleteAppBackend.json new file mode 100644 index 0000000..2f8e24b --- /dev/null +++ b/appBackend/examples/DeleteAppBackend.json @@ -0,0 +1,9 @@ +{ + "parameters": { + "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229", + "appBackendId": "5b218778-e7a5-4d73-8187-f10824047715" + }, + "responses": { + "200": {} + } +} diff --git a/appBackend/examples/GetAppBackend.json b/appBackend/examples/GetAppBackend.json new file mode 100644 index 0000000..b1a6ad6 --- /dev/null +++ b/appBackend/examples/GetAppBackend.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48", + "appBackendId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87" + }, + "responses": { + "200": { + "body": { + "id": "5b218778-e7a5-4d73-8187-f10824047715", + "displayName": "AppBackend 1", + "description": "An AppBackend description.", + "type": "AppBackend", + "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229" + } + } + } +} diff --git a/appBackend/examples/ListAppBackendsInWorkspace.json b/appBackend/examples/ListAppBackendsInWorkspace.json new file mode 100644 index 0000000..fb8c18e --- /dev/null +++ b/appBackend/examples/ListAppBackendsInWorkspace.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "3546052c-ae64-4526-b1a8-52af7761426f", + "displayName": "AppBackend Name 1", + "description": "An AppBackend description.", + "type": "AppBackend", + "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229" + }, + { + "id": "f697fb63-abd4-4399-9548-be7e3c3c0dac", + "displayName": "AppBackend Name 2", + "description": "An AppBackend description.", + "type": "AppBackend", + "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229" + } + ] + } + } + } +} diff --git a/appBackend/examples/UpdateAppBackend.json b/appBackend/examples/UpdateAppBackend.json new file mode 100644 index 0000000..78c9cbc --- /dev/null +++ b/appBackend/examples/UpdateAppBackend.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229", + "appBackendId": "5b218778-e7a5-4d73-8187-f10824047715", + "updateAppBackendRequest": { + "displayName": "AppBackend's New name", + "description": "AppBackend's New description" + } + }, + "responses": { + "200": { + "body": { + "displayName": "AppBackend's New name", + "description": "AppBackend's New description", + "type": "AppBackend", + "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229", + "id": "5b218778-e7a5-4d73-8187-f10824047715" + } + } + } +} diff --git a/appBackend/swagger.json b/appBackend/swagger.json new file mode 100644 index 0000000..5743fe2 --- /dev/null +++ b/appBackend/swagger.json @@ -0,0 +1,375 @@ +{ + "swagger": "2.0", + "info": { + "title": "AppBackend REST APIs", + "version": "v1" + }, + "schemes": [ + "https" + ], + "host": "api.fabric.microsoft.com", + "basePath": "/v1", + "paths": { + "/workspaces/{workspaceId}/appBackends": { + "get": { + "summary": "List AppBackends in the specified workspace.", + "description": "> [!NOTE]\n> The AppBackend item is currently in preview ([learn more](/fabric/fundamentals/preview)).\n\nLists AppBackends in the specified workspace.\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\n The caller must have a *viewer* workspace role. \n\n## Required Delegated Scopes\n\n Workspace.Read.All or Workspace.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "tags": [ + "Items" + ], + "operationId": "Items_ListAppBackends", + "x-ms-pageable": { + "nextLinkName": "continuationUri" + }, + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "description": "The workspace ID.", + "type": "string", + "format": "uuid", + "required": true + }, + { + "in": "query", + "name": "recursive", + "description": "Indicates whether to list items recursively. If `true`, lists items in the folder and all nested folders. If `false`, lists only the items directly within the folder. Default is `true`.", + "type": "boolean", + "required": false + }, + { + "in": "query", + "name": "rootFolderId", + "description": "This parameter allows users to filter items based on a specific root folder. If not provided, the workspace is used as the root folder.", + "type": "string", + "format": "uuid", + "required": false + }, + { + "in": "query", + "name": "continuationToken", + "description": "A token for retrieving the next page of results.", + "type": "string", + "required": false + } + ], + "responses": { + "200": { + "description": "Request completed successfully.", + "schema": { + "$ref": "./definitions.json#/definitions/AppBackends" + } + }, + "429": { + "description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.", + "x-ms-error-response": true, + "headers": { + "Retry-After": { + "type": "integer", + "description": "The number of seconds to wait before retrying the request." + } + }, + "schema": { + "$ref": "../common/definitions.json#/definitions/ErrorResponse" + } + }, + "default": { + "description": "Common error codes:\n\n* InvalidItemType - Invalid item type.", + "schema": { + "$ref": "../common/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List AppBackends in workspace example": { + "$ref": "./examples/ListAppBackendsInWorkspace.json" + } + } + }, + "post": { + "summary": "Create an AppBackend in the specified workspace.", + "description": "> [!NOTE]\n> The AppBackend item is currently in preview ([learn more](/fabric/fundamentals/preview)).\n\nCreates an AppBackend in the specified workspace.\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n ## Permissions \n The caller must have a *contributor* workspace role. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Limitations\n- To create an AppBackend, the workspace must be on a supported Fabric capacity. For more information, see: [Microsoft Fabric license types](/fabric/enterprise/licenses#microsoft-fabric-license-types).\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "tags": [ + "Items" + ], + "operationId": "Items_CreateAppBackend", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-fabric-sdk-long-running-operation": true, + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "description": "The workspace ID.", + "type": "string", + "format": "uuid", + "required": true + }, + { + "in": "body", + "name": "createAppBackendRequest", + "description": "Create AppBackend request payload.", + "schema": { + "$ref": "./definitions.json#/definitions/CreateAppBackendRequest" + }, + "required": true + } + ], + "responses": { + "201": { + "description": "Successfully created.", + "schema": { + "$ref": "./definitions.json#/definitions/AppBackend" + } + }, + "202": { + "description": "Request accepted, AppBackend provisioning in progress.", + "headers": { + "Location": { + "description": "The URL of the operation status, which can be used to track the operation state.", + "type": "string" + }, + "x-ms-operation-id": { + "description": "The operation ID which can be used with long running operations (LRO) APIs to track the operation state and get the result.", + "type": "string", + "format": "uuid" + }, + "Retry-After": { + "type": "integer", + "description": "The number of seconds to wait before retrying the request." + } + } + }, + "429": { + "description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.", + "x-ms-error-response": true, + "headers": { + "Retry-After": { + "type": "integer", + "description": "The number of seconds to wait before retrying the request." + } + }, + "schema": { + "$ref": "../common/definitions.json#/definitions/ErrorResponse" + } + }, + "default": { + "description": "Common error codes:\n\n* InvalidItemType - Item type is invalid.\n\n* ItemDisplayNameAlreadyInUse - Item display name is already used.\n\n* CorruptedPayload - The provided payload is corrupted.\n\n* WorkspaceItemsLimitExceeded - Workspace item limit exceeded.", + "schema": { + "$ref": "../common/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create an AppBackend example": { + "$ref": "./examples/CreateAppBackendWithoutDefinition.json" + } + } + } + }, + "/workspaces/{workspaceId}/appBackends/{appBackendId}": { + "get": { + "summary": "Get the specified AppBackend.", + "description": "> [!NOTE]\n> The AppBackend item is currently in preview ([learn more](/fabric/fundamentals/preview)).\n\nReturns properties of the specified AppBackend.\n\n## Permissions\n\n The caller must have *read* permissions for the AppBackend. \n\n## Required Delegated Scopes\n\n Item.Read.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "tags": [ + "Items" + ], + "operationId": "Items_GetAppBackend", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "description": "The workspace ID.", + "type": "string", + "format": "uuid", + "required": true + }, + { + "in": "path", + "name": "appBackendId", + "description": "The AppBackend ID.", + "type": "string", + "format": "uuid", + "required": true + } + ], + "responses": { + "200": { + "description": "Request completed successfully.", + "schema": { + "$ref": "./definitions.json#/definitions/AppBackend" + } + }, + "429": { + "description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.", + "x-ms-error-response": true, + "headers": { + "Retry-After": { + "type": "integer", + "description": "The number of seconds to wait before retrying the request." + } + }, + "schema": { + "$ref": "../common/definitions.json#/definitions/ErrorResponse" + } + }, + "default": { + "description": "Common error codes:\n\n* ItemNotFound - The requested item was not found.", + "schema": { + "$ref": "../common/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get an AppBackend example": { + "$ref": "./examples/GetAppBackend.json" + } + } + }, + "patch": { + "summary": "Update the specified AppBackend.", + "description": "> [!NOTE]\n> The AppBackend item is currently in preview ([learn more](/fabric/fundamentals/preview)).\n\nUpdates the properties of the specified AppBackend.\n\n## Permissions\n\n The caller must have *read and write* permissions for the AppBackend.\n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "tags": [ + "Items" + ], + "operationId": "Items_UpdateAppBackend", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "description": "The workspace ID.", + "type": "string", + "format": "uuid", + "required": true + }, + { + "in": "path", + "name": "appBackendId", + "description": "The AppBackend ID.", + "type": "string", + "format": "uuid", + "required": true + }, + { + "in": "body", + "name": "updateAppBackendRequest", + "description": "Update AppBackend request payload.", + "schema": { + "$ref": "./definitions.json#/definitions/UpdateAppBackendRequest" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "Request completed successfully.", + "schema": { + "$ref": "./definitions.json#/definitions/AppBackend" + } + }, + "429": { + "description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.", + "x-ms-error-response": true, + "headers": { + "Retry-After": { + "type": "integer", + "description": "The number of seconds to wait before retrying the request." + } + }, + "schema": { + "$ref": "../common/definitions.json#/definitions/ErrorResponse" + } + }, + "default": { + "description": "Common error codes:\n\n* ItemNotFound - The requested item was not found. \n\n* InvalidRequest - Invalid update request.", + "schema": { + "$ref": "../common/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update an AppBackend example": { + "$ref": "./examples/UpdateAppBackend.json" + } + } + }, + "delete": { + "summary": "Delete the specified AppBackend.", + "description": "> [!NOTE]\n> The AppBackend item is currently in preview ([learn more](/fabric/fundamentals/preview)).\n\n## Permissions\n\n The caller must have *write* permissions for the AppBackend. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "tags": [ + "Items" + ], + "operationId": "Items_DeleteAppBackend", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "description": "The workspace ID.", + "type": "string", + "format": "uuid", + "required": true + }, + { + "in": "path", + "name": "appBackendId", + "description": "The AppBackend ID.", + "type": "string", + "format": "uuid", + "required": true + } + ], + "responses": { + "200": { + "description": "Request completed successfully." + }, + "429": { + "description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.", + "x-ms-error-response": true, + "headers": { + "Retry-After": { + "type": "integer", + "description": "The number of seconds to wait before retrying the request." + } + }, + "schema": { + "$ref": "../common/definitions.json#/definitions/ErrorResponse" + } + }, + "default": { + "description": "Common error codes:\n\n* ItemNotFound - The requested item was not found.", + "schema": { + "$ref": "../common/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete an AppBackend example": { + "$ref": "./examples/DeleteAppBackend.json" + } + } + } + } + }, + "responses": {}, + "security": [], + "tags": [] +} diff --git a/common/definitions.json b/common/definitions.json index d3e4a8f..6939176 100644 --- a/common/definitions.json +++ b/common/definitions.json @@ -263,7 +263,7 @@ "ItemType": { "description": "The type of the item. Additional item types may be added over time.", "type": "string", - "enum": [ "Dashboard", "Report", "SemanticModel", "PaginatedReport", "Datamart", "Lakehouse", "Eventhouse", "Environment", "KQLDatabase", "KQLQueryset", "KQLDashboard", "DataPipeline", "Notebook", "SparkJobDefinition", "MLExperiment", "MLModel", "Warehouse", "Eventstream", "SQLEndpoint", "MirroredWarehouse", "MirroredDatabase", "Reflex", "GraphQLApi", "MountedDataFactory", "SQLDatabase", "CopyJob", "VariableLibrary", "Dataflow", "ApacheAirflowJob", "WarehouseSnapshot", "DigitalTwinBuilder", "DigitalTwinBuilderFlow", "MirroredAzureDatabricksCatalog", "Map", "AnomalyDetector", "UserDataFunction", "GraphModel", "GraphQuerySet", "SnowflakeDatabase", "OperationsAgent", "CosmosDBDatabase", "Ontology", "EventSchemaSet", "DataAgent", "MirroredCatalog" ], + "enum": [ "Dashboard", "Report", "SemanticModel", "PaginatedReport", "Datamart", "Lakehouse", "Eventhouse", "Environment", "KQLDatabase", "KQLQueryset", "KQLDashboard", "DataPipeline", "Notebook", "SparkJobDefinition", "MLExperiment", "MLModel", "Warehouse", "Eventstream", "SQLEndpoint", "MirroredWarehouse", "MirroredDatabase", "Reflex", "GraphQLApi", "MountedDataFactory", "SQLDatabase", "CopyJob", "VariableLibrary", "Dataflow", "ApacheAirflowJob", "WarehouseSnapshot", "DigitalTwinBuilder", "DigitalTwinBuilderFlow", "MirroredAzureDatabricksCatalog", "Map", "AnomalyDetector", "UserDataFunction", "GraphModel", "GraphQuerySet", "SnowflakeDatabase", "OperationsAgent", "CosmosDBDatabase", "Ontology", "EventSchemaSet", "DataAgent", "MirroredCatalog", "AppBackend" ], "x-ms-enum": { "name": "ItemType", "modelAsString": true, @@ -447,6 +447,10 @@ { "value": "MirroredCatalog", "description": "A MirroredCatalog." + }, + { + "value": "AppBackend", + "description": "An AppBackend." } ] }, @@ -1218,3 +1222,4 @@ } } } + diff --git a/cosmosDbDatabase/definitions.json b/cosmosDbDatabase/definitions.json index 09ddd20..ef7be93 100644 --- a/cosmosDbDatabase/definitions.json +++ b/cosmosDbDatabase/definitions.json @@ -14,7 +14,13 @@ { "$ref": "../common/definitions.json#/definitions/Item" } - ] + ], + "properties": { + "properties": { + "description": "The CosmosDBDatabase properties.", + "$ref": "#/definitions/CosmosDBDatabaseProperties" + } + } }, "CosmosDBDatabases": { "description": "A list of Cosmos DB databases.", @@ -34,6 +40,21 @@ "$ref": "../common/definitions.json#/definitions/PaginatedResponse" } ] + }, + "CosmosDBDatabaseProperties": { + "required": ["serverFqdn", "databaseName"], + "description": "The Cosmos DB database properties.", + "type": "object", + "properties": { + "serverFqdn": { + "description": "The Cosmos DB database server fully qualified domain name (FQDN).", + "type": "string" + }, + "databaseName": { + "description": "The name of the Cosmos DB database, automatically set from the display name during creation. This property is read-only and cannot be changed.", + "type": "string" + } + } }, "CreateCosmosDBDatabaseRequest": { "description": "Create Cosmos DB database request payload.", diff --git a/cosmosDbDatabase/examples/GetCosmosDBDatabase.json b/cosmosDbDatabase/examples/GetCosmosDBDatabase.json index d971654..67b6a1e 100644 --- a/cosmosDbDatabase/examples/GetCosmosDBDatabase.json +++ b/cosmosDbDatabase/examples/GetCosmosDBDatabase.json @@ -11,6 +11,10 @@ "description": "A Cosmos DB Database description.", "type": "CosmosDBDatabase", "workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48", + "properties": { + "serverFqdn": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87.xyz.cosmos.fabric.microsoft.com", + "databaseName": "Cosmos DB Database 1" + }, "sensitivityLabel": { "id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f" } diff --git a/cosmosDbDatabase/examples/ListCosmosDBDatabasesInWorkspace.json b/cosmosDbDatabase/examples/ListCosmosDBDatabasesInWorkspace.json index 85c7a8a..91628c0 100644 --- a/cosmosDbDatabase/examples/ListCosmosDBDatabasesInWorkspace.json +++ b/cosmosDbDatabase/examples/ListCosmosDBDatabasesInWorkspace.json @@ -12,6 +12,10 @@ "description": "A Cosmos DB Database description.", "type": "CosmosDBDatabase", "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229", + "properties": { + "serverFqdn": "3546052c-ae64-4526-b1a8-52af7761426f.xyz.cosmos.fabric.microsoft.com", + "databaseName": "Cosmos DB Database Name 1" + }, "sensitivityLabel": { "id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f" } @@ -22,6 +26,10 @@ "description": "A Cosmos DB Database description.", "type": "CosmosDBDatabase", "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229", + "properties": { + "serverFqdn": "3546052c-ae64-4526-b1a8-52af7761426f.xyz.cosmos.fabric.microsoft.com", + "databaseName": "Cosmos DB Database Name 2" + }, "sensitivityLabel": { "id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f" } @@ -30,4 +38,4 @@ } } } -} \ No newline at end of file +} diff --git a/platform/swagger.json b/platform/swagger.json index ff95873..0231988 100644 --- a/platform/swagger.json +++ b/platform/swagger.json @@ -7732,7 +7732,7 @@ "/workspaces/{workspaceId}/managedPrivateEndpoints": { "get": { "summary": "Returns a list of managed private endpoints associated with the specified workspace.", - "description": "> [!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\n## Permissions\n\n The caller must have *viewer* or higher workspace role. \n\n## Required Delegated Scopes\n\nWorkspace.Read.All or Workspace.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "description": "## Permissions\n\n The caller must have *viewer* or higher workspace role. \n\n## Required Delegated Scopes\n\nWorkspace.Read.All or Workspace.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", "tags": [ "ManagedPrivateEndpoints" ], @@ -7798,7 +7798,7 @@ }, "post": { "summary": "Creates a managed private endpoint in the specified workspace.", - "description": "> [!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\n## Permissions\n\nThe caller must have *admin* workspace role.\n\n## Required Delegated Scopes \n\nWorkspace.ReadWrite.All.\n\n## Limitations \n- To create managed private endpoint the workspace must be on a supported Fabric capacity. For more information see: [Microsoft Fabric license types](/fabric/enterprise/licenses#microsoft-fabric-license-types).\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "description": "## Permissions\n\nThe caller must have *admin* workspace role.\n\n## Required Delegated Scopes \n\nWorkspace.ReadWrite.All.\n\n## Limitations \n- To create managed private endpoint the workspace must be on a supported Fabric capacity. For more information see: [Microsoft Fabric license types](/fabric/enterprise/licenses#microsoft-fabric-license-types).\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", "tags": [ "ManagedPrivateEndpoints" ], @@ -7871,7 +7871,7 @@ "/workspaces/{workspaceId}/managedPrivateEndpoints/{managedPrivateEndpointId}": { "delete": { "summary": "Deletes the specified managed private endpoint.", - "description": "> [!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\n## Permissions\n\nThe caller must have *admin* workspace role.\n\n## Required Delegated Scopes \n\nWorkspace.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "description": "## Permissions\n\nThe caller must have *admin* workspace role.\n\n## Required Delegated Scopes \n\nWorkspace.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", "tags": [ "ManagedPrivateEndpoints" ], @@ -7929,7 +7929,7 @@ }, "get": { "summary": "Gets the specified managed private endpoint.", - "description": "> [!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\n## Permissions\n\nThe caller must have *viewer* or higher workspace role. \n\n## Required Delegated Scopes \n\nWorkspace.Read.All or Workspace.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "description": "## Permissions\n\nThe caller must have *viewer* or higher workspace role. \n\n## Required Delegated Scopes \n\nWorkspace.Read.All or Workspace.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", "tags": [ "ManagedPrivateEndpoints" ],