mirror of
https://github.com/microsoft/fabric-rest-api-specs.git
synced 2026-11-04 12:04:23 +00:00
Updating swagger files.
This commit is contained in:
Fabric-APIs-Publish-Specification-Pipeline committed
1 parent
1e1731305d
commit
fed4d44a67
29 files changed
+1764
-25
No files matched your search
+318
-1
@@ -169,6 +169,11 @@
|
||||
"$ref": "../common/definitions.json#/definitions/ItemTag"
|
||||
},
|
||||
"readOnly": true
|
||||
},
|
||||
"defaultIdentity": {
|
||||
"description": "The item's default identity.",
|
||||
"$ref": "../common/definitions.json#/definitions/Principal",
|
||||
"readOnly": true
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -1103,6 +1108,318 @@
|
||||
"$ref": "../platform/definitions/workspaceNetworkingPolicy.json#/definitions/NetworkRules"
|
||||
}
|
||||
}
|
||||
},
|
||||
"WorkloadAssignmentInfos": {
|
||||
"description": "A paginated list of workloads in the tenant. Contains workload information with assignment status details.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"value": {
|
||||
"type": "array",
|
||||
"description": "The list of workloads with their assignment information.",
|
||||
"items": {
|
||||
"$ref": "#/definitions/WorkloadAssignmentInfo"
|
||||
}
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
|
||||
}
|
||||
]
|
||||
},
|
||||
"WorkloadAssignmentInfo": {
|
||||
"required": [
|
||||
"id",
|
||||
"name",
|
||||
"publisher",
|
||||
"isAssignable",
|
||||
"isAssignedToTenant",
|
||||
"assignedCapacitiesCount",
|
||||
"assignedWorkspacesCount"
|
||||
],
|
||||
"description": "Workload assignment information. Contains details about a workload and its assignment status across the tenant, capacities, and workspaces.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
"description": "The unique identifier of the workload.",
|
||||
"readOnly": true
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "The display name of the workload.",
|
||||
"readOnly": true
|
||||
},
|
||||
"publisher": {
|
||||
"type": "string",
|
||||
"description": "The publisher of the workload.",
|
||||
"readOnly": true
|
||||
},
|
||||
"isAssignable": {
|
||||
"type": "boolean",
|
||||
"description": "Specifies if the workload is assignable. When true, the workload can be assigned to tenant, capacities or workspaces.",
|
||||
"readOnly": true
|
||||
},
|
||||
"isAssignedToTenant": {
|
||||
"type": "boolean",
|
||||
"description": "Specifies if the workload is assigned to the tenant scope. When true, the workload is available across the entire tenant.",
|
||||
"readOnly": true
|
||||
},
|
||||
"assignedCapacitiesCount": {
|
||||
"type": "integer",
|
||||
"description": "The number of capacities to which the workload has been assigned.",
|
||||
"readOnly": true
|
||||
},
|
||||
"assignedWorkspacesCount": {
|
||||
"type": "integer",
|
||||
"description": "The number of workspaces to which the workload has been assigned.",
|
||||
"readOnly": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"WorkloadAssignmentType": {
|
||||
"type": "string",
|
||||
"description": "The type of workload assignment. Specifies whether a workload is assigned to a capacity, workspace, or tenant. Additional assignment types may be added over time.",
|
||||
"enum": [
|
||||
"Capacity",
|
||||
"Workspace",
|
||||
"Tenant"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "WorkloadAssignmentType",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "Capacity",
|
||||
"description": "Capacity assignment type. The workload is assigned to a specific capacity."
|
||||
},
|
||||
{
|
||||
"value": "Workspace",
|
||||
"description": "Workspace assignment type. The workload is assigned to a specific workspace."
|
||||
},
|
||||
{
|
||||
"value": "Tenant",
|
||||
"description": "Tenant assignment type. The workload is assigned to the entire tenant scope."
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"WorkloadAssignments": {
|
||||
"description": "A paginated list of workload assignments. Contains assignments for workloads to capacities, workspaces, or tenant.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"value": {
|
||||
"type": "array",
|
||||
"description": "The list of workload assignments. Each item can be a Capacity, Workspace, or Tenant assignment.",
|
||||
"items": {
|
||||
"$ref": "#/definitions/BaseWorkloadAssignment"
|
||||
}
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
|
||||
}
|
||||
]
|
||||
},
|
||||
"BaseWorkloadAssignment": {
|
||||
"required": [
|
||||
"id",
|
||||
"type",
|
||||
"workloadId"
|
||||
],
|
||||
"description": "Base workload assignment.",
|
||||
"type": "object",
|
||||
"discriminator": "type",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"description": "The unique identifier of the assignment.",
|
||||
"readOnly": true
|
||||
},
|
||||
"type": {
|
||||
"description": "The type of assignment. Possible values: Capacity, Workspace, Tenant.",
|
||||
"$ref": "#/definitions/WorkloadAssignmentType",
|
||||
"readOnly": true
|
||||
},
|
||||
"workloadId": {
|
||||
"type": "string",
|
||||
"description": "The unique identifier of the workload.",
|
||||
"readOnly": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"WorkloadCapacityAssignment": {
|
||||
"description": "Capacity workload assignment. Represents an assignment of a workload to a specific capacity.",
|
||||
"type": "object",
|
||||
"x-ms-discriminator-value": "Capacity",
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/BaseWorkloadAssignment"
|
||||
},
|
||||
{
|
||||
"$ref": "#/definitions/WorkloadCapacityAssignmentProperties"
|
||||
}
|
||||
]
|
||||
},
|
||||
"WorkloadCapacityAssignmentProperties": {
|
||||
"required": [
|
||||
"capacityId",
|
||||
"capacityName"
|
||||
],
|
||||
"description": "Properties specific to capacity workload assignments. Contains the capacity identifier and display name.",
|
||||
"properties": {
|
||||
"capacityId": {
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"description": "The unique identifier of the capacity to which the workload is assigned.",
|
||||
"readOnly": true
|
||||
},
|
||||
"capacityName": {
|
||||
"type": "string",
|
||||
"description": "The display name of the capacity to which the workload is assigned.",
|
||||
"readOnly": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"WorkloadWorkspaceAssignment": {
|
||||
"description": "Workspace workload assignment. Represents an assignment of a workload to a specific workspace.",
|
||||
"type": "object",
|
||||
"x-ms-discriminator-value": "Workspace",
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/BaseWorkloadAssignment"
|
||||
},
|
||||
{
|
||||
"$ref": "#/definitions/WorkloadWorkspaceAssignmentProperties"
|
||||
}
|
||||
]
|
||||
},
|
||||
"WorkloadWorkspaceAssignmentProperties": {
|
||||
"required": [
|
||||
"workspaceId",
|
||||
"workspaceName"
|
||||
],
|
||||
"description": "Properties specific to workspace workload assignments. Contains the workspace identifier and display name.",
|
||||
"properties": {
|
||||
"workspaceId": {
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"description": "The unique identifier of the workspace to which the workload is assigned.",
|
||||
"readOnly": true
|
||||
},
|
||||
"workspaceName": {
|
||||
"type": "string",
|
||||
"description": "The display name of the workspace to which the workload is assigned.",
|
||||
"readOnly": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"WorkloadTenantAssignment": {
|
||||
"description": "Tenant workload assignment. Represents an assignment of a workload to the entire tenant scope.",
|
||||
"type": "object",
|
||||
"x-ms-discriminator-value": "Tenant",
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/BaseWorkloadAssignment"
|
||||
}
|
||||
]
|
||||
},
|
||||
"CreateWorkloadBaseAssignmentRequest": {
|
||||
"required": [
|
||||
"type",
|
||||
"workloadId"
|
||||
],
|
||||
"description": "Base request for creating workload assignments.",
|
||||
"type": "object",
|
||||
"discriminator": "type",
|
||||
"properties": {
|
||||
"type": {
|
||||
"description": "The type of assignment to create. Possible values: Capacity, Workspace, Tenant.",
|
||||
"$ref": "#/definitions/WorkloadAssignmentType"
|
||||
},
|
||||
"workloadId": {
|
||||
"type": "string",
|
||||
"description": "The unique identifier of the workload to assign."
|
||||
}
|
||||
}
|
||||
},
|
||||
"CreateWorkloadCapacityAssignmentRequest": {
|
||||
"description": "Request for creating a capacity workload assignment. Assigns a workload to a specific capacity.",
|
||||
"type": "object",
|
||||
"x-ms-discriminator-value": "Capacity",
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/CreateWorkloadBaseAssignmentRequest"
|
||||
},
|
||||
{
|
||||
"$ref": "#/definitions/CreateWorkloadCapacityAssignmentProperties"
|
||||
}
|
||||
]
|
||||
},
|
||||
"CreateWorkloadCapacityAssignmentProperties": {
|
||||
"required": [
|
||||
"capacityId"
|
||||
],
|
||||
"description": "Properties specific to creating a capacity workload assignment. Contains the capacity identifier to which the workload will be assigned.",
|
||||
"properties": {
|
||||
"capacityId": {
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"description": "The unique identifier of the capacity to assign the workload to."
|
||||
}
|
||||
}
|
||||
},
|
||||
"CreateWorkloadWorkspaceAssignmentRequest": {
|
||||
"description": "Request for creating a workspace workload assignment. Assigns a workload to a specific workspace.",
|
||||
"type": "object",
|
||||
"x-ms-discriminator-value": "Workspace",
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/CreateWorkloadBaseAssignmentRequest"
|
||||
},
|
||||
{
|
||||
"$ref": "#/definitions/CreateWorkloadWorkspaceAssignmentProperties"
|
||||
}
|
||||
]
|
||||
},
|
||||
"CreateWorkloadWorkspaceAssignmentProperties": {
|
||||
"required": [
|
||||
"workspaceId"
|
||||
],
|
||||
"description": "Properties specific to creating a workspace workload assignment. Contains the workspace identifier to which the workload will be assigned.",
|
||||
"properties": {
|
||||
"workspaceId": {
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"description": "The unique identifier of the workspace to assign the workload to."
|
||||
}
|
||||
}
|
||||
},
|
||||
"CreateWorkloadTenantAssignmentRequest": {
|
||||
"description": "Request for creating a tenant workload assignment. Assigns a workload to the entire tenant scope.",
|
||||
"type": "object",
|
||||
"x-ms-discriminator-value": "Tenant",
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/CreateWorkloadBaseAssignmentRequest"
|
||||
}
|
||||
]
|
||||
},
|
||||
"DeleteWorkloadAssignmentRequest": {
|
||||
"required": [
|
||||
"id"
|
||||
],
|
||||
"description": "Request for deleting a workload assignment. Contains the unique identifier of the assignment to delete.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"description": "The unique identifier of the assignment to delete."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -22,6 +22,14 @@
|
||||
"userDetails": {
|
||||
"userPrincipalName": "Jacob@example.com"
|
||||
}
|
||||
},
|
||||
"defaultIdentity": {
|
||||
"id": "ff3c8689-591c-4298-a228-4ffcc77cb661",
|
||||
"displayName": "Caleb Foster",
|
||||
"type": "User",
|
||||
"userDetails": {
|
||||
"userPrincipalName": "caleb@example.com"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -21,6 +21,14 @@
|
||||
"userPrincipalName": "caleb@example.com"
|
||||
}
|
||||
},
|
||||
"defaultIdentity": {
|
||||
"id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
|
||||
"displayName": "Caleb Foster",
|
||||
"type": "User",
|
||||
"userDetails": {
|
||||
"userPrincipalName": "caleb@example.com"
|
||||
}
|
||||
},
|
||||
"tags": [
|
||||
{
|
||||
"displayName": "Tag 1",
|
||||
@@ -48,6 +56,14 @@
|
||||
"userDetails": {
|
||||
"userPrincipalName": "jacob@example.com"
|
||||
}
|
||||
},
|
||||
"defaultIdentity": {
|
||||
"id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
|
||||
"displayName": "Jacob Hancock",
|
||||
"type": "User",
|
||||
"userDetails": {
|
||||
"userPrincipalName": "jacob@example.com"
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
{
|
||||
"parameters": {
|
||||
"createWorkloadAssignmentRequest": {
|
||||
"capacityId": "a7b12741-80ce-444a-a493-ecf92fed4ffd",
|
||||
"type": "Capacity",
|
||||
"workloadId": "Fabric.SampleWorkloadV2"
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"201": {
|
||||
"body": {
|
||||
"id": "b70c0007-6524-402c-86a2-489752e219a6",
|
||||
"type": "Capacity",
|
||||
"workloadId": "Fabric.SampleWorkloadV2",
|
||||
"capacityId": "a7b12741-80ce-444a-a493-ecf92fed4ffd",
|
||||
"capacityName": "F4 Capacity"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,17 @@
|
||||
{
|
||||
"parameters": {
|
||||
"createWorkloadAssignmentRequest": {
|
||||
"type": "Tenant",
|
||||
"workloadId": "Fabric.SampleWorkloadV2"
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"201": {
|
||||
"body": {
|
||||
"id": "07f7c957-9942-442d-83d9-d6a0f317c1c5",
|
||||
"type": "Tenant",
|
||||
"workloadId": "Fabric.SampleWorkloadV2"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,20 @@
|
||||
{
|
||||
"parameters": {
|
||||
"createWorkloadAssignmentRequest": {
|
||||
"workspaceId": "a7b12741-80ce-444a-a493-ecf92fed4ffd",
|
||||
"type": "Workspace",
|
||||
"workloadId": "Fabric.SampleWorkloadV2"
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"201": {
|
||||
"body": {
|
||||
"id": "0002665b-43c2-47ec-9f03-866e34503c35",
|
||||
"type": "Workspace",
|
||||
"workloadId": "Fabric.SampleWorkloadV2",
|
||||
"workspaceId": "a7b12741-80ce-444a-a493-ecf92fed4ffd",
|
||||
"workspaceName": "My workspace"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,8 @@
|
||||
{
|
||||
"parameters": {
|
||||
"assignmentId": "830f18e9-e7e5-43c7-88de-197bfe0b457e"
|
||||
},
|
||||
"responses": {
|
||||
"200": {}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,32 @@
|
||||
{
|
||||
"parameters": {},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"value": [
|
||||
{
|
||||
"id": "46c90afa-1f07-4c85-822e-7da41987a0cc",
|
||||
"type": "Capacity",
|
||||
"workloadId": "Fabric.SampleWorkloadV2",
|
||||
"capacityId": "a7b12741-80ce-444a-a493-ecf92fed4ffd",
|
||||
"capacityName": "F4 Capacity"
|
||||
},
|
||||
{
|
||||
"id": "007b57fd-126b-423c-9cfb-f5ec51e2de4d",
|
||||
"type": "Workspace",
|
||||
"workloadId": "Fabric.SampleWorkloadV2",
|
||||
"workspaceId": "67605640-97d3-47ab-8600-010d482f4c54",
|
||||
"workspaceName": "My workspace"
|
||||
},
|
||||
{
|
||||
"id": "5e9ad558-a1f3-416c-9c4c-363846b2b670",
|
||||
"type": "Tenant",
|
||||
"workloadId": "Fabric.TestWorkload"
|
||||
}
|
||||
],
|
||||
"continuationUri": "https://api.fabric.microsoft.com/v1/admin/workloads/assignments?continuationToken=MSwxMDAwMCww",
|
||||
"continuationToken": "MSwxMDAwMCww"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,30 @@
|
||||
{
|
||||
"parameters": {
|
||||
"Type": "Capacity",
|
||||
"workloadId": "Fabric.SampleWorkloadV2"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"value": [
|
||||
{
|
||||
"id": "489eef53-adca-4191-9437-a665e8ada1e7",
|
||||
"type": "Capacity",
|
||||
"workloadId": "Fabric.SampleWorkloadV2",
|
||||
"capacityId": "a7b12741-80ce-444a-a493-ecf92fed4ffd",
|
||||
"capacityName": "F4 Capacity"
|
||||
},
|
||||
{
|
||||
"id": "0c76b9d4-0ddc-4ff2-8b6e-23eded9b92cd",
|
||||
"type": "Capacity",
|
||||
"workloadId": "Fabric.SampleWorkloadV2",
|
||||
"capacityId": "67605640-97d3-47ab-8600-010d482f4c54",
|
||||
"capacityName": "F8 Capacity"
|
||||
}
|
||||
],
|
||||
"continuationUri": "https://api.fabric.microsoft.com/v1/admin/workloads/assignments?type=capacity&workloadId=Fabric.SampleWorkloadV2&continuationToken=MSwxMDAwMCww",
|
||||
"continuationToken": "MSwxMDAwMCww"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,20 @@
|
||||
{
|
||||
"parameters": {
|
||||
"Type": "Tenant"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"value": [
|
||||
{
|
||||
"id": "c77c4d09-3240-42a3-a72c-a76e1615c12a",
|
||||
"type": "Tenant",
|
||||
"workloadId": "Fabric.TestWorkload"
|
||||
}
|
||||
],
|
||||
"continuationUri": "https://api.fabric.microsoft.com/v1/admin/workloads/assignments?type=tenant&continuationToken=MSwxMDAwMCww",
|
||||
"continuationToken": "MSwxMDAwMCww"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,40 @@
|
||||
{
|
||||
"parameters": {},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"value": [
|
||||
{
|
||||
"id": "Fabric.TestWorkload",
|
||||
"name": "Test Workload",
|
||||
"publisher": "Contoso",
|
||||
"isAssignable": true,
|
||||
"isAssignedToTenant": true,
|
||||
"assignedCapacitiesCount": 2,
|
||||
"assignedWorkspacesCount": 0
|
||||
},
|
||||
{
|
||||
"id": "Fabric.TestWorkloadV2",
|
||||
"name": "Awesome Workload",
|
||||
"publisher": "Contoso",
|
||||
"isAssignable": true,
|
||||
"isAssignedToTenant": false,
|
||||
"assignedCapacitiesCount": 0,
|
||||
"assignedWorkspacesCount": 0
|
||||
},
|
||||
{
|
||||
"id": "Fabric.SampleWorkload",
|
||||
"name": "Sample Workload",
|
||||
"publisher": "SampleOrganization",
|
||||
"isAssignable": true,
|
||||
"isAssignedToTenant": false,
|
||||
"assignedCapacitiesCount": 0,
|
||||
"assignedWorkspacesCount": 0
|
||||
}
|
||||
],
|
||||
"continuationUri": "https://api.fabric.microsoft.com/v1/admin/workloads?continuationToken=MSwxMDAwMCww",
|
||||
"continuationToken": "MSwxMDAwMCww"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,42 @@
|
||||
{
|
||||
"parameters": {
|
||||
"assignmentStatus": "Assigned"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"value": [
|
||||
{
|
||||
"id": "Fabric.SampleWorkloadV2",
|
||||
"name": "Sample Workload",
|
||||
"publisher": "Contoso",
|
||||
"isAssignable": true,
|
||||
"isAssignedToTenant": true,
|
||||
"assignedCapacitiesCount": 2,
|
||||
"assignedWorkspacesCount": 3
|
||||
},
|
||||
{
|
||||
"id": "Fabric.TestWorkload",
|
||||
"name": "Test Workload",
|
||||
"publisher": "Contoso",
|
||||
"isAssignable": true,
|
||||
"isAssignedToTenant": true,
|
||||
"assignedCapacitiesCount": 0,
|
||||
"assignedWorkspacesCount": 0
|
||||
},
|
||||
{
|
||||
"id": "Org.TestWorkloadV2",
|
||||
"name": "Corp Workload",
|
||||
"publisher": "Corp",
|
||||
"isAssignable": false,
|
||||
"isAssignedToTenant": true,
|
||||
"assignedCapacitiesCount": 0,
|
||||
"assignedWorkspacesCount": 0
|
||||
}
|
||||
],
|
||||
"continuationUri": "https://api.fabric.microsoft.com/v1/admin/workloads?assignmentStatus=assigned&continuationToken=MSwxMDAwMCww",
|
||||
"continuationToken": "MSwxMDAwMCww"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -3034,6 +3034,314 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workloads": {
|
||||
"get": {
|
||||
"summary": "Returns all workloads, optionally filtered by assignment status. If AssignmentStatus is not specified or set to AssignmentStatus.Any, the result will include assigned workloads and unassigned workloads.",
|
||||
"description": "This API supports [pagination](/rest/api/fabric/articles/pagination).\n\nNote: Only published workloads are visible.\n\n## Permissions\n\nThe caller must be a Fabric administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All\n\n## Limitations\n\nMaximum 200 requests per hour.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Workloads"
|
||||
],
|
||||
"operationId": "Workloads_ListWorkloads",
|
||||
"x-ms-pageable": {
|
||||
"nextLinkName": "continuationUri",
|
||||
"itemName": "value"
|
||||
},
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "query",
|
||||
"name": "assignmentStatus",
|
||||
"type": "string",
|
||||
"description": "Assignment status of workloads. Additional assignment statuses may be added over time.",
|
||||
"enum": [
|
||||
"Any",
|
||||
"Assigned",
|
||||
"Unassigned"
|
||||
],
|
||||
"default": "Any",
|
||||
"x-ms-enum": {
|
||||
"name": "WorkloadAssignmentStatus",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "Any",
|
||||
"description": "Workloads that are assigned or unassigned."
|
||||
},
|
||||
{
|
||||
"value": "Assigned",
|
||||
"description": "Workloads that are assigned to the tenant or to at least one workspace or capacity in the tenant."
|
||||
},
|
||||
{
|
||||
"value": "Unassigned",
|
||||
"description": "Workloads that are not assigned to the tenant, any workspace, or any capacity in the tenant."
|
||||
}
|
||||
]
|
||||
},
|
||||
"required": false
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "continuationToken",
|
||||
"description": "Continuation token. Used to get the next items in the list.",
|
||||
"type": "string",
|
||||
"required": false
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK. The operation was successful.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/WorkloadAssignmentInfos"
|
||||
}
|
||||
},
|
||||
"429": {
|
||||
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
||||
"x-ms-error-response": true,
|
||||
"headers": {
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
},
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* BadRequest - Invalid query parameters.\n\n* PrivateLinksUnsupported - The API is not supported with Private Links enabled.\n\n* Unauthorized - The caller doesn't have permission to call the API.\n\n* TooManyRequests - The caller has exceeded the number of requests allowed in the current time frame and further requests will fail.\n\n* InternalServerError - Unexpected server error.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"List workloads with assigned status example": {
|
||||
"$ref": "./examples/workloads/ListWorkloadsAssigned.json"
|
||||
},
|
||||
"List all workloads example": {
|
||||
"$ref": "./examples/workloads/ListWorkloadsAll.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workloads/assignments": {
|
||||
"get": {
|
||||
"summary": "List all workload assignments. The result contains a list of assignments which can be filtered by the workload ID and assignment type.",
|
||||
"description": "This API supports [pagination](/rest/api/fabric/articles/pagination).\n\nNote: Only published workloads are visible.\n\n## Permissions\n\nThe caller must be a Fabric administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.Read.All or Tenant.ReadWrite.All\n\n## Limitations\n\nMaximum 200 requests per hour.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Workloads"
|
||||
],
|
||||
"operationId": "Workloads_ListWorkloadAssignments",
|
||||
"x-ms-pageable": {
|
||||
"nextLinkName": "continuationUri",
|
||||
"itemName": "value"
|
||||
},
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "query",
|
||||
"name": "continuationToken",
|
||||
"description": "Continuation token. Used to get the next items in the list.",
|
||||
"type": "string",
|
||||
"required": false
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "Type",
|
||||
"type": "string",
|
||||
"description": "Assignment type. Additional assignment types may be added over time.",
|
||||
"enum": [
|
||||
"Capacity",
|
||||
"Workspace",
|
||||
"Tenant"
|
||||
],
|
||||
"required": false,
|
||||
"x-ms-enum": {
|
||||
"name": "WorkloadAssignmentType",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "Capacity",
|
||||
"description": "Capacity assignment type."
|
||||
},
|
||||
{
|
||||
"value": "Workspace",
|
||||
"description": "Workspace assignment type."
|
||||
},
|
||||
{
|
||||
"value": "Tenant",
|
||||
"description": "Tenant assignment type."
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "workloadId",
|
||||
"description": "WorkloadID filter.",
|
||||
"type": "string",
|
||||
"required": false
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK. The operation was successful.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/WorkloadAssignments"
|
||||
}
|
||||
},
|
||||
"429": {
|
||||
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
||||
"x-ms-error-response": true,
|
||||
"headers": {
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
},
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* WorkloadNotFound - Provided workload ID can't be found.\n\n* PrivateLinksUnsupported - The API is not supported with Private Links enabled.\n\n* Unauthorized - The caller doesn't have permission to call the API.\n\n* TooManyRequests - The caller has exceeded the number of requests allowed in the current time frame and further requests will fail.\n\n* InternalServerError - Unexpected server error.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"List all workload assignments example": {
|
||||
"$ref": "./examples/workloads/ListWorkloadAssignments.json"
|
||||
},
|
||||
"List capacity assignments for a specific workload example": {
|
||||
"$ref": "./examples/workloads/ListWorkloadAssignmentsFiltered.json"
|
||||
},
|
||||
"List tenant assignments example": {
|
||||
"$ref": "./examples/workloads/ListWorkloadAssignmentsTenant.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"post": {
|
||||
"summary": "Create workload assignment.",
|
||||
"description": "## Permissions\n\nThe caller must be a Fabric administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.ReadWrite.All\n\n## Limitations\n\nMaximum 200 requests per hour.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Workloads"
|
||||
],
|
||||
"operationId": "Workloads_CreateWorkloadAssignment",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "body",
|
||||
"name": "createWorkloadAssignmentRequest",
|
||||
"description": "The request payload for creating workload assignment.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/CreateWorkloadBaseAssignmentRequest"
|
||||
},
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"201": {
|
||||
"description": "Created. Workload assignment created successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/BaseWorkloadAssignment"
|
||||
}
|
||||
},
|
||||
"429": {
|
||||
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
||||
"x-ms-error-response": true,
|
||||
"headers": {
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
},
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* WorkloadNotFound - Provided workload ID can't be found.\n\n* PrivateLinksUnsupported - The API is not supported with Private Links enabled.\n\n* Unauthorized - The caller doesn't have permission to call the API.\n\n* TooManyRequests - The caller has exceeded the number of requests allowed in the current time frame and further requests will fail.\n\n* InternalServerError - Unexpected server error.\n\n* BadRequest - Invalid request type, Missing capacity/workspace IDs in request body, Invalid capacity/workspace ID received.\n\n* CapacityNotFound - Capacity not found in the tenant.\n\n* WorkspaceNotFound - Workspace not found in the tenant.\n\n* WorkspaceHaveNoCapacity - Workspace have no capacity assigned.\n\n* WorkspaceHaveUnsupportedSKU - Workspace have unsupported capacity SKU tier.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Create capacity assignment example": {
|
||||
"$ref": "./examples/workloads/CreateWorkloadCapacityAssignment.json"
|
||||
},
|
||||
"Create workspace assignment example": {
|
||||
"$ref": "./examples/workloads/CreateWorkloadWorkspaceAssignment.json"
|
||||
},
|
||||
"Create tenant assignment example": {
|
||||
"$ref": "./examples/workloads/CreateWorkloadTenantAssignment.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workloads/assignments/{assignmentId}": {
|
||||
"delete": {
|
||||
"summary": "Delete workload assignment.",
|
||||
"description": "## Permissions\n\nThe caller must be a Fabric administrator or authenticate using a service principal.\n\n## Required Delegated Scopes\n\nTenant.ReadWrite.All\n\n## Limitations\n\nMaximum 200 requests per hour.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Workloads"
|
||||
],
|
||||
"operationId": "Workloads_DeleteWorkloadAssignment",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "assignmentId",
|
||||
"description": "Assignment ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK. Assignment deleted successfully."
|
||||
},
|
||||
"429": {
|
||||
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
||||
"x-ms-error-response": true,
|
||||
"headers": {
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
},
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* AssignmentNotFound - Provided assignment ID can't be found.\n\n* PrivateLinksUnsupported - The API is not supported with Private Links enabled.\n\n* Unauthorized - The caller doesn't have permission to call the API.\n\n* TooManyRequests - The caller has exceeded the number of requests allowed in the current time frame and further requests will fail.\n\n* InternalServerError - Unexpected server error.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Delete workload assignment example": {
|
||||
"$ref": "./examples/workloads/DeleteWorkloadAssignment.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {},
|
||||
|
||||
+12
-7
@@ -371,7 +371,7 @@
|
||||
},
|
||||
{
|
||||
"value": "VariableLibrary",
|
||||
"description": "A VariableLibrary."
|
||||
"description": "A VariableLibrary."
|
||||
},
|
||||
{
|
||||
"value": "MirroredAzureDatabricksCatalog",
|
||||
@@ -598,6 +598,11 @@
|
||||
},
|
||||
"readOnly": true
|
||||
},
|
||||
"defaultIdentity": {
|
||||
"description": "The item's default identity.",
|
||||
"$ref": "../common/definitions.json#/definitions/Principal",
|
||||
"readOnly": true
|
||||
},
|
||||
"sensitivityLabel": {
|
||||
"description": "The item sensitivity label.",
|
||||
"$ref": "#/definitions/SensitivityLabel",
|
||||
@@ -905,7 +910,7 @@
|
||||
],
|
||||
"x-ms-discriminator-value": "Domain"
|
||||
},
|
||||
|
||||
|
||||
"ItemReference": {
|
||||
"description": "An item reference object.",
|
||||
"type": "object",
|
||||
@@ -933,8 +938,8 @@
|
||||
{
|
||||
"value": "ByVariable",
|
||||
"description": "The item is referenced by a variable."
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
]
|
||||
}
|
||||
},
|
||||
@@ -1009,8 +1014,8 @@
|
||||
{
|
||||
"value": "ByVariable",
|
||||
"description": "The connection is referenced by a variable."
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
]
|
||||
}
|
||||
},
|
||||
@@ -1051,7 +1056,7 @@
|
||||
}
|
||||
],
|
||||
"x-ms-discriminator-value": "ByVariable"
|
||||
},
|
||||
},
|
||||
"Duration": {
|
||||
"description": "A duration.",
|
||||
"type": "object",
|
||||
|
||||
@@ -392,7 +392,59 @@
|
||||
"properties": {
|
||||
"query": {
|
||||
"type": "string",
|
||||
"description": "The Azure Stream Analytics & Eventstream Query to execute. Language reference documentation can be found [here](https://learn.microsoft.com/en-us/stream-analytics-query/stream-analytics-query-language-reference)."
|
||||
"description": "The Azure Stream Analytics and Eventstream query to execute. Language reference documentation is available [here](https://learn.microsoft.com/en-us/stream-analytics-query/stream-analytics-query-language-reference)."
|
||||
|
||||
},
|
||||
"advancedSettings": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/SqlAdvancedSettings"
|
||||
}
|
||||
],
|
||||
"description": "The advanced settings for the SQL operator."
|
||||
}
|
||||
|
||||
}
|
||||
},
|
||||
"SqlAdvancedSettings": {
|
||||
"type": "object",
|
||||
"description": "Advanced settings for the SQL operator.",
|
||||
"properties": {
|
||||
"eventsOutOfOrderPolicy": {
|
||||
"type": "string",
|
||||
"description": "The policy for handling events that arrive out of order. Additional policies may be added over time.",
|
||||
"enum": [
|
||||
"Adjust",
|
||||
"Drop"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "EventsOutOfOrderPolicy",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "Adjust",
|
||||
"description": "Adjust the timestamp of out-of-order events."
|
||||
},
|
||||
{
|
||||
"value": "Drop",
|
||||
"description": "Drop out-of-order events."
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"eventsOutOfOrderMaxDelayInSeconds": {
|
||||
"type": "integer",
|
||||
"format": "int32",
|
||||
"description": "The maximum delay in seconds for out-of-order events. The value must be between 0 and 3600.",
|
||||
"minimum": 0,
|
||||
"maximum": 3600
|
||||
},
|
||||
"eventsLateArrivalMaxDelayInSeconds": {
|
||||
"type": "integer",
|
||||
"format": "int32",
|
||||
"description": "The maximum delay in seconds for late arrival events. The value must be between 0 and 1814400.",
|
||||
"minimum": 0,
|
||||
"maximum": 1814400
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
"definitions": {
|
||||
"SerializationType": {
|
||||
"type": "string",
|
||||
"description": "The serialization type.",
|
||||
"description": "The serialization type. Additional serialization types may be added over time.",
|
||||
"enum": [
|
||||
"Avro",
|
||||
"Json",
|
||||
|
||||
@@ -912,7 +912,7 @@
|
||||
},
|
||||
"includedEventTypes": {
|
||||
"type": "array",
|
||||
"description": "The included event types.",
|
||||
"description": "The included event types. Additional event types may be added over time.",
|
||||
"items": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
@@ -1089,7 +1089,7 @@
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string",
|
||||
"description": "The sample data type.",
|
||||
"description": "The sample data type. Additional sample data types may be added over time.",
|
||||
"enum": [
|
||||
"YellowTaxi",
|
||||
"StockMarket",
|
||||
@@ -1238,7 +1238,7 @@
|
||||
},
|
||||
"region": {
|
||||
"type": "string",
|
||||
"description": "The Amazon Kinesis region name.",
|
||||
"description": "The Amazon Kinesis region name. Additional regions may be added over time.",
|
||||
"enum": [
|
||||
"af-south-1",
|
||||
"ap-east-1",
|
||||
@@ -1407,6 +1407,37 @@
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"startPosition": {
|
||||
"type": "string",
|
||||
"description": "The start position in the stream.",
|
||||
"enum": [
|
||||
"Latest",
|
||||
"TrimHorizon",
|
||||
"AtTimestamp"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "StartPosition",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "Latest",
|
||||
"description": "Start from the latest record."
|
||||
},
|
||||
{
|
||||
"value": "TrimHorizon",
|
||||
"description": "Start from the last untrimmed record."
|
||||
},
|
||||
{
|
||||
"value": "AtTimestamp",
|
||||
"description": "Start from a specific timestamp."
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"startTimestamp": {
|
||||
"type": "string",
|
||||
"description": "The start timestamp in ISO 8601 format (for example, '2024-01-15T10:30:00Z'). Required when `startPosition` is `AtTimestamp`."
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -1473,7 +1504,7 @@
|
||||
"properties": {
|
||||
"saslMechanism": {
|
||||
"type": "string",
|
||||
"description": "The SASL mechanism.",
|
||||
"description": "The SASL mechanism. Additional SASL mechanisms may be added over time.",
|
||||
"enum": [
|
||||
"PLAIN",
|
||||
"SCRAM-SHA-256",
|
||||
@@ -1547,7 +1578,7 @@
|
||||
"properties": {
|
||||
"saslMechanism": {
|
||||
"type": "string",
|
||||
"description": "The SASL mechanism.",
|
||||
"description": "The SASL mechanism. Additional SASL mechanisms may be added over time.",
|
||||
"enum": [
|
||||
"PLAIN",
|
||||
"SCRAM-SHA-256",
|
||||
@@ -1698,6 +1729,33 @@
|
||||
"tableName": {
|
||||
"type": "string",
|
||||
"description": "The table name."
|
||||
},
|
||||
"decimalHandlingMode": {
|
||||
"type": "string",
|
||||
"description": "Specifies how decimal values are represented by the connector (precise decimal, double, or string).",
|
||||
"enum": [
|
||||
"Precise",
|
||||
"Double",
|
||||
"String"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "DecimalHandlingMode",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "Precise",
|
||||
"description": "The decimal handling mode is Precise."
|
||||
},
|
||||
{
|
||||
"value": "Double",
|
||||
"description": "The decimal handling mode is Double."
|
||||
},
|
||||
{
|
||||
"value": "String",
|
||||
"description": "The decimal handling mode is String."
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -1716,6 +1774,28 @@
|
||||
"type": "integer",
|
||||
"description": "The port number. Default is 3306.",
|
||||
"default": 3306
|
||||
},
|
||||
"snapshotLockingMode": {
|
||||
"type": "string",
|
||||
"description": "Specifies the locking strategy used when taking the initial snapshot (for example, minimal locks vs extended locking for stronger consistency).",
|
||||
"enum": [
|
||||
"Minimal",
|
||||
"Extended"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "SnapshotLockingMode",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "Minimal",
|
||||
"description": "The snapshot locking mode is Minimal."
|
||||
},
|
||||
{
|
||||
"value": "Extended",
|
||||
"description": "The snapshot locking mode is Extended."
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
@@ -1739,6 +1819,37 @@
|
||||
"type": "integer",
|
||||
"description": "The port number. Default is 5432.",
|
||||
"default": 5432
|
||||
},
|
||||
"publicationName": {
|
||||
"type": "string",
|
||||
"description": "The publication name for the CDC connector."
|
||||
},
|
||||
"publicationAutoCreateMode": {
|
||||
"type": "string",
|
||||
"description": "The publication auto-create mode.",
|
||||
"enum": [
|
||||
"Filtered",
|
||||
"AllTables",
|
||||
"Disabled"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "PublicationAutoCreateMode",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "Filtered",
|
||||
"description": "The publication auto-create mode is Filtered."
|
||||
},
|
||||
{
|
||||
"value": "AllTables",
|
||||
"description": "The publication auto-create mode is AllTables."
|
||||
},
|
||||
{
|
||||
"value": "Disabled",
|
||||
"description": "The publication auto-create mode is Disabled."
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
|
||||
@@ -228,7 +228,9 @@
|
||||
"type": "AmazonKinesis",
|
||||
"properties": {
|
||||
"dataConnectionId": "2e4c91e7-0c4a-4cc4-abe3-cc7ba4310a37",
|
||||
"region": "us-east-1"
|
||||
"region": "us-east-1",
|
||||
"startPosition": "AtTimestamp",
|
||||
"startTimestamp": "2024-01-15T10:30:00Z"
|
||||
},
|
||||
"status": "Running"
|
||||
},
|
||||
@@ -290,7 +292,8 @@
|
||||
"type": "AzureSQLDBCDC",
|
||||
"properties": {
|
||||
"dataConnectionId": "2e4c91e7-0c4a-4cc4-abe3-cc7ba4310a37",
|
||||
"tableName": "tableName"
|
||||
"tableName": "tableName",
|
||||
"decimalHandlingMode": "Precise"
|
||||
},
|
||||
"status": "Running"
|
||||
},
|
||||
@@ -300,7 +303,8 @@
|
||||
"type": "AzureSQLMIDBCDC",
|
||||
"properties": {
|
||||
"dataConnectionId": "2e4c91e7-0c4a-4cc4-abe3-cc7ba4310a37",
|
||||
"tableName": "tableName"
|
||||
"tableName": "tableName",
|
||||
"decimalHandlingMode": "Double"
|
||||
},
|
||||
"status": "Running"
|
||||
},
|
||||
@@ -310,7 +314,8 @@
|
||||
"type": "SQLServerOnVMDBCDC",
|
||||
"properties": {
|
||||
"dataConnectionId": "2e4c91e7-0c4a-4cc4-abe3-cc7ba4310a37",
|
||||
"tableName": "tableName"
|
||||
"tableName": "tableName",
|
||||
"decimalHandlingMode": "String"
|
||||
},
|
||||
"status": "Running"
|
||||
},
|
||||
@@ -322,7 +327,8 @@
|
||||
"dataConnectionId": "2e4c91e7-0c4a-4cc4-abe3-cc7ba4310a37",
|
||||
"tableName": "tableName",
|
||||
"serverId": 9,
|
||||
"port": 3306
|
||||
"port": 3306,
|
||||
"snapshotLockingMode": "Minimal"
|
||||
},
|
||||
"status": "Running"
|
||||
},
|
||||
@@ -334,7 +340,9 @@
|
||||
"dataConnectionId": "2e4c91e7-0c4a-4cc4-abe3-cc7ba4310a37",
|
||||
"tableName": "tableName",
|
||||
"slotName": "slotName",
|
||||
"port": 5432
|
||||
"port": 5432,
|
||||
"publicationName": "my_publication",
|
||||
"publicationAutoCreateMode": "Filtered"
|
||||
},
|
||||
"status": "Running"
|
||||
},
|
||||
@@ -881,7 +889,12 @@
|
||||
}
|
||||
],
|
||||
"properties": {
|
||||
"query": "SELECT * INTO [MyStream] FROM [MyNode]"
|
||||
"query": "SELECT * INTO [MyStream] FROM [MyNode]",
|
||||
"advancedSettings": {
|
||||
"eventsOutOfOrderPolicy": "Adjust",
|
||||
"eventsOutOfOrderMaxDelayInSeconds": 5,
|
||||
"eventsLateArrivalMaxDelayInSeconds": 300
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
|
||||
@@ -1382,6 +1382,51 @@
|
||||
"$ref": "../../common/definitions.json#/definitions/PaginatedResponse"
|
||||
}
|
||||
]
|
||||
},
|
||||
"ConnectionStatusResponse": {
|
||||
"required": [ "status" ],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"status": {
|
||||
"description": "The status of the connection. Additional statuses may be added over time.",
|
||||
"type": "string",
|
||||
"enum": [ "Online", "Offline" ],
|
||||
"x-ms-enum": {
|
||||
"name": "TestConnectionStatus",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "Online",
|
||||
"description": "The connection is online."
|
||||
},
|
||||
{
|
||||
"value": "Offline",
|
||||
"description": "The connection is offline."
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"errors": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/ConnectionStatusError"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"ConnectionStatusError": {
|
||||
"required": [ "errorCode", "message" ],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"errorCode": {
|
||||
"description": "The error code that caused the connection to be offline.",
|
||||
"type": "string"
|
||||
},
|
||||
"message": {
|
||||
"description": "The message that explains why the connection is offline.",
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -2047,7 +2047,7 @@
|
||||
"description": "Run on demand item job instance payload",
|
||||
"properties": {
|
||||
"executionData": {
|
||||
"description": "The execution data for an on-demand job. This is fixed static data defined by the specific item job type.",
|
||||
"description": "The execution data for an on-demand job. This is fixed static data, defined by the specific item job type.",
|
||||
"type": "object"
|
||||
},
|
||||
"parameters": {
|
||||
@@ -2568,8 +2568,12 @@
|
||||
"description": "The actual data contains the time/weekdays of this schedule.",
|
||||
"$ref": "#/definitions/ScheduleConfig"
|
||||
},
|
||||
"executionData": {
|
||||
"description": "The execution data for a scheduled job. This is fixed static data, defined by the specific item job type.",
|
||||
"type": "object"
|
||||
},
|
||||
"owner": {
|
||||
"description": "The user identity that created this schedule or last modified.",
|
||||
"description": "The user identity that created this schedule or last modified it.",
|
||||
"$ref": "../../common/definitions.json#/definitions/Principal"
|
||||
}
|
||||
}
|
||||
@@ -2586,6 +2590,10 @@
|
||||
"configuration": {
|
||||
"description": "The actual data contains the time/weekdays of this schedule.",
|
||||
"$ref": "#/definitions/ScheduleConfig"
|
||||
},
|
||||
"executionData": {
|
||||
"description": "The execution data for a scheduled job. This is fixed static data, defined by the specific item job type.",
|
||||
"type": "object"
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -2601,6 +2609,10 @@
|
||||
"configuration": {
|
||||
"description": "The actual data contains the time/weekdays of this schedule.",
|
||||
"$ref": "#/definitions/ScheduleConfig"
|
||||
},
|
||||
"executionData": {
|
||||
"description": "The execution data for a scheduled job. This is fixed static data, defined by the specific item job type.",
|
||||
"type": "object"
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -2897,7 +2909,7 @@
|
||||
"enum": [
|
||||
"DiagnosticLogs"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"x-ms-enum": {
|
||||
"name": "ImmutabilityScope",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
@@ -2907,6 +2919,91 @@
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"UpdateItemIdentityRequest": {
|
||||
"description": "Associate identity request payload.",
|
||||
"required": [ "assignmentType" ],
|
||||
"properties": {
|
||||
"assignmentType": {
|
||||
"description": "The type of subject that makes an associaste identity request.",
|
||||
"$ref": "#/definitions/IdentityAssignmentType",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"IdentityAssignmentType": {
|
||||
"description": "Specifies the type of identity for an associate identity request. Additional identity assignment types may be added over time.",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"Caller"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "IdentityAssignmentEntityType",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "Caller",
|
||||
"description": "User or service principal who makes the associate identity request."
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"UpdateItemIdentityResponse": {
|
||||
"description": "Associate identity response.",
|
||||
"required": [ "assignmentStatus" ],
|
||||
"properties": {
|
||||
"assignmentStatus": {
|
||||
"description": "The identity assigned to the item after update.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/ItemAssignmentStatus"
|
||||
},
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"ItemAssignmentStatus": {
|
||||
"description": "The status of an identity assignment to an item.",
|
||||
"type": "object",
|
||||
"required": [ "itemId", "status" ],
|
||||
"properties": {
|
||||
"itemId": {
|
||||
"description": "The ID of the item.",
|
||||
"type": "string",
|
||||
"format": "uuid"
|
||||
},
|
||||
"status": {
|
||||
"description": "The status of the identity assignment. Additional status may be added over time.",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"Succeeded",
|
||||
"Failed"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "IdentityAssignmentStatusType",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "Succeeded",
|
||||
"description": "The identity is successfully assigned to the item."
|
||||
},
|
||||
{
|
||||
"value": "Failed",
|
||||
"description": "The identity assignment failed."
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"parentItemId": {
|
||||
"description": "The ID of the parent item.",
|
||||
"type": "string",
|
||||
"format": "uuid"
|
||||
},
|
||||
"errorInfo": {
|
||||
"description": "The error information if the identity assignment failed.",
|
||||
"$ref": "../../common/definitions.json#/definitions/ErrorResponseDetails"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,20 @@
|
||||
{
|
||||
"parameters": {
|
||||
"connectionId": "a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"status": "Online",
|
||||
"errors": []
|
||||
}
|
||||
},
|
||||
"202": {
|
||||
"headers": {
|
||||
"Location": "https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef",
|
||||
"x-ms-operation-id": "427f6c34-b64e-4ee4-8ea5-b533c0e203ef",
|
||||
"Retry-After": 30
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,25 @@
|
||||
{
|
||||
"parameters": {
|
||||
"connectionId": "a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"status": "Offline",
|
||||
"errors": [
|
||||
{
|
||||
"message": "Error response with StatusCode: BadRequest, ErrorCode: GatewayNotFound, ErrorMessage: 'GatewayContainer does not exist'",
|
||||
"errorCode": "DM_GWPipeline_UnknownError"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"202": {
|
||||
"headers": {
|
||||
"Location": "https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef",
|
||||
"x-ms-operation-id": "427f6c34-b64e-4ee4-8ea5-b533c0e203ef",
|
||||
"Retry-After": 30
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,52 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "12345678-1234-1234-1234-123456789abc",
|
||||
"itemId": "87654321-4321-4321-4321-abcdef123456",
|
||||
"jobType": "DefaultJob",
|
||||
"createScheduleRequest": {
|
||||
"enabled": true,
|
||||
"configuration": {
|
||||
"startDateTime": "2024-04-28T00:00:00",
|
||||
"endDateTime": "2024-04-30T23:59:00",
|
||||
"localTimeZoneId": "Central Standard Time",
|
||||
"type": "Daily",
|
||||
"times": ["09:00", "15:00"]
|
||||
},
|
||||
"executionData": {
|
||||
"tableName": "Table1",
|
||||
"optimizeSettings": {
|
||||
"vOrder": true
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"201": {
|
||||
"headers": {
|
||||
"Location": "https://api.fabric.microsoft.com/v1/workspaces/12345678-1234-1234-1234-123456789abc/items/87654321-4321-4321-4321-abcdef123456/jobs/DefaultJob/schedules/11111111-2222-3333-4444-555555555555"
|
||||
},
|
||||
"body": {
|
||||
"id": "11111111-2222-3333-4444-555555555555",
|
||||
"enabled": true,
|
||||
"createdDateTime": "2024-04-28T05:35:20.5366667",
|
||||
"configuration": {
|
||||
"startDateTime": "2024-04-28T00:00:00",
|
||||
"endDateTime": "2024-04-30T23:59:00",
|
||||
"localTimeZoneId": "Central Standard Time",
|
||||
"type": "Daily",
|
||||
"times": ["09:00", "15:00"]
|
||||
},
|
||||
"executionData": {
|
||||
"tableName": "Table1",
|
||||
"optimizeSettings": {
|
||||
"vOrder": true
|
||||
}
|
||||
},
|
||||
"owner": {
|
||||
"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
|
||||
"type": "User"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,35 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "12345678-1234-1234-1234-123456789abc",
|
||||
"itemId": "87654321-4321-4321-4321-abcdef123456",
|
||||
"scheduleId": "11111111-2222-3333-4444-555555555555",
|
||||
"jobType": "DefaultJob"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"id": "11111111-2222-3333-4444-555555555555",
|
||||
"enabled": true,
|
||||
"createdDateTime": "2024-04-28T05:35:20.5366667",
|
||||
"configuration": {
|
||||
"startDateTime": "2024-04-28T00:00:00",
|
||||
"endDateTime": "2024-04-30T23:59:00",
|
||||
"localTimeZoneId": "Central Standard Time",
|
||||
"type": "Weekly",
|
||||
"times": ["10:00", "16:00"],
|
||||
"weekdays": ["Monday", "Wednesday", "Friday"]
|
||||
},
|
||||
"executionData": {
|
||||
"tableName": "Table2",
|
||||
"optimizeSettings": {
|
||||
"vOrder": false
|
||||
}
|
||||
},
|
||||
"owner": {
|
||||
"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
|
||||
"type": "User"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,26 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "0c7ac00e-7b1a-4b7f-ac0f-95636b0c6081",
|
||||
"itemId": "56f028cd-fa09-46e6-b9b6-82b14185216d",
|
||||
"include": "DefaultIdentity"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"displayName": "Item 1",
|
||||
"description": "Item 1 description",
|
||||
"type": "Lakehouse",
|
||||
"workspaceId": "0c7ac00e-7b1a-4b7f-ac0f-95636b0c6081",
|
||||
"id": "56f028cd-fa09-46e6-b9b6-82b14185216d",
|
||||
"defaultIdentity": {
|
||||
"id": "ce44af2b-7f4b-4975-979b-4d4d8c43c117",
|
||||
"displayName": "Caleb Foster",
|
||||
"type": "User",
|
||||
"userDetails": {
|
||||
"userPrincipalName": "caleb@example.com"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,48 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
|
||||
"rootFolderId": "bbbbbbbb-1111-2222-3333-cccccccccccc",
|
||||
"include": "DefaultIdentity"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body":
|
||||
{
|
||||
"value": [
|
||||
{
|
||||
"id": "cccccccc-2222-3333-4444-dddddddddddd",
|
||||
"displayName": "Lakehouse",
|
||||
"description": "A lakehouse used by the sales team.",
|
||||
"type": "Lakehouse",
|
||||
"workspaceId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
|
||||
"folderId": "bbbbbbbb-1111-2222-3333-cccccccccccc",
|
||||
"defaultIdentity": {
|
||||
"id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
|
||||
"displayName": "Caleb Foster",
|
||||
"type": "User",
|
||||
"userDetails": {
|
||||
"userPrincipalName": "caleb@example.com"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "dddddddd-3333-4444-5555-eeeeeeeeeeee",
|
||||
"displayName": "Notebook",
|
||||
"description": "A notebook for refining Q1 of year 2024 sales data analysis through machine learning algorithms.",
|
||||
"type": "Notebook",
|
||||
"workspaceId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
|
||||
"folderId": "cccccccc-8888-9999-0000-dddddddddddd",
|
||||
"defaultIdentity": {
|
||||
"id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
|
||||
"displayName": "Caleb Foster",
|
||||
"type": "User",
|
||||
"userDetails": {
|
||||
"userPrincipalName": "caleb@example.com"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,43 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"itemId": "5b218778-e7a5-4d73-8187-f10824047715",
|
||||
"beta": true,
|
||||
"updateItemIdentityRequest": {
|
||||
"assignmentType" : "Caller"
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"assignmentStatus": [
|
||||
{
|
||||
"itemId": "eab1679a-8cab-40d6-9ba6-5c2a07a7ce81",
|
||||
"status": "Succeeded"
|
||||
},
|
||||
{
|
||||
"itemId": "8eedb1b0-3af8-4b17-8e7e-663e61e12211",
|
||||
"parentItemId": "eab1679a-8cab-40d6-9ba6-5c2a07a7ce81",
|
||||
"status": "Succeeded"
|
||||
},
|
||||
{
|
||||
"itemId": "83b128a3-f58f-4eee-ab0b-e7e25a748f54",
|
||||
"parentItemId": "eab1679a-8cab-40d6-9ba6-5c2a07a7ce81",
|
||||
"status": "Failed",
|
||||
"errorInfo": {
|
||||
"errorCode": "AssignmentFailed",
|
||||
"message": "The assignment operation failed due to insufficient permissions."
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"202": {
|
||||
"headers": {
|
||||
"Location": "https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef",
|
||||
"x-ms-operation-id": "427f6c34-b64e-4ee4-8ea5-b533c0e203ef",
|
||||
"Retry-After": 30
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,52 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "12345678-1234-1234-1234-123456789abc",
|
||||
"itemId": "87654321-4321-4321-4321-abcdef123456",
|
||||
"scheduleId": "11111111-2222-3333-4444-555555555555",
|
||||
"jobType": "DefaultJob",
|
||||
"updateScheduleRequest": {
|
||||
"enabled": true,
|
||||
"configuration": {
|
||||
"startDateTime": "2024-04-28T00:00:00",
|
||||
"endDateTime": "2024-04-30T23:59:00",
|
||||
"localTimeZoneId": "Central Standard Time",
|
||||
"type": "Weekly",
|
||||
"times": ["10:00", "16:00"],
|
||||
"weekdays": ["Monday", "Wednesday", "Friday"]
|
||||
},
|
||||
"executionData": {
|
||||
"tableName": "Table2",
|
||||
"optimizeSettings": {
|
||||
"vOrder": false
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"id": "11111111-2222-3333-4444-555555555555",
|
||||
"enabled": true,
|
||||
"createdDateTime": "2024-04-28T05:35:20.5366667",
|
||||
"configuration": {
|
||||
"startDateTime": "2024-04-28T00:00:00",
|
||||
"endDateTime": "2024-04-30T23:59:00",
|
||||
"localTimeZoneId": "Central Standard Time",
|
||||
"type": "Weekly",
|
||||
"times": ["10:00", "16:00"],
|
||||
"weekdays": ["Monday", "Wednesday", "Friday"]
|
||||
},
|
||||
"executionData": {
|
||||
"tableName": "Table2",
|
||||
"optimizeSettings": {
|
||||
"vOrder": false
|
||||
}
|
||||
},
|
||||
"owner": {
|
||||
"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
|
||||
"type": "User"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -714,6 +714,30 @@
|
||||
"description": "A token for retrieving the next page of results.",
|
||||
"type": "string",
|
||||
"required": false
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "include",
|
||||
"description": "Specifies which item properties to include in the response as a comma-separated list. Additional values may be added over time.",
|
||||
"type": "array",
|
||||
"collectionFormat": "csv",
|
||||
"items": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"DefaultIdentity"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "ItemIncludeOption",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "DefaultIdentity",
|
||||
"description": "Includes the default identity"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": false
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
@@ -761,6 +785,9 @@
|
||||
},
|
||||
"List items in workspace with continuation example": {
|
||||
"$ref": "./examples/platform/ListItemsInWorkspaceWithContinuation.json"
|
||||
},
|
||||
"List items with include option example": {
|
||||
"$ref": "./examples/platform/ListItemsWithDefaultIdentity.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -882,6 +909,30 @@
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "include",
|
||||
"description": "Specifies which item properties to include in the response as a comma-separated list. Additional values may be added over time.",
|
||||
"type": "array",
|
||||
"collectionFormat": "csv",
|
||||
"items": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"DefaultIdentity"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "ItemIncludeOption",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "DefaultIdentity",
|
||||
"description": "Includes the default identity"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": false
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
@@ -914,6 +965,9 @@
|
||||
"x-ms-examples": {
|
||||
"Get an item example": {
|
||||
"$ref": "./examples/platform/GetItem.json"
|
||||
},
|
||||
"Get an item with include default Identity option example": {
|
||||
"$ref": "./examples/platform/GetItemWithDefaultIdentity.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -1589,6 +1643,9 @@
|
||||
"x-ms-examples": {
|
||||
"create item schedule example": {
|
||||
"$ref": "./examples/platform/CreateItemSchedule.json"
|
||||
},
|
||||
"create item schedule with execution data example": {
|
||||
"$ref": "./examples/platform/CreateItemScheduleWithExecutionData.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1667,6 +1724,9 @@
|
||||
"x-ms-examples": {
|
||||
"get item schedule example": {
|
||||
"$ref": "./examples/platform/GetItemSchedule.json"
|
||||
},
|
||||
"get item schedule with execution data example": {
|
||||
"$ref": "./examples/platform/GetItemScheduleWithExecutionData.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -1752,6 +1812,9 @@
|
||||
"x-ms-examples": {
|
||||
"update item schedule plan example": {
|
||||
"$ref": "./examples/platform/UpdateItemSchedule.json"
|
||||
},
|
||||
"update item schedule with execution data example": {
|
||||
"$ref": "./examples/platform/UpdateItemScheduleWithExecutionData.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -7955,6 +8018,86 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/connections/{connectionId}/testConnection": {
|
||||
"post": {
|
||||
"summary": "Tests the connection.",
|
||||
"description": "Provides the status of the specified connection.\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n**Required permissions**: Permission to read the connection, or admin permission for the gateway that hosts the connection.\n**Required scopes**: Connection.Read.All or Connection.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": [
|
||||
"Connections"
|
||||
],
|
||||
"operationId": "Connections_TestConnection",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"x-ms-fabric-sdk-long-running-operation": true,
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "connectionId",
|
||||
"description": "The ID of the connection.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK. The Status of the connection has been fetched.",
|
||||
"schema": {
|
||||
"$ref": "./definitions/connections.json#/definitions/ConnectionStatusResponse"
|
||||
}
|
||||
},
|
||||
"202": {
|
||||
"description": "Request accepted, fetching the status of the connection.",
|
||||
"headers": {
|
||||
"Location": {
|
||||
"description": "The URL of the operation status which tracks 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."
|
||||
}
|
||||
}
|
||||
},
|
||||
"429": {
|
||||
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
||||
"x-ms-error-response": true,
|
||||
"headers": {
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
},
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* EntityNotFound - The requested resource could not be found.\n\n* InsufficientPermissionsToManageConnection - The caller has insufficient permissions to manage this connection.\n\n* IncorrectCredentials - Failed to establish connection using the Credentials input.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"OnlineExample": {
|
||||
"$ref": "./examples/connections/TestConnection.json"
|
||||
},
|
||||
"OfflineExample": {
|
||||
"$ref": "./examples/connections/TestConnectionOffline.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/connections/supportedConnectionTypes": {
|
||||
"get": {
|
||||
"summary": "Lists supported connection types.",
|
||||
@@ -9742,9 +9885,103 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/items/{itemId}/identities/default/assign?beta=true": {
|
||||
"post": {
|
||||
"summary": "Associates the default identity with an item.",
|
||||
"description": "> [!NOTE]\n> This API is part of a Beta release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n**When calling this API, callers must specify `true` as the value for the query parameter `beta`.**\n\n This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n This API is supported for a number of item types, find the supported item types and information about their definition structure in [Item management overview](/rest/api/fabric/articles/item-management/item-management-overview).\n\n## Permissions\n\n The caller must have *read and write* permissions for the item.\n\n## Required Delegated Scopes\n\n For item APIs use these scope types: \n- Generic scope: Item.ReadWrite.All \n- Specific scope: *itemType*.ReadWrite.All (for example: Notebook.ReadWrite.All) \n\n for more information about scopes, see: [scopes article](/rest/api/fabric/articles/scopes).\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) | When the item type in the call is supported. Check the corresponding API for the item type you're calling, to see if your call is supported.|\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_Associate_Identity_(beta)",
|
||||
"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": "itemId",
|
||||
"description": "The item ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "body",
|
||||
"name": "updateItemIdentityRequest",
|
||||
"description": "Associate identity request payload.",
|
||||
"schema": {
|
||||
"$ref": "./definitions/platform.json#/definitions/UpdateItemIdentityRequest"
|
||||
},
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"name": "beta",
|
||||
"in": "query",
|
||||
"required": true,
|
||||
"type": "boolean",
|
||||
"description": "This required parameter must be set to `true` to access this API, which is currently in beta."
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions/platform.json#/definitions/UpdateItemIdentityResponse"
|
||||
}
|
||||
},
|
||||
"202": {
|
||||
"description": "Request accepted, identity association is in progress.",
|
||||
"headers": {
|
||||
"Location": {
|
||||
"type": "string",
|
||||
"description": "The URL to the job instance resource"
|
||||
},
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request"
|
||||
}
|
||||
}
|
||||
},
|
||||
"429": {
|
||||
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
||||
"x-ms-error-response": true,
|
||||
"headers": {
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
},
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* ItemNotFound - The requested item was not found.\n\n* InvalidRequest - Invalid association request.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Associate identity example": {
|
||||
"$ref": "./examples/platform/UpdateItemIdentity.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {},
|
||||
"security": [],
|
||||
"tags": []
|
||||
}
|
||||
|
||||
Reference in new issue
Block a user