Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
changes:
- section: "Other Changes"
description: "Updated Fabric REST API specifications and item definition documentation."
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,11 @@
"$ref": "../common/definitions.json#/definitions/WorkspaceAppliedTag"
},
"readOnly": true
},
"encryption": {
"description": "The encryption details of the workspace.",
"$ref": "../platform/definitions/workspaceCmk.json#/definitions/Encryption",
"readOnly": true
}
}
},
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
{
"parameters": {
"include": "encryption"
},
"responses": {
"200": {
"body": {
"workspaces": [
{
"id": "abf49964-6f70-4aea-a66c-4b78a22e3ddc",
"name": "Contoso Workspace 1",
"type": "Workspace",
"state": "Active",
"capacityId": "61d6811f-7544-4e75-a1e6-1c59c0383312",
"domainId": "039bd896-b39c-4540-93e3-e9926de135f9",
"encryption": {
"status": "Disabled"
}
},
{
"id": "9c7f06cc-e850-4961-b2bd-181a70b1a784",
"name": "Contoso Workspace 2",
"type": "Workspace",
"state": "Active",
"capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84",
"domainId": "039bd896-b39c-4540-93e3-e9926de135f9",
"encryption": {
"status": "Disabled"
}
},
{
"id": "90119767-07b4-4657-82ee-53e90fece225",
"name": "Contoso Workspace 3",
"type": "Workspace",
"state": "Active",
"capacityId": "61d6811f-7544-4e75-a1e6-1c59c0383312",
"domainId": "039bd896-b39c-4540-93e3-e9926de135f9",
"encryption": {
"status": "Active",
"keyIdentifier": "https://westus07112025-cmktest1.vault.azure.net/keys/test2k/"
}
},
{
"id": "adaa3051-b1de-41ed-b1b4-d5e08887c1e9",
"name": "Contoso Workspace 4",
"type": "Workspace",
"state": "Active",
"capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84",
"domainId": "039bd896-b39c-4540-93e3-e9926de135f9",
"encryption": {
"status": "EnableInProgress",
"keyIdentifier": "https://westus07112025-cmktest1.vault.azure.net/keys/test2k/",
"previousStatus": "Active",
"previousKeyIdentifier": "https://westus07112025-cmktest1.vault.azure.net/keys/test4k/"
}
}
],
"continuationUri": "https://api.fabric.microsoft.com/v1/admin/workspaces?continuationToken='LDEsMTAwMDAwLDA%3D'",
"continuationToken": "LDEsMTAwMDAwLDA%3D"
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
{
"parameters": {
"include": "encryption",
"capacityId": "61d6811f-7544-4e75-a1e6-1c59c0383312",
"encryptionStatus": "Active"
},
"responses": {
"200": {
"body": {
"workspaces": [
{
"id": "90119767-07b4-4657-82ee-53e90fece225",
"name": "Contoso Workspace 3",
"type": "Workspace",
"state": "Active",
"capacityId": "61d6811f-7544-4e75-a1e6-1c59c0383312",
"domainId": "039bd896-b39c-4540-93e3-e9926de135f9",
"encryption": {
"status": "Active",
"keyIdentifier": "https://westus07112025-cmktest1.vault.azure.net/keys/test2k/"
}
}
],
"continuationUri": "https://api.fabric.microsoft.com/v1/admin/workspaces?continuationToken='LDEsMTAwMDAwLDA%3D'",
"continuationToken": "LDEsMTAwMDAwLDA%3D"
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
{
"parameters": {
"capacityId": "61d6811f-7544-4e75-a1e6-1c59c0383312",
"encryptionStatus": "Active"
},
"responses": {
"200": {
"body": {
"workspaces": [
{
"id": "abf49964-6f70-4aea-a66c-4b78a22e3ddc",
"name": "Contoso Workspace 1",
"type": "Workspace",
"state": "Active",
"capacityId": "61d6811f-7544-4e75-a1e6-1c59c0383312",
"domainId": "039bd896-b39c-4540-93e3-e9926de135f9"
},
{
"id": "90119767-07b4-4657-82ee-53e90fece225",
"name": "Contoso Workspace 3",
"type": "Workspace",
"state": "Active",
"capacityId": "61d6811f-7544-4e75-a1e6-1c59c0383312",
"domainId": "039bd896-b39c-4540-93e3-e9926de135f9"
}
],
"continuationUri": "https://api.fabric.microsoft.com/v1/admin/workspaces?continuationToken='LDEsMTAwMDAwLDA%3D'",
"continuationToken": "LDEsMTAwMDAwLDA%3D"
}
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -504,7 +504,7 @@
"/workspaces": {
"get": {
"summary": "Returns a list of workspaces.",
"description": "> [!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination). A maximum of 10,000 records can be returned per request. With the continuous token provided in the response, you can get the next 10,000 records.\n\n## Permissions\n\nThe caller must be a Fabric administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All\n\n## Limitations\n\nMaximum 200 requests per hour.\n\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 Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination). A maximum of 10,000 records can be returned per request. With the continuation token provided in the response, you can get the next 10,000 records.\n\n## Permissions\n\nThe caller must be a Fabric administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All\n\n## Limitations\n\nMaximum 200 requests per hour.\n\nThe `encryptionStatus` filter is applied only when the `include` parameter contains `encryption`.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"tags": [
"Workspaces"
],
Expand Down Expand Up @@ -552,6 +552,20 @@
"description": "Continuation token. Used to get the next items in the list.",
"type": "string",
"required": false
},
{
"in": "query",
"name": "encryptionStatus",
"description": "Indicates the CMK encryption status of the workspace and is used to filter workspaces that match the specified status.",
"type": "string",
"required": false
},
{
"in": "query",
"name": "include",
"description": "Specifies additional data to include for each workspace in the response. Supported values: `encryption`.",
"type": "string",
"required": false
}
],
"responses": {
Expand Down Expand Up @@ -587,6 +601,15 @@
},
"Get a list of workspaces using state query parameter example": {
"$ref": "./examples/ListWorkspacesByState.json"
},
"List workspaces with encryption details": {
"$ref": "./examples/ListWorkspacesWithEncryption.json"
},
"List workspaces with active encryption status in a given capacity": {
"$ref": "./examples/ListWorkspacesWithEncryptionAndCapacity.json"
},
"List workspaces for a given capacity, ignoring the encryptionStatus filter.": {
"$ref": "./examples/ListWorkspacesWithoutEncryptionAndCapacity.json"
}
}
}
Expand Down Expand Up @@ -1256,7 +1279,7 @@
{
"in": "query",
"name": "nonEmptyOnly",
"description": "When true, only return domains that have at least one workspace containing an item. Default: false.",
"description": "When true, only return domains with workspaces assigned that contain one or more items the user has at least read access to. Default: false.",
"type": "boolean",
"required": false
},
Expand Down Expand Up @@ -1381,7 +1404,7 @@
{
"in": "query",
"name": "nonEmptyOnly",
"description": "When true, only return domains that have at least one workspace containing an item. Default: false.",
"description": "When true, only return domains with workspaces assigned that contain one or more items the user has at least read access to. Default: false.",
"type": "boolean",
"required": false
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -575,6 +575,20 @@
}
}
},
"AirflowEnvironmentComputeRequest": {
"description": "The request payload for updating Apache Airflow environment compute configuration.",
"type": "object",
"required": [
"poolTemplateId"
],
"properties": {
"poolTemplateId": {
"description": "The pool template ID.",
"type": "string",
"format": "uuid"
}
}
},
"AirflowComputeResponse": {
"description": "Apache Airflow compute configuration response.",
"type": "object",
Expand Down
Original file line number Diff line number Diff line change
@@ -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
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"apacheAirflowJobId": "5b218778-e7a5-4d73-8187-f10824047715",
"beta": true,
"airflowEnvironmentComputeRequest": {
"poolTemplateId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
},
"responses": {
"202": {
"headers": {
"Location": "https://api.fabric.microsoft.com/v1/operations/12345678-1234-1234-1234-123456789012",
"x-ms-operation-id": "12345678-1234-1234-1234-123456789012",
"Retry-After": 30
}
}
}
}
Loading