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
a96c37a56b
commit
505f86c93a
72 files changed
+3854
-43
No files matched your search
@@ -0,0 +1,74 @@
|
||||
{
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"version": "v1",
|
||||
"title": "Admin connection data types"
|
||||
},
|
||||
"paths": {},
|
||||
"definitions": {
|
||||
"ListConnectionsResponse": {
|
||||
"required": [
|
||||
"value"
|
||||
],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"value": {
|
||||
"description": "A list of connections.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "../../platform/definitions/connections.json#/definitions/Connection"
|
||||
}
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "../../common/definitions.json#/definitions/PaginatedResponse"
|
||||
}
|
||||
]
|
||||
},
|
||||
"AddAdminConnectionRoleAssignmentRequest": {
|
||||
"type": "object",
|
||||
"description": "The add connection role assignment request for a principal.",
|
||||
"required": ["principal", "role"],
|
||||
"properties": {
|
||||
"principal": {
|
||||
"description": "The principal. Group principal type is not supported.",
|
||||
"readOnly": false,
|
||||
"$ref": "../../common/definitions.json#/definitions/Principal"
|
||||
},
|
||||
"role": {
|
||||
"description": "The connection role of the principal.",
|
||||
"readOnly": false,
|
||||
"$ref": "#/definitions/AssignableAdminConnectionRole"
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateAdminConnectionRoleAssignmentRequest": {
|
||||
"type": "object",
|
||||
"description": "An update connection role assignment request payload.",
|
||||
"required": ["role"],
|
||||
"properties": {
|
||||
"role": {
|
||||
"description": "The connection role of the principal.",
|
||||
"readOnly": false,
|
||||
"$ref": "#/definitions/AssignableAdminConnectionRole"
|
||||
}
|
||||
}
|
||||
},
|
||||
"AssignableAdminConnectionRole": {
|
||||
"type": "string",
|
||||
"description": "A connection role. Additional connection roles may be added over time.",
|
||||
"enum": ["Owner"],
|
||||
"x-ms-enum": {
|
||||
"name": "AssignableAdminConnectionRole",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "Owner",
|
||||
"description": "Enables the principal to gain ownership of the connection. The principal is initially assigned the 'PendingOwner' role and to complete the transition to 'Owner', the principal must update the connection credentials using [Update Connection API](/rest/api/fabric/core/connections/update-connection)."
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,27 @@
|
||||
{
|
||||
"parameters": {
|
||||
"connectionId": "f3a2e6af-d048-4f85-94d9-b3d16140df05",
|
||||
"addAdminConnectionRoleAssignmentRequest": {
|
||||
"principal": {
|
||||
"id": "6a002b3d-e4ec-43df-8c08-e8eb7547d9dd",
|
||||
"type": "User"
|
||||
},
|
||||
"role": "Owner"
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"201": {
|
||||
"headers": {
|
||||
"Location": "https://api.fabric.microsoft.com/v1/admin/connections/f3a2e6af-d048-4f85-94d9-b3d16140df05/roleAssignments/6a002b3d-e4ec-43df-8c08-e8eb7547d9dd"
|
||||
},
|
||||
"body": {
|
||||
"id": "6a002b3d-e4ec-43df-8c08-e8eb7547d9dd",
|
||||
"principal": {
|
||||
"id": "6a002b3d-e4ec-43df-8c08-e8eb7547d9dd",
|
||||
"type": "User"
|
||||
},
|
||||
"role": "Owner"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,8 @@
|
||||
{
|
||||
"parameters": {
|
||||
"connectionId": "536f7c95-1b4e-4d3a-8e7f-9c2d5a6b8e01"
|
||||
},
|
||||
"responses": {
|
||||
"200": {}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"parameters": {
|
||||
"connectionId": "a06fbff3-09e1-4958-a92b-2a7550459762",
|
||||
"connectionRoleAssignmentId": "b7439ed7-7331-4c59-b2bb-f4f917e61979"
|
||||
},
|
||||
"responses": {
|
||||
"200": {}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,26 @@
|
||||
{
|
||||
"parameters": {
|
||||
"connectionId": "f6a39b76-9816-4e4b-b93a-f42e405017b7"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"id": "f6a39b76-9816-4e4b-b93a-f42e405017b7",
|
||||
"displayName": "ContosoConnection",
|
||||
"gatewayId": "58376c10-5f61-4024-887e-748df4beae45",
|
||||
"connectivityType": "OnPremisesGateway",
|
||||
"connectionDetails": {
|
||||
"type": "SQL",
|
||||
"path": "contoso.database.windows.net;sales"
|
||||
},
|
||||
"privacyLevel": "Organizational",
|
||||
"credentialDetails": {
|
||||
"credentialType": "Basic",
|
||||
"singleSignOnType": "None",
|
||||
"connectionEncryption": "NotEncrypted",
|
||||
"skipTestConnection": false
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,18 @@
|
||||
{
|
||||
"parameters": {
|
||||
"connectionId": "4bbb41c0-1dcc-4a8c-aff5-c681a3d10208",
|
||||
"connectionRoleAssignmentId": "43970761-afc9-4428-ae6e-3b08bef098ff"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"id": "43970761-afc9-4428-ae6e-3b08bef098ff",
|
||||
"principal": {
|
||||
"id": "43970761-afc9-4428-ae6e-3b08bef098ff",
|
||||
"type": "User"
|
||||
},
|
||||
"role": "Owner"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,78 @@
|
||||
{
|
||||
"parameters": {},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"value": [
|
||||
{
|
||||
"id": "6952a7b2-aea3-414f-9d85-6c0fe5d34539",
|
||||
"displayName": "ContosoConnection1",
|
||||
"gatewayId": "8f72eea3-d989-4a5a-aeed-02b3aaa2ddd0",
|
||||
"connectivityType": "ShareableCloud",
|
||||
"connectionDetails": {
|
||||
"type": "Web",
|
||||
"path": "https://www.contoso.com"
|
||||
},
|
||||
"privacyLevel": "Public",
|
||||
"credentialDetails": {
|
||||
"credentialType": "Anonymous",
|
||||
"singleSignOnType": "None",
|
||||
"connectionEncryption": "NotEncrypted",
|
||||
"skipTestConnection": false
|
||||
},
|
||||
"connectionRecency": {
|
||||
"createdDateTime": "2023-05-23T16:22:20Z",
|
||||
"lastBoundDateTime": "2023-05-26T16:22:20Z",
|
||||
"lastCredentialUsedDateTime": "2023-05-27T16:22:20Z",
|
||||
"myLastBoundDateTime": "2023-05-24T16:22:20Z",
|
||||
"myLastCredentialUsedDateTime": "2023-05-25T16:22:20Z"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "f6a39b76-9816-4e4b-b93a-f42e405017b7",
|
||||
"displayName": "ContosoConnection2",
|
||||
"gatewayId": "58376c10-5f61-4024-887e-748df4beae45",
|
||||
"connectivityType": "OnPremisesGateway",
|
||||
"connectionDetails": {
|
||||
"type": "SQL",
|
||||
"path": "contoso.database.windows.net;sales"
|
||||
},
|
||||
"privacyLevel": "Organizational",
|
||||
"credentialDetails": {
|
||||
"credentialType": "Basic",
|
||||
"singleSignOnType": "None",
|
||||
"connectionEncryption": "Any",
|
||||
"skipTestConnection": false
|
||||
},
|
||||
"connectionRecency": {
|
||||
"createdDateTime": "2023-05-23T16:22:20Z",
|
||||
"lastBoundDateTime": "2023-05-26T16:22:20Z",
|
||||
"lastCredentialUsedDateTime": "2023-05-27T16:22:20Z",
|
||||
"myLastBoundDateTime": "2023-05-24T16:22:20Z",
|
||||
"myLastCredentialUsedDateTime": "2023-05-25T16:22:20Z"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "a3b4c5d6-7e8f-4a5b-9c0d-1e2f3a4b5c6d",
|
||||
"displayName": "ContosoStreamingVirtualNetworkGatewayConnection",
|
||||
"gatewayId": "3f8d6a4b-1c2e-4f5a-9b7c-2d6e8f1a3b9d",
|
||||
"connectivityType": "StreamingVirtualNetworkGateway",
|
||||
"connectionDetails": {
|
||||
"type": "SQL",
|
||||
"path": "contoso.database.windows.net;marketing"
|
||||
},
|
||||
"privacyLevel": "Organizational",
|
||||
"credentialDetails": {
|
||||
"credentialType": "Basic",
|
||||
"singleSignOnType": "None",
|
||||
"connectionEncryption": "Encrypted",
|
||||
"skipTestConnection": false
|
||||
}
|
||||
}
|
||||
],
|
||||
"continuationToken": "LDEsMTAwMDAwLDA%3D",
|
||||
"continuationUri": "https://api.fabric.microsoft.com/v1/connections?continuationToken=LDEsMTAwMDAwLDA%3D"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,45 @@
|
||||
{
|
||||
"parameters": {
|
||||
"connectionId": "9558d649-84f1-4b7e-850a-59b5d0ae95eb"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"value": [
|
||||
{
|
||||
"id": "1c15c348-dd88-4065-8f25-57581c216bcf",
|
||||
"principal": {
|
||||
"id": "1c15c348-dd88-4065-8f25-57581c216bcf",
|
||||
"type": "User"
|
||||
},
|
||||
"role": "Owner"
|
||||
},
|
||||
{
|
||||
"id": "d3a7dbf7-6641-48f2-851e-d71bbf9d90c4",
|
||||
"principal": {
|
||||
"id": "d3a7dbf7-6641-48f2-851e-d71bbf9d90c4",
|
||||
"type": "Group"
|
||||
},
|
||||
"role": "Owner"
|
||||
},
|
||||
{
|
||||
"id": "48ba22da-4431-4da4-8b70-3401685bf9e5",
|
||||
"principal": {
|
||||
"id": "48ba22da-4431-4da4-8b70-3401685bf9e5",
|
||||
"type": "Group"
|
||||
},
|
||||
"role": "User"
|
||||
},
|
||||
{
|
||||
"id": "1dfa1747-ce76-4caf-99c8-360b95f9f17a",
|
||||
"principal": {
|
||||
"id": "1dfa1747-ce76-4caf-99c8-360b95f9f17a",
|
||||
"type": "User"
|
||||
},
|
||||
"role": "UserWithReshare"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,47 @@
|
||||
{
|
||||
"parameters": {
|
||||
"connectionId": "9558d649-84f1-4b7e-850a-59b5d0ae95eb"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"value": [
|
||||
{
|
||||
"id": "1c15c348-dd88-4065-8f25-57581c216bcf",
|
||||
"principal": {
|
||||
"id": "1c15c348-dd88-4065-8f25-57581c216bcf",
|
||||
"type": "User"
|
||||
},
|
||||
"role": "Owner"
|
||||
},
|
||||
{
|
||||
"id": "d3a7dbf7-6641-48f2-851e-d71bbf9d90c4",
|
||||
"principal": {
|
||||
"id": "d3a7dbf7-6641-48f2-851e-d71bbf9d90c4",
|
||||
"type": "Group"
|
||||
},
|
||||
"role": "Owner"
|
||||
},
|
||||
{
|
||||
"id": "48ba22da-4431-4da4-8b70-3401685bf9e5",
|
||||
"principal": {
|
||||
"id": "48ba22da-4431-4da4-8b70-3401685bf9e5",
|
||||
"type": "Group"
|
||||
},
|
||||
"role": "User"
|
||||
},
|
||||
{
|
||||
"id": "1dfa1747-ce76-4caf-99c8-360b95f9f17a",
|
||||
"principal": {
|
||||
"id": "1dfa1747-ce76-4caf-99c8-360b95f9f17a",
|
||||
"type": "User"
|
||||
},
|
||||
"role": "UserWithReshare"
|
||||
}
|
||||
],
|
||||
"continuationToken": "LDEsMTAwMDAwLDA%3D",
|
||||
"continuationUri": "https://api.fabric.microsoft.com/v1/admin/connections/9558d649-84f1-4b7e-850a-59b5d0ae95eb/roleAssignments?continuationToken=LDEsMTAwMDAwLDA%3D"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,21 @@
|
||||
{
|
||||
"parameters": {
|
||||
"connectionId": "fe8e181d-dbb8-471a-99f0-fdbf0a2ad4fd",
|
||||
"connectionRoleAssignmentId": "43970761-afc9-4428-ae6e-3b08bef098ff",
|
||||
"updateAdminConnectionRoleAssignmentRequest": {
|
||||
"role": "Owner"
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"id": "43970761-afc9-4428-ae6e-3b08bef098ff",
|
||||
"principal": {
|
||||
"id": "43970761-afc9-4428-ae6e-3b08bef098ff",
|
||||
"type": "User"
|
||||
},
|
||||
"role": "Owner"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -3667,6 +3667,501 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/connections": {
|
||||
"get": {
|
||||
"summary": "Returns a list of connections in the tenant.",
|
||||
"description": "> [!NOTE]\n> Fabric tenant admin connection management is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\n## Permissions\n\nThe caller must be a Fabric administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All\n\n## Limitations\n\nNone.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Connections"
|
||||
],
|
||||
"x-ms-pageable": {
|
||||
"nextLinkName": "continuationUri"
|
||||
},
|
||||
"operationId": "Connections_ListConnections",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "query",
|
||||
"name": "continuationToken",
|
||||
"description": "A token for retrieving the next page of results.",
|
||||
"type": "string",
|
||||
"required": false
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK. The operation was successful.",
|
||||
"schema": {
|
||||
"$ref": "./definitions/connections.json#/definitions/ListConnectionsResponse"
|
||||
}
|
||||
},
|
||||
"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* Unauthorized - The caller doesn't have permission to call the API.\n\n* InternalServerError - Unexpected server error.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"List connections as admin example": {
|
||||
"$ref": "./examples/connections/ListConnection.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/connections/{connectionId}": {
|
||||
"get": {
|
||||
"summary": "Returns the specified connection.",
|
||||
"description": "> [!NOTE]\n> Fabric tenant admin connection management is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\n## Permissions\n\nThe caller must be a Fabric administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All\n\n## Limitations\n\nNone.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Connections"
|
||||
],
|
||||
"operationId": "Connections_GetConnection",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "connectionId",
|
||||
"description": "The connection ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK. The operation was successful.",
|
||||
"schema": {
|
||||
"$ref": "../platform/definitions/connections.json#/definitions/Connection"
|
||||
}
|
||||
},
|
||||
"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* EntityNotFound - The requested resource could not be found.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Get connection as admin example": {
|
||||
"$ref": "./examples/connections/GetConnection.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Deletes the specified connection.",
|
||||
"description": "> [!NOTE]\n> Fabric tenant admin connection management is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\n## Permissions\n\nThe caller must be a Fabric administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.ReadWrite.All\n\n## Limitations\n\nNone.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Connections"
|
||||
],
|
||||
"operationId": "Connections_DeleteConnection",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "connectionId",
|
||||
"description": "The connection ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK. The operation was successful."
|
||||
},
|
||||
"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* EntityNotFound - The requested resource could not be found.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Delete connection as admin example": {
|
||||
"$ref": "./examples/connections/DeleteConnection.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/connections/{connectionId}/roleAssignments": {
|
||||
"get": {
|
||||
"summary": "Returns a list of connection role assignments.",
|
||||
"description": "> [!NOTE]\n> Fabric tenant admin connection 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 be a Fabric administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All\n\n## Limitations\n\nNo additional limitations.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Connections"
|
||||
],
|
||||
"operationId": "Connections_ListConnectionRoleAssignments",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"x-ms-pageable": {
|
||||
"nextLinkName": "continuationUri"
|
||||
},
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "connectionId",
|
||||
"description": "The connection 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": "OK. The operation was successful.",
|
||||
"schema": {
|
||||
"$ref": "../platform/definitions/connections.json#/definitions/ConnectionRoleAssignments"
|
||||
}
|
||||
},
|
||||
"429": {
|
||||
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
||||
"x-ms-error-response": true,
|
||||
"headers": {
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
},
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* UnknownError - An error occurred.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"List connection role assignments as admin example": {
|
||||
"$ref": "./examples/connections/ListConnectionRoleAssignments.json"
|
||||
},
|
||||
"List connection role assignments with continuation as admin example": {
|
||||
"$ref": "./examples/connections/ListConnectionRoleAssignmentsWithContinuation.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"post": {
|
||||
"summary": "Adds a connection role assignment.",
|
||||
"description": "> [!NOTE]\n> Fabric tenant admin connection management is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\n## Permissions\n\nThe caller must be a Fabric administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.ReadWrite.All\n\n## Limitations\n\nNo additional limitations.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Connections"
|
||||
],
|
||||
"operationId": "Connections_AddConnectionRoleAssignment",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "connectionId",
|
||||
"description": "The connection ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "body",
|
||||
"name": "addAdminConnectionRoleAssignmentRequest",
|
||||
"description": "The request payload for adding a connection role assignment.",
|
||||
"schema": {
|
||||
"$ref": "./definitions/connections.json#/definitions/AddAdminConnectionRoleAssignmentRequest"
|
||||
},
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"201": {
|
||||
"description": "Successfully created.",
|
||||
"headers": {
|
||||
"Location": {
|
||||
"description": "The URL of the newly created connection role assignment.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"schema": {
|
||||
"$ref": "../platform/definitions/connections.json#/definitions/ConnectionRoleAssignment"
|
||||
}
|
||||
},
|
||||
"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* UnsupportedPrincipalType - The group principal type is not supported for this operation.\n\n* InvalidInput - Missing required parameter.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Add connection role assignment as admin example": {
|
||||
"$ref": "./examples/connections/AddAdminConnectionRoleAssignment.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/connections/{connectionId}/roleAssignments/{connectionRoleAssignmentId}": {
|
||||
"get": {
|
||||
"summary": "Returns the principal's role assignment for the connection.",
|
||||
"description": "> [!NOTE]\n> Fabric tenant admin connection management is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\n## Permissions\n\nThe caller must be a Fabric administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All\n\n## Limitations\n\nNo additional limitations.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Connections"
|
||||
],
|
||||
"operationId": "Connections_GetConnectionRoleAssignment",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "connectionId",
|
||||
"description": "The connection ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "connectionRoleAssignmentId",
|
||||
"description": "The ID of the connection role assignment.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK. The operation was successful.",
|
||||
"schema": {
|
||||
"$ref": "../platform/definitions/connections.json#/definitions/ConnectionRoleAssignment"
|
||||
}
|
||||
},
|
||||
"429": {
|
||||
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
||||
"x-ms-error-response": true,
|
||||
"headers": {
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
},
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* UnknownError - An error occurred.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Get connection role assignment as admin example": {
|
||||
"$ref": "./examples/connections/GetConnectionRoleAssignment.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"patch": {
|
||||
"summary": "Updates the principal's role assignment for the connection.",
|
||||
"description": "> [!NOTE]\n> Fabric tenant admin connection management is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\n## Permissions\n\nThe caller must be a Fabric administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.ReadWrite.All\n\n## Limitations\n\nNo additional limitations.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Connections"
|
||||
],
|
||||
"operationId": "Connections_UpdateConnectionRoleAssignment",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "connectionId",
|
||||
"description": "The connection ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "connectionRoleAssignmentId",
|
||||
"description": "The ID of the connection role assignment.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "body",
|
||||
"name": "updateAdminConnectionRoleAssignmentRequest",
|
||||
"description": "An update connection role assignment request payload.",
|
||||
"schema": {
|
||||
"$ref": "./definitions/connections.json#/definitions/UpdateAdminConnectionRoleAssignmentRequest"
|
||||
},
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK. The operation was successful.",
|
||||
"schema": {
|
||||
"$ref": "../platform/definitions/connections.json#/definitions/ConnectionRoleAssignment"
|
||||
}
|
||||
},
|
||||
"429": {
|
||||
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
||||
"x-ms-error-response": true,
|
||||
"headers": {
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
},
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* UnknownError - An error occurred.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Update connection role assignment as admin example": {
|
||||
"$ref": "./examples/connections/UpdateAdminConnectionRoleAssignment.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Deletes the specified role assignment for the connection.",
|
||||
"description": "> [!NOTE]\n> Fabric tenant admin connection management is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\n## Permissions\n\nThe caller must be a Fabric administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.ReadWrite.All\n\n## Limitations\n\nNo additional limitations.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Connections"
|
||||
],
|
||||
"operationId": "Connections_DeleteConnectionRoleAssignment",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "connectionId",
|
||||
"description": "The connection ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "connectionRoleAssignmentId",
|
||||
"description": "The ID of the connection role assignment.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK. The operation was successful."
|
||||
},
|
||||
"429": {
|
||||
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
||||
"x-ms-error-response": true,
|
||||
"headers": {
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
},
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* UnknownError - An error occurred.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Delete connection role assignment as admin example": {
|
||||
"$ref": "./examples/connections/DeleteConnectionRoleAssignment.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {},
|
||||
|
||||
@@ -268,7 +268,7 @@
|
||||
"ItemType": {
|
||||
"description": "The type of the item. Additional item types may be added over time.",
|
||||
"type": "string",
|
||||
"enum": [ "Dashboard", "Report", "SemanticModel", "PaginatedReport", "Datamart", "Lakehouse", "Eventhouse", "Environment", "KQLDatabase", "KQLQueryset", "KQLDashboard", "DataPipeline", "Notebook", "SparkJobDefinition", "MLExperiment", "MLModel", "Warehouse", "Eventstream", "SQLEndpoint", "MirroredWarehouse", "MirroredDatabase", "Reflex", "GraphQLApi", "MountedDataFactory", "SQLDatabase", "CopyJob", "VariableLibrary", "Dataflow", "ApacheAirflowJob", "WarehouseSnapshot", "DigitalTwinBuilder", "DigitalTwinBuilderFlow", "MirroredAzureDatabricksCatalog", "Map", "AnomalyDetector", "UserDataFunction", "GraphModel", "GraphQuerySet", "SnowflakeDatabase", "OperationsAgent", "CosmosDBDatabase", "Ontology", "EventSchemaSet", "DataAgent", "MirroredCatalog", "PolicySet", "AppBackend", "OrgApp", "OrgAppAudience", "DataBuildToolJob", "AzureDatabricksStorage", "Plan", "Monitoring" ],
|
||||
"enum": [ "Dashboard", "Report", "SemanticModel", "PaginatedReport", "Datamart", "Lakehouse", "Eventhouse", "Environment", "KQLDatabase", "KQLQueryset", "KQLDashboard", "DataPipeline", "Notebook", "SparkJobDefinition", "MLExperiment", "MLModel", "Warehouse", "Eventstream", "SQLEndpoint", "MirroredWarehouse", "MirroredDatabase", "Reflex", "GraphQLApi", "MountedDataFactory", "SQLDatabase", "CopyJob", "VariableLibrary", "Dataflow", "ApacheAirflowJob", "WarehouseSnapshot", "DigitalTwinBuilder", "DigitalTwinBuilderFlow", "MirroredAzureDatabricksCatalog", "Map", "AnomalyDetector", "UserDataFunction", "GraphModel", "GraphQuerySet", "SnowflakeDatabase", "OperationsAgent", "CosmosDBDatabase", "Ontology", "EventSchemaSet", "DataAgent", "MirroredCatalog", "PolicySet", "AppBackend", "OrgApp", "OrgAppAudience", "DataBuildToolJob", "AzureDatabricksStorage", "Plan", "Monitoring", "DeploymentPlan" ],
|
||||
"x-ms-enum": {
|
||||
"name": "ItemType",
|
||||
"modelAsString": true,
|
||||
@@ -484,6 +484,10 @@
|
||||
{
|
||||
"value": "Monitoring",
|
||||
"description": "A Monitoring item."
|
||||
},
|
||||
{
|
||||
"value": "DeploymentPlan",
|
||||
"description": "A Deployment plan."
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
@@ -1004,7 +1004,7 @@
|
||||
"/workspaces/{workspaceId}/dataflows/gen1Upgrade": {
|
||||
"post": {
|
||||
"summary": "Upgrades Gen1 dataflows in the specified workspace.",
|
||||
"description": "> [!NOTE]\n> Gen1 dataflow upgrade 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\nUpgrades a caller-supplied batch of Gen1 dataflows to Dataflow Gen2 in place. Each successful upgrade preserves the dataflow identifier and workspace. The batch supports partial success. The operation returns the batch result synchronously when processing completes immediately, or returns an accepted response for asynchronous processing and makes the result available through the long-running operation.\n\n## Permissions\n\nThe caller must own each dataflow being upgraded or have the *admin* workspace role. Authorization is evaluated independently for each dataflow; an unauthorized dataflow is returned as a failed result row without failing the batch request.\n\n## Required Delegated Scopes\n\nDataflow.ReadWrite.All or Item.ReadWrite.All\n\n## Limitations\n\n- Each request must contain between 1 and 50 dataflows from the specified workspace.\n- Upgrades run in place and do not support cross-workspace targets.\n- Cancellation is not supported.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"description": "> [!NOTE]\n> Gen1 dataflow upgrade 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\nUpgrades a caller-supplied batch of Gen1 dataflows to Dataflow Gen2 in place. Each successful upgrade preserves the dataflow identifier and workspace. The batch supports partial success. The operation returns the batch result synchronously when processing completes immediately, or returns an accepted response for asynchronous processing and makes the result available through the long-running operation.\n\n## Permissions\n\nThe caller must own each dataflow being upgraded or have the *admin* workspace role. Authorization is evaluated independently for each dataflow; an unauthorized dataflow is returned as a failed result row without failing the batch request.\n\n## Required Delegated Scopes\n\nDataflow.ReadWrite.All or Item.ReadWrite.All\n\n## Limitations\n\n- Each request must contain between 1 and 50 dataflows from the specified workspace.\n- The request body must not exceed 13 KiB (13,312 bytes), including whitespace.\n- Upgrades run in place and do not support cross-workspace targets.\n- Cancellation is not supported.\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": [
|
||||
"Upgrade"
|
||||
],
|
||||
|
||||
@@ -0,0 +1,166 @@
|
||||
{
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"title": "Deployment plan data types",
|
||||
"version": "v1"
|
||||
},
|
||||
"paths": {},
|
||||
"definitions": {
|
||||
"DeploymentPlan": {
|
||||
"description": "A deployment plan object.",
|
||||
"type": "object",
|
||||
"required": ["type"],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "../common/definitions.json#/definitions/Item"
|
||||
}
|
||||
]
|
||||
},
|
||||
"DeploymentPlans": {
|
||||
"description": "A list of deployment plans.",
|
||||
"required": ["value"],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"value": {
|
||||
"description": "A list of deployment plans.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/DeploymentPlan"
|
||||
},
|
||||
"readOnly": true
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
|
||||
}
|
||||
]
|
||||
},
|
||||
"CreateDeploymentPlanRequest": {
|
||||
"description": "The request payload for creating a deployment plan.",
|
||||
"required": ["displayName"],
|
||||
"properties": {
|
||||
"displayName": {
|
||||
"description": "The deployment plan display name. The display name must follow naming rules according to the item type.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"description": {
|
||||
"description": "The deployment plan description. Maximum length is 256 characters.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"folderId": {
|
||||
"description": "The folder ID. If not specified or null, the deployment plan is created with the workspace as its folder.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"readOnly": false
|
||||
},
|
||||
"definition": {
|
||||
"description": "The deployment plan public definition.",
|
||||
"$ref": "#/definitions/DeploymentPlanPublicDefinition",
|
||||
"readOnly": false
|
||||
},
|
||||
"sensitivityLabelSettings": {
|
||||
"description": "The sensitivity label settings for the deployment plan.",
|
||||
"$ref": "../common/definitions.json#/definitions/SensitivityLabelSettings",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateDeploymentPlanDefinitionRequest": {
|
||||
"description": "The request payload for updating a deployment plan public definition.",
|
||||
"required": ["definition"],
|
||||
"properties": {
|
||||
"definition": {
|
||||
"$ref": "#/definitions/DeploymentPlanPublicDefinition",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"DeploymentPlanDefinitionResponse": {
|
||||
"description": "The response payload for a deployment plan public definition.",
|
||||
"required": ["definition"],
|
||||
"properties": {
|
||||
"definition": {
|
||||
"$ref": "#/definitions/DeploymentPlanPublicDefinition",
|
||||
"readOnly": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"DeploymentPlanPublicDefinition" : {
|
||||
"description": "The deployment plan public definition object. Refer to this [article](/rest/api/fabric/articles/item-management/definitions/deployment-plan-definition) for more details on the structure of the deployment plan definition.",
|
||||
"type": "object",
|
||||
"required": ["parts"],
|
||||
"properties": {
|
||||
"format": {
|
||||
"description": "The format of the deployment plan definition. Additional `format` types may be added over time.",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"DeploymentPlanFormat"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "DeploymentPlanDefinitionFormat",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "DeploymentPlanFormat",
|
||||
"description": "The format for deployment plan definitions, designed to support CI/CD scenarios in Fabric. See [Deployment plan - DeploymentPlanV1 specification](/rest/api/fabric/articles/item-management/definitions/deployment-plan-definition) for more details."
|
||||
}
|
||||
]
|
||||
},
|
||||
"readOnly": false
|
||||
},
|
||||
"parts": {
|
||||
"description": "A list of definition parts.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/DeploymentPlanPublicDefinitionPart"
|
||||
},
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"DeploymentPlanPublicDefinitionPart": {
|
||||
"description": "The deployment plan definition part object.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"path": {
|
||||
"description": "The deployment plan public definition part path.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"payload": {
|
||||
"description": "The deployment plan public definition part payload.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"payloadType":{
|
||||
"description": "The payload type.",
|
||||
"$ref": "../common/definitions.json#/definitions/PayloadType",
|
||||
"readOnly": false
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"path",
|
||||
"payload",
|
||||
"payloadType"
|
||||
]
|
||||
},
|
||||
"UpdateDeploymentPlanRequest": {
|
||||
"description": "The request payload for updating a deployment plan.",
|
||||
"properties": {
|
||||
"displayName": {
|
||||
"description": "The deployment plan display name. The display name must follow naming rules according to item type.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"description": {
|
||||
"description": "The deployment plan description. Maximum length is 256 characters.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,42 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"createDeploymentPlanRequest": {
|
||||
"displayName": "DeploymentPlan 1",
|
||||
"description": "A deployment plan description.",
|
||||
"definition": {
|
||||
"format": "DeploymentPlanFormat",
|
||||
"parts": [
|
||||
{
|
||||
"path": "plan.yml",
|
||||
"payload": "eyJleGVjdXRhYmxlRm9ybWF0IjoiRGVwbG95bWVudFBsYW5WMSIsImlkIjoiOWRmNDhhY2ZmZTgifQ==",
|
||||
"payloadType": "InlineBase64"
|
||||
},
|
||||
{
|
||||
"path": ".platform",
|
||||
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
|
||||
"payloadType": "InlineBase64"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"201": {
|
||||
"body": {
|
||||
"displayName": "DeploymentPlan 1",
|
||||
"description": "A deployment plan description.",
|
||||
"type": "DeploymentPlan",
|
||||
"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,27 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"createDeploymentPlanRequest": {
|
||||
"displayName": "DeploymentPlan 1",
|
||||
"description": "A deployment plan description."
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"201": {
|
||||
"body": {
|
||||
"displayName": "DeploymentPlan 1",
|
||||
"description": "A deployment plan description.",
|
||||
"type": "DeploymentPlan",
|
||||
"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,9 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"deploymentPlanId": "5b218778-e7a5-4d73-8187-f10824047715"
|
||||
},
|
||||
"responses": {
|
||||
"200": {}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,17 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
|
||||
"deploymentPlanId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"id": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
|
||||
"displayName": "DeploymentPlan 1",
|
||||
"description": "A deployment plan description.",
|
||||
"type": "DeploymentPlan",
|
||||
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,33 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "6e335e92-a2a2-4b5a-970a-bd6a89fbb765",
|
||||
"deploymentPlanId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"definition": {
|
||||
"parts": [
|
||||
{
|
||||
"path": "plan.yml",
|
||||
"payload": "ew0KICAiZXhlY3V0YWJsZUZvcm1hdCI6IkRlcGxveW1lbnRQbGFuVjEiLA0KICAiaWQiOiI5ZGY0OGFjZmZlOCINCn0=",
|
||||
"payloadType": "InlineBase64"
|
||||
},
|
||||
{
|
||||
"path": ".platform",
|
||||
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
|
||||
"payloadType": "InlineBase64"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"202": {
|
||||
"headers": {
|
||||
"Location": "https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
|
||||
"x-ms-operation-id": "431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
|
||||
"Retry-After": 30
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,27 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"value": [
|
||||
{
|
||||
"id": "3546052c-ae64-4526-b1a8-52af7761426f",
|
||||
"displayName": "DeploymentPlan Name 1",
|
||||
"description": "A deployment plan description.",
|
||||
"type": "DeploymentPlan",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
|
||||
},
|
||||
{
|
||||
"id": "f697fb63-abd4-4399-9548-be7e3c3c0dac",
|
||||
"displayName": "DeploymentPlan Name 2",
|
||||
"description": "A deployment plan description.",
|
||||
"type": "DeploymentPlan",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,21 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"deploymentPlanId": "5b218778-e7a5-4d73-8187-f10824047715",
|
||||
"updateDeploymentPlanRequest": {
|
||||
"displayName": "DeploymentPlan's New name",
|
||||
"description": "Deployment plan's new description."
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"displayName": "DeploymentPlan's New name",
|
||||
"description": "Deployment plan's new description.",
|
||||
"type": "DeploymentPlan",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"id": "5b218778-e7a5-4d73-8187-f10824047715"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,34 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"deploymentPlanId": "5b218778-e7a5-4d73-8187-f10824047715",
|
||||
"updateMetadata" : true,
|
||||
"updateDeploymentPlanDefinitionRequest": {
|
||||
"definition": {
|
||||
"parts": [
|
||||
{
|
||||
"path": "plan.yml",
|
||||
"payload": "ew0KICAiZXhlY3V0YWJsZUZvcm1hdCI6IkRlcGxveW1lbnRQbGFuVjEiLA0KICAiaWQiOiI5ZGY0OGFjZmZlOCINCn0=",
|
||||
"payloadType": "InlineBase64"
|
||||
},
|
||||
{
|
||||
"path": ".platform",
|
||||
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
|
||||
"payloadType": "InlineBase64"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
},
|
||||
"202": {
|
||||
"headers": {
|
||||
"Location": "https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef",
|
||||
"x-ms-operation-id": "427f6c34-b64e-4ee4-8ea5-b533c0e203ef",
|
||||
"Retry-After": 30
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,569 @@
|
||||
{
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"title": "Deployment plan REST APIs",
|
||||
"version": "v1"
|
||||
},
|
||||
"schemes": [
|
||||
"https"
|
||||
],
|
||||
"host": "api.fabric.microsoft.com",
|
||||
"basePath": "/v1",
|
||||
"paths": {
|
||||
"/workspaces/{workspaceId}/deploymentPlans": {
|
||||
"get": {
|
||||
"summary": "Lists deployment plans in the specified workspace.",
|
||||
"description": "> [!NOTE]\n> Deployment plan item 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 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_ListDeploymentPlans",
|
||||
"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": "recursive",
|
||||
"description": "Lists items in the specified folder and its nested folders, or only in the specified folder. When set to `true`, all items in the folder and its nested folders are listed. When set to `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
|
||||
},
|
||||
{
|
||||
"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/DeploymentPlans"
|
||||
}
|
||||
},
|
||||
"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 deployment plans in workspace example": {
|
||||
"$ref": "./examples/ListDeploymentPlansInWorkspace.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"post": {
|
||||
"summary": "Creates a deployment plan in the specified workspace.",
|
||||
"description": "> [!NOTE]\n> Deployment plan item 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\nTo create a deployment plan with a definition, refer to [deployment plan](/rest/api/fabric/articles/item-management/definitions/deployment-plan-definition) article.\n\n## Permissions\n\nThe caller must have a *contributor* workspace role.\n\n## Required Delegated Scopes\n\nItem.ReadWrite.All\n\n## Limitations\n\n- To create a deployment plan, 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_CreateDeploymentPlan",
|
||||
"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": "createDeploymentPlanRequest",
|
||||
"description": "Create item request payload.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/CreateDeploymentPlanRequest"
|
||||
},
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"201": {
|
||||
"description": "Successfully created.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/DeploymentPlan"
|
||||
}
|
||||
},
|
||||
"202": {
|
||||
"description": "Request accepted, deployment plan 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 deployment plan example": {
|
||||
"$ref": "./examples/CreateDeploymentPlanWithoutDefinition.json"
|
||||
},
|
||||
"Create a deployment plan with definition example": {
|
||||
"$ref": "./examples/CreateDeploymentPlan.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/deploymentPlans/{deploymentPlanId}": {
|
||||
"get": {
|
||||
"summary": "Gets the specified deployment plan.",
|
||||
"description": "> [!NOTE]\n> Deployment plan item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\n## Permissions\n\nThe caller must have *read* permissions for the deployment plan.\n\n## Required Delegated Scopes\n\nItem.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_GetDeploymentPlan",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "workspaceId",
|
||||
"description": "The workspace ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "deploymentPlanId",
|
||||
"description": "The deployment plan ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/DeploymentPlan"
|
||||
}
|
||||
},
|
||||
"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 deployment plan example": {
|
||||
"$ref": "./examples/GetDeploymentPlan.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"patch": {
|
||||
"summary": "Updates the specified deployment plan.",
|
||||
"description": "> [!NOTE]\n> Deployment plan item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\n## Permissions\n\nThe caller must have *read and write* permissions for the deployment plan.\n\n## Required Delegated Scopes\n\nItem.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_UpdateDeploymentPlan",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "workspaceId",
|
||||
"description": "The workspace ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "deploymentPlanId",
|
||||
"description": "The deployment plan ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "body",
|
||||
"name": "updateDeploymentPlanRequest",
|
||||
"description": "Update deployment plan request payload.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/UpdateDeploymentPlanRequest"
|
||||
},
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/DeploymentPlan"
|
||||
}
|
||||
},
|
||||
"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 deployment plan example": {
|
||||
"$ref": "./examples/UpdateDeploymentPlan.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Deletes the specified deployment plan.",
|
||||
"description": "> [!NOTE]\n> Deployment plan item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\n## Permissions\n\nThe caller must have *write* permissions for the deployment plan.\n\n## Required Delegated Scopes\n\nItem.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_DeleteDeploymentPlan",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "workspaceId",
|
||||
"description": "The workspace ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "deploymentPlanId",
|
||||
"description": "The deployment plan 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.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Delete a deployment plan example": {
|
||||
"$ref": "./examples/DeleteDeploymentPlan.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/deploymentPlans/{deploymentPlanId}/getDefinition": {
|
||||
"post": {
|
||||
"summary": "Gets the deployment plan definition.",
|
||||
"description": "> [!NOTE]\n> Deployment plan item 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\nWhen you get a deployment plan's 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 deployment plan.\n\n## Required Delegated Scopes\n\nItem.ReadWrite.All\n\n## Limitations\n\nTo retrieve the definition of a deployment plan 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_GetDeploymentPlanDefinition",
|
||||
"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": "deploymentPlanId",
|
||||
"description": "The deployment plan ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "format",
|
||||
"description": "The format of the deployment plan definition.",
|
||||
"type": "string",
|
||||
"required": false
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/DeploymentPlanDefinitionResponse"
|
||||
}
|
||||
},
|
||||
"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 deployment plan definition example": {
|
||||
"$ref": "./examples/GetDeploymentPlanDefinition.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/deploymentPlans/{deploymentPlanId}/updateDefinition": {
|
||||
"post": {
|
||||
"summary": "Updates the deployment plan definition.",
|
||||
"description": "> [!NOTE]\n> Deployment plan item 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\nUpdating the deployment plan's definition does not affect its sensitivity label.\n\n## Permissions\n\nThe caller must have *read and write* permissions for the deployment plan.\n\n## Required Delegated Scopes\n\nItem.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_UpdateDeploymentPlanDefinition",
|
||||
"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": "deploymentPlanId",
|
||||
"description": "The deployment plan 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": "updateDeploymentPlanDefinitionRequest",
|
||||
"description": "Update deployment plan definition request payload.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/UpdateDeploymentPlanDefinitionRequest"
|
||||
},
|
||||
"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 deployment plan definition example": {
|
||||
"$ref": "./examples/UpdateDeploymentPlanDefinition.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {},
|
||||
"security": [],
|
||||
"tags": []
|
||||
}
|
||||
@@ -469,7 +469,7 @@
|
||||
"description": "End time of publish operation in UTC, using the YYYY-MM-DDTHH:mm:ss.sssssssZ format.",
|
||||
"format": "date-time",
|
||||
"type": "string"
|
||||
},
|
||||
},
|
||||
"componentPublishInfo": {
|
||||
"description": "Environment component publish information.",
|
||||
"$ref": "#/definitions/ComponentPublishInfo"
|
||||
@@ -590,7 +590,7 @@
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
},
|
||||
"Libraries": {
|
||||
"description": "Environment libraries.",
|
||||
"type": "object",
|
||||
@@ -754,6 +754,244 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"PoolActivations": {
|
||||
"description": "A paginated list of pool activations.",
|
||||
"type": "object",
|
||||
"required": ["value"],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
|
||||
}
|
||||
],
|
||||
"properties": {
|
||||
"value": {
|
||||
"description": "A list of pool activations.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/PoolActivation"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"PoolActivation": {
|
||||
"description": "A pool activation object.",
|
||||
"type": "object",
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/CustomLivePoolSettings"
|
||||
}
|
||||
],
|
||||
"properties": {
|
||||
"jobInstanceId": {
|
||||
"description": "The pool activation job instance identifier.",
|
||||
"type": "string",
|
||||
"format": "uuid"
|
||||
},
|
||||
"name": {
|
||||
"description": "The pool activation name.",
|
||||
"type": "string"
|
||||
},
|
||||
"capacityId": {
|
||||
"description": "The capacity identifier.",
|
||||
"type": "string",
|
||||
"format": "uuid"
|
||||
},
|
||||
"state": {
|
||||
"description": "The current lifecycle state of the activation.",
|
||||
"$ref": "#/definitions/JobHistoryStatus"
|
||||
},
|
||||
"scheduledStartDateTime": {
|
||||
"description": "The scheduled start time in UTC, using the YYYY-MM-DDTHH:mm:ssZ format.",
|
||||
"type": "string"
|
||||
},
|
||||
"startDateTime": {
|
||||
"description": "The actual start time in UTC, using the YYYY-MM-DDTHH:mm:ssZ format.",
|
||||
"type": "string"
|
||||
},
|
||||
"scheduledEndDateTime": {
|
||||
"description": "The scheduled end time in UTC, using the YYYY-MM-DDTHH:mm:ssZ format.",
|
||||
"type": "string"
|
||||
},
|
||||
"endDateTime": {
|
||||
"description": "The actual end time in UTC, using the YYYY-MM-DDTHH:mm:ssZ format. Omitted if the activation is ongoing.",
|
||||
"type": "string"
|
||||
},
|
||||
"isRecurring": {
|
||||
"description": "Whether the activation recurs on a schedule.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"cancellationReason": {
|
||||
"description": "The reason for cancellation, if applicable.",
|
||||
"type": "string"
|
||||
},
|
||||
"jobType": {
|
||||
"description": "The monitoring job type classification.",
|
||||
"type": "string"
|
||||
},
|
||||
"runtimeVersion": {
|
||||
"description": "The Fabric runtime version used for the activation.",
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"PoolActivationDetails": {
|
||||
"description": "A pool activation details object with extended diagnostic properties.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"sparkConfiguration"
|
||||
],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/PoolActivation"
|
||||
}
|
||||
],
|
||||
"properties": {
|
||||
"poolName": {
|
||||
"description": "The pool display name.",
|
||||
"type": "string"
|
||||
},
|
||||
"sparkConfiguration": {
|
||||
"description": "The Spark configuration for the activation. Always present in the Get pool activation detail response.",
|
||||
"$ref": "#/definitions/SparkConfiguration"
|
||||
},
|
||||
"resourceStatusSummary": {
|
||||
"description": "The summary of activation resources grouped by lifecycle status.",
|
||||
"$ref": "#/definitions/ResourceStatusSummary"
|
||||
}
|
||||
}
|
||||
},
|
||||
"SparkComputeConfiguration": {
|
||||
"description": "Common Spark compute configuration properties.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"driverMemory": {
|
||||
"description": "The driver memory allocation including the unit suffix, for example `7g` or `28g`.",
|
||||
"type": "string"
|
||||
},
|
||||
"driverCores": {
|
||||
"description": "The number of CPU cores allocated to the driver.",
|
||||
"type": "integer",
|
||||
"format": "int32"
|
||||
},
|
||||
"executorMemory": {
|
||||
"description": "The executor memory allocation including the unit suffix, for example `7g` or `28g`.",
|
||||
"type": "string"
|
||||
},
|
||||
"executorCores": {
|
||||
"description": "The number of CPU cores allocated to each executor.",
|
||||
"type": "integer",
|
||||
"format": "int32"
|
||||
}
|
||||
}
|
||||
},
|
||||
"SparkConfiguration": {
|
||||
"description": "The Spark configuration for a pool activation.",
|
||||
"type": "object",
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/SparkComputeConfiguration"
|
||||
}
|
||||
],
|
||||
"properties": {
|
||||
"numExecutors": {
|
||||
"description": "The number of executors.",
|
||||
"type": "integer",
|
||||
"format": "int32"
|
||||
},
|
||||
"isDynamicAllocationEnabled": {
|
||||
"description": "Whether dynamic allocation was enabled for the activation. When `false`, the activation used a fixed executor count from `numExecutors` and no dynamic scaling was applied.",
|
||||
"type": "boolean"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ResourceStatusSummary": {
|
||||
"description": "The summary of custom live pool activation resources grouped by user-facing lifecycle status.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"starting": {
|
||||
"description": "The number of resources currently provisioning.",
|
||||
"type": "integer",
|
||||
"format": "int32"
|
||||
},
|
||||
"ready": {
|
||||
"description": "The number of resources warmed up and available.",
|
||||
"type": "integer",
|
||||
"format": "int32"
|
||||
},
|
||||
"acquired": {
|
||||
"description": "The number of resources acquired by (actively assigned to) a session.",
|
||||
"type": "integer",
|
||||
"format": "int32"
|
||||
},
|
||||
"stopping": {
|
||||
"description": "The number of resources being decommissioned.",
|
||||
"type": "integer",
|
||||
"format": "int32"
|
||||
},
|
||||
"deactivated": {
|
||||
"description": "The number of resources intentionally deactivated by policy.",
|
||||
"type": "integer",
|
||||
"format": "int32"
|
||||
},
|
||||
"expired": {
|
||||
"description": "The number of resources that exceeded their lifetime.",
|
||||
"type": "integer",
|
||||
"format": "int32"
|
||||
},
|
||||
"cancelled": {
|
||||
"description": "The number of resources cancelled before completion.",
|
||||
"type": "integer",
|
||||
"format": "int32"
|
||||
},
|
||||
"failed": {
|
||||
"description": "The number of resources that failed to provision.",
|
||||
"type": "integer",
|
||||
"format": "int32"
|
||||
}
|
||||
}
|
||||
},
|
||||
"JobHistoryStatus": {
|
||||
"description": "The lifecycle state of a pool activation. Additional JobHistoryStatus types may be added over time.",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"NotStarted",
|
||||
"InProgress",
|
||||
"Succeeded",
|
||||
"Failed",
|
||||
"Cancelled",
|
||||
"Unknown"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "State",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "NotStarted",
|
||||
"description": "The activation has not yet started."
|
||||
},
|
||||
{
|
||||
"value": "InProgress",
|
||||
"description": "The activation is currently in progress."
|
||||
},
|
||||
{
|
||||
"value": "Succeeded",
|
||||
"description": "The activation completed successfully."
|
||||
},
|
||||
{
|
||||
"value": "Failed",
|
||||
"description": "The activation failed."
|
||||
},
|
||||
{
|
||||
"value": "Cancelled",
|
||||
"description": "The activation was cancelled."
|
||||
},
|
||||
{
|
||||
"value": "Unknown",
|
||||
"description": "The activation state is unknown."
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,47 @@
|
||||
{
|
||||
"title": "Get pool activation example",
|
||||
"parameters": {
|
||||
"workspaceId": "11111111-2222-3333-4444-555555555555",
|
||||
"environmentId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
|
||||
"activationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"jobInstanceId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"name": "WeekdayMorningActivation",
|
||||
"capacityId": "99999999-8888-7777-6666-555555555555",
|
||||
"state": "Failed",
|
||||
"scheduledStartDateTime": "2025-06-01T08:00:00Z",
|
||||
"startDateTime": "2025-06-01T08:00:12Z",
|
||||
"scheduledEndDateTime": "2025-06-01T18:00:00Z",
|
||||
"endDateTime": "2025-06-01T08:05:30Z",
|
||||
"maxClustersToHydrate": 5,
|
||||
"clusterIdleTimeout": "PT30M",
|
||||
"customLivePoolLifespan": "PT12H",
|
||||
"isRecurring": true,
|
||||
"jobType": "SparkPool",
|
||||
"runtimeVersion": "1.3",
|
||||
"poolName": "ProductionPool",
|
||||
"sparkConfiguration": {
|
||||
"driverMemory": "28g",
|
||||
"driverCores": 4,
|
||||
"executorMemory": "28g",
|
||||
"executorCores": 4,
|
||||
"numExecutors": 5,
|
||||
"isDynamicAllocationEnabled": false
|
||||
},
|
||||
"resourceStatusSummary": {
|
||||
"starting": 0,
|
||||
"ready": 0,
|
||||
"acquired": 0,
|
||||
"stopping": 0,
|
||||
"deactivated": 0,
|
||||
"expired": 0,
|
||||
"cancelled": 0,
|
||||
"failed": 5
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,33 @@
|
||||
{
|
||||
"title": "List pool activations example",
|
||||
"parameters": {
|
||||
"workspaceId": "11111111-2222-3333-4444-555555555555",
|
||||
"environmentId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"value": [
|
||||
{
|
||||
"jobInstanceId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"name": "WeekdayMorningActivation",
|
||||
"capacityId": "99999999-8888-7777-6666-555555555555",
|
||||
"state": "Succeeded",
|
||||
"scheduledStartDateTime": "2025-06-01T08:00:00Z",
|
||||
"startDateTime": "2025-06-01T08:00:12Z",
|
||||
"scheduledEndDateTime": "2025-06-01T18:00:00Z",
|
||||
"endDateTime": "2025-06-01T18:00:05Z",
|
||||
"maxClustersToHydrate": 5,
|
||||
"clusterIdleTimeout": "PT30M",
|
||||
"customLivePoolLifespan": "PT12H",
|
||||
"isRecurring": true,
|
||||
"jobType": "SparkPool",
|
||||
"runtimeVersion": "1.3"
|
||||
}
|
||||
],
|
||||
"continuationToken": "eyJjb250aW51YXRpb24iOiJ0b2tlbiJ9",
|
||||
"continuationUri": "https://api.fabric.microsoft.com/v1/workspaces/11111111-2222-3333-4444-555555555555/environments/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/poolActivations?continuationToken=eyJjb250aW51YXRpb24iOiJ0b2tlbiJ9"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -2121,6 +2121,165 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/environments/{environmentId}/poolActivations": {
|
||||
"get": {
|
||||
"tags": [
|
||||
"PoolActivations"
|
||||
],
|
||||
"summary": "Lists pool activations for the specified environment.",
|
||||
"description": "Returns pool activation history for a custom live pool associated with the specified environment. This API supports pagination and filtering by activation state.\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\nThe caller must have *read* permissions for the environment item.\n\n## Required Delegated Scopes\n\nEnvironment.Read.All or Environment.ReadWrite.All or Item.Read.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"operationId": "PoolActivations_ListPoolActivations",
|
||||
"x-ms-pageable": {
|
||||
"nextLinkName": "continuationUri"
|
||||
},
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "workspaceId",
|
||||
"description": "The workspace identifier.",
|
||||
"required": true,
|
||||
"type": "string",
|
||||
"format": "uuid"
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "environmentId",
|
||||
"description": "The environment identifier.",
|
||||
"required": true,
|
||||
"type": "string",
|
||||
"format": "uuid"
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "continuationToken",
|
||||
"description": "A token for retrieving the next page of results.",
|
||||
"type": "string",
|
||||
"required": false
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "pageSize",
|
||||
"description": "The requested number of items per page. The server may return fewer items. If unspecified or exceeds the server maximum, the server uses its configured default.",
|
||||
"type": "integer",
|
||||
"format": "int32",
|
||||
"required": false
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "filter",
|
||||
"description": "An expression that filters the collection. Supported filter: `state eq '<state>'`. Supported values for `<state>`: `NotStarted`, `InProgress`, `Succeeded`, `Failed`, `Cancelled`, `Unknown`.",
|
||||
"type": "string",
|
||||
"required": false
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/PoolActivations"
|
||||
}
|
||||
},
|
||||
"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* SparkCoreBadWebRequest - The filter expression is malformed or uses an unsupported operator/field.\n\n* SparkCoreItemNotFound - The specified environment does not exist.\n\n* SparkCoreUnexpectedException - An unhandled exception occurred.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"List pool activations example": {
|
||||
"$ref": "./examples/ListPoolActivations.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/environments/{environmentId}/poolActivations/{activationId}": {
|
||||
"get": {
|
||||
"tags": [
|
||||
"PoolActivations"
|
||||
],
|
||||
"summary": "Gets properties of the specified pool activation.",
|
||||
"description": "Returns detailed properties of a single pool activation, including Spark configuration and resource breakdown diagnostics.\n\n## Permissions\n\nThe caller must have *read* permissions for the environment item.\n\n## Required Delegated Scopes\n\nEnvironment.Read.All or Environment.ReadWrite.All or Item.Read.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"operationId": "PoolActivations_GetPoolActivation",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "workspaceId",
|
||||
"description": "The workspace identifier.",
|
||||
"required": true,
|
||||
"type": "string",
|
||||
"format": "uuid"
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "environmentId",
|
||||
"description": "The environment identifier.",
|
||||
"required": true,
|
||||
"type": "string",
|
||||
"format": "uuid"
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "activationId",
|
||||
"description": "The pool activation identifier.",
|
||||
"required": true,
|
||||
"type": "string",
|
||||
"format": "uuid"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/PoolActivationDetails"
|
||||
}
|
||||
},
|
||||
"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* SparkCoreItemNotFound - The specified environment does not exist.\n\n* SparkCoreJobNotFound - The specified pool activation does not exist.\n\n* SparkCoreUnexpectedException - An unhandled exception occurred.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Get pool activation example": {
|
||||
"$ref": "./examples/GetPoolActivation.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {},
|
||||
|
||||
@@ -125,12 +125,6 @@
|
||||
"responses": {
|
||||
"201": {
|
||||
"description": "Request completed successfully.",
|
||||
"headers": {
|
||||
"Location": {
|
||||
"description": "The URL of the newly created KQL dashboard.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/KQLDashboard"
|
||||
}
|
||||
|
||||
@@ -1095,6 +1095,11 @@
|
||||
"connectionRecency": {
|
||||
"$ref": "#/definitions/ConnectionRecency",
|
||||
"description": "The recency details about the connection."
|
||||
},
|
||||
"myRole": {
|
||||
"description": "The calling principal's effective role on the connection. When the principal is part of multiple security groups with different roles, the highest role is returned. If the principal has no role on the connection, this property is not returned.",
|
||||
"readOnly": true,
|
||||
"$ref": "#/definitions/ConnectionRole"
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -1343,7 +1348,7 @@
|
||||
},
|
||||
"role": {
|
||||
"description": "The connection role of the principal.",
|
||||
"$ref": "#/definitions/ConnectionRole"
|
||||
"$ref": "#/definitions/AssignableConnectionRole"
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -1354,7 +1359,7 @@
|
||||
"properties": {
|
||||
"role": {
|
||||
"description": "The connection role of the principal.",
|
||||
"$ref": "#/definitions/ConnectionRole"
|
||||
"$ref": "#/definitions/AssignableConnectionRole"
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -1398,11 +1403,38 @@
|
||||
},
|
||||
"ConnectionRole": {
|
||||
"type": "string",
|
||||
"description": "A Connection role. Additional connection roles may be added over time.",
|
||||
"enum": ["User", "UserWithReshare", "Owner"],
|
||||
"description": "A connection role. Additional connection roles may be added over time.",
|
||||
"enum": ["User", "UserWithReshare", "Owner", "PendingOwner"],
|
||||
"x-ms-enum": {
|
||||
"name": "ConnectionRole",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "User",
|
||||
"description": "Enables user access for the connection."
|
||||
},
|
||||
{
|
||||
"value": "UserWithReshare",
|
||||
"description": "Enables user with resharing access for the connection."
|
||||
},
|
||||
{
|
||||
"value": "Owner",
|
||||
"description": "Enables ownership access for the connection."
|
||||
},
|
||||
{
|
||||
"value": "PendingOwner",
|
||||
"description": "Ownership of the connection is not yet effective; the principal must update the connection credentials (using [Update Connection API](/rest/api/fabric/core/connections/update-connection)) to make it effective."
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"AssignableConnectionRole": {
|
||||
"type": "string",
|
||||
"description": "A connection role that can be assigned to a principal. Additional connection roles may be added over time.",
|
||||
"enum": ["User", "UserWithReshare", "Owner"],
|
||||
"x-ms-enum": {
|
||||
"name": "AssignableConnectionRole",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "User",
|
||||
|
||||
@@ -704,6 +704,11 @@
|
||||
"$ref": "../../common/definitions.json#/definitions/ItemOptionsBySourceItemIdEntry"
|
||||
},
|
||||
"readOnly": false
|
||||
},
|
||||
"deploymentPlan": {
|
||||
"description": "A reference to a deployment plan item to orchestrate the deployment. When provided, the plan controls item deployment ordering and executes pre/post deployment actions. When absent or null, the operation behaves as today. Currently, only the `ByItemId` reference type is supported. Deployment plan support is currently in Beta. This property can be used only when the query parameter `beta` is set to `true` and may change based on feedback.",
|
||||
"$ref": "./platform.json#/definitions/DeploymentPlanReference",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
|
||||
@@ -193,6 +193,11 @@
|
||||
"$ref": "../../common/definitions.json#/definitions/ItemOptionsByLogicalIdEntry"
|
||||
},
|
||||
"readOnly": false
|
||||
},
|
||||
"deploymentPlan": {
|
||||
"description": "A reference to a deployment plan item to orchestrate the deployment. When provided, the plan controls item deployment ordering and executes pre/post deployment actions. When absent or null, the operation behaves as today. Currently, only the `ByLogicalId` reference type is supported. Deployment plan support is currently in Beta. This property can be used only when the query parameter `beta` is set to `true` and may change based on feedback.",
|
||||
"$ref": "./platform.json#/definitions/DeploymentPlanReference",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
|
||||
@@ -715,6 +715,11 @@
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"readOnly": true
|
||||
},
|
||||
"identityReference": {
|
||||
"description": "The item reference for the workspace identity. Only ItemReferenceById is supported.",
|
||||
"$ref": "../../common/definitions.json#/definitions/ItemReference",
|
||||
"readOnly": true
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -787,6 +792,76 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"DeploymentPlanReference": {
|
||||
"description": "A reference to a deployment plan item.",
|
||||
"type": "object",
|
||||
"required": ["referenceType"],
|
||||
"discriminator": "referenceType",
|
||||
"properties": {
|
||||
"referenceType": {
|
||||
"description": "The deployment plan reference type.",
|
||||
"$ref": "#/definitions/DeploymentPlanReferenceType",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"DeploymentPlanReferenceType": {
|
||||
"type": "string",
|
||||
"description": "The deployment plan reference type. Additional `DeploymentPlanReferenceType` types may be added over time.",
|
||||
"enum": ["ByItemId", "ByLogicalId"],
|
||||
"x-ms-enum": {
|
||||
"name": "DeploymentPlanReferenceType",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "ByItemId",
|
||||
"description": "The deployment plan is referenced by its item ID."
|
||||
},
|
||||
{
|
||||
"value": "ByLogicalId",
|
||||
"description": "The deployment plan is referenced by its logical ID."
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"DeploymentPlanReferenceByItemId": {
|
||||
"description": "A deployment plan reference by item ID.",
|
||||
"type": "object",
|
||||
"required": ["itemId"],
|
||||
"properties": {
|
||||
"itemId": {
|
||||
"description": "The item ID of the deployment plan item.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"readOnly": false
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/DeploymentPlanReference"
|
||||
}
|
||||
],
|
||||
"x-ms-discriminator-value": "ByItemId"
|
||||
},
|
||||
"DeploymentPlanReferenceByLogicalId": {
|
||||
"description": "A deployment plan reference by logical ID.",
|
||||
"type": "object",
|
||||
"required": ["logicalId"],
|
||||
"properties": {
|
||||
"logicalId": {
|
||||
"description": "The logical ID of the deployment plan item.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"readOnly": false
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/DeploymentPlanReference"
|
||||
}
|
||||
],
|
||||
"x-ms-discriminator-value": "ByLogicalId"
|
||||
},
|
||||
"BulkImportItemDefinitionsRequest": {
|
||||
"description": "Bulk import of exported item definitions request payload.",
|
||||
"type": "object",
|
||||
@@ -814,6 +889,11 @@
|
||||
"$ref": "../../common/definitions.json#/definitions/ItemOptionsByLogicalIdEntry"
|
||||
},
|
||||
"readOnly": false
|
||||
},
|
||||
"deploymentPlan": {
|
||||
"description": "A reference to a deployment plan item to orchestrate the deployment. When provided, the plan controls item deployment ordering and executes pre/post deployment actions. When absent or null, the operation behaves as today. Currently, only the `ByLogicalId` reference type is supported. Deployment plan support is currently in Beta. This property can be used only when the query parameter `beta` is set to `true` and may change based on feedback.",
|
||||
"$ref": "#/definitions/DeploymentPlanReference",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,268 @@
|
||||
{
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"title": "Surge protection actor data types",
|
||||
"version": "v1"
|
||||
},
|
||||
"paths": {},
|
||||
"definitions": {
|
||||
"SurgeProtectionActorType": {
|
||||
"type": "string",
|
||||
"description": "The type of the actor. Additional SurgeProtectionActorType values may be added over time.",
|
||||
"enum": [
|
||||
"Workspace"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "SurgeProtectionActorType",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "Workspace",
|
||||
"description": "The actor is a workspace."
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"BlockedActorExpirationPolicyType": {
|
||||
"type": "string",
|
||||
"description": "The type of expiration policy. Additional BlockedActorExpirationPolicyType values may be added over time.",
|
||||
"enum": [
|
||||
"NeverExpire",
|
||||
"ExpireAfterDate"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "BlockedActorExpirationPolicyType",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "NeverExpire",
|
||||
"description": "The block does not expire automatically."
|
||||
},
|
||||
{
|
||||
"value": "ExpireAfterDate",
|
||||
"description": "The block expires at the date and time specified in `expireAfterDateTime`."
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"BlockedActorExpirationPolicy": {
|
||||
"type": "object",
|
||||
"description": "Defines when a blocked actor expires.",
|
||||
"required": [
|
||||
"policyType"
|
||||
],
|
||||
"discriminator": "policyType",
|
||||
"properties": {
|
||||
"policyType": {
|
||||
"description": "The type of expiration policy.",
|
||||
"$ref": "#/definitions/BlockedActorExpirationPolicyType",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"NeverExpireBlockedActorExpirationPolicy": {
|
||||
"description": "An expiration policy where the block does not expire automatically.",
|
||||
"type": "object",
|
||||
"x-ms-discriminator-value": "NeverExpire",
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/BlockedActorExpirationPolicy"
|
||||
}
|
||||
]
|
||||
},
|
||||
"ExpireAfterDateBlockedActorExpirationPolicy": {
|
||||
"description": "An expiration policy where the block expires at the date and time specified in `expireAfterDateTime`.",
|
||||
"type": "object",
|
||||
"x-ms-discriminator-value": "ExpireAfterDate",
|
||||
"required": [
|
||||
"expireAfterDateTime"
|
||||
],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/BlockedActorExpirationPolicy"
|
||||
}
|
||||
],
|
||||
"properties": {
|
||||
"expireAfterDateTime": {
|
||||
"description": "The date and time at which the block expires. Expressed in UTC, using the YYYY-MM-DDTHH:mm:ssZ format.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"SurgeProtectionActorDetails": {
|
||||
"type": "object",
|
||||
"description": "The details of the actor.",
|
||||
"required": [
|
||||
"actorType"
|
||||
],
|
||||
"discriminator": "actorType",
|
||||
"properties": {
|
||||
"actorType": {
|
||||
"description": "The type of the actor.",
|
||||
"$ref": "#/definitions/SurgeProtectionActorType",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"WorkspaceActorDetails": {
|
||||
"description": "The details of a workspace actor.",
|
||||
"type": "object",
|
||||
"x-ms-discriminator-value": "Workspace",
|
||||
"required": [
|
||||
"workspaceId"
|
||||
],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/SurgeProtectionActorDetails"
|
||||
}
|
||||
],
|
||||
"properties": {
|
||||
"workspaceId": {
|
||||
"description": "The workspace ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"BlockedActor": {
|
||||
"description": "A blocked actor on a capacity.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"id",
|
||||
"actorDetails",
|
||||
"expirationPolicy"
|
||||
],
|
||||
"properties": {
|
||||
"id": {
|
||||
"description": "The blocked actor ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"readOnly": true
|
||||
},
|
||||
"actorDetails": {
|
||||
"description": "The actor that is blocked.",
|
||||
"$ref": "#/definitions/SurgeProtectionActorDetails",
|
||||
"readOnly": true
|
||||
},
|
||||
"expirationPolicy": {
|
||||
"description": "Defines when the block expires.",
|
||||
"$ref": "#/definitions/BlockedActorExpirationPolicy",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"MissionCriticalActor": {
|
||||
"description": "A mission critical actor on a capacity.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"id",
|
||||
"actorDetails"
|
||||
],
|
||||
"properties": {
|
||||
"id": {
|
||||
"description": "The mission critical actor ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"readOnly": true
|
||||
},
|
||||
"actorDetails": {
|
||||
"description": "The actor that is shielded from surge-protection rejection.",
|
||||
"$ref": "#/definitions/SurgeProtectionActorDetails",
|
||||
"readOnly": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"CreateBlockedActorRequest": {
|
||||
"description": "The request payload for creating a blocked actor on a capacity.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"actorDetails",
|
||||
"expirationPolicy"
|
||||
],
|
||||
"properties": {
|
||||
"actorDetails": {
|
||||
"description": "The actor to block.",
|
||||
"$ref": "#/definitions/SurgeProtectionActorDetails",
|
||||
"readOnly": false
|
||||
},
|
||||
"expirationPolicy": {
|
||||
"description": "Defines when the block expires.",
|
||||
"$ref": "#/definitions/BlockedActorExpirationPolicy",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateBlockedActorRequest": {
|
||||
"description": "The request payload for updating a blocked actor on a capacity.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"expirationPolicy"
|
||||
],
|
||||
"properties": {
|
||||
"expirationPolicy": {
|
||||
"description": "Defines when the block expires.",
|
||||
"$ref": "#/definitions/BlockedActorExpirationPolicy",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"CreateMissionCriticalActorRequest": {
|
||||
"description": "The request payload for creating a mission critical actor on a capacity.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"actorDetails"
|
||||
],
|
||||
"properties": {
|
||||
"actorDetails": {
|
||||
"description": "The actor to shield from surge-protection rejection.",
|
||||
"$ref": "#/definitions/SurgeProtectionActorDetails",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"BlockedActors": {
|
||||
"description": "A list of blocked actors.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"value"
|
||||
],
|
||||
"properties": {
|
||||
"value": {
|
||||
"description": "A list of blocked actors.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/BlockedActor"
|
||||
}
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "../../common/definitions.json#/definitions/PaginatedResponse"
|
||||
}
|
||||
]
|
||||
},
|
||||
"MissionCriticalActors": {
|
||||
"description": "A list of mission critical actors.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"value"
|
||||
],
|
||||
"properties": {
|
||||
"value": {
|
||||
"description": "A list of mission critical actors.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/MissionCriticalActor"
|
||||
}
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "../../common/definitions.json#/definitions/PaginatedResponse"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -57,7 +57,8 @@
|
||||
},
|
||||
"connectionRecency": {
|
||||
"createdDateTime": "2023-05-23T16:22:20Z"
|
||||
}
|
||||
},
|
||||
"myRole": "Owner"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -53,7 +53,8 @@
|
||||
},
|
||||
"connectionRecency": {
|
||||
"createdDateTime": "2023-05-23T16:22:20Z"
|
||||
}
|
||||
},
|
||||
"myRole": "Owner"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -61,7 +61,8 @@
|
||||
},
|
||||
"connectionRecency": {
|
||||
"createdDateTime": "2023-05-23T16:22:20Z"
|
||||
}
|
||||
},
|
||||
"myRole": "Owner"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -50,7 +50,8 @@
|
||||
"singleSignOnType": "None",
|
||||
"connectionEncryption": "Encrypted",
|
||||
"skipTestConnection": false
|
||||
}
|
||||
},
|
||||
"myRole": "Owner"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -53,7 +53,8 @@
|
||||
},
|
||||
"connectionRecency": {
|
||||
"createdDateTime": "2023-05-23T16:22:20Z"
|
||||
}
|
||||
},
|
||||
"myRole": "Owner"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -26,7 +26,8 @@
|
||||
"lastCredentialUsedDateTime": "2023-05-27T16:22:20Z",
|
||||
"myLastBoundDateTime": "2023-05-24T16:22:20Z",
|
||||
"myLastCredentialUsedDateTime": "2023-05-25T16:22:20Z"
|
||||
}
|
||||
},
|
||||
"myRole": "Owner"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -37,6 +37,14 @@
|
||||
"type": "User"
|
||||
},
|
||||
"role": "UserWithReshare"
|
||||
},
|
||||
{
|
||||
"id": "7f2c9a10-4d3e-4b8a-9c1f-2e6d8b0a5c4e",
|
||||
"principal": {
|
||||
"id": "7f2c9a10-4d3e-4b8a-9c1f-2e6d8b0a5c4e",
|
||||
"type": "User"
|
||||
},
|
||||
"role": "PendingOwner"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
@@ -26,7 +26,8 @@
|
||||
"lastCredentialUsedDateTime": "2023-05-27T16:22:20Z",
|
||||
"myLastBoundDateTime": "2023-05-24T16:22:20Z",
|
||||
"myLastCredentialUsedDateTime": "2023-05-25T16:22:20Z"
|
||||
}
|
||||
},
|
||||
"myRole": "Owner"
|
||||
},
|
||||
{
|
||||
"id": "f6a39b76-9816-4e4b-b93a-f42e405017b7",
|
||||
@@ -50,7 +51,8 @@
|
||||
"lastCredentialUsedDateTime": "2023-05-27T16:22:20Z",
|
||||
"myLastBoundDateTime": "2023-05-24T16:22:20Z",
|
||||
"myLastCredentialUsedDateTime": "2023-05-25T16:22:20Z"
|
||||
}
|
||||
},
|
||||
"myRole": "User"
|
||||
},
|
||||
{
|
||||
"id": "a3b4c5d6-7e8f-4a5b-9c0d-1e2f3a4b5c6d",
|
||||
@@ -67,7 +69,8 @@
|
||||
"singleSignOnType": "None",
|
||||
"connectionEncryption": "Encrypted",
|
||||
"skipTestConnection": false
|
||||
}
|
||||
},
|
||||
"myRole": "PendingOwner"
|
||||
}
|
||||
],
|
||||
"continuationToken": "LDEsMTAwMDAwLDA%3D",
|
||||
|
||||
@@ -46,7 +46,8 @@
|
||||
"lastCredentialUsedDateTime": "2023-05-27T16:22:20Z",
|
||||
"myLastBoundDateTime": "2023-05-24T16:22:20Z",
|
||||
"myLastCredentialUsedDateTime": "2023-05-25T16:22:20Z"
|
||||
}
|
||||
},
|
||||
"myRole": "Owner"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -34,7 +34,8 @@
|
||||
"lastCredentialUsedDateTime": "2023-05-27T16:22:20Z",
|
||||
"myLastBoundDateTime": "2023-05-24T16:22:20Z",
|
||||
"myLastCredentialUsedDateTime": "2023-05-25T16:22:20Z"
|
||||
}
|
||||
},
|
||||
"myRole": "Owner"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -29,7 +29,8 @@
|
||||
"lastCredentialUsedDateTime": "2023-05-27T16:22:20Z",
|
||||
"myLastBoundDateTime": "2023-05-24T16:22:20Z",
|
||||
"myLastCredentialUsedDateTime": "2023-05-25T16:22:20Z"
|
||||
}
|
||||
},
|
||||
"myRole": "Owner"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -30,7 +30,8 @@
|
||||
"lastCredentialUsedDateTime": "2023-05-27T16:22:20Z",
|
||||
"myLastBoundDateTime": "2023-05-24T16:22:20Z",
|
||||
"myLastCredentialUsedDateTime": "2023-05-25T16:22:20Z"
|
||||
}
|
||||
},
|
||||
"myRole": "Owner"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -26,7 +26,8 @@
|
||||
"singleSignOnType": "None",
|
||||
"connectionEncryption": "Encrypted",
|
||||
"skipTestConnection": false
|
||||
}
|
||||
},
|
||||
"myRole": "Owner"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -34,7 +34,8 @@
|
||||
"lastCredentialUsedDateTime": "2023-05-27T16:22:20Z",
|
||||
"myLastBoundDateTime": "2023-05-24T16:22:20Z",
|
||||
"myLastCredentialUsedDateTime": "2023-05-25T16:22:20Z"
|
||||
}
|
||||
},
|
||||
"myRole": "Owner"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,26 @@
|
||||
{
|
||||
"parameters": {
|
||||
"deploymentPipelineId": "a5ded933-57b7-41f4-b072-ed4c1f9d5824",
|
||||
"deployRequest": {
|
||||
"sourceStageId": "db1577e0-0132-4d6d-92b9-952c359988f2",
|
||||
"targetStageId": "f1c39546-6282-4590-8af3-847a6226ad16",
|
||||
"note": "Deploying with orchestrated deployment plan",
|
||||
"options": {
|
||||
"deploymentPlan": {
|
||||
"referenceType": "ByItemId",
|
||||
"itemId": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"202": {
|
||||
"headers": {
|
||||
"Location": "https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
|
||||
"x-ms-operation-id": "431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
|
||||
"deployment-id": "1065e6a3-a020-4c0c-ada7-92b5fe99eec5",
|
||||
"Retry-After": 30
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,31 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "1565e6a3-c020-4c0c-dda7-92bafe99eec5",
|
||||
"updateFromGitRequest": {
|
||||
"workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
|
||||
"remoteCommitHash": "7d03b2918bf6aa62f96d0a4307293f3853201705",
|
||||
"conflictResolution": {
|
||||
"conflictResolutionType": "Workspace",
|
||||
"conflictResolutionPolicy": "PreferWorkspace"
|
||||
},
|
||||
"options": {
|
||||
"allowOverrideItems": true,
|
||||
"deploymentPlan": {
|
||||
"referenceType": "ByLogicalId",
|
||||
"logicalId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
},
|
||||
"202": {
|
||||
"headers": {
|
||||
"Location": "https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
|
||||
"x-ms-operation-id": "431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
|
||||
"Retry-After": 30
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,45 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "24d305d1-9db8-4785-b038-714e07e7394f",
|
||||
"beta": true,
|
||||
"bulkImportItemDefinitionsRequest": {
|
||||
"definitionParts": [
|
||||
{
|
||||
"path": "/Folder1/Folder2/MyReport.Report/.platform",
|
||||
"payload": "ewogICIkc2NoZW1hIjogImh0dHBzOi8vZGV2ZWxvcGVyLm1pY3Jvc29mdC5jb20vanNvbi1zY2hlbWFzL2ZhYnJpYy9naXRJbnRlZ3JhdGlvbi9wbGF0Zm9ybVByb3BlcnRpZXMvMi4wLjAvc2NoZW1hLmpzb24iLAogICJtZXRhZGF0YSI6IHsKICAgICJ0eXBlIjogIlJlcG9ydCIsCiAgICAiZGlzcGxheU5hbWUiOiAiTXlSZXBvcnQiCiAgfSwKICAiY29uZmlnIjogewogICAgInZlcnNpb24iOiAiMi4wIiwKICAgICJsb2dpY2FsSWQiOiAiODg0MzZlNjUtNmVkMS04MTg1LTQ5ZmYtZjYxMDc3ZmM3M2Q0IgogIH0KfQ==",
|
||||
"payloadType": "InlineBase64"
|
||||
}
|
||||
],
|
||||
"options": {
|
||||
"allowPairingByName": true,
|
||||
"deploymentPlan": {
|
||||
"referenceType": "ByLogicalId",
|
||||
"logicalId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"importItemDefinitionsDetails": [
|
||||
{
|
||||
"itemId": "3546052c-ae64-4526-b1a8-52af7761426f",
|
||||
"itemDisplayName": "MyReport",
|
||||
"itemType": "Report",
|
||||
"itemLogicalId": "88436e65-6ed1-8185-49ff-f61077fc73d4",
|
||||
"operationType": "Create",
|
||||
"operationStatus": "Succeeded"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"202": {
|
||||
"headers": {
|
||||
"Location": "https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
|
||||
"x-ms-operation-id": "431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
|
||||
"Retry-After": 30
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -14,7 +14,12 @@
|
||||
"capacityAssignmentProgress": "Completed",
|
||||
"workspaceIdentity": {
|
||||
"applicationId" : "00a4a8f9-78d3-41b3-b87a-6ae5271c8d0d",
|
||||
"servicePrincipalId": "5ba4ae58-d402-45c6-a848-0253e834fd78"
|
||||
"servicePrincipalId": "5ba4ae58-d402-45c6-a848-0253e834fd78",
|
||||
"identityReference": {
|
||||
"referenceType": "ById",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
|
||||
"itemId": "4a1d86e3-d740-4610-b32d-7bae87d33e9d"
|
||||
}
|
||||
},
|
||||
"capacityRegion": "East US",
|
||||
"oneLakeEndpoints": {
|
||||
|
||||
@@ -14,7 +14,12 @@
|
||||
"capacityAssignmentProgress": "Completed",
|
||||
"workspaceIdentity": {
|
||||
"applicationId" : "00a4a8f9-78d3-41b3-b87a-6ae5271c8d0d",
|
||||
"servicePrincipalId": "5ba4ae58-d402-45c6-a848-0253e834fd78"
|
||||
"servicePrincipalId": "5ba4ae58-d402-45c6-a848-0253e834fd78",
|
||||
"identityReference": {
|
||||
"referenceType": "ById",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
|
||||
"itemId": "4a1d86e3-d740-4610-b32d-7bae87d33e9d"
|
||||
}
|
||||
},
|
||||
"capacityRegion": "East US",
|
||||
"oneLakeEndpoints": {
|
||||
|
||||
@@ -6,7 +6,12 @@
|
||||
"200": {
|
||||
"body": {
|
||||
"applicationId" : "00a4a8f9-78d3-41b3-b87a-6ae5271c8d0d",
|
||||
"servicePrincipalId": "5ba4ae58-d402-45c6-a848-0253e834fd78"
|
||||
"servicePrincipalId": "5ba4ae58-d402-45c6-a848-0253e834fd78",
|
||||
"identityReference": {
|
||||
"referenceType": "ById",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
|
||||
"itemId": "4a1d86e3-d740-4610-b32d-7bae87d33e9d"
|
||||
}
|
||||
}
|
||||
},
|
||||
"202": {
|
||||
|
||||
@@ -0,0 +1,30 @@
|
||||
{
|
||||
"parameters": {
|
||||
"capacityId": "96f3f0ff-4fe2-4712-b61b-05a456ba9357",
|
||||
"createBlockedActorRequest": {
|
||||
"actorDetails": {
|
||||
"actorType": "Workspace",
|
||||
"workspaceId": "a1f2c3d4-e5f6-7890-abcd-1234567890ef"
|
||||
},
|
||||
"expirationPolicy": {
|
||||
"policyType": "ExpireAfterDate",
|
||||
"expireAfterDateTime": "2026-07-15T18:00:00Z"
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"201": {
|
||||
"body": {
|
||||
"id": "11223344-5566-7788-99aa-bbccddeeff00",
|
||||
"actorDetails": {
|
||||
"actorType": "Workspace",
|
||||
"workspaceId": "a1f2c3d4-e5f6-7890-abcd-1234567890ef"
|
||||
},
|
||||
"expirationPolicy": {
|
||||
"policyType": "ExpireAfterDate",
|
||||
"expireAfterDateTime": "2026-07-15T18:00:00Z"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,28 @@
|
||||
{
|
||||
"parameters": {
|
||||
"capacityId": "96f3f0ff-4fe2-4712-b61b-05a456ba9357",
|
||||
"createBlockedActorRequest": {
|
||||
"actorDetails": {
|
||||
"actorType": "Workspace",
|
||||
"workspaceId": "a1f2c3d4-e5f6-7890-abcd-1234567890ef"
|
||||
},
|
||||
"expirationPolicy": {
|
||||
"policyType": "NeverExpire"
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"id": "11223344-5566-7788-99aa-bbccddeeff00",
|
||||
"actorDetails": {
|
||||
"actorType": "Workspace",
|
||||
"workspaceId": "a1f2c3d4-e5f6-7890-abcd-1234567890ef"
|
||||
},
|
||||
"expirationPolicy": {
|
||||
"policyType": "NeverExpire"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"parameters": {
|
||||
"capacityId": "96f3f0ff-4fe2-4712-b61b-05a456ba9357",
|
||||
"blockedActorId": "11223344-5566-7788-99aa-bbccddeeff00"
|
||||
},
|
||||
"responses": {
|
||||
"200": {}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,21 @@
|
||||
{
|
||||
"parameters": {
|
||||
"capacityId": "96f3f0ff-4fe2-4712-b61b-05a456ba9357",
|
||||
"blockedActorId": "11223344-5566-7788-99aa-bbccddeeff00"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"id": "11223344-5566-7788-99aa-bbccddeeff00",
|
||||
"actorDetails": {
|
||||
"actorType": "Workspace",
|
||||
"workspaceId": "a1f2c3d4-e5f6-7890-abcd-1234567890ef"
|
||||
},
|
||||
"expirationPolicy": {
|
||||
"policyType": "ExpireAfterDate",
|
||||
"expireAfterDateTime": "2026-07-15T18:00:00Z"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,36 @@
|
||||
{
|
||||
"parameters": {
|
||||
"capacityId": "96f3f0ff-4fe2-4712-b61b-05a456ba9357"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"value": [
|
||||
{
|
||||
"id": "11223344-5566-7788-99aa-bbccddeeff00",
|
||||
"actorDetails": {
|
||||
"actorType": "Workspace",
|
||||
"workspaceId": "a1f2c3d4-e5f6-7890-abcd-1234567890ef"
|
||||
},
|
||||
"expirationPolicy": {
|
||||
"policyType": "ExpireAfterDate",
|
||||
"expireAfterDateTime": "2026-07-15T18:00:00Z"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "22334455-6677-8899-aabb-ccddeeff0011",
|
||||
"actorDetails": {
|
||||
"actorType": "Workspace",
|
||||
"workspaceId": "c3d4e5f6-a7b8-9012-cdef-3456789012ab"
|
||||
},
|
||||
"expirationPolicy": {
|
||||
"policyType": "NeverExpire"
|
||||
}
|
||||
}
|
||||
],
|
||||
"continuationToken": "LDEsMTAwMDAwLDA%3D",
|
||||
"continuationUri": "https://api.fabric.microsoft.com/v1/capacities/96f3f0ff-4fe2-4712-b61b-05a456ba9357/surgeProtection/blockedActors?continuationToken='LDEsMTAwMDAwLDA%3D'"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,25 @@
|
||||
{
|
||||
"parameters": {
|
||||
"capacityId": "96f3f0ff-4fe2-4712-b61b-05a456ba9357",
|
||||
"blockedActorId": "11223344-5566-7788-99aa-bbccddeeff00",
|
||||
"updateBlockedActorRequest": {
|
||||
"expirationPolicy": {
|
||||
"policyType": "NeverExpire"
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"id": "11223344-5566-7788-99aa-bbccddeeff00",
|
||||
"actorDetails": {
|
||||
"actorType": "Workspace",
|
||||
"workspaceId": "a1f2c3d4-e5f6-7890-abcd-1234567890ef"
|
||||
},
|
||||
"expirationPolicy": {
|
||||
"policyType": "NeverExpire"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,22 @@
|
||||
{
|
||||
"parameters": {
|
||||
"capacityId": "96f3f0ff-4fe2-4712-b61b-05a456ba9357",
|
||||
"createMissionCriticalActorRequest": {
|
||||
"actorDetails": {
|
||||
"actorType": "Workspace",
|
||||
"workspaceId": "b2c3d4e5-f6a7-8901-bcde-2345678901fa"
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"201": {
|
||||
"body": {
|
||||
"id": "33445566-7788-99aa-bbcc-ddeeff001122",
|
||||
"actorDetails": {
|
||||
"actorType": "Workspace",
|
||||
"workspaceId": "b2c3d4e5-f6a7-8901-bcde-2345678901fa"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
+22
@@ -0,0 +1,22 @@
|
||||
{
|
||||
"parameters": {
|
||||
"capacityId": "96f3f0ff-4fe2-4712-b61b-05a456ba9357",
|
||||
"createMissionCriticalActorRequest": {
|
||||
"actorDetails": {
|
||||
"actorType": "Workspace",
|
||||
"workspaceId": "b2c3d4e5-f6a7-8901-bcde-2345678901fa"
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"id": "33445566-7788-99aa-bbcc-ddeeff001122",
|
||||
"actorDetails": {
|
||||
"actorType": "Workspace",
|
||||
"workspaceId": "b2c3d4e5-f6a7-8901-bcde-2345678901fa"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"parameters": {
|
||||
"capacityId": "96f3f0ff-4fe2-4712-b61b-05a456ba9357",
|
||||
"missionCriticalActorId": "33445566-7788-99aa-bbcc-ddeeff001122"
|
||||
},
|
||||
"responses": {
|
||||
"200": {}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,17 @@
|
||||
{
|
||||
"parameters": {
|
||||
"capacityId": "96f3f0ff-4fe2-4712-b61b-05a456ba9357",
|
||||
"missionCriticalActorId": "33445566-7788-99aa-bbcc-ddeeff001122"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"id": "33445566-7788-99aa-bbcc-ddeeff001122",
|
||||
"actorDetails": {
|
||||
"actorType": "Workspace",
|
||||
"workspaceId": "b2c3d4e5-f6a7-8901-bcde-2345678901fa"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,29 @@
|
||||
{
|
||||
"parameters": {
|
||||
"capacityId": "96f3f0ff-4fe2-4712-b61b-05a456ba9357"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"value": [
|
||||
{
|
||||
"id": "33445566-7788-99aa-bbcc-ddeeff001122",
|
||||
"actorDetails": {
|
||||
"actorType": "Workspace",
|
||||
"workspaceId": "b2c3d4e5-f6a7-8901-bcde-2345678901fa"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "44556677-8899-aabb-ccdd-eeff00112233",
|
||||
"actorDetails": {
|
||||
"actorType": "Workspace",
|
||||
"workspaceId": "d4e5f6a7-b8c9-0123-def4-567890abcdef"
|
||||
}
|
||||
}
|
||||
],
|
||||
"continuationToken": "MiwxMDAwMDAsMQ%3D%3D",
|
||||
"continuationUri": "https://api.fabric.microsoft.com/v1/capacities/96f3f0ff-4fe2-4712-b61b-05a456ba9357/surgeProtection/missionCriticalActors?continuationToken='MiwxMDAwMDAsMQ%3D%3D'"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
+626
-3
@@ -1464,7 +1464,7 @@
|
||||
"/workspaces/{workspaceId}/items/bulkImportDefinitions": {
|
||||
"post": {
|
||||
"summary": "Bulk import item definitions into the workspace.",
|
||||
"description": "Imports item definitions for multiple items into a workspace in a single operation. This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation). Each item definition in the request will be processed, creating new items or updating existing ones as determined by the system based on whether the item already exists. To see the supported item types, see [Item definition overview](/rest/api/fabric/articles/item-management/definitions/item-definition-overview).\n\n## Permissions\n\nThe caller must have a *contributor* or higher role for the workspace.\n\nThe caller must have *read and write* permissions for each item being updated.\n\n## Required Delegated Scopes\n\nItem.ReadWrite.All.\n\n## Limitations\n\n The following limitations apply: \n- The maximum supported request payload size is 128 MB. \n- If the request includes one or more Fabric item types, the workspace must be assigned to a Fabric capacity (F SKU, including Fabric Trial). Power BI Premium capacities are supported only for Power BI items and aren't sufficient for Fabric items.\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) | Only when all the [items](/rest/api/fabric/articles/item-management/item-management-overview) involved in the operation support service principals |\n\n## Interface",
|
||||
"description": "> [!NOTE]\n> Deployment plan support in this API is part of a Beta release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use. All other functionality of this API is generally available.\n**To use deployment plan support, callers must specify `true` as the value for the query parameter `beta`.**\n\nImports item definitions for multiple items into a workspace in a single operation. This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation). Each item definition in the request will be processed, creating new items or updating existing ones as determined by the system based on whether the item already exists. To see the supported item types, see [Item definition overview](/rest/api/fabric/articles/item-management/definitions/item-definition-overview).\n\n## Permissions\n\nThe caller must have a *contributor* or higher role for the workspace.\n\nThe caller must have *read and write* permissions for each item being updated.\n\n## Required Delegated Scopes\n\nItem.ReadWrite.All.\n\n## Limitations\n\n The following limitations apply: \n- The maximum supported request payload size is 128 MB. \n- If the request includes one or more Fabric item types, the workspace must be assigned to a Fabric capacity (F SKU, including Fabric Trial). Power BI Premium capacities are supported only for Power BI items and aren't sufficient for Fabric items.\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) | Only when all the [items](/rest/api/fabric/articles/item-management/item-management-overview) involved in the operation support service principals |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
@@ -1493,6 +1493,13 @@
|
||||
"$ref": "./definitions/platform.json#/definitions/BulkImportItemDefinitionsRequest"
|
||||
},
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"name": "beta",
|
||||
"in": "query",
|
||||
"description": "Set to `true` to enable Beta functionality, including deployment plan support. When omitted or set to `false`, only generally available functionality is accessible and deployment plan input is not accepted.",
|
||||
"required": false,
|
||||
"type": "boolean"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
@@ -1546,6 +1553,9 @@
|
||||
},
|
||||
"Bulk import item definitions with options example": {
|
||||
"$ref": "./examples/platform/BulkImportItemDefinitionsWithOptions.json"
|
||||
},
|
||||
"Bulk import item definitions with deployment plan example": {
|
||||
"$ref": "./examples/platform/BulkImportItemDefinitionsWithDeploymentPlan.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -2780,7 +2790,7 @@
|
||||
"/workspaces/{workspaceId}/git/updateFromGit": {
|
||||
"post": {
|
||||
"summary": "Updates the workspace with commits pushed to the connected branch.",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nTo use this API, the caller's Git credentials must be configured using [Update My Git Credentials](/rest/api/fabric/core/git/update-my-git-credentials) API. You can use the [Get My Git Credentials](/rest/api/fabric/core/git/get-my-git-credentials) API to check the Git credentials configuration.\n\nThe update only affects items in the workspace that were changed in those commits. If called after the [Connect](/rest/api/fabric/core/git/connect) and [Initialize Connection](/rest/api/fabric/core/git/initialize-connection) APIs, it will perform a full update of the entire workspace.\n\n## Permissions\n\nThe caller must have a *contributor* or higher workspace role.\n\n## Required Delegated Scopes\n\nWorkspace.GitUpdate.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) | Only supported when all the [items](/rest/api/fabric/articles/item-management/item-management-overview) involved in the operation support service principals |\n\n## Interface",
|
||||
"description": "> [!NOTE]\n> Deployment plan support in this API is part of a Beta release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use. All other functionality of this API is generally available.\n**To use deployment plan support, callers must specify `true` as the value for the query parameter `beta`.**\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nTo use this API, the caller's Git credentials must be configured using [Update My Git Credentials](/rest/api/fabric/core/git/update-my-git-credentials) API. You can use the [Get My Git Credentials](/rest/api/fabric/core/git/get-my-git-credentials) API to check the Git credentials configuration.\n\nThe update only affects items in the workspace that were changed in those commits. If called after the [Connect](/rest/api/fabric/core/git/connect) and [Initialize Connection](/rest/api/fabric/core/git/initialize-connection) APIs, it will perform a full update of the entire workspace.\n\n## Permissions\n\nThe caller must have a *contributor* or higher workspace role.\n\n## Required Delegated Scopes\n\nWorkspace.GitUpdate.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) | Only supported when all the [items](/rest/api/fabric/articles/item-management/item-management-overview) involved in the operation support service principals |\n\n## Interface",
|
||||
"tags": [
|
||||
"Git"
|
||||
],
|
||||
@@ -2801,6 +2811,13 @@
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"name": "beta",
|
||||
"in": "query",
|
||||
"description": "Set to `true` to enable Beta functionality, including deployment plan support. When omitted or set to `false`, only generally available functionality is accessible and deployment plan input is not accepted.",
|
||||
"required": false,
|
||||
"type": "boolean"
|
||||
},
|
||||
{
|
||||
"in": "body",
|
||||
"name": "updateFromGitRequest",
|
||||
@@ -2859,6 +2876,9 @@
|
||||
},
|
||||
"Update a workspace from Git with options example": {
|
||||
"$ref": "./examples/gitIntegration/UpdateFromGitWithOptions.json"
|
||||
},
|
||||
"Update a workspace using data from a Git with a deployment plan example": {
|
||||
"$ref": "./examples/gitIntegration/UpdateFromGitWithDeploymentPlan.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -3729,6 +3749,599 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/capacities/{capacityId}/surgeProtection/blockedActors": {
|
||||
"post": {
|
||||
"summary": "Creates a blocked actor on a capacity.",
|
||||
"description": "Creates a blocked actor on the specified capacity. The actor's background operations will be rejected regardless of capacity utilization.\n\n**Upsert-by-actor semantics:** If the specified actor is already blocked on this capacity, the existing record's `expirationPolicy` is overwritten with the values from this request and the updated record is returned with `200 OK`. If the actor is new, the record is created and returned with `201 Created`.\n\nWhen `expirationPolicy.policyType` is `ExpireAfterDate`, enforcement stops immediately when `expirationPolicy.expireAfterDateTime` passes. The record may remain visible via List and Get until an asynchronous background garbage-collection job removes it.\n\n## Permissions\n\nThe caller must be a capacity admin.\n\n## Required Delegated Scopes\n\nCapacity.ReadWrite.All\n\n## Limitations\n\n- Each capacity can hold a maximum of 1,000 surge-protection items combined across blocked actors, mission critical actors, and detection rules.\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_CreateBlockedActor",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "capacityId",
|
||||
"description": "The capacity ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "body",
|
||||
"name": "createBlockedActorRequest",
|
||||
"description": "Create blocked actor request payload.",
|
||||
"schema": {
|
||||
"$ref": "./definitions/surgeProtectionActors.json#/definitions/CreateBlockedActorRequest"
|
||||
},
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "The actor was already blocked on the capacity; the existing blocked actor was updated and returned.",
|
||||
"schema": {
|
||||
"$ref": "./definitions/surgeProtectionActors.json#/definitions/BlockedActor"
|
||||
}
|
||||
},
|
||||
"201": {
|
||||
"description": "Successfully created a new blocked actor.",
|
||||
"schema": {
|
||||
"$ref": "./definitions/surgeProtectionActors.json#/definitions/BlockedActor"
|
||||
}
|
||||
},
|
||||
"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* InvalidRequest - The request body is malformed or contains invalid field values.\n\n* SurgeProtectionItemsLimitExceeded - The capacity has reached the 1,000 combined surge-protection items limit.\n\n* WorkspaceNotFound - The workspace specified in `actorDetails.workspaceId` does not exist or is not associated with this capacity.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Create a blocked actor that is already blocked example": {
|
||||
"$ref": "./examples/platform/blockedActors/CreateBlockedActorAlreadyBlocked.json"
|
||||
},
|
||||
"Create a new blocked actor example": {
|
||||
"$ref": "./examples/platform/blockedActors/CreateBlockedActor.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"get": {
|
||||
"summary": "Lists blocked actors on a capacity.",
|
||||
"description": "Returns a paginated list of blocked actors on the specified capacity.\n\nBlocked actors whose `expirationPolicy.expireAfterDateTime` has passed may still appear in the list until a background garbage-collection job removes them; enforcement has already stopped for those entries.\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\nThe caller must be a capacity admin.\n\n## Required Delegated Scopes\n\nCapacity.Read.All or Capacity.ReadWrite.All\n\n## Limitations\n\n- Each capacity can hold a maximum of 1,000 surge-protection items combined across blocked actors, mission critical actors, and detection rules.\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_ListBlockedActors",
|
||||
"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": "Successfully returned the list of blocked actors.",
|
||||
"schema": {
|
||||
"$ref": "./definitions/surgeProtectionActors.json#/definitions/BlockedActors"
|
||||
}
|
||||
},
|
||||
"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* InvalidContinuationToken - The continuation token is invalid or expired.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"List blocked actors example": {
|
||||
"$ref": "./examples/platform/blockedActors/ListBlockedActors.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/capacities/{capacityId}/surgeProtection/blockedActors/{blockedActorId}": {
|
||||
"get": {
|
||||
"summary": "Gets the specified blocked actor.",
|
||||
"description": "Returns the specified blocked actor on the capacity.\n\n## Permissions\n\nThe caller must be a capacity admin.\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_GetBlockedActor",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "capacityId",
|
||||
"description": "The capacity ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "blockedActorId",
|
||||
"description": "The blocked actor ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successfully returned the blocked actor.",
|
||||
"schema": {
|
||||
"$ref": "./definitions/surgeProtectionActors.json#/definitions/BlockedActor"
|
||||
}
|
||||
},
|
||||
"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* BlockedActorNotFound - The blocked actor with the specified ID does not exist on this capacity.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Get a blocked actor example": {
|
||||
"$ref": "./examples/platform/blockedActors/GetBlockedActor.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"patch": {
|
||||
"summary": "Updates a blocked actor on a capacity.",
|
||||
"description": "Updates the expiration configuration of the specified blocked actor.\n\n## Permissions\n\nThe caller must be a capacity admin.\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_UpdateBlockedActor",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "capacityId",
|
||||
"description": "The capacity ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "blockedActorId",
|
||||
"description": "The blocked actor ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "body",
|
||||
"name": "updateBlockedActorRequest",
|
||||
"description": "Update blocked actor request payload.",
|
||||
"schema": {
|
||||
"$ref": "./definitions/surgeProtectionActors.json#/definitions/UpdateBlockedActorRequest"
|
||||
},
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successfully updated the blocked actor.",
|
||||
"schema": {
|
||||
"$ref": "./definitions/surgeProtectionActors.json#/definitions/BlockedActor"
|
||||
}
|
||||
},
|
||||
"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* InvalidRequest - The request body is malformed or contains invalid field values.\n\n* BlockedActorNotFound - The blocked actor with the specified ID does not exist on this capacity.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Update a blocked actor example": {
|
||||
"$ref": "./examples/platform/blockedActors/UpdateBlockedActor.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Deletes a blocked actor from a capacity.",
|
||||
"description": "Deletes the specified blocked actor from the capacity. The actor's background operations will no longer be blocked.\n\n## Permissions\n\nThe caller must be a capacity admin.\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_DeleteBlockedActor",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "capacityId",
|
||||
"description": "The capacity ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "blockedActorId",
|
||||
"description": "The blocked actor ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successfully deleted the blocked actor."
|
||||
},
|
||||
"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* BlockedActorNotFound - The blocked actor with the specified ID does not exist on this capacity.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Delete a blocked actor example": {
|
||||
"$ref": "./examples/platform/blockedActors/DeleteBlockedActor.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/capacities/{capacityId}/surgeProtection/missionCriticalActors": {
|
||||
"post": {
|
||||
"summary": "Creates a mission critical actor on a capacity.",
|
||||
"description": "Creates a mission critical actor on the specified capacity. The actor's operations will be shielded from surge-protection rejection.\n\n**Idempotent no-op semantics:** If the specified actor is already mission critical on this capacity, the existing record is returned unchanged with `200 OK`. If the actor is new, the record is created and returned with `201 Created`.\n\n## Permissions\n\nThe caller must be a capacity admin.\n\n## Required Delegated Scopes\n\nCapacity.ReadWrite.All\n\n## Limitations\n\n- Each capacity can hold a maximum of 1,000 surge-protection items combined across blocked actors, mission critical actors, and detection rules.\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_CreateMissionCriticalActor",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "capacityId",
|
||||
"description": "The capacity ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "body",
|
||||
"name": "createMissionCriticalActorRequest",
|
||||
"description": "Create mission critical actor request payload.",
|
||||
"schema": {
|
||||
"$ref": "./definitions/surgeProtectionActors.json#/definitions/CreateMissionCriticalActorRequest"
|
||||
},
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "The actor was already mission critical on the capacity; the existing mission critical actor was returned unchanged.",
|
||||
"schema": {
|
||||
"$ref": "./definitions/surgeProtectionActors.json#/definitions/MissionCriticalActor"
|
||||
}
|
||||
},
|
||||
"201": {
|
||||
"description": "Successfully created a new mission critical actor.",
|
||||
"schema": {
|
||||
"$ref": "./definitions/surgeProtectionActors.json#/definitions/MissionCriticalActor"
|
||||
}
|
||||
},
|
||||
"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* InvalidRequest - The request body is malformed or contains invalid field values.\n\n* SurgeProtectionItemsLimitExceeded - The capacity has reached the 1,000 combined surge-protection items limit.\n\n* WorkspaceNotFound - The workspace specified in `actorDetails.workspaceId` does not exist or is not associated with this capacity.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Create a mission critical actor that already exists example": {
|
||||
"$ref": "./examples/platform/missionCriticalActors/CreateMissionCriticalActorAlreadyExists.json"
|
||||
},
|
||||
"Create a new mission critical actor example": {
|
||||
"$ref": "./examples/platform/missionCriticalActors/CreateMissionCriticalActor.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"get": {
|
||||
"summary": "Lists mission critical actors on a capacity.",
|
||||
"description": "Returns a paginated list of mission critical actors on the specified capacity.\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\nThe caller must be a capacity admin.\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_ListMissionCriticalActors",
|
||||
"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": "Successfully returned the list of mission critical actors.",
|
||||
"schema": {
|
||||
"$ref": "./definitions/surgeProtectionActors.json#/definitions/MissionCriticalActors"
|
||||
}
|
||||
},
|
||||
"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* InvalidContinuationToken - The continuation token is invalid or expired.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"List mission critical actors example": {
|
||||
"$ref": "./examples/platform/missionCriticalActors/ListMissionCriticalActors.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/capacities/{capacityId}/surgeProtection/missionCriticalActors/{missionCriticalActorId}": {
|
||||
"get": {
|
||||
"summary": "Gets the specified mission critical actor.",
|
||||
"description": "Returns the specified mission critical actor on the capacity.\n\n## Permissions\n\nThe caller must be a capacity admin.\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_GetMissionCriticalActor",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "capacityId",
|
||||
"description": "The capacity ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "missionCriticalActorId",
|
||||
"description": "The mission critical actor ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successfully returned the mission critical actor.",
|
||||
"schema": {
|
||||
"$ref": "./definitions/surgeProtectionActors.json#/definitions/MissionCriticalActor"
|
||||
}
|
||||
},
|
||||
"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* MissionCriticalActorNotFound - The mission critical actor with the specified ID does not exist on this capacity.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Get a mission critical actor example": {
|
||||
"$ref": "./examples/platform/missionCriticalActors/GetMissionCriticalActor.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Deletes a mission critical actor from a capacity.",
|
||||
"description": "Deletes the specified mission critical actor from the capacity. The actor will no longer be shielded from surge-protection rejection.\n\n## Permissions\n\nThe caller must be a capacity admin.\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_DeleteMissionCriticalActor",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "capacityId",
|
||||
"description": "The capacity ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "missionCriticalActorId",
|
||||
"description": "The mission critical actor ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successfully deleted the mission critical actor."
|
||||
},
|
||||
"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* MissionCriticalActorNotFound - The mission critical actor with the specified ID does not exist on this capacity.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Delete a mission critical actor example": {
|
||||
"$ref": "./examples/platform/missionCriticalActors/DeleteMissionCriticalActor.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/capacities/{capacityId}/overageConfiguration": {
|
||||
"get": {
|
||||
"summary": "Gets the overage configuration for the specified capacity.",
|
||||
@@ -6191,7 +6804,7 @@
|
||||
"/deploymentPipelines/{deploymentPipelineId}/deploy": {
|
||||
"post": {
|
||||
"summary": "Deploys items from the specified stage of the specified deployment pipeline.",
|
||||
"description": "To learn about items that are supported in deployment pipelines, see: [Supported items](/fabric/cicd/deployment-pipelines/intro-to-deployment-pipelines#supported-items).\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\nThe caller must have an *admin* deployment pipelines role.\nThe user must be at least a contributor on both source and target deployment workspaces. For more information, see: [Permissions](https://go.microsoft.com/fwlink/?linkid=2235654).\n\n## Required Delegated Scopes\n\nPipeline.Deploy\n\n## Limitations\n\nMaximum 300 deployed items per request.\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) | Only supported when all the [items](/rest/api/fabric/articles/item-management/item-management-overview) involved in the operation support service principals |\n\n## Interface",
|
||||
"description": "> [!NOTE]\n> Deployment plan support in this API is part of a Beta release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use. All other functionality of this API is generally available.\n**To use deployment plan support, callers must specify `true` as the value for the query parameter `beta`.**\n\nTo learn about items that are supported in deployment pipelines, see: [Supported items](/fabric/cicd/deployment-pipelines/intro-to-deployment-pipelines#supported-items).\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\nThe caller must have an *admin* deployment pipelines role.\nThe user must be at least a contributor on both source and target deployment workspaces. For more information, see: [Permissions](https://go.microsoft.com/fwlink/?linkid=2235654).\n\n## Required Delegated Scopes\n\nPipeline.Deploy\n\n## Limitations\n\nMaximum 300 deployed items per request.\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) | Only supported when all the [items](/rest/api/fabric/articles/item-management/item-management-overview) involved in the operation support service principals |\n\n## Interface",
|
||||
"tags": [
|
||||
"DeploymentPipelines"
|
||||
],
|
||||
@@ -6212,6 +6825,13 @@
|
||||
"type": "string",
|
||||
"format": "uuid"
|
||||
},
|
||||
{
|
||||
"name": "beta",
|
||||
"in": "query",
|
||||
"description": "Set to `true` to enable Beta functionality, including deployment plan support. When omitted or set to `false`, only generally available functionality is accessible and deployment plan input is not accepted.",
|
||||
"required": false,
|
||||
"type": "boolean"
|
||||
},
|
||||
{
|
||||
"name": "deployRequest",
|
||||
"in": "body",
|
||||
@@ -6281,6 +6901,9 @@
|
||||
},
|
||||
"Example of deploying with options": {
|
||||
"$ref": "./examples/deploymentPipelines/DeployWithOptions.json"
|
||||
},
|
||||
"Example of deploying Fabric items from a deployment pipeline stage using a deployment plan": {
|
||||
"$ref": "./examples/deploymentPipelines/DeployWithDeploymentPlan.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
+19
-2
@@ -37,7 +37,7 @@
|
||||
},
|
||||
"CreateReportRequest": {
|
||||
"description": "Create report request payload.",
|
||||
"required": ["displayName", "definition"],
|
||||
"required": ["displayName"],
|
||||
"properties": {
|
||||
"displayName": {
|
||||
"description": "The report display name. The display name must follow naming rules according to item type.",
|
||||
@@ -56,10 +56,15 @@
|
||||
"readOnly": false
|
||||
},
|
||||
"definition": {
|
||||
"description": "The report public definition.",
|
||||
"description": "The report public definition. Either `definition` or `creationPayload` is required. You can't use both at the same time.",
|
||||
"$ref": "#/definitions/ReportDefinition",
|
||||
"readOnly": false
|
||||
},
|
||||
"creationPayload": {
|
||||
"description": "The creation payload for creating a report connected to an existing semantic model. Either `definition` or `creationPayload` is required. You can't use both at the same time.",
|
||||
"$ref": "#/definitions/ReportCreationPayload",
|
||||
"readOnly": false
|
||||
},
|
||||
"sensitivityLabelSettings": {
|
||||
"description": "The sensitivity label settings for the report.",
|
||||
"$ref": "../common/definitions.json#/definitions/SensitivityLabelSettings",
|
||||
@@ -67,6 +72,18 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"ReportCreationPayload": {
|
||||
"description": "Creation payload for creating a report without a definition.",
|
||||
"type": "object",
|
||||
"required": ["semanticModelReference"],
|
||||
"properties": {
|
||||
"semanticModelReference": {
|
||||
"description": "A reference to the semantic model to connect the report to. The semantic model must be accessible to the caller.",
|
||||
"$ref": "../common/definitions.json#/definitions/ItemReferenceById",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateReportRequest": {
|
||||
"description": "Update report request.",
|
||||
"properties": {
|
||||
|
||||
@@ -0,0 +1,34 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"createReportRequest": {
|
||||
"displayName": "Sales Dashboard",
|
||||
"description": "An empty report connected to a semantic model.",
|
||||
"creationPayload": {
|
||||
"semanticModelReference": {
|
||||
"referenceType": "ById",
|
||||
"itemId": "5b218778-e7a5-4d73-8187-f10824047715",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"201": {
|
||||
"body": {
|
||||
"displayName": "Sales Dashboard",
|
||||
"description": "An empty report connected to a semantic model.",
|
||||
"type": "Report",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
|
||||
}
|
||||
},
|
||||
"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
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
+5
-2
@@ -91,7 +91,7 @@
|
||||
},
|
||||
"post": {
|
||||
"summary": "Creates a report in the specified workspace.",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n This API requires a [definition](/rest/api/fabric/articles/item-management/definitions/report-definition).\n\n## Permissions \n The caller must have a *contributor* workspace role.\n\n## Required Delegated Scopes \n\n Report.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations \n- To create a report item, the user must have the appropriate license. 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\nThe API supports two creation modes: (1) provide a `definition` for full control over the report structure, or (2) provide a `creationPayload` with a `semanticModelReference` to create an empty report connected to an existing semantic model. Either `definition` or `creationPayload` is required. You can't use both at the same time.\n\n## Permissions\n\nThe caller must have a *contributor* workspace role. When creating a report with a `creationPayload` that references a semantic model via `semanticModelReference`, the caller must also have read access to the referenced semantic model, including when that semantic model resides in a different workspace (cross-workspace reference).\n\n## Required Delegated Scopes\n\nReport.ReadWrite.All or Item.ReadWrite.All\n\n## Limitations\n\n- To create a report item, the user must have the appropriate license. 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"
|
||||
],
|
||||
@@ -161,7 +161,7 @@
|
||||
}
|
||||
},
|
||||
"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.",
|
||||
"description": "Common error codes:\n\n* ItemDisplayNameAlreadyInUse - Item display name is already used. \n\n* CorruptedPayload - The provided payload is corrupted. \n\n* MutuallyExclusiveProperties - The `definition` and `creationPayload` cannot both be provided. \n\n* MissingRequiredProperty - Either `definition` or `creationPayload` must be provided. \n\n* SemanticModelNotFound - The referenced semantic model does not exist or is not accessible.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
@@ -170,6 +170,9 @@
|
||||
"x-ms-examples": {
|
||||
"Create a report example": {
|
||||
"$ref": "./examples/CreateReport.json"
|
||||
},
|
||||
"Create a report with creation payload example": {
|
||||
"$ref": "./examples/CreateReportWithCreationPayload.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -37,7 +37,7 @@
|
||||
},
|
||||
"CreateSemanticModelRequest": {
|
||||
"description": "Create semantic model request payload.",
|
||||
"required": ["displayName", "definition"],
|
||||
"required": ["displayName"],
|
||||
"properties": {
|
||||
"displayName": {
|
||||
"description": "The semantic model display name. The display name must follow naming rules according to item type.",
|
||||
@@ -56,10 +56,15 @@
|
||||
"readOnly": false
|
||||
},
|
||||
"definition": {
|
||||
"description": "The semantic model public definition.",
|
||||
"description": "The semantic model public definition. Use `definition` or `creationPayload`. You can't use both at the same time.",
|
||||
"$ref": "#/definitions/SemanticModelDefinition",
|
||||
"readOnly": false
|
||||
},
|
||||
"creationPayload": {
|
||||
"description": "The creation payload for creating a semantic model without a full definition. Provide OneLake table URLs to create a DirectLake model, or omit both `definition` and `creationPayload` to create an empty semantic model. Use `definition` or `creationPayload`. You can't use both at the same time.",
|
||||
"$ref": "#/definitions/SemanticModelCreationPayload",
|
||||
"readOnly": false
|
||||
},
|
||||
"sensitivityLabelSettings": {
|
||||
"description": "The sensitivity label settings for the semantic model.",
|
||||
"$ref": "../common/definitions.json#/definitions/SensitivityLabelSettings",
|
||||
@@ -158,6 +163,22 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"SemanticModelCreationPayload": {
|
||||
"description": "Creation payload for creating a semantic model without a definition.",
|
||||
"type": "object",
|
||||
"required": ["oneLakeTables"],
|
||||
"properties": {
|
||||
"oneLakeTables": {
|
||||
"description": "A list of OneLake table URLs to connect the semantic model to (maximum 100). Each URL must follow one of two formats: `https://onelake.dfs.fabric.microsoft.com/{workspaceId}/{dataItemId}/Tables/{tableName}` for a table in the default `dbo` schema, or `https://onelake.dfs.fabric.microsoft.com/{workspaceId}/{dataItemId}/Tables/{schemaName}/{tableName}` for a table in an explicit custom schema. URLs may reference different workspaces and data items, and a single request may mix default-schema and custom-schema URLs. The system infers table names and columns from the OneLake source.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string",
|
||||
"format": "uri"
|
||||
},
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"BindSemanticModelConnectionRequest": {
|
||||
"description": "The payload of a bindConnection request to bind a data source reference of a semantic model to a data connection.",
|
||||
"required": ["connectionBinding"],
|
||||
|
||||
@@ -0,0 +1,27 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"createSemanticModelRequest": {
|
||||
"displayName": "SemanticModel 1",
|
||||
"description": "An empty semantic model."
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"201": {
|
||||
"body": {
|
||||
"displayName": "SemanticModel 1",
|
||||
"description": "An empty semantic model.",
|
||||
"type": "SemanticModel",
|
||||
"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",
|
||||
"createSemanticModelRequest": {
|
||||
"displayName": "Sales Analytics Model",
|
||||
"description": "A semantic model connected to lakehouse tables.",
|
||||
"creationPayload": {
|
||||
"oneLakeTables": [
|
||||
"https://onelake.dfs.fabric.microsoft.com/aaaa0000-bb11-2222-33cc-444444dddddd/cccc0000-dd11-2222-33ee-444444ffffff/Tables/dim_customer",
|
||||
"https://onelake.dfs.fabric.microsoft.com/aaaa0000-bb11-2222-33cc-444444dddddd/cccc0000-dd11-2222-33ee-444444ffffff/Tables/sales/dim_product",
|
||||
"https://onelake.dfs.fabric.microsoft.com/1111aaaa-bb22-3333-44cc-555555eeeeee/2222bbbb-cc33-4444-55dd-666666ffffff/Tables/dim_region"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"201": {
|
||||
"body": {
|
||||
"displayName": "Sales Analytics Model",
|
||||
"description": "A semantic model connected to lakehouse tables.",
|
||||
"type": "SemanticModel",
|
||||
"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
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -91,7 +91,7 @@
|
||||
},
|
||||
"post": {
|
||||
"summary": "Creates a semantic model in the specified workspace.",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n This API requires a [definition](/rest/api/fabric/articles/item-management/definitions/semantic-model-definition).\n\n## Permissions\n\nThe caller must have a *contributor* workspace role.\n\n## Required Delegated Scopes \n\n SemanticModel.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations \n- To create a semantic model, the user must have the appropriate license. 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\nThe API supports three creation modes: (1) provide a `definition` for full control over the model structure, (2) provide a `creationPayload` with OneLake table URLs to create a DirectLake model, or (3) omit both to create an empty semantic model. Use `definition` or `creationPayload`. You can't use both at the same time.\n\n## Permissions\n\nThe caller must have a *contributor* workspace role. When creating a DirectLake model with a `creationPayload` that references OneLake tables, the caller must also have access to each referenced source Lakehouse or data item, including when those sources reside in a different workspace (cross-workspace sources).\n\n## Required Delegated Scopes\n\nSemanticModel.ReadWrite.All or Item.ReadWrite.All\n\n## Limitations\n\n- To create a semantic model, the user must have the appropriate license. 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"
|
||||
],
|
||||
@@ -161,7 +161,7 @@
|
||||
}
|
||||
},
|
||||
"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.",
|
||||
"description": "Common error codes:\n\n* ItemDisplayNameAlreadyInUse - Item display name is already used. \n\n* CorruptedPayload - The provided payload is corrupted. \n\n* MutuallyExclusiveProperties - The `definition` and `creationPayload` cannot both be provided. \n\n* InvalidOneLakeTableUrl - One or more OneLake table URLs are invalid. \n\n* DuplicateTableName - Duplicate table names are not allowed.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
@@ -170,6 +170,12 @@
|
||||
"x-ms-examples": {
|
||||
"Create a semantic model example": {
|
||||
"$ref": "./examples/CreateSemanticModel.json"
|
||||
},
|
||||
"Create an empty semantic model example": {
|
||||
"$ref": "./examples/CreateSemanticModelEmpty.json"
|
||||
},
|
||||
"Create a semantic model with OneLake tables example": {
|
||||
"$ref": "./examples/CreateSemanticModelWithOneLakeTables.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Reference in new issue
Block a user