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:
1 parent
a5f4b4efa7
commit
2929ae87ec
12 files changed
+796
-12
No files matched your search
+6
-6
@@ -1150,7 +1150,7 @@
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* UnknownError - An error occurred.",
|
||||
"description": "Common error codes:\n\n* DomainNotFound - The provided domain was not found\n\n* UnknownError - An error occurred.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
@@ -1206,7 +1206,7 @@
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* UnknownError - An error occurred.\n\n* EntityConflict - Update domain failed because domain display name already exists.",
|
||||
"description": "Common error codes:\n\n* DomainNotFound - The provided domain was not found\n\n* UnknownError - An error occurred.\n\n* EntityConflict - Update domain failed because domain display name already exists.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
@@ -1245,7 +1245,7 @@
|
||||
"description": "Request completed successfully."
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* UnknownError - An error occurred.",
|
||||
"description": "Common error codes:\n\n* DomainNotFound - The provided domain was not found\n\n* UnknownError - An error occurred.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
@@ -1294,7 +1294,7 @@
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* UnknownError - An error occurred.",
|
||||
"description": "Common error codes:\n\n* DomainNotFound - The provided domain was not found\n\n* UnknownError - An error occurred.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
@@ -1350,7 +1350,7 @@
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* UnknownError - An error occurred.\n\n* EntityConflict - Update domain failed because domain display name already exists.",
|
||||
"description": "Common error codes:\n\n* DomainNotFound - The provided domain was not found\n\n* EntityConflict - Update domain failed because domain display name already exists.\n\n* UnknownError - An error occurred.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
@@ -1448,7 +1448,7 @@
|
||||
"description": "Request completed successfully."
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* UnknownError - An error occurred.",
|
||||
"description": "Common error codes:\n\n* DomainNotFound - The provided domain was not found\n\n* UnknownError - An error occurred.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
|
||||
+10
-6
@@ -192,7 +192,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" ],
|
||||
"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" ],
|
||||
"x-ms-enum": {
|
||||
"name": "ItemType",
|
||||
"modelAsString": true,
|
||||
@@ -305,9 +305,9 @@
|
||||
"value": "CopyJob",
|
||||
"description": "A Copy job."
|
||||
},
|
||||
{
|
||||
"value": "VariableLibrary",
|
||||
"description": "A VariableLibrary."
|
||||
{
|
||||
"value": "VariableLibrary",
|
||||
"description": "A VariableLibrary."
|
||||
},
|
||||
{
|
||||
"value": "MirroredAzureDatabricksCatalog",
|
||||
@@ -346,8 +346,8 @@
|
||||
"description": "A GraphModel."
|
||||
},
|
||||
{
|
||||
"value": "GraphQuerySet",
|
||||
"description": "A Graph QuerySet."
|
||||
"value": "GraphQuerySet",
|
||||
"description": "A Graph QuerySet."
|
||||
},
|
||||
{
|
||||
"value": "SnowflakeDatabase",
|
||||
@@ -356,6 +356,10 @@
|
||||
{
|
||||
"value": "OperationsAgent",
|
||||
"description": "A OperationsAgent."
|
||||
},
|
||||
{
|
||||
"value": "CosmosDBDatabase",
|
||||
"description": "A Cosmos DB Database."
|
||||
}
|
||||
]
|
||||
},
|
||||
|
||||
@@ -0,0 +1,126 @@
|
||||
{
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"version": "v1",
|
||||
"title": "CosmosDBDatabase data types"
|
||||
},
|
||||
"paths": {},
|
||||
"definitions": {
|
||||
"CosmosDBDatabase": {
|
||||
"description": "A Cosmos DB database object.",
|
||||
"type": "object",
|
||||
"required": ["type"],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "../common/definitions.json#/definitions/Item"
|
||||
}
|
||||
]
|
||||
},
|
||||
"CosmosDBDatabases": {
|
||||
"description": "A list of Cosmos DB databases.",
|
||||
"required": ["value"],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"value": {
|
||||
"description": "A list of Cosmos DB databases.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/CosmosDBDatabase"
|
||||
}
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
|
||||
}
|
||||
]
|
||||
},
|
||||
"CreateCosmosDBDatabaseRequest": {
|
||||
"description": "Create Cosmos DB database request payload.",
|
||||
"required": ["displayName"],
|
||||
"properties": {
|
||||
"displayName": {
|
||||
"description": "The Cosmos DB database display name. The display name must follow naming rules according to item type.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"description": {
|
||||
"description": "The Cosmos DB database description. Maximum length is 256 characters.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"definition": {
|
||||
"description": "The Cosmos DB database definition.",
|
||||
"$ref": "#/definitions/CosmosDBDatabaseDefinition",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateCosmosDBDatabaseRequest": {
|
||||
"description": "Update Cosmos DB database request.",
|
||||
"properties": {
|
||||
"description": {
|
||||
"description": "The Cosmos DB database description. Maximum length is 256 characters.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateCosmosDBDatabaseDefinitionRequest": {
|
||||
"description": "Update Cosmos DB database public definition request payload.",
|
||||
"required": ["definition"],
|
||||
"properties": {
|
||||
"definition": {
|
||||
"$ref": "#/definitions/CosmosDBDatabaseDefinition"
|
||||
}
|
||||
}
|
||||
},
|
||||
"CosmosDBDatabaseDefinitionResponse": {
|
||||
"description": "The Cosmos DB database public definition response.",
|
||||
"required": ["definition"],
|
||||
"properties": {
|
||||
"definition": {
|
||||
"$ref": "#/definitions/CosmosDBDatabaseDefinition",
|
||||
"readOnly": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"CosmosDBDatabaseDefinition" : {
|
||||
"description": "The Cosmos DB database public definition object. Refer to this [article](/rest/api/fabric/articles/item-management/definitions/cosmosdb-database-definition) for more details on how to craft a Cosmos DB database public definition.",
|
||||
"type": "object",
|
||||
"required": ["parts"],
|
||||
"properties": {
|
||||
"parts": {
|
||||
"description": "A list of definition parts.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/CosmosDBDatabaseDefinitionPart"
|
||||
},
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"CosmosDBDatabaseDefinitionPart": {
|
||||
"description": "Cosmos DB database definition part object.",
|
||||
"type": "object",
|
||||
"required": ["path", "payload", "payloadType"],
|
||||
"properties": {
|
||||
"path": {
|
||||
"description": "The Cosmos DB database public definition part path.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"payload": {
|
||||
"description": "The Cosmos DB database public definition part payload.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"payloadType":{
|
||||
"description": "The payload type.",
|
||||
"$ref": "../common/definitions.json#/definitions/PayloadType",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,27 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"createCosmosDBDatabaseRequest": {
|
||||
"displayName": "Cosmos DB Database 1",
|
||||
"description": "A Cosmos DB Database description."
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"201": {
|
||||
"body": {
|
||||
"displayName": "Cosmos DB Database 1",
|
||||
"description": "A Cosmos DB Database description.",
|
||||
"type": "CosmosDBDatabase",
|
||||
"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,36 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"createCosmosDBDatabaseRequest": {
|
||||
"displayName": "Cosmos DB Database 1",
|
||||
"description": "A Cosmos DB Database description.",
|
||||
"definition": {
|
||||
"parts": [
|
||||
{
|
||||
"path": "definition.json",
|
||||
"payload": "ewogICIkc2NoZW1hIjogImh0dHBzOi8vZGV2ZWxvcGVyLm1pY3Jvc29mdC5jb20vanNvbi1zY2hlbWFzL2ZhYnJpYy9pdGVtL0Nvc21vc0RCL2RlZmluaXRpb24vQ29zbW9zREIvMi4wLjAvc2NoZW1hLmpzb24iLAogICJjb250YWluZXJzIjogWwogICAgewogICAgICAib3B0aW9ucyI6IHsKICAgICAgICAiYXV0b3NjYWxlU2V0dGluZ3MiOiB7CiAgICAgICAgICAibWF4VGhyb3VnaHB1dCI6IDUwMDAKICAgICAgICB9CiAgICAgIH0sCiAgICAgICJyZXNvdXJjZSI6IHsKICAgICAgICAiaWQiOiAiU2FtcGxlRGF0YSIsCiAgICAgICAgImNvbXB1dGVkUHJvcGVydGllcyI6IFtdLAogICAgICAgICJjb25mbGljdFJlc29sdXRpb25Qb2xpY3kiOiB7CiAgICAgICAgICAibW9kZSI6ICJMYXN0V3JpdGVyV2lucyIsCiAgICAgICAgICAiY29uZmxpY3RSZXNvbHV0aW9uUGF0aCI6ICIvX3RzIiwKICAgICAgICAgICJjb25mbGljdFJlc29sdXRpb25Qcm9jZWR1cmUiOiAiIgogICAgICAgIH0sCiAgICAgICAgImdlb3NwYXRpYWxDb25maWciOiB7CiAgICAgICAgICAidHlwZSI6ICJHZW9ncmFwaHkiCiAgICAgICAgfSwKICAgICAgICAiaW5kZXhpbmdQb2xpY3kiOiB7CiAgICAgICAgICAiYXV0b21hdGljIjogdHJ1ZSwKICAgICAgICAgICJpbmRleGluZ01vZGUiOiAiQ29uc2lzdGVudCIsCiAgICAgICAgICAiaW5jbHVkZWRQYXRocyI6IFsKICAgICAgICAgICAgewogICAgICAgICAgICAgICJwYXRoIjogIi8qIiwKICAgICAgICAgICAgICAiaW5kZXhlcyI6IFtdCiAgICAgICAgICAgIH0KICAgICAgICAgIF0sCiAgICAgICAgICAiZXhjbHVkZWRQYXRocyI6IFsKICAgICAgICAgICAgewogICAgICAgICAgICAgICJwYXRoIjogIi9cIl9ldGFnXCIvPyIKICAgICAgICAgICAgfQogICAgICAgICAgXSwKICAgICAgICAgICJjb21wb3NpdGVJbmRleGVzIjogW10sCiAgICAgICAgICAic3BhdGlhbEluZGV4ZXMiOiBbXSwKICAgICAgICAgICJ2ZWN0b3JJbmRleGVzIjogW10sCiAgICAgICAgICAiZnVsbFRleHRJbmRleGVzIjogW10KICAgICAgICB9LAogICAgICAgICJwYXJ0aXRpb25LZXkiOiB7CiAgICAgICAgICAicGF0aHMiOiBbCiAgICAgICAgICAgICIvY2F0ZWdvcnkiCiAgICAgICAgICBdLAogICAgICAgICAgImtpbmQiOiAiSGFzaCIsCiAgICAgICAgICAidmVyc2lvbiI6IDIKICAgICAgICB9LAogICAgICAgICJ1bmlxdWVLZXlQb2xpY3kiOiB7CiAgICAgICAgICAidW5pcXVlS2V5cyI6IFtdCiAgICAgICAgfQogICAgICB9CiAgICB9CiAgXQp9",
|
||||
"payloadType": "InlineBase64"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"201": {
|
||||
"body": {
|
||||
"displayName": "Cosmos DB Database 1",
|
||||
"description": "A Cosmos DB Database description.",
|
||||
"type": "CosmosDBDatabase",
|
||||
"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",
|
||||
"cosmosDbDatabaseId": "5b218778-e7a5-4d73-8187-f10824047715"
|
||||
},
|
||||
"responses": {
|
||||
"200": {}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,17 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
|
||||
"cosmosDbDatabaseId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"id": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
|
||||
"displayName": "Cosmos DB Database 1",
|
||||
"description": "A Cosmos DB Database description.",
|
||||
"type": "CosmosDBDatabase",
|
||||
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,33 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
|
||||
"cosmosDbDatabaseId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"definition": {
|
||||
"parts": [
|
||||
{
|
||||
"path": "definition.json",
|
||||
"payload": "ewogICIkc2NoZW1hIjogImh0dHBzOi8vZGV2ZWxvcGVyLm1pY3Jvc29mdC5jb20vanNvbi1zY2hlbWFzL2ZhYnJpYy9pdGVtL0Nvc21vc0RCL2RlZmluaXRpb24vQ29zbW9zREIvMi4wLjAvc2NoZW1hLmpzb24iLAogICJjb250YWluZXJzIjogWwogICAgewogICAgICAib3B0aW9ucyI6IHsKICAgICAgICAiYXV0b3NjYWxlU2V0dGluZ3MiOiB7CiAgICAgICAgICAibWF4VGhyb3VnaHB1dCI6IDUwMDAKICAgICAgICB9CiAgICAgIH0sCiAgICAgICJyZXNvdXJjZSI6IHsKICAgICAgICAiaWQiOiAiU2FtcGxlRGF0YSIsCiAgICAgICAgImNvbXB1dGVkUHJvcGVydGllcyI6IFtdLAogICAgICAgICJjb25mbGljdFJlc29sdXRpb25Qb2xpY3kiOiB7CiAgICAgICAgICAibW9kZSI6ICJMYXN0V3JpdGVyV2lucyIsCiAgICAgICAgICAiY29uZmxpY3RSZXNvbHV0aW9uUGF0aCI6ICIvX3RzIiwKICAgICAgICAgICJjb25mbGljdFJlc29sdXRpb25Qcm9jZWR1cmUiOiAiIgogICAgICAgIH0sCiAgICAgICAgImdlb3NwYXRpYWxDb25maWciOiB7CiAgICAgICAgICAidHlwZSI6ICJHZW9ncmFwaHkiCiAgICAgICAgfSwKICAgICAgICAiaW5kZXhpbmdQb2xpY3kiOiB7CiAgICAgICAgICAiYXV0b21hdGljIjogdHJ1ZSwKICAgICAgICAgICJpbmRleGluZ01vZGUiOiAiQ29uc2lzdGVudCIsCiAgICAgICAgICAiaW5jbHVkZWRQYXRocyI6IFsKICAgICAgICAgICAgewogICAgICAgICAgICAgICJwYXRoIjogIi8qIiwKICAgICAgICAgICAgICAiaW5kZXhlcyI6IFtdCiAgICAgICAgICAgIH0KICAgICAgICAgIF0sCiAgICAgICAgICAiZXhjbHVkZWRQYXRocyI6IFsKICAgICAgICAgICAgewogICAgICAgICAgICAgICJwYXRoIjogIi9cIl9ldGFnXCIvPyIKICAgICAgICAgICAgfQogICAgICAgICAgXSwKICAgICAgICAgICJjb21wb3NpdGVJbmRleGVzIjogW10sCiAgICAgICAgICAic3BhdGlhbEluZGV4ZXMiOiBbXSwKICAgICAgICAgICJ2ZWN0b3JJbmRleGVzIjogW10sCiAgICAgICAgICAiZnVsbFRleHRJbmRleGVzIjogW10KICAgICAgICB9LAogICAgICAgICJwYXJ0aXRpb25LZXkiOiB7CiAgICAgICAgICAicGF0aHMiOiBbCiAgICAgICAgICAgICIvY2F0ZWdvcnkiCiAgICAgICAgICBdLAogICAgICAgICAgImtpbmQiOiAiSGFzaCIsCiAgICAgICAgICAidmVyc2lvbiI6IDIKICAgICAgICB9LAogICAgICAgICJ1bmlxdWVLZXlQb2xpY3kiOiB7CiAgICAgICAgICAidW5pcXVlS2V5cyI6IFtdCiAgICAgICAgfQogICAgICB9CiAgICB9CiAgXQp9",
|
||||
"payloadType": "InlineBase64"
|
||||
},
|
||||
{
|
||||
"path": ".platform",
|
||||
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
|
||||
"payloadType": "InlineBase64"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"202": {
|
||||
"headers": {
|
||||
"Location": "https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6",
|
||||
"x-ms-operation-id": "0acd697c-1550-43cd-b998-91bfbfbd47c6",
|
||||
"Retry-After": 30
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,27 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"value": [
|
||||
{
|
||||
"id": "3546052c-ae64-4526-b1a8-52af7761426f",
|
||||
"displayName": "Cosmos DB Database Name 1",
|
||||
"description": "A Cosmos DB Database description.",
|
||||
"type": "CosmosDBDatabase",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
|
||||
},
|
||||
{
|
||||
"id": "f697fb63-abd4-4399-9548-be7e3c3c0dac",
|
||||
"displayName": "Cosmos DB Database Name 2",
|
||||
"description": "A Cosmos DB Database description.",
|
||||
"type": "CosmosDBDatabase",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,20 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"cosmosDbDatabaseId": "5b218778-e7a5-4d73-8187-f10824047715",
|
||||
"updateCosmosDBDatabaseRequest": {
|
||||
"description": "Cosmos DB database's new description"
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"displayName": "Cosmos DB database's name",
|
||||
"description": "Cosmos DB database's new description",
|
||||
"type": "CosmosDBDatabase",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"id": "5b218778-e7a5-4d73-8187-f10824047715"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,33 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"cosmosDbDatabaseId": "5b218778-e7a5-4d73-8187-f10824047715",
|
||||
"updateMetadata": true,
|
||||
"updateCosmosDBDatabaseDefinitionRequest": {
|
||||
"definition": {
|
||||
"parts": [
|
||||
{
|
||||
"path": "definition.json",
|
||||
"payload": "ewogICIkc2NoZW1hIjogImh0dHBzOi8vZGV2ZWxvcGVyLm1pY3Jvc29mdC5jb20vanNvbi1zY2hlbWFzL2ZhYnJpYy9pdGVtL0Nvc21vc0RCL2RlZmluaXRpb24vQ29zbW9zREIvMi4wLjAvc2NoZW1hLmpzb24iLAogICJjb250YWluZXJzIjogWwogICAgewogICAgICAib3B0aW9ucyI6IHsKICAgICAgICAiYXV0b3NjYWxlU2V0dGluZ3MiOiB7CiAgICAgICAgICAibWF4VGhyb3VnaHB1dCI6IDUwMDAKICAgICAgICB9CiAgICAgIH0sCiAgICAgICJyZXNvdXJjZSI6IHsKICAgICAgICAiaWQiOiAiU2FtcGxlRGF0YSIsCiAgICAgICAgImNvbXB1dGVkUHJvcGVydGllcyI6IFtdLAogICAgICAgICJjb25mbGljdFJlc29sdXRpb25Qb2xpY3kiOiB7CiAgICAgICAgICAibW9kZSI6ICJMYXN0V3JpdGVyV2lucyIsCiAgICAgICAgICAiY29uZmxpY3RSZXNvbHV0aW9uUGF0aCI6ICIvX3RzIiwKICAgICAgICAgICJjb25mbGljdFJlc29sdXRpb25Qcm9jZWR1cmUiOiAiIgogICAgICAgIH0sCiAgICAgICAgImdlb3NwYXRpYWxDb25maWciOiB7CiAgICAgICAgICAidHlwZSI6ICJHZW9ncmFwaHkiCiAgICAgICAgfSwKICAgICAgICAiaW5kZXhpbmdQb2xpY3kiOiB7CiAgICAgICAgICAiYXV0b21hdGljIjogdHJ1ZSwKICAgICAgICAgICJpbmRleGluZ01vZGUiOiAiQ29uc2lzdGVudCIsCiAgICAgICAgICAiaW5jbHVkZWRQYXRocyI6IFsKICAgICAgICAgICAgewogICAgICAgICAgICAgICJwYXRoIjogIi8qIiwKICAgICAgICAgICAgICAiaW5kZXhlcyI6IFtdCiAgICAgICAgICAgIH0KICAgICAgICAgIF0sCiAgICAgICAgICAiZXhjbHVkZWRQYXRocyI6IFsKICAgICAgICAgICAgewogICAgICAgICAgICAgICJwYXRoIjogIi9cIl9ldGFnXCIvPyIKICAgICAgICAgICAgfQogICAgICAgICAgXSwKICAgICAgICAgICJjb21wb3NpdGVJbmRleGVzIjogW10sCiAgICAgICAgICAic3BhdGlhbEluZGV4ZXMiOiBbXSwKICAgICAgICAgICJ2ZWN0b3JJbmRleGVzIjogW10sCiAgICAgICAgICAiZnVsbFRleHRJbmRleGVzIjogW10KICAgICAgICB9LAogICAgICAgICJwYXJ0aXRpb25LZXkiOiB7CiAgICAgICAgICAicGF0aHMiOiBbCiAgICAgICAgICAgICIvY2F0ZWdvcnkiCiAgICAgICAgICBdLAogICAgICAgICAgImtpbmQiOiAiSGFzaCIsCiAgICAgICAgICAidmVyc2lvbiI6IDIKICAgICAgICB9LAogICAgICAgICJ1bmlxdWVLZXlQb2xpY3kiOiB7CiAgICAgICAgICAidW5pcXVlS2V5cyI6IFtdCiAgICAgICAgfQogICAgICB9CiAgICB9CiAgXQp9",
|
||||
"payloadType": "InlineBase64"
|
||||
},
|
||||
{
|
||||
"path": ".platform",
|
||||
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
|
||||
"payloadType": "InlineBase64"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {},
|
||||
"202": {
|
||||
"headers": {
|
||||
"Location": "https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6",
|
||||
"x-ms-operation-id": "0acd697c-1550-43cd-b998-91bfbfbd47c6",
|
||||
"Retry-After": 30
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,452 @@
|
||||
{
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"title": "Cosmos DB Database REST APIs",
|
||||
"version": "v1"
|
||||
},
|
||||
"schemes": [
|
||||
"https"
|
||||
],
|
||||
"host": "api.fabric.microsoft.com",
|
||||
"basePath": "/v1",
|
||||
"paths": {
|
||||
"/workspaces/{workspaceId}/cosmosDbDatabases": {
|
||||
"get": {
|
||||
"summary": "Returns a list of Cosmos DB databases from the specified workspace.",
|
||||
"description": "## 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) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_ListCosmosDBDatabases",
|
||||
"x-ms-pageable": {
|
||||
"nextLinkName": "continuationUri"
|
||||
},
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "workspaceId",
|
||||
"description": "The workspace ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "continuationToken",
|
||||
"description": "A token for retrieving the next page of results.",
|
||||
"type": "string",
|
||||
"required": false
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/CosmosDBDatabases"
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* InvalidItemType - Invalid item type.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"List Cosmos DB Databases in workspace example": {
|
||||
"$ref": "./examples/ListCosmosDBDatabasesInWorkspace.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"post": {
|
||||
"summary": "Creates a Cosmos DB database in the specified workspace.",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n ## Permissions \n The caller must have a *contributor* workspace role. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All \n\n## Limitations \n- To create a Cosmos DB database 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_CreateCosmosDBDatabase",
|
||||
"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": "createCosmosDBDatabaseRequest",
|
||||
"description": "Create item request payload.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/CreateCosmosDBDatabaseRequest"
|
||||
},
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"201": {
|
||||
"description": "Successfully created",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/CosmosDBDatabase"
|
||||
}
|
||||
},
|
||||
"202": {
|
||||
"description": "Request accepted, Cosmos DB database provisioning in progress.",
|
||||
"headers": {
|
||||
"Location": {
|
||||
"description": "The URL of the operation status, which can be used to track the operation state.",
|
||||
"type": "string"
|
||||
},
|
||||
"x-ms-operation-id": {
|
||||
"description": "The operation ID which can be used with long running operations (LRO) APIs to track the operation state and get the result.",
|
||||
"type": "string",
|
||||
"format": "uuid"
|
||||
},
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* InvalidItemType - Item type is invalid\n\n* ItemDisplayNameAlreadyInUse - Item display name is already used.\n\n* CorruptedPayload - The provided payload is corrupted.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Create a Cosmos DB Database example": {
|
||||
"$ref": "./examples/CreateCosmosDBDatabase.json"
|
||||
},
|
||||
"Create a Cosmos DB Database with definition example": {
|
||||
"$ref": "./examples/CreateCosmosDBDatabaseWithDefinition.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/cosmosDbDatabases/{cosmosDbDatabaseId}": {
|
||||
"get": {
|
||||
"summary": "Returns properties of the specified Cosmos DB database.",
|
||||
"description": "## Permissions\n\n The caller must have *read* permissions for the Cosmos DB database. \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) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_GetCosmosDBDatabase",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "workspaceId",
|
||||
"description": "The workspace ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "cosmosDbDatabaseId",
|
||||
"description": "The Cosmos DB database ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/CosmosDBDatabase"
|
||||
}
|
||||
},
|
||||
"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 Cosmos DB Database example": {
|
||||
"$ref": "./examples/GetCosmosDBDatabase.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"patch": {
|
||||
"summary": "Updates the properties of the specified Cosmos DB database.",
|
||||
"description": "## Permissions\n\n The caller must have *read and write* permissions for the Cosmos DB database.\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) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_UpdateCosmosDBDatabase",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "workspaceId",
|
||||
"description": "The workspace ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "cosmosDbDatabaseId",
|
||||
"description": "The Cosmos DB database ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "body",
|
||||
"name": "updateCosmosDBDatabaseRequest",
|
||||
"description": "Update Cosmos DB database request payload.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/UpdateCosmosDBDatabaseRequest"
|
||||
},
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/CosmosDBDatabase"
|
||||
}
|
||||
},
|
||||
"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 Cosmos DB Database example": {
|
||||
"$ref": "./examples/UpdateCosmosDBDatabase.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Deletes the specified Cosmos DB database.",
|
||||
"description": "## Permissions\n\n The caller must have *write* permissions for the Cosmos DB database.\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) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_DeleteCosmosDBDatabase",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "workspaceId",
|
||||
"description": "The workspace ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "cosmosDbDatabaseId",
|
||||
"description": "The Cosmos DB database ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully."
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* ItemNotFound - The requested item was not found.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Delete a Cosmos DB Database example": {
|
||||
"$ref": "./examples/DeleteCosmosDBDatabase.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/cosmosDbDatabases/{cosmosDbDatabaseId}/getDefinition": {
|
||||
"post": {
|
||||
"summary": "Returns the specified Cosmos DB database public definition.",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a Cosmos DB database'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 CosmosDBDatabase. \n\n## Required Delegated Scopes \n\n Item.ReadWrite.All \n\n## Limitations\n\n This API is blocked for a notebook with an encrypted sensitivity label.\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_GetCosmosDBDatabaseDefinition",
|
||||
"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": "cosmosDbDatabaseId",
|
||||
"description": "The Cosmos DB database ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/CosmosDBDatabaseDefinitionResponse"
|
||||
}
|
||||
},
|
||||
"202": {
|
||||
"description": "Request accepted. Retrieving the definition is in progress.",
|
||||
"headers": {
|
||||
"Location": {
|
||||
"description": "The URL of the operation status, which can be used to track the operation state.",
|
||||
"type": "string"
|
||||
},
|
||||
"x-ms-operation-id": {
|
||||
"description": "The operation ID which can be used with long running operations (LRO) APIs to track the operation state and get the result.",
|
||||
"type": "string",
|
||||
"format": "uuid"
|
||||
},
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* OperationNotSupportedForItem - Operation not supported for requested item.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Get a Cosmos DB Database public definition example": {
|
||||
"$ref": "./examples/GetCosmosDBDatabaseDefinition.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/cosmosDbDatabases/{cosmosDbDatabaseId}/updateDefinition": {
|
||||
"post": {
|
||||
"summary": "Overrides the definition for the specified Cosmos DB database.",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n \nUpdating the Cosmos DB database's definition, does not affect its sensitivity label. \n\n## Permissions\n\n The caller must have *read and write* permissions for the CosmosDBDatabase. \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) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"operationId": "Items_UpdateCosmosDBDatabaseDefinition",
|
||||
"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": "cosmosDbDatabaseId",
|
||||
"description": "The Cosmos DB database 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. \n> NOTE: \nThe CosmosDBDatabase item type does not support renaming via the .platform file.",
|
||||
"type": "boolean",
|
||||
"required": false
|
||||
},
|
||||
{
|
||||
"in": "body",
|
||||
"name": "updateCosmosDBDatabaseDefinitionRequest",
|
||||
"description": "Update Cosmos DB database request payload.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/UpdateCosmosDBDatabaseDefinitionRequest"
|
||||
},
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully."
|
||||
},
|
||||
"202": {
|
||||
"description": "Request accepted. Update definition is in progress.",
|
||||
"headers": {
|
||||
"Location": {
|
||||
"description": "The URL of the operation status, which can be used to track the operation state.",
|
||||
"type": "string"
|
||||
},
|
||||
"x-ms-operation-id": {
|
||||
"description": "The operation ID which can be used with long running operations (LRO) APIs to track the operation state and get the result.",
|
||||
"type": "string",
|
||||
"format": "uuid"
|
||||
},
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* OperationNotSupportedForItem - Operation not supported for requested item. \n\n* CorruptedPayload - The provided payload is corrupted.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Update a Cosmos DB Database public definition example": {
|
||||
"$ref": "./examples/UpdateCosmosDBDatabaseDefinition.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
},
|
||||
"security": [
|
||||
],
|
||||
"tags": [
|
||||
]
|
||||
}
|
||||
Reference in new issue
Block a user