nprasad2077/fabric-rest-api-specs
1
0 Fork 0
mirror of https://github.com/microsoft/fabric-rest-api-specs.git synced 2026-11-04 12:04:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updating swagger files.

Browse Source
This commit is contained in:
Fabric-APIs-Publish-Specification-Pipeline committed 2025-08-19 22:05:07 +00:00
1 parent 4dc6fd4055
commit 34b78601b2
7 files changed
+309 -2
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

platform/definitions/platform.json
+8 -2
View File
@@ -55,6 +55,12 @@
"type": "string",
"format": "uuid",
"readOnly": true
},
"apiEndpoint": {
"description": "HTTP URL that represents the API endpoint specific to the workspace. This endpoint value is returned when the user enables preferWorkspaceSpecificEndpoints. It allows for API access over private links.",
"type": "string",
"format": "uri",
"readOnly": true
}
},
"readOnly": true
@@ -388,12 +394,12 @@
"type": "object",
"properties": {
"blobEndpoint": {
"description": "The OneLake API endpoint available for Blob API operations. This is a region specific endpoint, unless the tenant has Private Link enabled and public access disabled, in which case the global endpoint is provided.",
"description": "The OneLake API endpoint available for Blob API operations. By default, this is a region specific endpoint. If the user enables preferWorkspaceSpecificEndpoints or the workspace has public access disabled, the workspace-specific endpoint is provided to allow for access over private links.",
"type": "string",
"readOnly": true
},
"dfsEndpoint": {
"description": "The OneLake API endpoint available for Distributed File System (DFS) or ADLSgen2 filesystem API operations. This is a region specific endpoint, unless the tenant has Private Link enabled and public access disabled, in which case the global endpoint is provided.",
"description": "The OneLake API endpoint available for Distributed File System (DFS) or ADLSgen2 filesystem API operations. By default, this is a region specific endpoint. If the user enables preferWorkspaceSpecificEndpoints or the workspace has public access disabled, the workspace-specific endpoint is provided to allow for access over private links.",
"type": "string",
"readOnly": true
}
platform/definitions/workspaceNetworkingPolicy.json
+73
View File
@@ -0,0 +1,73 @@
{
"swagger": "2.0",
"info": {
"version": "v1",
"title": "Workspace Networking Communication Policy REST APIs"
},
"paths": {},
"definitions": {
"WorkspaceNetworkingCommunicationPolicy": {
"type": "object",
"description": "The networking communication policy for a workspace.",
"properties": {
"inbound": {
"description": "The inbound network communications properties for a workspace.",
"$ref": "#/definitions/InboundRules"
},
"outbound": {
"description": "The outbound network communications properties for a workspace.",
"$ref": "#/definitions/OutboundRules"
}
}
},
"InboundRules": {
"description": "The policy for all inbound communications to a workspace.",
"type": "object",
"properties": {
"publicAccessRules": {
"description": "The policy for inbound communications to a workspace from public networks.",
"$ref": "#/definitions/NetworkRules"
}
}
},
"OutboundRules": {
"description": "The policy for all outbound communications from a workspace.",
"type": "object",
"properties": {
"publicAccessRules": {
"description": "The policy for outbound communications to public networks from a workspace.",
"$ref": "#/definitions/NetworkRules"
}
}
},
"NetworkRules": {
"description": "The policy defining access to/from a workspace to/from public networks.",
"type": "object",
"properties": {
"defaultAction": {
"description": "Default policy for workspace access from public networks.",
"$ref": "#/definitions/DefaultAction"
}
}
},
"DefaultAction": {
"description": "The default option for a network communications policy. Additional network connection defaults may be added over time.",
"type": "string",
"enum": [ "Allow", "Deny" ],
"x-ms-enum": {
"name": "NetworkAccessRule",
"modelAsString": true,
"values": [
{
"value": "Allow",
"description": "Allow all connections."
},
{
"value": "Deny",
"description": "Deny all connections."
}
]
}
}
}
}
platform/examples/platform/GetWorkspaceNetworkingCommunicationPolicy.json
+24
View File
@@ -0,0 +1,24 @@
{
"parameters": {
"workspaceId": "47482db6-4583-4672-86dd-999d0f8f4d7a"
},
"responses": {
"200": {
"body": {
"inbound": {
"publicAccessRules": {
"defaultAction": "Deny"
}
},
"outbound": {
"publicAccessRules": {
"defaultAction": "Allow"
}
}
},
"headers": {
"ETag": "0f8fad5b-d9cb-469f-a165-70867728950e"
}
}
}
}
platform/examples/platform/GetWorkspaceWithPreferWorkspaceSpecificEndpoints.json
+28
View File
@@ -0,0 +1,28 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
"preferWorkspaceSpecificEndpoints" : true
},
"responses": {
"200": {
"body": {
"id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
"displayName": "New workspace",
"description": "New workspace description",
"type": "Workspace",
"capacityId": "56bac802-080d-4f73-8a42-1b406eb1fcac",
"capacityAssignmentProgress": "Completed",
"workspaceIdentity": {
"applicationId" : "00a4a8f9-78d3-41b3-b87a-6ae5271c8d0d",
"servicePrincipalId": "5ba4ae58-d402-45c6-a848-0253e834fd78"
},
"capacityRegion": "East US",
"oneLakeEndpoints": {
"blobEndpoint": "https://cfafbeb180374d0c896ea46fb27ff227.zcf.blob.fabric.microsoft.com",
"dfsEndpoint": "https://cfafbeb180374d0c896ea46fb27ff227.zcf.dfs.fabric.microsoft.com"
},
"apiEndpoint": "https://cfafbeb180374d0c896ea46fb27ff227.zcf.w.api.fabric.microsoft.com"
}
}
}
}
platform/examples/platform/ListWorkspacesWithPreferWorkspaceSpecificEndpoints.json
+27
View File
@@ -0,0 +1,27 @@
{
"parameters": {
"preferWorkspaceSpecificEndpoints" : true
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
"displayName": "Alice's Workspace",
"description": "A workspace for Alice",
"type": "Workspace",
"apiEndpoint": "https://cfafbeb180374d0c896ea46fb27ff227.zcf.w.api.fabric.microsoft.com"
},
{
"id": "0c02a0cd-71bc-410f-aa05-5a7bc98765f7",
"displayName": "Bob's Workspace",
"description": "A workspace for Bob",
"type": "Workspace",
"apiEndpoint": "https://0c02a0cd71bc410faa055a7bc98765f7.z0c.w.api.fabric.microsoft.com"
}
]
}
}
}
}
platform/examples/platform/SetWorkspaceNetworkingCommunicationPolicy.json
+24
View File
@@ -0,0 +1,24 @@
{
"parameters": {
"workspaceId": "47482db6-4583-4672-86dd-999d0f8f4d7a",
"SetWorkspaceNetworkingCommunicationPolicy": {
"inbound": {
"publicAccessRules": {
"defaultAction": "Allow"
}
},
"outbound": {
"publicAccessRules": {
"defaultAction": "Deny"
}
}
}
},
"responses": {
"200": {
"headers": {
"ETag": "0f8fad5b-d9cb-469f-a165-70867728950e"
}
}
}
}
platform/swagger.json
+125
View File
@@ -88,6 +88,13 @@
"description": "A token for retrieving the next page of results.",
"type": "string",
"required": false
},
{
"in": "query",
"name": "preferWorkspaceSpecificEndpoints",
"description": "A setting that controls whether to include the workspace-specific API endpoint per workspace. True - Include the workspace-specific API endpoint, False - Do not include the workspace-specific API endpoint.",
"type": "boolean",
"required": false
}
],
"responses": {
@@ -113,6 +120,9 @@
},
"List workspaces with continuation example": {
"$ref": "./examples/platform/ListWorkspacesWithContinuation.json"
},
"List workspaces with preferWorkspaceSpecificEndpoints example": {
"$ref": "./examples/platform/ListWorkspacesWithPreferWorkspaceSpecificEndpoints.json"
}
}
}
@@ -136,6 +146,13 @@
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "query",
"name": "preferWorkspaceSpecificEndpoints",
"description": "A setting that controls whether to include workspace-specific or general public endpoints for API and OneLake access. True - Include workspace-specific endpoints for API and OneLake access, False - Include general public endpoints for OneLake access.",
"type": "boolean",
"required": false
}
],
"responses": {
@@ -155,6 +172,9 @@
"x-ms-examples": {
"Get a workspace example": {
"$ref": "./examples/platform/GetWorkspace.json"
},
"Get a workspace with preferWorkspaceSpecificEndpoints example": {
"$ref": "./examples/platform/GetWorkspaceWithPreferWorkspaceSpecificEndpoints.json"
}
}
},
@@ -6461,6 +6481,111 @@
}
}
}
},
"/workspaces/{workspaceId}/networking/communicationPolicy": {
"get": {
"summary": "Returns networking communication policy for the specified workspace. This feature is currently in preview.",
"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",
"tags": [
"Workspaces"
],
"operationId": "Workspaces_GetNetworkCommunicationPolicy",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions/workspaceNetworkingPolicy.json#/definitions/WorkspaceNetworkingCommunicationPolicy"
},
"headers": {
"ETag": {
"type": "string"
}
}
},
"default": {
"description": "Common error codes:\n\n* UnknownError - An error occurred.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get workspace networking communication policy example": {
"$ref": "./examples/platform/GetWorkspaceNetworkingCommunicationPolicy.json"
}
}
},
"put": {
"summary": "Sets networking communication policy for the specified workspace. This API uses the PUT method and will overwrite all settings. Remaining policy will be set to default value if only partial policy is provided in the request body. Always run Get Network Communication Policy first and provide full policy in the request body. This feature is currently in preview.",
"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",
"tags": [
"Workspaces"
],
"operationId": "Workspaces_SetNetworkCommunicationPolicy",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "body",
"name": "SetWorkspaceNetworkingCommunicationPolicy",
"description": "Set workspace networking communication policy request payload.",
"schema": {
"$ref": "./definitions/workspaceNetworkingPolicy.json#/definitions/WorkspaceNetworkingCommunicationPolicy"
},
"required": true
},
{
"in": "header",
"name": "If-Match",
"description": "An ETag value. The ETag must be specified in quotes. If provided, the call will succeed only if the resource's ETag matches the provided ETag.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"headers": {
"ETag": {
"type": "string"
}
}
},
"default": {
"description": "Common error codes:\n\n* UnknownError - An error occurred.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Set workspace networking communication policy example": {
"$ref": "./examples/platform/SetWorkspaceNetworkingCommunicationPolicy.json"
}
}
}
}
},
"responses": {},