{ "swagger": "2.0", "info": { "title": "DataAgent REST APIs", "version": "v1" }, "schemes": [ "https" ], "host": "api.fabric.microsoft.com", "basePath": "/v1", "paths": { "/workspaces/{workspaceId}/dataAgents": { "get": { "summary": "Returns a list of DataAgents from the specified workspace.", "description": "This API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\n The caller must have a *viewer* workspace role. \n\n## Required Delegated Scopes\n\nWorkspace.Read.All or Workspace.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", "tags": [ "Items" ], "operationId": "Items_ListDataAgents", "x-ms-pageable": { "nextLinkName": "continuationUri" }, "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "workspaceId", "description": "The workspace ID.", "type": "string", "format": "uuid", "required": true }, { "in": "query", "name": "continuationToken", "description": "A token for retrieving the next page of results.", "type": "string", "required": false }, { "in": "query", "name": "recursive", "description": "Lists items in a folder and its nested folders, or just a folder only. True - All items in the folder and its nested folders are listed, False - Only items in the folder are listed. The default value is true.", "type": "boolean", "required": false }, { "in": "query", "name": "rootFolderId", "description": "This parameter allows users to filter items based on a specific root folder. If not provided, the workspace is used as the root folder.", "type": "string", "format": "uuid", "required": false } ], "responses": { "200": { "description": "Request completed successfully.", "schema": { "$ref": "./definitions.json#/definitions/DataAgents" } }, "429": { "description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.", "x-ms-error-response": true, "headers": { "Retry-After": { "type": "integer", "description": "The number of seconds to wait before retrying the request." } }, "schema": { "$ref": "../common/definitions.json#/definitions/ErrorResponse" } }, "default": { "description": "Common error codes:\n\n* InvalidItemType - Invalid item type.", "schema": { "$ref": "../common/definitions.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List DataAgents in workspace example": { "$ref": "./examples/ListDataAgentsInWorkspace.json" } } }, "post": { "summary": "Creates a DataAgent in the specified workspace.", "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\nTo create DataAgent with a public definition, refer to [DataAgent](/rest/api/fabric/articles/item-management/definitions/data-agent-definition) article. \n\n ## Permissions \n The caller must have a *contributor* workspace role. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All \n\n## Limitations \n- To create a DataAgent the workspace must be on a supported Fabric capacity. For more information see: [Microsoft Fabric license types](/fabric/enterprise/licenses#microsoft-fabric-license-types).\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", "tags": [ "Items" ], "operationId": "Items_CreateDataAgent", "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": "createDataAgentRequest", "description": "Create item request payload.", "schema": { "$ref": "./definitions.json#/definitions/CreateDataAgentRequest" }, "required": true } ], "responses": { "201": { "description": "Successfully created", "schema": { "$ref": "./definitions.json#/definitions/DataAgent" } }, "202": { "description": "Request accepted, DataAgent 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 DataAgent example": { "$ref": "./examples/CreateDataAgentWithoutDefinition.json" }, "Create a DataAgent with public definition example": { "$ref": "./examples/CreateDataAgent.json" } } } }, "/workspaces/{workspaceId}/dataAgents/{dataAgentId}": { "get": { "summary": "Returns properties of the specified DataAgent.", "description": "## Permissions\n\n The caller must have *read* permissions for the DataAgent. \n\n## Required Delegated Scopes\n\n Item.Read.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", "tags": [ "Items" ], "operationId": "Items_GetDataAgent", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "workspaceId", "description": "The workspace ID.", "type": "string", "format": "uuid", "required": true }, { "in": "path", "name": "dataAgentId", "description": "The DataAgent ID.", "type": "string", "format": "uuid", "required": true } ], "responses": { "200": { "description": "Request completed successfully.", "schema": { "$ref": "./definitions.json#/definitions/DataAgent" } }, "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 DataAgent example": { "$ref": "./examples/GetDataAgent.json" } } }, "patch": { "summary": "Updates the properties of the specified DataAgent.", "description": "## Permissions\n\n The caller must have *read and write* permissions for the DataAgent.\n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", "tags": [ "Items" ], "operationId": "Items_UpdateDataAgent", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "workspaceId", "description": "The workspace ID.", "type": "string", "format": "uuid", "required": true }, { "in": "path", "name": "dataAgentId", "description": "The DataAgent ID.", "type": "string", "format": "uuid", "required": true }, { "in": "body", "name": "updateDataAgentRequest", "description": "Update DataAgent request payload.", "schema": { "$ref": "./definitions.json#/definitions/UpdateDataAgentRequest" }, "required": true } ], "responses": { "200": { "description": "Request completed successfully.", "schema": { "$ref": "./definitions.json#/definitions/DataAgent" } }, "429": { "description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.", "x-ms-error-response": true, "headers": { "Retry-After": { "type": "integer", "description": "The number of seconds to wait before retrying the request." } }, "schema": { "$ref": "../common/definitions.json#/definitions/ErrorResponse" } }, "default": { "description": "Common error codes:\n\n* ItemNotFound - The requested item was not found. \n\n* InvalidRequest - Invalid update request.", "schema": { "$ref": "../common/definitions.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update a DataAgent example": { "$ref": "./examples/UpdateDataAgent.json" } } }, "delete": { "summary": "Deletes the specified DataAgent.", "description": "## Permissions\n\n The caller must have *write* permissions for the DataAgent. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", "tags": [ "Items" ], "operationId": "Items_DeleteDataAgent", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "workspaceId", "description": "The workspace ID.", "type": "string", "format": "uuid", "required": true }, { "in": "path", "name": "dataAgentId", "description": "The DataAgent ID.", "type": "string", "format": "uuid", "required": true }, { "in": "query", "name": "hardDelete", "description": "Specifies whether to perform a hard delete. When set to `true`, the item is permanently deleted and cannot be recovered. When set to `false` or not specified, the item is soft-deleted if the item type supports it.", "type": "boolean", "required": false } ], "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.\n\n* FeatureNotAvailable - This could be due to the soft deletion feature not being available.\n\n* UnsupportedItemType - This could be due to the soft deletion feature not supported by the requested item type.\n\n* TenantSwitchDisabled - This could be due to the soft deletion feature being disabled by the tenant admin.\n\n* InvalidTargetItemStateForSoftDeletion - The item is in invalid states for soft deletion.\n\n* InvalidParentItemStateForSoftDeletion - The item's parent item is not in Active state.", "schema": { "$ref": "../common/definitions.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete a DataAgent example": { "$ref": "./examples/DeleteDataAgent.json" }, "Hard delete a DataAgent example": { "$ref": "./examples/HardDeleteDataAgent.json" } } } }, "/workspaces/{workspaceId}/dataAgents/{dataAgentId}/getDefinition": { "post": { "summary": "Returns the specified DataAgent public definition.", "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a DataAgent's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the DataAgent. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Limitations\n\nTo retrieve the definition of a Data agent item protected by an encrypted sensitivity label, the caller must have sufficient [usage rights](/fabric/enterprise/powerbi/service-security-sensitivity-label-change-enforcement) to remove the label, as configured in [Microsoft Purview](/purview/purview).\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_GetDataAgentDefinition", "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": "dataAgentId", "description": "The DataAgent ID.", "type": "string", "format": "uuid", "required": true }, { "in": "query", "name": "format", "description": "The format of the data agent public definition.", "type": "string", "required": false } ], "responses": { "200": { "description": "Request completed successfully.", "schema": { "$ref": "./definitions.json#/definitions/DataAgentDefinitionResponse" } }, "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 DataAgent public definition example": { "$ref": "./examples/GetDataAgentDefinition.json" } } } }, "/workspaces/{workspaceId}/dataAgents/{dataAgentId}/updateDefinition": { "post": { "summary": "Overrides the definition for the specified DataAgent.", "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n \nUpdating the DataAgent's definition, does not affect its sensitivity label. \n\n## Permissions\n\n The caller must have *read and write* permissions for the DataAgent. \n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", "tags": [ "Items" ], "operationId": "Items_UpdateDataAgentDefinition", "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": "dataAgentId", "description": "The DataAgent 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 in the .platform file", "type": "boolean", "required": false }, { "in": "body", "name": "updateDataAgentDefinitionRequest", "description": "Update DataAgent definition request payload.", "schema": { "$ref": "./definitions.json#/definitions/UpdateDataAgentDefinitionRequest" }, "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 DataAgent public definition example": { "$ref": "./examples/UpdateDataAgentDefinition.json" } } } }, "/workspaces/{workspaceId}/dataAgents/{dataAgentId}/staging/settings": { "get": { "summary": "Returns the staging (draft) settings for the specified DataAgent.", "description": "> [!NOTE]\n> Data Agent configuration management is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\n## Permissions\n\nThe caller must have *read* permissions for the DataAgent.\n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All or DataAgent.Read.All or DataAgent.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": [ "Staging" ], "operationId": "Staging_GetSettings", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "workspaceId", "description": "The workspace ID.", "type": "string", "format": "uuid", "required": true }, { "in": "path", "name": "dataAgentId", "description": "The DataAgent ID.", "type": "string", "format": "uuid", "required": true } ], "responses": { "200": { "description": "Request completed successfully.", "schema": { "$ref": "./definitions.json#/definitions/DataAgentSettingsResponse" } }, "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 staging DataAgent settings example": { "$ref": "./examples/GetStagingDataAgentSettings.json" } } }, "patch": { "summary": "Updates the staging settings for the specified DataAgent.", "description": "> [!NOTE]\n> Data Agent configuration management is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nOnly provided fields are updated.\n\n## Permissions\n\nThe caller must have *read and write* permissions for the DataAgent.\n\n## Required Delegated Scopes\n\nItem.ReadWrite.All or DataAgent.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": [ "Staging" ], "operationId": "Staging_UpdateSettings", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "workspaceId", "description": "The workspace ID.", "type": "string", "format": "uuid", "required": true }, { "in": "path", "name": "dataAgentId", "description": "The DataAgent ID.", "type": "string", "format": "uuid", "required": true }, { "in": "body", "name": "updateDataAgentSettingsRequest", "description": "Update DataAgent settings request payload.", "schema": { "$ref": "./definitions.json#/definitions/UpdateDataAgentSettingsRequest" }, "required": true } ], "responses": { "200": { "description": "Request completed successfully.", "schema": { "$ref": "./definitions.json#/definitions/DataAgentSettingsResponse" } }, "429": { "description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.", "x-ms-error-response": true, "headers": { "Retry-After": { "type": "integer", "description": "The number of seconds to wait before retrying the request." } }, "schema": { "$ref": "../common/definitions.json#/definitions/ErrorResponse" } }, "default": { "description": "Common error codes:\n\n* ItemNotFound - The requested item was not found.\n\n* InvalidRequest - Invalid update request.", "schema": { "$ref": "../common/definitions.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update staging DataAgent settings example": { "$ref": "./examples/UpdateStagingDataAgentSettings.json" } } } }, "/workspaces/{workspaceId}/dataAgents/{dataAgentId}/staging/datasources": { "get": { "summary": "Returns a list of staging datasources for the specified DataAgent.", "description": "> [!NOTE]\n> Data Agent configuration management is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\nThe caller must have *read* permissions for the DataAgent.\n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All or DataAgent.Read.All or DataAgent.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": [ "Staging" ], "operationId": "Staging_ListDatasources", "x-ms-pageable": { "nextLinkName": "continuationUri" }, "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "workspaceId", "description": "The workspace ID.", "type": "string", "format": "uuid", "required": true }, { "in": "path", "name": "dataAgentId", "description": "The DataAgent ID.", "type": "string", "format": "uuid", "required": true }, { "in": "query", "name": "continuationToken", "description": "A token for retrieving the next page of results.", "type": "string", "required": false } ], "responses": { "200": { "description": "Request completed successfully.", "schema": { "$ref": "./definitions.json#/definitions/DataAgentDatasources" } }, "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": { "List staging DataAgent datasources example": { "$ref": "./examples/ListStagingDataAgentDatasources.json" } } }, "post": { "summary": "Creates a datasource in the staging environment of the specified DataAgent.", "description": "> [!NOTE]\n> Data Agent configuration management is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nThis operation creates a datasource for an existing Fabric item.\n\n## Permissions\n\nThe caller must have *read and write* permissions for the DataAgent.\n\n## Required Delegated Scopes\n\nItem.ReadWrite.All or DataAgent.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": [ "Staging" ], "operationId": "Staging_CreateDatasource", "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": "dataAgentId", "description": "The DataAgent ID.", "type": "string", "format": "uuid", "required": true }, { "in": "body", "name": "createDataAgentDatasourceRequest", "description": "Create datasource request payload.", "schema": { "$ref": "./definitions.json#/definitions/CreateDataAgentDatasourceRequest" }, "required": true } ], "responses": { "201": { "description": "Successfully created.", "schema": { "$ref": "./definitions.json#/definitions/DataAgentDatasourceResponse" } }, "202": { "description": "Request accepted, datasource 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* ItemNotFound - The requested item was not found\n\n* InvalidRequest - Invalid request\n\n* EntityConflict - A create operation is already in progress for this datasource", "schema": { "$ref": "../common/definitions.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create staging DataAgent datasource example": { "$ref": "./examples/CreateStagingDataAgentDatasource.json" }, "Create staging DataAgent warehouse datasource example": { "$ref": "./examples/CreateStagingDataAgentWarehouseDatasource.json" } } } }, "/workspaces/{workspaceId}/dataAgents/{dataAgentId}/staging/datasources/{datasourceId}": { "get": { "summary": "Returns metadata for a specific staging datasource of the specified DataAgent.", "description": "> [!NOTE]\n> Data Agent configuration management is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\n## Permissions\n\nThe caller must have *read* permissions for the DataAgent.\n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All or DataAgent.Read.All or DataAgent.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": [ "Staging" ], "operationId": "Staging_GetDatasource", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "workspaceId", "description": "The workspace ID.", "type": "string", "format": "uuid", "required": true }, { "in": "path", "name": "dataAgentId", "description": "The DataAgent ID.", "type": "string", "format": "uuid", "required": true }, { "in": "path", "name": "datasourceId", "description": "The datasource ID.", "type": "string", "format": "uuid", "required": true } ], "responses": { "200": { "description": "Request completed successfully.", "schema": { "$ref": "./definitions.json#/definitions/DataAgentDatasourceResponse" } }, "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 staging DataAgent datasource example": { "$ref": "./examples/GetStagingDataAgentDatasource.json" } } }, "patch": { "summary": "Updates metadata for a specific staging datasource of the specified DataAgent.", "description": "> [!NOTE]\n> Data Agent configuration management is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nOnly provided fields are updated.\n\n## Permissions\n\nThe caller must have *read and write* permissions for the DataAgent.\n\n## Required Delegated Scopes\n\nItem.ReadWrite.All or DataAgent.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": [ "Staging" ], "operationId": "Staging_UpdateDatasource", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "workspaceId", "description": "The workspace ID.", "type": "string", "format": "uuid", "required": true }, { "in": "path", "name": "dataAgentId", "description": "The DataAgent ID.", "type": "string", "format": "uuid", "required": true }, { "in": "path", "name": "datasourceId", "description": "The datasource ID.", "type": "string", "format": "uuid", "required": true }, { "in": "body", "name": "updateDataAgentDatasourceRequest", "description": "Update datasource request payload.", "schema": { "$ref": "./definitions.json#/definitions/UpdateDataAgentDatasourceRequest" }, "required": true } ], "responses": { "200": { "description": "Request completed successfully.", "schema": { "$ref": "./definitions.json#/definitions/DataAgentDatasourceResponse" } }, "429": { "description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.", "x-ms-error-response": true, "headers": { "Retry-After": { "type": "integer", "description": "The number of seconds to wait before retrying the request." } }, "schema": { "$ref": "../common/definitions.json#/definitions/ErrorResponse" } }, "default": { "description": "Common error codes:\n\n* ItemNotFound - The requested item was not found.\n\n* InvalidRequest - Invalid update request.", "schema": { "$ref": "../common/definitions.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update staging DataAgent datasource example": { "$ref": "./examples/UpdateStagingDataAgentDatasource.json" } } }, "delete": { "summary": "Deletes a datasource from the staging environment of the specified DataAgent.", "description": "> [!NOTE]\n> Data Agent configuration management is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nDeletes the datasource from the DataAgent. The underlying Fabric item isn't deleted.\n\n## Permissions\n\nThe caller must have *read and write* permissions for the DataAgent.\n\n## Required Delegated Scopes\n\nItem.ReadWrite.All or DataAgent.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": [ "Staging" ], "operationId": "Staging_DeleteDatasource", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "workspaceId", "description": "The workspace ID.", "type": "string", "format": "uuid", "required": true }, { "in": "path", "name": "dataAgentId", "description": "The DataAgent ID.", "type": "string", "format": "uuid", "required": true }, { "in": "path", "name": "datasourceId", "description": "The datasource ID.", "type": "string", "format": "uuid", "required": true } ], "responses": { "200": { "description": "Request completed successfully." }, "429": { "description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.", "x-ms-error-response": true, "headers": { "Retry-After": { "type": "integer", "description": "The number of seconds to wait before retrying the request." } }, "schema": { "$ref": "../common/definitions.json#/definitions/ErrorResponse" } }, "default": { "description": "Common error codes:\n\n* ItemNotFound - The requested item was not found.", "schema": { "$ref": "../common/definitions.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete staging DataAgent datasource example": { "$ref": "./examples/DeleteStagingDataAgentDatasource.json" } } } }, "/workspaces/{workspaceId}/dataAgents/{dataAgentId}/staging/datasources/{datasourceId}/elements": { "get": { "summary": "Returns schema elements at a level of the schema tree for a staging datasource.", "description": "> [!NOTE]\n> Data Agent configuration management is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nElements represent the schema tree of a datasource (schemas, tables, columns). Navigate level-by-level using the `rootId` parameter.\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\nThe caller must have *read* permissions for the DataAgent.\n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All or DataAgent.Read.All or DataAgent.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": [ "Staging" ], "operationId": "Staging_ListDatasourceElements", "x-ms-pageable": { "nextLinkName": "continuationUri" }, "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "workspaceId", "description": "The workspace ID.", "type": "string", "format": "uuid", "required": true }, { "in": "path", "name": "dataAgentId", "description": "The DataAgent ID.", "type": "string", "format": "uuid", "required": true }, { "in": "path", "name": "datasourceId", "description": "The datasource ID.", "type": "string", "format": "uuid", "required": true }, { "in": "query", "name": "rootId", "description": "The identifier of a parent element. Omit to get the root level.", "type": "string", "required": false }, { "in": "query", "name": "continuationToken", "description": "A token for retrieving the next page of results.", "type": "string", "required": false } ], "responses": { "200": { "description": "Request completed successfully.", "schema": { "$ref": "./definitions.json#/definitions/DataSourceElements" } }, "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": { "List staging DataAgent datasource elements example": { "$ref": "./examples/ListStagingDataAgentDatasourceElements.json" } } }, "patch": { "summary": "Updates a specific schema element for a staging datasource.", "description": "> [!NOTE]\n> Data Agent configuration management is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nSelect/deselect an element or set a custom description. Only provided fields are updated.\n\n## Permissions\n\nThe caller must have *read and write* permissions for the DataAgent.\n\n## Required Delegated Scopes\n\nItem.ReadWrite.All or DataAgent.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": [ "Staging" ], "operationId": "Staging_UpdateDatasourceElement", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "workspaceId", "description": "The workspace ID.", "type": "string", "format": "uuid", "required": true }, { "in": "path", "name": "dataAgentId", "description": "The DataAgent ID.", "type": "string", "format": "uuid", "required": true }, { "in": "path", "name": "datasourceId", "description": "The datasource ID.", "type": "string", "format": "uuid", "required": true }, { "in": "query", "name": "id", "description": "The element identifier.", "type": "string", "required": true }, { "in": "body", "name": "updateDataSourceElementRequest", "description": "Update element request payload.", "schema": { "$ref": "./definitions.json#/definitions/UpdateDataSourceElementRequest" }, "required": true } ], "responses": { "200": { "description": "Request completed successfully.", "schema": { "$ref": "./definitions.json#/definitions/DataSourceElement" } }, "429": { "description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.", "x-ms-error-response": true, "headers": { "Retry-After": { "type": "integer", "description": "The number of seconds to wait before retrying the request." } }, "schema": { "$ref": "../common/definitions.json#/definitions/ErrorResponse" } }, "default": { "description": "Common error codes:\n\n* ItemNotFound - The requested item was not found.\n\n* InvalidRequest - Invalid update request.", "schema": { "$ref": "../common/definitions.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update staging DataAgent datasource element example": { "$ref": "./examples/UpdateStagingDataAgentDatasourceElement.json" } } }, "delete": { "summary": "Deletes a schema element that is no longer present in the live schema from a staging datasource.", "description": "> [!NOTE]\n> Data Agent configuration management is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nUse this API to remove a stale element from the saved datasource schema after it has been removed from the live datasource schema. This API does not automatically remove elements when the live schema changes, so callers can review the change and decide whether to delete the saved element themselves.\n\nAn element can be deleted only when it is no longer present in the live datasource schema. If the element still exists in the live datasource schema, the request fails.\n\n## Permissions\n\nThe caller must have *read and write* permissions for the DataAgent.\n\n## Required Delegated Scopes\n\nItem.ReadWrite.All or DataAgent.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": [ "Staging" ], "operationId": "Staging_DeleteDatasourceElement", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "workspaceId", "description": "The workspace ID.", "type": "string", "format": "uuid", "required": true }, { "in": "path", "name": "dataAgentId", "description": "The DataAgent ID.", "type": "string", "format": "uuid", "required": true }, { "in": "path", "name": "datasourceId", "description": "The datasource ID.", "type": "string", "format": "uuid", "required": true }, { "in": "query", "name": "id", "description": "The element identifier.", "type": "string", "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* ElementStillAvailable - The element still exists in the datasource schema and cannot be deleted.", "schema": { "$ref": "../common/definitions.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete staging DataAgent datasource element example": { "$ref": "./examples/DeleteStagingDataAgentDatasourceElement.json" } } } }, "/workspaces/{workspaceId}/dataAgents/{dataAgentId}/staging/datasources/{datasourceId}/fewshots": { "get": { "summary": "Returns a list of staging fewshots for a datasource of the specified DataAgent.", "description": "> [!NOTE]\n> Data Agent configuration management is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\nThe caller must have *read* permissions for the DataAgent.\n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All or DataAgent.Read.All or DataAgent.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": [ "Staging" ], "operationId": "Staging_ListDatasourceFewshots", "x-ms-pageable": { "nextLinkName": "continuationUri" }, "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "workspaceId", "description": "The workspace ID.", "type": "string", "format": "uuid", "required": true }, { "in": "path", "name": "dataAgentId", "description": "The DataAgent ID.", "type": "string", "format": "uuid", "required": true }, { "in": "path", "name": "datasourceId", "description": "The datasource ID.", "type": "string", "format": "uuid", "required": true }, { "in": "query", "name": "continuationToken", "description": "A token for retrieving the next page of results.", "type": "string", "required": false } ], "responses": { "200": { "description": "Request completed successfully.", "schema": { "$ref": "./definitions.json#/definitions/DataAgentFewshots" } }, "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": { "List staging DataAgent datasource fewshots example": { "$ref": "./examples/ListStagingDataAgentDatasourceFewshots.json" } } }, "post": { "summary": "Creates a new fewshot for a staging datasource of the specified DataAgent.", "description": "> [!NOTE]\n> Data Agent configuration management is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\n## Permissions\n\nThe caller must have *read and write* permissions for the DataAgent.\n\n## Required Delegated Scopes\n\nItem.ReadWrite.All or DataAgent.ReadWrite.All\n\n## Limitations\n\nFewshots aren't supported for Semantic Model and Ontology datasources.\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": [ "Staging" ], "operationId": "Staging_CreateDatasourceFewshot", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "workspaceId", "description": "The workspace ID.", "type": "string", "format": "uuid", "required": true }, { "in": "path", "name": "dataAgentId", "description": "The DataAgent ID.", "type": "string", "format": "uuid", "required": true }, { "in": "path", "name": "datasourceId", "description": "The datasource ID.", "type": "string", "format": "uuid", "required": true }, { "in": "body", "name": "createDataAgentFewshotRequest", "description": "Create fewshot request payload.", "schema": { "$ref": "./definitions.json#/definitions/CreateDataAgentFewshotRequest" }, "required": true } ], "responses": { "201": { "description": "Successfully created.", "schema": { "$ref": "./definitions.json#/definitions/DataAgentFewshot" } }, "429": { "description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.", "x-ms-error-response": true, "headers": { "Retry-After": { "type": "integer", "description": "The number of seconds to wait before retrying the request." } }, "schema": { "$ref": "../common/definitions.json#/definitions/ErrorResponse" } }, "default": { "description": "Common error codes:\n\n* ItemNotFound - The requested item was not found.\n\n* InvalidRequest - Invalid request.", "schema": { "$ref": "../common/definitions.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create staging DataAgent datasource fewshot example": { "$ref": "./examples/CreateStagingDataAgentDatasourceFewshot.json" } } } }, "/workspaces/{workspaceId}/dataAgents/{dataAgentId}/staging/datasources/{datasourceId}/fewshots/{fewShotId}": { "get": { "summary": "Returns a specific staging fewshot by ID.", "description": "> [!NOTE]\n> Data Agent configuration management is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\n## Permissions\n\nThe caller must have *read* permissions for the DataAgent.\n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All or DataAgent.Read.All or DataAgent.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": [ "Staging" ], "operationId": "Staging_GetDatasourceFewshot", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "workspaceId", "description": "The workspace ID.", "type": "string", "format": "uuid", "required": true }, { "in": "path", "name": "dataAgentId", "description": "The DataAgent ID.", "type": "string", "format": "uuid", "required": true }, { "in": "path", "name": "datasourceId", "description": "The datasource ID.", "type": "string", "format": "uuid", "required": true }, { "in": "path", "name": "fewShotId", "description": "The fewshot ID.", "type": "string", "format": "uuid", "required": true } ], "responses": { "200": { "description": "Request completed successfully.", "schema": { "$ref": "./definitions.json#/definitions/DataAgentFewshot" } }, "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 staging DataAgent datasource fewshot example": { "$ref": "./examples/GetStagingDataAgentDatasourceFewshot.json" } } }, "patch": { "summary": "Updates a specific staging fewshot.", "description": "> [!NOTE]\n> Data Agent configuration management is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nOnly provided fields are updated.\n\n## Permissions\n\nThe caller must have *read and write* permissions for the DataAgent.\n\n## Required Delegated Scopes\n\nItem.ReadWrite.All or DataAgent.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": [ "Staging" ], "operationId": "Staging_UpdateDatasourceFewshot", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "workspaceId", "description": "The workspace ID.", "type": "string", "format": "uuid", "required": true }, { "in": "path", "name": "dataAgentId", "description": "The DataAgent ID.", "type": "string", "format": "uuid", "required": true }, { "in": "path", "name": "datasourceId", "description": "The datasource ID.", "type": "string", "format": "uuid", "required": true }, { "in": "path", "name": "fewShotId", "description": "The fewshot ID.", "type": "string", "format": "uuid", "required": true }, { "in": "body", "name": "updateDataAgentFewshotRequest", "description": "Update fewshot request payload.", "schema": { "$ref": "./definitions.json#/definitions/UpdateDataAgentFewshotRequest" }, "required": true } ], "responses": { "200": { "description": "Request completed successfully.", "schema": { "$ref": "./definitions.json#/definitions/DataAgentFewshot" } }, "429": { "description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.", "x-ms-error-response": true, "headers": { "Retry-After": { "type": "integer", "description": "The number of seconds to wait before retrying the request." } }, "schema": { "$ref": "../common/definitions.json#/definitions/ErrorResponse" } }, "default": { "description": "Common error codes:\n\n* ItemNotFound - The requested item was not found.\n\n* InvalidRequest - Invalid update request.", "schema": { "$ref": "../common/definitions.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update staging DataAgent datasource fewshot example": { "$ref": "./examples/UpdateStagingDataAgentDatasourceFewshot.json" } } }, "delete": { "summary": "Deletes a specific staging fewshot.", "description": "> [!NOTE]\n> Data Agent configuration management is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\n## Permissions\n\nThe caller must have *read and write* permissions for the DataAgent.\n\n## Required Delegated Scopes\n\nItem.ReadWrite.All or DataAgent.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": [ "Staging" ], "operationId": "Staging_DeleteDatasourceFewshot", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "workspaceId", "description": "The workspace ID.", "type": "string", "format": "uuid", "required": true }, { "in": "path", "name": "dataAgentId", "description": "The DataAgent ID.", "type": "string", "format": "uuid", "required": true }, { "in": "path", "name": "datasourceId", "description": "The datasource ID.", "type": "string", "format": "uuid", "required": true }, { "in": "path", "name": "fewShotId", "description": "The fewshot ID.", "type": "string", "format": "uuid", "required": true } ], "responses": { "200": { "description": "Request completed successfully." }, "429": { "description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.", "x-ms-error-response": true, "headers": { "Retry-After": { "type": "integer", "description": "The number of seconds to wait before retrying the request." } }, "schema": { "$ref": "../common/definitions.json#/definitions/ErrorResponse" } }, "default": { "description": "Common error codes:\n\n* ItemNotFound - The requested item was not found.", "schema": { "$ref": "../common/definitions.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete staging DataAgent datasource fewshot example": { "$ref": "./examples/DeleteStagingDataAgentDatasourceFewshot.json" } } } }, "/workspaces/{workspaceId}/dataAgents/{dataAgentId}/staging/datasources/{datasourceId}/fewshots/deleteAll": { "post": { "summary": "Deletes all fewshots for a staging datasource of the specified DataAgent.", "description": "> [!NOTE]\n> Data Agent configuration management is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\n## Permissions\n\nThe caller must have *read and write* permissions for the DataAgent.\n\n## Required Delegated Scopes\n\nItem.ReadWrite.All or DataAgent.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": [ "Staging" ], "operationId": "Staging_DeleteAllDatasourceFewshots", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "workspaceId", "description": "The workspace ID.", "type": "string", "format": "uuid", "required": true }, { "in": "path", "name": "dataAgentId", "description": "The DataAgent ID.", "type": "string", "format": "uuid", "required": true }, { "in": "path", "name": "datasourceId", "description": "The datasource ID.", "type": "string", "format": "uuid", "required": true } ], "responses": { "200": { "description": "Request completed successfully." }, "429": { "description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.", "x-ms-error-response": true, "headers": { "Retry-After": { "type": "integer", "description": "The number of seconds to wait before retrying the request." } }, "schema": { "$ref": "../common/definitions.json#/definitions/ErrorResponse" } }, "default": { "description": "Common error codes:\n\n* ItemNotFound - The requested item was not found.", "schema": { "$ref": "../common/definitions.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete all staging DataAgent datasource fewshots example": { "$ref": "./examples/DeleteAllStagingDataAgentDatasourceFewshots.json" } } } }, "/workspaces/{workspaceId}/dataAgents/{dataAgentId}/settings": { "get": { "summary": "Returns the published settings for the specified DataAgent.", "description": "> [!NOTE]\n> Data Agent configuration management is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\n## Permissions\n\nThe caller must have *read* permissions for the DataAgent.\n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All or DataAgent.Read.All or DataAgent.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": [ "Published" ], "operationId": "Published_GetSettings", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "workspaceId", "description": "The workspace ID.", "type": "string", "format": "uuid", "required": true }, { "in": "path", "name": "dataAgentId", "description": "The DataAgent ID.", "type": "string", "format": "uuid", "required": true } ], "responses": { "200": { "description": "Request completed successfully.", "schema": { "$ref": "./definitions.json#/definitions/DataAgentSettingsResponse" } }, "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 published DataAgent settings example": { "$ref": "./examples/GetPublishedDataAgentSettings.json" } } } }, "/workspaces/{workspaceId}/dataAgents/{dataAgentId}/datasources": { "get": { "summary": "Returns a list of published datasources for the specified DataAgent.", "description": "> [!NOTE]\n> Data Agent configuration management is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\nThe caller must have *read* permissions for the DataAgent.\n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All or DataAgent.Read.All or DataAgent.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": [ "Published" ], "operationId": "Published_ListDatasources", "x-ms-pageable": { "nextLinkName": "continuationUri" }, "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "workspaceId", "description": "The workspace ID.", "type": "string", "format": "uuid", "required": true }, { "in": "path", "name": "dataAgentId", "description": "The DataAgent ID.", "type": "string", "format": "uuid", "required": true }, { "in": "query", "name": "continuationToken", "description": "A token for retrieving the next page of results.", "type": "string", "required": false } ], "responses": { "200": { "description": "Request completed successfully.", "schema": { "$ref": "./definitions.json#/definitions/DataAgentDatasources" } }, "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": { "List published DataAgent datasources example": { "$ref": "./examples/ListPublishedDataAgentDatasources.json" } } } }, "/workspaces/{workspaceId}/dataAgents/{dataAgentId}/datasources/{datasourceId}": { "get": { "summary": "Returns metadata for a specific published datasource of the specified DataAgent.", "description": "> [!NOTE]\n> Data Agent configuration management is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\n## Permissions\n\nThe caller must have *read* permissions for the DataAgent.\n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All or DataAgent.Read.All or DataAgent.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": [ "Published" ], "operationId": "Published_GetDatasource", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "workspaceId", "description": "The workspace ID.", "type": "string", "format": "uuid", "required": true }, { "in": "path", "name": "dataAgentId", "description": "The DataAgent ID.", "type": "string", "format": "uuid", "required": true }, { "in": "path", "name": "datasourceId", "description": "The datasource ID.", "type": "string", "format": "uuid", "required": true } ], "responses": { "200": { "description": "Request completed successfully.", "schema": { "$ref": "./definitions.json#/definitions/DataAgentDatasourceResponse" } }, "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 published DataAgent datasource example": { "$ref": "./examples/GetPublishedDataAgentDatasource.json" } } } }, "/workspaces/{workspaceId}/dataAgents/{dataAgentId}/datasources/{datasourceId}/elements": { "get": { "summary": "Returns schema elements at a level of the schema tree for a published datasource.", "description": "> [!NOTE]\n> Data Agent configuration management is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nElements represent the schema tree of a datasource (schemas, tables, columns). Navigate level-by-level using the `rootId` parameter.\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\nThe caller must have *read* permissions for the DataAgent.\n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All or DataAgent.Read.All or DataAgent.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": [ "Published" ], "operationId": "Published_ListDatasourceElements", "x-ms-pageable": { "nextLinkName": "continuationUri" }, "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "workspaceId", "description": "The workspace ID.", "type": "string", "format": "uuid", "required": true }, { "in": "path", "name": "dataAgentId", "description": "The DataAgent ID.", "type": "string", "format": "uuid", "required": true }, { "in": "path", "name": "datasourceId", "description": "The datasource ID.", "type": "string", "format": "uuid", "required": true }, { "in": "query", "name": "rootId", "description": "The identifier of a parent element. Omit to get the root level.", "type": "string", "required": false }, { "in": "query", "name": "continuationToken", "description": "A token for retrieving the next page of results.", "type": "string", "required": false } ], "responses": { "200": { "description": "Request completed successfully.", "schema": { "$ref": "./definitions.json#/definitions/DataSourceElements" } }, "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": { "List published DataAgent datasource elements example": { "$ref": "./examples/ListPublishedDataAgentDatasourceElements.json" } } } }, "/workspaces/{workspaceId}/dataAgents/{dataAgentId}/datasources/{datasourceId}/fewshots": { "get": { "summary": "Returns a list of published fewshots for a datasource of the specified DataAgent.", "description": "> [!NOTE]\n> Data Agent configuration management is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\nThe caller must have *read* permissions for the DataAgent.\n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All or DataAgent.Read.All or DataAgent.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": [ "Published" ], "operationId": "Published_ListDatasourceFewshots", "x-ms-pageable": { "nextLinkName": "continuationUri" }, "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "workspaceId", "description": "The workspace ID.", "type": "string", "format": "uuid", "required": true }, { "in": "path", "name": "dataAgentId", "description": "The DataAgent ID.", "type": "string", "format": "uuid", "required": true }, { "in": "path", "name": "datasourceId", "description": "The datasource ID.", "type": "string", "format": "uuid", "required": true }, { "in": "query", "name": "continuationToken", "description": "A token for retrieving the next page of results.", "type": "string", "required": false } ], "responses": { "200": { "description": "Request completed successfully.", "schema": { "$ref": "./definitions.json#/definitions/DataAgentFewshots" } }, "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": { "List published DataAgent datasource fewshots example": { "$ref": "./examples/ListPublishedDataAgentDatasourceFewshots.json" } } } }, "/workspaces/{workspaceId}/dataAgents/{dataAgentId}/datasources/{datasourceId}/fewshots/{fewShotId}": { "get": { "summary": "Returns a specific published fewshot by ID.", "description": "> [!NOTE]\n> Data Agent configuration management is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\n## Permissions\n\nThe caller must have *read* permissions for the DataAgent.\n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All or DataAgent.Read.All or DataAgent.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": [ "Published" ], "operationId": "Published_GetDatasourceFewshot", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "workspaceId", "description": "The workspace ID.", "type": "string", "format": "uuid", "required": true }, { "in": "path", "name": "dataAgentId", "description": "The DataAgent ID.", "type": "string", "format": "uuid", "required": true }, { "in": "path", "name": "datasourceId", "description": "The datasource ID.", "type": "string", "format": "uuid", "required": true }, { "in": "path", "name": "fewShotId", "description": "The fewshot ID.", "type": "string", "format": "uuid", "required": true } ], "responses": { "200": { "description": "Request completed successfully.", "schema": { "$ref": "./definitions.json#/definitions/DataAgentFewshot" } }, "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 published DataAgent datasource fewshot example": { "$ref": "./examples/GetPublishedDataAgentDatasourceFewshot.json" } } } }, "/workspaces/{workspaceId}/dataAgents/{dataAgentId}/staging/publish": { "post": { "summary": "Publishes the staging configuration of the specified DataAgent.", "description": "> [!NOTE]\n> Data Agent configuration management is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nPromotes the current staging state to the published environment, making it live.\n\n## Permissions\n\nThe caller must have *read and write* permissions for the DataAgent.\n\n## Required Delegated Scopes\n\nItem.ReadWrite.All or DataAgent.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_PublishDataAgent", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "workspaceId", "description": "The workspace ID.", "type": "string", "format": "uuid", "required": true }, { "in": "path", "name": "dataAgentId", "description": "The DataAgent ID.", "type": "string", "format": "uuid", "required": true }, { "in": "body", "name": "publishDataAgentRequest", "description": "Publish DataAgent request payload.", "schema": { "$ref": "./definitions.json#/definitions/PublishDataAgentRequest" }, "required": true } ], "responses": { "200": { "description": "Request completed successfully.", "schema": { "$ref": "./definitions.json#/definitions/PublishDataAgentResponse" } }, "429": { "description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.", "x-ms-error-response": true, "headers": { "Retry-After": { "type": "integer", "description": "The number of seconds to wait before retrying the request." } }, "schema": { "$ref": "../common/definitions.json#/definitions/ErrorResponse" } }, "default": { "description": "Common error codes:\n\n* ItemNotFound - The requested item was not found.\n\n* InvalidRequest - Invalid request.", "schema": { "$ref": "../common/definitions.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Publish DataAgent example": { "$ref": "./examples/PublishDataAgent.json" } } } }, "/workspaces/{workspaceId}/dataAgents/{dataAgentId}/staging/reset": { "post": { "summary": "Reverts the staging environment of the specified DataAgent to the published state.", "description": "> [!NOTE]\n> Data Agent configuration management is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nDiscards all unpublished changes in the staging environment.\n\n## Permissions\n\nThe caller must have *read and write* permissions for the DataAgent.\n\n## Required Delegated Scopes\n\nItem.ReadWrite.All or DataAgent.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": [ "Staging" ], "operationId": "Staging_Reset", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "workspaceId", "description": "The workspace ID.", "type": "string", "format": "uuid", "required": true }, { "in": "path", "name": "dataAgentId", "description": "The DataAgent ID.", "type": "string", "format": "uuid", "required": true } ], "responses": { "200": { "description": "Request completed successfully." }, "429": { "description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.", "x-ms-error-response": true, "headers": { "Retry-After": { "type": "integer", "description": "The number of seconds to wait before retrying the request." } }, "schema": { "$ref": "../common/definitions.json#/definitions/ErrorResponse" } }, "default": { "description": "Common error codes:\n\n* ItemNotFound - The requested item was not found.", "schema": { "$ref": "../common/definitions.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Reset staging DataAgent example": { "$ref": "./examples/ResetStagingDataAgent.json" } } } } }, "responses": {}, "security": [], "tags": [] }