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
49e5f16adc
commit
b4d35818fc
16 files changed
+1737
-25
No files matched your search
@@ -25,6 +25,7 @@
|
||||
"AzureServiceBus",
|
||||
"ConfluentCloud",
|
||||
"CustomEndpoint",
|
||||
"FabricAnomalyDetectionEvents",
|
||||
"FabricCapacityOverviewEvents",
|
||||
"FabricJobEvents",
|
||||
"FabricOneLakeEvents",
|
||||
@@ -104,6 +105,10 @@
|
||||
"value": "CustomEndpoint",
|
||||
"description": "The Custom Endpoint source type."
|
||||
},
|
||||
{
|
||||
"value": "FabricAnomalyDetectionEvents",
|
||||
"description": "The Fabric Anomaly Detection Events source type."
|
||||
},
|
||||
{
|
||||
"value": "FabricCapacityOverviewEvents",
|
||||
"description": "The Fabric Capacity Overview Events source type."
|
||||
@@ -352,6 +357,25 @@
|
||||
],
|
||||
"x-ms-discriminator-value": "CustomEndpoint"
|
||||
},
|
||||
"FabricAnomalyDetectionEventsSourceResponse": {
|
||||
"type": "object",
|
||||
"description": "Fabric Anomaly Detection Events source response.",
|
||||
"required": [
|
||||
"properties"
|
||||
],
|
||||
"properties": {
|
||||
"properties": {
|
||||
"description": "The properties of the Fabric Anomaly Detection Events source.",
|
||||
"$ref": "#/definitions/FabricAnomalyDetectionEventsSourceProperties"
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/SourceResponse"
|
||||
}
|
||||
],
|
||||
"x-ms-discriminator-value": "FabricAnomalyDetectionEvents"
|
||||
},
|
||||
"FabricCapacityOverviewEventsSourceResponse": {
|
||||
"type": "object",
|
||||
"description": "Fabric Capacity Overview Events source response.",
|
||||
@@ -530,7 +554,8 @@
|
||||
],
|
||||
"properties": {
|
||||
"properties": {
|
||||
"$ref": "#/definitions/BaseSQLCDCSourceProperties"
|
||||
"description": "The properties of the Azure SQL DB CDC source.",
|
||||
"$ref": "#/definitions/BaseSQLServerCDCSourceProperties"
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
@@ -548,7 +573,8 @@
|
||||
],
|
||||
"properties": {
|
||||
"properties": {
|
||||
"$ref": "#/definitions/BaseSQLCDCSourceProperties"
|
||||
"description": "The properties of the Azure SQL MI DB CDC source.",
|
||||
"$ref": "#/definitions/BaseSQLServerCDCSourceProperties"
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
@@ -566,7 +592,8 @@
|
||||
],
|
||||
"properties": {
|
||||
"properties": {
|
||||
"$ref": "#/definitions/BaseSQLCDCSourceProperties"
|
||||
"description": "The properties of the SQL Server on VM DB CDC source.",
|
||||
"$ref": "#/definitions/BaseSQLServerCDCSourceProperties"
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
@@ -1015,6 +1042,41 @@
|
||||
"description": "Custom endpoint events source properties.",
|
||||
"properties": {}
|
||||
},
|
||||
"FabricAnomalyDetectionEventsSourceProperties": {
|
||||
"type": "object",
|
||||
"description": "Fabric Anomaly Detection Events source properties.",
|
||||
"properties": {
|
||||
"workspaceId": {
|
||||
"type": "string",
|
||||
"description": "The workspace identifier.",
|
||||
"format": "uuid"
|
||||
},
|
||||
"itemId": {
|
||||
"type": "string",
|
||||
"description": "The item identifier.",
|
||||
"format": "uuid"
|
||||
},
|
||||
"configurationId": {
|
||||
"type": "string",
|
||||
"description": "The anomaly detection configuration identifier.",
|
||||
"format": "uuid"
|
||||
},
|
||||
"includedEventTypes": {
|
||||
"type": "array",
|
||||
"description": "The list of event types to include. Supported values: Microsoft.Fabric.AnomalyDetection.AnomalyDetected. Additional event types may be added over time.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"filters": {
|
||||
"type": "array",
|
||||
"description": "The Azure Event Grid advanced filters to apply. Each entry is an advanced filter object as defined by Azure Event Grid. For details, see https://learn.microsoft.com/azure/event-grid/event-filtering#advanced-filtering.",
|
||||
"items": {
|
||||
"type": "object"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"FabricCapacityOverviewEventsSourceProperties": {
|
||||
"type": "object",
|
||||
"description": "Fabric Capacity Overview Events source properties.",
|
||||
@@ -1491,6 +1553,10 @@
|
||||
]
|
||||
},
|
||||
"default": "None"
|
||||
},
|
||||
"tlsSettings": {
|
||||
"description": "The TLS settings for the Kafka connection.",
|
||||
"$ref": "#/definitions/TLSSettings"
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -1756,6 +1822,95 @@
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"snapshotMode": {
|
||||
"type": "string",
|
||||
"description": "Specifies how the initial snapshot of data is taken (for example, initial load, initial only, or no data).",
|
||||
"enum": [
|
||||
"Initial",
|
||||
"InitialOnly",
|
||||
"NoData"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "SnapshotMode",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "Initial",
|
||||
"description": "The snapshot mode is Initial."
|
||||
},
|
||||
{
|
||||
"value": "InitialOnly",
|
||||
"description": "The snapshot mode is InitialOnly."
|
||||
},
|
||||
{
|
||||
"value": "NoData",
|
||||
"description": "The snapshot mode is NoData."
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"BaseSQLServerCDCSourceProperties": {
|
||||
"type": "object",
|
||||
"description": "Base SQL Server CDC source properties. Extends BaseSQLCDCSourceProperties with SQL Server-specific settings.",
|
||||
"properties": {
|
||||
"excludedColumns": {
|
||||
"type": "string",
|
||||
"description": "The comma-separated list of columns to exclude from capture."
|
||||
},
|
||||
"databaseApplicationIntent": {
|
||||
"type": "string",
|
||||
"description": "Specifies the application intent for the database connection.",
|
||||
"enum": [
|
||||
"ReadWrite",
|
||||
"ReadOnly"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "DatabaseApplicationIntent",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "ReadWrite",
|
||||
"description": "The database application intent is ReadWrite."
|
||||
},
|
||||
{
|
||||
"value": "ReadOnly",
|
||||
"description": "The database application intent is ReadOnly."
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"snapshotSelectStatementOverrides": {
|
||||
"type": "array",
|
||||
"description": "The snapshot select statement overrides. Each entry specifies a table and a custom SELECT statement to use for the initial snapshot.",
|
||||
"items": {
|
||||
"$ref": "#/definitions/SnapshotSelectStatementOverrideItem"
|
||||
}
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/BaseSQLCDCSourceProperties"
|
||||
}
|
||||
]
|
||||
},
|
||||
"SnapshotSelectStatementOverrideItem": {
|
||||
"type": "object",
|
||||
"description": "Represents a snapshot select statement override for a specific table.",
|
||||
"required": [
|
||||
"tableName",
|
||||
"selectStatement"
|
||||
],
|
||||
"properties": {
|
||||
"tableName": {
|
||||
"type": "string",
|
||||
"description": "The table name."
|
||||
},
|
||||
"selectStatement": {
|
||||
"type": "string",
|
||||
"description": "The custom SELECT statement to use for the initial snapshot."
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -1780,7 +1935,8 @@
|
||||
"description": "Specifies the locking strategy used when taking the initial snapshot (for example, minimal locks vs extended locking for stronger consistency).",
|
||||
"enum": [
|
||||
"Minimal",
|
||||
"Extended"
|
||||
"Extended",
|
||||
"None"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "SnapshotLockingMode",
|
||||
@@ -1793,6 +1949,10 @@
|
||||
{
|
||||
"value": "Extended",
|
||||
"description": "The snapshot locking mode is Extended."
|
||||
},
|
||||
{
|
||||
"value": "None",
|
||||
"description": "The snapshot locking mode is None."
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -1850,6 +2010,17 @@
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"heartbeatActionQuery": {
|
||||
"type": "string",
|
||||
"description": "The heartbeat action query. A SQL statement executed periodically to keep the replication slot active."
|
||||
},
|
||||
"snapshotSelectStatementOverrides": {
|
||||
"type": "array",
|
||||
"description": "The snapshot select statement overrides. Each entry specifies a table and a custom SELECT statement to use for the initial snapshot.",
|
||||
"items": {
|
||||
"$ref": "#/definitions/SnapshotSelectStatementOverrideItem"
|
||||
}
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
@@ -2051,6 +2222,10 @@
|
||||
"topic": {
|
||||
"type": "string",
|
||||
"description": "The MQTT topic."
|
||||
},
|
||||
"tlsSettings": {
|
||||
"description": "The TLS settings for the MQTT connection.",
|
||||
"$ref": "#/definitions/TLSSettings"
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -2233,6 +2408,141 @@
|
||||
"description": "The advanced filters defined in https://learn.microsoft.com/en-us/azure/event-grid/event-filtering#advanced-filtering."
|
||||
}
|
||||
}
|
||||
},
|
||||
"TLSSettings": {
|
||||
"type": "object",
|
||||
"description": "Represents the TLS settings for a source connection.",
|
||||
"properties": {
|
||||
"trustCACertificate": {
|
||||
"description": "The trust CA certificate settings.",
|
||||
"$ref": "#/definitions/TrustCACertificate"
|
||||
},
|
||||
"clientCertificate": {
|
||||
"description": "The client certificate settings.",
|
||||
"$ref": "#/definitions/ClientCertificate"
|
||||
}
|
||||
}
|
||||
},
|
||||
"TrustCACertificate": {
|
||||
"type": "object",
|
||||
"description": "Represents the trust CA certificate settings.",
|
||||
"required": [
|
||||
"verifyHostname"
|
||||
],
|
||||
"properties": {
|
||||
"certificate": {
|
||||
"description": "The certificate resource.",
|
||||
"$ref": "#/definitions/CertificateResource"
|
||||
},
|
||||
"verifyHostname": {
|
||||
"type": "boolean",
|
||||
"description": "Determines whether the client verifies the broker's certificate hostname during the TLS handshake. When false, the client can connect even if the broker's certificate does not match its hostname."
|
||||
},
|
||||
"cipherSuites": {
|
||||
"type": "string",
|
||||
"description": "The cipher suites to use for the TLS connection."
|
||||
}
|
||||
}
|
||||
},
|
||||
"ClientCertificate": {
|
||||
"type": "object",
|
||||
"description": "Represents the client certificate settings.",
|
||||
"properties": {
|
||||
"certificate": {
|
||||
"description": "The certificate resource.",
|
||||
"$ref": "#/definitions/CertificateResource"
|
||||
},
|
||||
"revocationMode": {
|
||||
"type": "string",
|
||||
"description": "The TLS certificate revocation mode. Additional modes may be added over time.",
|
||||
"enum": [
|
||||
"Off",
|
||||
"CRL",
|
||||
"OCSP",
|
||||
"CRLAndOCSP"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "TLSRevocationMode",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "Off",
|
||||
"description": "Revocation checking is disabled."
|
||||
},
|
||||
{
|
||||
"value": "CRL",
|
||||
"description": "Revocation checking uses CRL (Certificate Revocation List)."
|
||||
},
|
||||
{
|
||||
"value": "OCSP",
|
||||
"description": "Revocation checking uses OCSP (Online Certificate Status Protocol)."
|
||||
},
|
||||
{
|
||||
"value": "CRLAndOCSP",
|
||||
"description": "Revocation checking uses both CRL and OCSP."
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"CertificateResource": {
|
||||
"type": "object",
|
||||
"description": "Base type for certificate resources. Additional types may be added over time.",
|
||||
"discriminator": "type",
|
||||
"required": [
|
||||
"type"
|
||||
],
|
||||
"properties": {
|
||||
"type": {
|
||||
"description": "The certificate resource type.",
|
||||
"$ref": "#/definitions/CertificateResourceType"
|
||||
}
|
||||
}
|
||||
},
|
||||
"CertificateResourceType": {
|
||||
"type": "string",
|
||||
"description": "The certificate resource type. Additional types may be added over time.",
|
||||
"enum": [
|
||||
"KeyVault"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "CertificateResourceType",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "KeyVault",
|
||||
"description": "The certificate is stored in Azure Key Vault."
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"KeyVaultCertificateResource": {
|
||||
"type": "object",
|
||||
"description": "A certificate stored in Azure Key Vault.",
|
||||
"x-ms-discriminator-value": "KeyVault",
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/CertificateResource"
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"required": [
|
||||
"azureKeyVaultResourceId",
|
||||
"certificateName"
|
||||
],
|
||||
"properties": {
|
||||
"azureKeyVaultResourceId": {
|
||||
"type": "string",
|
||||
"description": "The Azure Key Vault resource ID (Azure Resource Manager (ARM) resource ID, not a UUID)."
|
||||
},
|
||||
"certificateName": {
|
||||
"type": "string",
|
||||
"description": "The certificate name in the Key Vault."
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -134,6 +134,30 @@
|
||||
},
|
||||
"status": "Running"
|
||||
},
|
||||
{
|
||||
"id": "b5c6d7e8-f9a0-4b1c-d2e3-f4a5b6c7d8e9",
|
||||
"name": "FabricAnomalyDetectionEventsSource",
|
||||
"type": "FabricAnomalyDetectionEvents",
|
||||
"properties": {
|
||||
"workspaceId": "9625b495-17b3-4d6c-aeea-a81ae76ba369",
|
||||
"itemId": "ee579458-85ea-4652-bd77-5c7d7c298b2a",
|
||||
"configurationId": "c1d2e3f4-a5b6-4c7d-8e9f-0a1b2c3d4e5f",
|
||||
"includedEventTypes": [
|
||||
"Microsoft.Fabric.AnomalyDetection.AnomalyDetected"
|
||||
],
|
||||
"filters": [
|
||||
{
|
||||
"operatorType": "StringIn",
|
||||
"key": "data.severity",
|
||||
"values": [
|
||||
"High",
|
||||
"Critical"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"status": "Running"
|
||||
},
|
||||
{
|
||||
"id": "f9c8c1e2-1c5b-4c2a-8f3a-1a2b3c4d5e6f",
|
||||
"name": "FabricJobEventsSource",
|
||||
@@ -258,7 +282,25 @@
|
||||
"consumerGroupName": "consumerGroupName",
|
||||
"autoOffsetReset": "Latest",
|
||||
"saslMechanism": "SCRAM-SHA-512",
|
||||
"securityProtocol": "SASL_SSL"
|
||||
"securityProtocol": "SASL_SSL",
|
||||
"tlsSettings": {
|
||||
"trustCACertificate": {
|
||||
"certificate": {
|
||||
"type": "KeyVault",
|
||||
"azureKeyVaultResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.KeyVault/vaults/myVault",
|
||||
"certificateName": "my-ca-cert"
|
||||
},
|
||||
"verifyHostname": true
|
||||
},
|
||||
"clientCertificate": {
|
||||
"certificate": {
|
||||
"type": "KeyVault",
|
||||
"azureKeyVaultResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.KeyVault/vaults/myVault",
|
||||
"certificateName": "my-client-cert"
|
||||
},
|
||||
"revocationMode": "CRL"
|
||||
}
|
||||
}
|
||||
},
|
||||
"status": "Running"
|
||||
},
|
||||
@@ -292,8 +334,17 @@
|
||||
"type": "AzureSQLDBCDC",
|
||||
"properties": {
|
||||
"dataConnectionId": "2e4c91e7-0c4a-4cc4-abe3-cc7ba4310a37",
|
||||
"tableName": "tableName",
|
||||
"decimalHandlingMode": "Precise"
|
||||
"tableName": "dbo.Orders",
|
||||
"decimalHandlingMode": "Precise",
|
||||
"snapshotMode": "InitialOnly",
|
||||
"excludedColumns": "dbo.Orders.secret_col,dbo.Orders.internal_col",
|
||||
"databaseApplicationIntent": "ReadOnly",
|
||||
"snapshotSelectStatementOverrides": [
|
||||
{
|
||||
"tableName": "dbo.Orders",
|
||||
"selectStatement": "SELECT * FROM dbo.Orders WHERE active = 1"
|
||||
}
|
||||
]
|
||||
},
|
||||
"status": "Running"
|
||||
},
|
||||
@@ -303,8 +354,11 @@
|
||||
"type": "AzureSQLMIDBCDC",
|
||||
"properties": {
|
||||
"dataConnectionId": "2e4c91e7-0c4a-4cc4-abe3-cc7ba4310a37",
|
||||
"tableName": "tableName",
|
||||
"decimalHandlingMode": "Double"
|
||||
"tableName": "dbo.Products",
|
||||
"decimalHandlingMode": "Double",
|
||||
"snapshotMode": "Initial",
|
||||
"excludedColumns": "dbo.Products.internal_flag",
|
||||
"databaseApplicationIntent": "ReadWrite"
|
||||
},
|
||||
"status": "Running"
|
||||
},
|
||||
@@ -314,8 +368,9 @@
|
||||
"type": "SQLServerOnVMDBCDC",
|
||||
"properties": {
|
||||
"dataConnectionId": "2e4c91e7-0c4a-4cc4-abe3-cc7ba4310a37",
|
||||
"tableName": "tableName",
|
||||
"decimalHandlingMode": "String"
|
||||
"tableName": "dbo.Inventory",
|
||||
"decimalHandlingMode": "String",
|
||||
"snapshotMode": "NoData"
|
||||
},
|
||||
"status": "Running"
|
||||
},
|
||||
@@ -325,9 +380,11 @@
|
||||
"type": "MySQLCDC",
|
||||
"properties": {
|
||||
"dataConnectionId": "2e4c91e7-0c4a-4cc4-abe3-cc7ba4310a37",
|
||||
"tableName": "tableName",
|
||||
"serverId": 9,
|
||||
"tableName": "inventory.products",
|
||||
"serverId": 12345,
|
||||
"port": 3306,
|
||||
"decimalHandlingMode": "Precise",
|
||||
"snapshotMode": "Initial",
|
||||
"snapshotLockingMode": "Minimal"
|
||||
},
|
||||
"status": "Running"
|
||||
@@ -338,11 +395,20 @@
|
||||
"type": "PostgreSQLCDC",
|
||||
"properties": {
|
||||
"dataConnectionId": "2e4c91e7-0c4a-4cc4-abe3-cc7ba4310a37",
|
||||
"tableName": "tableName",
|
||||
"slotName": "slotName",
|
||||
"tableName": "public.orders",
|
||||
"slotName": "my_slot",
|
||||
"port": 5432,
|
||||
"decimalHandlingMode": "Double",
|
||||
"snapshotMode": "InitialOnly",
|
||||
"publicationName": "my_publication",
|
||||
"publicationAutoCreateMode": "Filtered"
|
||||
"publicationAutoCreateMode": "AllTables",
|
||||
"heartbeatActionQuery": "INSERT INTO heartbeat (ts) VALUES (NOW())",
|
||||
"snapshotSelectStatementOverrides": [
|
||||
{
|
||||
"tableName": "public.orders",
|
||||
"selectStatement": "SELECT * FROM public.orders WHERE created_at >= '2025-01-01'"
|
||||
}
|
||||
]
|
||||
},
|
||||
"status": "Running"
|
||||
},
|
||||
@@ -401,7 +467,17 @@
|
||||
"properties": {
|
||||
"dataConnectionId": "6950656c-9f6d-48e8-b7d1-6cf9eb7cca28",
|
||||
"serverVersion": "V5",
|
||||
"topic": "mqttTopicName"
|
||||
"topic": "mqttTopicName",
|
||||
"tlsSettings": {
|
||||
"trustCACertificate": {
|
||||
"certificate": {
|
||||
"type": "KeyVault",
|
||||
"azureKeyVaultResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.KeyVault/vaults/myVault",
|
||||
"certificateName": "my-mqtt-ca-cert"
|
||||
},
|
||||
"verifyHostname": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"status": "Running"
|
||||
},
|
||||
|
||||
+363
-6
@@ -150,27 +150,45 @@
|
||||
"required": ["id", "enabled"],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "../platform/definitions/platform.json#/definitions/ItemSchedule"
|
||||
"$ref": "../common/job_scheduling.json#/definitions/BaseItemSchedule"
|
||||
}
|
||||
]
|
||||
],
|
||||
"properties": {
|
||||
"executionData": {
|
||||
"description": "The execution data for the refresh materialized lake views.",
|
||||
"$ref": "#/definitions/RefreshMaterializedLakeViewsExecutionData"
|
||||
}
|
||||
}
|
||||
},
|
||||
"CreateLakehouseRefreshMaterializedLakeViewsScheduleRequest": {
|
||||
"description": "Create lakehouse refresh materialized lake views schedule request payload.",
|
||||
"type": "object",
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "../platform/definitions/platform.json#/definitions/CreateScheduleRequest"
|
||||
"$ref": "../common/job_scheduling.json#/definitions/BaseCreateScheduleRequest"
|
||||
}
|
||||
]
|
||||
],
|
||||
"properties": {
|
||||
"executionData": {
|
||||
"description": "The execution data for the refresh materialized lake views.",
|
||||
"$ref": "#/definitions/RefreshMaterializedLakeViewsExecutionData"
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateLakehouseRefreshMaterializedLakeViewsScheduleRequest": {
|
||||
"description": "Update lakehouse refresh materialized lake views schedule request payload.",
|
||||
"type": "object",
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "../platform/definitions/platform.json#/definitions/UpdateScheduleRequest"
|
||||
"$ref": "../common/job_scheduling.json#/definitions/BaseUpdateScheduleRequest"
|
||||
}
|
||||
]
|
||||
],
|
||||
"properties": {
|
||||
"executionData": {
|
||||
"description": "The execution data for the refresh materialized lake views.",
|
||||
"$ref": "#/definitions/RefreshMaterializedLakeViewsExecutionData"
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateLakehouseDefinitionRequest": {
|
||||
"description": "Update Lakehouse public definition request payload.",
|
||||
@@ -509,6 +527,345 @@
|
||||
"description": "Overrides the default retention period. Unreferenced files or data files associated with delta table versions older than the specified retention period are removed. This value should follow the pattern of `d:hh:mm:ss` where d is the number of days, hh is the number of hours between 00 and 23, mm is the number of minutes between 00 and 59, and ss is the number of seconds between 00 and 59."
|
||||
}
|
||||
}
|
||||
},
|
||||
"MaterializedLakeViewExecutionDefinitions": {
|
||||
"description": "A list of materialized lake view execution definitions.",
|
||||
"required": ["value"],
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"value": {
|
||||
"description": "A list of materialized lake view execution definitions.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/MaterializedLakeViewExecutionDefinition"
|
||||
}
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "../common/definitions.json#/definitions/PaginatedResponse"
|
||||
}
|
||||
]
|
||||
},
|
||||
"MaterializedLakeViewExecutionDefinition": {
|
||||
"description": "A materialized lake views execution definition object.",
|
||||
"type": "object",
|
||||
"required": ["id", "displayName", "currentLakehouseExecutionContext"],
|
||||
"properties": {
|
||||
"id": {
|
||||
"description": "The materialized lake views execution definition ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"readOnly": true
|
||||
},
|
||||
"displayName": {
|
||||
"description": "The materialized lake views execution definition display name.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"description": {
|
||||
"description": "A short description of the materialized lake views execution definition.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"settings": {
|
||||
"description": "The materialized lake views execution definition settings.",
|
||||
"$ref": "#/definitions/MaterializedLakeViewExecutionDefinitionSettingsResponse",
|
||||
"readOnly": false
|
||||
},
|
||||
"currentLakehouseExecutionContext": {
|
||||
"description": "The current lakehouse execution context for the materialized lake views execution definition.",
|
||||
"$ref": "#/definitions/CurrentLakehouseExecutionContext",
|
||||
"readOnly": false
|
||||
},
|
||||
"extendedLineageExecutionContext": {
|
||||
"description": "The extended lineage execution context for the materialized lake views execution definition.",
|
||||
"$ref": "#/definitions/ExtendedLineageExecutionContextResponse",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"CreateMaterializedLakeViewExecutionDefinitionRequest": {
|
||||
"description": "Create materialized lake views execution definition request payload.",
|
||||
"type": "object",
|
||||
"required": ["displayName", "currentLakehouseExecutionContext"],
|
||||
"properties": {
|
||||
"displayName": {
|
||||
"description": "The materialized lake views execution definition display name.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"description": {
|
||||
"description": "A short description of the materialized lake views execution definition.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"settings": {
|
||||
"description": "The materialized lake views execution definition settings.",
|
||||
"$ref": "#/definitions/MaterializedLakeViewExecutionDefinitionSettingsRequest",
|
||||
"readOnly": false
|
||||
},
|
||||
"currentLakehouseExecutionContext": {
|
||||
"description": "The current lakehouse execution context for the materialized lake views execution definition.",
|
||||
"$ref": "#/definitions/CurrentLakehouseExecutionContext",
|
||||
"readOnly": false
|
||||
},
|
||||
"extendedLineageExecutionContext": {
|
||||
"description": "The extended lineage execution context for the materialized lake views execution definition.",
|
||||
"$ref": "#/definitions/ExtendedLineageExecutionContextRequest",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateMaterializedLakeViewExecutionDefinitionRequest": {
|
||||
"description": "Update materialized lake views execution definition request payload. Only the fields provided are updated; omitted fields retain their existing values.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"displayName": {
|
||||
"description": "The materialized lake views execution definition display name.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"description": {
|
||||
"description": "A short description of the materialized lake views execution definition.",
|
||||
"type": "string",
|
||||
"readOnly": false
|
||||
},
|
||||
"settings": {
|
||||
"description": "The materialized lake views execution definition settings.",
|
||||
"$ref": "#/definitions/MaterializedLakeViewExecutionDefinitionSettingsRequest",
|
||||
"readOnly": false
|
||||
},
|
||||
"currentLakehouseExecutionContext": {
|
||||
"description": "The current lakehouse execution context for the materialized lake views execution definition.",
|
||||
"$ref": "#/definitions/CurrentLakehouseExecutionContext",
|
||||
"readOnly": false
|
||||
},
|
||||
"extendedLineageExecutionContext": {
|
||||
"description": "The extended lineage execution context for the materialized lake views execution definition.",
|
||||
"$ref": "#/definitions/ExtendedLineageExecutionContextRequest",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"MaterializedLakeViewExecutionDefinitionSettingsRequest": {
|
||||
"description": "The materialized lake views execution definition settings.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"environment": {
|
||||
"description": "The Spark environment reference to be used with the materialized lake views execution definition.",
|
||||
"$ref": "../common/definitions.json#/definitions/ItemReferenceById",
|
||||
"readOnly": false
|
||||
},
|
||||
"refreshMode": {
|
||||
"description": "The refresh mode setting to be used with the materialized lake views execution definition. Defaults to `Optimal` if not specified.",
|
||||
"$ref": "#/definitions/RefreshMode",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"MaterializedLakeViewExecutionDefinitionSettingsResponse": {
|
||||
"description": "The materialized lake views execution definition settings (response).",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"environment": {
|
||||
"description": "The Spark environment reference to be used with the materialized lake views execution definition.",
|
||||
"$ref": "../common/definitions.json#/definitions/ItemReference",
|
||||
"readOnly": false
|
||||
},
|
||||
"refreshMode": {
|
||||
"description": "The refresh mode setting to be used with the materialized lake views execution definition. Defaults to `Optimal` if not specified.",
|
||||
"$ref": "#/definitions/RefreshMode",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"RefreshMode":{
|
||||
"type": "string",
|
||||
"description": "The refresh mode for the execution definition. Additional `RefreshMode` types may be added over time.",
|
||||
"enum": [
|
||||
"Optimal",
|
||||
"Full"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "RefreshMode",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "Optimal",
|
||||
"description": "This mode chooses the best strategy to maximize performance from among incremental, full, or no recompute while refreshing each materialized lake view."
|
||||
},
|
||||
{
|
||||
"value": "Full",
|
||||
"description": "This mode enforces the full recompute for materialized lake views being refreshed."
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"CurrentLakehouseExecutionContext": {
|
||||
"description": "The current lakehouse execution context for a materialized lake views execution definition.",
|
||||
"type": "object",
|
||||
"required": ["mode"],
|
||||
"discriminator": "mode",
|
||||
"properties": {
|
||||
"mode": {
|
||||
"description": "The execution context mode for the current lakehouse.",
|
||||
"$ref": "#/definitions/ExecutionContextMode",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"CurrentLakehouseExecutionContextAll": {
|
||||
"description": "Current lakehouse execution context where all materialized lake views are included.",
|
||||
"type": "object",
|
||||
"x-ms-discriminator-value": "All",
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/CurrentLakehouseExecutionContext"
|
||||
}
|
||||
]
|
||||
},
|
||||
"CurrentLakehouseExecutionContextSelected": {
|
||||
"description": "Current lakehouse execution context where only selected materialized lake views are included.",
|
||||
"type": "object",
|
||||
"x-ms-discriminator-value": "Selected",
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/CurrentLakehouseExecutionContext"
|
||||
}
|
||||
],
|
||||
"properties": {
|
||||
"selectedMlvs": {
|
||||
"description": "The list of fully qualified names of materialized lake views from the current lakehouse to be refreshed.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"readOnly": false
|
||||
}
|
||||
},
|
||||
"required": ["selectedMlvs"]
|
||||
},
|
||||
"ExtendedLineageExecutionContextRequest": {
|
||||
"description": "The extended lineage execution context for a materialized lake views execution definition.",
|
||||
"type": "object",
|
||||
"required": ["mode"],
|
||||
"discriminator": "mode",
|
||||
"properties": {
|
||||
"mode": {
|
||||
"description": "The execution context mode for extended lineage.",
|
||||
"$ref": "#/definitions/ExecutionContextMode",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"ExtendedLineageExecutionContextRequestAll": {
|
||||
"description": "Extended lineage execution context where all lakehouses are included.",
|
||||
"type": "object",
|
||||
"x-ms-discriminator-value": "All",
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/ExtendedLineageExecutionContextRequest"
|
||||
}
|
||||
]
|
||||
},
|
||||
"ExtendedLineageExecutionContextRequestSelected": {
|
||||
"description": "Extended lineage execution context where only selected lakehouses are included.",
|
||||
"type": "object",
|
||||
"x-ms-discriminator-value": "Selected",
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/ExtendedLineageExecutionContextRequest"
|
||||
}
|
||||
],
|
||||
"properties": {
|
||||
"selectedLakehouses": {
|
||||
"description": "The list of lakehouses to be included in refresh.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "../common/definitions.json#/definitions/ItemReferenceById"
|
||||
},
|
||||
"readOnly": false
|
||||
}
|
||||
},
|
||||
"required": ["selectedLakehouses"]
|
||||
},
|
||||
"ExtendedLineageExecutionContextResponse": {
|
||||
"description": "The extended lineage execution context for a materialized lake views execution definition (response).",
|
||||
"type": "object",
|
||||
"required": ["mode"],
|
||||
"discriminator": "mode",
|
||||
"properties": {
|
||||
"mode": {
|
||||
"description": "The execution context mode for extended lineage.",
|
||||
"$ref": "#/definitions/ExecutionContextMode",
|
||||
"readOnly": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"ExtendedLineageExecutionContextResponseAll": {
|
||||
"description": "Extended lineage execution context where all lakehouses are included (response).",
|
||||
"type": "object",
|
||||
"x-ms-discriminator-value": "All",
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/ExtendedLineageExecutionContextResponse"
|
||||
}
|
||||
]
|
||||
},
|
||||
"ExtendedLineageExecutionContextResponseSelected": {
|
||||
"description": "Extended lineage execution context where only selected lakehouses are included (response).",
|
||||
"type": "object",
|
||||
"x-ms-discriminator-value": "Selected",
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/ExtendedLineageExecutionContextResponse"
|
||||
}
|
||||
],
|
||||
"properties": {
|
||||
"selectedLakehouses": {
|
||||
"description": "The list of lakehouses to be included in refresh.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "../common/definitions.json#/definitions/ItemReference"
|
||||
},
|
||||
"readOnly": false
|
||||
}
|
||||
},
|
||||
"required": ["selectedLakehouses"]
|
||||
},
|
||||
"ExecutionContextMode": {
|
||||
"type": "string",
|
||||
"description": "The execution context mode. Additional `ExecutionContextMode` types may be added over time.",
|
||||
"enum": [
|
||||
"All",
|
||||
"Selected"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "ExecutionContextMode",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "All",
|
||||
"description": "All items are included in the execution boundary."
|
||||
},
|
||||
{
|
||||
"value": "Selected",
|
||||
"description": "Only selected items are included in the execution boundary."
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"RefreshMaterializedLakeViewsExecutionData": {
|
||||
"description": "The execution data for the refresh materialized lake views.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"mlvExecutionDefinitionId": {
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"description": "The MLV Execution Definition Id."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,70 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1",
|
||||
"lakehouseId": "dddddddd-9999-0000-1111-eeeeeeeeeeee",
|
||||
"createMLVExecutionDefinitionRequest": {
|
||||
"displayName": "Gold Chain – Sales",
|
||||
"description": "Weekly report on Gold chain",
|
||||
"settings": {
|
||||
"environment": {
|
||||
"referenceType": "ById",
|
||||
"itemId": "aaaaaaaa-1111-2222-3333-bbbbbbbbbbbb",
|
||||
"workspaceId": "11111111-2222-3333-4444-555555555555"
|
||||
},
|
||||
"refreshMode": "Optimal"
|
||||
},
|
||||
"currentLakehouseExecutionContext": {
|
||||
"mode": "Selected",
|
||||
"selectedMlvs": [
|
||||
"schema.mlvName1"
|
||||
]
|
||||
},
|
||||
"extendedLineageExecutionContext": {
|
||||
"mode": "Selected",
|
||||
"selectedLakehouses": [
|
||||
{
|
||||
"referenceType": "ById",
|
||||
"itemId": "cccccccc-4444-5555-6666-dddddddddddd",
|
||||
"workspaceId": "11111111-2222-3333-4444-555555555555"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"201": {
|
||||
"headers": {
|
||||
"Location": "https://api.fabric.microsoft.com/v1/workspaces/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/lakehouses/dddddddd-9999-0000-1111-eeeeeeeeeeee/mlvexecutiondefinitions/bbbbbbbb-1111-2222-3333-cccccccccccc"
|
||||
},
|
||||
"body": {
|
||||
"id": "bbbbbbbb-1111-2222-3333-cccccccccccc",
|
||||
"displayName": "Gold Chain – Sales",
|
||||
"description": "Weekly report on Gold chain",
|
||||
"settings": {
|
||||
"environment": {
|
||||
"referenceType": "ById",
|
||||
"itemId": "aaaaaaaa-1111-2222-3333-bbbbbbbbbbbb",
|
||||
"workspaceId": "11111111-2222-3333-4444-555555555555"
|
||||
},
|
||||
"refreshMode": "Optimal"
|
||||
},
|
||||
"currentLakehouseExecutionContext": {
|
||||
"mode": "Selected",
|
||||
"selectedMlvs": [
|
||||
"schema.mlvName1"
|
||||
]
|
||||
},
|
||||
"extendedLineageExecutionContext": {
|
||||
"mode": "Selected",
|
||||
"selectedLakehouses": [
|
||||
{
|
||||
"referenceType": "ById",
|
||||
"itemId": "cccccccc-4444-5555-6666-dddddddddddd",
|
||||
"workspaceId": "11111111-2222-3333-4444-555555555555"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -11,6 +11,9 @@
|
||||
"localTimeZoneId": "Central Standard Time",
|
||||
"type": "Cron",
|
||||
"interval": 10
|
||||
},
|
||||
"executionData": {
|
||||
"mlvExecutionDefinitionId": "eeeeeeee-4444-5555-6666-ffffffffffff"
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -30,6 +33,9 @@
|
||||
"type": "Cron",
|
||||
"interval": 10
|
||||
},
|
||||
"executionData": {
|
||||
"mlvExecutionDefinitionId": "eeeeeeee-4444-5555-6666-ffffffffffff"
|
||||
},
|
||||
"owner": {
|
||||
"id": "33dd33dd-ee44-ff55-aa66-77bb77bb77bb",
|
||||
"type": "User"
|
||||
|
||||
@@ -0,0 +1,10 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1",
|
||||
"lakehouseId": "dddddddd-9999-0000-1111-eeeeeeeeeeee",
|
||||
"mlvExecutionDefinitionId": "bbbbbbbb-1111-2222-3333-cccccccccccc"
|
||||
},
|
||||
"responses": {
|
||||
"200": {}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,40 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1",
|
||||
"lakehouseId": "dddddddd-9999-0000-1111-eeeeeeeeeeee",
|
||||
"mlvExecutionDefinitionId": "bbbbbbbb-1111-2222-3333-cccccccccccc"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"id": "bbbbbbbb-1111-2222-3333-cccccccccccc",
|
||||
"displayName": "Gold Chain – Sales",
|
||||
"description": "Weekly report on Gold chain",
|
||||
"settings": {
|
||||
"environment": {
|
||||
"referenceType": "ById",
|
||||
"itemId": "aaaaaaaa-1111-2222-3333-bbbbbbbbbbbb",
|
||||
"workspaceId": "11111111-2222-3333-4444-555555555555"
|
||||
},
|
||||
"refreshMode": "Optimal"
|
||||
},
|
||||
"currentLakehouseExecutionContext": {
|
||||
"mode": "Selected",
|
||||
"selectedMlvs": [
|
||||
"schema.mlvName1"
|
||||
]
|
||||
},
|
||||
"extendedLineageExecutionContext": {
|
||||
"mode": "Selected",
|
||||
"selectedLakehouses": [
|
||||
{
|
||||
"referenceType": "ById",
|
||||
"itemId": "cccccccc-4444-5555-6666-dddddddddddd",
|
||||
"workspaceId": "11111111-2222-3333-4444-555555555555"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,50 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1",
|
||||
"lakehouseId": "dddddddd-9999-0000-1111-eeeeeeeeeeee"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"value": [
|
||||
{
|
||||
"id": "bbbbbbbb-1111-2222-3333-cccccccccccc",
|
||||
"displayName": "Gold Chain – Sales",
|
||||
"description": "Weekly report on Gold chain",
|
||||
"settings": {
|
||||
"environment": {
|
||||
"referenceType": "ById",
|
||||
"itemId": "aaaaaaaa-1111-2222-3333-bbbbbbbbbbbb",
|
||||
"workspaceId": "11111111-2222-3333-4444-555555555555"
|
||||
},
|
||||
"refreshMode": "Optimal"
|
||||
},
|
||||
"currentLakehouseExecutionContext": {
|
||||
"mode": "Selected",
|
||||
"selectedMlvs": [
|
||||
"schema.mlvName1"
|
||||
]
|
||||
},
|
||||
"extendedLineageExecutionContext": {
|
||||
"mode": "Selected",
|
||||
"selectedLakehouses": [
|
||||
{
|
||||
"referenceType": "ById",
|
||||
"itemId": "cccccccc-4444-5555-6666-dddddddddddd",
|
||||
"workspaceId": "11111111-2222-3333-4444-555555555555"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "dddddddd-5555-6666-7777-eeeeeeeeeeee",
|
||||
"displayName": "Silver Chain – Inventory",
|
||||
"currentLakehouseExecutionContext": {
|
||||
"mode": "All"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,56 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1",
|
||||
"lakehouseId": "dddddddd-9999-0000-1111-eeeeeeeeeeee",
|
||||
"mlvExecutionDefinitionId": "bbbbbbbb-1111-2222-3333-cccccccccccc",
|
||||
"updateMLVExecutionDefinitionRequest": {
|
||||
"displayName": "Updated Gold Chain – Sales",
|
||||
"settings": {
|
||||
"refreshMode": "Full"
|
||||
},
|
||||
"currentLakehouseExecutionContext": {
|
||||
"mode": "All"
|
||||
},
|
||||
"extendedLineageExecutionContext": {
|
||||
"mode": "Selected",
|
||||
"selectedLakehouses": [
|
||||
{
|
||||
"referenceType": "ById",
|
||||
"itemId": "cccccccc-4444-5555-6666-dddddddddddd",
|
||||
"workspaceId": "11111111-2222-3333-4444-555555555555"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"id": "bbbbbbbb-1111-2222-3333-cccccccccccc",
|
||||
"displayName": "Updated Gold Chain – Sales",
|
||||
"description": "Weekly report on Gold chain",
|
||||
"settings": {
|
||||
"environment": {
|
||||
"referenceType": "ById",
|
||||
"itemId": "aaaaaaaa-1111-2222-3333-bbbbbbbbbbbb",
|
||||
"workspaceId": "11111111-2222-3333-4444-555555555555"
|
||||
},
|
||||
"refreshMode": "Full"
|
||||
},
|
||||
"currentLakehouseExecutionContext": {
|
||||
"mode": "All"
|
||||
},
|
||||
"extendedLineageExecutionContext": {
|
||||
"mode": "Selected",
|
||||
"selectedLakehouses": [
|
||||
{
|
||||
"referenceType": "ById",
|
||||
"itemId": "cccccccc-4444-5555-6666-dddddddddddd",
|
||||
"workspaceId": "11111111-2222-3333-4444-555555555555"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -11,6 +11,9 @@
|
||||
"localTimeZoneId": "Pacific Standard Time",
|
||||
"type": "Cron",
|
||||
"interval": 15
|
||||
},
|
||||
"executionData": {
|
||||
"mlvExecutionDefinitionId": "eeeeeeee-4444-5555-6666-ffffffffffff"
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -27,6 +30,9 @@
|
||||
"type": "Cron",
|
||||
"interval": 15
|
||||
},
|
||||
"executionData": {
|
||||
"mlvExecutionDefinitionId": "eeeeeeee-4444-5555-6666-ffffffffffff"
|
||||
},
|
||||
"owner": {
|
||||
"id": "33dd33dd-ee44-ff55-aa66-77bb77bb77bb",
|
||||
"type": "User"
|
||||
|
||||
@@ -1484,6 +1484,370 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/lakehouses/{lakehouseId}/mlvexecutiondefinitions": {
|
||||
"post": {
|
||||
"summary": "Creates a materialized lake views execution definition.",
|
||||
"description": "## Permissions\n\nThe caller must have *contributor* or higher workspace role.\n\n## Required Delegated Scopes\n\nLakehouse.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": [
|
||||
"MaterializedLakeViews"
|
||||
],
|
||||
"operationId": "MaterializedLakeViews_CreateMlvExecutionDefinition",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "workspaceId",
|
||||
"description": "The workspace ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "lakehouseId",
|
||||
"description": "The lakehouse ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "body",
|
||||
"name": "createMLVExecutionDefinitionRequest",
|
||||
"description": "Create materialized lake views execution definition request payload.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/CreateMaterializedLakeViewExecutionDefinitionRequest"
|
||||
},
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"201": {
|
||||
"description": "Successfully created the materialized lake views execution definition.\n\nResponse headers:\n\n* `Location` - The URL of the newly created materialized lake views execution definition.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/MaterializedLakeViewExecutionDefinition"
|
||||
}
|
||||
},
|
||||
"429": {
|
||||
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
||||
"x-ms-error-response": true,
|
||||
"headers": {
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
},
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* InvalidRequest - Request parameters are invalid or not in a supported format\n\n* InsufficientPrivileges - The caller does not have sufficient permissions\n\n* ItemNotFound - Requested item ID not found\n\n* ConflictingRequest - A conflicting materialized lake views execution definition already exists",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Create a materialized lake views execution definition example": {
|
||||
"$ref": "./examples/CreateExecutionDefinition.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"get": {
|
||||
"summary": "Returns a list of materialized lake views execution definitions for a lakehouse.",
|
||||
"description": "This API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\nThe caller must have *viewer* or higher workspace role.\n\n## Required Delegated Scopes\n\nLakehouse.Read.All or Lakehouse.ReadWrite.All or Item.Read.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"MaterializedLakeViews"
|
||||
],
|
||||
"operationId": "MaterializedLakeViews_ListMlvExecutionDefinitions",
|
||||
"x-ms-pageable": {
|
||||
"nextLinkName": "continuationUri"
|
||||
},
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "workspaceId",
|
||||
"description": "The workspace ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "lakehouseId",
|
||||
"description": "The lakehouse 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/MaterializedLakeViewExecutionDefinitions"
|
||||
}
|
||||
},
|
||||
"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\n\n* ItemNotFound - Requested item ID not found",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"List materialized lake views execution definitions example": {
|
||||
"$ref": "./examples/ListExecutionDefinitions.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/lakehouses/{lakehouseId}/mlvexecutiondefinitions/{mlvExecutionDefinitionId}": {
|
||||
"get": {
|
||||
"summary": "Returns the specified materialized lake views execution definition.",
|
||||
"description": "## Permissions\n\nThe caller must have *viewer* or higher workspace role.\n\n## Required Delegated Scopes\n\nLakehouse.Read.All or Lakehouse.ReadWrite.All or Item.Read.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"MaterializedLakeViews"
|
||||
],
|
||||
"operationId": "MaterializedLakeViews_GetMlvExecutionDefinition",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "workspaceId",
|
||||
"description": "The workspace ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "lakehouseId",
|
||||
"description": "The lakehouse ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "mlvExecutionDefinitionId",
|
||||
"description": "The materialized lake views execution definition ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/MaterializedLakeViewExecutionDefinition"
|
||||
}
|
||||
},
|
||||
"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\n\n* ItemNotFound - Requested item ID not found",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Get a materialized lake views execution definition example": {
|
||||
"$ref": "./examples/GetExecutionDefinition.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"patch": {
|
||||
"summary": "Updates the specified materialized lake views execution definition.",
|
||||
"description": "Only the fields provided in the request body are updated; omitted fields retain their existing values.\n\n## Permissions\n\nThe caller must have *contributor* or higher workspace role.\n\n## Required Delegated Scopes\n\nLakehouse.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": [
|
||||
"MaterializedLakeViews"
|
||||
],
|
||||
"operationId": "MaterializedLakeViews_UpdateMlvExecutionDefinition",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "workspaceId",
|
||||
"description": "The workspace ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "lakehouseId",
|
||||
"description": "The lakehouse ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "mlvExecutionDefinitionId",
|
||||
"description": "The materialized lake views execution definition ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "body",
|
||||
"name": "updateMLVExecutionDefinitionRequest",
|
||||
"description": "Update materialized lake views execution definition request payload.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/UpdateMaterializedLakeViewExecutionDefinitionRequest"
|
||||
},
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions.json#/definitions/MaterializedLakeViewExecutionDefinition"
|
||||
}
|
||||
},
|
||||
"429": {
|
||||
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
||||
"x-ms-error-response": true,
|
||||
"headers": {
|
||||
"Retry-After": {
|
||||
"type": "integer",
|
||||
"description": "The number of seconds to wait before retrying the request."
|
||||
}
|
||||
},
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "Common error codes:\n\n* InvalidRequest - Request parameters are invalid or not in a supported format\n\n* InsufficientPrivileges - The caller does not have sufficient permissions\n\n* ItemNotFound - Requested item ID not found\n\n* ConflictingRequest - A conflicting update was detected",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Update a materialized lake views execution definition example": {
|
||||
"$ref": "./examples/UpdateExecutionDefinition.json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Deletes the specified materialized lake views execution definition.",
|
||||
"description": "## Permissions\n\nThe caller must have *contributor* or higher workspace role.\n\n## Required Delegated Scopes\n\nLakehouse.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": [
|
||||
"MaterializedLakeViews"
|
||||
],
|
||||
"operationId": "MaterializedLakeViews_DeleteMlvExecutionDefinition",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "workspaceId",
|
||||
"description": "The workspace ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "lakehouseId",
|
||||
"description": "The lakehouse ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "mlvExecutionDefinitionId",
|
||||
"description": "The materialized lake views execution definition 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* InsufficientPrivileges - The caller does not have sufficient permissions\n\n* ItemNotFound - Requested item ID not found",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Delete a materialized lake views execution definition example": {
|
||||
"$ref": "./examples/DeleteExecutionDefinition.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {},
|
||||
|
||||
@@ -83,7 +83,7 @@
|
||||
}
|
||||
},
|
||||
"PaginatedReportDefinition": {
|
||||
"description": "Paginated report public definition object. Refer to this [article](/rest/api/fabric/articles/item-management/definitions/paginatedreport-definition.md) for more details on the structure of the Paginated Report definition.",
|
||||
"description": "Paginated report public definition object. Refer to this [article](/rest/api/fabric/articles/item-management/definitions/paginatedreport-definition) for more details on the structure of the Paginated Report definition.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"parts"
|
||||
|
||||
@@ -0,0 +1,151 @@
|
||||
{
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"version": "v1",
|
||||
"title": "Relations data types"
|
||||
},
|
||||
"paths": {},
|
||||
"definitions": {
|
||||
"RelationsResponse": {
|
||||
"description": "A response containing related items, relation edges, and referenced workspaces.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"items": {
|
||||
"description": "A list of related items.",
|
||||
"type": "array",
|
||||
"readOnly": true,
|
||||
"items": {
|
||||
"$ref": "#/definitions/RelationsRelatedItem"
|
||||
}
|
||||
},
|
||||
"relations": {
|
||||
"description": "A list of relation edges between items.",
|
||||
"type": "array",
|
||||
"readOnly": true,
|
||||
"items": {
|
||||
"$ref": "#/definitions/RelationsEdge"
|
||||
}
|
||||
},
|
||||
"workspaces": {
|
||||
"description": "A list of workspaces referenced by the related items.",
|
||||
"type": "array",
|
||||
"readOnly": true,
|
||||
"items": {
|
||||
"$ref": "#/definitions/RelationsWorkspace"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"RelationsRelatedItem": {
|
||||
"description": "An item that is related to the specified item. This is a subset of the full item object, containing only the properties returned by the relations APIs.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"description": "The item ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"readOnly": true
|
||||
},
|
||||
"type": {
|
||||
"description": "The item type.",
|
||||
"$ref": "../../common/definitions.json#/definitions/ItemType",
|
||||
"readOnly": true
|
||||
},
|
||||
"displayName": {
|
||||
"description": "The item display name.",
|
||||
"type": "string",
|
||||
"readOnly": true
|
||||
},
|
||||
"workspaceId": {
|
||||
"description": "The ID of the workspace that contains the item. Use this ID to find the workspace in the `workspaces` list.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"readOnly": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"RelationsEdge": {
|
||||
"description": "A relation edge between two items.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"itemId": {
|
||||
"description": "The source item identifier.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"readOnly": true
|
||||
},
|
||||
"dependentOnItemId": {
|
||||
"description": "The identifier of the item that the source item depends on.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"readOnly": true
|
||||
},
|
||||
"relationType": {
|
||||
"description": "The type of relation between the two items. Additional relation types may be added over time.",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"CascadeDelete",
|
||||
"WeakAssociation",
|
||||
"Datasource",
|
||||
"PushData",
|
||||
"Orchestration",
|
||||
"Shortcut",
|
||||
"HiddenInWorkspace"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "RelationType",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "CascadeDelete",
|
||||
"description": "A CascadeDelete relationship indicates that the item is the Parent of the dependentOnItemId and deleting the item will cause the Dependent item to also be deleted."
|
||||
},
|
||||
{
|
||||
"value": "WeakAssociation",
|
||||
"description": "A WeakAssociation relationship indicates that there is a soft dependency on the item identified by the dependentOnItemId. If the Dependent item is deleted, the relationship will be removed."
|
||||
},
|
||||
{
|
||||
"value": "Datasource",
|
||||
"description": "A Datasource relationship indicates that there is a soft dependency on the item identified by a common Datasource. If the Dependent item is deleted, the relationship will be removed."
|
||||
},
|
||||
{
|
||||
"value": "PushData",
|
||||
"description": "A PushData relationship indicates that a dependent item writes/pushes data to dependecy item(the item identified by the dependentOnItemId). If the Dependent item is deleted, the relationship will be removed."
|
||||
},
|
||||
{
|
||||
"value": "Orchestration",
|
||||
"description": "An Orchestration relationship indicates that an item executes management or orchestration processes of the dependency item(the item identified by the dependentOnItemId). If the Dependent item is deleted, the relationship will be removed."
|
||||
},
|
||||
{
|
||||
"value": "Shortcut",
|
||||
"description": "A Shortcut relationship indicates that an item has a shortcut or link to data or data area from item identified by the dependentOnItemId. If the Dependent item is deleted, the relationship will be removed."
|
||||
},
|
||||
{
|
||||
"value": "HiddenInWorkspace",
|
||||
"description": "HiddenInWorkspace indicates that the item that owns this relationship will be hidden in the workspace."
|
||||
}
|
||||
]
|
||||
},
|
||||
"readOnly": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"RelationsWorkspace": {
|
||||
"description": "A workspace referenced in the relations response.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"description": "The workspace identifier.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"readOnly": true
|
||||
},
|
||||
"displayName": {
|
||||
"description": "The workspace display name.",
|
||||
"type": "string",
|
||||
"readOnly": true
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,41 @@
|
||||
{
|
||||
"title": "Get downstream relations example",
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"itemId": "9b218778-e7a5-4d73-8187-f10824047715",
|
||||
"beta": true
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"items": [
|
||||
{
|
||||
"id": "3546052c-ae64-4526-b1a8-52af7761426f",
|
||||
"type": "Report",
|
||||
"displayName": "Q4 Sales Dashboard",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
|
||||
},
|
||||
{
|
||||
"id": "9b218778-e7a5-4d73-8187-f10824047715",
|
||||
"type": "SemanticModel",
|
||||
"displayName": "Sales Semantic Model",
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
|
||||
}
|
||||
],
|
||||
"relations": [
|
||||
{
|
||||
"itemId": "3546052c-ae64-4526-b1a8-52af7761426f",
|
||||
"dependentOnItemId": "9b218778-e7a5-4d73-8187-f10824047715",
|
||||
"relationType": "PushData"
|
||||
}
|
||||
],
|
||||
"workspaces": [
|
||||
{
|
||||
"id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"displayName": "Finance Analytics Workspace"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,35 @@
|
||||
{
|
||||
"title": "Get upstream relations example",
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"itemId": "3546052c-ae64-4526-b1a8-52af7761426f",
|
||||
"beta": true
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"items": [
|
||||
{
|
||||
"id": "9b218778-e7a5-4d73-8187-f10824047715",
|
||||
"type": "Lakehouse",
|
||||
"displayName": "Enterprise Sales Lakehouse",
|
||||
"workspaceId": "9a1f7d8b-4f9c-4c1e-b8e7-3d6c2b0a5f41"
|
||||
}
|
||||
],
|
||||
"relations": [
|
||||
{
|
||||
"itemId": "3546052c-ae64-4526-b1a8-52af7761426f",
|
||||
"dependentOnItemId": "9b218778-e7a5-4d73-8187-f10824047715",
|
||||
"relationType": "PushData"
|
||||
}
|
||||
],
|
||||
"workspaces": [
|
||||
{
|
||||
"id": "9a1f7d8b-4f9c-4c1e-b8e7-3d6c2b0a5f41",
|
||||
"displayName": "Data Engineering Workspace"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -10957,6 +10957,146 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/items/{itemId}/relations/downstream?beta=true": {
|
||||
"get": {
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"summary": "Gets downstream relations for an item.",
|
||||
"description": "> [!NOTE]\n> This API is part of a Beta release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n**When calling this API, callers must specify `true` as the value for the query parameter `beta`.**\n\nReturns all items that are downstream of the specified item, including the relation edges and referenced workspaces.\n\n## Permissions\n\nThe caller must have *read* permissions for the item.\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",
|
||||
"operationId": "Items_Get_Downstream_Relations_(beta)",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "workspaceId",
|
||||
"description": "The workspace ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "itemId",
|
||||
"description": "The item ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "beta",
|
||||
"description": "This required parameter must be set to `true` to access this API, which is currently in beta.",
|
||||
"type": "boolean",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions/relations.json#/definitions/RelationsResponse"
|
||||
}
|
||||
},
|
||||
"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* InsufficientPrivileges - The caller does not have sufficient permissions to access the item.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Get downstream relations example": {
|
||||
"$ref": "./examples/platform/GetDownstreamRelations.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/workspaces/{workspaceId}/items/{itemId}/relations/upstream?beta=true": {
|
||||
"get": {
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
"summary": "Gets upstream relations for an item.",
|
||||
"description": "> [!NOTE]\n> This API is part of a Beta release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n**When calling this API, callers must specify `true` as the value for the query parameter `beta`.**\n\nReturns all items that are upstream of the specified item, including the relation edges and referenced workspaces.\n\n## Permissions\n\nThe caller must have *read* permissions for the item.\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",
|
||||
"operationId": "Items_Get_Upstream_Relations_(beta)",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "workspaceId",
|
||||
"description": "The workspace ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "itemId",
|
||||
"description": "The item ID.",
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "beta",
|
||||
"description": "This required parameter must be set to `true` to access this API, which is currently in beta.",
|
||||
"type": "boolean",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Request completed successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions/relations.json#/definitions/RelationsResponse"
|
||||
}
|
||||
},
|
||||
"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* InsufficientPrivileges - The caller does not have sufficient permissions to access the item.",
|
||||
"schema": {
|
||||
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-examples": {
|
||||
"Get upstream relations example": {
|
||||
"$ref": "./examples/platform/GetUpstreamRelations.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {},
|
||||
|
||||
Reference in new issue
Block a user