mirror of
https://github.com/microsoft/fabric-rest-api-specs.git
synced 2026-11-04 12:04:23 +00:00
Updating swagger files.
This commit is contained in:
Fabric-APIs-Publish-Specification-Pipeline committed
1 parent
152e811e59
commit
49e5f16adc
53 files changed
+4452
-23
No files matched your search
@@ -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
|
||||
}
|
||||
}
|
||||
},
|
||||
|
||||
@@ -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"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -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"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -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"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
+26
-3
@@ -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"
|
||||
],
|
||||
@@ -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": {
|
||||
@@ -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"
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -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
|
||||
},
|
||||
@@ -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
|
||||
},
|
||||
|
||||
@@ -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",
|
||||
|
||||
@@ -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
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1241,6 +1241,105 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/apacheAirflowJobs/{apacheAirflowJobId}/environment/updateCompute?beta=true": {
|
||||
"post": {
|
||||
"summary": "Updates the compute configuration 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\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": [
|
||||
"Compute"
|
||||
],
|
||||
"operationId": "Compute_Update_Apache_Airflow_Job_Compute_(beta)",
|
||||
"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": "path",
|
||||
"name": "apacheAirflowJobId",
|
||||
"description": "The Apache Airflow job ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "beta",
|
||||
"description": "This required parameter must be set to `true` to access this API, which is currently in beta.",
|
||||
"type": "boolean",
|
||||
"required": true,
|
||||
"default": true
|
||||
},
|
||||
{
|
||||
"in": "body",
|
||||
"name": "airflowEnvironmentComputeRequest",
|
||||
"description": "Update Apache Airflow environment compute request payload.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/AirflowEnvironmentComputeRequest"
|
||||
},
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully."
|
||||
},
|
||||
"202": {
|
||||
"description": "Request accepted. The compute configuration will be updated in the background.",
|
||||
"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* ItemNotFound - The requested Apache Airflow job was not found.\n\n* Forbidden - The caller doesn't have permissions to call the API.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Update Apache Airflow compute configuration example": {
|
||||
"$ref": "./examples/UpdateApacheAirflowJobCompute.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/apacheAirflowJobs/{apacheAirflowJobId}/files?beta=true": {
|
||||
"get": {
|
||||
"summary": "Returns a list of Apache Airflow job files from the specified Apache Airflow job.",
|
||||
|
||||
+699
-8
@@ -9,12 +9,20 @@
|
||||
"DataAgent": {
|
||||
"description": "A DataAgent object.",
|
||||
"type": "object",
|
||||
"required": ["type"],
|
||||
"required": [
|
||||
"type"
|
||||
],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "../common/definitions.json#/definitions/Item"
|
||||
}
|
||||
]
|
||||
],
|
||||
"properties": {
|
||||
"properties": {
|
||||
"description": "The DataAgent properties.",
|
||||
"$ref": "#/definitions/DataAgentProperties"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DataAgents": {
|
||||
"description": "A list of data agents.",
|
||||
@@ -35,9 +43,22 @@
|
||||
}
|
||||
]
|
||||
},
|
||||
"DataAgentProperties": {
|
||||
"description": "The DataAgent properties.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"publishedDescription": {
|
||||
"description": "The published description of the DataAgent. This description provides context when the agent appears in other experiences. It is set when the DataAgent is published and is not returned for an unpublished DataAgent.",
|
||||
"type": "string",
|
||||
"readOnly": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"CreateDataAgentRequest": {
|
||||
"description": "Create DataAgent request payload.",
|
||||
"required": ["displayName"],
|
||||
"required": [
|
||||
"displayName"
|
||||
],
|
||||
"properties": {
|
||||
"displayName": {
|
||||
"description": "The DataAgent display name. The display name must follow naming rules according to item type.",
|
||||
@@ -69,7 +90,9 @@
|
||||
},
|
||||
"UpdateDataAgentDefinitionRequest": {
|
||||
"description": "Update DataAgent public definition request payload.",
|
||||
"required": ["definition"],
|
||||
"required": [
|
||||
"definition"
|
||||
],
|
||||
"properties": {
|
||||
"definition": {
|
||||
"$ref": "#/definitions/DataAgentPublicDefinition"
|
||||
@@ -78,7 +101,9 @@
|
||||
},
|
||||
"DataAgentDefinitionResponse": {
|
||||
"description": "DataAgent public definition response.",
|
||||
"required": ["definition"],
|
||||
"required": [
|
||||
"definition"
|
||||
],
|
||||
"properties": {
|
||||
"definition": {
|
||||
"$ref": "#/definitions/DataAgentPublicDefinition",
|
||||
@@ -86,10 +111,12 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"DataAgentPublicDefinition" : {
|
||||
"DataAgentPublicDefinition": {
|
||||
"description": "DataAgent public definition object. Refer to this [article](/rest/api/fabric/articles/item-management/definitions/data-agent-definition) for more details on the structure of the DataAgent definition.",
|
||||
"type": "object",
|
||||
"required": ["parts"],
|
||||
"required": [
|
||||
"parts"
|
||||
],
|
||||
"properties": {
|
||||
"format": {
|
||||
"description": "The format of the data agent definition.",
|
||||
@@ -120,7 +147,7 @@
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"payloadType":{
|
||||
"payloadType": {
|
||||
"description": "The payload type.",
|
||||
"$ref": "../common/definitions.json#/definitions/PayloadType",
|
||||
"readOnly": false
|
||||
@@ -141,6 +168,670 @@
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"DataAgentSettingsResponse": {
|
||||
"description": "The DataAgent settings.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"aiInstructions": {
|
||||
"description": "Custom AI system prompt for the DataAgent.",
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateDataAgentSettingsRequest": {
|
||||
"description": "Update DataAgent settings request payload. Only provided fields are updated.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"aiInstructions": {
|
||||
"description": "Custom AI system prompt for the DataAgent.",
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DataAgentDatasources": {
|
||||
"description": "A paginated list of DataAgent datasources.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"value"
|
||||
],
|
||||
"properties": {
|
||||
"value": {
|
||||
"description": "A list of datasources.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/DataAgentDatasourceResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
|
||||
}
|
||||
]
|
||||
},
|
||||
"DataAgentDatasourceResponse": {
|
||||
"description": "A DataAgent datasource.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"id",
|
||||
"type"
|
||||
],
|
||||
"discriminator": "type",
|
||||
"properties": {
|
||||
"id": {
|
||||
"description": "The datasource ID.",
|
||||
"type": "string",
|
||||
"format": "uuid"
|
||||
},
|
||||
"instructions": {
|
||||
"description": "Custom AI instructions specific to this datasource.",
|
||||
"type": "string"
|
||||
},
|
||||
"type": {
|
||||
"description": "The datasource type.",
|
||||
"$ref": "#/definitions/DatasourceType"
|
||||
},
|
||||
"displayName": {
|
||||
"description": "The display name of the datasource.",
|
||||
"type": "string"
|
||||
},
|
||||
"description": {
|
||||
"description": "The description of the datasource.",
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"FabricItemDatasource": {
|
||||
"type": "object",
|
||||
"description": "A DataAgent datasource backed by a Fabric item.",
|
||||
"required": [
|
||||
"itemReference",
|
||||
"fabricItemType"
|
||||
],
|
||||
"properties": {
|
||||
"itemReference": {
|
||||
"$ref": "../common/definitions.json#/definitions/ItemReference"
|
||||
},
|
||||
"fabricItemType": {
|
||||
"description": "The Fabric item type of the datasource.",
|
||||
"$ref": "#/definitions/DataAgentSupportedItemType"
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/DataAgentDatasourceResponse"
|
||||
}
|
||||
],
|
||||
"x-ms-discriminator-value": "FabricItem"
|
||||
},
|
||||
"LakehouseTablesDatasource": {
|
||||
"type": "object",
|
||||
"description": "A DataAgent datasource that uses a lakehouse in tables-only mode.",
|
||||
"required": [
|
||||
"lakehouseReference"
|
||||
],
|
||||
"properties": {
|
||||
"lakehouseReference": {
|
||||
"$ref": "../common/definitions.json#/definitions/ItemReference"
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/DataAgentDatasourceResponse"
|
||||
}
|
||||
],
|
||||
"x-ms-discriminator-value": "LakehouseTables"
|
||||
},
|
||||
"CreateDataAgentDatasourceRequest": {
|
||||
"description": "Create DataAgent datasource request payload.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"type"
|
||||
],
|
||||
"properties": {
|
||||
"type": {
|
||||
"description": "The datasource type to create.",
|
||||
"$ref": "#/definitions/DatasourceType"
|
||||
},
|
||||
"itemReference": {
|
||||
"$ref": "../common/definitions.json#/definitions/ItemReferenceById"
|
||||
},
|
||||
"lakehouseReference": {
|
||||
"$ref": "../common/definitions.json#/definitions/ItemReferenceById"
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateDataAgentDatasourceRequest": {
|
||||
"description": "Update DataAgent datasource request payload. Only provided fields are updated.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"instructions": {
|
||||
"description": "Custom AI instructions specific to this datasource.",
|
||||
"type": "string"
|
||||
},
|
||||
"description": {
|
||||
"description": "The description of the datasource.",
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DataSourceElement": {
|
||||
"description": "A datasource schema element.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"id",
|
||||
"isSelected",
|
||||
"displayName",
|
||||
"type",
|
||||
"hasSubElements"
|
||||
],
|
||||
"properties": {
|
||||
"id": {
|
||||
"description": "The element identifier. Use as rootId to drill deeper into the schema tree.",
|
||||
"type": "string"
|
||||
},
|
||||
"isSelected": {
|
||||
"description": "Whether this element is selected for use by the DataAgent.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"displayName": {
|
||||
"description": "Human-readable name of the element.",
|
||||
"type": "string"
|
||||
},
|
||||
"type": {
|
||||
"description": "The type of schema element.",
|
||||
"$ref": "#/definitions/ElementType"
|
||||
},
|
||||
"dataType": {
|
||||
"description": "Data type for columns (e.g., int, string). Present only for column elements.",
|
||||
"type": "string"
|
||||
},
|
||||
"description": {
|
||||
"description": "User-set description of the element.",
|
||||
"type": "string"
|
||||
},
|
||||
"hasSubElements": {
|
||||
"description": "Whether this element has children to drill into.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"state": {
|
||||
"description": "Indicates if the element exists in the live schema.",
|
||||
"$ref": "#/definitions/ElementState"
|
||||
},
|
||||
"indexState": {
|
||||
"description": "Index state for lakehouse file directories.",
|
||||
"$ref": "#/definitions/IndexState"
|
||||
},
|
||||
"lastSyncDateTime": {
|
||||
"description": "The last time this element was synchronized from the datasource schema, as an ISO 8601 timestamp (e.g., 2025-06-15T10:30:00Z).",
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DataSourceElements": {
|
||||
"description": "A paginated list of datasource schema elements.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"value"
|
||||
],
|
||||
"properties": {
|
||||
"value": {
|
||||
"description": "A list of schema elements.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/DataSourceElement"
|
||||
}
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
|
||||
}
|
||||
]
|
||||
},
|
||||
"UpdateDataSourceElementRequest": {
|
||||
"description": "Update a datasource element request payload. Only provided fields are updated.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"isSelected": {
|
||||
"description": "Select or deselect the element. When deselected, the element configuration is preserved and restored when re-selected.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"description": {
|
||||
"description": "Set a custom description for the element.",
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DataAgentFewshot": {
|
||||
"description": "A DataAgent fewshot.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"id",
|
||||
"question",
|
||||
"validationStatus"
|
||||
],
|
||||
"properties": {
|
||||
"id": {
|
||||
"description": "The fewshot ID.",
|
||||
"type": "string",
|
||||
"format": "uuid"
|
||||
},
|
||||
"question": {
|
||||
"description": "Natural language question.",
|
||||
"type": "string"
|
||||
},
|
||||
"query": {
|
||||
"description": "The SQL/KQL query answer.",
|
||||
"type": "string"
|
||||
},
|
||||
"validationStatus": {
|
||||
"description": "The validation status of the fewshot.",
|
||||
"$ref": "#/definitions/FewshotValidationStatus"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DataAgentFewshots": {
|
||||
"description": "A paginated list of DataAgent fewshots.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"value"
|
||||
],
|
||||
"properties": {
|
||||
"value": {
|
||||
"description": "A list of fewshots.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/DataAgentFewshot"
|
||||
}
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
|
||||
}
|
||||
]
|
||||
},
|
||||
"CreateDataAgentFewshotRequest": {
|
||||
"description": "Create a DataAgent fewshot request payload.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"question"
|
||||
],
|
||||
"properties": {
|
||||
"question": {
|
||||
"description": "Natural language question.",
|
||||
"type": "string"
|
||||
},
|
||||
"query": {
|
||||
"description": "The SQL/KQL query answer.",
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateDataAgentFewshotRequest": {
|
||||
"description": "Update a DataAgent fewshot request payload. Only provided fields are updated.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"question": {
|
||||
"description": "Natural language question.",
|
||||
"type": "string"
|
||||
},
|
||||
"query": {
|
||||
"description": "The SQL/KQL query answer.",
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"PublishDataAgentRequest": {
|
||||
"description": "Publish DataAgent request payload.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"publishedDescription": {
|
||||
"description": "A description shown when the agent appears in other experiences.",
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"PublishDataAgentResponse": {
|
||||
"description": "Publish DataAgent response.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"publishedDescription": {
|
||||
"description": "The publish description.",
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DatasourceType": {
|
||||
"type": "string",
|
||||
"description": "The datasource type. Additional DatasourceType types may be added over time.",
|
||||
"enum": [
|
||||
"FabricItem",
|
||||
"LakehouseTables"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "DatasourceType",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "FabricItem",
|
||||
"description": "A datasource backed by a supported Fabric item."
|
||||
},
|
||||
{
|
||||
"value": "LakehouseTables",
|
||||
"description": "A datasource backed by a lakehouse in tables-only mode."
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"DataAgentSupportedItemType": {
|
||||
"type": "string",
|
||||
"description": "The supported Fabric item type for a `FabricItem` datasource. Values use published Fabric item names. Additional DataAgentSupportedItemType types may be added over time.",
|
||||
"enum": [
|
||||
"Report",
|
||||
"SemanticModel",
|
||||
"Lakehouse",
|
||||
"KQLDatabase",
|
||||
"Warehouse",
|
||||
"MirroredDatabase",
|
||||
"MirroredAzureDatabricksCatalog",
|
||||
"GraphModel",
|
||||
"SQLDatabase",
|
||||
"Ontology"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "DataAgentSupportedItemType",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "Report",
|
||||
"description": "Power BI report."
|
||||
},
|
||||
{
|
||||
"value": "SemanticModel",
|
||||
"description": "Power BI semantic model."
|
||||
},
|
||||
{
|
||||
"value": "Lakehouse",
|
||||
"description": "A lakehouse."
|
||||
},
|
||||
{
|
||||
"value": "KQLDatabase",
|
||||
"description": "A KQL database."
|
||||
},
|
||||
{
|
||||
"value": "Warehouse",
|
||||
"description": "A warehouse."
|
||||
},
|
||||
{
|
||||
"value": "MirroredDatabase",
|
||||
"description": "A mirrored database."
|
||||
},
|
||||
{
|
||||
"value": "MirroredAzureDatabricksCatalog",
|
||||
"description": "A mirrored Azure Databricks catalog."
|
||||
},
|
||||
{
|
||||
"value": "GraphModel",
|
||||
"description": "A graph model."
|
||||
},
|
||||
{
|
||||
"value": "SQLDatabase",
|
||||
"description": "A SQL database."
|
||||
},
|
||||
{
|
||||
"value": "Ontology",
|
||||
"description": "An ontology."
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"ElementType": {
|
||||
"type": "string",
|
||||
"description": "The public type of a datasource schema element. Additional ElementType types may be added over time.",
|
||||
"enum": [
|
||||
"Root",
|
||||
"Files",
|
||||
"Directory",
|
||||
"Schemas",
|
||||
"Tables",
|
||||
"Views",
|
||||
"Functions",
|
||||
"ScalarFunctions",
|
||||
"TableValuedFunctions",
|
||||
"Shortcuts",
|
||||
"MaterializedViews",
|
||||
"Schema",
|
||||
"Table",
|
||||
"ExternalTable",
|
||||
"MaterializedView",
|
||||
"View",
|
||||
"Column",
|
||||
"Measure",
|
||||
"Function",
|
||||
"FunctionParameter",
|
||||
"FunctionReturnValue",
|
||||
"NodeType",
|
||||
"EdgeType",
|
||||
"Entity"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "ElementType",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "Root",
|
||||
"description": "The root element of a datasource schema tree."
|
||||
},
|
||||
{
|
||||
"value": "Files",
|
||||
"description": "A files container element."
|
||||
},
|
||||
{
|
||||
"value": "Directory",
|
||||
"description": "A directory element."
|
||||
},
|
||||
{
|
||||
"value": "Schemas",
|
||||
"description": "A grouping container for schema elements."
|
||||
},
|
||||
{
|
||||
"value": "Tables",
|
||||
"description": "A grouping container for table elements."
|
||||
},
|
||||
{
|
||||
"value": "Views",
|
||||
"description": "A grouping container for view elements."
|
||||
},
|
||||
{
|
||||
"value": "Functions",
|
||||
"description": "A grouping container for function elements."
|
||||
},
|
||||
{
|
||||
"value": "ScalarFunctions",
|
||||
"description": "A grouping container for scalar function elements."
|
||||
},
|
||||
{
|
||||
"value": "TableValuedFunctions",
|
||||
"description": "A grouping container for table-valued function elements."
|
||||
},
|
||||
{
|
||||
"value": "Shortcuts",
|
||||
"description": "A grouping container for shortcut elements."
|
||||
},
|
||||
{
|
||||
"value": "MaterializedViews",
|
||||
"description": "A grouping container for materialized view elements."
|
||||
},
|
||||
{
|
||||
"value": "Schema",
|
||||
"description": "A schema element."
|
||||
},
|
||||
{
|
||||
"value": "Table",
|
||||
"description": "A table element."
|
||||
},
|
||||
{
|
||||
"value": "ExternalTable",
|
||||
"description": "An external table element."
|
||||
},
|
||||
{
|
||||
"value": "MaterializedView",
|
||||
"description": "A materialized view element."
|
||||
},
|
||||
{
|
||||
"value": "View",
|
||||
"description": "A view element."
|
||||
},
|
||||
{
|
||||
"value": "Column",
|
||||
"description": "A column element."
|
||||
},
|
||||
{
|
||||
"value": "Measure",
|
||||
"description": "A measure element."
|
||||
},
|
||||
{
|
||||
"value": "Function",
|
||||
"description": "A function element."
|
||||
},
|
||||
{
|
||||
"value": "FunctionParameter",
|
||||
"description": "A function parameter element."
|
||||
},
|
||||
{
|
||||
"value": "FunctionReturnValue",
|
||||
"description": "A function return value element."
|
||||
},
|
||||
{
|
||||
"value": "NodeType",
|
||||
"description": "A graph node type element."
|
||||
},
|
||||
{
|
||||
"value": "EdgeType",
|
||||
"description": "A graph edge type element."
|
||||
},
|
||||
{
|
||||
"value": "Entity",
|
||||
"description": "An ontology entity element."
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"ElementState": {
|
||||
"type": "string",
|
||||
"description": "Indicates the current availability of the element in the datasource schema. Additional ElementState types may be added over time.",
|
||||
"enum": [
|
||||
"Available",
|
||||
"NotAvailable",
|
||||
"AccessDenied",
|
||||
"AccessDeniedOap",
|
||||
"DatasourceNotFound",
|
||||
"SchemaUnavailable"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "ElementState",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "Available",
|
||||
"description": "The element is available in the datasource schema."
|
||||
},
|
||||
{
|
||||
"value": "NotAvailable",
|
||||
"description": "The element was previously configured but is no longer available in the datasource schema."
|
||||
},
|
||||
{
|
||||
"value": "AccessDenied",
|
||||
"description": "The datasource schema could not be read because access was denied."
|
||||
},
|
||||
{
|
||||
"value": "AccessDeniedOap",
|
||||
"description": "The datasource schema could not be read because access is blocked by an organizational access policy."
|
||||
},
|
||||
{
|
||||
"value": "DatasourceNotFound",
|
||||
"description": "The datasource could not be found."
|
||||
},
|
||||
{
|
||||
"value": "SchemaUnavailable",
|
||||
"description": "The datasource schema is currently unavailable."
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"IndexState": {
|
||||
"type": "string",
|
||||
"description": "Index state for lakehouse file directories. Additional IndexState types may be added over time.",
|
||||
"enum": [
|
||||
"Indexed",
|
||||
"Indexing",
|
||||
"NotIndexed"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "IndexState",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "Indexed",
|
||||
"description": "Directory has been indexed for unstructured search."
|
||||
},
|
||||
{
|
||||
"value": "Indexing",
|
||||
"description": "Directory is currently being indexed."
|
||||
},
|
||||
{
|
||||
"value": "NotIndexed",
|
||||
"description": "Directory has not been indexed."
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"FewshotValidationStatus": {
|
||||
"description": "The validation status of a fewshot.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"value"
|
||||
],
|
||||
"properties": {
|
||||
"value": {
|
||||
"description": "The validation result.",
|
||||
"$ref": "#/definitions/FewshotValidationStatusValue"
|
||||
},
|
||||
"reason": {
|
||||
"description": "The reason for the current validation status, when available.",
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"FewshotValidationStatusValue": {
|
||||
"type": "string",
|
||||
"description": "The validation result for a fewshot. Additional FewshotValidationStatusValue types may be added over time.",
|
||||
"enum": [
|
||||
"Validating",
|
||||
"Valid",
|
||||
"Invalid"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "FewshotValidationStatusValue",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "Validating",
|
||||
"description": "Validation is currently in progress."
|
||||
},
|
||||
{
|
||||
"value": "Valid",
|
||||
"description": "Query has been validated successfully."
|
||||
},
|
||||
{
|
||||
"value": "Invalid",
|
||||
"description": "Query failed validation."
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,37 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
|
||||
"dataAgentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
|
||||
"createDataAgentDatasourceRequest": {
|
||||
"type": "LakehouseTables",
|
||||
"lakehouseReference": {
|
||||
"referenceType": "ById",
|
||||
"itemId": "b5e7c3a1-2d4f-4890-9a1b-3c5d7e9f0a2b",
|
||||
"workspaceId": "e1f2a3b4-5c6d-7e8f-9a0b-1c2d3e4f5a6b"
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"201": {
|
||||
"body": {
|
||||
"id": "c1c6d12f-8d2a-4d5b-9ca1-8bb7b42d4a30",
|
||||
"instructions": "Use this for customer engagement analysis.",
|
||||
"type": "LakehouseTables",
|
||||
"displayName": "CustomerLakehouse",
|
||||
"description": "Customer interaction history and support activity.",
|
||||
"lakehouseReference": {
|
||||
"referenceType": "ById",
|
||||
"itemId": "b5e7c3a1-2d4f-4890-9a1b-3c5d7e9f0a2b",
|
||||
"workspaceId": "e1f2a3b4-5c6d-7e8f-9a0b-1c2d3e4f5a6b"
|
||||
}
|
||||
}
|
||||
},
|
||||
"202": {
|
||||
"headers": {
|
||||
"Location": "https://api.fabric.microsoft.com/v1/operations/65d59164-2ebd-4cac-9149-55612f8f5bb8",
|
||||
"x-ms-operation-id": "65d59164-2ebd-4cac-9149-55612f8f5bb8",
|
||||
"Retry-After": 30
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,23 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
|
||||
"dataAgentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
|
||||
"datasourceId": "c1c6d12f-8d2a-4d5b-9ca1-8bb7b42d4a30",
|
||||
"createDataAgentFewshotRequest": {
|
||||
"question": "What are the top 5 busiest pickup locations?",
|
||||
"query": "SELECT TOP 5 pickup_location, COUNT(*) as trip_count FROM dbo.Trip GROUP BY pickup_location ORDER BY trip_count DESC"
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"201": {
|
||||
"body": {
|
||||
"id": "d7a3b2c1-4e5f-6a7b-8c9d-0e1f2a3b4c5d",
|
||||
"question": "What are the top 5 busiest pickup locations?",
|
||||
"query": "SELECT TOP 5 pickup_location, COUNT(*) as trip_count FROM dbo.Trip GROUP BY pickup_location ORDER BY trip_count DESC",
|
||||
"validationStatus": {
|
||||
"value": "Validating"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,38 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
|
||||
"dataAgentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
|
||||
"createDataAgentDatasourceRequest": {
|
||||
"type": "FabricItem",
|
||||
"itemReference": {
|
||||
"referenceType": "ById",
|
||||
"itemId": "01234372-7fd9-44d3-bd75-a2718645a82a",
|
||||
"workspaceId": "abdd0d48-2eed-4066-adc4-321a9f6a628e"
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"201": {
|
||||
"body": {
|
||||
"id": "70f9282b-1b64-4f08-9e4e-2ab9f0e20e01",
|
||||
"instructions": "Use this for document retrieval queries.",
|
||||
"type": "FabricItem",
|
||||
"displayName": "SalesWarehouse",
|
||||
"description": "Sales data warehouse with order and customer information.",
|
||||
"itemReference": {
|
||||
"referenceType": "ById",
|
||||
"itemId": "01234372-7fd9-44d3-bd75-a2718645a82a",
|
||||
"workspaceId": "abdd0d48-2eed-4066-adc4-321a9f6a628e"
|
||||
},
|
||||
"fabricItemType": "Warehouse"
|
||||
}
|
||||
},
|
||||
"202": {
|
||||
"headers": {
|
||||
"Location": "https://api.fabric.microsoft.com/v1/operations/91d594a7-e8d7-487f-9dfb-f40f6d3318d2",
|
||||
"x-ms-operation-id": "91d594a7-e8d7-487f-9dfb-f40f6d3318d2",
|
||||
"Retry-After": 30
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,10 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
|
||||
"dataAgentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
|
||||
"datasourceId": "c1c6d12f-8d2a-4d5b-9ca1-8bb7b42d4a30"
|
||||
},
|
||||
"responses": {
|
||||
"200": {}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,10 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
|
||||
"dataAgentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
|
||||
"datasourceId": "70f9282b-1b64-4f08-9e4e-2ab9f0e20e01"
|
||||
},
|
||||
"responses": {
|
||||
"200": {}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,11 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
|
||||
"dataAgentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
|
||||
"datasourceId": "c1c6d12f-8d2a-4d5b-9ca1-8bb7b42d4a30",
|
||||
"id": "U2NoZW1hcy9kYm8vVGFibGVzL1RyaXA="
|
||||
},
|
||||
"responses": {
|
||||
"200": {}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,11 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
|
||||
"dataAgentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
|
||||
"datasourceId": "c1c6d12f-8d2a-4d5b-9ca1-8bb7b42d4a30",
|
||||
"fewShotId": "c3f5e2a1-9b8d-4f7e-a6b2-1d0c8e3f9a5b"
|
||||
},
|
||||
"responses": {
|
||||
"200": {}
|
||||
}
|
||||
}
|
||||
@@ -11,6 +11,9 @@
|
||||
"description": "A DataAgent description.",
|
||||
"type": "DataAgent",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"properties": {
|
||||
"publishedDescription": "Published via API"
|
||||
},
|
||||
"sensitivityLabel": {
|
||||
"id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
|
||||
}
|
||||
|
||||
@@ -0,0 +1,24 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
|
||||
"dataAgentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
|
||||
"datasourceId": "70f9282b-1b64-4f08-9e4e-2ab9f0e20e01"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"id": "70f9282b-1b64-4f08-9e4e-2ab9f0e20e01",
|
||||
"instructions": "Use this for document retrieval queries.",
|
||||
"type": "FabricItem",
|
||||
"displayName": "SalesWarehouse",
|
||||
"description": "Sales data warehouse with order and customer information.",
|
||||
"itemReference": {
|
||||
"referenceType": "ById",
|
||||
"itemId": "01234372-7fd9-44d3-bd75-a2718645a82a",
|
||||
"workspaceId": "abdd0d48-2eed-4066-adc4-321a9f6a628e"
|
||||
},
|
||||
"fabricItemType": "Warehouse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,21 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
|
||||
"dataAgentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
|
||||
"datasourceId": "c1c6d12f-8d2a-4d5b-9ca1-8bb7b42d4a30",
|
||||
"fewShotId": "c3f5e2a1-9b8d-4f7e-a6b2-1d0c8e3f9a5b"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"id": "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
|
||||
"question": "What are the top 5 busiest pickup locations?",
|
||||
"query": "SELECT TOP 5 pickup_location_name, COUNT(*) as trip_count FROM dbo.Trip GROUP BY pickup_location_name ORDER BY trip_count DESC",
|
||||
"validationStatus": {
|
||||
"value": "Invalid",
|
||||
"reason": "Column 'pickup_location_name' does not exist in dbo.Trip."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,13 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
|
||||
"dataAgentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"aiInstructions": "Always respond in English. Be concise."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,24 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
|
||||
"dataAgentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
|
||||
"datasourceId": "70f9282b-1b64-4f08-9e4e-2ab9f0e20e01"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"id": "70f9282b-1b64-4f08-9e4e-2ab9f0e20e01",
|
||||
"instructions": "Use this for document retrieval queries.",
|
||||
"type": "FabricItem",
|
||||
"displayName": "SalesWarehouse",
|
||||
"description": "Sales data warehouse with order and customer information.",
|
||||
"itemReference": {
|
||||
"referenceType": "ById",
|
||||
"itemId": "01234372-7fd9-44d3-bd75-a2718645a82a",
|
||||
"workspaceId": "abdd0d48-2eed-4066-adc4-321a9f6a628e"
|
||||
},
|
||||
"fabricItemType": "Warehouse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,21 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
|
||||
"dataAgentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
|
||||
"datasourceId": "c1c6d12f-8d2a-4d5b-9ca1-8bb7b42d4a30",
|
||||
"fewShotId": "c3f5e2a1-9b8d-4f7e-a6b2-1d0c8e3f9a5b"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"id": "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
|
||||
"question": "What are the top 5 busiest pickup locations?",
|
||||
"query": "SELECT TOP 5 pickup_location_name, COUNT(*) as trip_count FROM dbo.Trip GROUP BY pickup_location_name ORDER BY trip_count DESC",
|
||||
"validationStatus": {
|
||||
"value": "Invalid",
|
||||
"reason": "Column 'pickup_location_name' does not exist in dbo.Trip."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,13 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
|
||||
"dataAgentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"aiInstructions": "Always respond in English. Be concise."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -12,6 +12,9 @@
|
||||
"description": "A DataAgent description.",
|
||||
"type": "DataAgent",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"properties": {
|
||||
"publishedDescription": "Published via API"
|
||||
},
|
||||
"sensitivityLabel": {
|
||||
"id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
|
||||
}
|
||||
|
||||
@@ -0,0 +1,35 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
|
||||
"dataAgentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
|
||||
"datasourceId": "c1c6d12f-8d2a-4d5b-9ca1-8bb7b42d4a30"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"value": [
|
||||
{
|
||||
"id": "U2NoZW1hcw==",
|
||||
"isSelected": false,
|
||||
"displayName": "Schemas",
|
||||
"type": "Schemas",
|
||||
"hasSubElements": true,
|
||||
"state": "Available",
|
||||
"lastSyncDateTime": "2025-06-15T10:30:00Z"
|
||||
},
|
||||
{
|
||||
"id": "VGFibGVz",
|
||||
"isSelected": false,
|
||||
"displayName": "Tables",
|
||||
"type": "Tables",
|
||||
"hasSubElements": true,
|
||||
"state": "Available",
|
||||
"lastSyncDateTime": "2025-06-15T10:30:00Z"
|
||||
}
|
||||
],
|
||||
"continuationToken": null,
|
||||
"continuationUri": null
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,34 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
|
||||
"dataAgentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
|
||||
"datasourceId": "c1c6d12f-8d2a-4d5b-9ca1-8bb7b42d4a30"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"value": [
|
||||
{
|
||||
"id": "c3f5e2a1-9b8d-4f7e-a6b2-1d0c8e3f9a5b",
|
||||
"question": "How many trips were there in January?",
|
||||
"query": "SELECT COUNT(*) FROM dbo.Trip WHERE MONTH(start_date) = 1",
|
||||
"validationStatus": {
|
||||
"value": "Valid"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
|
||||
"question": "What are the top 5 busiest pickup locations?",
|
||||
"query": "SELECT TOP 5 pickup_location_name, COUNT(*) as trip_count FROM dbo.Trip GROUP BY pickup_location_name ORDER BY trip_count DESC",
|
||||
"validationStatus": {
|
||||
"value": "Invalid",
|
||||
"reason": "Column 'pickup_location_name' does not exist in dbo.Trip."
|
||||
}
|
||||
}
|
||||
],
|
||||
"continuationToken": null,
|
||||
"continuationUri": null
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,41 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
|
||||
"dataAgentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"value": [
|
||||
{
|
||||
"id": "70f9282b-1b64-4f08-9e4e-2ab9f0e20e01",
|
||||
"instructions": "Use this for document retrieval queries.",
|
||||
"type": "FabricItem",
|
||||
"displayName": "SalesWarehouse",
|
||||
"description": "Sales data warehouse with order and customer information.",
|
||||
"itemReference": {
|
||||
"referenceType": "ById",
|
||||
"itemId": "01234372-7fd9-44d3-bd75-a2718645a82a",
|
||||
"workspaceId": "abdd0d48-2eed-4066-adc4-321a9f6a628e"
|
||||
},
|
||||
"fabricItemType": "Warehouse"
|
||||
},
|
||||
{
|
||||
"id": "c1c6d12f-8d2a-4d5b-9ca1-8bb7b42d4a30",
|
||||
"instructions": "Use this for customer engagement analysis.",
|
||||
"type": "LakehouseTables",
|
||||
"displayName": "CustomerLakehouse",
|
||||
"description": "Customer interaction history and support activity.",
|
||||
"lakehouseReference": {
|
||||
"referenceType": "ById",
|
||||
"itemId": "b5e7c3a1-2d4f-4890-9a1b-3c5d7e9f0a2b",
|
||||
"workspaceId": "e1f2a3b4-5c6d-7e8f-9a0b-1c2d3e4f5a6b"
|
||||
}
|
||||
}
|
||||
],
|
||||
"continuationToken": null,
|
||||
"continuationUri": null
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,35 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
|
||||
"dataAgentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
|
||||
"datasourceId": "c1c6d12f-8d2a-4d5b-9ca1-8bb7b42d4a30"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"value": [
|
||||
{
|
||||
"id": "U2NoZW1hcw==",
|
||||
"isSelected": false,
|
||||
"displayName": "Schemas",
|
||||
"type": "Schemas",
|
||||
"hasSubElements": true,
|
||||
"state": "Available",
|
||||
"lastSyncDateTime": "2025-06-15T10:30:00Z"
|
||||
},
|
||||
{
|
||||
"id": "VGFibGVz",
|
||||
"isSelected": false,
|
||||
"displayName": "Tables",
|
||||
"type": "Tables",
|
||||
"hasSubElements": true,
|
||||
"state": "Available",
|
||||
"lastSyncDateTime": "2025-06-15T10:30:00Z"
|
||||
}
|
||||
],
|
||||
"continuationToken": null,
|
||||
"continuationUri": null
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,34 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
|
||||
"dataAgentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
|
||||
"datasourceId": "c1c6d12f-8d2a-4d5b-9ca1-8bb7b42d4a30"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"value": [
|
||||
{
|
||||
"id": "c3f5e2a1-9b8d-4f7e-a6b2-1d0c8e3f9a5b",
|
||||
"question": "How many trips were there in January?",
|
||||
"query": "SELECT COUNT(*) FROM dbo.Trip WHERE MONTH(start_date) = 1",
|
||||
"validationStatus": {
|
||||
"value": "Valid"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
|
||||
"question": "What are the top 5 busiest pickup locations?",
|
||||
"query": "SELECT TOP 5 pickup_location_name, COUNT(*) as trip_count FROM dbo.Trip GROUP BY pickup_location_name ORDER BY trip_count DESC",
|
||||
"validationStatus": {
|
||||
"value": "Invalid",
|
||||
"reason": "Column 'pickup_location_name' does not exist in dbo.Trip."
|
||||
}
|
||||
}
|
||||
],
|
||||
"continuationToken": null,
|
||||
"continuationUri": null
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,41 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
|
||||
"dataAgentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"value": [
|
||||
{
|
||||
"id": "70f9282b-1b64-4f08-9e4e-2ab9f0e20e01",
|
||||
"instructions": "Use this for document retrieval queries.",
|
||||
"type": "FabricItem",
|
||||
"displayName": "SalesWarehouse",
|
||||
"description": "Sales data warehouse with order and customer information.",
|
||||
"itemReference": {
|
||||
"referenceType": "ById",
|
||||
"itemId": "01234372-7fd9-44d3-bd75-a2718645a82a",
|
||||
"workspaceId": "abdd0d48-2eed-4066-adc4-321a9f6a628e"
|
||||
},
|
||||
"fabricItemType": "Warehouse"
|
||||
},
|
||||
{
|
||||
"id": "c1c6d12f-8d2a-4d5b-9ca1-8bb7b42d4a30",
|
||||
"instructions": "Use this for customer engagement analysis.",
|
||||
"type": "LakehouseTables",
|
||||
"displayName": "CustomerLakehouse",
|
||||
"description": "Customer interaction history and support activity.",
|
||||
"lakehouseReference": {
|
||||
"referenceType": "ById",
|
||||
"itemId": "b5e7c3a1-2d4f-4890-9a1b-3c5d7e9f0a2b",
|
||||
"workspaceId": "e1f2a3b4-5c6d-7e8f-9a0b-1c2d3e4f5a6b"
|
||||
}
|
||||
}
|
||||
],
|
||||
"continuationToken": null,
|
||||
"continuationUri": null
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,16 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
|
||||
"dataAgentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
|
||||
"publishDataAgentRequest": {
|
||||
"publishedDescription": "Production release v2 with improved instructions"
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"publishedDescription": "Production release v2 with improved instructions"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
|
||||
"dataAgentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
|
||||
},
|
||||
"responses": {
|
||||
"200": {}
|
||||
}
|
||||
}
|
||||
@@ -2,7 +2,7 @@
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"dataAgentId": "5b218778-e7a5-4d73-8187-f10824047715",
|
||||
"updateMetadata" : true,
|
||||
"updateMetadata": true,
|
||||
"updateDataAgentDefinitionRequest": {
|
||||
"definition": {
|
||||
"parts": [
|
||||
@@ -21,8 +21,7 @@
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
},
|
||||
"200": {},
|
||||
"202": {
|
||||
"headers": {
|
||||
"Location": "https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef",
|
||||
|
||||
@@ -0,0 +1,28 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
|
||||
"dataAgentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
|
||||
"datasourceId": "70f9282b-1b64-4f08-9e4e-2ab9f0e20e01",
|
||||
"updateDataAgentDatasourceRequest": {
|
||||
"instructions": "Use this for document retrieval queries.",
|
||||
"description": "Sales data warehouse with order and customer information."
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"id": "70f9282b-1b64-4f08-9e4e-2ab9f0e20e01",
|
||||
"instructions": "Use this for document retrieval queries.",
|
||||
"type": "FabricItem",
|
||||
"displayName": "SalesWarehouse",
|
||||
"description": "Sales data warehouse with order and customer information.",
|
||||
"itemReference": {
|
||||
"referenceType": "ById",
|
||||
"itemId": "01234372-7fd9-44d3-bd75-a2718645a82a",
|
||||
"workspaceId": "abdd0d48-2eed-4066-adc4-321a9f6a628e"
|
||||
},
|
||||
"fabricItemType": "Warehouse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,24 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
|
||||
"dataAgentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
|
||||
"datasourceId": "c1c6d12f-8d2a-4d5b-9ca1-8bb7b42d4a30",
|
||||
"updateDataSourceElementRequest": {
|
||||
"isSelected": true
|
||||
},
|
||||
"id": "U2NoZW1hcy9kYm8vVGFibGVzL1RyaXA="
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"id": "U2NoZW1hcy9kYm8vVGFibGVzL1RyaXA=",
|
||||
"isSelected": true,
|
||||
"displayName": "Trip",
|
||||
"type": "Table",
|
||||
"hasSubElements": true,
|
||||
"state": "Available",
|
||||
"lastSyncDateTime": "2025-06-15T10:30:00Z"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,23 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
|
||||
"dataAgentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
|
||||
"datasourceId": "c1c6d12f-8d2a-4d5b-9ca1-8bb7b42d4a30",
|
||||
"fewShotId": "c3f5e2a1-9b8d-4f7e-a6b2-1d0c8e3f9a5b",
|
||||
"updateDataAgentFewshotRequest": {
|
||||
"query": "SELECT COUNT(*) FROM dbo.Trip WHERE MONTH(start_date) = 1 AND YEAR(start_date) = 2024"
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"id": "c3f5e2a1-9b8d-4f7e-a6b2-1d0c8e3f9a5b",
|
||||
"question": "How many trips were there in January?",
|
||||
"query": "SELECT COUNT(*) FROM dbo.Trip WHERE MONTH(start_date) = 1 AND YEAR(start_date) = 2024",
|
||||
"validationStatus": {
|
||||
"value": "Validating"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,16 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
|
||||
"dataAgentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
|
||||
"updateDataAgentSettingsRequest": {
|
||||
"aiInstructions": "Always respond in Spanish."
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"aiInstructions": "Always respond in Spanish."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
File diff suppressed because it is too large.
Load diff
@@ -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 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",
|
||||
"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. Currently supported values: `application/vnd.apache.arrow.stream;pq-arrow-version=1` (default), `application/vnd.apache.arrow.stream;pq-arrow-version=2`.",
|
||||
"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 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'.",
|
||||
"schema": {
|
||||
"type": "file"
|
||||
}
|
||||
|
||||
@@ -760,7 +760,7 @@
|
||||
"/workspaces/{workspaceId}/lakehouses/{lakehouseId}/jobs/refreshMaterializedLakeViews/schedules": {
|
||||
"post": {
|
||||
"summary": "Create a new Refresh MaterializedLakeViews schedule for a lakehouse.",
|
||||
"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## Required Delegated Scopes: \n\n(Lakehouse.Execute.All or Item.Execute.All) and (Lakehouse.ReadWrite.All or Item.ReadWrite.All)\n\n## Limitations \n- A lakehouse can create maximum 20 schedulers.\n- Materialized Lake View supports only one active refresh schedule per lineage.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
|
||||
"description": "> [!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## Required Delegated Scopes: \n\n(Lakehouse.Execute.All or Item.Execute.All) and (Lakehouse.ReadWrite.All or Item.ReadWrite.All)\n\n## Limitations \n- A lakehouse can create maximum 20 schedulers.\n- Materialized Lake View supports only one active refresh schedule per lineage.\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": [
|
||||
"BackgroundJobs"
|
||||
],
|
||||
@@ -1092,7 +1092,7 @@
|
||||
"/workspaces/{workspaceId}/lakehouses/{lakehouseId}/jobs/refreshMaterializedLakeViews/instances": {
|
||||
"post": {
|
||||
"summary": "Run on-demand [Refresh MaterializedLakeViews](/fabric/data-engineering/materialized-lake-views/refresh-materialized-lake-view) job instance.",
|
||||
"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> [!NOTE]\n> The URL for this API has been updated to include the job type as part of the path, replacing the previous use of a query parameter. For backward compatibility, invocations using the query parameter are still supported.\n\n## Required Delegated Scopes\n\nLakehouse.Execute.All or Item.Execute.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) | No |\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\n> [!NOTE]\n> The URL for this API has been updated to include the job type as part of the path, replacing the previous use of a query parameter. For backward compatibility, invocations using the query parameter are still supported.\n\n## Required Delegated Scopes\n\nLakehouse.Execute.All or Item.Execute.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": [
|
||||
"BackgroundJobs"
|
||||
],
|
||||
@@ -1152,7 +1152,7 @@
|
||||
"/workspaces/{workspaceId}/lakehouses/{lakehouseId}/jobs/refreshMaterializedLakeViews/schedules/{scheduleId}": {
|
||||
"patch": {
|
||||
"summary": "Update an existing Refresh MaterializedLakeViews schedule for a lakehouse.",
|
||||
"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## Required Delegated Scopes: \n\n(Lakehouse.Execute.All or Item.Execute.All) and (Lakehouse.ReadWrite.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) | No |\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\n## Required Delegated Scopes: \n\n(Lakehouse.Execute.All or Item.Execute.All) and (Lakehouse.ReadWrite.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": [
|
||||
"BackgroundJobs"
|
||||
],
|
||||
@@ -1233,7 +1233,7 @@
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Delete an existing Refresh MaterializedLakeViews schedule for a lakehouse.",
|
||||
"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## Required Delegated Scopes\n\nLakehouse.ReadWrite.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) | No |\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\n## Required Delegated Scopes\n\nLakehouse.ReadWrite.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": [
|
||||
"BackgroundJobs"
|
||||
],
|
||||
|
||||
@@ -35,6 +35,96 @@
|
||||
}
|
||||
]
|
||||
},
|
||||
"CreatePaginatedReportRequest": {
|
||||
"description": "The request payload to create a paginated report.",
|
||||
"required": [
|
||||
"displayName",
|
||||
"definition"
|
||||
],
|
||||
"properties": {
|
||||
"displayName": {
|
||||
"description": "The paginated report display name. The display name must follow naming rules according to item type.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"description": {
|
||||
"description": "The paginated report description. Maximum length is 256 characters.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"definition": {
|
||||
"description": "The paginated report public definition.",
|
||||
"$ref": "#/definitions/PaginatedReportDefinition",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdatePaginatedReportDefinitionRequest": {
|
||||
"description": "Update paginated report public definition request payload.",
|
||||
"required": [
|
||||
"definition"
|
||||
],
|
||||
"properties": {
|
||||
"definition": {
|
||||
"$ref": "#/definitions/PaginatedReportDefinition"
|
||||
}
|
||||
}
|
||||
},
|
||||
"PaginatedReportDefinitionResponse": {
|
||||
"description": "Paginated report public definition response.",
|
||||
"required": [
|
||||
"definition"
|
||||
],
|
||||
"properties": {
|
||||
"definition": {
|
||||
"$ref": "#/definitions/PaginatedReportDefinition",
|
||||
"readOnly": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"PaginatedReportDefinition": {
|
||||
"description": "Paginated report public definition object. Refer to this [article](/rest/api/fabric/articles/item-management/definitions/paginatedreport-definition.md) for more details on the structure of the Paginated Report definition.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"parts"
|
||||
],
|
||||
"properties": {
|
||||
"format": {
|
||||
"description": "The format of the paginated report definition. Supported format: `PaginatedReportDefinition`. Additional format types may be added over time.",
|
||||
"$ref": "#/definitions/PaginatedReportDefinitionFormat",
|
||||
"readOnly": false
|
||||
},
|
||||
"parts": {
|
||||
"description": "A list of definition parts.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/PaginatedReportDefinitionPart"
|
||||
},
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"PaginatedReportDefinitionPart": {
|
||||
"description": "Paginated report definition part object.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"path": {
|
||||
"description": "The paginated report part path (e.g., `ContosoReport.rdl`, `.platform`).",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"payload": {
|
||||
"description": "The paginated report part payload.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"payloadType": {
|
||||
"description": "The payload type.",
|
||||
"$ref": "../common/definitions.json#/definitions/PayloadType",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdatePaginatedReportRequest": {
|
||||
"description": "Update paginated report request.",
|
||||
"properties": {
|
||||
@@ -49,6 +139,21 @@
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"PaginatedReportDefinitionFormat": {
|
||||
"type": "string",
|
||||
"description": "The format of the paginated report definition. Additional format types may be added over time.",
|
||||
"enum": ["PaginatedReportDefinition"],
|
||||
"x-ms-enum": {
|
||||
"name": "PaginatedReportDefinitionFormat",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "PaginatedReportDefinition",
|
||||
"description": "The default format for paginated report definitions. The definition contains an RDL file encoded as Base64."
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,37 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"createPaginatedReportRequest": {
|
||||
"displayName": "ContosoReport",
|
||||
"description": "A quarterly sales report.",
|
||||
"definition": {
|
||||
"format": "PaginatedReportDefinition",
|
||||
"parts": [
|
||||
{
|
||||
"path": "ContosoReport.rdl",
|
||||
"payload": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4...",
|
||||
"payloadType": "InlineBase64"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"201": {
|
||||
"body": {
|
||||
"displayName": "ContosoReport",
|
||||
"description": "A quarterly sales report.",
|
||||
"type": "PaginatedReport",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"id": "cfafbeb1-8037-4d0c-896e-28c4f2e65573"
|
||||
}
|
||||
},
|
||||
"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
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"paginatedReportId": "cfafbeb1-8037-4d0c-896e-28c4f2e65573"
|
||||
},
|
||||
"responses": {
|
||||
"200": {}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,17 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"paginatedReportId": "cfafbeb1-8037-4d0c-896e-28c4f2e65573"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"displayName": "ContosoReport",
|
||||
"description": "A quarterly sales report.",
|
||||
"type": "PaginatedReport",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"id": "cfafbeb1-8037-4d0c-896e-28c4f2e65573"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,34 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"paginatedReportId": "cfafbeb1-8037-4d0c-896e-28c4f2e65573",
|
||||
"format": "PaginatedReportDefinition"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"definition": {
|
||||
"parts": [
|
||||
{
|
||||
"path": "ContosoReport.rdl",
|
||||
"payload": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4...",
|
||||
"payloadType": "InlineBase64"
|
||||
},
|
||||
{
|
||||
"path": ".platform",
|
||||
"payload": "eyJtZXRhZGF0YSI6eyJ0eXBlIjoiUGFnaW5hdGVkUmVwb3J0In19",
|
||||
"payloadType": "InlineBase64"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"202": {
|
||||
"headers": {
|
||||
"Location": "https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
|
||||
"x-ms-operation-id": "431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
|
||||
"Retry-After": 30
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,34 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"paginatedReportId": "cfafbeb1-8037-4d0c-896e-28c4f2e65573",
|
||||
"updateMetadata": true,
|
||||
"updatePaginatedReportDefinitionRequest": {
|
||||
"definition": {
|
||||
"format": "PaginatedReportDefinition",
|
||||
"parts": [
|
||||
{
|
||||
"path": "ContosoReport.rdl",
|
||||
"payload": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4...",
|
||||
"payloadType": "InlineBase64"
|
||||
},
|
||||
{
|
||||
"path": ".platform",
|
||||
"payload": "eyJtZXRhZGF0YSI6eyJ0eXBlIjoiUGFnaW5hdGVkUmVwb3J0In19",
|
||||
"payloadType": "InlineBase64"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {},
|
||||
"202": {
|
||||
"headers": {
|
||||
"Location": "https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef",
|
||||
"x-ms-operation-id": "427f6c34-b64e-4ee4-8ea5-b533c0e203ef",
|
||||
"Retry-After": 30
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -88,9 +88,154 @@
|
||||
"$ref": "./examples/ListPaginatedReportsInWorkspace.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"post": {
|
||||
"summary": "Creates a paginated report in the specified workspace.",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nTo create a paginated report with a definition, refer to the [Paginated Report definition](/rest/api/fabric/articles/item-management/definitions/paginated-report-definition) article.\n\n## Permissions\n\nThe caller must have a *contributor* workspace role.\n\n## Required Delegated Scopes\n\nPaginatedReport.ReadWrite.All or Item.ReadWrite.All\n\n## Limitations\n\n- Creating a paginated report in a subfolder is not supported. The paginated report is created at the workspace root level. To place a paginated report in a subfolder, use the Update Definition API which supports subfolders.\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_CreatePaginatedReport",
|
||||
"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": "createPaginatedReportRequest",
|
||||
"description": "Create paginated report request payload.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/CreatePaginatedReportRequest"
|
||||
},
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"201": {
|
||||
"description": "Successfully created",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/PaginatedReport"
|
||||
}
|
||||
},
|
||||
"202": {
|
||||
"description": "Request accepted, paginated report 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 a paginated report example": {
|
||||
"$ref": "./examples/CreatePaginatedReport.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/paginatedReports/{paginatedReportId}": {
|
||||
"get": {
|
||||
"summary": "Returns properties of the specified paginated report.",
|
||||
"description": "## Permissions\n\nThe caller must have *read* permissions for the paginated report.\n\n## Required Delegated Scopes\n\nPaginatedReport.Read.All or PaginatedReport.ReadWrite.All or 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_GetPaginatedReport",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "workspaceId",
|
||||
"description": "The workspace ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "paginatedReportId",
|
||||
"description": "The paginated report ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/PaginatedReport"
|
||||
}
|
||||
},
|
||||
"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 a paginated report example": {
|
||||
"$ref": "./examples/GetPaginatedReport.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"patch": {
|
||||
"summary": "Updates the properties of the specified paginated report.",
|
||||
"description": "## Permissions\n\n The caller must have *read and write* permissions for the paginated report. \n\n## Required Delegated Scopes \n\n PaginatedReport.ReadWrite.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",
|
||||
@@ -163,6 +308,248 @@
|
||||
"$ref": "./examples/UpdatePaginatedReport.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Deletes the specified paginated report.",
|
||||
"description": "## Permissions\n\n The caller must have *write* permissions for the paginated report. \n\n## Required Delegated Scopes \n\n PaginatedReport.ReadWrite.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_DeletePaginatedReport",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "workspaceId",
|
||||
"description": "The workspace ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "paginatedReportId",
|
||||
"description": "The paginated report 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.\n\n* InsufficientWorkspaceRole - User doesn't have sufficient workspace role.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Delete a paginated report example": {
|
||||
"$ref": "./examples/DeletePaginatedReport.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/paginatedReports/{paginatedReportId}/getDefinition": {
|
||||
"post": {
|
||||
"summary": "Returns the specified paginated report public definition.",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\n The caller must have *read and write* permissions for the paginated report. \n\n## Required Delegated Scopes \n\n PaginatedReport.ReadWrite.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_GetPaginatedReportDefinition",
|
||||
"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": "path",
|
||||
"name": "paginatedReportId",
|
||||
"description": "The paginated report ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "format",
|
||||
"description": "The format of the paginated report public definition. Supported format: `PaginatedReportDefinition`. If not provided, `PaginatedReportDefinition` is used.",
|
||||
"type": "string",
|
||||
"required": false
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/PaginatedReportDefinitionResponse"
|
||||
}
|
||||
},
|
||||
"202": {
|
||||
"description": "Request accepted. Retrieving the definition is 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* OperationNotSupportedForItem - Operation not supported for requested item.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Get a paginated report definition example": {
|
||||
"$ref": "./examples/GetPaginatedReportDefinition.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/paginatedReports/{paginatedReportId}/updateDefinition": {
|
||||
"post": {
|
||||
"summary": "Overrides the definition for the specified paginated report.",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\n The caller must have *read and write* permissions for the paginated report. \n\n## Required Delegated Scopes \n\n PaginatedReport.ReadWrite.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_UpdatePaginatedReportDefinition",
|
||||
"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": "path",
|
||||
"name": "paginatedReportId",
|
||||
"description": "The paginated report ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "updateMetadata",
|
||||
"description": "When set to `true` and the `.platform` file is provided as part of the definition, the item's metadata is updated using the metadata from the `.platform` file.",
|
||||
"type": "boolean",
|
||||
"required": false
|
||||
},
|
||||
{
|
||||
"in": "body",
|
||||
"name": "updatePaginatedReportDefinitionRequest",
|
||||
"description": "Update paginated report definition request payload.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/UpdatePaginatedReportDefinitionRequest"
|
||||
},
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully."
|
||||
},
|
||||
"202": {
|
||||
"description": "Request accepted. Update definition is 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* OperationNotSupportedForItem - Operation not supported for requested item. \n\n* CorruptedPayload - The provided payload is corrupted.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Update a paginated report definition example": {
|
||||
"$ref": "./examples/UpdatePaginatedReportDefinition.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
|
||||
@@ -0,0 +1,155 @@
|
||||
{
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"title": "Workspace CMK Encryption data types",
|
||||
"version": "v1"
|
||||
},
|
||||
"paths": {},
|
||||
"definitions": {
|
||||
"Encryption": {
|
||||
"description": "Workspace encryption details using a customer-managed key (CMK).",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"keyIdentifier": {
|
||||
"description": "The encryption key identifier.",
|
||||
"type": "string"
|
||||
},
|
||||
"status": {
|
||||
"description": "The CMK encryption status of the workspace.",
|
||||
"$ref": "#/definitions/EncryptionStatus"
|
||||
},
|
||||
"previousKeyIdentifier": {
|
||||
"description": "The previous encryption key identifier.",
|
||||
"type": "string"
|
||||
},
|
||||
"previousStatus": {
|
||||
"description": "The previous CMK encryption status of the workspace.",
|
||||
"$ref": "#/definitions/EncryptionStatus"
|
||||
}
|
||||
}
|
||||
},
|
||||
"AssignWorkspaceEncryptionRequest": {
|
||||
"description": "The Assign Workspace CMK Encryption request payload.",
|
||||
"required": [
|
||||
"keyIdentifier"
|
||||
],
|
||||
"properties": {
|
||||
"keyIdentifier": {
|
||||
"description": "The Azure Key Vault key identifier. This must be a versionless key URI.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"WorkspaceEncryptionDetail": {
|
||||
"description": "Workspace encryption settings and status details.",
|
||||
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"encryptionDetail": {
|
||||
"description": "The workspace encryption detail.",
|
||||
"$ref": "#/definitions/EncryptionDetail"
|
||||
},
|
||||
"previousEncryptionDetail": {
|
||||
"description": "The previous workspace encryption detail.",
|
||||
"$ref": "#/definitions/EncryptionDetail"
|
||||
},
|
||||
"workspaceEncryptionItemsDetails": {
|
||||
"description": "The encryption status of items in the workspace.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/WorkspaceEncryptionItemsDetail"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"EncryptionDetail": {
|
||||
"description": "Workspace encryption details.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"keyIdentifier": {
|
||||
"description": "The key identifier.",
|
||||
"type": "string"
|
||||
},
|
||||
"encryptionStatus": {
|
||||
"description": "The workspace encryption status.",
|
||||
"$ref": "#/definitions/EncryptionStatus"
|
||||
}
|
||||
}
|
||||
},
|
||||
"WorkspaceEncryptionItemsDetail": {
|
||||
|
||||
"description": "Encryption status details for items in the workspace.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"items": {
|
||||
"description": "The array of workspace item details.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/WorkspaceEncryptionItem"
|
||||
}
|
||||
},
|
||||
"encryptionStatus": {
|
||||
"description": "The encryption status for the items.",
|
||||
"$ref": "#/definitions/EncryptionStatus"
|
||||
}
|
||||
}
|
||||
},
|
||||
"WorkspaceEncryptionItem": {
|
||||
"description": "Workspace item details.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"displayName": {
|
||||
"description": "The item display name.",
|
||||
"type": "string"
|
||||
},
|
||||
"id": {
|
||||
"format": "uuid",
|
||||
"description": "The item Id.",
|
||||
"type": "string"
|
||||
},
|
||||
"type": {
|
||||
"description": "The item type.",
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"EncryptionStatus": {
|
||||
"type": "string",
|
||||
"description": "Workspace encryption status. Additional encryption status may be added over time.",
|
||||
"enum": [
|
||||
"Disabled",
|
||||
"Active",
|
||||
"EnableInProgress",
|
||||
"DisableInProgress",
|
||||
"Failed"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "WorkspaceEncryptionStatus",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "Disabled",
|
||||
"description": "Workspace encryption is not active."
|
||||
},
|
||||
{
|
||||
"value": "Active",
|
||||
"description": "Workspace encryption is active and the workspace is encrypted."
|
||||
},
|
||||
{
|
||||
"value": "EnableInProgress",
|
||||
"description": "Workspace encryption is enabling."
|
||||
},
|
||||
{
|
||||
"value": "DisableInProgress",
|
||||
"description": "Workspace encryption is disabling."
|
||||
},
|
||||
{
|
||||
"value": "Failed",
|
||||
"description": "Workspace encryption application failed."
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,13 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "47482db6-4583-4672-86dd-999d0f8f4d7a",
|
||||
"assignWorkspaceEncryptionRequest": {
|
||||
"keyIdentifier": "https://westus07112025-cmktest1.vault.azure.net/keys/test2k/"
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully."
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,39 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "47482db6-4583-4672-86dd-999d0f8f4d7a"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"encryptionDetail": {
|
||||
"keyIdentifier": "https://westus07112025-cmktest1.vault.azure.net/keys/test2k/",
|
||||
"encryptionStatus": "EnableInProgress"
|
||||
},
|
||||
"previousEncryptionDetail": {
|
||||
"keyIdentifier": "https://westus07112025-cmktest1.vault.azure.net/keys/key1/",
|
||||
"encryptionStatus": "Active"
|
||||
},
|
||||
"workspaceEncryptionItemsDetails": [
|
||||
{
|
||||
"items": [
|
||||
{
|
||||
"displayName": "copyjob1",
|
||||
"type": "CopyJob",
|
||||
"id": "9d922047-55a9-4737-8ec0-f34a320100bc"
|
||||
},
|
||||
{
|
||||
"displayName": "copyjob2",
|
||||
"type": "CopyJob",
|
||||
"id": "8d022047-55a9-4737-8ec0-f34a320100b7"
|
||||
}
|
||||
],
|
||||
"encryptionStatus": "EnableInProgress"
|
||||
}
|
||||
]
|
||||
},
|
||||
"headers": {
|
||||
"Retry-After": 900
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,15 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "47482db6-4583-4672-86dd-999d0f8f4d7a"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"encryptionDetail": {
|
||||
"keyIdentifier": "https://westus07112025-cmktest1.vault.azure.net/keys/test2k/",
|
||||
"encryptionStatus": "Active"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,10 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "47482db6-4583-4672-86dd-999d0f8f4d7a"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully."
|
||||
}
|
||||
}
|
||||
}
|
||||
+171
-2
@@ -10673,6 +10673,177 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/encryption": {
|
||||
"get": {
|
||||
"summary": "Gets the workspace Customer-Managed Key (CMK) encryption settings.",
|
||||
"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\nReturns the CMK encryption settings and status for the specified workspace. \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_GetWorkspaceEncryption",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "workspaceId",
|
||||
"description": "The workspace ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully. If encryption is in progress, the response includes a `Retry-After` header.\n\n---\n**Headers:**\n\n**Retry-After** `integer` - Indicates the number of seconds after which the client can retry to get the encryption status.",
|
||||
"schema": {
|
||||
"$ref": "./definitions/workspaceCmk.json#/definitions/WorkspaceEncryptionDetail"
|
||||
}
|
||||
},
|
||||
"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* UnknownError - An error occurred.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Get workspace CMK encryption active example": {
|
||||
"$ref": "./examples/platform/GetWorkspaceEncryptionSuccessResult.json"
|
||||
},
|
||||
"Get workspace CMK encryption in progress example": {
|
||||
"$ref": "./examples/platform/GetWorkspaceEncryptionInprogressSuccessResult.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/encryption/assign": {
|
||||
"post": {
|
||||
"summary": "Assigns a Customer-Managed Key (CMK) to a 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\nEnables CMK encryption for the workspace or rotates the encryption key for the workspace. \n\n## Permissions\n\nThe caller must have an *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_AssignWorkspaceEncryption",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "workspaceId",
|
||||
"description": "The workspace ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "body",
|
||||
"name": "assignWorkspaceEncryptionRequest",
|
||||
"description": "Assign workspace encryption request payload.",
|
||||
"schema": {
|
||||
"$ref": "./definitions/workspaceCmk.json#/definitions/AssignWorkspaceEncryptionRequest"
|
||||
},
|
||||
"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* UnknownError - An error occurred.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Assign workspace CMK encryption example": {
|
||||
"$ref": "./examples/platform/AssignWorkspaceEncryption.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/encryption/reset": {
|
||||
"post": {
|
||||
"summary": "Resets the workspace encryption by removing the Customer-Managed Key (CMK) encryption configuration.",
|
||||
"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\nAfter reset, the workspace data remains encrypted using Fabric's default Microsoft-managed keys. \n\n## Permissions\n\nThe caller must have an *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_ResetWorkspaceEncryption",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "workspaceId",
|
||||
"description": "The workspace 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* UnknownError - An error occurred.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Reset workspace CMK encryption example": {
|
||||
"$ref": "./examples/platform/ResetWorkspaceEncryption.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/networking/communicationPolicy/inbound/firewall": {
|
||||
"get": {
|
||||
"summary": "Returns the IP firewall rules for the workspace. This API is designed to help workspace administrators view the effective IP firewall rules. This feature is currently in preview.",
|
||||
@@ -10792,5 +10963,3 @@
|
||||
"security": [],
|
||||
"tags": []
|
||||
}
|
||||
|
||||
|
||||
Reference in new issue
Block a user