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
9d7c3c28ba
commit
674af7d85d
50 files changed
+3896
-116
No files matched your search
+13
-1
@@ -263,7 +263,7 @@
|
||||
"ItemType": {
|
||||
"description": "The type of the item. Additional item types may be added over time.",
|
||||
"type": "string",
|
||||
"enum": [ "Dashboard", "Report", "SemanticModel", "PaginatedReport", "Datamart", "Lakehouse", "Eventhouse", "Environment", "KQLDatabase", "KQLQueryset", "KQLDashboard", "DataPipeline", "Notebook", "SparkJobDefinition", "MLExperiment", "MLModel", "Warehouse", "Eventstream", "SQLEndpoint", "MirroredWarehouse", "MirroredDatabase", "Reflex", "GraphQLApi", "MountedDataFactory", "SQLDatabase", "CopyJob", "VariableLibrary", "Dataflow", "ApacheAirflowJob", "WarehouseSnapshot", "DigitalTwinBuilder", "DigitalTwinBuilderFlow", "MirroredAzureDatabricksCatalog", "Map", "AnomalyDetector", "UserDataFunction", "GraphModel", "GraphQuerySet", "SnowflakeDatabase", "OperationsAgent", "CosmosDBDatabase", "Ontology", "EventSchemaSet", "DataAgent", "MirroredCatalog", "AppBackend" ],
|
||||
"enum": [ "Dashboard", "Report", "SemanticModel", "PaginatedReport", "Datamart", "Lakehouse", "Eventhouse", "Environment", "KQLDatabase", "KQLQueryset", "KQLDashboard", "DataPipeline", "Notebook", "SparkJobDefinition", "MLExperiment", "MLModel", "Warehouse", "Eventstream", "SQLEndpoint", "MirroredWarehouse", "MirroredDatabase", "Reflex", "GraphQLApi", "MountedDataFactory", "SQLDatabase", "CopyJob", "VariableLibrary", "Dataflow", "ApacheAirflowJob", "WarehouseSnapshot", "DigitalTwinBuilder", "DigitalTwinBuilderFlow", "MirroredAzureDatabricksCatalog", "Map", "AnomalyDetector", "UserDataFunction", "GraphModel", "GraphQuerySet", "SnowflakeDatabase", "OperationsAgent", "CosmosDBDatabase", "Ontology", "EventSchemaSet", "DataAgent", "MirroredCatalog", "AppBackend", "OrgApp", "OrgAppAudience", "DataBuildToolJob" ],
|
||||
"x-ms-enum": {
|
||||
"name": "ItemType",
|
||||
"modelAsString": true,
|
||||
@@ -451,6 +451,18 @@
|
||||
{
|
||||
"value": "AppBackend",
|
||||
"description": "An AppBackend."
|
||||
},
|
||||
{
|
||||
"value": "OrgApp",
|
||||
"description": "An Org App."
|
||||
},
|
||||
{
|
||||
"value": "OrgAppAudience",
|
||||
"description": "An Org App Audience."
|
||||
},
|
||||
{
|
||||
"value": "DataBuildToolJob",
|
||||
"description": "A DataBuildToolJob."
|
||||
}
|
||||
]
|
||||
},
|
||||
|
||||
@@ -408,6 +408,82 @@
|
||||
"$ref": "./definitions.json#/definitions/Principal"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ItemJobParameterType": {
|
||||
"description": "A string that represents the parameter's type. Additional types may be added over time.",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"VariableReference",
|
||||
"Integer",
|
||||
"Number",
|
||||
"Text",
|
||||
"Boolean",
|
||||
"DateTime",
|
||||
"Guid",
|
||||
"Automatic"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "ItemJobParameterType",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "VariableReference",
|
||||
"description": "The type of parameter is a variable reference."
|
||||
},
|
||||
{
|
||||
"value": "Integer",
|
||||
"description": "The type of parameter is an integer."
|
||||
},
|
||||
{
|
||||
"value": "Number",
|
||||
"description": "The type of parameter is a number, it accepts both integer and float values."
|
||||
},
|
||||
{
|
||||
"value": "Text",
|
||||
"description": "The type of parameter is a text."
|
||||
},
|
||||
{
|
||||
"value": "Boolean",
|
||||
"description": "The type of parameter is a boolean."
|
||||
},
|
||||
{
|
||||
"value": "DateTime",
|
||||
"description": "The type of parameter is a datetime in UTC, using the YYYY-MM-DDTHH:mm:ssZ format."
|
||||
},
|
||||
{
|
||||
"value": "Guid",
|
||||
"description": "The parameter type is a string representation of a GUID, using 00000000-0000-0000-0000-000000000000 format. See https://learn.microsoft.com/dotnet/api/system.guid.tostring for formatting details, and please use the default format: \"D\"."
|
||||
},
|
||||
{
|
||||
"value": "Automatic",
|
||||
"description": "The parameter type is automatically determined. Note: this type may not be supported for all item job types."
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"Parameter": {
|
||||
"description": "An item job parameter.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"name",
|
||||
"type",
|
||||
"value"
|
||||
],
|
||||
"properties": {
|
||||
"name": {
|
||||
"description": "The parameter name, specified by the caller, must be unique (case-insensitive check) and no longer than 256 characters.",
|
||||
"type": "string"
|
||||
},
|
||||
"type": {
|
||||
"description": "The parameter type.",
|
||||
"type": "string",
|
||||
"$ref": "#/definitions/ItemJobParameterType"
|
||||
},
|
||||
"value": {
|
||||
"description": "The parameter value based on the parameter type.",
|
||||
"type": "object"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -141,6 +141,33 @@
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"CopyJobEntityResetPayload": {
|
||||
"description": "A list of CopyJobEntities to reset.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"resetAllCopyJobEntities": {
|
||||
"description": "Whether to reset all CopyJob entities.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"copyJobEntitiesToReset": {
|
||||
"description": "A list of CopyJob entities to reset.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/CopyJobEntityReset"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"CopyJobEntityReset": {
|
||||
"description": "The Id of a CopyJobEntity to reset.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"copyJobEntityId": {
|
||||
"type": "string",
|
||||
"format": "uuid"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,12 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"copyJobId": "5b218778-e7a5-4d73-8187-f10824047715",
|
||||
"resetCopyJobRequest": {
|
||||
"resetAllCopyJobEntities": true
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,20 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"copyJobId": "5b218778-e7a5-4d73-8187-f10824047715",
|
||||
"resetCopyJobRequest": {
|
||||
"resetAllCopyJobEntities": false,
|
||||
"copyJobEntitiesToReset": [
|
||||
{
|
||||
"copyJobEntityId": "b1b04262-1a57-412b-8b92-117832e4dad0"
|
||||
},
|
||||
{
|
||||
"copyJobEntityId": "7351d4be-fc32-4799-a6a4-f2b9572e1674"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {}
|
||||
}
|
||||
}
|
||||
@@ -564,6 +564,81 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/copyJobs/{copyJobId}/resetCopyJob": {
|
||||
"post": {
|
||||
"summary": "Resets the specified CopyJob.",
|
||||
"description": "Resets the specified CopyJob. If `resetAllCopyJobEntities` is true, all entities are reset. Otherwise, only the specified entities are reset.\n\n## Permissions\n\n The caller must have *contributor* 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_ResetCopyJob",
|
||||
"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": "resetCopyJobRequest",
|
||||
"description": "The CopyJobReset payload.",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/CopyJobEntityResetPayload"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully."
|
||||
},
|
||||
"429": {
|
||||
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
||||
"x-ms-error-response": true,
|
||||
"headers": {
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
},
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* 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": {
|
||||
"Reset all entities example": {
|
||||
"$ref": "./examples/ResetCopyJob_AllCopyJobEntities.json"
|
||||
},
|
||||
"Reset selected copyJobEntities example": {
|
||||
"$ref": "./examples/ResetCopyJob_SelectedCopyJobEntities.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {},
|
||||
|
||||
@@ -0,0 +1,194 @@
|
||||
{
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"title": "DataBuildToolJob data types",
|
||||
"version": "v1"
|
||||
},
|
||||
"paths": {},
|
||||
"definitions": {
|
||||
"DataBuildToolJob": {
|
||||
"description": "A DataBuildToolJob object.",
|
||||
"type": "object",
|
||||
"required": ["type"],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "../common/definitions.json#/definitions/Item"
|
||||
}
|
||||
],
|
||||
"properties": {
|
||||
"properties": {
|
||||
"description": "The DataBuildToolJob properties.",
|
||||
"$ref": "#/definitions/DataBuildToolJobProperties"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DataBuildToolJobProperties": {
|
||||
"description": "The DataBuildToolJob properties.",
|
||||
"type": "object",
|
||||
"required": ["oneLakeRootPath"],
|
||||
"properties": {
|
||||
"oneLakeRootPath": {
|
||||
"description": "OneLake path to the DataBuildToolJob root directory.",
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DataBuildToolJobs": {
|
||||
"description": "A list of DataBuildToolJobs.",
|
||||
"required": ["value"],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"value": {
|
||||
"description": "A list of DataBuildToolJobs.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/DataBuildToolJob"
|
||||
}
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
|
||||
}
|
||||
]
|
||||
},
|
||||
"CreateDataBuildToolJobRequest": {
|
||||
"description": "The request payload for creating a DataBuildToolJob.",
|
||||
"required": ["displayName"],
|
||||
"properties": {
|
||||
"displayName": {
|
||||
"description": "The DataBuildToolJob display name. The display name must follow naming rules according to item type.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"description": {
|
||||
"description": "The DataBuildToolJob description. Maximum length is 256 characters.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"folderId": {
|
||||
"description": "The folder ID. If not specified or null, the DataBuildToolJob is created with the workspace as its folder.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"readOnly": false
|
||||
},
|
||||
"definition": {
|
||||
"description": "The DataBuildToolJob public definition.",
|
||||
"$ref": "#/definitions/DataBuildToolJobPublicDefinition",
|
||||
"readOnly": false
|
||||
},
|
||||
"sensitivityLabelSettings": {
|
||||
"description": "The sensitivity label settings for the DataBuildToolJob.",
|
||||
"$ref": "../common/definitions.json#/definitions/SensitivityLabelSettings",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateDataBuildToolJobDefinitionRequest": {
|
||||
"description": "The request payload for updating a DataBuildToolJob public definition.",
|
||||
"required": ["definition"],
|
||||
"properties": {
|
||||
"definition": {
|
||||
"$ref": "#/definitions/DataBuildToolJobPublicDefinition"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DataBuildToolJobDefinitionResponse": {
|
||||
"description": "The response payload for a DataBuildToolJob public definition.",
|
||||
"required": ["definition"],
|
||||
"properties": {
|
||||
"definition": {
|
||||
"$ref": "#/definitions/DataBuildToolJobPublicDefinition",
|
||||
"readOnly": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"DataBuildToolJobPublicDefinition" : {
|
||||
"description": "The DataBuildToolJob public definition object. Refer to this [article](/rest/api/fabric/articles/item-management/definitions/data-build-tool-job-definition) for more details on the structure of the DataBuildToolJob definition.",
|
||||
"type": "object",
|
||||
"required": ["parts"],
|
||||
"properties": {
|
||||
"format": {
|
||||
"description": "The format of the DataBuildToolJob definition. Additional formats may be added over time.",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"DataBuildToolJobV1"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "DataBuildToolJobDefinitionFormat",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "DataBuildToolJobV1",
|
||||
"description": "The format for DataBuildToolJob definitions, designed to support CI/CD scenarios in Fabric. See [DataBuildToolJob - DataBuildToolJobV1 specification](/rest/api/fabric/articles/item-management/definitions/data-build-tool-job-definition) for more details."
|
||||
}
|
||||
]
|
||||
},
|
||||
"readOnly": false
|
||||
},
|
||||
"parts": {
|
||||
"description": "A list of definition parts.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/DataBuildToolJobPublicDefinitionPart"
|
||||
},
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"DataBuildToolJobPublicDefinitionPart": {
|
||||
"description": "The DataBuildToolJob definition part object.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"path": {
|
||||
"description": "The DataBuildToolJob public definition part path.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"payload": {
|
||||
"description": "The DataBuildToolJob public definition part payload.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"payloadType":{
|
||||
"description": "The payload type.",
|
||||
"$ref": "../common/definitions.json#/definitions/PayloadType",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateDataBuildToolJobRequest": {
|
||||
"description": "The request payload for updating a DataBuildToolJob.",
|
||||
"properties": {
|
||||
"displayName": {
|
||||
"description": "The DataBuildToolJob display name. The display name must follow naming rules according to item type.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"description": {
|
||||
"description": "The DataBuildToolJob description. Maximum length is 256 characters.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"DataBuildToolJobExecuteSchedule": {
|
||||
"description": "DataBuildToolJob execute schedule.",
|
||||
"type": "object",
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "../common/job_scheduling.json#/definitions/BaseItemSchedule"
|
||||
}
|
||||
]
|
||||
},
|
||||
"CreateDataBuildToolJobExecuteScheduleRequest": {
|
||||
"description": "Create DataBuildToolJob execute schedule plan request payload.",
|
||||
"type": "object",
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "../common/job_scheduling.json#/definitions/BaseCreateScheduleRequest"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,42 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"createDataBuildToolJobRequest": {
|
||||
"displayName": "DataBuildToolJob 1",
|
||||
"description": "A DataBuildToolJob description.",
|
||||
"definition": {
|
||||
"format": "DataBuildToolJobV1",
|
||||
"parts": [
|
||||
{
|
||||
"path": "DataBuildToolJobV1.json",
|
||||
"payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
|
||||
"payloadType": "InlineBase64"
|
||||
},
|
||||
{
|
||||
"path": ".platform",
|
||||
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
|
||||
"payloadType": "InlineBase64"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"201": {
|
||||
"body": {
|
||||
"displayName": "DataBuildToolJob 1",
|
||||
"description": "A DataBuildToolJob description.",
|
||||
"type": "DataBuildToolJob",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"id": "5b218778-e7a5-4d73-8187-f10824047715"
|
||||
}
|
||||
},
|
||||
"202": {
|
||||
"headers": {
|
||||
"Location": "https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6",
|
||||
"x-ms-operation-id": "0acd697c-1550-43cd-b998-91bfbfbd47c6",
|
||||
"Retry-After": 30
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,39 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "4b218778-e7a5-4d73-8187-f10824047715",
|
||||
"dataBuildToolJobId": "431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
|
||||
"createScheduleRequest": {
|
||||
"enabled": true,
|
||||
"configuration": {
|
||||
"startDateTime": "2026-03-28T00:00:00",
|
||||
"endDateTime": "2026-03-30T23:59:00",
|
||||
"localTimeZoneId": "Central Standard Time",
|
||||
"type": "Cron",
|
||||
"interval": 10
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"201": {
|
||||
"headers": {
|
||||
"Location": "https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/items/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7/jobs/Execute/schedules/bbbbbbbb-1111-2222-3333-cccccccccccc"
|
||||
},
|
||||
"body": {
|
||||
"id": "bbbbbbbb-1111-2222-3333-cccccccccccc",
|
||||
"enabled": true,
|
||||
"createdDateTime": "2024-05-28T05:35:20.5366667",
|
||||
"configuration": {
|
||||
"startDateTime": "2026-03-28T00:00:00",
|
||||
"endDateTime": "2026-03-30T23:59:00",
|
||||
"localTimeZoneId": "Central Standard Time",
|
||||
"type": "Cron",
|
||||
"interval": 10
|
||||
},
|
||||
"owner": {
|
||||
"id": "33dd33dd-ee44-ff55-aa66-77bb77bb77bb",
|
||||
"type": "User"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,27 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"createDataBuildToolJobRequest": {
|
||||
"displayName": "DataBuildToolJob 1",
|
||||
"description": "A DataBuildToolJob description."
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"201": {
|
||||
"body": {
|
||||
"displayName": "DataBuildToolJob 1",
|
||||
"description": "A DataBuildToolJob description.",
|
||||
"type": "DataBuildToolJob",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"id": "5b218778-e7a5-4d73-8187-f10824047715"
|
||||
}
|
||||
},
|
||||
"202": {
|
||||
"headers": {
|
||||
"Location": "https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6",
|
||||
"x-ms-operation-id": "0acd697c-1550-43cd-b998-91bfbfbd47c6",
|
||||
"Retry-After": 30
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"dataBuildToolJobId": "5b218778-e7a5-4d73-8187-f10824047715"
|
||||
},
|
||||
"responses": {
|
||||
"200": {}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,20 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
|
||||
"dataBuildToolJobId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"id": "5b218778-e7a5-4d73-8187-f10824047715",
|
||||
"displayName": "DataBuildToolJob 1",
|
||||
"description": "A DataBuildToolJob description.",
|
||||
"type": "DataBuildToolJob",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"properties": {
|
||||
"oneLakeRootPath": "https://onelake.dfs.fabric.microsoft.com/f089354e-8366-4e18-aea3-4cb4a3a50b48/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,33 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "6e335e92-a2a2-4b5a-970a-bd6a89fbb765",
|
||||
"dataBuildToolJobId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"definition": {
|
||||
"parts": [
|
||||
{
|
||||
"path": "DataBuildToolJobV1.json",
|
||||
"payload": "ew0KICAiZXhlY3V0YW..OWRmNDhhY2ZmZTgifQ",
|
||||
"payloadType": "InlineBase64"
|
||||
},
|
||||
{
|
||||
"path": ".platform",
|
||||
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
|
||||
"payloadType": "InlineBase64"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"202": {
|
||||
"headers": {
|
||||
"Location": "https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
|
||||
"x-ms-operation-id": "431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
|
||||
"Retry-After": 30
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,33 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"value": [
|
||||
{
|
||||
"id": "3546052c-ae64-4526-b1a8-52af7761426f",
|
||||
"displayName": "DataBuildToolJob Name 1",
|
||||
"description": "A DataBuildToolJob description.",
|
||||
"type": "DataBuildToolJob",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"properties": {
|
||||
"oneLakeRootPath": "https://onelake.dfs.fabric.microsoft.com/f089354e-8366-4e18-aea3-4cb4a3a50b48/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "f697fb63-abd4-4399-9548-be7e3c3c0dac",
|
||||
"displayName": "DataBuildToolJob Name 2",
|
||||
"description": "A DataBuildToolJob description.",
|
||||
"type": "DataBuildToolJob",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"properties": {
|
||||
"oneLakeRootPath": "https://onelake.dfs.fabric.microsoft.com/f089354e-8366-4e18-aea3-4cb4a3a50b48/d8f6cf16-3aac-4440-9d76-a03d86b7ae3e"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,14 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "4b218778-e7a5-4d73-8187-f10824047715",
|
||||
"dataBuildToolJobId": "431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7"
|
||||
},
|
||||
"responses": {
|
||||
"202": {
|
||||
"headers": {
|
||||
"Location": "https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/dataBuildToolJobs/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7/jobs/execute/instances/f2d65699-dd22-4889-980c-15226deb0e1b",
|
||||
"Retry-After": 60
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,21 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"dataBuildToolJobId": "5b218778-e7a5-4d73-8187-f10824047715",
|
||||
"updateDataBuildToolJobRequest": {
|
||||
"displayName": "DataBuildToolJob's New name",
|
||||
"description": "DataBuildToolJob's New description"
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"displayName": "DataBuildToolJob's New name",
|
||||
"description": "DataBuildToolJob's New description",
|
||||
"type": "DataBuildToolJob",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"id": "5b218778-e7a5-4d73-8187-f10824047715"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,34 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"dataBuildToolJobId": "5b218778-e7a5-4d73-8187-f10824047715",
|
||||
"updateMetadata" : true,
|
||||
"updateDataBuildToolJobDefinitionRequest": {
|
||||
"definition": {
|
||||
"parts": [
|
||||
{
|
||||
"path": "DataBuildToolJobV1.json",
|
||||
"payload": "ew0KICAiZXhlY3V0YW..OWRmNDhhY2ZmZTgifQ==",
|
||||
"payloadType": "InlineBase64"
|
||||
},
|
||||
{
|
||||
"path": ".platform",
|
||||
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
|
||||
"payloadType": "InlineBase64"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
},
|
||||
"202": {
|
||||
"headers": {
|
||||
"Location": "https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef",
|
||||
"x-ms-operation-id": "427f6c34-b64e-4ee4-8ea5-b533c0e203ef",
|
||||
"Retry-After": 30
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,694 @@
|
||||
{
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"title": "DataBuildToolJob REST APIs",
|
||||
"version": "v1"
|
||||
},
|
||||
"schemes": [
|
||||
"https"
|
||||
],
|
||||
"host": "api.fabric.microsoft.com",
|
||||
"basePath": "/v1",
|
||||
"paths": {
|
||||
"/workspaces/{workspaceId}/dataBuildToolJobs": {
|
||||
"get": {
|
||||
"summary": "Returns a list of DataBuildToolJobs from the specified workspace.",
|
||||
"description": "> [!NOTE]\n> DataBuildToolJob item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\nThe caller must have a *viewer* workspace role.\n\n## Required Delegated Scopes\n\nWorkspace.Read.All or Workspace.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_ListDataBuildToolJobs",
|
||||
"x-ms-pageable": {
|
||||
"nextLinkName": "continuationUri"
|
||||
},
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "workspaceId",
|
||||
"description": "The workspace ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "recursive",
|
||||
"description": "Lists items in a folder and its nested folders, or just a folder only. True - All items in the folder and its nested folders are listed, False - Only items in the folder are listed. The default value is true.",
|
||||
"type": "boolean",
|
||||
"required": false
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "rootFolderId",
|
||||
"description": "This parameter allows users to filter items based on a specific root folder. If not provided, the workspace is used as the root folder.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": false
|
||||
},
|
||||
{
|
||||
"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/DataBuildToolJobs"
|
||||
}
|
||||
},
|
||||
"429": {
|
||||
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
||||
"x-ms-error-response": true,
|
||||
"headers": {
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
},
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* InvalidItemType - Invalid item type.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"List DataBuildToolJobs in workspace example": {
|
||||
"$ref": "./examples/ListDataBuildToolJobsInWorkspace.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"post": {
|
||||
"summary": "Creates a DataBuildToolJob in the specified workspace.",
|
||||
"description": "> [!NOTE]\n> DataBuildToolJob item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nTo create a DataBuildToolJob with a definition, refer to [DataBuildToolJob](/rest/api/fabric/articles/item-management/definitions/data-build-tool-job-definition) article.\n\n## Permissions\n\nThe caller must have a *contributor* workspace role.\n\n## Required Delegated Scopes\n\nItem.ReadWrite.All\n\n## Limitations\n\n- To create a DataBuildToolJob, 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_CreateDataBuildToolJob",
|
||||
"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": "createDataBuildToolJobRequest",
|
||||
"description": "Create item request payload.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/CreateDataBuildToolJobRequest"
|
||||
},
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"201": {
|
||||
"description": "Successfully created",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/DataBuildToolJob"
|
||||
}
|
||||
},
|
||||
"202": {
|
||||
"description": "Request accepted, DataBuildToolJob provisioning in progress.",
|
||||
"headers": {
|
||||
"Location": {
|
||||
"description": "The URL of the operation status, which can be used to track the operation state.",
|
||||
"type": "string"
|
||||
},
|
||||
"x-ms-operation-id": {
|
||||
"description": "The operation ID which can be used with long running operations (LRO) APIs to track the operation state and get the result.",
|
||||
"type": "string",
|
||||
"format": "uuid"
|
||||
},
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
}
|
||||
},
|
||||
"429": {
|
||||
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
||||
"x-ms-error-response": true,
|
||||
"headers": {
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
},
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* InvalidItemType - Item type is invalid\n\n* ItemDisplayNameAlreadyInUse - Item display name is already used.\n\n* CorruptedPayload - The provided payload is corrupted.\n\n* WorkspaceItemsLimitExceeded - Workspace item limit exceeded.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Create a DataBuildToolJob example": {
|
||||
"$ref": "./examples/CreateDataBuildToolJobWithoutDefinition.json"
|
||||
},
|
||||
"Create a DataBuildToolJob with definition example": {
|
||||
"$ref": "./examples/CreateDataBuildToolJob.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/dataBuildToolJobs/{dataBuildToolJobId}": {
|
||||
"get": {
|
||||
"summary": "Returns properties of the specified DataBuildToolJob.",
|
||||
"description": "> [!NOTE]\n> DataBuildToolJob item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\n## Permissions\n\nThe caller must have *read* permissions for the DataBuildToolJob.\n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_GetDataBuildToolJob",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "workspaceId",
|
||||
"description": "The workspace ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "dataBuildToolJobId",
|
||||
"description": "The DataBuildToolJob ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/DataBuildToolJob"
|
||||
}
|
||||
},
|
||||
"429": {
|
||||
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
||||
"x-ms-error-response": true,
|
||||
"headers": {
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
},
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* ItemNotFound - The requested item was not found.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Get a DataBuildToolJob example": {
|
||||
"$ref": "./examples/GetDataBuildToolJob.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"patch": {
|
||||
"summary": "Updates the properties of the specified DataBuildToolJob.",
|
||||
"description": "> [!NOTE]\n> DataBuildToolJob item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\n## Permissions\n\nThe caller must have *read and write* permissions for the DataBuildToolJob.\n\n## Required Delegated Scopes\n\nItem.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_UpdateDataBuildToolJob",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "workspaceId",
|
||||
"description": "The workspace ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "dataBuildToolJobId",
|
||||
"description": "The DataBuildToolJob ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "body",
|
||||
"name": "updateDataBuildToolJobRequest",
|
||||
"description": "Update request payload.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/UpdateDataBuildToolJobRequest"
|
||||
},
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/DataBuildToolJob"
|
||||
}
|
||||
},
|
||||
"429": {
|
||||
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
||||
"x-ms-error-response": true,
|
||||
"headers": {
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
},
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* ItemNotFound - The requested item was not found. \n\n* InvalidRequest - Invalid update request.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Update a DataBuildToolJob example": {
|
||||
"$ref": "./examples/UpdateDataBuildToolJob.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Deletes the specified DataBuildToolJob.",
|
||||
"description": "> [!NOTE]\n> DataBuildToolJob item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\n## Permissions\n\nThe caller must have *write* permissions for the DataBuildToolJob.\n\n## Required Delegated Scopes\n\nItem.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_DeleteDataBuildToolJob",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "workspaceId",
|
||||
"description": "The workspace ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "dataBuildToolJobId",
|
||||
"description": "The DataBuildToolJob ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully."
|
||||
},
|
||||
"429": {
|
||||
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
||||
"x-ms-error-response": true,
|
||||
"headers": {
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
},
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* ItemNotFound - The requested item was not found.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Delete a DataBuildToolJob example": {
|
||||
"$ref": "./examples/DeleteDataBuildToolJob.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/dataBuildToolJobs/{dataBuildToolJobId}/getDefinition": {
|
||||
"post": {
|
||||
"summary": "Returns the specified DataBuildToolJob public definition.",
|
||||
"description": "> [!NOTE]\n> DataBuildToolJob item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a DataBuildToolJob's definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\nThe caller must have *read and write* permissions for the DataBuildToolJob.\n\n## Required Delegated Scopes\n\nItem.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_GetDataBuildToolJobDefinition",
|
||||
"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": "dataBuildToolJobId",
|
||||
"description": "The DataBuildToolJob ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "format",
|
||||
"description": "The format of the DataBuildToolJob definition.",
|
||||
"type": "string",
|
||||
"required": false
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/DataBuildToolJobDefinitionResponse"
|
||||
}
|
||||
},
|
||||
"202": {
|
||||
"description": "Request accepted. Retrieving the definition is in progress.",
|
||||
"headers": {
|
||||
"Location": {
|
||||
"description": "The URL of the operation status, which can be used to track the operation state.",
|
||||
"type": "string"
|
||||
},
|
||||
"x-ms-operation-id": {
|
||||
"description": "The operation ID which can be used with long running operations (LRO) APIs to track the operation state and get the result.",
|
||||
"type": "string",
|
||||
"format": "uuid"
|
||||
},
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
}
|
||||
},
|
||||
"429": {
|
||||
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
||||
"x-ms-error-response": true,
|
||||
"headers": {
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
},
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* OperationNotSupportedForItem - Operation not supported for requested item.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Get a DataBuildToolJob definition example": {
|
||||
"$ref": "./examples/GetDataBuildToolJobDefinition.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/dataBuildToolJobs/{dataBuildToolJobId}/updateDefinition": {
|
||||
"post": {
|
||||
"summary": "Overrides the definition for the specified DataBuildToolJob.",
|
||||
"description": "> [!NOTE]\n> DataBuildToolJob item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nUpdating the DataBuildToolJob's definition, does not affect its sensitivity label.\n\n## Permissions\n\nThe caller must have *read and write* permissions for the DataBuildToolJob.\n\n## Required Delegated Scopes\n\nItem.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_UpdateDataBuildToolJobDefinition",
|
||||
"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": "dataBuildToolJobId",
|
||||
"description": "The DataBuildToolJob 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": "updateDataBuildToolJobDefinitionRequest",
|
||||
"description": "Update definition request payload.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/UpdateDataBuildToolJobDefinitionRequest"
|
||||
},
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully."
|
||||
},
|
||||
"202": {
|
||||
"description": "Request accepted. Update definition is in progress.",
|
||||
"headers": {
|
||||
"Location": {
|
||||
"description": "The URL of the operation status, which can be used to track the operation state.",
|
||||
"type": "string"
|
||||
},
|
||||
"x-ms-operation-id": {
|
||||
"description": "The operation ID which can be used with long running operations (LRO) APIs to track the operation state and get the result.",
|
||||
"type": "string",
|
||||
"format": "uuid"
|
||||
},
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
}
|
||||
},
|
||||
"429": {
|
||||
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
||||
"x-ms-error-response": true,
|
||||
"headers": {
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
},
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* OperationNotSupportedForItem - Operation not supported for requested item. \n\n* CorruptedPayload - The provided payload is corrupted.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Update a DataBuildToolJob definition example": {
|
||||
"$ref": "./examples/UpdateDataBuildToolJobDefinition.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/dataBuildToolJobs/{dataBuildToolJobId}/jobs/execute/instances": {
|
||||
"post": {
|
||||
"summary": "Run on-demand DataBuildToolJob execute job instance.",
|
||||
"description": "> [!NOTE]\n> DataBuildToolJob item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\n## Permissions\n\n- The caller must have a *member* or higher workspace role.\n\n## Required Delegated Scopes\n\nItem.Execute.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": [
|
||||
"BackgroundJobs"
|
||||
],
|
||||
"operationId": "BackgroundJobs_RunOnDemandExecute",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "workspaceId",
|
||||
"description": "The workspace ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "dataBuildToolJobId",
|
||||
"description": "The DataBuildToolJob item ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"202": {
|
||||
"description": "Request accepted, job execution is in progress.\n\n---\n**Headers:**\n\n**Location** `string` - The URL to the job instance resource.\n\n**Retry-After** `integer` - The number of seconds the client should wait before polling the job status for the first time. Clients must use this value to determine when to check the job status and should wait at least this many seconds before the first status poll."
|
||||
},
|
||||
"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* MissingMinimalPermissions - The caller does not have sufficient permissions to run job instance. \n\n* InvalidJobType - The requested job type is invalid. \n\n* TooManyRequestsForJobs - The caller is making too many run on-demand job requests. \n\n* ItemNotFound - Requested item id not found.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Run DataBuildToolJob execute job instance example": {
|
||||
"$ref": "./examples/RunOnDemandDataBuildToolJobNoBody.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/dataBuildToolJobs/{dataBuildToolJobId}/jobs/execute/schedules": {
|
||||
"post": {
|
||||
"summary": "Create a new execute schedule for a DataBuildToolJob.",
|
||||
"description": "> [!NOTE]\n> DataBuildToolJob item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\n## Permissions\n\n- The caller must have a *member* or higher workspace role.\n\n## Required Delegated Scopes\n\nItem.Execute.All and Item.ReadWrite.All\n\n## Limitations\n\nA DataBuildToolJob can create maximum 20 schedules.\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": [
|
||||
"BackgroundJobs"
|
||||
],
|
||||
"operationId": "BackgroundJobs_ScheduleDataBuildToolJob",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "workspaceId",
|
||||
"description": "The workspace ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "dataBuildToolJobId",
|
||||
"description": "The DataBuildToolJob ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "body",
|
||||
"name": "createScheduleRequest",
|
||||
"description": "A DataBuildToolJob execute schedule create request.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/CreateDataBuildToolJobExecuteScheduleRequest"
|
||||
},
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"201": {
|
||||
"description": "Successfully created the schedule.\n\n---\n**Headers:**\n\n**Location** `string` - The URL of the newly created schedule.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/DataBuildToolJobExecuteSchedule"
|
||||
}
|
||||
},
|
||||
"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* InsufficientPrivileges - The caller does not have sufficient permissions to access the item\n\n* ItemNotFound - Requested item id not found\n\n* ScheduleExceedsLimit - The number of created schedules for the item exceeds the limit",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Create DataBuildToolJob Execute schedule example": {
|
||||
"$ref": "./examples/CreateDataBuildToolJobExecuteSchedule.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {},
|
||||
"security": [],
|
||||
"tags": []
|
||||
}
|
||||
@@ -207,11 +207,45 @@
|
||||
"description": "A list of parameters to override during execution.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "../platform/definitions/platform.json#/definitions/ItemJobParameter"
|
||||
"$ref": "#/definitions/ItemJobParameter"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"ItemJobParameter": {
|
||||
"description": "Parameter details.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"parameterName",
|
||||
"type",
|
||||
"value"
|
||||
],
|
||||
"properties": {
|
||||
"parameterName": {
|
||||
"description": "Name of the parameter.",
|
||||
"type": "string"
|
||||
},
|
||||
"type": {
|
||||
"description": "The parameter type. Additional parameter types may be added over time.",
|
||||
"type": "string",
|
||||
"enum": [ "Automatic" ],
|
||||
"x-ms-enum": {
|
||||
"name": "Type",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "Automatic",
|
||||
"description": "Value must be Automatic"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"value": {
|
||||
"description": "The value of the parameter to override during execution.",
|
||||
"type": "object"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ExecuteQueryRequest": {
|
||||
"description": "Request payload for executing a query against a dataflow.",
|
||||
"type": "object",
|
||||
|
||||
@@ -929,7 +929,7 @@
|
||||
"/workspaces/{workspaceId}/dataflows/{dataflowId}/executeQuery": {
|
||||
"post": {
|
||||
"summary": "Executes a query against a dataflow and returns the result.",
|
||||
"description": "Executes a specified query against a dataflow and streams the results in Apache Arrow format. Supports using custom mashup documents for advanced scenarios.\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\n The caller must have *execute* permissions for the dataflow.\n\n## Required Delegated Scopes\n\nDataflow.Execute.All or Item.Execute.All.\n\n## Limitations\n\nQueries can run for a maximum of 90 seconds.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"description": "Executes a specified query against a dataflow and streams the results in the format specified by the `Accept` header. The default format is Apache Arrow. Supports using custom mashup documents for advanced scenarios.\n\nUse the `Accept` header to control the response format:\n- `application/vnd.apache.arrow.stream;pq.arrow.version=1` (default), `application/vnd.apache.arrow.stream;pq.arrow.version=2` — Apache Arrow streaming format.\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\nThe caller must have *execute* permissions for the dataflow.\n\n## Required Delegated Scopes\n\nDataflow.Execute.All or Item.Execute.All.\n\n## Limitations\n\nQueries can run for a maximum of 90 seconds.\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": [
|
||||
"QueryExecution"
|
||||
],
|
||||
@@ -958,6 +958,13 @@
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "header",
|
||||
"name": "Accept",
|
||||
"description": "The desired media type of the response. Currently supported values: `application/vnd.apache.arrow.stream;pq.arrow.version=1` (default), `application/vnd.apache.arrow.stream;pq.arrow.version=2`.",
|
||||
"required": false,
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"in": "body",
|
||||
"name": "executeQueryRequest",
|
||||
@@ -970,7 +977,7 @@
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Query result was succesfully written. Results are streamed in Apache Arrow format. Refer to the [Arrow documentation](https://arrow.apache.org/docs/python/ipc.html#reading-from-stream-and-file-format-for-pandas) on how to read the stream in Python and other languages. \n\nErrors encountered during query execution or during streaming will be in an additional column at the end named 'PQ Arrow Metadata'. \n\nMedia Type: \"application/vnd.apache.arrow.stream\"",
|
||||
"description": "Query result was successfully streamed. The response format depends on the `Accept` header:\n\n* **application/vnd.apache.arrow.stream;pq.arrow.version=1** (default), **application/vnd.apache.arrow.stream;pq.arrow.version=2** — Results are streamed in Apache Arrow format. Refer to the [Arrow documentation](https://arrow.apache.org/docs/python/ipc.html#reading-from-stream-and-file-format-for-pandas) on how to read the stream in Python and other languages.\n\nFor both Arrow versions, errors encountered during query execution or streaming will be in an additional column named 'PQ Arrow Metadata'.",
|
||||
"schema": {
|
||||
"type": "file"
|
||||
}
|
||||
|
||||
@@ -166,7 +166,7 @@
|
||||
"description": "The parameter list for run on-demand job request. Per-run, user-defined inputs to tailor this invocation. Note: parameter names are case-insensitive, but the casing must match the parameter name used in the code cell.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "../platform/definitions/platform.json#/definitions/Parameter"
|
||||
"$ref": "../common/job_scheduling.json#/definitions/Parameter"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,190 @@
|
||||
{
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"title": "OrgApp data types",
|
||||
"version": "v1"
|
||||
},
|
||||
"paths": {},
|
||||
"definitions": {
|
||||
"OrgApp": {
|
||||
"description": "An OrgApp object.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"type"
|
||||
],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "../common/definitions.json#/definitions/Item"
|
||||
}
|
||||
],
|
||||
"properties": {
|
||||
"properties": {
|
||||
"description": "The OrgApp properties.",
|
||||
"$ref": "#/definitions/OrgAppProperties"
|
||||
}
|
||||
}
|
||||
},
|
||||
"OrgAppProperties": {
|
||||
"description": "The OrgApp properties.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"oneLakeRootPath"
|
||||
],
|
||||
"properties": {
|
||||
"oneLakeRootPath": {
|
||||
"description": "OneLake path to the OrgApp root directory.",
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"OrgApps": {
|
||||
"description": "A list of OrgApps.",
|
||||
"required": [
|
||||
"value"
|
||||
],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"value": {
|
||||
"description": "The list of OrgApps.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/OrgApp"
|
||||
}
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
|
||||
}
|
||||
]
|
||||
},
|
||||
"CreateOrgAppRequest": {
|
||||
"description": "Create OrgApp request payload.",
|
||||
"required": [
|
||||
"displayName"
|
||||
],
|
||||
"properties": {
|
||||
"displayName": {
|
||||
"description": "The OrgApp display name. The display name must follow naming rules according to item type.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"description": {
|
||||
"description": "The OrgApp description. Maximum length is 256 characters.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"folderId": {
|
||||
"description": "The folder ID. If not specified or null, the OrgApp is created with the workspace as its folder.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"readOnly": false
|
||||
},
|
||||
"definition": {
|
||||
"description": "The OrgApp public definition.",
|
||||
"$ref": "#/definitions/OrgAppPublicDefinition",
|
||||
"readOnly": false
|
||||
},
|
||||
"sensitivityLabelSettings": {
|
||||
"description": "The sensitivity label settings for the OrgApp.",
|
||||
"$ref": "../common/definitions.json#/definitions/SensitivityLabelSettings",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateOrgAppDefinitionRequest": {
|
||||
"description": "Update OrgApp public definition request payload.",
|
||||
"required": [
|
||||
"definition"
|
||||
],
|
||||
"properties": {
|
||||
"definition": {
|
||||
"$ref": "#/definitions/OrgAppPublicDefinition"
|
||||
}
|
||||
}
|
||||
},
|
||||
"OrgAppDefinitionResponse": {
|
||||
"description": "OrgApp public definition response.",
|
||||
"required": [
|
||||
"definition"
|
||||
],
|
||||
"properties": {
|
||||
"definition": {
|
||||
"$ref": "#/definitions/OrgAppPublicDefinition",
|
||||
"readOnly": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"OrgAppPublicDefinition": {
|
||||
"description": "OrgApp public definition object. Refer to this [article](/rest/api/fabric/articles/item-management/definitions/org-app-definition) for more details on the structure of the OrgApp definition.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"parts"
|
||||
],
|
||||
"properties": {
|
||||
"format": {
|
||||
"description": "The format of the item definition. Additional `format` types may be added over time.",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"OrgAppV1"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "OrgAppDefinitionFormat",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "OrgAppV1",
|
||||
"description": "The V1 JSON format for the OrgApp public definition, specifically designed to support CI/CD scenarios in Fabric. See [OrgApp - OrgAppV1 specification](/rest/api/fabric/articles/item-management/definitions/org-app-definition/OrgAppV1) for more details."
|
||||
}
|
||||
]
|
||||
},
|
||||
"readOnly": false
|
||||
},
|
||||
"parts": {
|
||||
"description": "A list of definition parts.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/OrgAppPublicDefinitionPart"
|
||||
},
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"OrgAppPublicDefinitionPart": {
|
||||
"description": "OrgApp definition part object.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"path": {
|
||||
"description": "The OrgApp public definition part path.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"payload": {
|
||||
"description": "The OrgApp public definition part payload.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"payloadType": {
|
||||
"description": "The payload type.",
|
||||
"$ref": "../common/definitions.json#/definitions/PayloadType",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateOrgAppRequest": {
|
||||
"description": "Update OrgApp request.",
|
||||
"properties": {
|
||||
"displayName": {
|
||||
"description": "The OrgApp display name. The display name must follow naming rules according to item type.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"description": {
|
||||
"description": "The OrgApp description. Maximum length is 256 characters.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,41 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"createOrgAppRequest": {
|
||||
"displayName": "OrgApp 1",
|
||||
"description": "A OrgApp description.",
|
||||
"definition": {
|
||||
"parts": [
|
||||
{
|
||||
"path": "OrgAppV1.json",
|
||||
"payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
|
||||
"payloadType": "InlineBase64"
|
||||
},
|
||||
{
|
||||
"path": ".platform",
|
||||
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
|
||||
"payloadType": "InlineBase64"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"201": {
|
||||
"body": {
|
||||
"displayName": "OrgApp 1",
|
||||
"description": "A OrgApp description.",
|
||||
"type": "OrgApp",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"id": "5b218778-e7a5-4d73-8187-f10824047715"
|
||||
}
|
||||
},
|
||||
"202": {
|
||||
"headers": {
|
||||
"Location": "https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6",
|
||||
"x-ms-operation-id": "0acd697c-1550-43cd-b998-91bfbfbd47c6",
|
||||
"Retry-After": 30
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,27 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"createOrgAppRequest": {
|
||||
"displayName": "OrgApp 1",
|
||||
"description": "A OrgApp description."
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"201": {
|
||||
"body": {
|
||||
"displayName": "OrgApp 1",
|
||||
"description": "A OrgApp description.",
|
||||
"type": "OrgApp",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"id": "5b218778-e7a5-4d73-8187-f10824047715"
|
||||
}
|
||||
},
|
||||
"202": {
|
||||
"headers": {
|
||||
"Location": "https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6",
|
||||
"x-ms-operation-id": "0acd697c-1550-43cd-b998-91bfbfbd47c6",
|
||||
"Retry-After": 30
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"orgAppId": "5b218778-e7a5-4d73-8187-f10824047715"
|
||||
},
|
||||
"responses": {
|
||||
"200": {}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,20 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
|
||||
"orgAppId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"id": "5b218778-e7a5-4d73-8187-f10824047715",
|
||||
"displayName": "OrgApp 1",
|
||||
"description": "A OrgApp description.",
|
||||
"type": "OrgApp",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"sensitivityLabel": {
|
||||
"id": "9fbde396-1a24-4c79-8edf-9254a0f35055"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,33 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "6e335e92-a2a2-4b5a-970a-bd6a89fbb765",
|
||||
"orgAppId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"definition": {
|
||||
"parts": [
|
||||
{
|
||||
"path": "OrgAppV1.json",
|
||||
"payload": "ew0KICAiZXhlY3V0YW..OWRmNDhhY2ZmZTgifQ",
|
||||
"payloadType": "InlineBase64"
|
||||
},
|
||||
{
|
||||
"path": ".platform",
|
||||
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
|
||||
"payloadType": "InlineBase64"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"202": {
|
||||
"headers": {
|
||||
"Location": "https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
|
||||
"x-ms-operation-id": "431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
|
||||
"Retry-After": 30
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,33 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"value": [
|
||||
{
|
||||
"id": "3546052c-ae64-4526-b1a8-52af7761426f",
|
||||
"displayName": "OrgApp Name 1",
|
||||
"description": "A OrgApp description.",
|
||||
"type": "OrgApp",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"sensitivityLabel": {
|
||||
"id": "9fbde396-1a24-4c79-8edf-9254a0f35055"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "f697fb63-abd4-4399-9548-be7e3c3c0dac",
|
||||
"displayName": "OrgApp Name 2",
|
||||
"description": "A OrgApp description.",
|
||||
"type": "OrgApp",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"sensitivityLabel": {
|
||||
"id": "9fbde396-1a24-4c79-8edf-9254a0f35055"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,21 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"orgAppId": "5b218778-e7a5-4d73-8187-f10824047715",
|
||||
"updateOrgAppRequest": {
|
||||
"displayName": "OrgApp's New name",
|
||||
"description": "OrgApp's New description"
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"displayName": "OrgApp's New name",
|
||||
"description": "OrgApp's New description",
|
||||
"type": "OrgApp",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"id": "5b218778-e7a5-4d73-8187-f10824047715"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,33 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"orgAppId": "5b218778-e7a5-4d73-8187-f10824047715",
|
||||
"updateMetadata": true,
|
||||
"updateOrgAppDefinitionRequest": {
|
||||
"definition": {
|
||||
"parts": [
|
||||
{
|
||||
"path": "OrgAppV1.json",
|
||||
"payload": "ew0KICAiZXhlY3V0YW..OWRmNDhhY2ZmZTgifQ==",
|
||||
"payloadType": "InlineBase64"
|
||||
},
|
||||
{
|
||||
"path": ".platform",
|
||||
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
|
||||
"payloadType": "InlineBase64"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {},
|
||||
"202": {
|
||||
"headers": {
|
||||
"Location": "https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef",
|
||||
"x-ms-operation-id": "427f6c34-b64e-4ee4-8ea5-b533c0e203ef",
|
||||
"Retry-After": 30
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,575 @@
|
||||
{
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"title": "OrgApp REST APIs",
|
||||
"version": "v1"
|
||||
},
|
||||
"schemes": [
|
||||
"https"
|
||||
],
|
||||
"host": "api.fabric.microsoft.com",
|
||||
"basePath": "/v1",
|
||||
"paths": {
|
||||
"/workspaces/{workspaceId}/orgApps": {
|
||||
"get": {
|
||||
"summary": "Returns a list of OrgApps from the specified workspace.",
|
||||
"description": "This API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\n The caller must have a *viewer* workspace role. \n\n## Required Delegated Scopes\n\nWorkspace.Read.All or Workspace.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_ListOrgApps",
|
||||
"x-ms-pageable": {
|
||||
"nextLinkName": "continuationUri"
|
||||
},
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "workspaceId",
|
||||
"description": "The workspace ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "recursive",
|
||||
"description": "Lists items in a folder and its nested folders, or just a folder only. True - All items in the folder and its nested folders are listed, False - Only items in the folder are listed. The default value is true.",
|
||||
"type": "boolean",
|
||||
"required": false
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "rootFolderId",
|
||||
"description": "This parameter allows users to filter items based on a specific root folder. If not provided, the workspace is used as the root folder.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": false
|
||||
},
|
||||
{
|
||||
"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/OrgApps"
|
||||
}
|
||||
},
|
||||
"429": {
|
||||
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
||||
"x-ms-error-response": true,
|
||||
"headers": {
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
},
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* InvalidItemType - Invalid item type.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"List OrgApps in workspace example": {
|
||||
"$ref": "./examples/ListOrgAppsInWorkspace.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"post": {
|
||||
"summary": "Creates an OrgApp in the specified workspace.",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n To create an OrgApp with a public definition, refer to [OrgApp](/rest/api/fabric/articles/item-management/definitions/org-app-definition) article. \n\n ## Permissions \n The caller must have a *contributor* workspace role. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All \n\n## Limitations \n- To create an OrgApp, the user must have the appropriate license. For more information see: [Microsoft Fabric license types](/fabric/enterprise/licenses#microsoft-fabric-license-types).\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_CreateOrgApp",
|
||||
"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": "createOrgAppRequest",
|
||||
"description": "Create item request payload.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/CreateOrgAppRequest"
|
||||
},
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"201": {
|
||||
"description": "Successfully created",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/OrgApp"
|
||||
}
|
||||
},
|
||||
"202": {
|
||||
"description": "Request accepted, OrgApp provisioning in progress.",
|
||||
"headers": {
|
||||
"Location": {
|
||||
"description": "The URL of the operation status, which can be used to track the operation state.",
|
||||
"type": "string"
|
||||
},
|
||||
"x-ms-operation-id": {
|
||||
"description": "The operation ID which can be used with long running operations (LRO) APIs to track the operation state and get the result.",
|
||||
"type": "string",
|
||||
"format": "uuid"
|
||||
},
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
}
|
||||
},
|
||||
"429": {
|
||||
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
||||
"x-ms-error-response": true,
|
||||
"headers": {
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
},
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* InvalidItemType - Item type is invalid\n\n* ItemDisplayNameAlreadyInUse - Item display name is already used.\n\n* CorruptedPayload - The provided payload is corrupted.\n\n* WorkspaceItemsLimitExceeded - Workspace item limit exceeded.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Create an OrgApp example": {
|
||||
"$ref": "./examples/CreateOrgAppWithoutDefinition.json"
|
||||
},
|
||||
"Create an OrgApp with public definition example": {
|
||||
"$ref": "./examples/CreateOrgApp.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/orgApps/{orgAppId}": {
|
||||
"get": {
|
||||
"summary": "Returns properties of the specified OrgApp.",
|
||||
"description": "## Permissions\n\n The caller must have *read* permissions for the OrgApp. \n\n## Required Delegated Scopes\n\n Item.Read.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_GetOrgApp",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "workspaceId",
|
||||
"description": "The workspace ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "orgAppId",
|
||||
"description": "The OrgApp ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/OrgApp"
|
||||
}
|
||||
},
|
||||
"429": {
|
||||
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
||||
"x-ms-error-response": true,
|
||||
"headers": {
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
},
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* ItemNotFound - The requested item was not found.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Get an OrgApp example": {
|
||||
"$ref": "./examples/GetOrgApp.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"patch": {
|
||||
"summary": "Updates the properties of the specified OrgApp.",
|
||||
"description": "## Permissions\n\n The caller must have *read and write* permissions for the OrgApp.\n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_UpdateOrgApp",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "workspaceId",
|
||||
"description": "The workspace ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "orgAppId",
|
||||
"description": "The OrgApp ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "body",
|
||||
"name": "updateOrgAppRequest",
|
||||
"description": "Update OrgApp request payload.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/UpdateOrgAppRequest"
|
||||
},
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/OrgApp"
|
||||
}
|
||||
},
|
||||
"429": {
|
||||
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
||||
"x-ms-error-response": true,
|
||||
"headers": {
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
},
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* ItemNotFound - The requested item was not found. \n\n* InvalidRequest - Invalid update request.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Update an OrgApp example": {
|
||||
"$ref": "./examples/UpdateOrgApp.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Deletes the specified OrgApp.",
|
||||
"description": "## Permissions\n\n The caller must have *write* permissions for the OrgApp. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_DeleteOrgApp",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "workspaceId",
|
||||
"description": "The workspace ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "orgAppId",
|
||||
"description": "The OrgApp ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully."
|
||||
},
|
||||
"429": {
|
||||
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
||||
"x-ms-error-response": true,
|
||||
"headers": {
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
},
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* ItemNotFound - The requested item was not found.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Delete an OrgApp example": {
|
||||
"$ref": "./examples/DeleteOrgApp.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/orgApps/{orgAppId}/getDefinition": {
|
||||
"post": {
|
||||
"summary": "Returns the specified OrgApp public definition.",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get an OrgApp's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the OrgApp. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_GetOrgAppDefinition",
|
||||
"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": "orgAppId",
|
||||
"description": "The OrgApp ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "format",
|
||||
"description": "The format of the OrgApp public definition. Additional `format` types may be added over time.",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"OrgAppV1"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "OrgAppDefinitionFormat",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "OrgAppV1",
|
||||
"description": "Custom format for the OrgApp public definition, specifically designed to support CI/CD scenarios in Fabric. see [OrgApp - OrgAppV1 specification](/rest/api/fabric/articles/item-management/definitions/org-app/orgappv1) for more details."
|
||||
}
|
||||
]
|
||||
},
|
||||
"required": false
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/OrgAppDefinitionResponse"
|
||||
}
|
||||
},
|
||||
"202": {
|
||||
"description": "Request accepted. Retrieving the definition is in progress.",
|
||||
"headers": {
|
||||
"Location": {
|
||||
"description": "The URL of the operation status, which can be used to track the operation state.",
|
||||
"type": "string"
|
||||
},
|
||||
"x-ms-operation-id": {
|
||||
"description": "The operation ID which can be used with long running operations (LRO) APIs to track the operation state and get the result.",
|
||||
"type": "string",
|
||||
"format": "uuid"
|
||||
},
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
}
|
||||
},
|
||||
"429": {
|
||||
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
||||
"x-ms-error-response": true,
|
||||
"headers": {
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
},
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* OperationNotSupportedForItem - Operation not supported for requested item.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Get an OrgApp public definition example": {
|
||||
"$ref": "./examples/GetOrgAppDefinition.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/orgApps/{orgAppId}/updateDefinition": {
|
||||
"post": {
|
||||
"summary": "Overrides the definition for the specified OrgApp.",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n \nUpdating the OrgApp's definition, does not affect its sensitivity label. \n\n## Permissions\n\n The caller must have *read and write* permissions for the OrgApp. \n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_UpdateOrgAppDefinition",
|
||||
"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": "orgAppId",
|
||||
"description": "The OrgApp 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": "updateOrgAppDefinitionRequest",
|
||||
"description": "Update OrgApp definition request payload.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/UpdateOrgAppDefinitionRequest"
|
||||
},
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully."
|
||||
},
|
||||
"202": {
|
||||
"description": "Request accepted. Update definition is in progress.",
|
||||
"headers": {
|
||||
"Location": {
|
||||
"description": "The URL of the operation status, which can be used to track the operation state.",
|
||||
"type": "string"
|
||||
},
|
||||
"x-ms-operation-id": {
|
||||
"description": "The operation ID which can be used with long running operations (LRO) APIs to track the operation state and get the result.",
|
||||
"type": "string",
|
||||
"format": "uuid"
|
||||
},
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
}
|
||||
},
|
||||
"429": {
|
||||
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
||||
"x-ms-error-response": true,
|
||||
"headers": {
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
},
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* OperationNotSupportedForItem - Operation not supported for requested item. \n\n* CorruptedPayload - The provided payload is corrupted.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Update an OrgApp public definition example": {
|
||||
"$ref": "./examples/UpdateOrgAppDefinition.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {},
|
||||
"security": [],
|
||||
"tags": []
|
||||
}
|
||||
@@ -0,0 +1,192 @@
|
||||
{
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"title": "OrgAppAudience data types",
|
||||
"version": "v1"
|
||||
},
|
||||
"paths": {},
|
||||
"definitions": {
|
||||
"OrgAppAudience": {
|
||||
"description": "An OrgAppAudience object.",
|
||||
|
||||
"type": "object",
|
||||
"required": [
|
||||
"type"
|
||||
],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "../common/definitions.json#/definitions/Item"
|
||||
}
|
||||
],
|
||||
"properties": {
|
||||
"properties": {
|
||||
"description": "The OrgAppAudience properties.",
|
||||
"$ref": "#/definitions/OrgAppAudienceProperties"
|
||||
}
|
||||
}
|
||||
},
|
||||
"OrgAppAudienceProperties": {
|
||||
"description": "The OrgAppAudience properties.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"oneLakeRootPath"
|
||||
],
|
||||
"properties": {
|
||||
"oneLakeRootPath": {
|
||||
"description": "OneLake path to the OrgAppAudience root directory.",
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"OrgAppAudiences": {
|
||||
"description": "A list of OrgAppAudiences.",
|
||||
|
||||
"required": [
|
||||
"value"
|
||||
],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"value": {
|
||||
"description": "The list of OrgAppAudiences.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/OrgAppAudience"
|
||||
}
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
|
||||
}
|
||||
]
|
||||
},
|
||||
"CreateOrgAppAudienceRequest": {
|
||||
"description": "Create OrgAppAudience request payload.",
|
||||
"required": [
|
||||
"displayName"
|
||||
],
|
||||
"properties": {
|
||||
"displayName": {
|
||||
"description": "The OrgAppAudience display name. The display name must follow naming rules according to item type.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"description": {
|
||||
"description": "The OrgAppAudience description. Maximum length is 256 characters.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"folderId": {
|
||||
"description": "The folder ID. If not specified or null, the OrgAppAudience is created with the workspace as its folder.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"readOnly": false
|
||||
},
|
||||
"definition": {
|
||||
"description": "The OrgAppAudience public definition.",
|
||||
"$ref": "#/definitions/OrgAppAudiencePublicDefinition",
|
||||
"readOnly": false
|
||||
},
|
||||
"sensitivityLabelSettings": {
|
||||
"description": "The sensitivity label settings for the OrgAppAudience.",
|
||||
"$ref": "../common/definitions.json#/definitions/SensitivityLabelSettings",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateOrgAppAudienceDefinitionRequest": {
|
||||
"description": "Update OrgAppAudience public definition request payload.",
|
||||
"required": [
|
||||
"definition"
|
||||
],
|
||||
"properties": {
|
||||
"definition": {
|
||||
"$ref": "#/definitions/OrgAppAudiencePublicDefinition"
|
||||
}
|
||||
}
|
||||
},
|
||||
"OrgAppAudienceDefinitionResponse": {
|
||||
"description": "OrgAppAudience public definition response.",
|
||||
"required": [
|
||||
"definition"
|
||||
],
|
||||
"properties": {
|
||||
"definition": {
|
||||
"$ref": "#/definitions/OrgAppAudiencePublicDefinition",
|
||||
"readOnly": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"OrgAppAudiencePublicDefinition": {
|
||||
"description": "OrgAppAudience public definition object. Refer to this [article](/rest/api/fabric/articles/item-management/definitions/org-app-audience-definition) for more details on the structure of the OrgAppAudience definition.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"parts"
|
||||
],
|
||||
"properties": {
|
||||
"format": {
|
||||
"description": "The format of the item definition. Additional `format` types may be added over time.",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"OrgAppAudienceV1"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "OrgAppAudienceDefinitionFormat",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "OrgAppAudienceV1",
|
||||
"description": "The V1 JSON format for the OrgAppAudience public definition, specifically designed to support CI/CD scenarios in Fabric. See [OrgAppAudience - OrgAppAudienceV1 specification](/rest/api/fabric/articles/item-management/definitions/org-app-audience-definition/OrgAppAudienceV1) for more details."
|
||||
}
|
||||
]
|
||||
},
|
||||
"readOnly": false
|
||||
},
|
||||
"parts": {
|
||||
"description": "A list of definition parts.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/OrgAppAudiencePublicDefinitionPart"
|
||||
},
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"OrgAppAudiencePublicDefinitionPart": {
|
||||
"description": "OrgAppAudience definition part object.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"path": {
|
||||
"description": "The OrgAppAudience public definition part path.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"payload": {
|
||||
"description": "The OrgAppAudience public definition part payload.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"payloadType": {
|
||||
"description": "The payload type.",
|
||||
"$ref": "../common/definitions.json#/definitions/PayloadType",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateOrgAppAudienceRequest": {
|
||||
"description": "Update OrgAppAudience request.",
|
||||
"properties": {
|
||||
"displayName": {
|
||||
"description": "The OrgAppAudience display name. The display name must follow naming rules according to item type.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"description": {
|
||||
"description": "The OrgAppAudience description. Maximum length is 256 characters.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,42 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"createOrgAppAudienceRequest": {
|
||||
"displayName": "OrgAppAudience 1",
|
||||
"description": "A OrgAppAudience description.",
|
||||
"definition": {
|
||||
"format": "OrgAppAudienceV1",
|
||||
"parts": [
|
||||
{
|
||||
"path": "OrgAppAudienceV1.json",
|
||||
"payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
|
||||
"payloadType": "InlineBase64"
|
||||
},
|
||||
{
|
||||
"path": ".platform",
|
||||
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
|
||||
"payloadType": "InlineBase64"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"201": {
|
||||
"body": {
|
||||
"displayName": "OrgAppAudience 1",
|
||||
"description": "A OrgAppAudience description.",
|
||||
"type": "OrgAppAudience",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"id": "5b218778-e7a5-4d73-8187-f10824047715"
|
||||
}
|
||||
},
|
||||
"202": {
|
||||
"headers": {
|
||||
"Location": "https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6",
|
||||
"x-ms-operation-id": "0acd697c-1550-43cd-b998-91bfbfbd47c6",
|
||||
"Retry-After": 30
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,27 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"createOrgAppAudienceRequest": {
|
||||
"displayName": "OrgAppAudience 1",
|
||||
"description": "A OrgAppAudience description."
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"201": {
|
||||
"body": {
|
||||
"displayName": "OrgAppAudience 1",
|
||||
"description": "A OrgAppAudience description.",
|
||||
"type": "OrgAppAudience",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"id": "5b218778-e7a5-4d73-8187-f10824047715"
|
||||
}
|
||||
},
|
||||
"202": {
|
||||
"headers": {
|
||||
"Location": "https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6",
|
||||
"x-ms-operation-id": "0acd697c-1550-43cd-b998-91bfbfbd47c6",
|
||||
"Retry-After": 30
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"orgAppAudienceId": "5b218778-e7a5-4d73-8187-f10824047715"
|
||||
},
|
||||
"responses": {
|
||||
"200": {}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,20 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
|
||||
"orgAppAudienceId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"id": "5b218778-e7a5-4d73-8187-f10824047715",
|
||||
"displayName": "OrgAppAudience 1",
|
||||
"description": "A OrgAppAudience description.",
|
||||
"type": "OrgAppAudience",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"sensitivityLabel": {
|
||||
"id": "9fbde396-1a24-4c79-8edf-9254a0f35055"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,33 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "6e335e92-a2a2-4b5a-970a-bd6a89fbb765",
|
||||
"orgAppAudienceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"definition": {
|
||||
"parts": [
|
||||
{
|
||||
"path": "OrgAppAudienceV1.json",
|
||||
"payload": "ew0KICAiZXhlY3V0YW..OWRmNDhhY2ZmZTgifQ",
|
||||
"payloadType": "InlineBase64"
|
||||
},
|
||||
{
|
||||
"path": ".platform",
|
||||
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
|
||||
"payloadType": "InlineBase64"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"202": {
|
||||
"headers": {
|
||||
"Location": "https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
|
||||
"x-ms-operation-id": "431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
|
||||
"Retry-After": 30
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,33 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"value": [
|
||||
{
|
||||
"id": "3546052c-ae64-4526-b1a8-52af7761426f",
|
||||
"displayName": "OrgAppAudience Name 1",
|
||||
"description": "A OrgAppAudience description.",
|
||||
"type": "OrgAppAudience",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"sensitivityLabel": {
|
||||
"id": "9fbde396-1a24-4c79-8edf-9254a0f35055"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "f697fb63-abd4-4399-9548-be7e3c3c0dac",
|
||||
"displayName": "OrgAppAudience Name 2",
|
||||
"description": "A OrgAppAudience description.",
|
||||
"type": "OrgAppAudience",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"sensitivityLabel": {
|
||||
"id": "9fbde396-1a24-4c79-8edf-9254a0f35055"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,21 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"orgAppAudienceId": "5b218778-e7a5-4d73-8187-f10824047715",
|
||||
"updateOrgAppAudienceRequest": {
|
||||
"displayName": "OrgAppAudience's New name",
|
||||
"description": "OrgAppAudience's New description"
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"displayName": "OrgAppAudience's New name",
|
||||
"description": "OrgAppAudience's New description",
|
||||
"type": "OrgAppAudience",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"id": "5b218778-e7a5-4d73-8187-f10824047715"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,33 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"orgAppAudienceId": "5b218778-e7a5-4d73-8187-f10824047715",
|
||||
"updateMetadata": true,
|
||||
"updateOrgAppAudienceDefinitionRequest": {
|
||||
"definition": {
|
||||
"parts": [
|
||||
{
|
||||
"path": "OrgAppAudienceV1.json",
|
||||
"payload": "ew0KICAiZXhlY3V0YW..OWRmNDhhY2ZmZTgifQ==",
|
||||
"payloadType": "InlineBase64"
|
||||
},
|
||||
{
|
||||
"path": ".platform",
|
||||
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
|
||||
"payloadType": "InlineBase64"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {},
|
||||
"202": {
|
||||
"headers": {
|
||||
"Location": "https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef",
|
||||
"x-ms-operation-id": "427f6c34-b64e-4ee4-8ea5-b533c0e203ef",
|
||||
"Retry-After": 30
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,575 @@
|
||||
{
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"title": "OrgAppAudience REST APIs",
|
||||
"version": "v1"
|
||||
},
|
||||
"schemes": [
|
||||
"https"
|
||||
],
|
||||
"host": "api.fabric.microsoft.com",
|
||||
"basePath": "/v1",
|
||||
"paths": {
|
||||
"/workspaces/{workspaceId}/orgAppAudiences": {
|
||||
"get": {
|
||||
"summary": "Returns a list of OrgAppAudiences from the specified workspace.",
|
||||
"description": "This API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\n The caller must have a *viewer* workspace role. \n\n## Required Delegated Scopes\n\nWorkspace.Read.All or Workspace.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_ListOrgAppAudiences",
|
||||
"x-ms-pageable": {
|
||||
"nextLinkName": "continuationUri"
|
||||
},
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "workspaceId",
|
||||
"description": "The workspace ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "recursive",
|
||||
"description": "Lists items in a folder and its nested folders, or just a folder only. True - All items in the folder and its nested folders are listed, False - Only items in the folder are listed. The default value is true.",
|
||||
"type": "boolean",
|
||||
"required": false
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "rootFolderId",
|
||||
"description": "This parameter allows users to filter items based on a specific root folder. If not provided, the workspace is used as the root folder.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": false
|
||||
},
|
||||
{
|
||||
"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/OrgAppAudiences"
|
||||
}
|
||||
},
|
||||
"429": {
|
||||
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
||||
"x-ms-error-response": true,
|
||||
"headers": {
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
},
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* InvalidItemType - Invalid item type.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"List OrgAppAudiences in workspace example": {
|
||||
"$ref": "./examples/ListOrgAppAudiencesInWorkspace.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"post": {
|
||||
"summary": "Creates an OrgAppAudience in the specified workspace.",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n To create an OrgAppAudience with a public definition, refer to [OrgAppAudience](/rest/api/fabric/articles/item-management/definitions/org-app-audience-definition) article. \n\n ## Permissions \n The caller must have a *contributor* workspace role. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All \n\n## Limitations \n- To create an OrgAppAudience, the user must have the appropriate license. For more information see: [Microsoft Fabric license types](/fabric/enterprise/licenses#microsoft-fabric-license-types). \n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_CreateOrgAppAudience",
|
||||
"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": "createOrgAppAudienceRequest",
|
||||
"description": "Create item request payload.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/CreateOrgAppAudienceRequest"
|
||||
},
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"201": {
|
||||
"description": "Successfully created",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/OrgAppAudience"
|
||||
}
|
||||
},
|
||||
"202": {
|
||||
"description": "Request accepted, OrgAppAudience provisioning in progress.",
|
||||
"headers": {
|
||||
"Location": {
|
||||
"description": "The URL of the operation status, which can be used to track the operation state.",
|
||||
"type": "string"
|
||||
},
|
||||
"x-ms-operation-id": {
|
||||
"description": "The operation ID which can be used with long running operations (LRO) APIs to track the operation state and get the result.",
|
||||
"type": "string",
|
||||
"format": "uuid"
|
||||
},
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
}
|
||||
},
|
||||
"429": {
|
||||
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
||||
"x-ms-error-response": true,
|
||||
"headers": {
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
},
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* InvalidItemType - Item type is invalid\n\n* ItemDisplayNameAlreadyInUse - Item display name is already used.\n\n* CorruptedPayload - The provided payload is corrupted.\n\n* WorkspaceItemsLimitExceeded - Workspace item limit exceeded.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Create an OrgAppAudience example": {
|
||||
"$ref": "./examples/CreateOrgAppAudienceWithoutDefinition.json"
|
||||
},
|
||||
"Create an OrgAppAudience with public definition example": {
|
||||
"$ref": "./examples/CreateOrgAppAudience.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/orgAppAudiences/{orgAppAudienceId}": {
|
||||
"get": {
|
||||
"summary": "Returns properties of the specified OrgAppAudience.",
|
||||
"description": "## Permissions\n\n The caller must have *read* permissions for the OrgAppAudience. \n\n## Required Delegated Scopes\n\n Item.Read.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_GetOrgAppAudience",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "workspaceId",
|
||||
"description": "The workspace ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "orgAppAudienceId",
|
||||
"description": "The OrgAppAudience ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/OrgAppAudience"
|
||||
}
|
||||
},
|
||||
"429": {
|
||||
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
||||
"x-ms-error-response": true,
|
||||
"headers": {
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
},
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* ItemNotFound - The requested item was not found.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Get an OrgAppAudience example": {
|
||||
"$ref": "./examples/GetOrgAppAudience.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"patch": {
|
||||
"summary": "Updates the properties of the specified OrgAppAudience.",
|
||||
"description": "## Permissions\n\n The caller must have *read and write* permissions for the OrgAppAudience.\n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_UpdateOrgAppAudience",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "workspaceId",
|
||||
"description": "The workspace ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "orgAppAudienceId",
|
||||
"description": "The OrgAppAudience ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "body",
|
||||
"name": "updateOrgAppAudienceRequest",
|
||||
"description": "Update OrgAppAudience request payload.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/UpdateOrgAppAudienceRequest"
|
||||
},
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/OrgAppAudience"
|
||||
}
|
||||
},
|
||||
"429": {
|
||||
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
||||
"x-ms-error-response": true,
|
||||
"headers": {
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
},
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* ItemNotFound - The requested item was not found. \n\n* InvalidRequest - Invalid update request.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Update an OrgAppAudience example": {
|
||||
"$ref": "./examples/UpdateOrgAppAudience.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Deletes the specified OrgAppAudience.",
|
||||
"description": "## Permissions\n\n The caller must have *write* permissions for the OrgAppAudience. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_DeleteOrgAppAudience",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "workspaceId",
|
||||
"description": "The workspace ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "orgAppAudienceId",
|
||||
"description": "The OrgAppAudience ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully."
|
||||
},
|
||||
"429": {
|
||||
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
||||
"x-ms-error-response": true,
|
||||
"headers": {
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
},
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* ItemNotFound - The requested item was not found.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Delete an OrgAppAudience example": {
|
||||
"$ref": "./examples/DeleteOrgAppAudience.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/orgAppAudiences/{orgAppAudienceId}/getDefinition": {
|
||||
"post": {
|
||||
"summary": "Returns the specified OrgAppAudience public definition.",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get an OrgAppAudience's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the OrgAppAudience. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_GetOrgAppAudienceDefinition",
|
||||
"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": "orgAppAudienceId",
|
||||
"description": "The OrgAppAudience ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "format",
|
||||
"description": "The format of the OrgAppAudience public definition. Additional `format` types may be added over time.",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"OrgAppAudienceV1"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "OrgAppAudienceDefinitionFormat",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "OrgAppAudienceV1",
|
||||
"description": "Custom format for the OrgAppAudience public definition, specifically designed to support CI/CD scenarios in Fabric. see [OrgAppAudience - OrgAppAudienceV1 specification](/rest/api/fabric/articles/item-management/definitions/org-app-audience/orgappaudiencev1) for more details."
|
||||
}
|
||||
]
|
||||
},
|
||||
"required": false
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/OrgAppAudienceDefinitionResponse"
|
||||
}
|
||||
},
|
||||
"202": {
|
||||
"description": "Request accepted. Retrieving the definition is in progress.",
|
||||
"headers": {
|
||||
"Location": {
|
||||
"description": "The URL of the operation status, which can be used to track the operation state.",
|
||||
"type": "string"
|
||||
},
|
||||
"x-ms-operation-id": {
|
||||
"description": "The operation ID which can be used with long running operations (LRO) APIs to track the operation state and get the result.",
|
||||
"type": "string",
|
||||
"format": "uuid"
|
||||
},
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
}
|
||||
},
|
||||
"429": {
|
||||
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
||||
"x-ms-error-response": true,
|
||||
"headers": {
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
},
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* OperationNotSupportedForItem - Operation not supported for requested item.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Get an OrgAppAudience public definition example": {
|
||||
"$ref": "./examples/GetOrgAppAudienceDefinition.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/orgAppAudiences/{orgAppAudienceId}/updateDefinition": {
|
||||
"post": {
|
||||
"summary": "Overrides the definition for the specified OrgAppAudience.",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n \nUpdating the OrgAppAudience's definition, does not affect its sensitivity label. \n\n## Permissions\n\n The caller must have *read and write* permissions for the OrgAppAudience. \n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_UpdateOrgAppAudienceDefinition",
|
||||
"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": "orgAppAudienceId",
|
||||
"description": "The OrgAppAudience 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": "updateOrgAppAudienceDefinitionRequest",
|
||||
"description": "Update OrgAppAudience definition request payload.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/UpdateOrgAppAudienceDefinitionRequest"
|
||||
},
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully."
|
||||
},
|
||||
"202": {
|
||||
"description": "Request accepted. Update definition is in progress.",
|
||||
"headers": {
|
||||
"Location": {
|
||||
"description": "The URL of the operation status, which can be used to track the operation state.",
|
||||
"type": "string"
|
||||
},
|
||||
"x-ms-operation-id": {
|
||||
"description": "The operation ID which can be used with long running operations (LRO) APIs to track the operation state and get the result.",
|
||||
"type": "string",
|
||||
"format": "uuid"
|
||||
},
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
}
|
||||
},
|
||||
"429": {
|
||||
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
||||
"x-ms-error-response": true,
|
||||
"headers": {
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
},
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* OperationNotSupportedForItem - Operation not supported for requested item. \n\n* CorruptedPayload - The provided payload is corrupted.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Update an OrgAppAudience public definition example": {
|
||||
"$ref": "./examples/UpdateOrgAppAudienceDefinition.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {},
|
||||
"security": [],
|
||||
"tags": []
|
||||
}
|
||||
@@ -444,6 +444,66 @@
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"GatewayStatus": {
|
||||
"type": "string",
|
||||
"description": "The status of the gateway. Additional statuses may be added over time.",
|
||||
"enum": ["Online", "Offline"],
|
||||
"x-ms-enum": {
|
||||
"name": "GatewayStatus",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "Online",
|
||||
"description": "The gateway is online and available for use."
|
||||
},
|
||||
{
|
||||
"value": "Offline",
|
||||
"description": "The gateway is offline. Please check errorDetails property for more information."
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"GatewayUpgradeState": {
|
||||
"type": "string",
|
||||
"description": "The gateway version upgrade state. Additional upgrade states may be added over time.",
|
||||
"enum": ["UpToDate", "NewVersionAvailable", "UpgradeRequired", "Unknown"],
|
||||
"x-ms-enum": {
|
||||
"name": "GatewayUpgradeState",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{ "value": "UpToDate", "description": "The gateway is up to date." },
|
||||
{ "value": "NewVersionAvailable", "description": "A new gateway version is available." },
|
||||
{ "value": "UpgradeRequired", "description": "The gateway requires an upgrade." },
|
||||
{ "value": "Unknown", "description": "The gateway upgrade state is unknown." }
|
||||
]
|
||||
}
|
||||
},
|
||||
"GatewayStatusResponse": {
|
||||
"required": ["status"],
|
||||
"type": "object",
|
||||
"description": "The gateway status response.",
|
||||
"properties": {
|
||||
"status": {
|
||||
"description": "The status of the gateway.",
|
||||
"$ref": "#/definitions/GatewayStatus"
|
||||
},
|
||||
"gatewayVersion": {
|
||||
"type": "string",
|
||||
"description": "The version of the gateway."
|
||||
},
|
||||
"gatewayUpgradeState": {
|
||||
"description": "The upgrade state of the gateway.",
|
||||
"$ref": "#/definitions/GatewayUpgradeState"
|
||||
},
|
||||
"errorDetails": {
|
||||
"description": "The error details when the gateway is offline or when one or many members of gateway clusters encounters an error.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "../../common/definitions.json#/definitions/ErrorResponseDetails"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1969,82 +1969,6 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"ItemJobParameterType": {
|
||||
"description": "A string that represents the parameter's type. Additional types may be added over time.",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"VariableReference",
|
||||
"Integer",
|
||||
"Number",
|
||||
"Text",
|
||||
"Boolean",
|
||||
"DateTime",
|
||||
"Guid",
|
||||
"Automatic"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "ItemJobParameterType",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "VariableReference",
|
||||
"description": "The type of parameter is a variable reference."
|
||||
},
|
||||
{
|
||||
"value": "Integer",
|
||||
"description": "The type of parameter is an integer."
|
||||
},
|
||||
{
|
||||
"value": "Number",
|
||||
"description": "The type of parameter is a number, it accepts both integer and float values."
|
||||
},
|
||||
{
|
||||
"value": "Text",
|
||||
"description": "The type of parameter is a text."
|
||||
},
|
||||
{
|
||||
"value": "Boolean",
|
||||
"description": "The type of parameter is a boolean."
|
||||
},
|
||||
{
|
||||
"value": "DateTime",
|
||||
"description": "The type of parameter is a datetime in UTC, using the YYYY-MM-DDTHH:mm:ssZ format."
|
||||
},
|
||||
{
|
||||
"value": "Guid",
|
||||
"description": "The parameter type is a string representation of a GUID, using 00000000-0000-0000-0000-000000000000 format. See https://learn.microsoft.com/dotnet/api/system.guid.tostring for formatting details, and please use the default format: \"D\"."
|
||||
},
|
||||
{
|
||||
"value": "Automatic",
|
||||
"description": "The parameter type is automatically determined. Note: this type may not be supported for all item job types."
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"Parameter": {
|
||||
"description": "An item job parameter.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"name",
|
||||
"type",
|
||||
"value"
|
||||
],
|
||||
"properties": {
|
||||
"name": {
|
||||
"description": "The parameter name, specified by the caller, must be unique (case-insensitive check) and no longer than 256 characters.",
|
||||
"type": "string"
|
||||
},
|
||||
"type": {
|
||||
"description": "The parameter type.",
|
||||
"type": "string",
|
||||
"$ref": "#/definitions/ItemJobParameterType"
|
||||
},
|
||||
"value": {
|
||||
"description": "The parameter value based on the parameter type.",
|
||||
"type": "object"
|
||||
}
|
||||
}
|
||||
},
|
||||
"RunOnDemandItemJobRequest": {
|
||||
"description": "Run on demand item job instance payload",
|
||||
"properties": {
|
||||
@@ -2056,7 +1980,7 @@
|
||||
"description": "The parameter list for an on-demand job. These are per-run, user-defined inputs that tailor this invocation. Note: This property is not broadly supported. If the API returns an error with errorCode `FeatureNotAvailable` and errorMessage `Parameter is not allowed for this item type or this item job type`, the `parameters` property is not supported for the specified item type or item job type.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/Parameter"
|
||||
"$ref": "../../common/job_scheduling.json#/definitions/Parameter"
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -2300,40 +2224,6 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"ItemJobParameter": {
|
||||
"description": "Parameter details.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"parameterName",
|
||||
"type",
|
||||
"value"
|
||||
],
|
||||
"properties": {
|
||||
"parameterName": {
|
||||
"description": "Name of the parameter.",
|
||||
"type": "string"
|
||||
},
|
||||
"type": {
|
||||
"description": "The parameter type. Additional parameter types may be added over time.",
|
||||
"type": "string",
|
||||
"enum": [ "Automatic" ],
|
||||
"x-ms-enum": {
|
||||
"name": "Type",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "Automatic",
|
||||
"description": "Value must be Automatic"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"value": {
|
||||
"description": "The value of the parameter to override during execution.",
|
||||
"type": "object"
|
||||
}
|
||||
}
|
||||
},
|
||||
"Folders": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
{
|
||||
"parameters": {
|
||||
"gatewayId": "8e41c4dd-a382-4937-9bf3-695ab881f7c2",
|
||||
"gatewayMemberId": "f921ee6b-8feb-4595-8aa7-3ed34338e8b6"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"status": "Online",
|
||||
"gatewayVersion": "1.2.3",
|
||||
"gatewayUpgradeState": "UpToDate"
|
||||
}
|
||||
},
|
||||
"202": {
|
||||
"headers": {
|
||||
"Location": "https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
|
||||
"x-ms-operation-id": "431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
|
||||
"Retry-After": "30"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,25 @@
|
||||
{
|
||||
"parameters": {
|
||||
"gatewayId": "8e41c4dd-a382-4937-9bf3-695ab881f7c2",
|
||||
"gatewayMemberId": "f921ee6b-8feb-4595-8aa7-3ed34338e8b6"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"status": "Offline",
|
||||
"gatewayVersion": "1.2.3",
|
||||
"gatewayUpgradeState": "UpToDate",
|
||||
"errorDetails": [
|
||||
{
|
||||
"errorCode": "DM_GWPipeline_Client_GatewayUnreachable",
|
||||
"message": "Gateway is unreachable",
|
||||
"relatedResource": {
|
||||
"resourceId": "f921ee6b-8feb-4595-8aa7-3ed34338e8b6",
|
||||
"resourceType": "Gateway"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,24 @@
|
||||
{
|
||||
"parameters": {
|
||||
"gatewayId": "8e41c4dd-a382-4937-9bf3-695ab881f7c2"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"status": "Online",
|
||||
"gatewayVersion": "1.2.3",
|
||||
"gatewayUpgradeState": "UpToDate",
|
||||
"errorDetails": [
|
||||
{
|
||||
"errorCode": "DMTS_GatewayIsDisabled",
|
||||
"message": "Gateway is disabled",
|
||||
"relatedResource": {
|
||||
"resourceId": "f5a83d6a-78e2-4834-af05-b586e3aeb7e6",
|
||||
"resourceType": "Gateway"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,31 @@
|
||||
{
|
||||
"parameters": {
|
||||
"gatewayId": "8e41c4dd-a382-4937-9bf3-695ab881f7c2"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"status": "Offline",
|
||||
"gatewayVersion": "1.2.3",
|
||||
"gatewayUpgradeState": "UpToDate",
|
||||
"errorDetails": [
|
||||
{
|
||||
"errorCode": "DM_GWPipeline_Client_GatewayUnreachable",
|
||||
"message": "Gateway is unreachable",
|
||||
"relatedResource": {
|
||||
"resourceId": "8e41c4dd-a382-4937-9bf3-695ab881f7c2",
|
||||
"resourceType": "Gateway"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"202": {
|
||||
"headers": {
|
||||
"Location": "https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
|
||||
"x-ms-operation-id": "431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
|
||||
"Retry-After": "30"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,17 @@
|
||||
{
|
||||
"parameters": {
|
||||
"gatewayId": "8e41c4dd-a382-4937-9bf3-695ab881f7c2"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Gateway successfully restarted."
|
||||
},
|
||||
"202": {
|
||||
"headers": {
|
||||
"Location": "https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
|
||||
"x-ms-operation-id": "431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
|
||||
"Retry-After": "30"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,17 @@
|
||||
{
|
||||
"parameters": {
|
||||
"gatewayId": "8e41c4dd-a382-4937-9bf3-695ab881f7c2"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Gateway successfully shut down."
|
||||
},
|
||||
"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"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -8921,6 +8921,239 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/gateways/{gatewayId}/checkStatus": {
|
||||
"post": {
|
||||
"summary": "Checks the status of the specified gateway.",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\nThe caller must have permission for the gateway.\n\n## Required Delegated Scopes\n\nGateway.Read.All or Gateway.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": [
|
||||
"Gateways"
|
||||
],
|
||||
"operationId": "Gateways_CheckGatewayStatus",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"x-ms-fabric-sdk-long-running-operation": true,
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "gatewayId",
|
||||
"description": "The ID of the gateway.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions/gateways.json#/definitions/GatewayStatusResponse"
|
||||
}
|
||||
},
|
||||
"202": {
|
||||
"description": "Request accepted, status check is in progress.",
|
||||
"headers": {
|
||||
"Location": {
|
||||
"description": "The URL of the operation status. Can be used to track the operation state.",
|
||||
"type": "string"
|
||||
},
|
||||
"x-ms-operation-id": {
|
||||
"description": "The operation ID. Can be used with long running operations (LRO) APIs to track the operation state and get the result.",
|
||||
"type": "string",
|
||||
"format": "uuid"
|
||||
},
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
}
|
||||
},
|
||||
"429": {
|
||||
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
||||
"x-ms-error-response": true,
|
||||
"headers": {
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
},
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* EntityNotFound - The requested resource could not be found.\n\n* InsufficientPermissionsToManageGateway - The caller has insufficient permissions to manage this gateway.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Virtual network gateway example": {
|
||||
"$ref": "./examples/gateways/CheckGatewayStatusVnet.json"
|
||||
},
|
||||
"On premise data gateway example when gateway cluster is online but one of the gateway member encounters an error": {
|
||||
"$ref": "./examples/gateways/CheckGatewayStatusOnPremise.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/gateways/{gatewayId}/members/{gatewayMemberId}/checkStatus": {
|
||||
"post": {
|
||||
"summary": "Checks the status of the specified gateway member.",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\nThe caller must have permission for the gateway.\n\n## Required Delegated Scopes\n\nGateway.Read.All or Gateway.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": [
|
||||
"Gateways"
|
||||
],
|
||||
"operationId": "Gateways_CheckGatewayMemberStatus",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"x-ms-fabric-sdk-long-running-operation": true,
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "gatewayId",
|
||||
"description": "The ID of the gateway.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "gatewayMemberId",
|
||||
"description": "The ID of the gateway member.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions/gateways.json#/definitions/GatewayStatusResponse"
|
||||
}
|
||||
},
|
||||
"202": {
|
||||
"description": "Request accepted, status check is in progress.",
|
||||
"headers": {
|
||||
"Location": {
|
||||
"description": "The URL of the operation status. Can be used to track the operation state.",
|
||||
"type": "string"
|
||||
},
|
||||
"x-ms-operation-id": {
|
||||
"description": "The operation ID. Can be used with long running operations (LRO) APIs to track the operation state and get the result.",
|
||||
"type": "string",
|
||||
"format": "uuid"
|
||||
},
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
}
|
||||
},
|
||||
"429": {
|
||||
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
||||
"x-ms-error-response": true,
|
||||
"headers": {
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
},
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* EntityNotFound - The requested resource could not be found.\n\n* InsufficientPermissionsToManageGateway - The caller has insufficient permissions to manage this gateway.\n\n* UnsupportedGatewayType - This operation is not supported for the vnet gateway type.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Online gateway member example": {
|
||||
"$ref": "./examples/gateways/CheckGatewayMemberStatus.json"
|
||||
},
|
||||
"Offline gateway member example": {
|
||||
"$ref": "./examples/gateways/CheckGatewayMemberStatusOffline.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/gateways/{gatewayId}/restart": {
|
||||
"post": {
|
||||
"summary": "Restarts the specified gateway.",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\nThe caller must have admin permission for the gateway.\n\n## Required Delegated Scopes\n\nGateway.ReadWrite.All\n\n## Limitations\n\nThis operation is only supported for vnet data gateway.\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": [
|
||||
"Gateways"
|
||||
],
|
||||
"operationId": "Gateways_RestartGateway",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"x-ms-fabric-sdk-long-running-operation": true,
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "gatewayId",
|
||||
"description": "The ID of the gateway.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successfully restarted."
|
||||
},
|
||||
"202": {
|
||||
"description": "Accepted. Gateway restart operation has been initiated.",
|
||||
"headers": {
|
||||
"Location": {
|
||||
"description": "The URI to call to fetch status on the execution job.",
|
||||
"type": "string"
|
||||
},
|
||||
"x-ms-operation-id": {
|
||||
"description": "The operation ID. 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": "Number of seconds to wait before next call to fetch the status."
|
||||
}
|
||||
}
|
||||
},
|
||||
"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* InsufficientPermissionsToManageGateway - The caller has insufficient permissions to manage this gateway.\n\n* UnsupportedGatewayType - This operation is not supported for on-premise data gateways.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Example": {
|
||||
"$ref": "./examples/gateways/RestartGateway.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/gateways/{gatewayId}/roleAssignments": {
|
||||
"get": {
|
||||
"summary": "Returns a list of gateway role assignments.",
|
||||
@@ -9257,6 +9490,77 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/gateways/{gatewayId}/shutdown": {
|
||||
"post": {
|
||||
"summary": "Shuts down the specified gateway.",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\nThe caller must have admin permission for the gateway.\n\n## Required Delegated Scopes\n\nGateway.ReadWrite.All\n\n## Limitations\n\nThis operation is only supported for vnet data gateway.\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": [
|
||||
"Gateways"
|
||||
],
|
||||
"operationId": "Gateways_ShutdownGateway",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"x-ms-fabric-sdk-long-running-operation": true,
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "gatewayId",
|
||||
"description": "The ID of the gateway.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successfully shutdown."
|
||||
},
|
||||
"202": {
|
||||
"description": "Accepted. Gateway shutdown operation has been initiated.",
|
||||
"headers": {
|
||||
"Location": {
|
||||
"description": "The URI to call to fetch status on the execution job.",
|
||||
"type": "string"
|
||||
},
|
||||
"x-ms-operation-id": {
|
||||
"description": "The operation ID. 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": "Number of seconds to wait before next call to fetch the status."
|
||||
}
|
||||
}
|
||||
},
|
||||
"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* InsufficientPermissionsToManageGateway - The caller has insufficient permissions to manage this gateway.\n\n* UnsupportedGatewayType - This operation is not supported for on-premise data gateways.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Example": {
|
||||
"$ref": "./examples/gateways/ShutdownGateway.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/connections/{connectionId}/roleAssignments": {
|
||||
"get": {
|
||||
"summary": "Returns a list of connection role assignments.",
|
||||
|
||||
Reference in new issue
Block a user