mirror of
https://github.com/microsoft/fabric-rest-api-specs.git
synced 2026-11-04 03:37:27 +00:00
Updating swagger files.
This commit is contained in:
Fabric-APIs-Publish-Specification-Pipeline committed
1 parent
505f86c93a
commit
6f817cbcb5
32 files changed
+2135
-36
No files matched your search
@@ -26,7 +26,9 @@
|
||||
},
|
||||
"DataAgents": {
|
||||
"description": "A list of data agents.",
|
||||
"required": ["value"],
|
||||
"required": [
|
||||
"value"
|
||||
],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"value": {
|
||||
@@ -789,6 +791,42 @@
|
||||
]
|
||||
}
|
||||
},
|
||||
"DataAgentTopic": {
|
||||
"description": "The metadata for a DataAgent topic file.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"fileName"
|
||||
],
|
||||
"properties": {
|
||||
"fileName": {
|
||||
"description": "The file name of the topic. Must end with the .md extension and be unique within the datasource.",
|
||||
"type": "string",
|
||||
"readOnly": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"DataAgentTopics": {
|
||||
"description": "A paginated list of DataAgent topics.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"value"
|
||||
],
|
||||
"properties": {
|
||||
"value": {
|
||||
"description": "A list of topics.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/DataAgentTopic"
|
||||
},
|
||||
"readOnly": true
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
|
||||
}
|
||||
]
|
||||
},
|
||||
"FewshotValidationStatus": {
|
||||
"description": "The validation status of a fewshot.",
|
||||
"type": "object",
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-28571bfff4cf",
|
||||
"dataAgentId": "5b218778-e7a5-4d73-8187-f10824047715",
|
||||
"datasourceId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"fileName": "company-policies.md"
|
||||
},
|
||||
"responses": {
|
||||
"200": {}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,15 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-28571bfff4cf",
|
||||
"dataAgentId": "5b218778-e7a5-4d73-8187-f10824047715",
|
||||
"datasourceId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"fileName": "company-policies.md"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"headers": {
|
||||
"Content-Type": "text/markdown"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,15 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-28571bfff4cf",
|
||||
"dataAgentId": "5b218778-e7a5-4d73-8187-f10824047715",
|
||||
"datasourceId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"fileName": "company-policies.md"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"headers": {
|
||||
"Content-Type": "text/markdown"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,22 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-28571bfff4cf",
|
||||
"dataAgentId": "5b218778-e7a5-4d73-8187-f10824047715",
|
||||
"datasourceId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"fileName": "company-policies.md"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"headers": {
|
||||
"Content-Type": "text/markdown"
|
||||
}
|
||||
},
|
||||
"202": {
|
||||
"headers": {
|
||||
"Location": "https://api.fabric.microsoft.com/v1/operations/43b2e353-884a-4c2a-8be5-e02f8be8f4d3",
|
||||
"x-ms-operation-id": "43b2e353-884a-4c2a-8be5-e02f8be8f4d3",
|
||||
"Retry-After": 30
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,21 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-28571bfff4cf",
|
||||
"dataAgentId": "5b218778-e7a5-4d73-8187-f10824047715",
|
||||
"datasourceId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"value": [
|
||||
{
|
||||
"fileName": "company-policies.md"
|
||||
},
|
||||
{
|
||||
"fileName": "product-docs.md"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,21 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-28571bfff4cf",
|
||||
"dataAgentId": "5b218778-e7a5-4d73-8187-f10824047715",
|
||||
"datasourceId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"value": [
|
||||
{
|
||||
"fileName": "company-policies.md"
|
||||
},
|
||||
{
|
||||
"fileName": "product-docs.md"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,12 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-28571bfff4cf",
|
||||
"dataAgentId": "5b218778-e7a5-4d73-8187-f10824047715",
|
||||
"datasourceId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"fileName": "company-policies.md",
|
||||
"content": "# Company Policies"
|
||||
},
|
||||
"responses": {
|
||||
"200": {}
|
||||
}
|
||||
}
|
||||
+593
-1
@@ -1808,6 +1808,359 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/dataAgents/{dataAgentId}/staging/datasources/{datasourceId}/topics": {
|
||||
"get": {
|
||||
"summary": "Returns a list of staging topics 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\nReturns a paginated list of topic file names for the specified datasource. To retrieve the content of a specific topic, use the download endpoint with the `fileName`.\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_ListDatasourceTopics",
|
||||
"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/DataAgentTopics"
|
||||
}
|
||||
},
|
||||
"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 topics example": {
|
||||
"$ref": "./examples/ListStagingDataAgentDatasourceTopics.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"put": {
|
||||
"summary": "Uploads a staging topic file.",
|
||||
"description": "> [!NOTE]\n> Data Agent configuration management is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nCreates or replaces a topic file in the staging area. The file content must be markdown format. If a file with the same name already exists, it is replaced.\n\n## Permissions\n\nThe caller must have *contributor* or higher 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_UploadDatasourceTopic",
|
||||
"consumes": [
|
||||
"text/markdown"
|
||||
],
|
||||
"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": "fileName",
|
||||
"description": "The topic file name (e.g., \"company-policies.md\"). Must end with the .md extension.",
|
||||
"type": "string",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "body",
|
||||
"name": "content",
|
||||
"description": "The markdown content of the topic file. May include YAML frontmatter with name and description fields.",
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "header",
|
||||
"name": "If-Match",
|
||||
"description": "An ETag value. The ETag must be specified in quotes. If provided, the call will succeed only if the resource's ETag matches the provided ETag.",
|
||||
"required": false,
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully.\n\n---\n**Headers:**\n\n**ETag** `string` - The ETag of the updated topic file."
|
||||
},
|
||||
"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* PreconditionFailed - The current resource ETag doesn't match the value specified in the If-Match header.",
|
||||
"x-ms-error-response": true,
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Upload staging DataAgent datasource topic example": {
|
||||
"$ref": "./examples/UploadStagingDataAgentDatasourceTopic.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Deletes a staging topic file.",
|
||||
"description": "> [!NOTE]\n> Data Agent configuration management is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nRemoves a topic file from the staging area.\n\n## Permissions\n\nThe caller must have *contributor* or higher 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_DeleteDatasourceTopic",
|
||||
"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": "fileName",
|
||||
"description": "The topic file name (e.g., \"company-policies.md\"). Must end with the .md extension.",
|
||||
"type": "string",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "header",
|
||||
"name": "If-Match",
|
||||
"description": "An ETag value. The ETag must be specified in quotes. If provided, the call will succeed only if the resource's ETag matches the provided ETag.",
|
||||
"required": false,
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully."
|
||||
},
|
||||
"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* PreconditionFailed - The current resource ETag doesn't match the value specified in the If-Match header.",
|
||||
"x-ms-error-response": true,
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Delete staging DataAgent datasource topic example": {
|
||||
"$ref": "./examples/DeleteStagingDataAgentDatasourceTopic.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/dataAgents/{dataAgentId}/staging/datasources/{datasourceId}/topics/format": {
|
||||
"post": {
|
||||
"summary": "Formats a staging topic file content.",
|
||||
"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\nReturns a formatted version of the specified topic file content. The formatted content includes proper YAML frontmatter (name, description) and structured markdown. If no frontmatter exists, name and description are auto-generated from the content. The original file is not modified — the caller must upload the returned content using the PUT endpoint to apply the formatting.\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_FormatDatasourceTopic",
|
||||
"produces": [
|
||||
"text/markdown"
|
||||
],
|
||||
"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": "path",
|
||||
"name": "datasourceId",
|
||||
"description": "The datasource ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "fileName",
|
||||
"description": "The topic file name (e.g., \"company-policies.md\"). Must end with the .md extension.",
|
||||
"type": "string",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully. Response body contains the formatted markdown content.\n\n---\n**Headers:**\n\n**ETag** `string` - The ETag of the topic file.",
|
||||
"schema": {
|
||||
"type": "file"
|
||||
}
|
||||
},
|
||||
"202": {
|
||||
"description": "Request accepted. Formatting 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* ItemNotFound - The requested item was not found.\n\n* InvalidRequest - The request is invalid. For example, the `fileName` query parameter is missing or does not end with the `.md` extension.",
|
||||
"x-ms-error-response": true,
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Format staging DataAgent datasource topic example": {
|
||||
"$ref": "./examples/FormatStagingDataAgentDatasourceTopic.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/dataAgents/{dataAgentId}/settings": {
|
||||
"get": {
|
||||
"summary": "Returns the published settings for the specified DataAgent.",
|
||||
@@ -2263,6 +2616,87 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/dataAgents/{dataAgentId}/datasources/{datasourceId}/topics": {
|
||||
"get": {
|
||||
"summary": "Returns a list of published topics 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\nReturns a paginated list of topic file names for the specified datasource. To retrieve the content of a specific topic, use the download endpoint with the `fileName`.\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_ListDatasourceTopics",
|
||||
"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/DataAgentTopics"
|
||||
}
|
||||
},
|
||||
"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 topics example": {
|
||||
"$ref": "./examples/ListPublishedDataAgentDatasourceTopics.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/dataAgents/{dataAgentId}/staging/publish": {
|
||||
"post": {
|
||||
"summary": "Publishes the staging configuration of the specified DataAgent.",
|
||||
@@ -2397,9 +2831,167 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/dataAgents/{dataAgentId}/staging/datasources/{datasourceId}/topics/content": {
|
||||
"get": {
|
||||
"summary": "Downloads a staging topic file by file name.",
|
||||
"description": "> [!NOTE]\n> Data Agent configuration management is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nReturns the raw markdown content of the topic file.\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_DownloadDatasourceTopic",
|
||||
"produces": [
|
||||
"text/markdown"
|
||||
],
|
||||
"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": "fileName",
|
||||
"description": "The topic file name (e.g., \"company-policies.md\"). Must end with the .md extension.",
|
||||
"type": "string",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully. Response body contains the raw markdown content.\n\n---\n**Headers:**\n\n**ETag** `string` - The ETag of the topic file.",
|
||||
"schema": {
|
||||
"type": "file"
|
||||
}
|
||||
},
|
||||
"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.",
|
||||
"x-ms-error-response": true,
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Download staging DataAgent datasource topic example": {
|
||||
"$ref": "./examples/DownloadStagingDataAgentDatasourceTopic.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/dataAgents/{dataAgentId}/datasources/{datasourceId}/topics/content": {
|
||||
"get": {
|
||||
"summary": "Downloads a published topic file by file name.",
|
||||
"description": "> [!NOTE]\n> Data Agent configuration management is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nReturns the raw markdown content of the topic file.\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_DownloadDatasourceTopic",
|
||||
"produces": [
|
||||
"text/markdown"
|
||||
],
|
||||
"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": "fileName",
|
||||
"description": "The topic file name (e.g., \"company-policies.md\"). Must end with the .md extension.",
|
||||
"type": "string",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully. Response body contains the raw markdown content.\n\n---\n**Headers:**\n\n**ETag** `string` - The ETag of the topic file.",
|
||||
"schema": {
|
||||
"type": "file"
|
||||
}
|
||||
},
|
||||
"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.",
|
||||
"x-ms-error-response": true,
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Download published DataAgent datasource topic example": {
|
||||
"$ref": "./examples/DownloadPublishedDataAgentDatasourceTopic.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {},
|
||||
"security": [],
|
||||
"tags": []
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,14 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"environmentId": "5b218778-e7a5-4d73-8187-f10824047715"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"headers": {
|
||||
"Content-Disposition": "attachment; filename=\"publish-log-5b218778-e7a5-4d73-8187-f10824047715.log\""
|
||||
},
|
||||
"body": "Starting Spark application...\nSpark context initialized.\nInstalling libraries from requirements...\nLibrary: numpy==1.24.0 - installed successfully\nLibrary: pandas==2.0.1 - installed successfully\nEnvironment configuration applied.\nSpark application finished with exit code 0.\n"
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -2059,6 +2059,69 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/environments/{environmentId}/staging/publish/log": {
|
||||
"get": {
|
||||
"summary": "Get environment publish log.",
|
||||
"description": "Downloads the driver stdout log as UTF-8 plain text for the latest environment publish run — whether it succeeded or failed. The log is only available when the latest publish operation executed a Spark job and that job has completed.\n\n## Permissions\n\nThe caller must have *write* permissions for the environment item.\n\n## Required Delegated Scopes\n\nItem.ReadWrite.All or Environment.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_GetPublishLog",
|
||||
"produces": [
|
||||
"application/octet-stream"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"name": "workspaceId",
|
||||
"in": "path",
|
||||
"description": "The workspace ID.",
|
||||
"required": true,
|
||||
"type": "string",
|
||||
"format": "uuid"
|
||||
},
|
||||
{
|
||||
"name": "environmentId",
|
||||
"in": "path",
|
||||
"description": "The environment ID.",
|
||||
"required": true,
|
||||
"type": "string",
|
||||
"format": "uuid"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully. If the driver log exceeds 50 MB, the response is truncated at exactly 50 MB and the body ends with a single-line marker: `--- LOG TRUNCATED AT 50000000 BYTES ---`.\n\n---\n**Headers:**\n\n**Content-Disposition** `string` - Provides download semantics for the publish log file.\n\n**x-ms-log-truncated** `boolean` - Set to `true` when the log exceeds 50 MB and has been truncated.",
|
||||
"schema": {
|
||||
"type": "file"
|
||||
}
|
||||
},
|
||||
"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* EnvironmentNotFound - The specified environment does not exist or the caller lacks access.\n\n* NoSparkJobExecuted - The latest publish did not execute a Spark job. No driver stdout log is available.\n\n* PublishInProgress - The Spark job for the latest publish is still running. The log will be available once the job completes.\n\n* UnknownError - An error occurred.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Get environment publish log example": {
|
||||
"$ref": "./examples/GetPublishLog.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/environments/{environmentId}/staging/cancelPublish": {
|
||||
"post": {
|
||||
"summary": "Trigger an environment publish cancellation.",
|
||||
|
||||
@@ -27,6 +27,7 @@
|
||||
"ConfluentCloud",
|
||||
"Cribl",
|
||||
"CustomEndpoint",
|
||||
"CustomStreamConnector",
|
||||
"FabricAnomalyDetectionEvents",
|
||||
"FabricCapacityOperationEvents",
|
||||
"FabricCapacityOverviewEvents",
|
||||
@@ -121,6 +122,10 @@
|
||||
"value": "CustomEndpoint",
|
||||
"description": "The Custom Endpoint source type."
|
||||
},
|
||||
{
|
||||
"value": "CustomStreamConnector",
|
||||
"description": "The Custom Stream Connector source type."
|
||||
},
|
||||
{
|
||||
"value": "FabricAnomalyDetectionEvents",
|
||||
"description": "The Fabric Anomaly Detection Events source type."
|
||||
@@ -407,6 +412,25 @@
|
||||
],
|
||||
"x-ms-discriminator-value": "CustomEndpoint"
|
||||
},
|
||||
"CustomStreamConnectorSourceResponse": {
|
||||
"type": "object",
|
||||
"description": "The response for a Custom Stream Connector source.",
|
||||
"required": [
|
||||
"properties"
|
||||
],
|
||||
"properties": {
|
||||
"properties": {
|
||||
"description": "The properties of the Custom Stream Connector source.",
|
||||
"$ref": "#/definitions/CustomStreamConnectorSourceProperties"
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/SourceResponse"
|
||||
}
|
||||
],
|
||||
"x-ms-discriminator-value": "CustomStreamConnector"
|
||||
},
|
||||
"SAPDatasphereSourceResponse": {
|
||||
"type": "object",
|
||||
"description": "Represents an SAP Datasphere source response.",
|
||||
@@ -1267,6 +1291,48 @@
|
||||
"description": "Custom endpoint events source properties.",
|
||||
"properties": {}
|
||||
},
|
||||
"CustomStreamConnectorSourceProperties": {
|
||||
"type": "object",
|
||||
"description": "The properties of a Custom Stream Connector source.",
|
||||
"properties": {
|
||||
"dataConnectionId": {
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"description": "The data connection identifier used to resolve runtime credentials and connectivity."
|
||||
},
|
||||
"workspaceId": {
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"description": "The workspace identifier of the referenced Custom Stream Connector item."
|
||||
},
|
||||
"itemId": {
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"description": "The identifier of the referenced Custom Stream Connector item."
|
||||
},
|
||||
"configurations": {
|
||||
"type": "array",
|
||||
"description": "The connector configurations. Values may include placeholders (for example, ${password}) that are resolved server-side at runtime.",
|
||||
"items": {
|
||||
"$ref": "#/definitions/CustomConnectorConfiguration"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"CustomConnectorConfiguration": {
|
||||
"type": "object",
|
||||
"description": "A Custom Stream Connector configuration entry.",
|
||||
"properties": {
|
||||
"key": {
|
||||
"type": "string",
|
||||
"description": "The configuration key."
|
||||
},
|
||||
"value": {
|
||||
"type": "string",
|
||||
"description": "The configuration value."
|
||||
}
|
||||
}
|
||||
},
|
||||
"CriblSourceProperties": {
|
||||
"type": "object",
|
||||
"description": "Cribl source properties. Connection information (bootstrap server, topic name, keys) is returned through the separate source connection API.",
|
||||
|
||||
@@ -45,6 +45,27 @@
|
||||
},
|
||||
"status": "Running"
|
||||
},
|
||||
{
|
||||
"id": "6e731a67-4fe0-47e4-9d1a-f1e8bbdd74a4",
|
||||
"name": "CustomStreamConnectorSource",
|
||||
"type": "CustomStreamConnector",
|
||||
"properties": {
|
||||
"dataConnectionId": "67a65f1d-6f20-4f80-aef0-a67730de7a2f",
|
||||
"workspaceId": "9625b495-17b3-4d6c-aeea-a81ae76ba369",
|
||||
"itemId": "ee579458-85ea-4652-bd77-5c7d7c298b2a",
|
||||
"configurations": [
|
||||
{
|
||||
"key": "topic",
|
||||
"value": "orders"
|
||||
},
|
||||
{
|
||||
"key": "api.key",
|
||||
"value": "${key}"
|
||||
}
|
||||
]
|
||||
},
|
||||
"status": "Running"
|
||||
},
|
||||
{
|
||||
"id": "e2886002-d696-4c05-969c-51361365cc24",
|
||||
"name": "AzureIoTHubSource",
|
||||
|
||||
@@ -0,0 +1,227 @@
|
||||
{
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"version": "v1",
|
||||
"title": "Actor auto-detection rules data types"
|
||||
},
|
||||
"paths": {},
|
||||
"definitions": {
|
||||
"ActorAutoDetectionRule": {
|
||||
"description": "An actor auto-detection rule on a capacity.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"id",
|
||||
"actorsSubjectToRule",
|
||||
"capacityUnitsConsumptionThresholdPercentage",
|
||||
"blockDuration"
|
||||
],
|
||||
"properties": {
|
||||
"id": {
|
||||
"description": "The actor auto-detection rule ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"readOnly": true
|
||||
},
|
||||
"actorsSubjectToRule": {
|
||||
"description": "The actors that are subject to the rule.",
|
||||
"$ref": "#/definitions/ActorAutoDetectionRuleActorsSubjectToRule",
|
||||
"readOnly": false
|
||||
},
|
||||
"capacityUnitsConsumptionThresholdPercentage": {
|
||||
"description": "The capacity unit consumption threshold per actor as a percentage of total capacity units over a rolling 24-hour window.",
|
||||
"type": "integer",
|
||||
"format": "int32",
|
||||
"minimum": 1,
|
||||
"maximum": 100,
|
||||
"readOnly": false
|
||||
},
|
||||
"blockDuration": {
|
||||
"description": "The duration for which an automatically blocked actor remains blocked.",
|
||||
"$ref": "#/definitions/ActorAutoDetectionRuleBlockDuration",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"ActorAutoDetectionRuleActorsSubjectToRule": {
|
||||
"description": "The base type that identifies which actors are subject to an actor auto-detection rule.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"type"
|
||||
],
|
||||
"discriminator": "type",
|
||||
"properties": {
|
||||
"type": {
|
||||
"description": "The kind of actors that are subject to the rule.",
|
||||
"$ref": "#/definitions/ActorAutoDetectionRuleActorsSubjectToRuleKind",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"ActorAutoDetectionRuleActorsSubjectToRuleKind": {
|
||||
"description": "The kind of actors that are subject to an actor auto-detection rule. Additional actor auto-detection rule actors subject to rule kinds may be added over time.",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"AllWorkspaces"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "ActorAutoDetectionRuleActorsSubjectToRuleKind",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "AllWorkspaces",
|
||||
"description": "All workspaces on the capacity are subject to the rule."
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"ActorAutoDetectionRuleAllWorkspaces": {
|
||||
"description": "An actor selection that applies an actor auto-detection rule to all workspaces on the capacity.",
|
||||
"type": "object",
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/ActorAutoDetectionRuleActorsSubjectToRule"
|
||||
}
|
||||
],
|
||||
"x-ms-discriminator-value": "AllWorkspaces"
|
||||
},
|
||||
"ActorAutoDetectionRuleBlockDuration": {
|
||||
"description": "The base type that describes how long an automatically blocked actor remains blocked.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"type"
|
||||
],
|
||||
"discriminator": "type",
|
||||
"properties": {
|
||||
"type": {
|
||||
"description": "The kind of block duration.",
|
||||
"$ref": "#/definitions/ActorAutoDetectionRuleBlockDurationKind",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"ActorAutoDetectionRuleBlockDurationKind": {
|
||||
"description": "The kind of block duration for an actor auto-detection rule. Additional actor auto-detection rule block duration kinds may be added over time.",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"Indefinite",
|
||||
"Hours"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "ActorAutoDetectionRuleBlockDurationKind",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "Indefinite",
|
||||
"description": "The actor remains blocked until manually unblocked by an admin."
|
||||
},
|
||||
{
|
||||
"value": "Hours",
|
||||
"description": "The actor remains blocked for a specified number of hours."
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"ActorAutoDetectionRuleIndefiniteBlockDuration": {
|
||||
"description": "An actor auto-detection rule block duration that remains in effect until an admin manually unblocks the actor.",
|
||||
"type": "object",
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/ActorAutoDetectionRuleBlockDuration"
|
||||
}
|
||||
],
|
||||
"x-ms-discriminator-value": "Indefinite"
|
||||
},
|
||||
"ActorAutoDetectionRuleHoursBlockDuration": {
|
||||
"description": "An actor auto-detection rule block duration measured in hours.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"hours"
|
||||
],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/ActorAutoDetectionRuleBlockDuration"
|
||||
}
|
||||
],
|
||||
"x-ms-discriminator-value": "Hours",
|
||||
"properties": {
|
||||
"hours": {
|
||||
"description": "The number of hours the actor remains blocked.",
|
||||
"type": "integer",
|
||||
"format": "int32",
|
||||
"minimum": 1,
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"CreateActorAutoDetectionRuleRequest": {
|
||||
"description": "The request payload for creating an actor auto-detection rule.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"actorsSubjectToRule",
|
||||
"capacityUnitsConsumptionThresholdPercentage",
|
||||
"blockDuration"
|
||||
],
|
||||
"properties": {
|
||||
"actorsSubjectToRule": {
|
||||
"description": "The actors that are subject to the rule.",
|
||||
"$ref": "#/definitions/ActorAutoDetectionRuleActorsSubjectToRule",
|
||||
"readOnly": false
|
||||
},
|
||||
"capacityUnitsConsumptionThresholdPercentage": {
|
||||
"description": "The capacity unit consumption threshold per actor as a percentage of total capacity units over a rolling 24-hour window.",
|
||||
"type": "integer",
|
||||
"format": "int32",
|
||||
"minimum": 1,
|
||||
"maximum": 100,
|
||||
"readOnly": false
|
||||
},
|
||||
"blockDuration": {
|
||||
"description": "The duration for which an automatically blocked actor remains blocked.",
|
||||
"$ref": "#/definitions/ActorAutoDetectionRuleBlockDuration",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateActorAutoDetectionRuleRequest": {
|
||||
"description": "The request payload for updating an actor auto-detection rule.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"capacityUnitsConsumptionThresholdPercentage": {
|
||||
"description": "The capacity unit consumption threshold per actor as a percentage of total capacity units over a rolling 24-hour window. Omit this property to leave the existing value unchanged.",
|
||||
"type": "integer",
|
||||
"format": "int32",
|
||||
"minimum": 1,
|
||||
"maximum": 100,
|
||||
"readOnly": false
|
||||
},
|
||||
"blockDuration": {
|
||||
"description": "The duration for which an automatically blocked actor remains blocked. When provided, this property replaces the entire block-duration configuration. Omit this property to leave the existing value unchanged.",
|
||||
"$ref": "#/definitions/ActorAutoDetectionRuleBlockDuration",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListActorAutoDetectionRulesResponse": {
|
||||
"description": "A list of actor auto-detection rules.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"value"
|
||||
],
|
||||
"properties": {
|
||||
"value": {
|
||||
"description": "A list of actor auto-detection rules.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/ActorAutoDetectionRule"
|
||||
},
|
||||
"readOnly": true
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "../../common/definitions.json#/definitions/PaginatedResponse"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1481,33 +1481,6 @@
|
||||
"description": "The object id.",
|
||||
"type": "string",
|
||||
"format": "uuid"
|
||||
},
|
||||
"objectType": {
|
||||
"description": "The type of Microsoft Entra ID object. Additional objectType types may be added over time.",
|
||||
"type": "string",
|
||||
"enum": [ "Group", "User", "ServicePrincipal", "ManagedIdentity" ],
|
||||
"x-ms-enum": {
|
||||
"name": "ObjectType",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "Group",
|
||||
"description": "Attribute name Group"
|
||||
},
|
||||
{
|
||||
"value": "User",
|
||||
"description": "Attribute name User"
|
||||
},
|
||||
{
|
||||
"value": "ServicePrincipal",
|
||||
"description": "Attribute name ServicePrincipal"
|
||||
},
|
||||
{
|
||||
"value": "ManagedIdentity",
|
||||
"description": "Attribute name ManagedIdentity"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
{
|
||||
"parameters": {
|
||||
"capacityId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"createActorAutoDetectionRuleRequest": {
|
||||
"actorsSubjectToRule": {
|
||||
"type": "AllWorkspaces"
|
||||
},
|
||||
"capacityUnitsConsumptionThresholdPercentage": 25,
|
||||
"blockDuration": {
|
||||
"type": "Hours",
|
||||
"hours": 24
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"201": {
|
||||
"body": {
|
||||
"id": "a1f0c3e4-5b6d-7890-abcd-ef1234567890",
|
||||
"actorsSubjectToRule": {
|
||||
"type": "AllWorkspaces"
|
||||
},
|
||||
"capacityUnitsConsumptionThresholdPercentage": 25,
|
||||
"blockDuration": {
|
||||
"type": "Hours",
|
||||
"hours": 24
|
||||
}
|
||||
}
|
||||
},
|
||||
"409": {
|
||||
"body": {
|
||||
"errorCode": "ActorAutoDetectionRuleAlreadyExists",
|
||||
"message": "An actor auto-detection rule with 'AllWorkspaces' already exists on this capacity.",
|
||||
"requestId": "d3e4f5a6-b7c8-9012-d345-e6f7890abcde"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
+28
@@ -0,0 +1,28 @@
|
||||
{
|
||||
"parameters": {
|
||||
"capacityId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"createActorAutoDetectionRuleRequest": {
|
||||
"actorsSubjectToRule": {
|
||||
"type": "AllWorkspaces"
|
||||
},
|
||||
"capacityUnitsConsumptionThresholdPercentage": 50,
|
||||
"blockDuration": {
|
||||
"type": "Indefinite"
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"201": {
|
||||
"body": {
|
||||
"id": "70cd1f22-e555-4fcf-813f-3877fef409fb",
|
||||
"actorsSubjectToRule": {
|
||||
"type": "AllWorkspaces"
|
||||
},
|
||||
"capacityUnitsConsumptionThresholdPercentage": 50,
|
||||
"blockDuration": {
|
||||
"type": "Indefinite"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"parameters": {
|
||||
"capacityId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"actorAutoDetectionRuleId": "a1f0c3e4-5b6d-7890-abcd-ef1234567890"
|
||||
},
|
||||
"responses": {
|
||||
"200": {}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,21 @@
|
||||
{
|
||||
"parameters": {
|
||||
"capacityId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"actorAutoDetectionRuleId": "a1f0c3e4-5b6d-7890-abcd-ef1234567890"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"id": "a1f0c3e4-5b6d-7890-abcd-ef1234567890",
|
||||
"actorsSubjectToRule": {
|
||||
"type": "AllWorkspaces"
|
||||
},
|
||||
"capacityUnitsConsumptionThresholdPercentage": 25,
|
||||
"blockDuration": {
|
||||
"type": "Hours",
|
||||
"hours": 24
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,26 @@
|
||||
{
|
||||
"parameters": {
|
||||
"capacityId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"value": [
|
||||
{
|
||||
"id": "a1f0c3e4-5b6d-7890-abcd-ef1234567890",
|
||||
"actorsSubjectToRule": {
|
||||
"type": "AllWorkspaces"
|
||||
},
|
||||
"capacityUnitsConsumptionThresholdPercentage": 25,
|
||||
"blockDuration": {
|
||||
"type": "Hours",
|
||||
"hours": 24
|
||||
}
|
||||
}
|
||||
],
|
||||
"continuationToken": null,
|
||||
"continuationUri": null
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,28 @@
|
||||
{
|
||||
"parameters": {
|
||||
"capacityId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"actorAutoDetectionRuleId": "a1f0c3e4-5b6d-7890-abcd-ef1234567890",
|
||||
"updateActorAutoDetectionRuleRequest": {
|
||||
"capacityUnitsConsumptionThresholdPercentage": 15,
|
||||
"blockDuration": {
|
||||
"type": "Hours",
|
||||
"hours": 48
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"id": "a1f0c3e4-5b6d-7890-abcd-ef1234567890",
|
||||
"actorsSubjectToRule": {
|
||||
"type": "AllWorkspaces"
|
||||
},
|
||||
"capacityUnitsConsumptionThresholdPercentage": 15,
|
||||
"blockDuration": {
|
||||
"type": "Hours",
|
||||
"hours": 48
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
+24
@@ -0,0 +1,24 @@
|
||||
{
|
||||
"parameters": {
|
||||
"capacityId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"actorAutoDetectionRuleId": "a1f0c3e4-5b6d-7890-abcd-ef1234567890",
|
||||
"updateActorAutoDetectionRuleRequest": {
|
||||
"capacityUnitsConsumptionThresholdPercentage": 40
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"id": "a1f0c3e4-5b6d-7890-abcd-ef1234567890",
|
||||
"actorsSubjectToRule": {
|
||||
"type": "AllWorkspaces"
|
||||
},
|
||||
"capacityUnitsConsumptionThresholdPercentage": 40,
|
||||
"blockDuration": {
|
||||
"type": "Hours",
|
||||
"hours": 24
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
+25
@@ -0,0 +1,25 @@
|
||||
{
|
||||
"parameters": {
|
||||
"capacityId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"actorAutoDetectionRuleId": "a1f0c3e4-5b6d-7890-abcd-ef1234567890",
|
||||
"updateActorAutoDetectionRuleRequest": {
|
||||
"blockDuration": {
|
||||
"type": "Indefinite"
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"id": "a1f0c3e4-5b6d-7890-abcd-ef1234567890",
|
||||
"actorsSubjectToRule": {
|
||||
"type": "AllWorkspaces"
|
||||
},
|
||||
"capacityUnitsConsumptionThresholdPercentage": 25,
|
||||
"blockDuration": {
|
||||
"type": "Indefinite"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -4462,6 +4462,339 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/capacities/{capacityId}/surgeProtection/actorAutoDetectionRules": {
|
||||
"post": {
|
||||
"summary": "Creates an actor auto-detection rule on the specified capacity.",
|
||||
"description": "Creates an actor auto-detection rule on the specified capacity. If a rule with the same actors subject to the rule already exists on the capacity, the request returns a conflict response.\n\n## Permissions\n\nThe caller must have *administrator* permissions on the capacity.\n\n## Required Delegated Scopes\n\nCapacity.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": [
|
||||
"SurgeProtection"
|
||||
],
|
||||
"operationId": "SurgeProtection_CreateActorAutoDetectionRule",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "capacityId",
|
||||
"description": "The capacity ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "body",
|
||||
"name": "createActorAutoDetectionRuleRequest",
|
||||
"description": "The request payload for creating an actor auto-detection rule.",
|
||||
"schema": {
|
||||
"$ref": "./definitions/actorAutoDetectionRules.json#/definitions/CreateActorAutoDetectionRuleRequest"
|
||||
},
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"201": {
|
||||
"description": "The actor auto-detection rule was created successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions/actorAutoDetectionRules.json#/definitions/ActorAutoDetectionRule"
|
||||
}
|
||||
},
|
||||
"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* InvalidParameter - The capacity unit consumption threshold is out of range or the block-duration variant is invalid.\n\n* InsufficientPermissions - The caller is not a capacity admin.\n\n* CapacityNotFound - The specified capacity does not exist.\n\n* ActorAutoDetectionRuleAlreadyExists - A rule with the same actors subject to the rule already exists on this capacity.\n\n* InvalidCapacitySKU - The capacity is not a Fabric SKU.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Create an actor auto-detection rule with an hours block duration": {
|
||||
"$ref": "./examples/actorAutoDetectionRules/CreateActorAutoDetectionRule.json"
|
||||
},
|
||||
"Create an actor auto-detection rule with an indefinite block duration": {
|
||||
"$ref": "./examples/actorAutoDetectionRules/CreateActorAutoDetectionRuleWithIndefiniteBlock.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"get": {
|
||||
"summary": "Lists actor auto-detection rules on the specified capacity.",
|
||||
"description": "Returns all actor auto-detection rules on the specified capacity.\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\nThe caller must have *administrator* permissions on the capacity.\n\n## Required Delegated Scopes\n\nCapacity.Read.All or Capacity.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": [
|
||||
"SurgeProtection"
|
||||
],
|
||||
"operationId": "SurgeProtection_ListActorAutoDetectionRules",
|
||||
"x-ms-pageable": {
|
||||
"nextLinkName": "continuationUri"
|
||||
},
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "capacityId",
|
||||
"description": "The capacity 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/actorAutoDetectionRules.json#/definitions/ListActorAutoDetectionRulesResponse"
|
||||
}
|
||||
},
|
||||
"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* InsufficientPermissions - The caller is not a capacity admin.\n\n* CapacityNotFound - The specified capacity does not exist.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"List actor auto-detection rules example": {
|
||||
"$ref": "./examples/actorAutoDetectionRules/ListActorAutoDetectionRules.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/capacities/{capacityId}/surgeProtection/actorAutoDetectionRules/{actorAutoDetectionRuleId}": {
|
||||
"get": {
|
||||
"summary": "Gets the specified actor auto-detection rule.",
|
||||
"description": "Returns the specified actor auto-detection rule on the capacity.\n\n## Permissions\n\nThe caller must have *administrator* permissions on the capacity.\n\n## Required Delegated Scopes\n\nCapacity.Read.All or Capacity.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": [
|
||||
"SurgeProtection"
|
||||
],
|
||||
"operationId": "SurgeProtection_GetActorAutoDetectionRule",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "capacityId",
|
||||
"description": "The capacity ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "actorAutoDetectionRuleId",
|
||||
"description": "The actor auto-detection rule ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions/actorAutoDetectionRules.json#/definitions/ActorAutoDetectionRule"
|
||||
}
|
||||
},
|
||||
"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* InsufficientPermissions - The caller is not a capacity admin.\n\n* CapacityNotFound - The specified capacity does not exist.\n\n* EntityNotFound - The specified actor auto-detection rule does not exist.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Get an actor auto-detection rule example": {
|
||||
"$ref": "./examples/actorAutoDetectionRules/GetActorAutoDetectionRule.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"patch": {
|
||||
"summary": "Updates the specified actor auto-detection rule.",
|
||||
"description": "Updates the specified actor auto-detection rule. Only the capacity unit consumption threshold percentage and block duration can be updated. The actors subject to the rule cannot be changed after creation. Omitting a property leaves it unchanged. When the block duration is provided, it replaces the entire existing block-duration configuration.\n\n## Permissions\n\nThe caller must have *administrator* permissions on the capacity.\n\n## Required Delegated Scopes\n\nCapacity.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": [
|
||||
"SurgeProtection"
|
||||
],
|
||||
"operationId": "SurgeProtection_UpdateActorAutoDetectionRule",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "capacityId",
|
||||
"description": "The capacity ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "actorAutoDetectionRuleId",
|
||||
"description": "The actor auto-detection rule ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "body",
|
||||
"name": "updateActorAutoDetectionRuleRequest",
|
||||
"description": "The request payload for updating an actor auto-detection rule.",
|
||||
"schema": {
|
||||
"$ref": "./definitions/actorAutoDetectionRules.json#/definitions/UpdateActorAutoDetectionRuleRequest"
|
||||
},
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "The actor auto-detection rule was updated successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions/actorAutoDetectionRules.json#/definitions/ActorAutoDetectionRule"
|
||||
}
|
||||
},
|
||||
"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* InvalidParameter - The capacity unit consumption threshold is out of range or the block-duration variant is invalid.\n\n* InsufficientPermissions - The caller is not a capacity admin.\n\n* CapacityNotFound - The specified capacity does not exist.\n\n* EntityNotFound - The specified actor auto-detection rule does not exist.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Update an actor auto-detection rule example": {
|
||||
"$ref": "./examples/actorAutoDetectionRules/UpdateActorAutoDetectionRule.json"
|
||||
},
|
||||
"Update only an actor auto-detection rule threshold": {
|
||||
"$ref": "./examples/actorAutoDetectionRules/UpdateActorAutoDetectionRuleThresholdOnly.json"
|
||||
},
|
||||
"Update an actor auto-detection rule with an indefinite block duration": {
|
||||
"$ref": "./examples/actorAutoDetectionRules/UpdateActorAutoDetectionRuleWithIndefiniteBlock.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Deletes the specified actor auto-detection rule.",
|
||||
"description": "Deletes the specified actor auto-detection rule from the capacity. If this is the only rule, auto-detection is disabled for the capacity. Deleting a rule does not clear existing blocks. Actors blocked for a specified number of hours remain blocked until the originally scheduled expiration time, and actors blocked indefinitely remain blocked until an admin manually unblocks them.\n\n## Permissions\n\nThe caller must have *administrator* permissions on the capacity.\n\n## Required Delegated Scopes\n\nCapacity.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": [
|
||||
"SurgeProtection"
|
||||
],
|
||||
"operationId": "SurgeProtection_DeleteActorAutoDetectionRule",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "capacityId",
|
||||
"description": "The capacity ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "actorAutoDetectionRuleId",
|
||||
"description": "The actor auto-detection rule ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "The actor auto-detection rule was deleted 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* InsufficientPermissions - The caller is not a capacity admin.\n\n* CapacityNotFound - The specified capacity does not exist.\n\n* EntityNotFound - The specified actor auto-detection rule does not exist.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Delete an actor auto-detection rule example": {
|
||||
"$ref": "./examples/actorAutoDetectionRules/DeleteActorAutoDetectionRule.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/operations/{operationId}": {
|
||||
"get": {
|
||||
"tags": [
|
||||
|
||||
@@ -106,10 +106,15 @@
|
||||
"readOnly": false
|
||||
},
|
||||
"creationPayload": {
|
||||
"description": "The warehouse creation payload. Use `creationPayload`. You can't use `definition` or `creationPayload` at the same time.",
|
||||
"description": "The warehouse creation payload. You cannot use `definition` and `creationPayload` at the same time.",
|
||||
"$ref": "#/definitions/WarehouseCreationPayload",
|
||||
"readOnly": false
|
||||
},
|
||||
"definition": {
|
||||
"description": "The warehouse definition. You cannot use `definition` and `creationPayload` at the same time.",
|
||||
"$ref": "#/definitions/WarehouseDefinition",
|
||||
"readOnly": false
|
||||
},
|
||||
"sensitivityLabelSettings": {
|
||||
"description": "The sensitivity label settings for the warehouse.",
|
||||
"$ref": "../common/definitions.json#/definitions/SensitivityLabelSettings",
|
||||
@@ -140,7 +145,7 @@
|
||||
}
|
||||
},
|
||||
"WarehouseDefinitionResponse": {
|
||||
"description": "Warehouse public definition response.",
|
||||
"description": "The warehouse public definition response.",
|
||||
"required": ["definition"],
|
||||
"properties": {
|
||||
"definition": {
|
||||
@@ -150,12 +155,12 @@
|
||||
}
|
||||
},
|
||||
"WarehouseDefinition": {
|
||||
"description": "Warehouse public definition object.",
|
||||
"description": "The warehouse public definition object. Refer to this [article](/rest/api/fabric/articles/item-management/definitions/warehouse-definition) for more details on the structure of the warehouse definition.",
|
||||
"type": "object",
|
||||
"required": ["parts"],
|
||||
"properties": {
|
||||
"format": {
|
||||
"description": "The format of the warehouse definition.",
|
||||
"description": "The format of the warehouse definition. Supported formats: `dacpac` and `sqlproj`. If no format is provided, `sqlproj` is used.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
@@ -172,14 +177,15 @@
|
||||
"WarehouseDefinitionPart": {
|
||||
"description": "Warehouse definition part object.",
|
||||
"type": "object",
|
||||
"required": ["path", "payload", "payloadType"],
|
||||
"properties": {
|
||||
"path": {
|
||||
"description": "The warehouse part path.",
|
||||
"description": "The warehouse public definition part path.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"payload": {
|
||||
"description": "The warehouse part payload.",
|
||||
"description": "The warehouse public definition part payload.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"createWarehouseRequest": {
|
||||
"displayName": "Warehouse 1",
|
||||
"description": "A warehouse description.",
|
||||
"definition": {
|
||||
"format": "dacpac",
|
||||
"parts": [
|
||||
{
|
||||
"path": "definition.dacpac",
|
||||
"payload": "UEsDBBQAAAAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAEAAAAGRlZmluaXRpb24uZGFjcGFj",
|
||||
"payloadType": "InlineBase64"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"201": {
|
||||
"body": {
|
||||
"displayName": "Warehouse 1",
|
||||
"description": "A warehouse description.",
|
||||
"type": "Warehouse",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"id": "5b218778-e7a5-4d73-8187-f10824047715"
|
||||
}
|
||||
},
|
||||
"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,46 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"createWarehouseRequest": {
|
||||
"displayName": "Warehouse 1",
|
||||
"description": "A warehouse description.",
|
||||
"definition": {
|
||||
"parts": [
|
||||
{
|
||||
"path": "sqldw.sqlproj",
|
||||
"payload": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4NCjxQcm9qZWN0IERlZmF1bHRUYXJnZXRzPSJCdWlsZCI+DQogIDxTZGs+TWljcm9zb2Z0LkJ1aWxkLlNxbC9TZGsNCiAgPC9TZGs+DQo8L1Byb2plY3Q+",
|
||||
"payloadType": "InlineBase64"
|
||||
},
|
||||
{
|
||||
"path": "dbo/Tables/Table1.sql",
|
||||
"payload": "Q1JFQVRFIFRBQkxFIFtkYm9dLltUYWJsZTFdIChbSWRdIElOVCBOT1QgTlVMTCwgW05hbWVdIE5WQVJDSEFSKDEwMCkp",
|
||||
"payloadType": "InlineBase64"
|
||||
},
|
||||
{
|
||||
"path": ".sharedqueries/query.sql",
|
||||
"payload": "U0VMRUNUIFtJZF0sIFtOYW1lXSBGUk9NIFtkYm9dLltUYWJsZTFd",
|
||||
"payloadType": "InlineBase64"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"201": {
|
||||
"body": {
|
||||
"displayName": "Warehouse 1",
|
||||
"description": "A warehouse description.",
|
||||
"type": "Warehouse",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"id": "5b218778-e7a5-4d73-8187-f10824047715"
|
||||
}
|
||||
},
|
||||
"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,34 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"warehouseId": "5b218778-e7a5-4d73-8187-f10824047715",
|
||||
"format": "dacpac"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"definition": {
|
||||
"parts": [
|
||||
{
|
||||
"path": "definition.dacpac",
|
||||
"payload": "UEsDBBQAAAAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAEAAAAGRlZmluaXRpb24uZGFjcGFj",
|
||||
"payloadType": "InlineBase64"
|
||||
},
|
||||
{
|
||||
"path": ".platform",
|
||||
"payload": "ewogICIkc2NoZW1hIjogImh0dHBzOi8vZGV2ZWxvcGVyLm1pY3Jvc29mdC5jb20vanNvbi1zY2hlbWFzL2ZhYnJpYy9naXRJbnRlZ3JhdGlvbi9wbGF0Zm9ybVByb3BlcnRpZXMvMi4wLjAvc2NoZW1hLmpzb24iLAogICJtZXRhZGF0YSI6IHsKICAgICJ0eXBlIjogIldhcmVob3VzZSIsCiAgICAiZGlzcGxheU5hbWUiOiAiV2FyZWhvdXNlXzEiCiAgfSwKICAiY29uZmlnIjogewogICAgInZlcnNpb24iOiAiMi4wIiwKICAgICJsb2dpY2FsSWQiOiAiMDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAwIgogIH0KfQ==",
|
||||
"payloadType": "InlineBase64"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"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,39 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"warehouseId": "5b218778-e7a5-4d73-8187-f10824047715",
|
||||
"format": "sqlproj"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"definition": {
|
||||
"parts": [
|
||||
{
|
||||
"path": "sqldw.sqlproj",
|
||||
"payload": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4NCjxQcm9qZWN0IERlZmF1bHRUYXJnZXRzPSJCdWlsZCI+DQogIDxTZGs+TWljcm9zb2Z0LkJ1aWxkLlNxbC9TZGsNCiAgPC9TZGs+DQo8L1Byb2plY3Q+",
|
||||
"payloadType": "InlineBase64"
|
||||
},
|
||||
{
|
||||
"path": "dbo/Tables/Table1.sql",
|
||||
"payload": "Q1JFQVRFIFRBQkxFIFtkYm9dLltUYWJsZTFdIChbSWRdIElOVCBOT1QgTlVMTCwgW05hbWVdIE5WQVJDSEFSKDEwMCkp",
|
||||
"payloadType": "InlineBase64"
|
||||
},
|
||||
{
|
||||
"path": ".sharedqueries/query.sql",
|
||||
"payload": "U0VMRUNUIFtJZF0sIFtOYW1lXSBGUk9NIFtkYm9dLltUYWJsZTFd",
|
||||
"payloadType": "InlineBase64"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"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,34 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"warehouseId": "5b218778-e7a5-4d73-8187-f10824047715",
|
||||
"updateMetadata": true,
|
||||
"updateWarehouseDefinitionRequest": {
|
||||
"definition": {
|
||||
"format": "dacpac",
|
||||
"parts": [
|
||||
{
|
||||
"path": "definition.dacpac",
|
||||
"payload": "UEsDBBQAAAAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAEAAAAGRlZmluaXRpb24uZGFjcGFj",
|
||||
"payloadType": "InlineBase64"
|
||||
},
|
||||
{
|
||||
"path": ".platform",
|
||||
"payload": "ewogICIkc2NoZW1hIjogImh0dHBzOi8vZGV2ZWxvcGVyLm1pY3Jvc29mdC5jb20vanNvbi1zY2hlbWFzL2ZhYnJpYy9naXRJbnRlZ3JhdGlvbi9wbGF0Zm9ybVByb3BlcnRpZXMvMi4wLjAvc2NoZW1hLmpzb24iLAogICJtZXRhZGF0YSI6IHsKICAgICJ0eXBlIjogIldhcmVob3VzZSIsCiAgICAiZGlzcGxheU5hbWUiOiAiV2FyZWhvdXNlXzEiCiAgfSwKICAiY29uZmlnIjogewogICAgInZlcnNpb24iOiAiMi4wIiwKICAgICJsb2dpY2FsSWQiOiAiMDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAwIgogIH0KfQ==",
|
||||
"payloadType": "InlineBase64"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {},
|
||||
"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,44 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"warehouseId": "5b218778-e7a5-4d73-8187-f10824047715",
|
||||
"updateMetadata": true,
|
||||
"updateWarehouseDefinitionRequest": {
|
||||
"definition": {
|
||||
"format": "sqlproj",
|
||||
"parts": [
|
||||
{
|
||||
"path": "sqldw.sqlproj",
|
||||
"payload": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4NCjxQcm9qZWN0IERlZmF1bHRUYXJnZXRzPSJCdWlsZCI+DQogIDxTZGs+TWljcm9zb2Z0LkJ1aWxkLlNxbC9TZGsNCiAgPC9TZGs+DQo8L1Byb2plY3Q+",
|
||||
"payloadType": "InlineBase64"
|
||||
},
|
||||
{
|
||||
"path": "dbo/Tables/Table1.sql",
|
||||
"payload": "Q1JFQVRFIFRBQkxFIFtkYm9dLltUYWJsZTFdIChbSWRdIElOVCBOT1QgTlVMTCwgW05hbWVdIE5WQVJDSEFSKDEwMCkp",
|
||||
"payloadType": "InlineBase64"
|
||||
},
|
||||
{
|
||||
"path": ".sharedqueries/query.sql",
|
||||
"payload": "U0VMRUNUIFtJZF0sIFtOYW1lXSBGUk9NIFtkYm9dLltUYWJsZTFd",
|
||||
"payloadType": "InlineBase64"
|
||||
},
|
||||
{
|
||||
"path": ".platform",
|
||||
"payload": "ewogICIkc2NoZW1hIjogImh0dHBzOi8vZGV2ZWxvcGVyLm1pY3Jvc29mdC5jb20vanNvbi1zY2hlbWFzL2ZhYnJpYy9naXRJbnRlZ3JhdGlvbi9wbGF0Zm9ybVByb3BlcnRpZXMvMi4wLjAvc2NoZW1hLmpzb24iLAogICJtZXRhZGF0YSI6IHsKICAgICJ0eXBlIjogIldhcmVob3VzZSIsCiAgICAiZGlzcGxheU5hbWUiOiAiV2FyZWhvdXNlXzEiCiAgfSwKICAiY29uZmlnIjogewogICAgInZlcnNpb24iOiAiMi4wIiwKICAgICJsb2dpY2FsSWQiOiAiMDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAwIgogIH0KfQ==",
|
||||
"payloadType": "InlineBase64"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {},
|
||||
"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
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
+218
-1
@@ -91,7 +91,7 @@
|
||||
},
|
||||
"post": {
|
||||
"summary": "Creates a warehouse in the specified workspace.",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n This API does not support create a warehouse with definition. \n\n## Permissions\n\nThe caller must have a *contributor* workspace role.\n\n## Required Delegated Scopes\n\n Warehouse.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations \n- To create a warehouse 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",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nTo create a warehouse with a public definition, see [Warehouse definition](/rest/api/fabric/articles/item-management/definitions/warehouse-definition).\n\n## Permissions\n\nThe caller must have a *contributor* workspace role.\n\n## Required Delegated Scopes\n\nWarehouse.ReadWrite.All or Item.ReadWrite.All\n\n## Limitations\n- To create a warehouse 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"
|
||||
],
|
||||
@@ -173,6 +173,12 @@
|
||||
},
|
||||
"Create a warehouse example with payload": {
|
||||
"$ref": "./examples/CreateWarehouseWithCreationPayload.json"
|
||||
},
|
||||
"Create a warehouse with definition (dacpac) example": {
|
||||
"$ref": "./examples/CreateWarehouseWithDefinitionDacpac.json"
|
||||
},
|
||||
"Create a warehouse with definition (sqlproj) example": {
|
||||
"$ref": "./examples/CreateWarehouseWithDefinitionSqlproj.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -600,6 +606,217 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/warehouses/{warehouseId}/getDefinition": {
|
||||
"post": {
|
||||
"summary": "Returns the specified warehouse public definition.",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a warehouse's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\nThe caller must have *read and write* permissions for the warehouse.\n\n## Required Delegated Scopes\n\nWarehouse.ReadWrite.All or Item.ReadWrite.All\n\n## Limitations\n\nTo retrieve the definition of a warehouse 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_GetWarehouseDefinition",
|
||||
"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": "warehouseId",
|
||||
"description": "The warehouse ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "format",
|
||||
"description": "The format of the warehouse public definition. Supported formats: `dacpac` and `sqlproj`. If no format is provided, `sqlproj` is used. Additional warehouse definition formats may be added over time.",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"dacpac",
|
||||
"sqlproj"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "WarehouseDefinitionFormat",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "dacpac",
|
||||
"description": "The warehouse definition in DACPAC format."
|
||||
},
|
||||
{
|
||||
"value": "sqlproj",
|
||||
"description": "The warehouse definition in SQL project format."
|
||||
}
|
||||
]
|
||||
},
|
||||
"required": false
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/WarehouseDefinitionResponse"
|
||||
}
|
||||
},
|
||||
"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 warehouse public definition in DACPAC format example": {
|
||||
"$ref": "./examples/GetWarehouseDefinitionDacpac.json"
|
||||
},
|
||||
"Get a warehouse public definition in SQL project format example": {
|
||||
"$ref": "./examples/GetWarehouseDefinitionSqlproj.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/warehouses/{warehouseId}/updateDefinition": {
|
||||
"post": {
|
||||
"summary": "Overrides the definition for the specified warehouse.",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nUpdating the warehouse's definition does not affect its sensitivity label.\n\n## Permissions\n\nThe caller must have *read and write* permissions for the warehouse.\n\n## Required Delegated Scopes\n\nWarehouse.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_UpdateWarehouseDefinition",
|
||||
"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": "warehouseId",
|
||||
"description": "The warehouse 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": "updateWarehouseDefinitionRequest",
|
||||
"description": "Update warehouse definition request payload.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/UpdateWarehouseDefinitionRequest"
|
||||
},
|
||||
"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 warehouse public definition in DACPAC format example": {
|
||||
"$ref": "./examples/UpdateWarehouseDefinitionDacpac.json"
|
||||
},
|
||||
"Update a warehouse public definition in SQL project format example": {
|
||||
"$ref": "./examples/UpdateWarehouseDefinitionSqlproj.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/warehouses/{itemId}/settings/sqlAudit": {
|
||||
"patch": {
|
||||
"summary": "Update settings associated with the warehouse.",
|
||||
|
||||
Reference in new issue
Block a user