nprasad2077/fabric-rest-api-specs
1
0 Fork 0
mirror of https://github.com/microsoft/fabric-rest-api-specs.git synced 2026-11-04 12:04:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

updated-swagger-files-%date%

Browse Source
This commit is contained in:
Fabric-APIs-Publish-Specification-Pipeline committed 2025-04-03 08:04:02 +00:00
1 parent 1db7e27db9
commit 10f950519a
487 files changed
+44246
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

admin/definitions.json
+999
View File
@@ -0,0 +1,999 @@
{
"swagger": "2.0",
"info": {
"version": "v1",
"title": "Admin data types"
},
"paths": {},
"definitions": {
"Workspaces": {
"description": "A list of workspaces.",
"properties": {
"workspaces": {
"type": "array",
"description": "The list of fabric workspaces.",
"items": {
"$ref": "#/definitions/Workspace"
}
}
},
"allOf": [
{
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
}
]
},
"Workspace": {
"required": [ "id", "name", "type", "state" ],
"description": "Workspace.",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true,
"description": "The workspace ID."
},
"name": {
"type": "string",
"description": "The workspace name."
},
"type": {
"type": "string",
"description": "The workspace type.",
"$ref": "../common/definitions.json#/definitions/WorkspaceType",
"readOnly": true
},
"state": {
"type": "string",
"description": "The workspace state.",
"$ref": "#/definitions/WorkspaceState",
"readOnly": true
},
"capacityId": {
"type": "string",
"format": "uuid",
"readOnly": true,
"description": "The capacity ID of the workspace."
}
}
},
"GitConnections": {
"description": "A response wrapper for a list of all the Git connections for a given tenant with a continuous token.",
"properties": {
"value": {
"type": "array",
"description": "The list of Git connections for a given tenant.",
"items": {
"$ref": "#/definitions/GitConnectionDetails"
}
}
},
"allOf": [
{
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
}
]
},
"Items": {
"description": "A list of items.",
"properties": {
"itemEntities": {
"type": "array",
"description": "The list of items for a given tenant.",
"items": {
"$ref": "#/definitions/Item"
}
}
},
"allOf": [
{
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
}
]
},
"Item": {
"required": [ "id" ],
"description": "Item details.",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true,
"description": "The item ID."
},
"name": {
"type": "string",
"description": "The item name."
},
"type": {
"description": "The item type. Includes values such as Synapse, Notebook, Kqldatabase and SynapseWorkbook.",
"$ref": "../common/definitions.json#/definitions/ItemType",
"readOnly": true
},
"description": {
"type": "string",
"description": "Item details including item type and item usage."
},
"state": {
"type": "string",
"description": "The item status.",
"$ref": "#/definitions/ItemState",
"readOnly": true
},
"lastUpdatedDate": {
"type": "string",
"format": "date-time",
"description": "The last updated date and time."
},
"creatorPrincipal": {
"description": "The item's owner.",
"$ref": "../common/definitions.json#/definitions/Principal",
"readOnly": true
},
"workspaceId": {
"type": "string",
"format": "uuid",
"readOnly": true,
"description": "The workspace ID of item."
},
"capacityId": {
"type": "string",
"format": "uuid",
"readOnly": true,
"description": "The capacity ID of the workspace."
}
}
},
"WorkspaceAccessDetailsResponse": {
"description": "A list of users with access to a given entity.",
"properties": {
"accessDetails": {
"type": "array",
"description": "A list of users with access to an entity.",
"items": {
"$ref": "#/definitions/WorkspaceAccessDetails"
}
}
}
},
"ItemAccessDetailsResponse": {
"description": "A list of users with access to a given entity.",
"properties": {
"accessDetails": {
"type": "array",
"description": "A list of users with access to an entity.",
"items": {
"$ref": "#/definitions/ItemAccessDetails"
}
}
}
},
"ItemAccessDetails": {
"type": "object",
"description": "User access details for an item.",
"properties": {
"principal": {
"description": "Information regarding the user who has access to the entity.",
"$ref": "../common/definitions.json#/definitions/Principal",
"readOnly": true
},
"itemAccessDetails": {
"description": "Item permissions for the user.",
"$ref": "#/definitions/ItemAccessDetail",
"readOnly": true
}
}
},
"WorkspaceAccessDetails": {
"type": "object",
"description": "User access details for the workspace.",
"properties": {
"principal": {
"description": "Information regarding the user who has access to the entity.",
"$ref": "../common/definitions.json#/definitions/Principal",
"readOnly": true
},
"workspaceAccessDetails": {
"description": "Workspace permissions for the user.",
"$ref": "#/definitions/WorkspaceAccessDetail",
"readOnly": true
}
}
},
"AccessDetails": {
"type": "object",
"description": "User access details for the given entity.",
"properties": {
"principal": {
"description": "Information regarding the user who has access to the entity.",
"$ref": "../common/definitions.json#/definitions/Principal",
"readOnly": true
},
"workspaceAccessDetails": {
"description": "Workspace permissions for the user.",
"$ref": "#/definitions/WorkspaceAccessDetail",
"readOnly": true
},
"itemAccessDetails": {
"description": "Item permissions for the user.",
"$ref": "#/definitions/ItemAccessDetail",
"readOnly": true
}
}
},
"WorkspaceAccessDetail": {
"type": "object",
"description": "Workspace permission details.",
"properties": {
"type": {
"type": "string",
"description": "Workspace type.",
"$ref": "../common/definitions.json#/definitions/WorkspaceType"
},
"workspaceRole": {
"description": "The workspace role.",
"$ref": "../common/definitions.json#/definitions/WorkspaceRole"
}
}
},
"ItemAccessDetail": {
"type": "object",
"description": "Item permission details such as *read* and *reshare*. ",
"properties": {
"type": {
"type": "string",
"description": "Entity type.",
"$ref": "../common/definitions.json#/definitions/ItemType"
},
"permissions": {
"type": "array",
"description": "Item permissions such as *read* and *reshare*.",
"items": {
"type": "string",
"$ref": "../common/definitions.json#/definitions/ItemPermissions"
}
},
"additionalPermissions": {
"type": "array",
"description": "Workload permissions such as *readAll* and *viewOutput*.",
"items": {
"type": "string"
}
}
}
},
"AccessEntityResponse": {
"description": "A list of entities and permissions.",
"properties": {
"accessEntities": {
"type": "array",
"description": "A list of users with access to an entity.",
"items": {
"$ref": "#/definitions/AccessEntity"
}
}
},
"allOf": [
{
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
}
]
},
"AccessEntity": {
"description": "Access details for the given user.",
"properties": {
"displayName": {
"type": "string",
"description": "Entity name."
},
"id": {
"type": "string",
"format": "uuid",
"readOnly": true,
"description": "The object ID of the entity."
},
"category": {
"description": "Entity category such as item.",
"$ref": "#/definitions/Category"
},
"type": {
"type": "string",
"description": "Entity type."
},
"itemAccessDetails": {
"description": "Item permissions.",
"$ref": "#/definitions/ItemAccessDetail"
}
}
},
"BaseTenantSetting": {
"required": [
"settingName",
"title",
"enabled",
"canSpecifySecurityGroups"
],
"description": "The base object of tenant setting details.",
"properties": {
"settingName": {
"type": "string",
"description": "The name of the tenant setting."
},
"title": {
"type": "string",
"description": "The title of the tenant setting."
},
"enabled": {
"type": "boolean",
"description": "The status of the tenant setting. False - Disabled, True - Enabled."
},
"canSpecifySecurityGroups": {
"type": "boolean",
"description": "Indicates if the tenant setting is enabled for a security group. False - The tenant setting is enabled for the entire organization. True - The tenant setting is enabled for security groups."
},
"enabledSecurityGroups": {
"type": "array",
"description": "A list of enabled security groups.",
"items": {
"$ref": "#/definitions/TenantSettingSecurityGroup"
}
},
"excludedSecurityGroups": {
"type": "array",
"description": "A list of excluded security groups.",
"items": {
"$ref": "#/definitions/TenantSettingSecurityGroup"
}
},
"tenantSettingGroup": {
"type": "string",
"description": "Tenant setting group name."
},
"properties": {
"type": "array",
"description": "Tenant setting properties.",
"items": {
"$ref": "#/definitions/TenantSettingProperty"
}
}
}
},
"CapacityTenantSetting": {
"description": "Capacity tenant setting details.",
"properties": {
"delegateToWorkspace": {
"type": "boolean",
"description": "Indicates whether the tenant setting can be delegated to a workspace admin. False - Workspace admin cannot override the tenant setting. True - Workspace admin can override the tenant setting."
},
"delegatedFrom": {
"type": "string",
"description": "Tenant setting delegated from tenant, capacity or domain.",
"$ref": "#/definitions/DelegatedFrom",
"readOnly": false
}
},
"allOf": [
{
"$ref": "#/definitions/BaseTenantSetting"
}
]
},
"DomainTenantSetting": {
"description": "Domain tenant setting details.",
"properties": {
"delegateToWorkspace": {
"type": "boolean",
"description": "Indicates whether the tenant setting can be delegated to a workspace admin. False - Workspace admin cannot override the tenant setting. True - Workspace admin can override the tenant setting."
},
"delegatedFrom": {
"type": "string",
"description": "Tenant setting delegated from tenant, capacity or domain.",
"$ref": "#/definitions/DelegatedFrom",
"readOnly": false
}
},
"allOf": [
{
"$ref": "#/definitions/BaseTenantSetting"
}
]
},
"WorkspaceTenantSetting": {
"description": "Workspace tenant setting details.",
"properties": {
"delegatedFrom": {
"type": "string",
"description": "Tenant setting delegated from tenant, capacity or domain.",
"$ref": "#/definitions/DelegatedFrom",
"readOnly": false
}
},
"allOf": [
{
"$ref": "#/definitions/BaseTenantSetting"
}
]
},
"TenantSetting": {
"description": "Tenant level setting details.",
"properties": {
"delegateToWorkspace": {
"type": "boolean",
"description": "Indicates whether the tenant setting can be delegated to a workspace admin. False - Workspace admin cannot override the tenant setting. True - Workspace admin can override the tenant setting."
},
"delegateToCapacity": {
"type": "boolean",
"description": "Indicates whether the tenant setting can be delegated to a capacity admin. False - Capacity admin cannot override the tenant setting. True - Capacity admin can override the tenant setting."
},
"delegateToDomain": {
"type": "boolean",
"description": "Indicates whether the tenant setting can be delegated to a domain admin. False - Domain admin cannot override the tenant setting. True - Domain admin can override the tenant setting."
}
},
"allOf": [
{
"$ref": "#/definitions/BaseTenantSetting"
}
]
},
"TenantSettings": {
"description": "A list of tenant settings.",
"properties": {
"value": {
"type": "array",
"description": "A list of tenant settings.",
"items": {
"$ref": "#/definitions/TenantSetting"
}
}
},
"allOf": [
{
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
}
]
},
"CapacityTenantSettingOverride": {
"description": "A capacity admin can override the tenant setting.",
"properties": {
"id": {
"type": "string",
"description": "The ID of a capacity."
},
"tenantSettings": {
"type": "array",
"description": "A list of capacity tenant settings.",
"items": {
"$ref": "#/definitions/CapacityTenantSetting"
}
}
}
},
"DomainTenantSettingOverride": {
"description": "A domain admin can override the tenant setting.",
"properties": {
"id": {
"type": "string",
"description": "The ID of a domain.",
"format": "uuid"
},
"tenantSettings": {
"type": "array",
"description": "A list of domain tenant settings.",
"items": {
"$ref": "#/definitions/DomainTenantSetting"
}
}
}
},
"WorkspaceTenantSettingOverride": {
"description": "A workspaceadmin can override the tenant setting.",
"properties": {
"id": {
"type": "string",
"description": "The ID of a workspace.",
"format": "uuid"
},
"tenantSettings": {
"type": "array",
"description": "A list of workspace tenant settings.",
"items": {
"$ref": "#/definitions/WorkspaceTenantSetting"
}
}
}
},
"CapacityTenantSettingOverrides": {
"description": "A list of tenant settings overrides.",
"properties": {
"value": {
"type": "array",
"description": "A list of tenant settings that were overridden by capacity admin.",
"items": {
"$ref": "#/definitions/CapacityTenantSettingOverride"
}
}
},
"allOf": [
{
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
}
]
},
"CapacityTenantSettingsByCapacityIdResponse": {
"description": "A list of tenant settings overrides for given capacityId",
"properties": {
"value": {
"type": "array",
"description": "A list of tenant settings that were overridden by capacity admin for given capacityId.",
"items": {
"$ref": "#/definitions/CapacityTenantSetting"
}
}
},
"allOf": [
{
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
}
]
},
"DomainTenantSettingOverrides": {
"description": "A list of tenant settings overrides.",
"properties": {
"value": {
"type": "array",
"description": "A list of tenant settings that were overridden by a domain admin.",
"items": {
"$ref": "#/definitions/DomainTenantSettingOverride"
}
}
},
"allOf": [
{
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
}
]
},
"WorkspaceTenantSettingOverrides": {
"description": "A list of tenant settings overrides.",
"properties": {
"value": {
"type": "array",
"description": "A list of tenant settings that were overridden by a workspace admin.",
"items": {
"$ref": "#/definitions/WorkspaceTenantSettingOverride"
}
}
},
"allOf": [
{
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
}
]
},
"UpdateTenantSettingRequest": {
"required": [
"enabled"
],
"description": "Tenant setting update request.",
"properties": {
"enabled": {
"type": "boolean",
"description": "The status of the tenant setting. False - Disabled, True - Enabled."
},
"enabledSecurityGroups": {
"type": "array",
"description": "A list of enabled security groups.",
"items": {
"$ref": "#/definitions/TenantSettingSecurityGroup"
}
},
"excludedSecurityGroups": {
"type": "array",
"description": "A list of excluded security groups.",
"items": {
"$ref": "#/definitions/TenantSettingSecurityGroup"
}
},
"properties": {
"type": "array",
"description": "Tenant setting properties.",
"items": {
"$ref": "#/definitions/TenantSettingProperty"
}
},
"delegateToCapacity": {
"type": "boolean",
"description": "Indicates whether the tenant setting can be delegated to a capacity admin. False - Capacity admin cannot override the tenant setting. True - Capacity admin can override the tenant setting. "
},
"delegateToDomain": {
"type": "boolean",
"description": "Indicates whether the tenant setting can be delegated to a domain admin. False - Domain admin cannot override the tenant setting. True - Domain admin can override the tenant setting."
},
"delegateToWorkspace": {
"type": "boolean",
"description": "Indicates whether the tenant setting can be delegated to a workspace admin. False - Workspace admin cannot override the tenant setting. True - Workspace admin can override the tenant setting."
}
}
},
"UpdateTenantSettingResponse": {
"description": "Tenant setting update response.",
"properties": {
"tenantSettings": {
"type": "array",
"description": "A list of tenant settings that were updated.",
"items": {
"$ref": "#/definitions/TenantSetting"
}
}
}
},
"UpdateCapacityTenantSettingOverrideRequest": {
"required": [
"enabled"
],
"type": "object",
"description": "Capacity tenant setting override update request.",
"properties": {
"enabled": {
"type": "boolean",
"description": "The status of the tenant setting. False - Disabled, True - Enabled."
},
"enabledSecurityGroups": {
"type": "array",
"description": "A list of enabled security groups.",
"items": {
"$ref": "#/definitions/TenantSettingSecurityGroup"
}
},
"excludedSecurityGroups": {
"type": "array",
"description": "A list of excluded security groups.",
"items": {
"$ref": "#/definitions/TenantSettingSecurityGroup"
}
},
"delegateToWorkspace": {
"type": "boolean",
"description": "Indicates whether the tenant setting can be delegated to a workspace admin. False - Workspace admin cannot override the tenant setting. True - Workspace admin can override the tenant setting."
}
}
},
"UpdateCapacityTenantSettingOverrideResponse": {
"description": "Capacity tenant setting override update request.",
"properties": {
"overrides": {
"type": "array",
"description": "A list of tenant settings that were updated in given capacity.",
"items": {
"$ref": "#/definitions/CapacityTenantSetting"
}
}
}
},
"TenantSettingSecurityGroup": {
"required": [ "graphId", "name" ],
"type": "object",
"description": "Tenant setting security group.",
"properties": {
"graphId": {
"type": "string",
"description": "The graph ID of the security group."
},
"name": {
"type": "string",
"description": "The name of the security group."
}
}
},
"TenantSettingProperty": {
"description": "Tenant setting property.",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the property."
},
"value": {
"type": "string",
"description": "The value of the property."
},
"type": {
"type": "string",
"description": "The type of the property.",
"$ref": "#/definitions/TenantSettingPropertyType"
}
}
},
"TenantSettingPropertyType": {
"type": "string",
"description": "Tenant setting property type. Additional tenant setting property types may be added over time.",
"enum": [ "FreeText", "Url", "Boolean", "MailEnabledSecurityGroup", "Integer" ],
"x-ms-enum": {
"name": "TenantSettingPropertyType",
"modelAsString": true,
"values": [
{
"value": "FreeText",
"description": "UI accepts any string for the text box."
},
{
"value": "Url",
"description": "UI accepts only URLs for the text box."
},
{
"value": "Boolean",
"description": "A checkbox in the UI."
},
{
"value": "MailEnabledSecurityGroup",
"description": "UI accepts only email enabled security groups for the text box."
},
{
"value": "Integer",
"description": "UI accepts only integers for the text box."
}
]
}
},
"DelegatedFrom": {
"type": "string",
"description": "The Fabric component (workspace, capacity or domain) that the tenant setting was delegated from. Additional `DelegatedFrom` may be added over time.",
"enum": [ "Tenant", "Capacity", "Domain" ],
"x-ms-enum": {
"name": "DelegatedFrom",
"modelAsString": true,
"values": [
{
"value": "Tenant",
"description": "The setting is delegated from a tenant."
},
{
"value": "Capacity",
"description": "The setting is delegated from a capacity."
},
{
"value": "Domain",
"description": "The setting is delegated from a domain."
}
]
}
},
"Category": {
"type": "string",
"description": "The category of the item type. Additional category types may be added over time.",
"enum": [ "Item" ],
"x-ms-enum": {
"name": "Category",
"modelAsString": true,
"values": [
{
"value": "Item",
"description": "Fabric items such as Notebook, Synapse and KQL Database."
}
]
}
},
"WorkspaceState": {
"type": "string",
"description": "The workspace state. Additional workspace states may be added over time.",
"enum": [ "Active", "Deleted" ],
"x-ms-enum": {
"name": "WorkspaceState",
"modelAsString": true,
"values": [
{
"value": "Active",
"description": "The workspace is active. Orphaned workspaces are displayed as active."
},
{
"value": "Deleted",
"description": "The workspace is deleted."
}
]
}
},
"GitConnectionDetails": {
"type": "object",
"description": "Represents the details of a Git connection for a workspace.",
"required": [
"workspaceId",
"gitProviderDetails"
],
"properties": {
"workspaceId": {
"type": "string",
"description": "The workspace ID.",
"format": "uuid"
},
"gitProviderDetails": {
"description": "The provider details.",
"$ref": "../common/definitions.json#/definitions/GitProviderDetails"
}
}
},
"ItemState": {
"type": "string",
"description": "The item state. Additional item states may be added over time.",
"enum": [ "Active" ],
"x-ms-enum": {
"name": "ItemState",
"modelAsString": true,
"values": [
{
"value": "Active",
"description": "An active item."
}
]
}
},
"RemoveLabelsRequest": {
"description": "A list of items requiring an information protection label update. Each item in the list includes the item ID and Fabric item type.",
"properties": {
"items": {
"type": "array",
"description": "A list of items.",
"items": {
"$ref": "#/definitions/ItemInfo"
}
}
}
},
"ItemsChangeLabelResponse": {
"description": "A list of the unique IDs and information protection label change status of the Fabric items in the label change request.",
"properties": {
"itemsChangeLabelStatus": {
"type": "array",
"description": "A list of items change label status.",
"items": {
"$ref": "#/definitions/ItemChangeLabelStatus"
}
}
}
},
"ItemChangeLabelStatus": {
"description": "The unique ID and information protection label change status of a Fabric item",
"required": [
"id",
"type",
"status"
],
"properties": {
"id": {
"type": "string",
"description": "The unique ID of a Fabric item. The ID is in UUID format.",
"readOnly": true
},
"type": {
"description": "The Fabric item type.",
"readOnly": true,
"$ref": "../common/definitions.json#/definitions/ItemType"
},
"status": {
"type": "string",
"description": "The status of an information protection label change operation. Additional tenant setting property types may be added over time.",
"readOnly": true,
"enum": [
"Failed",
"FailedToGetUsageRights",
"InsufficientUsageRights",
"NotFound",
"Succeeded"
],
"x-ms-enum": {
"name": "Status",
"modelAsExtensible": true,
"modelAsString": true,
"values": [
{
"value": "Failed",
"description": "Failed to set a new label. Please retry."
},
{
"value": "FailedToGetUsageRights",
"description": "Failed to set a new label. The Fabric item has a sensitivity label with protection settings, and Fabric was unable to verify that the user has sufficient usage rights to change the label."
},
{
"value": "InsufficientUsageRights",
"description": "Failed to set a new label. The Fabric item has a sensitivity label with protection settings, and the admin user (and the delegated user, if provided) doesn't have sufficient usage rights to change the label."
},
{
"value": "NotFound",
"description": "The Fabric item ID, label or type wasn't found."
},
{
"value": "Succeeded",
"description": "The Fabric item label was changed."
}
]
}
}
}
},
"SetLabelsRequest": {
"description": "A composite of label information required to update an information protection label.",
"required": [
"items",
"labelId"
],
"properties": {
"items": {
"type": "array",
"description": "A list of items. The list includes item ID and type.",
"readOnly": false,
"items": {
"$ref": "#/definitions/ItemInfo"
}
},
"labelId": {
"type": "string",
"format": "uuid",
"description": "The label ID, which must be in the user's label policy.",
"readOnly": false
},
"delegatedPrincipal": {
"description": "Delegated user details. A delegated user is a user within an organization whose admin sets a label on behalf of the user. Although the admin sets the label, the delegated user is marked as the label issuer. Only principals of type 'User' are supported.",
"readOnly": false,
"$ref": "../common/definitions.json#/definitions/Principal"
},
"assignmentMethod": {
"type": "string",
"description": "Specifies whether the assigned label was set by an automated process or manually. Additional tenant setting property types may be added over time.",
"readOnly": false,
"enum": [
"Standard",
"Priviledged"
],
"x-ms-enum": {
"name": "AssignmentMethod",
"modelAsExtensible": true,
"modelAsString": true,
"values": [
{
"value": "Standard",
"description": "The label was set by an automated process (default value)."
},
{
"value": "Priviledged",
"description": "The label was set manually."
}
]
}
}
}
},
"ItemInfo": {
"description": "The item information, including item ID and type.",
"type": "object",
"required": [
"id",
"type"
],
"properties": {
"id": {
"type": "string",
"description": "An ID in UUID format.",
"format": "uuid"
},
"type": {
"description": "The item type.",
"$ref": "../common/definitions.json#/definitions/ItemType"
}
}
},
"RestoreWorkspaceRequest": {
"description": "The request to restore a deleted workspace.",
"properties": {
"newWorkspaceName": {
"type": "string",
"description": "The name of the workspace. Mandatory if the restore request is for *My workspace*."
},
"newWorkspaceAdminPrincipal": {
"description": "The workspace's admin.",
"$ref": "../common/definitions.json#/definitions/Principal"
}
}
}
}
}
admin/definitions/domains.json
+271
View File
@@ -0,0 +1,271 @@
{
"swagger": "2.0",
"info": {
"version": "v1",
"title": "Domain data types"
},
"paths": {},
"definitions": {
"Domain": {
"type": "object",
"description": "Represents a domain or subdomain.",
"required": [
"id",
"displayName",
"contributorsScope"
],
"properties": {
"id": {
"type": "string",
"description": "The domain object ID.",
"format": "uuid"
},
"displayName": {
"type": "string",
"description": "The name of the domain."
},
"description": {
"type": "string",
"description": "The description of the domain."
},
"parentDomainId": {
"type": "string",
"description": "The domain parent object ID.",
"format": "uuid"
},
"contributorsScope": {
"description": "The domain contributors scope.",
"$ref": "#/definitions/ContributorsScopeType"
}
}
},
"DomainsResponse": {
"description": "This is a response wrapper for a list of all domains.",
"properties": {
"domains": {
"type": "array",
"description": "The list of domains.",
"items": {
"$ref": "#/definitions/Domain"
}
}
}
},
"DomainWorkspace": {
"type": "object",
"description": "Represents a workspace in a domain.",
"required": [
"id",
"displayName"
],
"properties": {
"id": {
"type": "string",
"description": "The workspace ID.",
"format": "uuid"
},
"displayName": {
"type": "string",
"description": "The name of the workspace."
}
}
},
"DomainWorkspaces": {
"description": "A response wrapper for a list of all the workspaces assigned to a domain with a continuous token.",
"properties": {
"value": {
"type": "array",
"description": "The list of all the workspaces assigned to the domain.",
"items": {
"$ref": "#/definitions/DomainWorkspace"
}
}
},
"allOf": [
{
"$ref": "../../common/definitions.json#/definitions/PaginatedResponse"
}
]
},
"UpdateDomainRequest": {
"description": "The request payload for updating a domain.",
"properties": {
"displayName": {
"type": "string",
"description": "The domain display name.\nThe display name cannot contain more than 40 characters.",
"readOnly": false
},
"description": {
"type": "string",
"description": "The domain description.\nThe description cannot contain more than 256 characters.",
"readOnly": false
},
"contributorsScope": {
"description": "The domain contributors scope.",
"$ref": "#/definitions/ContributorsScopeType"
}
}
},
"DomainRoleUnassignmentRequest": {
"description": "The request payload for unassigning domain members by principal.",
"required": [
"type"
],
"properties": {
"type": {
"description": "The update request type.",
"$ref": "#/definitions/DomainRole"
},
"principals": {
"type": "array",
"description": "The principals that will be unassigned from the domain role.",
"items": {
"$ref": "../../common/definitions.json#/definitions/Principal"
}
}
}
},
"DomainRoleAssignmentRequest": {
"description": "The request payload for assigning domain members for a domain by principal.",
"required": [
"type"
],
"properties": {
"type": {
"description": "The update request type.",
"$ref": "#/definitions/DomainRole"
},
"principals": {
"type": "array",
"description": "The principals that will be assigned to the domain role.",
"items": {
"$ref": "../../common/definitions.json#/definitions/Principal"
}
}
}
},
"AssignDomainWorkspacesByPrincipalsRequest": {
"description": "The request payload for assigning workspaces to a domain by principal.",
"properties": {
"principals": {
"description": "The principals that are admins of the workspaces.",
"type": "array",
"items": {
"$ref": "../../common/definitions.json#/definitions/Principal"
}
}
}
},
"AssignDomainWorkspacesByCapacitiesRequest": {
"description": "The request payload for assigning workspaces to a domain by capacity.",
"properties": {
"capacitiesIds": {
"type": "array",
"description": "The capacity IDs.",
"items": {
"type": "string",
"format": "uuid"
}
}
}
},
"UnassignDomainWorkspacesByIdsRequest": {
"description": "The request payload for unassigning workspaces from a domain by workspace ID.",
"properties": {
"workspacesIds": {
"description": "The workspace IDs that will be unassigned from that domain.",
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
},
"AssignDomainWorkspacesByIdsRequest": {
"description": "The request payload for assigning workspaces to a domain by workspace ID.",
"properties": {
"workspacesIds": {
"description": "The workspace IDs that will be assigned to that domain.",
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
},
"CreateDomainRequest": {
"required": [
"displayName"
],
"description": "The request payload for creating a domain or subdomain.",
"properties": {
"displayName": {
"description": "The domain display name.\nThe display name cannot contain more than 40 characters.",
"type": "string",
"readOnly": false
},
"description": {
"description": "The domain description.\nThe description cannot contain more than 256 characters.",
"type": "string",
"readOnly": false
},
"parentDomainId": {
"type": "string",
"format": "uuid",
"description": "The domain parent object ID."
}
}
},
"DomainRole": {
"type": "string",
"description": "Represents the domain members by the principal's request type. Additional request types may be added over time.",
"enum": [
"Admins",
"Contributors"
],
"x-ms-enum": {
"name": "DomainRole",
"modelAsString": true,
"values": [
{
"value": "Admins",
"description": "Domain admins request type."
},
{
"value": "Contributors",
"description": "Domain contributors request type."
}
]
}
},
"ContributorsScopeType": {
"type": "string",
"description": "The contributor scope. Additional contributor scopes may be added over time.",
"enum": [
"AllTenant",
"SpecificUsersAndGroups",
"AdminsOnly"
],
"x-ms-enum": {
"name": "ContributorsScopeType",
"modelAsString": true,
"values": [
{
"value": "AllTenant",
"description": "All the tenant's users."
},
{
"value": "SpecificUsersAndGroups",
"description": "Specific users and groups."
},
{
"value": "AdminsOnly",
"description": "Tenant and domain admins only."
}
]
}
}
}
}
admin/definitions/externaldatasharing.json
+141
View File
@@ -0,0 +1,141 @@
{
"swagger": "2.0",
"info": {
"version": "v1",
"title": "ExternalDataSharing - Admin APIs data types"
},
"paths": {},
"definitions": {
"ExternalDataShares": {
"type": "object",
"description": "A list of external data shares with a continuation token.",
"required": ["value"],
"properties": {
"value": {
"type": "array",
"description": "A list of external data shares.",
"items": {
"$ref": "#/definitions/ExternalDataShare"
},
"readOnly": true
}
},
"allOf": [
{
"$ref": "../../common/definitions.json#/definitions/PaginatedResponse"
}
]
},
"ExternalDataShare": {
"type": "object",
"description": "An external data share object.",
"required": ["id", "paths", "creatorPrincipal", "recipient", "status", "workspaceId", "itemId"],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The external data share ID.",
"readOnly": true
},
"paths": {
"type": "array",
"description": "The path or list of paths that are externally shared.",
"items": {
"type": "string"
},
"maxItems": 100,
"readOnly": true
},
"creatorPrincipal": {
"description": "The principal that created the external data share.",
"$ref": "../../common/definitions.json#/definitions/Principal",
"readOnly": true
},
"recipient": {
"description": "The recipient who was invited to accept the external data share.",
"$ref": "#/definitions/ExternalDataShareRecipient",
"readOnly": true
},
"status": {
"description": "The status of the external data share.",
"$ref": "#/definitions/ExternalDataShareStatus",
"readOnly": true
},
"expirationTimeUtc": {
"type": "string",
"format": "date-time",
"description": "The expiration date and time (UTC) of the invitation to the external data share.",
"readOnly": true
},
"workspaceId": {
"type": "string",
"format": "uuid",
"description": "The workspace ID.",
"readOnly": true
},
"itemId": {
"type": "string",
"format": "uuid",
"description": "The item ID.",
"readOnly": true
},
"invitationUrl": {
"type": "string",
"format": "uri",
"description": "The URL for accepting the invitation to the external data share.",
"readOnly": true
},
"acceptedByTenantId": {
"type": "string",
"format": "uuid",
"description": "The tenant ID in which the external data share was accepted.",
"readOnly": true
}
}
},
"ExternalDataShareStatus": {
"type": "string",
"description": "The status of a given external data share. Additional `ExternalDataShareStatus` types may be added over time.",
"enum": ["Pending", "Active", "Revoked", "InvitationExpired"],
"x-ms-enum": {
"name": "ExternalDataShareStatus",
"modelAsString": true,
"values": [
{
"value": "Pending",
"description": "An invitation was created and is now pending acceptance by the recipient."
},
{
"value": "Active",
"description": "The invitation has been accepted by the recipient and the external data share is active."
},
{
"value": "Revoked",
"description": "The external data share was revoked."
},
{
"value": "InvitationExpired",
"description": "The invitation expired and can no longer be accepted by the recipient."
}
]
}
},
"ExternalDataShareRecipient": {
"type": "object",
"description": "A representation of the the external data share recipient.",
"required": ["userPrincipalName"],
"properties": {
"userPrincipalName": {
"type": "string",
"description": "The recipient's email address.",
"maxLength": 256
},
"tenantId": {
"type": "string",
"format": "uuid",
"description": "The recipient's tenant ID."
}
}
}
}
}
admin/examples/GetItemById.json
+29
View File
@@ -0,0 +1,29 @@
{
"parameters": {
"itemId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"workspaceId": "7f4496db-9929-47bd-89c0-d7eb2f517a98",
"type": "Report"
},
"responses": {
"200": {
"body": {
"id": "17d8929d-ab32-46d1-858b-fdea74e93bf2",
"type": "Report",
"name": "Test",
"description": "Test Jacob's Report,",
"state": "Active",
"lastUpdatedDate": "2022-04-29T17:47:29.98673",
"workspaceId": "7f4496db-9929-47bd-89c0-d7eb2f517a98",
"capacityId": "D5E336D6-D919-4ECC-B424-1F771A506851",
"creatorPrincipal": {
"id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
"displayName": "Jacob Hancock",
"type": "User",
"userDetails": {
"userPrincipalName": "Jacob@example.com"
}
}
}
}
}
}
admin/examples/GetItemByIdNoType.json
+28
View File
@@ -0,0 +1,28 @@
{
"parameters": {
"itemId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"workspaceId": "7f4496db-9929-47bd-89c0-d7eb2f517a98"
},
"responses": {
"200": {
"body": {
"id": "17d8929d-ab32-46d1-858b-fdea74e93bf2",
"type": "Kusto",
"name": "Test",
"description": "Test Jacob's notebook.",
"state": "Active",
"lastUpdatedDate": "2022-04-29T17:47:29.98673",
"workspaceId": "7f4496db-9929-47bd-89c0-d7eb2f517a98",
"capacityId": "D5E336D6-D919-4ECC-B424-1F771A506851",
"creatorPrincipal": {
"id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
"displayName": "Jacob Hancock",
"type": "User",
"userDetails": {
"userPrincipalName": "Jacob@example.com"
}
}
}
}
}
}
admin/examples/GetWorkspaceById.json
+16
View File
@@ -0,0 +1,16 @@
{
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48"
},
"responses": {
"200": {
"body": {
"id": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
"name": "test report",
"type": "Workspace",
"state": "Active",
"capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84"
}
}
}
}
admin/examples/ListGitConnectionsDetails.json
+36
View File
@@ -0,0 +1,36 @@
{
"parameters": {},
"responses": {
"200": {
"body": {
"value": [
{
"workspaceId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
"gitProviderDetails":
{
"organizationName": "Test Organization",
"projectName": "Test Project",
"gitProviderType": "AzureDevOps",
"repositoryName": "Test Repo",
"branchName": "Test Branch",
"directoryName": "/Test Directory"
}
},
{
"workspaceId": "17d8929d-ab32-46d1-858b-fdea74e93bf2",
"gitProviderDetails":
{
"ownerName": "Test Owner",
"gitProviderType": "GitHub",
"repositoryName": "Test Repo",
"branchName": "Test Branch",
"directoryName": "/"
}
}
],
"continuationUri": "https://api.fabric.microsoft.com/v1/admin/workspaces/discoverGitConnections?continuationToken=eyJMYXN0U2VlbkNvbm5lY3Rpb25JZCI6NX0=",
"continuationToken": "eyJMYXN0U2VlbkNvbm5lY3Rpb25JZCI6NX0="
}
}
}
}
admin/examples/ListItemUsers.json
+74
View File
@@ -0,0 +1,74 @@
{
"parameters": {
"itemId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"workspaceId": "7f4496db-9929-47bd-89c0-d7eb2f517a98"
},
"responses": {
"200": {
"body": {
"accessDetails": [
{
"principal": {
"id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
"displayName": "Jacob Hancock",
"type": "User",
"userDetails": {
"userPrincipalName": "jacob@example.com"
}
},
"itemAccessDetails": {
"type": "Notebook",
"permissions": [
"Read",
"Reshare"
],
"additionalPermissions" : [
"ReadAll",
"viewOutput"
]
}
},
{
"principal": {
"id": "c7db8e03-c8cb-4d4c-9f64-1dcd327c9d3c",
"displayName": "Eric Solomon",
"type": "User",
"userDetails": {
"userPrincipalName": "eric@example.com"
}
},
"itemAccessDetails": {
"type": "Notebook",
"permissions": [
"Read",
"Reshare",
"Explore"
],
"additionalPermissions" : [
"ReadAll"
]
}
},
{
"principal": {
"id": "f51b705f-a409-4d40-9197-c5d5f349e2f0",
"displayName": "TestSecurityGroup",
"type": "Group",
"groupDetails": {
"groupType": "SecurityGroup"
}
},
"itemAccessDetails": {
"type": "Notebook",
"permissions": [
"Read",
"Reshare"
],
"additionalPermissions" : []
}
}
]
}
}
}
}
admin/examples/ListItemUsersByIdType.json
+35
View File
@@ -0,0 +1,35 @@
{
"parameters": {
"itemId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"workspaceId": "7f4496db-9929-47bd-89c0-d7eb2f517a98",
"type": "Report"
},
"responses": {
"200": {
"body": {
"accessDetails": [
{
"principal": {
"id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
"displayName": "Jacob Hancock",
"type": "User",
"userDetails": {
"userPrincipalName": "jacob@example.com"
}
},
"itemAccessDetails": {
"type": "Report",
"permissions": [
"Read",
"Reshare"
],
"additionalPermissions" : [
"ReadAll"
]
}
}
]
}
}
}
}
admin/examples/ListItems.json
+49
View File
@@ -0,0 +1,49 @@
{
"parameters": {},
"responses": {
"200": {
"body": {
"itemEntities": [
{
"id": "17d8929d-ab32-46d1-858b-fdea74e93bff",
"type": "Notebook",
"name": "Test",
"description": "Test notebook.",
"state": "Active",
"lastUpdatedDate": "2022-04-29T17:47:29.98673",
"workspaceId": "7f4496db-9929-47bd-89c0-d7eb2f517a95",
"capacityId": "D5E336D6-D919-4ECC-B424-1F771A506851",
"creatorPrincipal": {
"id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
"displayName": "Caleb Foster",
"type": "User",
"userDetails": {
"userPrincipalName": "caleb@example.com"
}
}
},
{
"id": "37d8929d-ab32-46d1-858b-fdea74e93bff",
"type": "KQLDatabase",
"name": "TestKusto",
"description": "Test KQL database.",
"state": "Active",
"lastUpdatedDate": "2022-06-30T17:47:29.98673",
"workspaceId": "8f4496db-9929-47bd-89c0-d7eb2f517a95",
"capacityId": "D5E336D6-D919-4ECC-B424-1F881A506851",
"creatorPrincipal": {
"id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
"displayName": "Jacob Hancock",
"type": "User",
"userDetails": {
"userPrincipalName": "jacob@example.com"
}
}
}
],
"continuationUri": "https://api.fabric.microsoft.com/v1/admin/items?continuationToken=MSwxMDAwMCww",
"continuationToken": "MSwxMDAwMCww"
}
}
}
}
admin/examples/ListItemsAccessByUpn.json
+32
View File
@@ -0,0 +1,32 @@
{
"parameters": {
"userId": "Test@Contoso.com"
},
"responses": {
"200": {
"body": {
"accessEntities": [
{
"id": "17d8929d-ab32-46d1-858b-fdea74e93bf2",
"displayName": "TestNotebook",
"category": "Item",
"itemAccessDetails": {
"type": "Notebook",
"permissions": [
"Read",
"Reshare",
"Explore"
],
"additionalPermissions" : [
"ReadAll",
"viewOutput"
]
}
}
],
"continuationUri": "https://api.fabric.microsoft.com/v1/admin/users/f3052d1c-61a9-46fb-8df9-0d78916ae041/access/?continuationToken=MSwxMDAwMCww",
"continuationToken": "MSwxMDAwMCww"
}
}
}
}
admin/examples/ListItemsAccessByUserId.json
+32
View File
@@ -0,0 +1,32 @@
{
"parameters": {
"userId": "f089354e-8366-4e18-aea3-4cb4a3a50b48"
},
"responses": {
"200": {
"body": {
"accessEntities": [
{
"id": "17d8929d-ab32-46d1-858b-fdea74e93bf2",
"displayName": "TestNotebook",
"category": "Item",
"itemAccessDetails": {
"type": "Notebook",
"permissions": [
"Read",
"Reshare",
"Explore"
],
"additionalPermissions" : [
"ReadAll",
"viewOutput"
]
}
}
],
"continuationUri": "https://api.fabric.microsoft.com/v1/admin/users/f3052d1c-61a9-46fb-8df9-0d78916ae041/access/?continuationToken=MSwxMDAwMCww",
"continuationToken": "MSwxMDAwMCww"
}
}
}
}
admin/examples/ListItemsAccessByUserIdAndType.json
+32
View File
@@ -0,0 +1,32 @@
{
"parameters": {
"userId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"type": "Report"
},
"responses": {
"200": {
"body": {
"accessEntities": [
{
"id": "17d8929d-ab32-46d1-858b-fdea74e93bf2",
"displayName": "Test Report",
"category": "Item",
"itemAccessDetails": {
"type": "Report",
"permissions": [
"Read",
"Reshare"
],
"additionalPermissions" : [
"ReadAll",
"viewOutput"
]
}
}
],
"continuationUri": null,
"continuationToken": null
}
}
}
}
admin/examples/ListItemsByDatamartType.json
+32
View File
@@ -0,0 +1,32 @@
{
"parameters": {
"type": "Lakehouse"
},
"responses": {
"200": {
"body": {
"itemEntities": [
{
"id": "b1a7e572-2585-4650-98ae-b92356f4460b",
"type": "Lakehouse",
"name": "Lakehouse 2022-03-16T21:42:38.442Z",
"state": "Active",
"lastUpdatedDate": "2022-06-27T16:55:04.893",
"workspaceId": "7f4496db-9929-47bd-89c0-d7eb2f517a98",
"capacityId": "D5E336D6-D919-4ECC-B424-1F771A506851",
"creatorPrincipal": {
"id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
"displayName": "Jacob Hancock",
"type": "User",
"userDetails": {
"userPrincipalName": "jacob@example.com"
}
}
}
],
"continuationUri": null,
"continuationToken": null
}
}
}
}
admin/examples/ListItemsByType.json
+32
View File
@@ -0,0 +1,32 @@
{
"parameters": {
"type": "Report"
},
"responses": {
"200": {
"body": {
"itemEntities": [
{
"id": "b1a7e572-2585-4650-98ae-b92356f4460b",
"type": "Report",
"name": "Test Report",
"state": "Active",
"lastUpdatedDate": "2022-06-27T16:55:04.893",
"workspaceId": "7f4496db-9929-47bd-89c0-d7eb2f517a98",
"capacityId": "D5E336D6-D919-4ECC-B424-1F771A506851",
"creatorPrincipal": {
"id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
"displayName": "Jacob Hancock",
"type": "User",
"userDetails": {
"userPrincipalName": "Jacob@example.com"
}
}
}
],
"continuationUri": null,
"continuationToken": null
}
}
}
}
admin/examples/ListWorkspaceUsers.json
+55
View File
@@ -0,0 +1,55 @@
{
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48"
},
"responses": {
"200": {
"body": {
"accessDetails": [
{
"principal": {
"id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
"displayName": "Jacob Hancock",
"type": "User",
"userDetails": {
"userPrincipalName": "jacob@example.com"
}
},
"workspaceAccessDetails": {
"type": "Workspace",
"workspaceRole": "Admin"
}
},
{
"principal": {
"id": "c7db8e03-c8cb-4d4c-9f64-1dcd327c9d3c",
"displayName": "Caleb Foster",
"type": "User",
"userDetails": {
"userPrincipalName": "caleb@example.com"
}
},
"workspaceAccessDetails": {
"type": "Workspace",
"workspaceRole": "Viewer"
}
},
{
"principal": {
"id": "f51b705f-a409-4d40-9197-c5d5f349e2f0",
"displayName": "TestSecurityGroup",
"type": "Group",
"groupDetails": {
"groupType": "SecurityGroup"
}
},
"workspaceAccessDetails": {
"type": "Workspace",
"workspaceRole": "Contributor"
}
}
]
}
}
}
}
admin/examples/ListWorkspaces.json
+20
View File
@@ -0,0 +1,20 @@
{
"parameters": {},
"responses": {
"200": {
"body": {
"workspaces": [
{
"id": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
"name": "test report",
"type": "Workspace",
"state": "Active",
"capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84"
}
],
"continuationUri": "https://api.fabric.microsoft.com/v1/admin/workspaces?continuationToken='LDEsMTAwMDAwLDA%3D'",
"continuationToken": "LDEsMTAwMDAwLDA%3D"
}
}
}
}
admin/examples/ListWorkspacesByState.json
+22
View File
@@ -0,0 +1,22 @@
{
"parameters": {
"state": "Active"
},
"responses": {
"200": {
"body": {
"workspaces": [
{
"id": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
"name": "test report",
"type": "Workspace",
"state": "Active",
"capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84"
}
],
"continuationUri": null,
"continuationToken": null
}
}
}
}
admin/examples/RestoreWorkspace.json
+15
View File
@@ -0,0 +1,15 @@
{
"parameters": {
"workspaceId": "97dd1d38-a4c6-41ed-bc4f-1e383f8ddd0f",
"restoreWorkspaceRequest": {
"newWorkspaceName": "Contoso Workspace",
"newWorkspaceAdminPrincipal": {
"id": "17dd1e38-a4c6-41ed-bc4f-1e383f8ddd01",
"type": "User"
}
}
},
"responses": {
"200": { }
}
}
admin/examples/domains/AssignDomainAdmins.json
+17
View File
@@ -0,0 +1,17 @@
{
"parameters": {
"domainId": "97dd1d38-a4c6-41ed-bc4f-1e383f8ddd0f",
"domainRoleAssignmentRequest": {
"type": "Admins",
"principals": [
{
"id": "796ce6ad-9163-4c16-9559-c68192a251de",
"type": "User"
}
]
}
},
"responses": {
"200": {}
}
}
admin/examples/domains/AssignDomainContributors.json
+17
View File
@@ -0,0 +1,17 @@
{
"parameters": {
"domainId": "97dd1d38-a4c6-41ed-bc4f-1e383f8ddd0f",
"domainRoleAssignmentRequest": {
"type": "Contributors",
"principals": [
{
"id": "796ce6ad-9163-4c16-9559-c68192a251de",
"type": "User"
}
]
}
},
"responses": {
"200": {}
}
}
admin/examples/domains/AssignDomainWorkspacesByCapacity.json
+19
View File
@@ -0,0 +1,19 @@
{
"parameters": {
"domainId": "97dd1d38-a4c6-41ed-bc4f-1e383f8ddd0f",
"assignDomainWorkspacesByCapacitiesRequest": {
"capacitiesIds": [
"796ce6ad-9163-4c16-9559-c68192a251de"
]
}
},
"responses": {
"202": {
"headers": {
"Location": "https://api.fabric.microsoft.com/operations/cfafbeb1-8037-4d0c-896e-a46fb27ff227",
"x-ms-operation-id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
"Retry-After": 30
}
}
}
}
admin/examples/domains/AssignDomainWorkspacesByIds.json
+15
View File
@@ -0,0 +1,15 @@
{
"parameters": {
"domainId": "97dd1d38-a4c6-41ed-bc4f-1e383f8ddd0f",
"assignDomainWorkspacesByIdsRequest": {
"workspacesIds": [
"e8de1852-7382-480a-8404-d5b1f5e1ab65",
"5348d3a9-c096-4074-9083-09e3ca69c8e5",
"ac561643-c5c5-4cf1-868e-8755a90e6fa3"
]
}
},
"responses": {
"200": {}
}
}
admin/examples/domains/AssignDomainWorkspacesByPrincipals.json
+22
View File
@@ -0,0 +1,22 @@
{
"parameters": {
"domainId": "97dd1d38-a4c6-41ed-bc4f-1e383f8ddd0f",
"assignDomainWorkspacesByPrincipalsRequest": {
"principals": [
{
"id": "796ce6ad-9163-4c16-9559-c68192a251de",
"type": "User"
}
]
}
},
"responses": {
"202": {
"headers": {
"Location": "https://api.fabric.microsoft.com/operations/cfafbeb1-8037-4d0c-896e-a46fb27ff227",
"x-ms-operation-id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
"Retry-After": 30
}
}
}
}
admin/examples/domains/AssignUnassignDomainAdmins.json
+17
View File
@@ -0,0 +1,17 @@
{
"parameters": {
"domainId": "97dd1d38-a4c6-41ed-bc4f-1e383f8ddd0f",
"updatePrincipalsRequest": {
"type": "Admins",
"principals": [
{
"id": "796ce6ad-9163-4c16-9559-c68192a251de",
"type": "User"
}
]
}
},
"responses": {
"200": {}
}
}
admin/examples/domains/AssignUnassignDomainContributors.json
+17
View File
@@ -0,0 +1,17 @@
{
"parameters": {
"domainId": "97dd1d38-a4c6-41ed-bc4f-1e383f8ddd0f",
"updatePrincipalsRequest": {
"type": "Contributors",
"principals": [
{
"id": "796ce6ad-9163-4c16-9559-c68192a251de",
"type": "User"
}
]
}
},
"responses": {
"200": {}
}
}
admin/examples/domains/AssignUnassignDomainWorkspacesByIds.json
+15
View File
@@ -0,0 +1,15 @@
{
"parameters": {
"domainId": "97dd1d38-a4c6-41ed-bc4f-1e383f8ddd0f",
"domainWorkspacesByIdsRequest": {
"workspacesIds": [
"e8de1852-7382-480a-8404-d5b1f5e1ab65",
"5348d3a9-c096-4074-9083-09e3ca69c8e5",
"ac561643-c5c5-4cf1-868e-8755a90e6fa3"
]
}
},
"responses": {
"200": {}
}
}
admin/examples/domains/CreateDomain.json
+20
View File
@@ -0,0 +1,20 @@
{
"parameters": {
"createDomainRequest": {
"displayName": "Finance",
"description": "This domain is used for identifying financial data and reports.",
"parentDomainId": "5f6552c3-816c-43e7-8289-842f8b35f9df"
}
},
"responses": {
"201": {
"body": {
"id": "9eba6944-daff-4441-b9b5-630ce34238fd",
"displayName": "Finance",
"description": "This domain is used for identifying financial data and reports.",
"parentDomainId": "5f6552c3-816c-43e7-8289-842f8b35f9df",
"contributorsScope": "AllTenant"
}
}
}
}
admin/examples/domains/DeleteDomain.json
+8
View File
@@ -0,0 +1,8 @@
{
"parameters": {
"domainId": "97dd1d38-a4c6-41ed-bc4f-1e383f8ddd0f"
},
"responses": {
"200": {}
}
}
admin/examples/domains/GetDomainById.json
+16
View File
@@ -0,0 +1,16 @@
{
"parameters": {
"domainId": "f2f6a374-789e-4d1d-9cc7-6e0b934fc529"
},
"responses": {
"200": {
"body": {
"id": "f2f6a374-789e-4d1d-9cc7-6e0b934fc529",
"displayName": "Finance",
"description": "This domain is used for identifying financial data and reports.",
"parentDomainId": null,
"contributorsScope": "SpecificUsersAndGroups"
}
}
}
}
admin/examples/domains/ListDomainWorkspaces.json
+27
View File
@@ -0,0 +1,27 @@
{
"parameters": {
"domainId": "97dd1d38-a4c6-41ed-bc4f-1e383f8ddd0f"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "e281785b-5608-41ac-a1a1-78b48b95b825",
"displayName": "Mark8ProjectTeam"
},
{
"id": "24402490-9519-48b9-9d51-b2db4095a56b",
"displayName": "Team southern region"
},
{
"id": "46f8ccd7-a209-4e12-978f-56ef3c44a68c",
"displayName": "SalesAndMarketing"
}
],
"continuationToken": null,
"continuationUri": null
}
}
}
}
admin/examples/domains/ListDomains.json
+59
View File
@@ -0,0 +1,59 @@
{
"parameters": {},
"responses": {
"200": {
"body": {
"domains": [
{
"id": "bc23d4c6-cc92-4eb6-bcb5-0ff98429bbff",
"displayName": "Finance",
"description": "This domain is used for identifying financial data and reports.",
"parentDomainId": null,
"contributorsScope": "AdminsOnly"
},
{
"id": "b0bca781-003c-4041-b1c4-f94d34ba76d4",
"displayName": "Human resources",
"description": null,
"parentDomainId": null,
"contributorsScope": "AllTenant"
},
{
"id": "6af5a1b6-bc4c-4c0a-b60d-30c68e6e3034",
"displayName": "HR Sales",
"description": null,
"parentDomainId": "bc23d4c6-cc92-4eb6-bcb5-0ff98429bbff",
"contributorsScope": "AllTenant"
},
{
"id": "6c00e8eb-51d4-46f7-8b90-7e98520ea7a0",
"displayName": "Marketing",
"parentDomainId": null,
"contributorsScope": "SpecificUsersAndGroups"
},
{
"id": "17df435d-9efd-48c1-a937-7d6fd70ab26a",
"displayName": "AdminsOnly",
"description": "Admins only",
"parentDomainId": "f2f6a374-789e-4d1d-9cc7-6e0b934fc529",
"contributorsScope": "AllTenant"
},
{
"id": "fb765fe3-d404-4f24-9d67-5916449c4c50",
"displayName": "Root",
"description": null,
"parentDomainId": null,
"contributorsScope": "AllTenant"
},
{
"id": "bda31be4-7efe-4272-8b85-e1b2ff0f0592",
"displayName": "Legal",
"description": "This domain is used for identifying legal data and reports.",
"parentDomainId": null,
"contributorsScope": "AllTenant"
}
]
}
}
}
}
admin/examples/domains/ListNonEmptyDomains.json
+40
View File
@@ -0,0 +1,40 @@
{
"parameters": {
"nonEmptyOnly": true
},
"responses": {
"200": {
"body": {
"domains": [
{
"id": "bc23d4c6-cc92-4eb6-bcb5-0ff98429bbff",
"displayName": "Finance",
"description": "This domain is used for identifying financial data and reports.",
"parentDomainId": null,
"contributorsScope": "AdminsOnly"
},
{
"id": "b0bca781-003c-4041-b1c4-f94d34ba76d4",
"displayName": "Human resources",
"description": null,
"parentDomainId": null,
"contributorsScope": "AllTenant"
},
{
"id": "6af5a1b6-bc4c-4c0a-b60d-30c68e6e3034",
"displayName": "HR Sales",
"description": null,
"parentDomainId": "bc23d4c6-cc92-4eb6-bcb5-0ff98429bbff",
"contributorsScope": "AllTenant"
},
{
"id": "6c00e8eb-51d4-46f7-8b90-7e98520ea7a0",
"displayName": "Marketing",
"parentDomainId": null,
"contributorsScope": "SpecificUsersAndGroups"
}
]
}
}
}
}
admin/examples/domains/UnassignAllDomainWorkspaces.json
+8
View File
@@ -0,0 +1,8 @@
{
"parameters": {
"domainId": "97dd1d38-a4c6-41ed-bc4f-1e383f8ddd0f"
},
"responses": {
"200": {}
}
}
admin/examples/domains/UnassignDomainAdmins.json
+17
View File
@@ -0,0 +1,17 @@
{
"parameters": {
"domainId": "97dd1d38-a4c6-41ed-bc4f-1e383f8ddd0f",
"domainRoleUnassignmentRequest": {
"type": "Admins",
"principals": [
{
"id": "796ce6ad-9163-4c16-9559-c68192a251de",
"type": "User"
}
]
}
},
"responses": {
"200": {}
}
}
admin/examples/domains/UnassignDomainContributors.json
+17
View File
@@ -0,0 +1,17 @@
{
"parameters": {
"domainId": "97dd1d38-a4c6-41ed-bc4f-1e383f8ddd0f",
"domainRoleUnassignmentRequest": {
"type": "Contributors",
"principals": [
{
"id": "796ce6ad-9163-4c16-9559-c68192a251de",
"type": "User"
}
]
}
},
"responses": {
"200": {}
}
}
admin/examples/domains/UnassignDomainWorkspacesByIds.json
+15
View File
@@ -0,0 +1,15 @@
{
"parameters": {
"domainId": "97dd1d38-a4c6-41ed-bc4f-1e383f8ddd0f",
"unassignDomainWorkspacesByIdsRequest": {
"workspacesIds": [
"e8de1852-7382-480a-8404-d5b1f5e1ab65",
"5348d3a9-c096-4074-9083-09e3ca69c8e5",
"ac561643-c5c5-4cf1-868e-8755a90e6fa3"
]
}
},
"responses": {
"200": {}
}
}
admin/examples/domains/UpdateDomain.json
+21
View File
@@ -0,0 +1,21 @@
{
"parameters": {
"domainId": "97dd1d38-a4c6-41ed-bc4f-1e383f8ddd0f",
"updateDomainRequest": {
"displayName": "Domain's new name",
"description": "Domain's new description",
"contributorsScope": "SpecificUsersAndGroups"
}
},
"responses": {
"200": {
"body": {
"id": "f2f6a374-789e-4d1d-9cc7-6e0b934fc529",
"displayName": "Domain's new name",
"description": "Domain's new description",
"parentDomainId": null,
"contributorsScope": "SpecificUsersAndGroups"
}
}
}
}
admin/examples/externaldatasharing/ListExternalDataShares.json
+104
View File
@@ -0,0 +1,104 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"itemId": "5b218778-e7a5-4d73-8187-f10824047715"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "dccc162f-7a41-4720-83c3-5c7e81187959",
"paths": [
"Files/Sales/Contoso_Sales_2023"
],
"creatorPrincipal": {
"id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
"displayName": "Jacob Hancock",
"type": "User",
"userDetails": {
"userPrincipalName": "jacob@contoso.com"
}
},
"recipient": {
"userPrincipalName": "lisa@fabrikam.com"
},
"status": "Pending",
"expirationTimeUtc": "2024-12-13T00:00:00.000Z",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"itemId": "5b218778-e7a5-4d73-8187-f10824047715",
"invitationUrl": "https://app.fabric.microsoft.com/externaldatasharing/accept?si=VyT5NJ3%2bNkySqEmf368Pjw-dccc162f-7a41-4720-83c3-5c7e81187959"
},
{
"id": "96c21561-65b8-4b23-bb9a-ee8cef945c45",
"paths": [
"Files/Sales/Contoso_Sales_2023"
],
"creatorPrincipal": {
"id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
"displayName": "Jacob Hancock",
"type": "User",
"userDetails": {
"userPrincipalName": "jacob@contoso.com"
}
},
"recipient": {
"userPrincipalName": "lisa@fabrikam.com"
},
"status": "Active",
"expirationTimeUtc": "2024-08-31T00:00:00.000Z",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"itemId": "5b218778-e7a5-4d73-8187-f10824047715",
"invitationUrl": "https://app.fabric.microsoft.com/externaldatasharing/accept?si=VyT5NJ3%2bNkySqEmf368Pjw-96c21561-65b8-4b23-bb9a-ee8cef945c45",
"acceptedByTenantId": "c51dc03f-268a-4da0-a879-25f24947ab8b"
},
{
"id": "0f40aeca-8f78-4a6f-a552-e5c45faadc60",
"paths": [
"Files/Sales/Contoso_Sales_2023"
],
"creatorPrincipal": {
"id": "81fac5e1-2a81-421b-a168-110b1c72fa11",
"displayName": "Eric Solomon",
"type": "User",
"userDetails": {
"userPrincipalName": "eric@contoso.com"
}
},
"recipient": {
"userPrincipalName": "lisa@fabrikam.com"
},
"status": "InvitationExpired",
"expirationTimeUtc": "2024-01-01T00:00:00.000Z",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"itemId": "5b218778-e7a5-4d73-8187-f10824047715",
"invitationUrl": "https://app.fabric.microsoft.com/externaldatasharing/accept?si=VyT5NJ3%2bNkySqEmf368Pjw-0f40aeca-8f78-4a6f-a552-e5c45faadc60"
},
{
"id": "89e82a82-0140-4837-8eee-9c919e3e5952",
"paths": [
"Files/Sales/Contoso_Sales_2023"
],
"creatorPrincipal": {
"id": "81fac5e1-2a81-421b-a168-110b1c72fa11",
"displayName": "Eric Solomon",
"type": "User",
"userDetails": {
"userPrincipalName": "eric@contoso.com"
}
},
"recipient": {
"userPrincipalName": "lisa@fabrikam.com"
},
"status": "Revoked",
"expirationTimeUtc": "2024-12-01T00:00:00.000Z",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"itemId": "5b218778-e7a5-4d73-8187-f10824047715",
"invitationUrl": "https://app.fabric.microsoft.com/externaldatasharing/accept?si=VyT5NJ3%2bNkySqEmf368Pjw-89e82a82-0140-4837-8eee-9c919e3e5952",
"acceptedByTenantId": "c51dc03f-268a-4da0-a879-25f24947ab8b"
}
]
}
}
}
}
admin/examples/externaldatasharing/RevokeExternalDataShare.json
+10
View File
@@ -0,0 +1,10 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"itemId": "5b218778-e7a5-4d73-8187-f10824047715",
"externalDataShareId": "dccc162f-7a41-4720-83c3-5c7e81187959"
},
"responses": {
"200": {}
}
}
admin/examples/informationProtection/removeLabels.json
+61
View File
@@ -0,0 +1,61 @@
{
"parameters": {
"removeLabelsRequest": {
"items": [
{
"id": "fe472f5e-636e-4c10-a1c6-7e9edc0b542a",
"type": "Dashboard"
},
{
"id": "476fcafe-b514-495d-b13f-ca9a4f0b1d8b",
"type": "Dashboard"
},
{
"id": "fe472f5e-636e-4c10-a1c6-7e9edc0b542c",
"type": "Report"
},
{
"id": "fe472f5e-636e-4c10-a1c6-7e9edc0b542e",
"type": "SemanticModel"
},
{
"id": "476fcafe-b514-495d-b13f-ca9a4f0b1d8f",
"type": "Notebook"
}
]
}
},
"responses": {
"200": {
"body": {
"itemsChangeLabelStatus": [
{
"id": "fe472f5e-636e-4c10-a1c6-7e9edc0b542a",
"type": "Dashboard",
"status": "NotFound"
},
{
"id": "476fcafe-b514-495d-b13f-ca9a4f0b1d8b",
"type": "Dashboard",
"status": "Failed"
},
{
"id": "fe472f5e-636e-4c10-a1c6-7e9edc0b542c",
"type": "Report",
"status": "Succeeded"
},
{
"id": "fe472f5e-636e-4c10-a1c6-7e9edc0b542e",
"type": "SemanticModel",
"status": "InsufficientUsageRights"
},
{
"id": "476fcafe-b514-495d-b13f-ca9a4f0b1d8f",
"type": "Notebook",
"status": "FailedToGetUsageRights"
}
]
}
}
}
}
admin/examples/informationProtection/setLabels.json
+67
View File
@@ -0,0 +1,67 @@
{
"parameters": {
"setLabelsRequest": {
"items": [
{
"id": "fe472f5e-636e-4c10-a1c6-7e9edc0b542a",
"type": "Dashboard"
},
{
"id": "476fcafe-b514-495d-b13f-ca9a4f0b1d8b",
"type": "Dashboard"
},
{
"id": "fe472f5e-636e-4c10-a1c6-7e9edc0b542c",
"type": "Report"
},
{
"id": "fe472f5e-636e-4c10-a1c6-7e9edc0b542e",
"type": "SemanticModel"
},
{
"id": "476fcafe-b514-495d-b13f-ca9a4f0b1d8f",
"type": "Notebook"
}
],
"labelId": "fe472f5e-636e-4c10-a1c6-7e9edc0b542d",
"assignmentMethod": "Standard",
"delegatedPrincipal": {
"id": "796ce6ad-9163-4c16-9559-c68192a251de",
"type": "User"
}
}
},
"responses": {
"200": {
"body": {
"itemsChangeLabelStatus": [
{
"id": "fe472f5e-636e-4c10-a1c6-7e9edc0b542a",
"type": "Dashboard",
"status": "NotFound"
},
{
"id": "476fcafe-b514-495d-b13f-ca9a4f0b1d8b",
"type": "Dashboard",
"status": "Failed"
},
{
"id": "fe472f5e-636e-4c10-a1c6-7e9edc0b542c",
"type": "Report",
"status": "Succeeded"
},
{
"id": "fe472f5e-636e-4c10-a1c6-7e9edc0b542e",
"type": "SemanticModel",
"status": "InsufficientUsageRights"
},
{
"id": "476fcafe-b514-495d-b13f-ca9a4f0b1d8f",
"type": "Notebook",
"status": "FailedToGetUsageRights"
}
]
}
}
}
}
admin/examples/tenantSettings/DeleteCapacityTenantSettingOverride.json
+9
View File
@@ -0,0 +1,9 @@
{
"parameters": {
"capacityId": "f51b705f-a409-4d40-9197-c5d5f349e2ef",
"tenantSettingName": "TenantSettingForCapacityDelegatedSwitch"
},
"responses": {
"200": {}
}
}
admin/examples/tenantSettings/ListCapacityTenantSettingsOverrides.json
+48
View File
@@ -0,0 +1,48 @@
{
"parameters": {},
"responses": {
"200": {
"body": {
"value": [
{
"id": "f51b705f-a409-4d40-9197-c5d5f349e2ef",
"tenantSettings": [
{
"settingName": "TenantSettingForCapacityDelegatedSwitch",
"title": "Capacity delegation test settings",
"enabled": true,
"canSpecifySecurityGroups": true,
"enabledSecurityGroups": [
{
"graphId": "f51b705f-a409-4d40-9197-c5d5f349e2f0",
"name": "TestComputeCdsa"
},
{
"graphId": "1fecf19f-6e33-41b3-89fa-de8c821f3b79",
"name": "TestComputeGroup2"
},
{
"graphId": "64bc10f1-1f1b-4a7e-b7a0-c87d89cba2b4",
"name": "TestCertifiers"
}
],
"tenantSettingGroup": "Delegation testing",
"properties": [
{
"name": "testIntProp",
"value": "5",
"type": "Integer"
}
],
"delegateToWorkspace": false,
"delegatedFrom": "Tenant"
}
]
}
],
"continuationUri": "https://api.fabric.microsoft.com/v1/admin/capacities/delegatedTenantSettingOverrides?continuationToken=MSwxMDAwMCww",
"continuationToken": "MSwxMDAwMCww"
}
}
}
}
admin/examples/tenantSettings/ListCapacityTenantSettingsOverridesByCapacityId.json
+43
View File
@@ -0,0 +1,43 @@
{
"parameters": {
"capacityId": "f51b705f-a409-4d40-9197-c5d5f349e2ef"
},
"responses": {
"200": {
"body": {
"value": [
{
"settingName": "TenantSettingForCapacityDelegatedSwitch",
"title": "Capacity delegation test settings",
"enabled": true,
"canSpecifySecurityGroups": true,
"enabledSecurityGroups": [
{
"graphId": "f51b705f-a409-4d40-9197-c5d5f349e2f0",
"name": "TestComputeCdsa"
},
{
"graphId": "1fecf19f-6e33-41b3-89fa-de8c821f3b79",
"name": "TestComputeGroup2"
},
{
"graphId": "64bc10f1-1f1b-4a7e-b7a0-c87d89cba2b4",
"name": "TestCertifiers"
}
],
"tenantSettingGroup": "Delegation testing",
"properties": [
{
"name": "testIntProp",
"value": "5",
"type": "Integer"
}
],
"delegateToWorkspace": false,
"delegatedFrom": "Tenant"
}
]
}
}
}
}
admin/examples/tenantSettings/ListDomainTenantSettingsOverrides.json
+41
View File
@@ -0,0 +1,41 @@
{
"parameters": {},
"responses": {
"200": {
"body": {
"value": [
{
"id": "f51b705f-a409-4d40-9197-c5d5f349e2ef",
"tenantSettings": [
{
"settingName": "TenantSettingForDomainDelegatedSwitch",
"title": "Domain delegation test settings",
"enabled": true,
"canSpecifySecurityGroups": true,
"enabledSecurityGroups": [
{
"graphId": "f51b705f-a409-4d40-9197-c5d5f349e2f0",
"name": "Admin API SP Test"
},
{
"graphId": "1fecf19f-6e33-41b3-89fa-de8c821f3b79",
"name": "Admin API Testing"
},
{
"graphId": "64bc10f1-1f1b-4a7e-b7a0-c87d89cba2b4",
"name": "Admin Only"
}
],
"tenantSettingGroup": "Delegation testing",
"delegateToWorkspace": false,
"delegatedFrom": "Tenant"
}
]
}
],
"continuationUri": "https://api.fabric.microsoft.com/v1/admin/domains/delegatedTenantSettingOverrides?continuationToken=MSwxMDAwMCww",
"continuationToken": "MSwxMDAwMCww"
}
}
}
}
admin/examples/tenantSettings/ListTenantSettings.json
+46
View File
@@ -0,0 +1,46 @@
{
"parameters": {},
"responses": {
"200": {
"body": {
"value": [
{
"settingName": "AdminApisIncludeDetailedMetadata",
"title": "Enhance admin APIs responses with detailed metadata",
"enabled": true,
"canSpecifySecurityGroups": true,
"tenantSettingGroup": "AdminApiSettings"
},
{
"settingName": "DatamartTenant",
"title": "Create Datamarts (Preview)",
"enabled": true,
"canSpecifySecurityGroups": true,
"enabledSecurityGroups": [
{
"graphId": "f51b705f-a409-4d40-9197-c5d5f349e2f0",
"name": "TestComputeCdsa"
},
{
"graphId": "1fecf19f-6e33-41b3-89fa-de8c821f3b79",
"name": "TestComputeGroup2"
},
{
"graphId": "64bc10f1-1f1b-4a7e-b7a0-c87d89cba2b4",
"name": "TestCertifiers"
}
],
"tenantSettingGroup": "DatamartSettings"
},
{
"settingName": "CertifyDatasets",
"title": "Certification",
"enabled": true,
"canSpecifySecurityGroups": true,
"tenantSettingGroup": "ExportAndSharing"
}
]
}
}
}
}
admin/examples/tenantSettings/ListWorkspaceTenantSettingsOverrides.json
+40
View File
@@ -0,0 +1,40 @@
{
"parameters": {},
"responses": {
"200": {
"body": {
"value": [
{
"id": "f51b705f-a409-4d40-9197-c5d5f349e2ef",
"tenantSettings": [
{
"settingName": "TenantSettingForWorkspaceDelegatedSwitch",
"title": "Workspace delegation test settings",
"enabled": true,
"canSpecifySecurityGroups": true,
"enabledSecurityGroups": [
{
"graphId": "f51b705f-a409-4d40-9197-c5d5f349e2f0",
"name": "Admin API SP Test"
},
{
"graphId": "1fecf19f-6e33-41b3-89fa-de8c821f3b79",
"name": "Admin API Testing"
},
{
"graphId": "64bc10f1-1f1b-4a7e-b7a0-c87d89cba2b4",
"name": "Admin Only"
}
],
"tenantSettingGroup": "Delegation testing",
"delegatedFrom": "Tenant"
}
]
}
],
"continuationUri": "https://api.fabric.microsoft.com/v1/admin/workspaces/delegatedTenantSettingOverrides?continuationToken=MSwxMDAwMCww",
"continuationToken": "MSwxMDAwMCww"
}
}
}
}
admin/examples/tenantSettings/UpdateCapacityTenantSettingOverride.json
+46
View File
@@ -0,0 +1,46 @@
{
"parameters": {
"capacityId": "f51b705f-a409-4d40-9197-c5d5f349e2ef",
"tenantSettingName": "AdminApisIncludeDetailedMetadata",
"updateTenantSettingOverrideRequest":{
"enabled": true,
"enabledSecurityGroups": [
{
"graphId": "f51b705f-a409-4d40-9197-c5d5f349e2f0",
"name": "TestComputeCdsa"
}
],
"delegateToWorkspace": true
}
},
"responses": {
"200": {
"body": {
"overrides": [
{
"settingName": "TenantSettingForCapacityDelegatedSwitch",
"title": "Capacity delegation test settings",
"enabled": true,
"canSpecifySecurityGroups": true,
"enabledSecurityGroups": [
{
"graphId": "f51b705f-a409-4d40-9197-c5d5f349e2f0",
"name": "TestComputeCdsa"
}
],
"tenantSettingGroup": "Delegation testing",
"properties": [
{
"name": "testIntProp",
"value": "5",
"type": "Integer"
}
],
"delegateToWorkspace": true,
"delegatedFrom": "Tenant"
}
]
}
}
}
}
admin/examples/tenantSettings/UpdateTenantSetting.json
+49
View File
@@ -0,0 +1,49 @@
{
"parameters": {
"tenantSettingName": "PublishToWeb",
"updateTenantSettingRequest": {
"enabled": true,
"enabledSecurityGroups": [
{
"graphId": "f51b705f-a409-4d40-9197-c5d5f349e2f0",
"name": "TestComputeCdsa"
}
],
"properties": [
{
"name": "CreateP2w",
"value": "true",
"type": "Boolean"
}
]
}
},
"responses": {
"200": {
"body": {
"tenantSettings": [
{
"settingName": "PublishToWeb",
"title": "Sample test tenant setting",
"enabled": true,
"canSpecifySecurityGroups": true,
"enabledSecurityGroups": [
{
"graphId": "f51b705f-a409-4d40-9197-c5d5f349e2f0",
"name": "TestComputeCdsa"
}
],
"properties": [
{
"name": "CreateP2w",
"value": "true",
"type": "Boolean"
}
],
"tenantSettingGroup": "TestSetting"
}
]
}
}
}
}
admin/swagger.json
+1742
View File
File diff suppressed because it is too large. Load diff
common/definitions.json
+702
View File
@@ -0,0 +1,702 @@
{
"swagger": "2.0",
"info": {
"version": "v1",
"title": "Common data types"
},
"paths": {},
"definitions": {
"ErrorResponse": {
"description": "The error response.",
"required": ["message", "errorCode"],
"allOf": [
{
"$ref": "#/definitions/ErrorResponseDetails"
}
],
"properties": {
"requestId": {
"type": "string",
"description": "ID of the request associated with the error.",
"readOnly": true
},
"moreDetails": {
"description": "List of additional error details.",
"type": "array",
"items": {
"$ref": "#/definitions/ErrorResponseDetails"
},
"readOnly": true
}
},
"readOnly": true
},
"ErrorResponseDetails": {
"description": "The error response details.",
"required": ["message", "errorCode"],
"properties": {
"errorCode": {
"type": "string",
"description": "A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.",
"readOnly": true
},
"message": {
"type": "string",
"description": "A human readable representation of the error.",
"readOnly": true
},
"relatedResource": {
"description": "The error related resource details.",
"$ref": "#/definitions/ErrorRelatedResource",
"readOnly": true
}
}
},
"ErrorRelatedResource": {
"description": "The error related resource details object.",
"required": ["resourceId", "resourceType"],
"properties": {
"resourceId": {
"type": "string",
"description": "The resource ID that's involved in the error.",
"readOnly": true
},
"resourceType": {
"type": "string",
"description": "The type of the resource that's involved in the error.",
"readOnly": true
}
},
"readOnly": true
},
"Principal": {
"description": "Represents an identity or a Microsoft Entra group.",
"type": "object",
"required": ["id", "type"],
"properties": {
"id": {
"description": "The principal's ID.",
"type": "string",
"format": "uuid",
"readOnly": false
},
"displayName": {
"description": "The principal's display name.",
"type": "string",
"readOnly": true
},
"type":{
"description": "The type of the principal. Additional principal types may be added over time.",
"type": "string",
"enum": ["User", "ServicePrincipal", "Group", "ServicePrincipalProfile"],
"x-ms-enum": {
"name": "PrincipalType",
"modelAsString": true,
"values": [
{
"value": "User",
"description": "Principal is a Microsoft Entra user principal."
},
{
"value": "ServicePrincipal",
"description": "Principal is a Microsoft Entra service principal."
},
{
"value": "Group",
"description": "Principal is a security group."
},
{
"value": "ServicePrincipalProfile",
"description": "Principal is a service principal profile."
}
]
},
"readOnly": false
},
"userDetails":{
"description": "User principal specific details. Applicable when the principal type is `User`.",
"type": "object",
"properties": {
"userPrincipalName": {
"description": "The user principal name.",
"type": "string",
"readOnly": true
}
},
"readOnly": true
},
"servicePrincipalDetails":{
"description": "Service principal specific details. Applicable when the principal type is `ServicePrincipal`.",
"type": "object",
"properties": {
"aadAppId": {
"description": "The service principal's Microsoft Entra AppId.",
"type": "string",
"format": "uuid",
"readOnly": true
}
},
"readOnly": true
},
"groupDetails":{
"description": "Group specific details. Applicable when the principal type is `Group`.",
"type": "object",
"properties": {
"groupType":{
"description": "The type of the group. Additional group types may be added over time.",
"type": "string",
"enum": ["Unknown", "SecurityGroup", "DistributionList"],
"x-ms-enum": {
"name": "GroupType",
"modelAsString": true,
"values": [
{
"value": "Unknown",
"description": "Principal group type is unknown."
},
{
"value": "SecurityGroup",
"description": "Principal is a security group."
},
{
"value": "DistributionList",
"description": "Principal is a distribution list."
}
]
},
"readOnly": false
}
},
"readOnly": false
},
"servicePrincipalProfileDetails":{
"description": "Service principal profile details. Applicable when the principal type is `ServicePrincipalProfile`.",
"type": "object",
"properties": {
"parentPrincipal": {
"description": "The service principal profile's parent principal.",
"$ref": "#/definitions/Principal",
"readOnly": false,
"type": "object"
}
},
"readOnly": false
}
},
"readOnly": false
},
"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" ],
"x-ms-enum": {
"name": "ItemType",
"modelAsString": true,
"values": [
{
"value": "Dashboard",
"description": "PowerBI dashboard."
},
{
"value": "Report",
"description": "PowerBI report."
},
{
"value": "SemanticModel",
"description": "PowerBI semantic model."
},
{
"value": "PaginatedReport",
"description": "PowerBI paginated report."
},
{
"value": "Datamart",
"description": "PowerBI datamart."
},
{
"value": "Lakehouse",
"description": "A lakehouse."
},
{
"value": "Eventhouse",
"description": "An eventhouse."
},
{
"value": "Environment",
"description": "An environment."
},
{
"value": "KQLDatabase",
"description": "A KQL database."
},
{
"value": "KQLQueryset",
"description": "A KQL queryset."
},
{
"value": "KQLDashboard",
"description": "A KQL dashboard."
},
{
"value": "DataPipeline",
"description": "A data pipeline."
},
{
"value": "Notebook",
"description": "A notebook."
},
{
"value": "SparkJobDefinition",
"description": "A spark job definition."
},
{
"value": "MLExperiment",
"description": "A machine learning experiment."
},
{
"value": "MLModel",
"description": "A machine learning model."
},
{
"value": "Warehouse",
"description": "A warehouse."
},
{
"value": "Eventstream",
"description": "An eventstream."
},
{
"value": "SQLEndpoint",
"description": "An SQL endpoint."
},
{
"value": "MirroredWarehouse",
"description": "A mirrored warehouse."
},
{
"value": "MirroredDatabase",
"description": "A mirrored database."
},
{
"value": "Reflex",
"description": "A Reflex."
},
{
"value": "GraphQLApi",
"description": "An API for GraphQL item."
},
{
"value": "MountedDataFactory",
"description": "A MountedDataFactory."
},
{
"value": "SQLDatabase",
"description": "A SQLDatabase."
},
{
"value": "CopyJob",
"description": "A Copy job."
}
]
},
"readOnly": false
},
"WorkspaceRole": {
"type": "string",
"description": "A Workspace role. Additional workspace roles may be added over time.",
"enum": ["Admin", "Member", "Contributor", "Viewer"],
"x-ms-enum": {
"name": "WorkspaceRole",
"modelAsString": true,
"values": [
{
"value": "Admin",
"description": "Enables administrative access to the workspace."
},
{
"value": "Member",
"description": "Enables membership access to the workspace."
},
{
"value": "Contributor",
"description": "Enables contribution to the workspace."
},
{
"value": "Viewer",
"description": "Enables viewing of the workspace."
}
]
}
},
"WorkspaceType": {
"type": "string",
"description": "A workspace type. Additional workspace types may be added over time.",
"enum": ["Personal", "Workspace", "AdminWorkspace"],
"x-ms-enum": {
"name": "WorkspaceType",
"modelAsString": true,
"values": [
{
"value": "Personal",
"description": "My folder or My workspace used to manage user items."
},
{
"value": "Workspace",
"description": "Workspace used to manage the Fabric items."
},
{
"value": "AdminWorkspace",
"description": "Admin monitoring workspace. Contains admin reports such as the audit report and the usage and adoption report."
}
]
},
"readOnly": true
},
"ItemPermissions": {
"type": "string",
"description": "Item permissions. Additional item permissions may be added over time.",
"enum": ["Read", "Write", "Reshare", "Explore", "Execute"],
"x-ms-enum": {
"name": "ItemPermissions",
"modelAsString": true,
"values": [
{
"value": "Read",
"description": "User can read the metadata about an item."
},
{
"value": "Write",
"description": "User can perform write operations on an item."
},
{
"value": "Reshare",
"description": "User can share an item with other users."
},
{
"value": "Explore",
"description": "User can build items on other items."
},
{
"value": "Execute",
"description": "User can execute and cancel item jobs."
}
]
}
},
"PayloadType": {
"description": "The type of the definition part payload. Additional payload types may be added over time.",
"type": "string",
"enum": ["InlineBase64"],
"x-ms-enum": {
"name": "PayloadType",
"modelAsString": true,
"values": [
{
"value": "InlineBase64",
"description": "Inline Base 64."
}
]
},
"readOnly": false
},
"PaginatedResponse": {
"properties": {
"continuationToken": {
"type": "string",
"description": "The token for the next result set batch. If there are no more records, it's removed from the response."
},
"continuationUri": {
"type": "string",
"description": "The URI of the next result set batch. If there are no more records, it's removed from the response."
}
}
},
"Item": {
"description": "An item object.",
"type": "object",
"required": ["type"],
"properties": {
"id": {
"description": "The item ID.",
"type": "string",
"format": "uuid",
"readOnly": true
},
"displayName": {
"description": "The item display name.",
"type": "string",
"readOnly": false
},
"description": {
"description": "The item description.",
"type": "string",
"readOnly": false
},
"type": {
"description": "The item type.",
"$ref": "#/definitions/ItemType",
"readOnly": false
},
"workspaceId": {
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"readOnly": true
},
"folderId": {
"description": "The folder ID.",
"type": "string",
"format": "uuid",
"readOnly": true
}
}
},
"Folder": {
"description": "A folder object.",
"type": "object",
"properties": {
"id": {
"description": "The folder ID.",
"type": "string",
"format": "uuid",
"readOnly": true
},
"displayName": {
"description": "The folder display name.",
"type": "string",
"readOnly": true
},
"workspaceId": {
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"readOnly": true
},
"parentFolderId": {
"description": "The parent folder ID. If the parent folder is a workspace, `parentFolderId` is either not specified or null.",
"type": "string",
"format": "uuid",
"readOnly": true
}
}
},
"GitProviderType": {
"type": "string",
"description": "A Git provider type. Additional provider types may be added over time.",
"enum": ["AzureDevOps", "GitHub"],
"x-ms-enum": {
"name": "GitProviderType",
"modelAsString": true,
"values": [
{
"value": "AzureDevOps",
"description": "Azure DevOps provider"
},
{
"value": "GitHub",
"description": "GitHub provider"
}
]
}
},
"GitProviderDetails": {
"type": "object",
"description": "The Git provider details.",
"discriminator": "gitProviderType",
"required": ["gitProviderType", "repositoryName", "branchName", "directoryName"],
"properties": {
"gitProviderType": {
"$ref": "#/definitions/GitProviderType"
},
"repositoryName": {
"type": "string",
"maxLength": 128,
"description": "The repository name. Maximum length is 128 characters."
},
"branchName": {
"type": "string",
"maxLength": 250,
"description": "The branch name. Maximum length is 250 characters."
},
"directoryName": {
"type": "string",
"maxLength": 256,
"description": "The relative path to the directory. Maximum length is 256 characters."
}
}
},
"AzureDevOpsDetails": {
"type": "object",
"description": "Azure DevOps provider details.",
"required": ["organizationName", "projectName"],
"properties": {
"organizationName": {
"type": "string",
"maxLength": 100,
"description": "The organization name. Maximum length is 100 characters."
},
"projectName": {
"type": "string",
"maxLength": 100,
"description": "The project name. Maximum length is 100 characters."
}
},
"allOf": [
{
"$ref": "#/definitions/GitProviderDetails"
}
],
"x-ms-discriminator-value": "AzureDevOps"
},
"GitHubDetails": {
"type": "object",
"description": "GitHub provider details.",
"required": ["ownerName"],
"properties": {
"ownerName": {
"type": "string",
"maxLength": 100,
"description": "The owner name. Maximum length is 100 characters."
}
},
"allOf": [
{
"$ref": "#/definitions/GitProviderDetails"
}
],
"x-ms-discriminator-value": "GitHub"
},
"AzureResource": {
"description": "The properties of an Azure resource",
"type": "object",
"required": ["subscriptionId", "resourceGroupName"],
"properties": {
"subscriptionId": {
"description": "The subscription ID",
"type": "string",
"format": "uuid"
},
"resourceGroupName": {
"description": "The name of the resource group",
"type": "string"
}
}
},
"VirtualNetworkAzureResource": {
"description": "The properties of a Virtual Network Azure resource",
"type": "object",
"required": ["virtualNetworkName", "subnetName"],
"properties": {
"virtualNetworkName": {
"description": "The name of the virtual network",
"type": "string"
},
"subnetName": {
"description": "The name of the subnet",
"type": "string"
}
},
"allOf": [
{
"$ref": "#/definitions/AzureResource"
}
]
},
"ItemReference": {
"description": "An item reference object.",
"type": "object",
"required": ["referenceType"],
"discriminator": "referenceType",
"properties": {
"referenceType": {
"description": "The item reference type.",
"$ref": "#/definitions/ItemReferenceType"
}
}
},
"ItemReferenceType": {
"type": "string",
"description": "The Item reference type. Additional `ItemReferenceType` types may be added over time.",
"enum": ["WithWorkspaceById"],
"x-ms-enum": {
"name": "ItemReferenceType",
"modelAsString": true,
"values": [
{
"value": "WithWorkspaceById",
"description": "The item is referenced by its ID with the ID of the item's workspace."
}
]
}
},
"ItemReferenceWithWorkspaceById": {
"description": "The item is referenced by its ID with the ID of the item's workspace.",
"type": "object",
"required": [
"itemId",
"workspaceId"
],
"properties": {
"itemId": {
"description": "The ID of the item.",
"type": "string",
"format": "uuid"
},
"workspaceId": {
"description": "The workspace ID of the item.",
"type": "string",
"format": "uuid"
}
},
"allOf": [
{
"$ref": "#/definitions/ItemReference"
}
],
"x-ms-discriminator-value": "WithWorkspaceById"
},
"Duration": {
"description": "A duration.",
"type": "object",
"required": [
"value",
"timeUnit"
],
"properties": {
"value": {
"type": "number",
"description": "The number of timeUnits in the duration."
},
"timeUnit": {
"type": "string",
"description": "The unit of time for the duration. Additional duration types may be added over time.",
"enum": ["Seconds", "Minutes", "Hours", "Days"],
"x-ms-enum": {
"name": "TimeUnit",
"modelAsString": true,
"values": [
{
"value": "Seconds",
"description": "Duration in seconds."
},
{
"value": "Minutes",
"description": "Duration in minutes."
},
{
"value": "Hours",
"description": "Duration in hours."
},
{
"value": "Days",
"description": "Duration in days."
}
]
}
}
}
}
}
}
copyJob/definitions.json
+135
View File
@@ -0,0 +1,135 @@
{
"swagger": "2.0",
"info": {
"title": "CopyJob data types",
"version": "v1"
},
"paths": {},
"definitions": {
"CopyJob": {
"description": "A CopyJob object.",
"type": "object",
"required": [ "type" ],
"allOf": [
{
"$ref": "../common/definitions.json#/definitions/Item"
}
]
},
"CopyJobs": {
"description": "A list of CopyJobs.",
"required": [ "value" ],
"type": "object",
"properties": {
"value": {
"description": "A list of CopyJobs.",
"type": "array",
"items": {
"$ref": "#/definitions/CopyJob"
}
}
},
"allOf": [
{
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
}
]
},
"CreateCopyJobRequest": {
"description": "Create CopyJob request payload.",
"required": [ "displayName" ],
"properties": {
"displayName": {
"description": "The CopyJob display name. The display name must follow naming rules according to item type.",
"type": "string",
"readOnly": false
},
"description": {
"description": "The CopyJob description. Maximum length is 256 characters.",
"type": "string",
"readOnly": false
},
"definition": {
"description": "The CopyJob public definition.",
"$ref": "#/definitions/CopyJobDefinition",
"readOnly": false
}
}
},
"UpdateCopyJobDefinitionRequest": {
"description": "Update CopyJob public definition request payload.",
"required": [ "definition" ],
"properties": {
"definition": {
"$ref": "#/definitions/CopyJobDefinition"
}
}
},
"CopyJobDefinitionResponse": {
"description": "CopyJob public definition response.",
"required": [ "definition" ],
"properties": {
"definition": {
"$ref": "#/definitions/CopyJobDefinition",
"readOnly": true
}
}
},
"CopyJobDefinition": {
"description": "CopyJob public definition object. Refer to [Copy job definition](/rest/api/fabric/articles/item-management/definitions/copyjob-definition) for more details on how to craft a CopyJob public definition.",
"type": "object",
"required": [ "parts" ],
"properties": {
"format": {
"description": "The format of the item definition.",
"type": "string",
"readOnly": false
},
"parts": {
"description": "A list of definition parts.",
"type": "array",
"items": {
"$ref": "#/definitions/CopyJobDefinitionPart"
},
"readOnly": false
}
}
},
"CopyJobDefinitionPart": {
"description": "CopyJob definition part object.",
"type": "object",
"properties": {
"path": {
"description": "The CopyJob public definition part path.",
"type": "string",
"readOnly": false
},
"payload": {
"description": "The CopyJob public definition part payload.",
"type": "string",
"readOnly": false
},
"payloadType": {
"description": "The payload type.",
"$ref": "../common/definitions.json#/definitions/PayloadType",
"readOnly": false
}
}
},
"UpdateCopyJobRequest": {
"description": "Update CopyJob request.",
"properties": {
"displayName": {
"description": "The CopyJob display name. The display name must follow naming rules according to item type.",
"type": "string",
"readOnly": false
},
"description": {
"description": "The CopyJob description. Maximum length is 256 characters.",
"type": "string",
"readOnly": false
}
}
}
}
}
copyJob/examples/CreateCopyJob.json
+41
View File
@@ -0,0 +1,41 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"createCopyJobRequest": {
"displayName": "CopyJob 1",
"description": "A Copy job description.",
"definition": {
"parts": [
{
"path": "copyjob-content.json",
"payload": "ewogICJwcm9wZXJ0aWVzIjogewogICAgImpvYk1vZGUiOiAiQmF0Y2giCiAgfSwKICAiYWN0aXZpdGllcyI6IFtdCn0=",
"payloadType": "InlineBase64"
},
{
"path": ".platform",
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
"payloadType": "InlineBase64"
}
]
}
}
},
"responses": {
"201": {
"body": {
"displayName": "CopyJob 1",
"description": "A Copy job description.",
"type": "CopyJob",
"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
}
}
}
}
copyJob/examples/CreateCopyJobWithoutDefinition.json
+27
View File
@@ -0,0 +1,27 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"createCopyJobRequest": {
"displayName": "CopyJob 1",
"description": "A Copy job description."
}
},
"responses": {
"201": {
"body": {
"displayName": "CopyJob 1",
"description": "A Copy job description.",
"type": "CopyJob",
"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
}
}
}
}
copyJob/examples/DeleteCopyJob.json
+9
View File
@@ -0,0 +1,9 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"copyJobId": "5b218778-e7a5-4d73-8187-f10824047715"
},
"responses": {
"200": {}
}
}
copyJob/examples/GetCopyJob.json
+17
View File
@@ -0,0 +1,17 @@
{
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"copyJobId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
},
"responses": {
"200": {
"body": {
"id": "5b218778-e7a5-4d73-8187-f10824047715",
"displayName": "CopyJob 1",
"description": "A Copy job description.",
"type": "CopyJob",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
}
}
}
}
copyJob/examples/GetCopyJobDefinition.json
+33
View File
@@ -0,0 +1,33 @@
{
"parameters": {
"workspaceId": "6e335e92-a2a2-4b5a-970a-bd6a89fbb765",
"copyJobId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
},
"responses": {
"200": {
"body": {
"definition": {
"parts": [
{
"path": "copyjob-content.json",
"payload": "ewogICJwcm9wZXJ0aWVzIjogewogICAgImpvYk1vZGUiOiAiQmF0Y2giCiAgfSwKICAiYWN0aXZpdGllcyI6IFtdCn0=",
"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
}
}
}
}
copyJob/examples/ListCopyJobsInWorkspace.json
+27
View File
@@ -0,0 +1,27 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "3546052c-ae64-4526-b1a8-52af7761426f",
"displayName": "CopyJob Name 1",
"description": "A Copy job description.",
"type": "CopyJob",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
},
{
"id": "f697fb63-abd4-4399-9548-be7e3c3c0dac",
"displayName": "CopyJob Name 2",
"description": "A Copy job description.",
"type": "CopyJob",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
}
]
}
}
}
}
copyJob/examples/UpdateCopyJob.json
+21
View File
@@ -0,0 +1,21 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"copyJobId": "5b218778-e7a5-4d73-8187-f10824047715",
"updateCopyJobRequest": {
"displayName": "CopyJob's New name",
"description": "CopyJob's New description"
}
},
"responses": {
"200": {
"body": {
"displayName": "CopyJob's New name",
"description": "CopyJob's New description",
"type": "CopyJob",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"id": "5b218778-e7a5-4d73-8187-f10824047715"
}
}
}
}
copyJob/examples/UpdateCopyJobDefinition.json
+34
View File
@@ -0,0 +1,34 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"copyJobId": "5b218778-e7a5-4d73-8187-f10824047715",
"updateMetadata" : true,
"updateCopyJobDefinitionRequest": {
"definition": {
"parts": [
{
"path": "copyjob-content.json",
"payload": "ewogICJwcm9wZXJ0aWVzIjogewogICAgImpvYk1vZGUiOiAiQ0RDIgogIH0sCiAgImFjdGl2aXRpZXMiOiBbXQp9",
"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
}
}
}
}
copyJob/swagger.json
+456
View File
@@ -0,0 +1,456 @@
{
"swagger": "2.0",
"info": {
"title": "CopyJob REST APIs",
"version": "v1"
},
"schemes": [
"https"
],
"host": "api.fabric.microsoft.com",
"basePath": "/v1",
"paths": {
"/workspaces/{workspaceId}/copyJobs": {
"get": {
"summary": "Returns a list of CopyJobs from the specified workspace.",
"description": "This API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\n The caller must have *viewer* or higher workspace role. \n\n## Required Delegated Scopes\n\nWorkspace.Read.All or Workspace.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"tags": [
"Items"
],
"operationId": "Items_ListCopyJobs",
"x-ms-pageable": {
"nextLinkName": "continuationUri"
},
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "query",
"name": "continuationToken",
"description": "A token for retrieving the next page of results.",
"type": "string",
"required": false
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions.json#/definitions/CopyJobs"
}
},
"default": {
"description": "Common error codes:\n\n* InvalidItemType - Invalid item type.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List CopyJobs in workspace example": {
"$ref": "./examples/ListCopyJobsInWorkspace.json"
}
}
},
"post": {
"summary": "Creates a CopyJob in the specified workspace.",
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n To create CopyJob with a public definition, refer to [CopyJob](/rest/api/fabric/articles/item-management/definitions/CopyJob). \n\n ## Permissions \n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes\n\n CopyJob.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations \n- To create a CopyJob 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_CreateCopyJob",
"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": "createCopyJobRequest",
"description": "Create item request payload.",
"schema": {
"$ref": "./definitions.json#/definitions/CreateCopyJobRequest"
},
"required": true
}
],
"responses": {
"201": {
"description": "Successfully created",
"schema": {
"$ref": "./definitions.json#/definitions/CopyJob"
}
},
"202": {
"description": "Request accepted, CopyJob 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."
}
}
},
"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.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Create a CopyJob example": {
"$ref": "./examples/CreateCopyJobWithoutDefinition.json"
},
"Create a CopyJob with public definition example": {
"$ref": "./examples/CreateCopyJob.json"
}
}
}
},
"/workspaces/{workspaceId}/copyJobs/{copyJobId}": {
"get": {
"summary": "Returns properties of the specified CopyJob.",
"description": "## Permissions\n\n The caller must have *viewer* or higher workspace role. \n\n## Required Delegated Scopes\n\n CopyJob.Read.All or CopyJob.ReadWrite.All or Item.Read.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"tags": [
"Items"
],
"operationId": "Items_GetCopyJob",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "copyJobId",
"description": "The CopyJob ID.",
"type": "string",
"format": "uuid",
"required": true
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions.json#/definitions/CopyJob"
}
},
"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 CopyJob example": {
"$ref": "./examples/GetCopyJob.json"
}
}
},
"patch": {
"summary": "Updates the properties of the specified CopyJob.",
"description": "## Permissions\n\n The caller must have *contributor* or higher workspace role.\n\n## Required Delegated Scopes\n\n CopyJob.ReadWrite.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"tags": [
"Items"
],
"operationId": "Items_UpdateCopyJob",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "copyJobId",
"description": "The CopyJob ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "body",
"name": "updateCopyJobRequest",
"description": "Update CopyJob request payload.",
"schema": {
"$ref": "./definitions.json#/definitions/UpdateCopyJobRequest"
},
"required": true
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions.json#/definitions/CopyJob"
}
},
"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 CopyJob example": {
"$ref": "./examples/UpdateCopyJob.json"
}
}
},
"delete": {
"summary": "Deletes the specified CopyJob.",
"description": "## Permissions\n\n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes\n\n CopyJob.ReadWrite.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"tags": [
"Items"
],
"operationId": "Items_DeleteCopyJob",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "copyJobId",
"description": "The CopyJob ID.",
"type": "string",
"format": "uuid",
"required": true
}
],
"responses": {
"200": {
"description": "Request completed successfully."
},
"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 CopyJob example": {
"$ref": "./examples/DeleteCopyJob.json"
}
}
}
},
"/workspaces/{workspaceId}/copyJobs/{copyJobId}/getDefinition": {
"post": {
"summary": "Returns the specified CopyJob public definition.",
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a CopyJob's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *contributor* or higher workspace role. \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_GetCopyJobDefinition",
"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": "copyJobId",
"description": "The CopyJob ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "query",
"name": "format",
"description": "The format of the CopyJob public definition.",
"type": "string",
"required": false
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions.json#/definitions/CopyJobDefinitionResponse"
}
},
"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."
}
}
},
"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 CopyJob public definition example": {
"$ref": "./examples/GetCopyJobDefinition.json"
}
}
}
},
"/workspaces/{workspaceId}/copyJobs/{copyJobId}/updateDefinition": {
"post": {
"summary": "Overrides the definition for the specified CopyJob.",
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n \nUpdating the CopyJob's definition, does not affect its sensitivity label. \n\n## Permissions\n\n The API caller must have *contributor* or higher workspace role. \n## Required Delegated Scopes\n\n CopyJob.ReadWrite.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"tags": [
"Items"
],
"operationId": "Items_UpdateCopyJobDefinition",
"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": "copyJobId",
"description": "The CopyJob 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": "updateCopyJobDefinitionRequest",
"description": "Update CopyJob definition request payload.",
"schema": {
"$ref": "./definitions.json#/definitions/UpdateCopyJobDefinitionRequest"
},
"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."
}
}
},
"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 CopyJob public definition example": {
"$ref": "./examples/UpdateCopyJobDefinition.json"
}
}
}
}
},
"responses": {},
"security": [],
"tags": []
}
dashboard/definitions.json
+135
View File
@@ -0,0 +1,135 @@
{
"swagger": "2.0",
"info": {
"version": "v1",
"title": "Dashboard data types"
},
"paths": {},
"definitions": {
"Dashboards": {
"description": "A list of dashboards.",
"required": ["value"],
"type": "object",
"properties": {
"value": {
"description": "A list of dashboards.",
"type": "array",
"items": {
"$ref": "#/definitions/Dashboard"
}
}
},
"allOf": [
{
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
}
]
},
"Dashboard": {
"description": "A dashboard object.",
"type": "object",
"required": ["type"],
"allOf": [
{
"$ref": "../common/definitions.json#/definitions/Item"
}
]
},
"CreateDashboardRequest": {
"description": "Create dashboard request payload.",
"required": ["displayName"],
"properties": {
"displayName": {
"description": "The dashboard display name. The display name must follow naming rules according to item type.",
"type": "string",
"readOnly": false
},
"description": {
"description": "The dashboard description. Maximum length is 256 characters.",
"type": "string",
"readOnly": false
},
"definition": {
"description": "The dashboard public definition.",
"$ref": "#/definitions/DashboardDefinition",
"readOnly": false
}
}
},
"UpdateDashboardDefinitionRequest": {
"description": "Update dashboard public definition request payload.",
"required": ["definition"],
"properties": {
"definition": {
"$ref": "#/definitions/DashboardDefinition"
}
}
},
"DashboardDefinitionResponse": {
"description": "Dashboard public definition response.",
"required": ["definition"],
"properties": {
"definition": {
"$ref": "#/definitions/DashboardDefinition",
"readOnly": true
}
}
},
"DashboardDefinition" : {
"description": "Dashboard public definition object.",
"type": "object",
"required": ["parts"],
"properties": {
"format": {
"description": "The format of the item definition.",
"type": "string",
"readOnly": false
},
"parts": {
"description": "A list of definition parts.",
"type": "array",
"items": {
"$ref": "#/definitions/DashboardDefinitionPart"
},
"readOnly": false
}
}
},
"DashboardDefinitionPart": {
"description": "Dashboard definition part object.",
"type": "object",
"properties": {
"path": {
"description": "The dashboard part path.",
"type": "string",
"readOnly": false
},
"payload": {
"description": "The dashboard part payload.",
"type": "string",
"readOnly": false
},
"payloadType":{
"description": "The payload type.",
"$ref": "../common/definitions.json#/definitions/PayloadType",
"readOnly": false
}
}
},
"UpdateDashboardRequest": {
"description": "Update dashboard request.",
"properties": {
"displayName": {
"description": "The dashboard display name. The display name must follow naming rules according to item type.",
"type": "string",
"readOnly": false
},
"description": {
"description": "The dashboard description. Maximum length is 256 characters.",
"type": "string",
"readOnly": false
}
}
}
}
}
dashboard/examples/ListDashboardsInWorkspace.json
+20
View File
@@ -0,0 +1,20 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "3546052c-ae64-4526-b1a8-52af7761426f",
"displayName": "Dashboard Name 1",
"description": "A dashboard description.",
"type": "Dashboard",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
}
]
}
}
}
}
dashboard/swagger.json
+69
View File
@@ -0,0 +1,69 @@
{
"swagger": "2.0",
"info": {
"title": "Dashboard REST APIs",
"version": "v1"
},
"schemes": [
"https"
],
"host": "api.fabric.microsoft.com",
"basePath": "/v1",
"paths": {
"/workspaces/{workspaceId}/dashboards": {
"get": {
"summary": "Returns a list of dashboards from the specified workspace.",
"description": "This API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\n The caller must have *viewer* or higher workspace role. \n\n## Required Delegated Scopes\n\nWorkspace.Read.All or Workspace.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
"tags": [
"Items"
],
"operationId": "Items_ListDashboards",
"x-ms-pageable": {
"nextLinkName": "continuationUri"
},
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "query",
"name": "continuationToken",
"description": "A token for retrieving the next page of results.",
"type": "string",
"required": false
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions.json#/definitions/Dashboards"
}
},
"default": {
"description": "Common error codes:\n\n* InvalidItemType - Invalid item type",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List dashboards in workspace example": {
"$ref": "./examples/ListDashboardsInWorkspace.json"
}
}
}
}
},
"responses": {},
"security": [],
"tags": []
}
dataPipeline/definitions.json
+135
View File
@@ -0,0 +1,135 @@
{
"swagger": "2.0",
"info": {
"version": "v1",
"title": "DataPipeline data types"
},
"paths": {},
"definitions": {
"DataPipelines": {
"description": "A list of data pipelines.",
"required": ["value"],
"type": "object",
"properties": {
"value": {
"description": "A list of data pipelines.",
"type": "array",
"items": {
"$ref": "#/definitions/DataPipeline"
}
}
},
"allOf": [
{
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
}
]
},
"DataPipeline": {
"description": "A data pipeline object.",
"type": "object",
"required": ["type"],
"allOf": [
{
"$ref": "../common/definitions.json#/definitions/Item"
}
]
},
"CreateDataPipelineRequest": {
"description": "Create data pipeline request payload.",
"required": ["displayName"],
"properties": {
"displayName": {
"description": "The data pipeline display name.",
"type": "string",
"readOnly": false
},
"description": {
"description": "The data pipeline description. Maximum length is 256 characters.",
"type": "string",
"readOnly": false
},
"definition": {
"description": "The data pipeline public definition.",
"$ref": "#/definitions/DataPipelineDefinition",
"readOnly": false
}
}
},
"UpdateDataPipelineDefinitionRequest": {
"description": "Update data pipeline public definition request payload.",
"required": ["definition"],
"properties": {
"definition": {
"$ref": "#/definitions/DataPipelineDefinition"
}
}
},
"DataPipelineDefinitionResponse": {
"description": "Data pipeline public definition response.",
"required": ["definition"],
"properties": {
"definition": {
"$ref": "#/definitions/DataPipelineDefinition",
"readOnly": true
}
}
},
"DataPipelineDefinition" : {
"description": "Data pipeline public definition object.",
"type": "object",
"required": ["parts"],
"properties": {
"format": {
"description": "The format of the item definition.",
"type": "string",
"readOnly": false
},
"parts": {
"description": "A list of definition parts.",
"type": "array",
"items": {
"$ref": "#/definitions/DataPipelineDefinitionPart"
},
"readOnly": false
}
}
},
"DataPipelineDefinitionPart": {
"description": "Data pipeline definition part object.",
"type": "object",
"properties": {
"path": {
"description": "The data pipeline part path.",
"type": "string",
"readOnly": false
},
"payload": {
"description": "The data pipeline part payload.",
"type": "string",
"readOnly": false
},
"payloadType":{
"description": "The payload type.",
"$ref": "../common/definitions.json#/definitions/PayloadType",
"readOnly": false
}
}
},
"UpdateDataPipelineRequest": {
"description": "Update data pipeline request.",
"properties": {
"displayName": {
"description": "The data pipeline display name. The display name must follow naming rules according to item type.",
"type": "string",
"readOnly": false
},
"description": {
"description": "The data pipeline description. Maximum length is 256 characters.",
"type": "string",
"readOnly": false
}
}
}
}
}
dataPipeline/examples/CreateDataPipeline.json
+41
View File
@@ -0,0 +1,41 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"createDataPipelineRequest": {
"displayName": "DataPipeline 1",
"description": "A data pipeline description",
"definition": {
"parts": [
{
"path": "pipeline-content.json",
"payload": "ewogICAgInByb3BlcnRpZXMiOiB7IAogICAgICAgICJkZXNjcmlwdGlvbiI6ICJEYXRhIHBpcGVsaW5lIGRlc2NyaXB0aW9uIiwgCiAgICAgICAgImFjdGl2aXRpZXMiOiBbIAogICAgICAgICAgICB7IAogICAgICAgICAgICAgICAgIm5hbWUiOiAiV2FpdF9BY3Rpdml0eV8xIiwgCiAgICAgICAgICAgICAgICAidHlwZSI6ICJXYWl0IiwgCiAgICAgICAgICAgICAgICAiZGVwZW5kc09uIjogW10sIAogICAgICAgICAgICAgICAgInR5cGVQcm9wZXJ0aWVzIjogeyAKICAgICAgICAgICAgICAgICAgICAid2FpdFRpbWVJblNlY29uZHMiOiAyNDAgCiAgICAgICAgICAgICAgICB9IAogICAgICAgICAgICB9LAogICAgICAgICAgICB7CiAgICAgICAgICAgICAgICAibmFtZSI6ICJXYWl0X0FjdGl2aXR5XzIiLAogICAgICAgICAgICAgICAgInR5cGUiOiAiV2FpdCIsCiAgICAgICAgICAgICAgICAiZGVwZW5kc09uIjogWwogICAgICAgICAgICAgICAgICAgIHsKICAgICAgICAgICAgICAgICAgICAgICAgImFjdGl2aXR5IjogIldhaXRfQWN0aXZpdHlfMSIsCiAgICAgICAgICAgICAgICAgICAgICAgICJkZXBlbmRlbmN5Q29uZGl0aW9ucyI6IFsgIlN1Y2NlZWRlZCIgXQogICAgICAgICAgICAgICAgICAgIH0KICAgICAgICAgICAgICAgIF0sCiAgICAgICAgICAgICAgICAidHlwZVByb3BlcnRpZXMiOiB7CiAgICAgICAgICAgICAgICAgICAgIndhaXRUaW1lSW5TZWNvbmRzIjogMjQwCiAgICAgICAgICAgICAgICB9CiAgICAgICAgICAgIH0KICAgICAgICBdCiAgICB9IAp9IA==",
"payloadType": "InlineBase64"
},
{
"path": ".platform",
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
"payloadType": "InlineBase64"
}
]
}
}
},
"responses": {
"201": {
"body": {
"displayName": "DataPipeline 1",
"description": "A data pipeline description",
"type": "DataPipeline",
"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
}
}
}
}
dataPipeline/examples/CreateDataPipelineWithoutDefinition.json
+27
View File
@@ -0,0 +1,27 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"createDataPipelineRequest": {
"displayName": "DataPipeline 1",
"description": "A data pipeline description"
}
},
"responses": {
"201": {
"body": {
"displayName": "DataPipeline 1",
"description": "A data pipeline description",
"type": "DataPipeline",
"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
}
}
}
}
dataPipeline/examples/DeleteDataPipeline.json
+9
View File
@@ -0,0 +1,9 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"dataPipelineId": "5b218778-e7a5-4d73-8187-f10824047715"
},
"responses": {
"200": {}
}
}
dataPipeline/examples/GetDataPipeline.json
+17
View File
@@ -0,0 +1,17 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"dataPipelineId": "5b218778-e7a5-4d73-8187-f10824047715"
},
"responses": {
"200": {
"body": {
"displayName": "DataPipeline 1",
"description": "A data pipeline description.",
"type": "DataPipeline",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"id": "5b218778-e7a5-4d73-8187-f10824047715"
}
}
}
}
dataPipeline/examples/GetDataPipelineDefinition.json
+33
View File
@@ -0,0 +1,33 @@
{
"parameters": {
"workspaceId": "6e335e92-a2a2-4b5a-970a-bd6a89fbb765",
"dataPipelineId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
},
"responses": {
"200": {
"body": {
"definition": {
"parts": [
{
"path": "pipeline-content.json",
"payload": "ewogICJwcm9wZXJ0aWVzIjogewogICAgImFjdGl2aXRpZXMiOiBbXQogIH0KfQ==",
"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
}
}
}
}
dataPipeline/examples/ListDataPipelinesInWorkspace.json
+20
View File
@@ -0,0 +1,20 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "3546052c-ae64-4526-b1a8-52af7761426f",
"displayName": "DataPipeline Name 1",
"description": "A data pipeline description.",
"type": "DataPipeline",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
}
]
}
}
}
}
dataPipeline/examples/UpdateDataPipeline.json
+21
View File
@@ -0,0 +1,21 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"dataPipelineId": "5b218778-e7a5-4d73-8187-f10824047715",
"updateDataPipelineRequest": {
"displayName": "A new name for the DataPipeline",
"description": "A new description for the data pipeline."
}
},
"responses": {
"200": {
"body": {
"displayName": "A new name for the DataPipeline",
"description": "A new description for the data pipeline.",
"type": "DataPipeline",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"id": "5b218778-e7a5-4d73-8187-f10824047715"
}
}
}
}
dataPipeline/examples/UpdateDataPipelineDefinition.json
+34
View File
@@ -0,0 +1,34 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"dataPipelineId": "5b218778-e7a5-4d73-8187-f10824047715",
"updateMetadata": true,
"updatePipelineDefinitionRequest": {
"definition": {
"parts": [
{
"path": "pipeline-content.json",
"payload": "ewogICJwcm9wZXJ0aWVzIjogewogICAgImFjdGl2aXRpZXMiOiBbCiAgICAgIHsKICAgICAgICAibmFtZSI6ICJXYWl0MSIsCiAgICAgICAgInR5cGUiOiAiV2FpdCIsCiAgICAgICAgImRlcGVuZHNPbiI6IFtdLAogICAgICAgICJ0eXBlUHJvcGVydGllcyI6IHsKICAgICAgICAgICJ3YWl0VGltZUluU2Vjb25kcyI6IDEKICAgICAgICB9CiAgICAgIH0KICAgIF0KICB9Cn0=",
"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
}
}
}
}
dataPipeline/swagger.json
+456
View File
@@ -0,0 +1,456 @@
{
"swagger": "2.0",
"info": {
"title": "DataPipeline REST APIs",
"version": "v1"
},
"schemes": [
"https"
],
"host": "api.fabric.microsoft.com",
"basePath": "/v1",
"paths": {
"/workspaces/{workspaceId}/dataPipelines": {
"get": {
"summary": "Returns a list of data pipelines from the specified workspace.",
"description": "This API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\n The caller must have *viewer* or higher workspace role. \n\n## Required Delegated Scopes\n\nWorkspace.Read.All or Workspace.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"tags": [
"Items"
],
"operationId": "Items_ListDataPipelines",
"x-ms-pageable": {
"nextLinkName": "continuationUri"
},
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "query",
"name": "continuationToken",
"description": "A token for retrieving the next page of results.",
"type": "string",
"required": false
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions.json#/definitions/DataPipelines"
}
},
"default": {
"description": "Common error codes:\n\n* InvalidItemType - Invalid item type",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List data pipelines in workspace example": {
"$ref": "./examples/ListDataPipelinesInWorkspace.json"
}
}
},
"post": {
"summary": "Creates a data pipeline in the specified workspace.",
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n ## Permissions \n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes\n\n DataPipeline.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations \n- To create a data pipeline, the workspace must be on a supported Fabric capacity.\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_CreateDataPipeline",
"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": "createDataPipelineRequest",
"description": "Create item request payload.",
"schema": {
"$ref": "./definitions.json#/definitions/CreateDataPipelineRequest"
},
"required": true
}
],
"responses": {
"201": {
"description": "Successfully created",
"schema": {
"$ref": "./definitions.json#/definitions/DataPipeline"
}
},
"202": {
"description": "Request accepted, data pipeline provisioning in progress",
"headers": {
"Location": {
"description": "The URL of the operation status, used to track the operation state.",
"type": "string"
},
"x-ms-operation-id": {
"description": "The operation ID, 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."
}
}
},
"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 data pipeline example": {
"$ref": "./examples/CreateDataPipelineWithoutDefinition.json"
},
"Create data pipeline with item definition example": {
"$ref": "./examples/CreateDataPipeline.json"
}
}
}
},
"/workspaces/{workspaceId}/dataPipelines/{dataPipelineId}": {
"get": {
"summary": "Returns properties of the specified data pipeline.",
"description": "## Permissions\n\n The caller must have *viewer* or higher workspace role. \n\n## Required Delegated Scopes\n\n DataPipeline.Read.All or DataPipeline.ReadWrite.All or Item.Read.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"tags": [
"Items"
],
"operationId": "Items_GetDataPipeline",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "dataPipelineId",
"description": "The data pipeline ID.",
"type": "string",
"format": "uuid",
"required": true
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions.json#/definitions/DataPipeline"
}
},
"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 data pipeline example": {
"$ref": "./examples/GetDataPipeline.json"
}
}
},
"patch": {
"summary": "Updates the properties of the specified data pipeline.",
"description": "## Permissions\n\n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes\n\n DataPipeline.ReadWrite.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"tags": [
"Items"
],
"operationId": "Items_UpdateDataPipeline",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "dataPipelineId",
"description": "The data pipeline ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "body",
"name": "updateDataPipelineRequest",
"description": "Update data pipeline request payload.",
"schema": {
"$ref": "./definitions.json#/definitions/UpdateDataPipelineRequest"
},
"required": true
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions.json#/definitions/DataPipeline"
}
},
"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 data pipeline example": {
"$ref": "./examples/UpdateDataPipeline.json"
}
}
},
"delete": {
"summary": "Deletes the specified data pipeline.",
"description": "## Permissions\n\n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes\n\n DataPipeline.ReadWrite.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"tags": [
"Items"
],
"operationId": "Items_DeleteDataPipeline",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "dataPipelineId",
"description": "The data pipeline ID.",
"type": "string",
"format": "uuid",
"required": true
}
],
"responses": {
"200": {
"description": "Request completed successfully."
},
"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 data pipeline example": {
"$ref": "./examples/DeleteDataPipeline.json"
}
}
}
},
"/workspaces/{workspaceId}/dataPipelines/{dataPipelineId}/getDefinition": {
"post": {
"summary": "Returns the specified data pipeline public definition.",
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a DataPipeline's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *contributor* or higher workspace role.\n## Required Delegated Scopes\n\n DataPipeline.ReadWrite.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"tags": [
"Items"
],
"operationId": "Items_GetDataPipelineDefinition",
"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": "dataPipelineId",
"description": "The data pipeline ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "query",
"name": "format",
"description": "The format of the data pipeline public definition.",
"type": "string",
"required": false
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions.json#/definitions/DataPipelineDefinitionResponse"
}
},
"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."
}
}
},
"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 data pipeline public definition example": {
"$ref": "./examples/GetDataPipelineDefinition.json"
}
}
}
},
"/workspaces/{workspaceId}/dataPipelines/{dataPipelineId}/updateDefinition": {
"post": {
"summary": "Overrides the definition for the specified data pipeline.",
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n \nUpdating the DataPipeline's definition, does not affect its sensitivity label. \n\n## Permissions\n\n The API caller must have *contributor* or higher workspace role.\n## Required Delegated Scopes\n\n DataPipeline.ReadWrite.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"tags": [
"Items"
],
"operationId": "Items_UpdateDataPipelineDefinition",
"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": "dataPipelineId",
"description": "The data pipeline 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": "updatePipelineDefinitionRequest",
"description": "Update data pipeline definition request payload.",
"schema": {
"$ref": "./definitions.json#/definitions/UpdateDataPipelineDefinitionRequest"
},
"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."
}
}
},
"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 data pipeline public definition example": {
"$ref": "./examples/UpdateDataPipelineDefinition.json"
}
}
}
}
},
"responses": {},
"security": [],
"tags": []
}
datamart/definitions.json
+39
View File
@@ -0,0 +1,39 @@
{
"swagger": "2.0",
"info": {
"version": "v1",
"title": "Datamart data types"
},
"paths": {},
"definitions": {
"Datamarts": {
"description": "A list of datamarts.",
"required": ["value"],
"type": "object",
"properties": {
"value": {
"description": "A list of datamarts.",
"type": "array",
"items": {
"$ref": "#/definitions/Datamart"
}
}
},
"allOf": [
{
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
}
]
},
"Datamart": {
"description": "A datamart object.",
"type": "object",
"required": ["type"],
"allOf": [
{
"$ref": "../common/definitions.json#/definitions/Item"
}
]
}
}
}
datamart/examples/ListDatamartsInWorkspace.json
+20
View File
@@ -0,0 +1,20 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "3546052c-ae64-4526-b1a8-52af7761426f",
"displayName": "Datamart Name 1",
"description": "A datamart description.",
"type": "Datamart",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
}
]
}
}
}
}
datamart/swagger.json
+69
View File
@@ -0,0 +1,69 @@
{
"swagger": "2.0",
"info": {
"title": "Datamart REST APIs",
"version": "v1"
},
"schemes": [
"https"
],
"host": "api.fabric.microsoft.com",
"basePath": "/v1",
"paths": {
"/workspaces/{workspaceId}/datamarts": {
"get": {
"summary": "Returns a list of datamarts from the specified workspace.",
"description": "This API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\n The caller must have *viewer* or higher workspace role. \n\n## Required Delegated Scopes\n\nWorkspace.Read.All or Workspace.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
"tags": [
"Items"
],
"operationId": "Items_ListDatamarts",
"x-ms-pageable": {
"nextLinkName": "continuationUri"
},
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "query",
"name": "continuationToken",
"description": "A token for retrieving the next page of results.",
"type": "string",
"required": false
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions.json#/definitions/Datamarts"
}
},
"default": {
"description": "Common error codes:\n\n* InvalidItemType - Invalid item type",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List datamarts in workspace example": {
"$ref": "./examples/ListDatamartsInWorkspace.json"
}
}
}
}
},
"responses": {},
"security": [],
"tags": []
}
environment/definitions.json
+440
View File
@@ -0,0 +1,440 @@
{
"swagger": "2.0",
"info": {
"title": "Environment data types",
"version": "v1"
},
"paths": {},
"definitions": {
"EnvironmentSparkCompute": {
"type": "object",
"properties": {
"instancePool": {
"description": "Environment pool has to be a valid custom pool. \"Starter Pool\" means use starter pool.",
"$ref": "#/definitions/InstancePool"
},
"driverCores": {
"description": "Spark driver core.",
"format": "int32",
"type": "integer"
},
"driverMemory": {
"description": "Spark driver memory.",
"type": "string"
},
"executorCores": {
"description": "Spark executor core.",
"format": "int32",
"type": "integer"
},
"executorMemory": {
"description": "Spark executor memory.",
"type": "string"
},
"dynamicExecutorAllocation": {
"description": "Dynamic executor allocation.",
"$ref": "#/definitions/DynamicExecutorAllocationProperties"
},
"sparkProperties": {
"type": "object",
"description": "Spark properties."
},
"runtimeVersion": {
"description": "Runtime version, find the supported [fabric runtimes](/fabric/data-engineering/runtime). For example: 1.3",
"type": "string"
}
}
},
"UpdateEnvironmentSparkComputeRequest": {
"type": "object",
"properties": {
"instancePool": {
"description": "Environment pool has to be a valid custom pool. The name for a default workspace pool is *Starter Pool*.",
"$ref": "#/definitions/InstancePool",
"type": "object"
},
"driverCores": {
"description": "Spark driver core.",
"format": "int32",
"type": "integer"
},
"driverMemory": {
"description": "Spark driver memory.",
"type": "string"
},
"executorCores": {
"description": "Spark executor core.",
"format": "int32",
"type": "integer"
},
"executorMemory": {
"description": "Spark executor memory.",
"type": "string"
},
"dynamicExecutorAllocation": {
"description": "Dynamic executor allocation.",
"$ref": "#/definitions/DynamicExecutorAllocationProperties"
},
"sparkProperties": {
"type": "object",
"description": "Spark properties."
},
"runtimeVersion": {
"description": "Runtime version, find the supported [fabric runtimes](/fabric/data-engineering/runtime). For example: 1.3",
"type": "string"
}
}
},
"InstancePool": {
"required": [
"name",
"type"
],
"type": "object",
"description": "An instance of a pool.",
"properties": {
"id": {
"format": "uuid",
"description": "Instance pool ID.",
"type": "string"
},
"name": {
"description": "Instance pool name.",
"type": "string"
},
"type": {
"description": "Instance pool type.",
"$ref": "#/definitions/CustomPoolType"
}
}
},
"CustomPoolType": {
"type": "string",
"description": "Custom pool type. Additional `CustomPoolType` types may be added over time.",
"enum": ["Workspace", "Capacity"],
"x-ms-enum": {
"name": "CustomPoolType",
"modelAsString": true,
"values": [
{
"value": "Workspace",
"description": "Workspace custom pool"
},
{
"value": "Capacity",
"description": "Capacity custom pool"
}
]
}
},
"DynamicExecutorAllocationProperties": {
"description": "Dynamic executor allocation proerties.",
"required": [
"enabled",
"minExecutors",
"maxExecutors"
],
"type": "object",
"properties": {
"enabled": {
"description": "The status of the dynamic executor allocation. False - Disabled, true - Enabled.",
"type": "boolean"
},
"minExecutors": {
"description": "The minimum executor number for dynamic allocation and the minimum for this property is 1.",
"format": "int32",
"type": "integer",
"minimum": 1
},
"maxExecutors": {
"description": "The maximum executor number for dynamic allocation and the minimum for this property is 1",
"format": "int32",
"type": "integer",
"minimum": 1
}
}
},
"Environments": {
"description": "A list of environments.",
"required": ["value"],
"type": "object",
"properties": {
"value": {
"description": "A list of environments.",
"type": "array",
"items": {
"$ref": "#/definitions/Environment"
}
}
},
"allOf": [
{
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
}
]
},
"Environment": {
"description": "An Environment item.",
"type": "object",
"required": ["type"],
"allOf": [
{
"$ref": "../common/definitions.json#/definitions/Item"
}
],
"properties": {
"properties": {
"description": "The environment properties.",
"$ref": "#/definitions/EnvironmentPublishInfo"
}
}
},
"CreateEnvironmentRequest": {
"description": "Create environment request payload.",
"required": ["displayName"],
"properties": {
"displayName": {
"description": "The environment display name.",
"type": "string",
"readOnly": false
},
"description": {
"description": "The environment description. Maximum length is 256 characters.",
"type": "string",
"readOnly": false
}
}
},
"UpdateEnvironmentRequest": {
"description": "Update environment request.",
"properties": {
"displayName": {
"description": "The environment display name.",
"type": "string",
"readOnly": false
},
"description": {
"description": "The environment description. Maximum length is 256 characters.",
"type": "string",
"readOnly": false
}
}
},
"EnvironmentPublishInfo": {
"description": "Environment publish information.",
"type": "object",
"required": ["publishDetails"],
"properties": {
"publishDetails": {
"description": "Environment publish operation details.",
"$ref": "#/definitions/PublishDetails"
}
}
},
"PublishDetails": {
"description": "Details of publish operation.",
"type": "object",
"properties": {
"state": {
"description": "Publish state. Additional state types may be added over time.",
"type": "string",
"enum": ["Success", "Cancelled", "Failed", "Cancelling", "Running", "Waiting"],
"x-ms-enum": {
"name": "EnvironmentPublishState",
"modelAsString": true,
"values": [
{
"value": "Waiting",
"description": "Environment publish is in waiting state."
},
{
"value": "Running",
"description": "Environment publish is in running state."
},
{
"value": "Cancelling",
"description": "Environment publish is in cancelling state."
},
{
"value": "Cancelled",
"description": "Environment publish is in cancelled state."
},
{
"value": "Failed",
"description": "Environment publish is in failed state."
},
{
"value": "Success",
"description": "Environment publish is in success state."
}
]
}
},
"targetVersion": {
"description": "Target verion to be published.",
"format": "uuid",
"type": "string"
},
"startTime": {
"description": "Start time of publish operation.",
"format": "date-time",
"type": "string"
},
"endTime": {
"description": "End time of publish operation.",
"format": "date-time",
"type": "string"
},
"componentPublishInfo": {
"description": "Environment component publish information.",
"$ref": "#/definitions/ComponentPublishInfo"
}
}
},
"ComponentPublishInfo": {
"description": "Publish info for each components in environment.",
"type": "object",
"properties": {
"sparkLibraries": {
"description": "Spark libraries publish information.",
"$ref": "#/definitions/SparkLibraries"
},
"sparkSettings": {
"description": "Spark settings publish information.",
"$ref": "#/definitions/SparkSettings"
}
}
},
"SparkLibraries": {
"description": "Spark libraries.",
"type": "object",
"properties": {
"state": {
"description": "Publish state. Additional state types may be added over time.",
"type": "string",
"enum": ["Success", "Cancelled", "Failed", "Cancelling", "Running", "Waiting"],
"x-ms-enum": {
"name": "EnvironmentPublishState",
"modelAsString": true,
"values": [
{
"value": "Waiting",
"description": "Environment publish is in waiting state."
},
{
"value": "Running",
"description": "Environment publish is in running state."
},
{
"value": "Cancelling",
"description": "Environment publish is in cancelling state."
},
{
"value": "Cancelled",
"description": "Environment publish is in cancelled state."
},
{
"value": "Failed",
"description": "Environment publish is in failed state."
},
{
"value": "Success",
"description": "Environment publish is in success state."
}
]
}
}
}
},
"SparkSettings": {
"description": "Spark settings.",
"type": "object",
"properties": {
"state": {
"description": "Publish state. Additional state types may be added over time.",
"type": "string",
"enum": ["Success", "Cancelled", "Failed", "Cancelling", "Running", "Waiting"],
"x-ms-enum": {
"name": "EnvironmentPublishState",
"modelAsString": true,
"values": [
{
"value": "Waiting",
"description": "Environment publish is in waiting state."
},
{
"value": "Running",
"description": "Environment publish is in running state."
},
{
"value": "Cancelling",
"description": "Environment publish is in cancelling state."
},
{
"value": "Cancelled",
"description": "Environment publish is in cancelled state."
},
{
"value": "Failed",
"description": "Environment publish is in failed state."
},
{
"value": "Success",
"description": "Environment publish is in success state."
}
]
}
}
}
},
"EnvironmentLibraries": {
"description": "Environment libraries.",
"type": "object",
"properties": {
"customLibraries": {
"description": "Custom libraries (.py, .whl, .jar, .tar.gz).",
"$ref": "#/definitions/CustomLibraries"
},
"environmentYml": {
"description": "Feed libraries.",
"type": "string"
}
}
},
"CustomLibraries": {
"description": "Custom libraries.",
"type": "object",
"properties": {
"wheelFiles": {
"type": "array",
"description": "A list of Wheel files.",
"items": {
"type": "string"
}
},
"pyFiles": {
"type": "array",
"description": "A list of Python files.",
"items": {
"type": "string"
}
},
"jarFiles": {
"type": "array",
"description": "A list of Jar files.",
"items": {
"type": "string"
}
},
"rTarFiles": {
"type": "array",
"description": "A list of R files.",
"items": {
"type": "string"
}
}
}
}
}
}
environment/examples/CreateEnvironment.json
+27
View File
@@ -0,0 +1,27 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"createEnvironmentRequest": {
"displayName": "Environment_1",
"description": "An environment description"
}
},
"responses": {
"201": {
"body": {
"displayName": "Environment_1",
"description": "An environment description",
"type": "Environment",
"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
}
}
}
}
environment/examples/DeleteEnvironment.json
+9
View File
@@ -0,0 +1,9 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"environmentId": "5b218778-e7a5-4d73-8187-f10824047715"
},
"responses": {
"200": {}
}
}
environment/examples/DeleteStagingLibraries.json
+11
View File
@@ -0,0 +1,11 @@
{
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"environmentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
"libraryToDelete": "samplelibrary.jar"
},
"responses": {
"200": {
}
}
}
environment/examples/GetEnvironment.json
+33
View File
@@ -0,0 +1,33 @@
{
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"environmentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
},
"responses": {
"200": {
"body": {
"displayName": "Environment_1",
"description": "An Environment description",
"type": "Environment",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"id": "5b218778-e7a5-4d73-8187-f10824047715",
"properties": {
"publishDetails": {
"state": "Success",
"targetVersion": "46838a80-5450-4414-bea0-40fb6f3e0c0d",
"startTime": "2024-03-29T14:17:09.0697022Z",
"endTime": "2024-03-29T14:48:09.0697022Z",
"componentPublishInfo": {
"sparkLibraries": {
"state": "Success"
},
"sparkSettings": {
"state": "Success"
}
}
}
}
}
}
}
}
environment/examples/GetEnvironmentSparkCompute.json
+30
View File
@@ -0,0 +1,30 @@
{
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"environmentId": "707cfd07-cbf1-41da-aad7-dd157ddb8c11"
},
"responses": {
"200": {
"body": {
"instancePool": {
"name": "MyWorkspacePool",
"type": "Workspace",
"id": "78942136-106c-4f3e-80fc-7ff4eae11603"
},
"driverCores": 4,
"driverMemory": "56g",
"executorCores": 4,
"executorMemory": "56g",
"dynamicExecutorAllocation": {
"enabled": false,
"minExecutors": 1,
"maxExecutors": 1
},
"sparkProperties": {
"spark.acls.enable": "false"
},
"runtimeVersion": "1.2"
}
}
}
}
environment/examples/GetPublishedLibraries.json
+27
View File
@@ -0,0 +1,27 @@
{
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"environmentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
},
"responses": {
"200": {
"body": {
"customLibraries": {
"wheelFiles": [
"samplewheel-0.18.0-py2.py3-none-any.whl"
],
"pyFiles": [
"samplepython.py"
],
"jarFiles": [
"samplejar.jar"
],
"rTarFiles": [
"sampleR.tar.gz"
]
},
"environmentYml": "dependencies:\r\n- pip:\r\n - matplotlib==3.4.3"
}
}
}
}
environment/examples/GetStagingLibraries.json
+27
View File
@@ -0,0 +1,27 @@
{
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"environmentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
},
"responses": {
"200": {
"body": {
"customLibraries": {
"wheelFiles": [
"samplewheel-0.18.0-py2.py3-none-any.whl"
],
"pyFiles": [
"samplepython.py"
],
"jarFiles": [
"samplejar.jar"
],
"rTarFiles": [
"sampleR.tar.gz"
]
},
"environmentYml": "dependencies:\r\n- pip:\r\n - matplotlib==3.4.3"
}
}
}
}
environment/examples/ListEnvironmentsInWorkspace.json
+59
View File
@@ -0,0 +1,59 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "3546052c-ae64-4526-b1a8-52af7761426f",
"displayName": "Environment_1",
"description": "A environment description.",
"type": "Environment",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"properties": {
"publishDetails": {
"state": "Failed",
"targetVersion": "14ece8b5-68a1-4130-a9e7-074c04537588",
"startTime": "2024-03-30T14:17:09.0697022Z",
"endTime": "2024-03-30T14:48:09.0697022Z",
"componentPublishInfo": {
"sparkLibraries": {
"state": "Failed"
},
"sparkSettings": {
"state": "Success"
}
}
}
}
},
{
"id": "a8a1bffa-7eea-49dc-a1d2-6281c1d031f1",
"displayName": "Environment_2",
"description": "A environment description.",
"type": "Environment",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"properties": {
"publishDetails": {
"state": "Success",
"targetVersion": "46838a80-5450-4414-bea0-40fb6f3e0c0d",
"startTime": "2024-03-29T14:17:09.0697022Z",
"endTime": "2024-03-29T14:48:09.0697022Z",
"componentPublishInfo": {
"sparkLibraries": {
"state": "Success"
},
"sparkSettings": {
"state": "Success"
}
}
}
}
}
]
}
}
}
}
environment/examples/PublishCancellation.json
+26
View File
@@ -0,0 +1,26 @@
{
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"environmentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
},
"responses": {
"200": {
"body": {
"publishDetails": {
"state": "Cancelled",
"targetVersion": "d9d95b01-248f-4ef4-bd7e-9d3f1f6447be",
"startTime": "2024-03-29T15:00:33.4359355Z",
"endTime": "2024-03-29T15:00:47.1407904Z",
"componentPublishInfo": {
"sparkLibraries": {
"state": "Cancelled"
},
"sparkSettings": {
"state": "Cancelled"
}
}
}
}
}
}
}
environment/examples/PublishEnvironment.json
+25
View File
@@ -0,0 +1,25 @@
{
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"environmentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
},
"responses": {
"200": {
"body": {
"publishDetails": {
"state": "Running",
"targetVersion": "46838a80-5450-4414-bea0-40fb6f3e0c0d",
"startTime": "2024-03-29T14:17:09.0697022Z",
"componentPublishInfo": {
"sparkLibraries": {
"state": "Running"
},
"sparkSettings": {
"state": "Running"
}
}
}
}
}
}
}
environment/examples/UpdateEnvironment.json
+21
View File
@@ -0,0 +1,21 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"environmentId": "5b218778-e7a5-4d73-8187-f10824047715",
"updateEnvironmentRequest": {
"displayName": "Environment_New_Name",
"description": "A new description for environment."
}
},
"responses": {
"200": {
"body": {
"displayName": "Environment_New_Name",
"description": "A new description for environment.",
"type": "Environment",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"id": "5b218778-e7a5-4d73-8187-f10824047715"
}
}
}
}
environment/examples/UpdateEnvironmentSparkCompute.json
+51
View File
@@ -0,0 +1,51 @@
{
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"environmentId": "707cfd07-cbf1-41da-aad7-dd157ddb8c11",
"updateEnvironmentSparkComputeRequest": {
"instancePool": {
"name": "MyWorkspacePool",
"type": "Workspace"
},
"driverCores": 4,
"driverMemory": "56g",
"executorCores": 4,
"executorMemory": "56g",
"dynamicExecutorAllocation": {
"enabled": false,
"minExecutors": 1,
"maxExecutors": 1
},
"sparkProperties": {
"spark.acls.enable": "false",
"spark.admin.acls": null
},
"runtimeVersion": "1.2"
}
},
"responses": {
"200": {
"body": {
"instancePool": {
"name": "MyWorkspacePool",
"type": "Workspace",
"id": "78942136-106c-4f3e-80fc-7ff4eae11603"
},
"driverCores": 4,
"driverMemory": "56g",
"executorCores": 4,
"executorMemory": "56g",
"dynamicExecutorAllocation": {
"enabled": false,
"minExecutors": 1,
"maxExecutors": 1
},
"sparkProperties": {
"spark.acls.enable": "false"
},
"runtimeVersion": "1.2"
}
}
}
}
environment/examples/UploadStagingLibraries.json
+10
View File
@@ -0,0 +1,10 @@
{
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"environmentId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
},
"responses": {
"200": {
}
}
}
environment/swagger.json
+767
View File
@@ -0,0 +1,767 @@
{
"swagger": "2.0",
"info": {
"title": "Environment REST APIs",
"version": "v1"
},
"schemes": [
"https"
],
"host": "api.fabric.microsoft.com",
"basePath": "/v1",
"paths": {
"/workspaces/{workspaceId}/environments/{environmentId}/staging/sparkcompute": {
"get": {
"tags": [
"SparkCompute"
],
"summary": "> [!NOTE]\n> This API is in preview.\n\nGet environment staging spark compute.",
"description": "## Permissions\n\nRead permission to the environment item. \n\n## Required Delegated Scopes\n\nEnvironment.Read.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"operationId": "SparkCompute_GetStagingSettings",
"produces": [
"application/json"
],
"parameters": [
{
"name": "workspaceId",
"in": "path",
"description": "The workspace ID.",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "environmentId",
"in": "path",
"description": "The environment ID.",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions.json#/definitions/EnvironmentSparkCompute"
}
},
"default": {
"description": "Common error codes:\n\n* UnknownError - An error occurred.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get environment staging spark compute example": {
"$ref": "./examples/GetEnvironmentSparkCompute.json"
}
}
},
"patch": {
"tags": [
"SparkCompute"
],
"summary": "> [!NOTE]\n> This API is in preview.\n\nUpdate environment staging spark compute. If you want to delete a spark property, set its value as null.",
"description": "## Permissions\n\nWrite permission to the environment item. \n\n## Required Delegated Scopes\n\nEnvironment.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": "SparkCompute_UpdateStagingSettings",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "workspaceId",
"in": "path",
"description": "The workspace ID.",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "environmentId",
"in": "path",
"description": "The environment ID.",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "updateEnvironmentSparkComputeRequest",
"in": "body",
"description": "Update environment spark compute request payload.",
"required": true,
"schema": {
"$ref": "./definitions.json#/definitions/UpdateEnvironmentSparkComputeRequest"
}
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions.json#/definitions/EnvironmentSparkCompute"
}
},
"default": {
"description": "Common error codes:\n\n* UnknownError - An error occurred.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Update environment staging spark compute example": {
"$ref": "./examples/UpdateEnvironmentSparkCompute.json"
}
}
}
},
"/workspaces/{workspaceId}/environments/{environmentId}/sparkcompute": {
"get": {
"tags": [
"SparkCompute"
],
"summary": "> [!NOTE]\n> This API is in preview.\n\nGet environment spark compute.",
"description": "## Permissions\n\nRead permission to the environment item. \n\n## Required Delegated Scopes\n\nEnvironment.Read.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"operationId": "SparkCompute_GetPublishedSettings",
"produces": [
"application/json"
],
"parameters": [
{
"name": "workspaceId",
"in": "path",
"description": "The workspace ID.",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "environmentId",
"in": "path",
"description": "The environment ID.",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions.json#/definitions/EnvironmentSparkCompute"
}
},
"default": {
"description": "Common error codes:\n\n* UnknownError - An error occurred.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get environment Spark compute example": {
"$ref": "./examples/GetEnvironmentSparkCompute.json"
}
}
}
},
"/workspaces/{workspaceId}/environments": {
"get": {
"summary": "Returns a list of environments from the specified workspace.",
"description": "This API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\n The caller must have *viewer* or higher workspace role. \n\n## Required Delegated Scopes\n\nWorkspace.Read.All or Workspace.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"tags": [
"Items"
],
"operationId": "Items_ListEnvironments",
"x-ms-pageable": {
"nextLinkName": "continuationUri"
},
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "query",
"name": "continuationToken",
"description": "A token for retrieving the next page of results.",
"type": "string",
"required": false
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions.json#/definitions/Environments"
}
},
"default": {
"description": "Common error codes:\n\n* InvalidItemType - Invalid item type",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List environments in workspace example": {
"$ref": "./examples/ListEnvironmentsInWorkspace.json"
}
}
},
"post": {
"summary": "Creates an environment in the specified workspace.",
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n This API does not support create a environment with definition.\n\n ## Permissions \n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes\n\n Environment.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations \n- To create an environment, the workspace must be on a supported Fabric capacity.\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_CreateEnvironment",
"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": "createEnvironmentRequest",
"description": "Create item request payload.",
"schema": {
"$ref": "./definitions.json#/definitions/CreateEnvironmentRequest"
},
"required": true
}
],
"responses": {
"201": {
"description": "Successfully created",
"schema": {
"$ref": "./definitions.json#/definitions/Environment"
}
},
"202": {
"description": "Request accepted, environment 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."
}
}
},
"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 environment example": {
"$ref": "./examples/CreateEnvironment.json"
}
}
}
},
"/workspaces/{workspaceId}/environments/{environmentId}": {
"get": {
"summary": "Returns properties of the specified environment.",
"description": "## Required Delegated Scopes\n\nEnvironment.Read.All or Item.Read.All or Environment.ReadWrite.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"tags": [
"Items"
],
"operationId": "Items_GetEnvironment",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "environmentId",
"description": "The environment ID.",
"type": "string",
"format": "uuid",
"required": true
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions.json#/definitions/Environment"
}
},
"default": {
"description": "Common error codes:\n\n* UnknownError - An error occurred.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Environment Item example": {
"$ref": "./examples/GetEnvironment.json"
}
}
},
"patch": {
"summary": "Updates the properties of the specified environment.",
"description": "## Permissions\n\n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes\n\n Environment.ReadWrite.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"tags": [
"Items"
],
"operationId": "Items_UpdateEnvironment",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "environmentId",
"description": "The environment ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "body",
"name": "updateEnvironmentRequest",
"description": "Update environment request payload.",
"schema": {
"$ref": "./definitions.json#/definitions/UpdateEnvironmentRequest"
},
"required": true
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions.json#/definitions/Environment"
}
},
"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 environment example": {
"$ref": "./examples/UpdateEnvironment.json"
}
}
},
"delete": {
"summary": "Deletes the specified environment.",
"description": "## Permissions\n\n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes\n\n Environment.ReadWrite.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"tags": [
"Items"
],
"operationId": "Items_DeleteEnvironment",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "environmentId",
"description": "The environment ID.",
"type": "string",
"format": "uuid",
"required": true
}
],
"responses": {
"200": {
"description": "Request completed successfully."
},
"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 environment example": {
"$ref": "./examples/DeleteEnvironment.json"
}
}
}
},
"/workspaces/{workspaceId}/environments/{environmentId}/staging/libraries": {
"get": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nGet a list of libraries staged into environment.",
"description": "## Permissions\n\nRead permission for the environment item. \n\n## Required Delegated Scopes\n\nEnvironment.Read.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"tags": [
"SparkLibraries"
],
"operationId": "SparkLibraries_GetStagingLibraries",
"produces": [
"application/json"
],
"parameters": [
{
"name": "workspaceId",
"in": "path",
"description": "The workspace ID.",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "environmentId",
"in": "path",
"description": "The environment ID.",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions.json#/definitions/EnvironmentLibraries"
}
},
"default": {
"description": "Common error codes:\n\n* EnvironmentLibrariesNotFound - This environment does not have any published libraries.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get environment staging libraries example": {
"$ref": "./examples/GetStagingLibraries.json"
}
}
},
"post": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nUpload spark library into environment.",
"description": "This API allows one file upload at a time. The supported file formats are .jar, .py, .whl, .tar.gz, or environment.yml. \n\n## Limitations\n\nThe maximum request size allowed is 100MB.\n\nNetwork issues may impact the upload size and may result in timeouts.\n\n## Permissions\n\nWrite permission for the environment item. \n\n## Required Delegated Scopes\n\nEnvironment.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": [
"SparkLibraries"
],
"operationId": "SparkLibraries_UploadStagingLibrary",
"consumes": [
"multipart/form-data"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "workspaceId",
"in": "path",
"description": "The workspace ID.",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "environmentId",
"in": "path",
"description": "The environment ID.",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "Request completed successfully."
},
"default": {
"description": "Common error codes:\n\n* EnvironmentValidationFailed - Provide a library with a valid format such as .jar, .py, .whl, .tar.gz, or environment.yml.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Upload environment staging libraries example": {
"$ref": "./examples/UploadStagingLibraries.json"
}
}
},
"delete": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nDeletes a library from environment. It supports deleting one file at a time.",
"description": "## Permissions\n\nWrite permission for the environment item. \n\n## Required Delegated Scopes\n\nEnvironment.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": [
"SparkLibraries"
],
"produces": [
"application/json"
],
"operationId": "SparkLibraries_DeleteStagingLibrary",
"parameters": [
{
"name": "workspaceId",
"in": "path",
"description": "The workspace ID.",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "environmentId",
"in": "path",
"description": "The environment ID.",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "libraryToDelete",
"in": "query",
"description": "The library file to be deleted. The library name needs to include its extension, for example samplefile.jar.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Request completed successfully."
},
"default": {
"description": "Common error codes:\n\n* EnvironmentValidationFailed - Provide a library name with a valid format such as .jar, .py, .whl, .tar.gz, or environment.yml.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete environment staging libraries example": {
"$ref": "./examples/DeleteStagingLibraries.json"
}
}
}
},
"/workspaces/{workspaceId}/environments/{environmentId}/libraries": {
"get": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nGet environment published libraries.",
"description": "## Permissions\n\nRead permission for the environment item. \n\n## Required Delegated Scopes\n\nEnvironment.Read.All or Environment.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"tags": [
"SparkLibraries"
],
"operationId": "SparkLibraries_GetPublishedLibraries",
"produces": [
"application/json"
],
"parameters": [
{
"name": "workspaceId",
"in": "path",
"description": "The workspace ID.",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "environmentId",
"in": "path",
"description": "The environment ID.",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions.json#/definitions/EnvironmentLibraries"
}
},
"default": {
"description": "Common error codes:\n\n* EnvironmentLibrariesNotFound - This environment does not have any staged libraries.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get environment published libraries example": {
"$ref": "./examples/GetPublishedLibraries.json"
}
}
}
},
"/workspaces/{workspaceId}/environments/{environmentId}/staging/publish": {
"post": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nTrigger an environment publish operation.",
"description": "## Permissions\n\nWrite permission for the environment item. \n\n## Required Delegated Scopes\n\nEnvironment.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": [
"SparkLibraries"
],
"operationId": "SparkLibraries_PublishEnvironment",
"produces": [
"application/json"
],
"parameters": [
{
"name": "workspaceId",
"in": "path",
"description": "The workspace ID.",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "environmentId",
"in": "path",
"description": "The environment ID.",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "Publish operation request has been submitted successfully.",
"schema": {
"$ref": "./definitions.json#/definitions/EnvironmentPublishInfo"
}
},
"202": {
"description": "> [!NOTE]\n> This code is not available.\n\nRequest accepted, publish operation is in progress.",
"headers": {
"Location": {
"description": "The URL to check the status of the publish operation.",
"type": "string"
},
"Retry-After": {
"type": "integer"
}
}
},
"default": {
"description": "Common error codes:\n\n* InvalidEnvironmentPublish - Environment publish operation for version <*GUID* of the failed publish operation> failed due to error: Code = EnvironmentAnotherOngoingPublishProcess.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Publish environment example": {
"$ref": "./examples/PublishEnvironment.json"
}
}
}
},
"/workspaces/{workspaceId}/environments/{environmentId}/staging/cancelPublish": {
"post": {
"summary": "> [!NOTE]\n> This API is in preview.\n\nTrigger an environment publish cancellation.",
"description": "## Permissions\n\nWrite permission for the environment item. \n\n## Required Delegated Scopes\n\nEnvironment.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": [
"SparkLibraries"
],
"operationId": "SparkLibraries_CancelPublish",
"produces": [
"application/json"
],
"parameters": [
{
"name": "workspaceId",
"in": "path",
"description": "The workspace ID.",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "environmentId",
"in": "path",
"description": "The environment ID.",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions.json#/definitions/EnvironmentPublishInfo"
}
},
"default": {
"description": "Common error codes:\n\n* InvalidEnvironmentCancel - Environment cancel operation for version <*GUID* of the failed publish cancellation> failed due to error: Code = EnvironmentUpsupportedStateForCancel.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Publish environment cancellation example": {
"$ref": "./examples/PublishCancellation.json"
}
}
}
}
},
"responses": {},
"security": [],
"tags": []
}
eventhouse/definitions.json
+190
View File
@@ -0,0 +1,190 @@
{
"swagger": "2.0",
"info": {
"version": "v1",
"title": "Eventhouse data types"
},
"paths": {},
"definitions": {
"Eventhouses": {
"description": "A list of eventhouses.",
"type": "object",
"required": ["value"],
"properties": {
"value": {
"description": "A list of eventhouses.",
"type": "array",
"items": {
"$ref": "#/definitions/Eventhouse"
}
}
},
"allOf": [
{
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
}
]
},
"Eventhouse": {
"description": "An eventhouse object.",
"type": "object",
"required": ["type"],
"allOf": [
{
"$ref": "../common/definitions.json#/definitions/Item"
}
],
"properties": {
"properties": {
"description": "The eventhouse properties.",
"$ref": "#/definitions/EventhouseProperties"
}
}
},
"EventhouseProperties": {
"description": "The eventhouse properties.",
"type": "object",
"required": ["queryServiceUri", "ingestionServiceUri"],
"properties": {
"queryServiceUri": {
"description": "Query service URI.",
"type": "string"
},
"ingestionServiceUri": {
"description": "Ingestion service URI.",
"type": "string"
},
"databasesItemIds": {
"description": "List of all KQL database children",
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"readOnly": true
}
},
"minimumConsumptionUnits": {
"description": "Use Minimum consumption for highly time-sensitive systems to keep the service always available at a selected minimum level. You pay for the minimum consumption level or actual consumption if above the minimum. Supported values include [0, 2.25, 4.25, 8.5, 13, 18, 26, 34, 50] or any number between 51 and 322. For more information, see [minimum consumption](/fabric/real-time-intelligence/eventhouse#minimum-consumption).",
"type": "number",
"format": "double",
"default": 0
}
}
},
"CreateEventhouseRequest": {
"description": "Create eventhouse request.",
"type": "object",
"required": ["displayName"],
"properties": {
"displayName": {
"description": "The eventhouse display name. The eventhouse name can contain alphanumeric characters, underscores, periods, and hyphens. Special characters aren't supported.",
"type": "string",
"readOnly": false
},
"description": {
"description": "The eventhouse description. Maximum length is 256 characters.",
"type": "string",
"readOnly": false
},
"creationPayload": {
"description": "The eventhouse creation payload. Use `definition` or `creationPayload`. You can't use both at the same time.",
"$ref": "#/definitions/EventhouseCreationPayload",
"readOnly": false
},
"definition": {
"description": "The eventhouse public definition. Use `definition` or `creationPayload`. You can't use both at the same time.",
"$ref": "#/definitions/EventhouseDefinition",
"readOnly": false
}
}
},
"UpdateEventhouseRequest": {
"description": "Update eventhouse request.",
"properties": {
"displayName": {
"description": "The eventhouse display name. The eventhouse name can contain alphanumeric characters, underscores, periods, and hyphens. Special characters aren't supported.",
"type": "string",
"readOnly": false
},
"description": {
"description": "The eventhouse description. Maximum length is 256 characters.",
"type": "string",
"readOnly": false
}
}
},
"EventhouseCreationPayload": {
"description": "Eventhouse item payload",
"type": "object",
"properties": {
"minimumConsumptionUnits": {
"description": "Use Minimum consumption for highly time-sensitive systems to keep the service always available at a selected minimum level. You pay for the minimum consumption level or actual consumption if above the minimum. Supported values include [0, 2.25, 4.25, 8.5, 13, 18, 26, 34, 50] or any number between 51 and 322. For more information, see [minimum consumption](/fabric/real-time-intelligence/eventhouse#minimum-consumption).",
"type": "number",
"format": "double",
"default": 0
}
}
},
"EventhouseDefinition" : {
"description": "Eventhouse public definition object.",
"type": "object",
"required": ["parts"],
"properties": {
"format": {
"description": "The format of the item definition.",
"type": "string",
"readOnly": false
},
"parts": {
"description": "A list of definition parts.",
"type": "array",
"items": {
"$ref": "#/definitions/EventhouseDefinitionPart"
},
"readOnly": false
}
}
},
"EventhouseDefinitionPart": {
"description": "Eventhouse definition part object.",
"type": "object",
"required": ["path", "payload", "payloadType"],
"properties": {
"path": {
"description": "The eventhouse part path.",
"type": "string",
"readOnly": false
},
"payload": {
"description": "The eventhouse part payload.",
"type": "string",
"readOnly": false
},
"payloadType":{
"description": "The payload type.",
"$ref": "../common/definitions.json#/definitions/PayloadType",
"readOnly": false
}
}
},
"UpdateEventhouseDefinitionRequest": {
"description": "Update eventhouse public definition request payload.",
"required": ["definition"],
"properties": {
"definition": {
"$ref": "#/definitions/EventhouseDefinition"
}
}
},
"EventhouseDefinitionResponse": {
"description": "Eventhouse public definition response.",
"required": ["definition"],
"properties": {
"definition": {
"$ref": "#/definitions/EventhouseDefinition",
"readOnly": true
}
}
}
}
}
eventhouse/examples/CreateEventhouse.json
+27
View File
@@ -0,0 +1,27 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"createEventhouseRequest": {
"displayName": "Eventhouse_1",
"description": "An eventhouse description."
}
},
"responses": {
"201": {
"body": {
"displayName": "Eventhouse_1",
"description": "An eventhouse description.",
"type": "Eventhouse",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"id": "5b218778-e7a5-4d73-8187-f10824047655"
}
},
"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
}
}
}
}
eventhouse/examples/CreateEventhouseWithCreationPayload.json
+30
View File
@@ -0,0 +1,30 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"createEventhouseRequest": {
"displayName": "Eventhouse_1",
"description": "An eventhouse description.",
"creationPayload": {
"minimumConsumptionUnits": 2.25
}
}
},
"responses": {
"201": {
"body": {
"displayName": "Eventhouse_1",
"description": "An eventhouse description.",
"type": "Eventhouse",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"id": "5b218778-e7a5-4d73-8187-f10824047655"
}
},
"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
}
}
}
}
eventhouse/examples/CreateEventhouseWithDefinition.json
+41
View File
@@ -0,0 +1,41 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"createEventhouseRequest": {
"displayName": "Eventhouse_1",
"description": "An eventhouse description.",
"definition": {
"parts": [
{
"path": "EventhouseProperties.json",
"payload": "e30=",
"payloadType": "InlineBase64"
},
{
"path": ".platform",
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
"payloadType": "InlineBase64"
}
]
}
}
},
"responses": {
"201": {
"body": {
"displayName": "Eventhouse_1",
"description": "An eventhouse description.",
"type": "Eventhouse",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"id": "5b218778-e7a5-4d73-8187-f10824047655"
}
},
"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
}
}
}
}
eventhouse/examples/DeleteEventhouse.json
+9
View File
@@ -0,0 +1,9 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"eventhouseId": "5b218778-e7a5-4d73-8187-f10824047715"
},
"responses": {
"200": {}
}
}
eventhouse/examples/GetEventhouse.json
+26
View File
@@ -0,0 +1,26 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"eventhouseId": "5b218778-e7a5-4d73-8187-f10824047715"
},
"responses": {
"200": {
"body": {
"displayName": "Eventhouse_1",
"description": "An eventhouse description.",
"type": "Eventhouse",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"id": "5b218778-e7a5-4d73-8187-f10824047715",
"properties": {
"queryServiceUri": "https://trd-f7k1b2rzuqrjmb3wpd.z5.kusto.fabric.microsoft.com",
"ingestionServiceUri": "https://ingest-trd-f7k1b2rzuqrjmb3wpd.z5.kusto.fabric.microsoft.com",
"databasesItemIds": [
"f1082404-7716-5b21-8778-e7a5e7a54d73",
"8187f108-2404-4771-6e7a-5b218778e7a5"
],
"minimumConsumptionUnits": 0
}
}
}
}
}
eventhouse/examples/GetEventhouseDefinition.json
+33
View File
@@ -0,0 +1,33 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"eventhouseId": "5b218778-e7a5-4d73-8187-f10824047715"
},
"responses": {
"200": {
"body": {
"definition": {
"parts": [
{
"path": "EventhouseProperties.json",
"payload": "e30=",
"payloadType": "InlineBase64"
},
{
"path": ".platform",
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc",
"payloadType": "InlineBase64"
}
]
}
}
},
"202": {
"headers": {
"Location": "https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6",
"x-ms-operation-id": "0acd697c-1550-43cd-b998-91bfbfbd47c6",
"Retry-After": 30
}
}
}
}
Loaded 100 of 487 files, more files were not shown because too many files have changed in this diff. Show more