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 2026-07-07 22:06:55 +00:00
1 parent b4d35818fc
commit 0ba0b17ce7
15 files changed
+320 -14
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

dataflow/swagger.json
+3 -3
View File
@@ -929,7 +929,7 @@
"/workspaces/{workspaceId}/dataflows/{dataflowId}/executeQuery": {
"post": {
"summary": "Executes a query against a dataflow and returns the result.",
"description": "Executes a specified query against a dataflow and streams the results in the format specified by the `Accept` header. The default format is Apache Arrow. Supports using custom mashup documents for advanced scenarios.\n\nUse the `Accept` header to control the response format:\n- `application/vnd.apache.arrow.stream;pq-arrow-version=1` (default), `application/vnd.apache.arrow.stream;pq-arrow-version=2` — Apache Arrow streaming format.\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\nThe caller must have *execute* permissions for the dataflow.\n\n## Required Delegated Scopes\n\nDataflow.Execute.All or Item.Execute.All.\n\n## Limitations\n\nQueries can run for a maximum of 90 seconds.\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": "Executes a specified query against a dataflow and streams the result back to the caller. Supports using custom mashup documents for advanced scenarios.\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\nThe caller must have *execute* permissions for the dataflow.\n\n## Required Delegated Scopes\n\nDataflow.Execute.All or Item.Execute.All.\n\n## Limitations\n\nQueries can run for a maximum of 90 seconds.\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## Response formats\n\nUse the `Accept` header to negotiate the response media type. Today, the [Apache Arrow](https://arrow.apache.org/) streaming format is the only available response format; additional formats may be offered in the future.\n\n### Apache Arrow streaming format\n\n**Media type:** `application/vnd.apache.arrow.stream`\n\nWhen sending this media type, the `pq-arrow-version` media-type parameter is **required** and selects the Arrow encoding version:\n\n- `pq-arrow-version=1` — Original Apache Arrow encoding. Compatible with all dataflows, including those that connect through an on-premises data gateway.\n- `pq-arrow-version=2` — Newer Apache Arrow encoding with improved streaming performance. Not supported for dataflows that connect through an on-premises data gateway.\n\nExample: `Accept: application/vnd.apache.arrow.stream;pq-arrow-version=2`\n\nIf the `Accept` header is omitted entirely (or `*/*` is sent), the response defaults to `application/vnd.apache.arrow.stream;pq-arrow-version=1`.\n\n## Interface",
"tags": [
"QueryExecution"
],
@@ -961,7 +961,7 @@
{
"in": "header",
"name": "Accept",
"description": "The desired media type of the response. Currently supported values: `application/vnd.apache.arrow.stream;pq-arrow-version=1` (default), `application/vnd.apache.arrow.stream;pq-arrow-version=2`.",
"description": "The desired media type of the response. See the operation description for the list of supported response formats. Today, only `application/vnd.apache.arrow.stream` is supported; when sending this media type, the `pq-arrow-version` parameter is required and must be either `1` or `2` (e.g. `application/vnd.apache.arrow.stream;pq-arrow-version=1`). If the header is omitted entirely, the default `application/vnd.apache.arrow.stream;pq-arrow-version=1` is used.",
"required": false,
"type": "string"
},
@@ -977,7 +977,7 @@
],
"responses": {
"200": {
"description": "Query result was successfully streamed. The response format depends on the `Accept` header:\n\n* **application/vnd.apache.arrow.stream;pq-arrow-version=1** (default), **application/vnd.apache.arrow.stream;pq-arrow-version=2** — Results are streamed in Apache Arrow format. Refer to the [Arrow documentation](https://arrow.apache.org/docs/python/ipc.html#reading-from-stream-and-file-format-for-pandas) on how to read the stream in Python and other languages.\n\nFor both Arrow versions, errors encountered during query execution or streaming will be in an additional column named 'PQ Arrow Metadata'.",
"description": "Query result was successfully streamed. The response body is encoded in the media type negotiated via the request's `Accept` header (see the operation description for the list of supported response formats).\n\nWhen the response is in the Apache Arrow streaming format (`application/vnd.apache.arrow.stream`, the only format available today), results are streamed as Apache Arrow IPC; the Arrow encoding version returned matches the `pq-arrow-version` parameter sent on the request's `Accept` header (default `1`). Refer to the [Arrow documentation](https://arrow.apache.org/docs/python/ipc.html#reading-from-stream-and-file-format-for-pandas) on how to read the stream in Python and other languages. Errors encountered during query execution or streaming are reported in an additional column at the end named 'PQ Arrow Metadata'.",
"schema": {
"type": "file"
}
platform/definitions/connections.json
+64 -1
View File
@@ -9,7 +9,7 @@
"ConnectivityType": {
"type": "string",
"description": "The connectivity type of the connection. Additional connectivity types may be added over time.",
"enum": ["ShareableCloud", "PersonalCloud", "OnPremisesGateway", "OnPremisesGatewayPersonal", "VirtualNetworkGateway", "Automatic", "None"],
"enum": ["ShareableCloud", "PersonalCloud", "OnPremisesGateway", "OnPremisesGatewayPersonal", "VirtualNetworkGateway", "StreamingVirtualNetworkGateway", "Automatic", "None"],
"x-ms-enum": {
"name": "ConnectivityType",
"modelAsString": true,
@@ -34,6 +34,10 @@
"value": "VirtualNetworkGateway",
"description": "The connection connects through a virtual network data gateway."
},
{
"value": "StreamingVirtualNetworkGateway",
"description": "The connection connects through a streaming virtual network data gateway."
},
{
"value": "Automatic",
"description": "The connection connects through the cloud using an implicit data connection. This option is only available for specific scenarios like semantic models that use Single Sign-On (SSO).”"
@@ -874,6 +878,28 @@
}
}
},
"CreateStreamingVirtualNetworkGatewayConnectionRequest": {
"description": "Creates a connection that connects through a streaming virtual network data gateway.",
"required": ["gatewayId", "credentialDetails"],
"type": "object",
"allOf": [
{
"$ref": "#/definitions/CreateConnectionRequest"
}
],
"x-ms-discriminator-value": "StreamingVirtualNetworkGateway",
"properties": {
"gatewayId": {
"type": "string",
"description": "The object ID of the streaming virtual network gateway that the connection is created under.",
"format": "uuid"
},
"credentialDetails": {
"description": "The credential details of the connection.",
"$ref": "#/definitions/CreateCredentialDetails"
}
}
},
"CreateCloudConnectionRequest": {
"required": ["credentialDetails"],
"type": "object",
@@ -968,6 +994,26 @@
}
}
},
"UpdateStreamingVirtualNetworkGatewayConnectionRequest": {
"description": "Updates a connection that connects through a streaming virtual network data gateway.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/UpdateConnectionRequest"
}
],
"x-ms-discriminator-value": "StreamingVirtualNetworkGateway",
"properties": {
"displayName": {
"description": "The display name of the connection. Maximum length is 200 characters.",
"type": "string"
},
"credentialDetails": {
"description": "The credential details of the connection.",
"$ref": "#/definitions/UpdateCredentialDetails"
}
}
},
"UpdateShareableCloudConnectionRequest": {
"type": "object",
"allOf": [
@@ -1165,6 +1211,23 @@
},
"x-ms-discriminator-value": "VirtualNetworkGateway"
},
"StreamingVirtualNetworkGatewayConnection": {
"type": "object",
"description": "A connection that connects through a streaming virtual network data gateway.",
"allOf": [
{
"$ref": "#/definitions/Connection"
}
],
"properties": {
"gatewayId": {
"description": "The gateway object ID of the connection.",
"type": "string",
"format": "uuid"
}
},
"x-ms-discriminator-value": "StreamingVirtualNetworkGateway"
},
"ListConnectionsResponse": {
"required": ["value"],
"type": "object",
platform/definitions/gateways.json
+57 -1
View File
@@ -9,7 +9,7 @@
"GatewayType": {
"type": "string",
"description": "The type of the gateway. Additional gateway types may be added over time.",
"enum": ["OnPremises", "OnPremisesPersonal", "VirtualNetwork"],
"enum": ["OnPremises", "OnPremisesPersonal", "VirtualNetwork", "StreamingVirtualNetwork"],
"x-ms-enum": {
"name": "GatewayType",
"modelAsString": true,
@@ -25,6 +25,10 @@
{
"value": "VirtualNetwork",
"description": "The virtual network gateway."
},
{
"value": "StreamingVirtualNetwork",
"description": "The streaming virtual network gateway."
}
]
}
@@ -201,6 +205,27 @@
}
}
},
"StreamingVirtualNetworkGateway": {
"description": "A streaming virtual network gateway.",
"required": ["displayName", "virtualNetworkAzureResource"],
"type": "object",
"allOf": [
{
"$ref": "#/definitions/Gateway"
}
],
"x-ms-discriminator-value": "StreamingVirtualNetwork",
"properties": {
"displayName": {
"type": "string",
"description": "The display name of the streaming virtual network gateway."
},
"virtualNetworkAzureResource": {
"description": "The Azure virtual network resource.",
"$ref": "../../common/definitions.json#/definitions/VirtualNetworkAzureResource"
}
}
},
"ListGatewaysResponse": {
"required": ["value"],
"type": "object",
@@ -264,6 +289,27 @@
}
}
},
"CreateStreamingVirtualNetworkGatewayRequest": {
"description": "Creates a streaming virtual network gateway.",
"required": ["displayName", "virtualNetworkAzureResource"],
"type": "object",
"allOf": [
{
"$ref": "#/definitions/CreateGatewayRequest"
}
],
"x-ms-discriminator-value": "StreamingVirtualNetwork",
"properties": {
"displayName": {
"type": "string",
"description": "The display name of the streaming virtual network gateway. Maximum length is 200 characters."
},
"virtualNetworkAzureResource": {
"description": "The Azure virtual network resource.",
"$ref": "../../common/definitions.json#/definitions/VirtualNetworkAzureResource"
}
}
},
"UpdateGatewayRequest": {
"required": ["type"],
"type": "object",
@@ -327,6 +373,16 @@
}
}
},
"UpdateStreamingVirtualNetworkGatewayRequest": {
"description": "Updates a streaming virtual network gateway.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/UpdateGatewayRequest"
}
],
"x-ms-discriminator-value": "StreamingVirtualNetwork"
},
"ListGatewayMembersResponse": {
"required": ["value"],
"type": "object",
platform/definitions/platform.json
+5 -5
View File
@@ -76,6 +76,11 @@
"$ref": "../../common/definitions.json#/definitions/WorkspaceAppliedTag"
},
"readOnly": true
},
"capacityRegion": {
"description": "The region of the capacity associated with this workspace.",
"$ref": "#/definitions/CapacityRegion",
"readOnly": true
}
},
"readOnly": true
@@ -100,11 +105,6 @@
"$ref": "#/definitions/WorkspaceIdentity",
"readOnly": true
},
"capacityRegion": {
"description": "The region of the capacity associated with this workspace.",
"$ref": "#/definitions/CapacityRegion",
"readOnly": true
},
"oneLakeEndpoints": {
"description": "The OneLake API endpoints associated with this workspace.",
"$ref": "#/definitions/OneLakeEndpoints",
platform/examples/connections/CreateStreamingVirtualNetworkGatewayConnection.json
+57
View File
@@ -0,0 +1,57 @@
{
"parameters": {
"createConnectionRequest": {
"connectivityType": "StreamingVirtualNetworkGateway",
"gatewayId": "93491300-cfbd-402f-bf17-9ace59a92354",
"displayName": "ContosoStreamingVirtualNetworkGatewayConnection",
"connectionDetails": {
"type": "SQL",
"creationMethod": "SQL",
"parameters": [
{
"dataType": "Text",
"name": "server",
"value": "contoso.database.windows.net"
},
{
"dataType": "Text",
"name": "database",
"value": "sales"
}
]
},
"privacyLevel": "Organizational",
"credentialDetails": {
"singleSignOnType": "None",
"connectionEncryption": "Encrypted",
"skipTestConnection": false,
"credentials": {
"credentialType": "Basic",
"username": "admin",
"password": "*********"
}
}
}
},
"responses": {
"201": {
"body": {
"id": "eeec9a3a-6ef5-4e2b-bb6a-0060bd2f0172",
"displayName": "ContosoStreamingVirtualNetworkGatewayConnection",
"gatewayId": "93491300-cfbd-402f-bf17-9ace59a92354",
"connectivityType": "StreamingVirtualNetworkGateway",
"connectionDetails": {
"type": "SQL",
"path": "contoso.database.windows.net;sales"
},
"privacyLevel": "Organizational",
"credentialDetails": {
"credentialType": "Basic",
"singleSignOnType": "None",
"connectionEncryption": "Encrypted",
"skipTestConnection": false
}
}
}
}
}
platform/examples/connections/ListConnections.json
+17
View File
@@ -50,6 +50,23 @@
"myLastBoundDateTime": "2023-05-24T16:22:20Z",
"myLastCredentialUsedDateTime": "2023-05-25T16:22:20Z"
}
},
{
"id": "a3b4c5d6-7e8f-4a5b-9c0d-1e2f3a4b5c6d",
"displayName": "ContosoStreamingVirtualNetworkGatewayConnection",
"gatewayId": "3f8d6a4b-1c2e-4f5a-9b7c-2d6e8f1a3b9d",
"connectivityType": "StreamingVirtualNetworkGateway",
"connectionDetails": {
"type": "SQL",
"path": "contoso.database.windows.net;marketing"
},
"privacyLevel": "Organizational",
"credentialDetails": {
"credentialType": "Basic",
"singleSignOnType": "None",
"connectionEncryption": "Encrypted",
"skipTestConnection": false
}
}
],
"continuationToken": "LDEsMTAwMDAwLDA%3D",
platform/examples/connections/UpdateStreamingVirtualNetworkGatewayConnection.json
+33
View File
@@ -0,0 +1,33 @@
{
"parameters": {
"connectionId": "6b571614-2e98-4bfd-b9ed-1cb8d3ffc396",
"updateConnectionRequest": {
"connectivityType": "StreamingVirtualNetworkGateway",
"displayName": "ContosoMarketingStreamingVirtualNetworkGatewayConnection",
"credentialDetails": {
"singleSignOnType": "None"
}
}
},
"responses": {
"200": {
"body": {
"id": "6b571614-2e98-4bfd-b9ed-1cb8d3ffc396",
"displayName": "ContosoMarketingStreamingVirtualNetworkGatewayConnection",
"gatewayId": "befccff4-3ee6-40d7-b8f1-a0a9fd684a85",
"connectivityType": "StreamingVirtualNetworkGateway",
"connectionDetails": {
"type": "SQL",
"path": "contoso.database.windows.net;marketing"
},
"privacyLevel": "Organizational",
"credentialDetails": {
"credentialType": "Basic",
"singleSignOnType": "None",
"connectionEncryption": "Encrypted",
"skipTestConnection": false
}
}
}
}
}
platform/examples/gateways/CreateStreamingVirtualNetworkGateway.json
+29
View File
@@ -0,0 +1,29 @@
{
"parameters": {
"createGatewayRequest": {
"type": "StreamingVirtualNetwork",
"displayName": "ContosoStreamingVirtualNetworkGateway",
"virtualNetworkAzureResource": {
"subscriptionId": "879b4ba0-ed17-4ff2-851e-4a2228e00b70",
"resourceGroupName": "ContosoResourceGroup",
"virtualNetworkName": "ContosoVirtualNetwork",
"subnetName": "ContosoSubnet"
}
}
},
"responses": {
"201": {
"body": {
"id": "271c5c9a-0860-4927-b1da-ce49008d6565",
"type": "StreamingVirtualNetwork",
"displayName": "ContosoStreamingVirtualNetworkGateway",
"virtualNetworkAzureResource": {
"subscriptionId": "879b4ba0-ed17-4ff2-851e-4a2228e00b70",
"resourceGroupName": "ContosoResourceGroup",
"virtualNetworkName": "ContosoVirtualNetwork",
"subnetName": "ContosoSubnet"
}
}
}
}
}
platform/examples/gateways/ListGateways.json
+11
View File
@@ -40,6 +40,17 @@
},
"inactivityMinutesBeforeSleep": 1440,
"numberOfMemberGateways": 3
},
{
"id": "3f8d6a4b-1c2e-4f5a-9b7c-2d6e8f1a3b9d",
"type": "StreamingVirtualNetwork",
"displayName": "ContosoStreamingVirtualNetworkGateway",
"virtualNetworkAzureResource": {
"subscriptionId": "879b4ba0-ed17-4ff2-851e-4a2228e00b70",
"resourceGroupName": "ContosoResourceGroup",
"virtualNetworkName": "ContosoVirtualNetwork",
"subnetName": "ContosoSubnet"
}
}
],
"continuationToken": "LDEsMTAwMDAwLDA%3D",
platform/examples/gateways/UpdateStreamingVirtualNetworkGateway.json
+24
View File
@@ -0,0 +1,24 @@
{
"parameters": {
"gatewayId": "7015263e-885f-455b-80f7-bbf862899176",
"updateGatewayRequest": {
"type": "StreamingVirtualNetwork",
"displayName": "ContosoStreamingVirtualNetworkGateway1"
}
},
"responses": {
"200": {
"body": {
"id": "7015263e-885f-455b-80f7-bbf862899176",
"type": "StreamingVirtualNetwork",
"displayName": "ContosoStreamingVirtualNetworkGateway1",
"virtualNetworkAzureResource": {
"subscriptionId": "879b4ba0-ed17-4ff2-851e-4a2228e00b70",
"resourceGroupName": "ContosoResourceGroup",
"virtualNetworkName": "ContosoVirtualNetwork",
"subnetName": "ContosoSubnet"
}
}
}
}
}
platform/examples/platform/CreateWorkspaceRequiredOnly.json
+2 -1
View File
@@ -13,7 +13,8 @@
"id": "cfafbeb1-8037-4d0c-896e-a46fb22287ff",
"displayName": "New workspace",
"description": "",
"type": "Workspace"
"type": "Workspace",
"capacityRegion": "West US"
}
}
}
platform/examples/platform/ListWorkspaces.json
+1
View File
@@ -29,6 +29,7 @@
"type": "Workspace",
"capacityId": "171018af-1531-4e61-942a-74f024b7f9fd",
"domainId": "7c889f28-999b-4945-840d-54da3e3b5a29",
"capacityRegion": "East US",
"tags": [
{
"id": "9b8c7d6e-5f4a-3b2c-1d0e-9f8a7b6c5d4e",
platform/examples/platform/ListWorkspacesWithContinuation.json
+2 -1
View File
@@ -21,7 +21,8 @@
"displayName": "Finance",
"description": "A workspace used by the finance team",
"type": "Workspace",
"capacityId": "171018af-1531-4e61-942a-74f024b7f9fd"
"capacityId": "171018af-1531-4e61-942a-74f024b7f9fd",
"capacityRegion": "East US"
}
],
"continuationToken": "LDEsMTAwMDAwLDA%3D",
platform/examples/platform/UpdateWorkspace.json
+2 -1
View File
@@ -13,7 +13,8 @@
"displayName": "Workspace New displayName",
"description": "Workspace New description",
"type": "Workspace",
"domainId": "686177b9-ef29-45e4-a5db-1786ca6dbb9f"
"domainId": "686177b9-ef29-45e4-a5db-1786ca6dbb9f",
"capacityRegion": "East US"
}
}
}
platform/swagger.json
+13 -1
View File
@@ -8103,6 +8103,9 @@
"Virtual network gateway example": {
"$ref": "./examples/connections/CreateVirtualNetworkGatewayConnection.json"
},
"Streaming virtual network gateway example": {
"$ref": "./examples/connections/CreateStreamingVirtualNetworkGatewayConnection.json"
},
"Cloud example": {
"$ref": "./examples/connections/CreateCloudConnection.json"
},
@@ -8235,6 +8238,9 @@
"Virtual network gateway example": {
"$ref": "./examples/connections/UpdateVirtualNetworkGatewayConnection.json"
},
"Streaming virtual network gateway example": {
"$ref": "./examples/connections/UpdateStreamingVirtualNetworkGatewayConnection.json"
},
"Shareable cloud example": {
"$ref": "./examples/connections/UpdateShareableCloudConnection.json"
},
@@ -8297,7 +8303,7 @@
"/connections/{connectionId}/testConnection": {
"post": {
"summary": "Tests the connection.",
"description": "Provides the status of the specified connection.\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\nPermission to read the connection, or admin permission for the gateway that hosts the connection.\n\n## Required Delegated Scopes \n\nConnection.Read.All or Connection.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": "Provides the status of the specified connection.\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n[!NOTE]\n> Connections that route through a streaming virtual network gateway (`connectivityType` = `StreamingVirtualNetworkGateway`) are not supported.\n\n## Permissions\n\nPermission to read the connection, or admin permission for the gateway that hosts the connection.\n\n## Required Delegated Scopes \n\nConnection.Read.All or Connection.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": [
"Connections"
],
@@ -8556,6 +8562,9 @@
"x-ms-examples": {
"Virtual network gateway example": {
"$ref": "./examples/gateways/CreateVirtualNetworkGateway.json"
},
"Streaming virtual network gateway example": {
"$ref": "./examples/gateways/CreateStreamingVirtualNetworkGateway.json"
}
}
}
@@ -8679,6 +8688,9 @@
},
"Virtual network gateway example": {
"$ref": "./examples/gateways/UpdateVirtualNetworkGateway.json"
},
"Streaming virtual network gateway example": {
"$ref": "./examples/gateways/UpdateStreamingVirtualNetworkGateway.json"
}
}
},