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
6bc50a0b15
commit
4dc2abd002
11 files changed
+541
-52
No files matched your search
@@ -145,27 +145,128 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"BaseCustomEndpointConnection": {
|
||||
"type": "object",
|
||||
"description": "Represents the connection information for a custom endpoint.",
|
||||
"required": [
|
||||
"fullyQualifiedNamespace",
|
||||
"eventHubName"
|
||||
"EndpointConnectionType": {
|
||||
"type": "string",
|
||||
"description": "The endpoint connection shape. Additional endpoint connection types may be added over time.",
|
||||
"enum": [
|
||||
"CustomEndpoint",
|
||||
"KafkaEndpoint"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "EndpointConnectionType",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "CustomEndpoint",
|
||||
"description": "The custom endpoint connection shape."
|
||||
},
|
||||
{
|
||||
"value": "KafkaEndpoint",
|
||||
"description": "The Kafka endpoint connection shape."
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"EndpointConnection": {
|
||||
"type": "object",
|
||||
"description": "Represents the connection information for an eventstream source or destination endpoint.",
|
||||
"discriminator": "type",
|
||||
"required": [
|
||||
"type"
|
||||
],
|
||||
"properties": {
|
||||
"type": {
|
||||
"description": "The endpoint connection shape.",
|
||||
"$ref": "#/definitions/EndpointConnectionType"
|
||||
}
|
||||
}
|
||||
},
|
||||
"CustomEndpointConnection": {
|
||||
"type": "object",
|
||||
"description": "Represents a custom endpoint connection.",
|
||||
"x-ms-discriminator-value": "CustomEndpoint",
|
||||
"properties": {
|
||||
"fullyQualifiedNamespace": {
|
||||
"type": "string",
|
||||
"description": "The fully qualified namespace of the EventHub."
|
||||
"description": "The fully qualified namespace of the Event Hub."
|
||||
},
|
||||
"eventHubName": {
|
||||
"type": "string",
|
||||
"description": "The name of the EventHub."
|
||||
"description": "The name of the Event Hub."
|
||||
},
|
||||
"consumerGroupName": {
|
||||
"type": "string",
|
||||
"description": "The consumer group name."
|
||||
},
|
||||
"accessKeys": {
|
||||
"$ref": "#/definitions/AccessKeys",
|
||||
"description": "The access keys."
|
||||
}
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/EndpointConnection"
|
||||
}
|
||||
]
|
||||
},
|
||||
"KafkaEndpointConnection": {
|
||||
"type": "object",
|
||||
"description": "Represents a Kafka endpoint connection.",
|
||||
"x-ms-discriminator-value": "KafkaEndpoint",
|
||||
"properties": {
|
||||
"bootstrapServer": {
|
||||
"type": "string",
|
||||
"description": "The Kafka bootstrap server address, including port."
|
||||
},
|
||||
"topicName": {
|
||||
"type": "string",
|
||||
"description": "The Kafka topic name."
|
||||
},
|
||||
"securityProtocol": {
|
||||
"type": "string",
|
||||
"description": "The Kafka security protocol.",
|
||||
"enum": [
|
||||
"SASL_PLAINTEXT",
|
||||
"PLAINTEXT",
|
||||
"SASL_SSL",
|
||||
"SSL"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "SecurityProtocol",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "SASL_PLAINTEXT",
|
||||
"description": "The security protocol is SASL_PLAINTEXT."
|
||||
},
|
||||
{
|
||||
"value": "PLAINTEXT",
|
||||
"description": "The security protocol is PLAINTEXT."
|
||||
},
|
||||
{
|
||||
"value": "SASL_SSL",
|
||||
"description": "The security protocol is SASL_SSL."
|
||||
},
|
||||
{
|
||||
"value": "SSL",
|
||||
"description": "The security protocol is SSL."
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"authentications": {
|
||||
"type": "array",
|
||||
"description": "The available authentication mechanisms.",
|
||||
"items": {
|
||||
"$ref": "#/definitions/EndpointAuthentication"
|
||||
}
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/EndpointConnection"
|
||||
}
|
||||
]
|
||||
},
|
||||
"AccessKeys": {
|
||||
"type": "object",
|
||||
@@ -195,6 +296,84 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"EndpointAuthentication": {
|
||||
"type": "object",
|
||||
"description": "The base authentication mechanism for an endpoint connection. The concrete type is indicated by the `saslMechanism` discriminator.",
|
||||
"discriminator": "saslMechanism",
|
||||
"required": [
|
||||
"saslMechanism"
|
||||
],
|
||||
"properties": {
|
||||
"saslMechanism": {
|
||||
"type": "string",
|
||||
"description": "The SASL authentication mechanism. Additional authentication mechanisms may be added over time.",
|
||||
"enum": [
|
||||
"OAuthBearer",
|
||||
"Plain"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "AuthenticationMechanism",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "OAuthBearer",
|
||||
"description": "The OAuthBearer SASL mechanism."
|
||||
},
|
||||
{
|
||||
"value": "Plain",
|
||||
"description": "The Plain SASL mechanism."
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"OAuthBearerAuthentication": {
|
||||
"type": "object",
|
||||
"description": "Represents the OAuthBearer SASL authentication mechanism.",
|
||||
"x-ms-discriminator-value": "OAuthBearer",
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/EndpointAuthentication"
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"scope"
|
||||
],
|
||||
"properties": {
|
||||
"scope": {
|
||||
"type": "string",
|
||||
"description": "The OAuth scope."
|
||||
}
|
||||
}
|
||||
},
|
||||
"PlainAuthentication": {
|
||||
"type": "object",
|
||||
"description": "Represents the Plain SASL authentication mechanism.",
|
||||
"x-ms-discriminator-value": "Plain",
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/EndpointAuthentication"
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"primaryConnectionString"
|
||||
],
|
||||
"properties": {
|
||||
"primaryConnectionString": {
|
||||
"type": "string",
|
||||
"description": "The primary connection string."
|
||||
},
|
||||
"secondaryConnectionString": {
|
||||
"type": "string",
|
||||
"description": "The secondary connection string for key rotation."
|
||||
},
|
||||
"saslJaasConfig": {
|
||||
"type": "string",
|
||||
"description": "The SASL JAAS configuration string."
|
||||
}
|
||||
}
|
||||
},
|
||||
"DataSourceStartType": {
|
||||
"type": "string",
|
||||
"description": "Represents the start type of the data source. Additional start types may be added over time.",
|
||||
@@ -258,4 +437,4 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -98,24 +98,6 @@
|
||||
],
|
||||
"discriminator": "type"
|
||||
},
|
||||
"DestinationConnectionResponse": {
|
||||
"type": "object",
|
||||
"description": "Represents the connection information for an eventstream destination.",
|
||||
"required": [
|
||||
"consumerGroupName"
|
||||
],
|
||||
"properties": {
|
||||
"consumerGroupName": {
|
||||
"type": "string",
|
||||
"description": "The consumer group name."
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "./common.json#/definitions/BaseCustomEndpointConnection"
|
||||
}
|
||||
]
|
||||
},
|
||||
"ActivatorDestinationResponse": {
|
||||
"type": "object",
|
||||
"description": "Activator destination response.",
|
||||
|
||||
@@ -25,8 +25,10 @@
|
||||
"AzureSQLMIDBCDC",
|
||||
"AzureServiceBus",
|
||||
"ConfluentCloud",
|
||||
"Cribl",
|
||||
"CustomEndpoint",
|
||||
"FabricAnomalyDetectionEvents",
|
||||
"FabricCapacityOperationEvents",
|
||||
"FabricCapacityOverviewEvents",
|
||||
"FabricJobEvents",
|
||||
"FabricOneLakeEvents",
|
||||
@@ -40,6 +42,8 @@
|
||||
"OracleDBCDC",
|
||||
"PostgreSQLCDC",
|
||||
"RealTimeWeather",
|
||||
"ReferenceLakehouse",
|
||||
"SAPDatasphere",
|
||||
"SQLServerOnVMDBCDC",
|
||||
"SampleData",
|
||||
"SolacePubSub"
|
||||
@@ -108,6 +112,10 @@
|
||||
"value": "ConfluentCloud",
|
||||
"description": "The Confluent Cloud source type."
|
||||
},
|
||||
{
|
||||
"value": "Cribl",
|
||||
"description": "The Cribl source type."
|
||||
},
|
||||
{
|
||||
"value": "CustomEndpoint",
|
||||
"description": "The Custom Endpoint source type."
|
||||
@@ -116,6 +124,10 @@
|
||||
"value": "FabricAnomalyDetectionEvents",
|
||||
"description": "The Fabric Anomaly Detection Events source type."
|
||||
},
|
||||
{
|
||||
"value": "FabricCapacityOperationEvents",
|
||||
"description": "The Fabric Capacity Operation Events source type."
|
||||
},
|
||||
{
|
||||
"value": "FabricCapacityOverviewEvents",
|
||||
"description": "The Fabric Capacity Overview Events source type."
|
||||
@@ -168,10 +180,18 @@
|
||||
"value": "RealTimeWeather",
|
||||
"description": "The Real Time Weather source type."
|
||||
},
|
||||
{
|
||||
"value": "ReferenceLakehouse",
|
||||
"description": "The Reference Lakehouse source type. Provides a point-in-time snapshot from a Lakehouse delta table for enrichment joins."
|
||||
},
|
||||
{
|
||||
"value": "SQLServerOnVMDBCDC",
|
||||
"description": "The SQL Server on VM DB CDC source type."
|
||||
},
|
||||
{
|
||||
"value": "SAPDatasphere",
|
||||
"description": "The SAP Datasphere source type."
|
||||
},
|
||||
{
|
||||
"value": "SampleData",
|
||||
"description": "The Sample Data source type."
|
||||
@@ -230,15 +250,6 @@
|
||||
],
|
||||
"discriminator": "type"
|
||||
},
|
||||
"SourceConnectionResponse": {
|
||||
"type": "object",
|
||||
"description": "Represents the connection information for an eventstream source.",
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "common.json#/definitions/BaseCustomEndpointConnection"
|
||||
}
|
||||
]
|
||||
},
|
||||
"AzureEventGridNamespaceSourceResponse": {
|
||||
"type": "object",
|
||||
"description": "Azure Event Grid Namespace source response.",
|
||||
@@ -391,6 +402,44 @@
|
||||
],
|
||||
"x-ms-discriminator-value": "CustomEndpoint"
|
||||
},
|
||||
"SAPDatasphereSourceResponse": {
|
||||
"type": "object",
|
||||
"description": "Represents an SAP Datasphere source response.",
|
||||
"required": [
|
||||
"properties"
|
||||
],
|
||||
"properties": {
|
||||
"properties": {
|
||||
"description": "The properties of the SAP Datasphere source.",
|
||||
"$ref": "#/definitions/SAPDatasphereSourceProperties"
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/SourceResponse"
|
||||
}
|
||||
],
|
||||
"x-ms-discriminator-value": "SAPDatasphere"
|
||||
},
|
||||
"CriblSourceResponse": {
|
||||
"type": "object",
|
||||
"description": "Represents a Cribl source response.",
|
||||
"required": [
|
||||
"properties"
|
||||
],
|
||||
"properties": {
|
||||
"properties": {
|
||||
"description": "The properties of the Cribl source.",
|
||||
"$ref": "#/definitions/CriblSourceProperties"
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/SourceResponse"
|
||||
}
|
||||
],
|
||||
"x-ms-discriminator-value": "Cribl"
|
||||
},
|
||||
"FabricAnomalyDetectionEventsSourceResponse": {
|
||||
"type": "object",
|
||||
"description": "Fabric Anomaly Detection Events source response.",
|
||||
@@ -410,6 +459,25 @@
|
||||
],
|
||||
"x-ms-discriminator-value": "FabricAnomalyDetectionEvents"
|
||||
},
|
||||
"FabricCapacityOperationEventsSourceResponse": {
|
||||
"type": "object",
|
||||
"description": "Fabric Capacity Operation Events source response.",
|
||||
"required": [
|
||||
"properties"
|
||||
],
|
||||
"properties": {
|
||||
"properties": {
|
||||
"description": "The properties of the Fabric Capacity Operation Events source.",
|
||||
"$ref": "#/definitions/FabricCapacityOperationEventsSourceProperties"
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/SourceResponse"
|
||||
}
|
||||
],
|
||||
"x-ms-discriminator-value": "FabricCapacityOperationEvents"
|
||||
},
|
||||
"FabricCapacityOverviewEventsSourceResponse": {
|
||||
"type": "object",
|
||||
"description": "Fabric Capacity Overview Events source response.",
|
||||
@@ -694,6 +762,25 @@
|
||||
],
|
||||
"x-ms-discriminator-value": "RealTimeWeather"
|
||||
},
|
||||
"ReferenceLakehouseSourceResponse": {
|
||||
"type": "object",
|
||||
"description": "Reference Lakehouse source response. Reference data sources provide point-in-time snapshots from a Lakehouse delta table used for enrichment joins.",
|
||||
"required": [
|
||||
"properties"
|
||||
],
|
||||
"properties": {
|
||||
"properties": {
|
||||
"description": "The properties of the Reference Lakehouse source.",
|
||||
"$ref": "#/definitions/ReferenceLakehouseSourceProperties"
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/SourceResponse"
|
||||
}
|
||||
],
|
||||
"x-ms-discriminator-value": "ReferenceLakehouse"
|
||||
},
|
||||
"GooglePubSubSourceResponse": {
|
||||
"type": "object",
|
||||
"description": "Google Pub/Sub source response.",
|
||||
@@ -1156,6 +1243,16 @@
|
||||
"description": "Custom endpoint events source properties.",
|
||||
"properties": {}
|
||||
},
|
||||
"CriblSourceProperties": {
|
||||
"type": "object",
|
||||
"description": "Cribl source properties. Connection information (bootstrap server, topic name, keys) is returned through the separate source connection API.",
|
||||
"properties": {}
|
||||
},
|
||||
"SAPDatasphereSourceProperties": {
|
||||
"type": "object",
|
||||
"description": "Represents the properties of an SAP Datasphere source. Connection information (bootstrap server, topic name, and authentication credentials) is returned through the separate source connection API.",
|
||||
"properties": {}
|
||||
},
|
||||
"FabricAnomalyDetectionEventsSourceProperties": {
|
||||
"type": "object",
|
||||
"description": "Fabric Anomaly Detection Events source properties.",
|
||||
@@ -1191,6 +1288,71 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"FabricCapacityOperationEventsSourceProperties": {
|
||||
"type": "object",
|
||||
"description": "Fabric Capacity Operation Events source properties.",
|
||||
"required": [
|
||||
"eventScope"
|
||||
],
|
||||
"properties": {
|
||||
"eventScope": {
|
||||
"type": "string",
|
||||
"description": "The event scope.",
|
||||
"enum": [
|
||||
"Tenant",
|
||||
"Capacity",
|
||||
"Workspace",
|
||||
"Item",
|
||||
"SubItem"
|
||||
],
|
||||
"x-ms-enum": {
|
||||
"name": "EventScope",
|
||||
"modelAsString": true,
|
||||
"values": [
|
||||
{
|
||||
"value": "Tenant",
|
||||
"description": "The event scope is Tenant."
|
||||
},
|
||||
{
|
||||
"value": "Capacity",
|
||||
"description": "The event scope is Capacity."
|
||||
},
|
||||
{
|
||||
"value": "Workspace",
|
||||
"description": "The event scope is Workspace."
|
||||
},
|
||||
{
|
||||
"value": "Item",
|
||||
"description": "The event scope is Item."
|
||||
},
|
||||
{
|
||||
"value": "SubItem",
|
||||
"description": "The event scope is SubItem."
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"capacityId": {
|
||||
"type": "string",
|
||||
"description": "The capacity identifier.",
|
||||
"format": "uuid"
|
||||
},
|
||||
"includedEventTypes": {
|
||||
"type": "array",
|
||||
"description": "The list of event types to include. Supported values: Microsoft.Fabric.Capacity.OperationStarted, Microsoft.Fabric.Capacity.OperationCompleted. 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.",
|
||||
@@ -2161,6 +2323,40 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"ReferenceLakehouseSourceProperties": {
|
||||
"type": "object",
|
||||
"description": "Reference Lakehouse source properties. The schema and table are identified by absoluteOneLakePath; workspaceId and itemId are still required for OneLake authorization and must match the workspaceId/itemId segments embedded in the URL.\n\nNote that a Reference Lakehouse source can only be used as input to a Join operator (or to a SQL operator when its reference-input feature is enabled). When joined, the other input must be a streaming source and at least one joinOn key is required, with joinOn.left referencing a streaming column and joinOn.right referencing a reference column; duration is not used and a LeftOuter join preserves the streaming side.",
|
||||
"required": [
|
||||
"absoluteOneLakePath"
|
||||
],
|
||||
"properties": {
|
||||
"workspaceId": {
|
||||
"type": "string",
|
||||
"description": "The Lakehouse workspace identifier.",
|
||||
"format": "uuid"
|
||||
},
|
||||
"itemId": {
|
||||
"type": "string",
|
||||
"description": "The Lakehouse item identifier.",
|
||||
"format": "uuid"
|
||||
},
|
||||
"absoluteOneLakePath": {
|
||||
"type": "string",
|
||||
"description": "Absolute OneLake DFS URL to the delta table, in the form https://onelake.dfs.fabric.microsoft.com/{workspaceId}/{itemId}/Tables/{schema}/{table}. The schema and table segments identify the reference table; workspaceId and itemId segments must match the workspaceId and itemId properties."
|
||||
},
|
||||
"referencedColumns": {
|
||||
"type": "array",
|
||||
"description": "The columns to include from the delta table. When omitted, all columns are included.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"refreshRate": {
|
||||
"type": "string",
|
||||
"description": "Refresh rate for the reference data snapshot, as a .NET TimeSpan-formatted string (\"hh:mm:ss\", e.g. \"00:05:00\" for 5 minutes). Must be at least 00:00:00 (static, no refresh) and less than 24 hours. When omitted, the reference data is treated as static (no refresh). OneLake operations are billed separately, so an explicit non-zero refresh rate has cost implications."
|
||||
}
|
||||
}
|
||||
},
|
||||
"GooglePubSubSourceProperties": {
|
||||
"type": "object",
|
||||
"description": "Google Pub/Sub source properties.",
|
||||
|
||||
@@ -7,6 +7,7 @@
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"type": "CustomEndpoint",
|
||||
"fullyQualifiedNamespace": "namespace.servicebus.windows.net",
|
||||
"eventHubName": "eventhub",
|
||||
"consumerGroupName": "$Default",
|
||||
|
||||
@@ -0,0 +1,29 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"eventstreamId": "8c500070-073f-4a88-b478-8fabe1941c52",
|
||||
"sourceId": "f2886002-d696-4c05-969c-51361365cc25"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"id": "f2886002-d696-4c05-969c-51361365cc25",
|
||||
"name": "ReferenceLakehouseSource",
|
||||
"type": "ReferenceLakehouse",
|
||||
"properties": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"itemId": "11111111-2222-3333-4444-555555555555",
|
||||
"absoluteOneLakePath": "https://onelake.dfs.fabric.microsoft.com/cfafbeb1-8037-4d0c-896e-a46fb27ff229/11111111-2222-3333-4444-555555555555/Tables/dbo/customers",
|
||||
"referencedColumns": [
|
||||
"id",
|
||||
"name",
|
||||
"email"
|
||||
],
|
||||
"refreshRate": "00:05:00"
|
||||
},
|
||||
"status": "Running",
|
||||
"error": null
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -7,6 +7,7 @@
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"type": "CustomEndpoint",
|
||||
"fullyQualifiedNamespace": "namespace.servicebus.windows.net",
|
||||
"eventHubName": "eventhub",
|
||||
"accessKeys": {
|
||||
|
||||
@@ -0,0 +1,29 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"eventstreamId": "8c500070-073f-4a88-b478-8fabe1941c52",
|
||||
"sourceId": "b7d2a1c3-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"type": "KafkaEndpoint",
|
||||
"bootstrapServer": "namespace.servicebus.windows.net:9093",
|
||||
"topicName": "eventhub",
|
||||
"securityProtocol": "SASL_SSL",
|
||||
"authentications": [
|
||||
{
|
||||
"saslMechanism": "OAuthBearer",
|
||||
"scope": "https://namespace.servicebus.windows.net/.default"
|
||||
},
|
||||
{
|
||||
"saslMechanism": "Plain",
|
||||
"primaryConnectionString": "Endpoint=sb://namespace.servicebus.windows.net/;SharedAccessKeyName=key;SharedAccessKey=primary",
|
||||
"secondaryConnectionString": "Endpoint=sb://namespace.servicebus.windows.net/;SharedAccessKeyName=key;SharedAccessKey=secondary",
|
||||
"saslJaasConfig": "org.apache.kafka.common.security.plain.PlainLoginModule required username=\"$ConnectionString\" password=\"Endpoint=sb://namespace.servicebus.windows.net/;SharedAccessKeyName=key;SharedAccessKey=primary\";"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,25 @@
|
||||
{
|
||||
"parameters": {
|
||||
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
|
||||
"eventstreamId": "8c500070-073f-4a88-b478-8fabe1941c52",
|
||||
"sourceId": "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"type": "KafkaEndpoint",
|
||||
"bootstrapServer": "namespace.servicebus.windows.net:9093",
|
||||
"topicName": "eventhub",
|
||||
"securityProtocol": "SASL_SSL",
|
||||
"authentications": [
|
||||
{
|
||||
"saslMechanism": "Plain",
|
||||
"primaryConnectionString": "Endpoint=sb://namespace.servicebus.windows.net/;SharedAccessKeyName=key;SharedAccessKey=primary",
|
||||
"secondaryConnectionString": "Endpoint=sb://namespace.servicebus.windows.net/;SharedAccessKeyName=key;SharedAccessKey=secondary",
|
||||
"saslJaasConfig": "org.apache.kafka.common.security.plain.PlainLoginModule required username=\"$ConnectionString\" password=\"Endpoint=sb://namespace.servicebus.windows.net/;SharedAccessKeyName=key;SharedAccessKey=primary\";"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -102,6 +102,20 @@
|
||||
"properties": {},
|
||||
"status": "Running"
|
||||
},
|
||||
{
|
||||
"id": "b7e2c4a1-3f9d-4e6b-8a1c-2d5f7b0e9c63",
|
||||
"name": "CriblSource",
|
||||
"type": "Cribl",
|
||||
"properties": {},
|
||||
"status": "Running"
|
||||
},
|
||||
{
|
||||
"id": "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
|
||||
"name": "SAPDatasphereSource",
|
||||
"type": "SAPDatasphere",
|
||||
"properties": {},
|
||||
"status": "Running"
|
||||
},
|
||||
{
|
||||
"id": "8b6b1b8e-9b7f-4a7d-8f6b-6f2a8b7c4b15",
|
||||
"name": "AzureBlobStorageEventsSource",
|
||||
@@ -121,6 +135,30 @@
|
||||
},
|
||||
"status": "Running"
|
||||
},
|
||||
{
|
||||
"id": "a4b5c6d7-e8f9-4a0b-c1d2-e3f4a5b6c7d8",
|
||||
"name": "FabricCapacityOperationEventsSource",
|
||||
"type": "FabricCapacityOperationEvents",
|
||||
"properties": {
|
||||
"eventScope": "Capacity",
|
||||
"capacityId": "0b6d8e27-0b7b-4e18-9e5b-2e6b9d9d7e3a",
|
||||
"includedEventTypes": [
|
||||
"Microsoft.Fabric.Capacity.OperationStarted",
|
||||
"Microsoft.Fabric.Capacity.OperationCompleted"
|
||||
],
|
||||
"filters": [
|
||||
{
|
||||
"operatorType": "StringIn",
|
||||
"key": "data.operationType",
|
||||
"values": [
|
||||
"ScaleUp",
|
||||
"ScaleDown"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"status": "Running"
|
||||
},
|
||||
{
|
||||
"id": "2e7b7f0f-6f1a-4d38-8b12-67d0e2d3e0b9",
|
||||
"name": "FabricCapacityOverviewEventsSource",
|
||||
|
||||
@@ -824,6 +824,9 @@
|
||||
"x-ms-examples": {
|
||||
"Get an eventstream source example": {
|
||||
"$ref": "./examples/GetEventstreamSource.json"
|
||||
},
|
||||
"Get a Reference Lakehouse eventstream source example": {
|
||||
"$ref": "./examples/GetEventstreamReferenceLakehouseSource.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -902,7 +905,7 @@
|
||||
"/workspaces/{workspaceId}/eventstreams/{eventstreamId}/sources/{sourceId}/connection": {
|
||||
"get": {
|
||||
"summary": "Returns the connection information of specified source of the eventstream.",
|
||||
"description": "## Permissions\n\n The caller must have *read and write* permissions for the eventstream. \n\n## Required Delegated Scopes \n\n Eventstream.ReadWrite.All or Item.ReadWrite.All\n\n## Limitations\n\n Only custom endpoints sources are supported.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"description": "## Permissions\n\n The caller must have *read and write* permissions for the eventstream. \n\n## Required Delegated Scopes \n\n Eventstream.ReadWrite.All or Item.ReadWrite.All\n\n## Limitations\n\n Only custom endpoint, Cribl, and SAP Datasphere sources are supported.\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": [
|
||||
"Topology"
|
||||
],
|
||||
@@ -940,7 +943,7 @@
|
||||
"200": {
|
||||
"description": "Request completed successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions/source.json#/definitions/SourceConnectionResponse"
|
||||
"$ref": "./definitions/common.json#/definitions/EndpointConnection"
|
||||
}
|
||||
},
|
||||
"429": {
|
||||
@@ -966,6 +969,12 @@
|
||||
"x-ms-examples": {
|
||||
"Get an eventstream source connection example": {
|
||||
"$ref": "./examples/GetEventstreamSourceConnection.json"
|
||||
},
|
||||
"Get an eventstream Cribl source connection example": {
|
||||
"$ref": "./examples/GetEventstreamSourceConnectionCribl.json"
|
||||
},
|
||||
"Get an eventstream SAP Datasphere source connection example": {
|
||||
"$ref": "./examples/GetEventstreamSourceConnectionSAPDatasphere.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1011,7 +1020,7 @@
|
||||
"200": {
|
||||
"description": "Request completed successfully.",
|
||||
"schema": {
|
||||
"$ref": "./definitions/destination.json#/definitions/DestinationConnectionResponse"
|
||||
"$ref": "./definitions/common.json#/definitions/EndpointConnection"
|
||||
}
|
||||
},
|
||||
"429": {
|
||||
|
||||
+12
-12
@@ -13,7 +13,7 @@
|
||||
"/workspaces": {
|
||||
"post": {
|
||||
"summary": "Creates a new workspace.",
|
||||
"description": "## Permissions\n\n- The caller must have permission to create workspaces granted by Fabric administrator. For more information see: [create workspaces](/fabric/admin/portal-workspace#create-workspaces-new-workspace-experience).\n- The caller must have *contributor* permissions or be an Admin on the capacity. For more information, see: [capacity user permissions](/power-bi/enterprise/service-admin-premium-manage#manage-user-permissions).\n- Service Principals must have permission granted by Fabric administrator. For more information see: [Service principals can create workspaces, connections, and deployment pipelines](/fabric/admin/service-admin-portal-developer#service-principals-can-create-workspaces-connections-and-deployment-pipelines). \n\n## Required Delegated Scopes\n\nWorkspace.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",
|
||||
"description": "## Permissions\n\n- The caller must have permission to create workspaces granted by Fabric administrator. For more information see: [create workspaces](/fabric/admin/portal-workspace#create-workspaces-new-workspace-experience).\n- The caller must have *contributor* permissions or be an Admin on the capacity. For more information, see: [capacity user permissions](/power-bi/enterprise/service-admin-premium-manage#manage-user-permissions).\n- Service Principals must have permission granted by Fabric administrator. For more information see: [Service principals can create workspaces, connections, and deployment pipelines](/fabric/admin/service-admin-portal-developer#service-principals-can-create-workspaces-connections-and-deployment-pipelines). \n\n## Required Delegated Scopes\n\nWorkspace.ReadWrite.All\n\n## Throttling limits\n\n| Limit Type | Value |\n|-|-|\n| [Unified Quota for Platform APIs](https://learn.microsoft.com/en-us/rest/api/fabric/articles/throttling#how-the-quota-model-works) | 200 calls/min |\n| API limit | 200 calls/min |\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": [
|
||||
"Workspaces"
|
||||
],
|
||||
@@ -76,7 +76,7 @@
|
||||
},
|
||||
"get": {
|
||||
"summary": "Returns a list of workspaces the principal can access. Use the roles query parameter to filter results by the principal workspace role.",
|
||||
"description": "This API supports [pagination](/rest/api/fabric/articles/pagination).\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",
|
||||
"description": "This API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Required Delegated Scopes\n\nWorkspace.Read.All or Workspace.ReadWrite.All\n\n## Throttling limits\n\n| Limit Type | Value |\n|-|-|\n| [Unified Quota for Platform APIs](https://learn.microsoft.com/en-us/rest/api/fabric/articles/throttling#how-the-quota-model-works) | 200 calls/min |\n| API limit | 200 calls/min |\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": [
|
||||
"Workspaces"
|
||||
],
|
||||
@@ -156,7 +156,7 @@
|
||||
"/workspaces/{workspaceId}": {
|
||||
"get": {
|
||||
"summary": "Returns specified workspace information.",
|
||||
"description": "## Permissions\n\n The caller must have *viewer* or higher workspace role.\n\n## Required Delegated Scopes\n\nWorkspace.Read.All or Workspace.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"description": "## Permissions\n\n The caller must have *viewer* or higher workspace role.\n\n## Required Delegated Scopes\n\nWorkspace.Read.All or Workspace.ReadWrite.All\n\n## Throttling limits\n\n| Limit Type | Value |\n|-|-|\n| [Unified Quota for Platform APIs](https://learn.microsoft.com/en-us/rest/api/fabric/articles/throttling#how-the-quota-model-works) | 200 calls/min |\n| API limit | 200 calls/min |\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": [
|
||||
"Workspaces"
|
||||
],
|
||||
@@ -219,7 +219,7 @@
|
||||
},
|
||||
"patch": {
|
||||
"summary": "Updates the specified workspace properties.",
|
||||
"description": "## Permissions\n\nThe caller must have *admin* workspace role.\n\n## Required Delegated Scopes\n\nWorkspace.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",
|
||||
"description": "## Permissions\n\nThe caller must have *admin* workspace role.\n\n## Required Delegated Scopes\n\nWorkspace.ReadWrite.All\n\n## Throttling limits\n\n| Limit Type | Value |\n|-|-|\n| [Unified Quota for Platform APIs](https://learn.microsoft.com/en-us/rest/api/fabric/articles/throttling#how-the-quota-model-works) | 200 calls/min |\n| API limit | 200 calls/min |\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": [
|
||||
"Workspaces"
|
||||
],
|
||||
@@ -284,7 +284,7 @@
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Deletes the specified workspace and the items under it.",
|
||||
"description": "## Permissions\n\nThe caller must have *admin* workspace role.\n\n## Required Delegated Scopes\n\nWorkspace.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",
|
||||
"description": "## Permissions\n\nThe caller must have *admin* workspace role.\n\n## Required Delegated Scopes\n\nWorkspace.ReadWrite.All\n\n## Throttling limits\n\n| Limit Type | Value |\n|-|-|\n| [Unified Quota for Platform APIs](https://learn.microsoft.com/en-us/rest/api/fabric/articles/throttling#how-the-quota-model-works) | 200 calls/min |\n| API limit | 200 calls/min |\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": [
|
||||
"Workspaces"
|
||||
],
|
||||
@@ -666,7 +666,7 @@
|
||||
"/workspaces/{workspaceId}/items": {
|
||||
"get": {
|
||||
"summary": "Returns a list of items from the specified workspace.",
|
||||
"description": "This API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\n The caller must have a *viewer* workspace role. \n\n## Required Delegated Scopes\n\nWorkspace.Read.All or Workspace.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"description": "This API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\n The caller must have a *viewer* workspace role. \n\n## Required Delegated Scopes\n\nWorkspace.Read.All or Workspace.ReadWrite.All\n\n## Throttling limits\n\n| Limit Type | Value |\n|-|-|\n| [Unified Quota for Platform APIs](https://learn.microsoft.com/en-us/rest/api/fabric/articles/throttling#how-the-quota-model-works) | 200 calls/min |\n| API limit | 200 calls/min |\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"
|
||||
],
|
||||
@@ -793,7 +793,7 @@
|
||||
},
|
||||
"post": {
|
||||
"summary": "Creates an item in the specified workspace.",
|
||||
"description": "This API is supported for a number of item types, find the supported item types in [Item management overview](/rest/api/fabric/articles/item-management/item-management-overview). You can use [Get item definition API](/rest/api/fabric/core/items/get-item-definition) to get an item definition. \n\nThis 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 For item APIs use these scope types: \n- Generic scope: Item.ReadWrite.All \n- Specific scope: *itemType*.ReadWrite.All (for example: Notebook.ReadWrite.All) \n\n for more information about scopes, see [scopes article](/rest/api/fabric/articles/scopes). \n\n## Limitations \n- To create a non-PowerBI Fabric item 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- To create a PowerBI item, the user must have the appropriate license. For more information see [Microsoft Fabric license types](/fabric/enterprise/licenses#microsoft-fabric-license-types). \n- When creating an item, use either `creationPayload` or `definition`, but do not use both at the same time. \n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | When the item type in the call is supported. Check the corresponding API for the item type you're calling, to see if your call is supported. For example, semantic models are supported. |\n\n## Interface",
|
||||
"description": "This API is supported for a number of item types, find the supported item types in [Item management overview](/rest/api/fabric/articles/item-management/item-management-overview). You can use [Get item definition API](/rest/api/fabric/core/items/get-item-definition) to get an item definition. \n\nThis 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 For item APIs use these scope types: \n- Generic scope: Item.ReadWrite.All \n- Specific scope: *itemType*.ReadWrite.All (for example: Notebook.ReadWrite.All) \n\n for more information about scopes, see [scopes article](/rest/api/fabric/articles/scopes). \n\n## Limitations \n- To create a non-PowerBI Fabric item 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- To create a PowerBI item, the user must have the appropriate license. For more information see [Microsoft Fabric license types](/fabric/enterprise/licenses#microsoft-fabric-license-types). \n- When creating an item, use either `creationPayload` or `definition`, but do not use both at the same time. \n\n## Throttling limits\n\n| Limit Type | Value |\n|-|-|\n| [Unified Quota for Platform APIs](https://learn.microsoft.com/en-us/rest/api/fabric/articles/throttling#how-the-quota-model-works) | 200 calls/min |\n| API limit | 200 calls/min |\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | When the item type in the call is supported. Check the corresponding API for the item type you're calling, to see if your call is supported. For example, semantic models are supported. |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
@@ -885,7 +885,7 @@
|
||||
"/workspaces/{workspaceId}/items/{itemId}": {
|
||||
"get": {
|
||||
"summary": "Returns properties of the specified item.",
|
||||
"description": "This API is supported for a number of item types, find the supported item types in [Item management overview](/rest/api/fabric/articles/item-management/item-management-overview). \n\nFor retrieving additional type specific properties, refer to the get API reference page of the specific item type.\n\n## Permissions\n\n The caller must have *read* permissions for the item. \n\n## Required Delegated Scopes\n\n For item APIs use these scope types: \n- Generic scope: Item.Read.All or Item.ReadWrite.All \n- Specific scope: *itemType*.Read.All or *itemType*.ReadWrite.All (for example: Notebook.ReadWrite.All) \n\n for more information about scopes, see: [scopes article](/rest/api/fabric/articles/scopes).\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"description": "This API is supported for a number of item types, find the supported item types in [Item management overview](/rest/api/fabric/articles/item-management/item-management-overview). \n\nFor retrieving additional type specific properties, refer to the get API reference page of the specific item type.\n\n## Permissions\n\n The caller must have *read* permissions for the item. \n\n## Required Delegated Scopes\n\n For item APIs use these scope types: \n- Generic scope: Item.Read.All or Item.ReadWrite.All \n- Specific scope: *itemType*.Read.All or *itemType*.ReadWrite.All (for example: Notebook.ReadWrite.All) \n\n for more information about scopes, see: [scopes article](/rest/api/fabric/articles/scopes).\n\n## Throttling limits\n\n| Limit Type | Value |\n|-|-|\n| [Unified Quota for Platform APIs](https://learn.microsoft.com/en-us/rest/api/fabric/articles/throttling#how-the-quota-model-works) | 200 calls/min |\n| API limit | 200 calls/min |\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"
|
||||
],
|
||||
@@ -973,7 +973,7 @@
|
||||
},
|
||||
"patch": {
|
||||
"summary": "Updates the properties of the specified item.",
|
||||
"description": "This API is supported for a number of item types, find the supported item types and information about their definition structure in [Item management overview](/rest/api/fabric/articles/item-management/item-management-overview).\n\n## Permissions\n\n The caller must have *read and write* permissions for the item.\n\n## Required Delegated Scopes\n\n For item APIs use these scope types: \n- Generic scope: Item.ReadWrite.All \n- Specific scope: *itemType*.ReadWrite.All (for example: Notebook.ReadWrite.All) \n\n for more information about scopes, see: [scopes article](/rest/api/fabric/articles/scopes).\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | When the item type in the call is supported. Check the corresponding API for the item type you're calling, to see if your call is supported. For example, semantic models are supported. |\n\n## Interface",
|
||||
"description": "This API is supported for a number of item types, find the supported item types and information about their definition structure in [Item management overview](/rest/api/fabric/articles/item-management/item-management-overview).\n\n## Permissions\n\n The caller must have *read and write* permissions for the item.\n\n## Required Delegated Scopes\n\n For item APIs use these scope types: \n- Generic scope: Item.ReadWrite.All \n- Specific scope: *itemType*.ReadWrite.All (for example: Notebook.ReadWrite.All) \n\n for more information about scopes, see: [scopes article](/rest/api/fabric/articles/scopes).\n\n## Throttling limits\n\n| Limit Type | Value |\n|-|-|\n| [Unified Quota for Platform APIs](https://learn.microsoft.com/en-us/rest/api/fabric/articles/throttling#how-the-quota-model-works) | 200 calls/min |\n| API limit | 200 calls/min |\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | When the item type in the call is supported. Check the corresponding API for the item type you're calling, to see if your call is supported. For example, semantic models are supported. |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
@@ -1046,7 +1046,7 @@
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Deletes the specified item.",
|
||||
"description": "This API is supported for a number of item types, find the supported item types and information about their definition structure in [Item management overview](/rest/api/fabric/articles/item-management/item-management-overview). The default behavior is to soft delete the item for supported item types.\n\n> [!NOTE]\n> The soft-deleted items will be counted toward the maximum number of items allowed in each workspace.\n\n## Permissions\n\nThe caller must have *write* permissions for the item for soft deletion.\nThe caller must have workspace *Admin* role assigned for hard/permanent deletion.\n\n## Required Delegated Scopes\n\n For item APIs use these scope types: \n- Generic scope: Item.ReadWrite.All \n- Specific scope: *itemType*.ReadWrite.All (for example: Notebook.ReadWrite.All) \n\n for more information about scopes, see [scopes article](/rest/api/fabric/articles/scopes).\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | When the item type in the call is supported. Check the corresponding API for the item type you're calling, to see if your call is supported. For example, semantic models are supported. |\n\n## Interface",
|
||||
"description": "This API is supported for a number of item types, find the supported item types and information about their definition structure in [Item management overview](/rest/api/fabric/articles/item-management/item-management-overview). The default behavior is to soft delete the item for supported item types.\n\n> [!NOTE]\n> The soft-deleted items will be counted toward the maximum number of items allowed in each workspace.\n\n## Permissions\n\nThe caller must have *write* permissions for the item for soft deletion.\nThe caller must have workspace *Admin* role assigned for hard/permanent deletion.\n\n## Required Delegated Scopes\n\n For item APIs use these scope types: \n- Generic scope: Item.ReadWrite.All \n- Specific scope: *itemType*.ReadWrite.All (for example: Notebook.ReadWrite.All) \n\n for more information about scopes, see [scopes article](/rest/api/fabric/articles/scopes).\n\n## Throttling limits\n\n| Limit Type | Value |\n|-|-|\n| [Unified Quota for Platform APIs](https://learn.microsoft.com/en-us/rest/api/fabric/articles/throttling#how-the-quota-model-works) | 200 calls/min |\n| API limit | 200 calls/min |\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | When the item type in the call is supported. Check the corresponding API for the item type you're calling, to see if your call is supported. For example, semantic models are supported. |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
@@ -3400,7 +3400,7 @@
|
||||
"LongRunningOperations"
|
||||
],
|
||||
"summary": "Returns the current state of the long running operation.",
|
||||
"description": "You get the operationId from x-ms-operation-id header return by the API that initiated the operation. \n Once the operation status is 'Succeeded' use the [Get Operation Result API](/rest/api/fabric/core/long-running-operations/get-operation-result) to retrieve the result.\n\n## Permissions \n\nSame as the permissions required for the API that initiated the operation. \n\n## Required Delegated Scope \n\nSame as the scopes required for the API that initiated the operation.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"description": "You get the operationId from x-ms-operation-id header return by the API that initiated the operation. \n Once the operation status is 'Succeeded' use the [Get Operation Result API](/rest/api/fabric/core/long-running-operations/get-operation-result) to retrieve the result.\n\n## Permissions \n\nSame as the permissions required for the API that initiated the operation. \n\n## Required Delegated Scope \n\nSame as the scopes required for the API that initiated the operation.\n\n## Throttling limits\n\n| Limit Type | Value |\n|-|-|\n| [Unified quota for Long-Running operations APIs](https://learn.microsoft.com/en-us/rest/api/fabric/articles/throttling#how-the-quota-model-works) | 200 calls/min |\n| API limit | 200 calls/min |\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": "LongRunningOperations_GetOperationState",
|
||||
"consumes": [],
|
||||
"produces": [
|
||||
@@ -3474,7 +3474,7 @@
|
||||
"LongRunningOperations"
|
||||
],
|
||||
"summary": "Returns the result of the long running operation.",
|
||||
"description": "You get the operationId from x-ms-operation-id header return by the API that initiated the operation.\n\n## Permissions \n\nSame as the permissions required for the API that initiated the operation. \n\n## Required Delegated Scope \n\nSame as the scopes required for the API that initiated the operation.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"description": "You get the operationId from x-ms-operation-id header return by the API that initiated the operation.\n\n## Permissions \n\nSame as the permissions required for the API that initiated the operation. \n\n## Required Delegated Scope \n\nSame as the scopes required for the API that initiated the operation.\n\n## Throttling limits\n\n| Limit Type | Value |\n|-|-|\n| [Unified quota for Long-Running operations APIs](https://learn.microsoft.com/en-us/rest/api/fabric/articles/throttling#how-the-quota-model-works) | 200 calls/min |\n| API limit | 200 calls/min |\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": "LongRunningOperations_GetOperationResult",
|
||||
"consumes": [],
|
||||
"produces": [
|
||||
|
||||
Reference in new issue
Block a user