diff --git a/anomalyDetector/swagger.json b/anomalyDetector/swagger.json index 68c37a8..4f04387 100644 --- a/anomalyDetector/swagger.json +++ b/anomalyDetector/swagger.json @@ -384,7 +384,7 @@ "/workspaces/{workspaceId}/anomalyDetectors/{anomalyDetectorId}/getDefinition": { "post": { "summary": "Returns the specified AnomalyDetector definition.", - "description": "> [!NOTE]\n> AnomalyDetector item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a AnomalyDetector's definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the AnomalyDetector. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface", + "description": "> [!NOTE]\n> AnomalyDetector item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a AnomalyDetector's definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the AnomalyDetector. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Limitations\n\nTo retrieve the definition of an anomaly detector item protected by an encrypted sensitivity label, the caller must have sufficient [usage rights](/fabric/enterprise/powerbi/service-security-sensitivity-label-change-enforcement) to remove the label, as configured in [Microsoft Purview](/purview/purview).\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface", "tags": [ "Items" ], diff --git a/apacheAirflowJob/swagger.json b/apacheAirflowJob/swagger.json index be786e4..0751196 100644 --- a/apacheAirflowJob/swagger.json +++ b/apacheAirflowJob/swagger.json @@ -384,7 +384,7 @@ "/workspaces/{workspaceId}/apacheAirflowJobs/{apacheAirflowJobId}/getDefinition": { "post": { "summary": "Returns the specified Apache Airflow job public definition.", - "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get an Apache Airflow job's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\nThe caller must have *read and write* permissions for the Apache Airflow job.\n\n## Required Delegated Scopes\n\nItem.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get an Apache Airflow job's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\nThe caller must have *read and write* permissions for the Apache Airflow job.\n\n## Required Delegated Scopes\n\nItem.ReadWrite.All\n\n## Limitations\n\nTo retrieve the definition of an Apache Airflow job item protected by an encrypted sensitivity label, the caller must have sufficient [usage rights](/fabric/enterprise/powerbi/service-security-sensitivity-label-change-enforcement) to remove the label, as configured in [Microsoft Purview](/purview/purview).\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" ], diff --git a/azureDatabricksStorage/swagger.json b/azureDatabricksStorage/swagger.json index cb414e1..807285f 100644 --- a/azureDatabricksStorage/swagger.json +++ b/azureDatabricksStorage/swagger.json @@ -384,7 +384,7 @@ "/workspaces/{workspaceId}/azureDatabricksStorages/{azureDatabricksStorageId}/getDefinition": { "post": { "summary": "Returns the specified AzureDatabricksStorage public definition.", - "description": "> [!NOTE]\n> AzureDatabricksStorage item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get an AzureDatabricksStorage's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\nThe caller must have *read and write* permissions for the AzureDatabricksStorage. \n\n## Required Delegated Scopes\n\nItem.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "description": "> [!NOTE]\n> AzureDatabricksStorage item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get an AzureDatabricksStorage's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\nThe caller must have *read and write* permissions for the AzureDatabricksStorage. \n\n## Required Delegated Scopes\n\nItem.ReadWrite.All\n\n## Limitations\n\nTo retrieve the definition of an Azure Databricks storage item protected by an encrypted sensitivity label, the caller must have sufficient [usage rights](/fabric/enterprise/powerbi/service-security-sensitivity-label-change-enforcement) to remove the label, as configured in [Microsoft Purview](/purview/purview).\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" ], diff --git a/common/definitions.json b/common/definitions.json index 21d7c7e..ef0e6e8 100644 --- a/common/definitions.json +++ b/common/definitions.json @@ -268,7 +268,7 @@ "ItemType": { "description": "The type of the item. Additional item types may be added over time.", "type": "string", - "enum": [ "Dashboard", "Report", "SemanticModel", "PaginatedReport", "Datamart", "Lakehouse", "Eventhouse", "Environment", "KQLDatabase", "KQLQueryset", "KQLDashboard", "DataPipeline", "Notebook", "SparkJobDefinition", "MLExperiment", "MLModel", "Warehouse", "Eventstream", "SQLEndpoint", "MirroredWarehouse", "MirroredDatabase", "Reflex", "GraphQLApi", "MountedDataFactory", "SQLDatabase", "CopyJob", "VariableLibrary", "Dataflow", "ApacheAirflowJob", "WarehouseSnapshot", "DigitalTwinBuilder", "DigitalTwinBuilderFlow", "MirroredAzureDatabricksCatalog", "Map", "AnomalyDetector", "UserDataFunction", "GraphModel", "GraphQuerySet", "SnowflakeDatabase", "OperationsAgent", "CosmosDBDatabase", "Ontology", "EventSchemaSet", "DataAgent", "MirroredCatalog", "PolicySet", "AppBackend", "OrgApp", "OrgAppAudience", "DataBuildToolJob", "AzureDatabricksStorage", "Plan" ], + "enum": [ "Dashboard", "Report", "SemanticModel", "PaginatedReport", "Datamart", "Lakehouse", "Eventhouse", "Environment", "KQLDatabase", "KQLQueryset", "KQLDashboard", "DataPipeline", "Notebook", "SparkJobDefinition", "MLExperiment", "MLModel", "Warehouse", "Eventstream", "SQLEndpoint", "MirroredWarehouse", "MirroredDatabase", "Reflex", "GraphQLApi", "MountedDataFactory", "SQLDatabase", "CopyJob", "VariableLibrary", "Dataflow", "ApacheAirflowJob", "WarehouseSnapshot", "DigitalTwinBuilder", "DigitalTwinBuilderFlow", "MirroredAzureDatabricksCatalog", "Map", "AnomalyDetector", "UserDataFunction", "GraphModel", "GraphQuerySet", "SnowflakeDatabase", "OperationsAgent", "CosmosDBDatabase", "Ontology", "EventSchemaSet", "DataAgent", "MirroredCatalog", "PolicySet", "AppBackend", "OrgApp", "OrgAppAudience", "DataBuildToolJob", "AzureDatabricksStorage", "Plan", "Monitoring" ], "x-ms-enum": { "name": "ItemType", "modelAsString": true, @@ -480,6 +480,10 @@ { "value": "Plan", "description": "A plan." + }, + { + "value": "Monitoring", + "description": "A Monitoring item." } ] } diff --git a/copyJob/swagger.json b/copyJob/swagger.json index bb70483..9323206 100644 --- a/copyJob/swagger.json +++ b/copyJob/swagger.json @@ -384,7 +384,7 @@ "/workspaces/{workspaceId}/copyJobs/{copyJobId}/getDefinition": { "post": { "summary": "Returns the specified CopyJob public definition.", - "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a CopyJob's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the copy job. \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 [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a CopyJob's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the copy job. \n\n## Limitations\n\nTo retrieve the definition of a Copy job item protected by an encrypted sensitivity label, the caller must have sufficient [usage rights](/fabric/enterprise/powerbi/service-security-sensitivity-label-change-enforcement) to remove the label, as configured in [Microsoft Purview](/purview/purview).\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" ], diff --git a/cosmosDbDatabase/swagger.json b/cosmosDbDatabase/swagger.json index 951814d..eb96e71 100644 --- a/cosmosDbDatabase/swagger.json +++ b/cosmosDbDatabase/swagger.json @@ -384,7 +384,7 @@ "/workspaces/{workspaceId}/cosmosDbDatabases/{cosmosDbDatabaseId}/getDefinition": { "post": { "summary": "Returns the specified Cosmos DB database public definition.", - "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a Cosmos DB database's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the CosmosDBDatabase. \n\n## Required Delegated Scopes \n\n Item.ReadWrite.All \n\n## Limitations\n\n This API is blocked for a notebook with an encrypted sensitivity label.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a Cosmos DB database's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the CosmosDBDatabase. \n\n## Required Delegated Scopes \n\n Item.ReadWrite.All \n\n## Limitations\n\nTo retrieve the definition of a Cosmos DB database item protected by an encrypted sensitivity label, the caller must have sufficient [usage rights](/fabric/enterprise/powerbi/service-security-sensitivity-label-change-enforcement) to remove the label, as configured in [Microsoft Purview](/purview/purview).\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" ], diff --git a/dataAgent/swagger.json b/dataAgent/swagger.json index 2283452..7b35a22 100644 --- a/dataAgent/swagger.json +++ b/dataAgent/swagger.json @@ -384,7 +384,7 @@ "/workspaces/{workspaceId}/dataAgents/{dataAgentId}/getDefinition": { "post": { "summary": "Returns the specified DataAgent public definition.", - "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a DataAgent's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the DataAgent. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a DataAgent's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the DataAgent. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Limitations\n\nTo retrieve the definition of a Data agent item protected by an encrypted sensitivity label, the caller must have sufficient [usage rights](/fabric/enterprise/powerbi/service-security-sensitivity-label-change-enforcement) to remove the label, as configured in [Microsoft Purview](/purview/purview).\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" ], diff --git a/dataBuildToolJob/swagger.json b/dataBuildToolJob/swagger.json index 96d4648..b272945 100644 --- a/dataBuildToolJob/swagger.json +++ b/dataBuildToolJob/swagger.json @@ -374,7 +374,7 @@ "/workspaces/{workspaceId}/dataBuildToolJobs/{dataBuildToolJobId}/getDefinition": { "post": { "summary": "Returns the specified DataBuildToolJob public definition.", - "description": "> [!NOTE]\n> DataBuildToolJob item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a DataBuildToolJob's definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\nThe caller must have *read and write* permissions for the DataBuildToolJob.\n\n## Required Delegated Scopes\n\nItem.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "description": "> [!NOTE]\n> DataBuildToolJob item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a DataBuildToolJob's definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\nThe caller must have *read and write* permissions for the DataBuildToolJob.\n\n## Required Delegated Scopes\n\nItem.ReadWrite.All\n\n## Limitations\n\nTo retrieve the definition of a Data build tool job item protected by an encrypted sensitivity label, the caller must have sufficient [usage rights](/fabric/enterprise/powerbi/service-security-sensitivity-label-change-enforcement) to remove the label, as configured in [Microsoft Purview](/purview/purview).\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" ], diff --git a/dataPipeline/swagger.json b/dataPipeline/swagger.json index 2de5749..391aa8e 100644 --- a/dataPipeline/swagger.json +++ b/dataPipeline/swagger.json @@ -384,7 +384,7 @@ "/workspaces/{workspaceId}/dataPipelines/{dataPipelineId}/getDefinition": { "post": { "summary": "Returns the specified data pipeline public definition.", - "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a DataPipeline's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the data pipeline.\n## Required Delegated Scopes\n\n DataPipeline.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", + "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a DataPipeline's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the data pipeline.\n## Required Delegated Scopes\n\n DataPipeline.ReadWrite.All or Item.ReadWrite.All\n\n## Limitations\n\nTo retrieve the definition of a data pipeline item protected by an encrypted sensitivity label, the caller must have sufficient [usage rights](/fabric/enterprise/powerbi/service-security-sensitivity-label-change-enforcement) to remove the label, as configured in [Microsoft Purview](/purview/purview).\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" ], diff --git a/dataflow/swagger.json b/dataflow/swagger.json index fde2260..fc68b6b 100644 --- a/dataflow/swagger.json +++ b/dataflow/swagger.json @@ -384,7 +384,7 @@ "/workspaces/{workspaceId}/dataflows/{dataflowId}/getDefinition": { "post": { "summary": "Returns the specified Dataflow public definition.", - "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a Dataflow's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the dataflow.\n## Required Delegated Scopes\n\n Dataflow.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", + "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a Dataflow's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the dataflow.\n## Required Delegated Scopes\n\n Dataflow.ReadWrite.All or Item.ReadWrite.All\n\n## Limitations\n\nTo retrieve the definition of a Dataflow item protected by an encrypted sensitivity label, the caller must have sufficient [usage rights](/fabric/enterprise/powerbi/service-security-sensitivity-label-change-enforcement) to remove the label, as configured in [Microsoft Purview](/purview/purview).\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" ], diff --git a/digitalTwinBuilder/swagger.json b/digitalTwinBuilder/swagger.json index 9051e27..d9d3707 100644 --- a/digitalTwinBuilder/swagger.json +++ b/digitalTwinBuilder/swagger.json @@ -384,7 +384,7 @@ "/workspaces/{workspaceId}/digitaltwinbuilders/{digitaltwinbuilderId}/getDefinition": { "post": { "summary": "Returns the specified DigitalTwinBuilder public definition.", - "description": "> [!NOTE]\n> Digital Twin Builder item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a digitaltwinbuilder public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the digital twin builder. \n\n## Required Delegated Scopes \n\n Item.ReadWrite.All \n\n## Limitations\n\n This API is blocked for a digitaltwinbuilder with an encrypted sensitivity label.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface", + "description": "> [!NOTE]\n> Digital Twin Builder item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a digitaltwinbuilder public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the digital twin builder. \n\n## Required Delegated Scopes \n\n Item.ReadWrite.All \n\n## Limitations\n\nTo retrieve the definition of a Digital twin builder item protected by an encrypted sensitivity label, the caller must have sufficient [usage rights](/fabric/enterprise/powerbi/service-security-sensitivity-label-change-enforcement) to remove the label, as configured in [Microsoft Purview](/purview/purview).\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface", "tags": [ "Items" ], diff --git a/digitalTwinBuilderFlow/swagger.json b/digitalTwinBuilderFlow/swagger.json index 9a2a7f1..85d158d 100644 --- a/digitalTwinBuilderFlow/swagger.json +++ b/digitalTwinBuilderFlow/swagger.json @@ -384,7 +384,7 @@ "/workspaces/{workspaceId}/digitalTwinBuilderFlows/{digitalTwinBuilderFlowId}/getDefinition": { "post": { "summary": "Returns the specified Digital Twin Builder Flow public definition.", - "description": "> [!NOTE]\n> Digital Twin Builder Flow item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a Digital Twin Builder Flow's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the digital twin builder flow. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "description": "> [!NOTE]\n> Digital Twin Builder Flow item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a Digital Twin Builder Flow's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the digital twin builder flow. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Limitations\n\nTo retrieve the definition of a Digital twin builder flow item protected by an encrypted sensitivity label, the caller must have sufficient [usage rights](/fabric/enterprise/powerbi/service-security-sensitivity-label-change-enforcement) to remove the label, as configured in [Microsoft Purview](/purview/purview).\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" ], diff --git a/environment/swagger.json b/environment/swagger.json index 37b378a..ece310c 100644 --- a/environment/swagger.json +++ b/environment/swagger.json @@ -863,7 +863,7 @@ "/workspaces/{workspaceId}/environments/{environmentId}/getDefinition": { "post": { "summary": "Returns the specified environment public definition.", - "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a environment's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the environment. \n\n## Required Delegated Scopes \n\n Environment.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations\n\n This API is blocked for a environment with an encrypted sensitivity label.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a environment's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the environment. \n\n## Required Delegated Scopes \n\n Environment.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations\n\nTo retrieve the definition of an environment item protected by an encrypted sensitivity label, the caller must have sufficient [usage rights](/fabric/enterprise/powerbi/service-security-sensitivity-label-change-enforcement) to remove the label, as configured in [Microsoft Purview](/purview/purview).\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" ], diff --git a/eventSchemaSet/swagger.json b/eventSchemaSet/swagger.json index 7727198..7069ccd 100644 --- a/eventSchemaSet/swagger.json +++ b/eventSchemaSet/swagger.json @@ -384,7 +384,7 @@ "/workspaces/{workspaceId}/eventSchemaSets/{eventSchemaSetId}/getDefinition": { "post": { "summary": "Returns the specified EventSchemaSet definition.", - "description": "> [!NOTE]\n> EventSchemaSets item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a EventSchemaSet's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the workspace role. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface", + "description": "> [!NOTE]\n> EventSchemaSets item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a EventSchemaSet's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the workspace role. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Limitations\n\nTo retrieve the definition of an event schema set item protected by an encrypted sensitivity label, the caller must have sufficient [usage rights](/fabric/enterprise/powerbi/service-security-sensitivity-label-change-enforcement) to remove the label, as configured in [Microsoft Purview](/purview/purview).\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface", "tags": [ "Items" ], diff --git a/eventhouse/swagger.json b/eventhouse/swagger.json index 7c15d86..f8c8fab 100644 --- a/eventhouse/swagger.json +++ b/eventhouse/swagger.json @@ -387,7 +387,7 @@ "/workspaces/{workspaceId}/eventhouses/{eventhouseId}/getDefinition": { "post": { "summary": "Returns the specified eventhouse public definition.", - "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\n The caller must have *read and write* permissions for the eventhouse. \n\n## Required Delegated Scopes \n\n Eventhouse.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", + "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\n The caller must have *read and write* permissions for the eventhouse. \n\n## Required Delegated Scopes \n\n Eventhouse.ReadWrite.All or Item.ReadWrite.All\n\n## Limitations\n\nTo retrieve the definition of an eventhouse item protected by an encrypted sensitivity label, the caller must have sufficient [usage rights](/fabric/enterprise/powerbi/service-security-sensitivity-label-change-enforcement) to remove the label, as configured in [Microsoft Purview](/purview/purview).\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" ], diff --git a/eventstream/swagger.json b/eventstream/swagger.json index ce17699..3ede62b 100644 --- a/eventstream/swagger.json +++ b/eventstream/swagger.json @@ -384,7 +384,7 @@ "/workspaces/{workspaceId}/eventstreams/{eventstreamId}/getDefinition": { "post": { "summary": "Returns the specified eventstream public definition.", - "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get an eventstream public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the eventstream. \n\n## Required Delegated Scopes \n\n Eventstream.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations\n\n This API is blocked for an eventstream with an encrypted sensitivity label.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get an eventstream public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the eventstream. \n\n## Required Delegated Scopes \n\n Eventstream.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations\n\nTo retrieve the definition of an eventstream item protected by an encrypted sensitivity label, the caller must have sufficient [usage rights](/fabric/enterprise/powerbi/service-security-sensitivity-label-change-enforcement) to remove the label, as configured in [Microsoft Purview](/purview/purview).\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" ], diff --git a/graphModel/swagger.json b/graphModel/swagger.json index 5b6bf83..0574e20 100644 --- a/graphModel/swagger.json +++ b/graphModel/swagger.json @@ -384,7 +384,7 @@ "/workspaces/{workspaceId}/graphModels/{graphModelId}/getDefinition": { "post": { "summary": "Returns the specified GraphModel public definition.", - "description": "> [!NOTE]\n> GraphModel item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a GraphModel's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the GraphModel. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "description": "> [!NOTE]\n> GraphModel item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a GraphModel's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the GraphModel. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Limitations\n\nTo retrieve the definition of a graph model item protected by an encrypted sensitivity label, the caller must have sufficient [usage rights](/fabric/enterprise/powerbi/service-security-sensitivity-label-change-enforcement) to remove the label, as configured in [Microsoft Purview](/purview/purview).\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" ], diff --git a/graphQLApi/swagger.json b/graphQLApi/swagger.json index 85ac83e..2eb083e 100644 --- a/graphQLApi/swagger.json +++ b/graphQLApi/swagger.json @@ -384,7 +384,7 @@ "/workspaces/{workspaceId}/graphQLApis/{graphQLApiId}/getDefinition": { "post": { "summary": "Returns the specified GraphQLApi public definition.", - "description": "\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a [GraphQLApi public definition](/rest/api/fabric/articles/item-management/definitions/graphql-api-definition), the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the GraphQLApi . \n\n## Required Delegated Scopes\n\n GraphQLApi.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations\n\n This API is blocked for a with an encrypted sensitivity label.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "description": "\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a [GraphQLApi public definition](/rest/api/fabric/articles/item-management/definitions/graphql-api-definition), the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the GraphQLApi . \n\n## Required Delegated Scopes\n\n GraphQLApi.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations\n\nTo retrieve the definition of a GraphQL API item protected by an encrypted sensitivity label, the caller must have sufficient [usage rights](/fabric/enterprise/powerbi/service-security-sensitivity-label-change-enforcement) to remove the label, as configured in [Microsoft Purview](/purview/purview).\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" ], diff --git a/graphQuerySet/swagger.json b/graphQuerySet/swagger.json index 7cc4ff2..9cecb04 100644 --- a/graphQuerySet/swagger.json +++ b/graphQuerySet/swagger.json @@ -384,7 +384,7 @@ "/workspaces/{workspaceId}/graphQuerySets/{graphQuerySetId}/getDefinition": { "post": { "summary": "Returns the specified graph queryset public definition.", - "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a GraphQuerySet's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the workspace. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a GraphQuerySet's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the workspace. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Limitations\n\nTo retrieve the definition of a graph query set item protected by an encrypted sensitivity label, the caller must have sufficient [usage rights](/fabric/enterprise/powerbi/service-security-sensitivity-label-change-enforcement) to remove the label, as configured in [Microsoft Purview](/purview/purview).\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" ], diff --git a/kqlDashboard/swagger.json b/kqlDashboard/swagger.json index 8877b4a..0b694e2 100644 --- a/kqlDashboard/swagger.json +++ b/kqlDashboard/swagger.json @@ -390,7 +390,7 @@ "/workspaces/{workspaceId}/kqlDashboards/{kqlDashboardId}/getDefinition": { "post": { "summary": "Returns the specified KQL dashboard public definition.", - "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\n The caller must have *read and write* permissions for the KQL dashboard. \n\n## Required Delegated Scopes \n\n KQLDashboard.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", + "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\n The caller must have *read and write* permissions for the KQL dashboard. \n\n## Required Delegated Scopes \n\n KQLDashboard.ReadWrite.All or Item.ReadWrite.All\n\n## Limitations\n\nTo retrieve the definition of a KQL dashboard item protected by an encrypted sensitivity label, the caller must have sufficient [usage rights](/fabric/enterprise/powerbi/service-security-sensitivity-label-change-enforcement) to remove the label, as configured in [Microsoft Purview](/purview/purview).\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" ], diff --git a/kqlDatabase/swagger.json b/kqlDatabase/swagger.json index 948cdf8..cefccac 100644 --- a/kqlDatabase/swagger.json +++ b/kqlDatabase/swagger.json @@ -393,7 +393,7 @@ "/workspaces/{workspaceId}/kqlDatabases/{kqlDatabaseId}/getDefinition": { "post": { "summary": "Returns the specified KQL database public definition.", - "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\n The caller must have *read and write* permissions for the KQL database. \n\n## Required Delegated Scopes \n\n KQLDatabase.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", + "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\n The caller must have *read and write* permissions for the KQL database. \n\n## Required Delegated Scopes \n\n KQLDatabase.ReadWrite.All or Item.ReadWrite.All\n\n## Limitations\n\nTo retrieve the definition of a KQL database item protected by an encrypted sensitivity label, the caller must have sufficient [usage rights](/fabric/enterprise/powerbi/service-security-sensitivity-label-change-enforcement) to remove the label, as configured in [Microsoft Purview](/purview/purview).\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" ], diff --git a/kqlQueryset/swagger.json b/kqlQueryset/swagger.json index b4cd7c6..1e47903 100644 --- a/kqlQueryset/swagger.json +++ b/kqlQueryset/swagger.json @@ -384,7 +384,7 @@ "/workspaces/{workspaceId}/kqlQuerysets/{kqlQuerysetId}/getDefinition": { "post": { "summary": "Returns the specified KQL queryset public definition.", - "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n ## Permissions\n\n The caller must have *read and write* permissions for the KQL queryset. \n\n## Required Delegated Scopes \n\n KQLQueryset.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", + "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n ## Permissions\n\n The caller must have *read and write* permissions for the KQL queryset. \n\n## Required Delegated Scopes \n\n KQLQueryset.ReadWrite.All or Item.ReadWrite.All\n\n## Limitations\n\nTo retrieve the definition of a KQL queryset item protected by an encrypted sensitivity label, the caller must have sufficient [usage rights](/fabric/enterprise/powerbi/service-security-sensitivity-label-change-enforcement) to remove the label, as configured in [Microsoft Purview](/purview/purview).\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" ], diff --git a/lakehouse/swagger.json b/lakehouse/swagger.json index 3e197ec..3e1c172 100644 --- a/lakehouse/swagger.json +++ b/lakehouse/swagger.json @@ -1301,7 +1301,7 @@ "/workspaces/{workspaceId}/lakehouses/{lakehouseId}/getDefinition": { "post": { "summary": "Returns the specified lakehouse public definition.", - "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a lakehouse's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\nThe caller must have *read and write* permissions for the lakehouse.\n\n## Required Delegated Scopes\n\n Lakehouse.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations\n\n This API is blocked for a lakehouse with an encrypted sensitivity label.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a lakehouse's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\nThe caller must have *read and write* permissions for the lakehouse.\n\n## Required Delegated Scopes\n\n Lakehouse.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations\n\nTo retrieve the definition of a lakehouse item protected by an encrypted sensitivity label, the caller must have sufficient [usage rights](/fabric/enterprise/powerbi/service-security-sensitivity-label-change-enforcement) to remove the label, as configured in [Microsoft Purview](/purview/purview).\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" ], diff --git a/map/swagger.json b/map/swagger.json index a2f345f..a58aadf 100644 --- a/map/swagger.json +++ b/map/swagger.json @@ -384,7 +384,7 @@ "/workspaces/{workspaceId}/maps/{mapId}/getDefinition": { "post": { "summary": "Returns the specified Map public definition.", - "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a Map's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the Map. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a Map's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the Map. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Limitations\n\nTo retrieve the definition of a map item protected by an encrypted sensitivity label, the caller must have sufficient [usage rights](/fabric/enterprise/powerbi/service-security-sensitivity-label-change-enforcement) to remove the label, as configured in [Microsoft Purview](/purview/purview).\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" ], diff --git a/mirroredAzureDatabricksCatalog/swagger.json b/mirroredAzureDatabricksCatalog/swagger.json index c6e98e1..d50bb44 100644 --- a/mirroredAzureDatabricksCatalog/swagger.json +++ b/mirroredAzureDatabricksCatalog/swagger.json @@ -387,7 +387,7 @@ "/workspaces/{workspaceId}/mirroredAzureDatabricksCatalogs/{mirroredAzureDatabricksCatalogId}/getDefinition": { "post": { "summary": "Returns the specified mirroredAzureDatabricksCatalog public definition.", - "description": "> [!NOTE]\n> Mirrored Azure Databricks Catalog item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\n The caller must have *read and write* permissions for the mirrored azure databricks catalog. \n\n## Required Delegated Scopes \n\n MirroredAzureDatabricksCatalog.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", + "description": "> [!NOTE]\n> Mirrored Azure Databricks Catalog item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\n The caller must have *read and write* permissions for the mirrored azure databricks catalog. \n\n## Required Delegated Scopes \n\n MirroredAzureDatabricksCatalog.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations\n\nTo retrieve the definition of a mirrored Azure Databricks catalog item protected by an encrypted sensitivity label, the caller must have sufficient [usage rights](/fabric/enterprise/powerbi/service-security-sensitivity-label-change-enforcement) to remove the label, as configured in [Microsoft Purview](/purview/purview).\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" ], diff --git a/mirroredCatalog/swagger.json b/mirroredCatalog/swagger.json index bff4c1e..fe8260c 100644 --- a/mirroredCatalog/swagger.json +++ b/mirroredCatalog/swagger.json @@ -371,7 +371,7 @@ "/workspaces/{workspaceId}/mirroredCatalogs/{mirroredCatalogId}/getDefinition": { "post": { "summary": "Returns the specified MirroredCatalog public definition.", - "description": "> [!NOTE]\n> MirroredCatalog item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a MirroredCatalog's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the mirrored catalog. \n\n## Required Delegated Scopes \n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "description": "> [!NOTE]\n> MirroredCatalog item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a MirroredCatalog's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the mirrored catalog. \n\n## Required Delegated Scopes \n\n Item.ReadWrite.All\n\n## Limitations\n\nTo retrieve the definition of a mirrored catalog item protected by an encrypted sensitivity label, the caller must have sufficient [usage rights](/fabric/enterprise/powerbi/service-security-sensitivity-label-change-enforcement) to remove the label, as configured in [Microsoft Purview](/purview/purview).\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" ], diff --git a/mirroredDatabase/swagger.json b/mirroredDatabase/swagger.json index 01dd09c..e61603d 100644 --- a/mirroredDatabase/swagger.json +++ b/mirroredDatabase/swagger.json @@ -363,7 +363,7 @@ "/workspaces/{workspaceId}/mirroredDatabases/{mirroredDatabaseId}/getDefinition": { "post": { "summary": "Returns the specified mirrored database public definition.", - "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\n The caller must have *read and write* permissions for the mirrored database. \n\n## Required Delegated Scopes \n\n MirroredDatabase.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", + "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\n The caller must have *read and write* permissions for the mirrored database. \n\n## Required Delegated Scopes \n\n MirroredDatabase.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations\n\nTo retrieve the definition of a mirrored database item protected by an encrypted sensitivity label, the caller must have sufficient [usage rights](/fabric/enterprise/powerbi/service-security-sensitivity-label-change-enforcement) to remove the label, as configured in [Microsoft Purview](/purview/purview).\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" ], diff --git a/monitoring/definitions.json b/monitoring/definitions.json new file mode 100644 index 0000000..e748594 --- /dev/null +++ b/monitoring/definitions.json @@ -0,0 +1,204 @@ +{ + "swagger": "2.0", + "info": { + "title": "Monitoring data types", + "version": "v1" + }, + "paths": {}, + "definitions": { + "Monitoring": { + "description": "A Monitoring object.", + "type": "object", + "required": ["type"], + "allOf": [ + { + "$ref": "../common/definitions.json#/definitions/Item" + } + ], + "properties": { + "properties": { + "description": "The Monitoring properties.", + "$ref": "#/definitions/MonitoringProperties", + "readOnly": true + } + } + }, + "MonitoringProperties": { + "description": "The Monitoring properties.", + "type": "object", + "properties": { + "dataCollectionState": { + "description": "The data collection state of the Monitoring item. This property is read-only and is transitioned only through the enable and disable data collection operations. Additional data collection states may be added over time.", + "type": "string", + "readOnly": true, + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "DataCollectionState", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "Data collection is active for the Monitoring item." + }, + { + "value": "Disabled", + "description": "Data collection is not active for the Monitoring item." + } + ] + } + } + } + }, + "MonitoringItems": { + "description": "A list of Monitoring items.", + "required": ["value"], + "type": "object", + "properties": { + "value": { + "description": "A list of Monitoring items.", + "type": "array", + "items": { + "$ref": "#/definitions/Monitoring" + }, + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../common/definitions.json#/definitions/PaginatedResponse" + } + ] + }, + "CreateMonitoringRequest": { + "description": "The request payload for creating a Monitoring.", + "required": ["displayName"], + "properties": { + "displayName": { + "description": "The Monitoring display name. Must contain 2 to 128 characters using only ASCII letters, digits, underscores (_), periods (.), and hyphens (-), with no spaces and no leading or trailing double underscore (__).", + "type": "string", + "minLength": 2, + "maxLength": 128, + "pattern": "^(?!__)(?!.*__$)[0-9a-zA-Z_.-]+(?![\\s\\S])", + "readOnly": false + }, + "description": { + "description": "The Monitoring description. Maximum length is 256 characters.", + "type": "string", + "maxLength": 256, + "readOnly": false + }, + "folderId": { + "description": "The folder ID. If not specified or null, the Monitoring is created with the workspace as its folder.", + "type": "string", + "format": "uuid", + "readOnly": false + }, + "definition": { + "description": "The Monitoring public definition.", + "$ref": "#/definitions/MonitoringPublicDefinition", + "readOnly": false + }, + "sensitivityLabelSettings": { + "description": "The sensitivity label settings for the Monitoring.", + "$ref": "../common/definitions.json#/definitions/SensitivityLabelSettings", + "readOnly": false + } + } + }, + "UpdateMonitoringDefinitionRequest": { + "description": "The request payload for updating a Monitoring public definition.", + "required": ["definition"], + "properties": { + "definition": { + "$ref": "#/definitions/MonitoringPublicDefinition", + "readOnly": false + } + } + }, + "MonitoringDefinitionResponse": { + "description": "The response payload for a Monitoring public definition.", + "required": ["definition"], + "properties": { + "definition": { + "$ref": "#/definitions/MonitoringPublicDefinition", + "readOnly": true + } + } + }, + "MonitoringPublicDefinition" : { + "description": "The Monitoring public definition object. Refer to this [article](/rest/api/fabric/articles/item-management/definitions/monitoring-definition) for more details on the structure of the Monitoring definition.", + "type": "object", + "required": ["parts"], + "properties": { + "format": { + "description": "The format of the Monitoring definition. Additional `format` types may be added over time.", + "type": "string", + "enum": [ + "MonitoringV1" + ], + "x-ms-enum": { + "name": "MonitoringDefinitionFormat", + "modelAsString": true, + "values": [ + { + "value": "MonitoringV1", + "description": "The format for Monitoring definitions, designed to support CI/CD scenarios in Fabric. See [Monitoring - MonitoringV1 specification](/rest/api/fabric/articles/item-management/definitions/monitoring-definition) for more details." + } + ] + }, + "readOnly": false + }, + "parts": { + "description": "A list of definition parts.", + "type": "array", + "items": { + "$ref": "#/definitions/MonitoringPublicDefinitionPart" + }, + "readOnly": false + } + } + }, + "MonitoringPublicDefinitionPart": { + "description": "The Monitoring definition part object.", + "type": "object", + "required": ["path", "payload", "payloadType"], + "properties": { + "path": { + "description": "The Monitoring public definition part path.", + "type": "string", + "readOnly": false + }, + "payload": { + "description": "The Monitoring public definition part payload.", + "type": "string", + "readOnly": false + }, + "payloadType":{ + "description": "The payload type.", + "$ref": "../common/definitions.json#/definitions/PayloadType", + "readOnly": false + } + } + }, + "UpdateMonitoringRequest": { + "description": "The request payload for updating a Monitoring.", + "properties": { + "displayName": { + "description": "The Monitoring display name. Maximum length is 128 characters.", + "type": "string", + "maxLength": 128, + "readOnly": false + }, + "description": { + "description": "The Monitoring description. Maximum length is 256 characters.", + "type": "string", + "maxLength": 256, + "readOnly": false + } + } + } + } +} diff --git a/monitoring/examples/CreateMonitoring.json b/monitoring/examples/CreateMonitoring.json new file mode 100644 index 0000000..6a66c15 --- /dev/null +++ b/monitoring/examples/CreateMonitoring.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229", + "createMonitoringRequest": { + "displayName": "Monitoring_1", + "description": "A Monitoring description.", + "definition": { + "format": "MonitoringV1", + "parts": [ + { + "path": "MonitoringProperties.json", + "payload": "eyJkYXRhQ29sbGVjdGlvblNldHRpbmdzIjpbeyJzb3VyY2VzIjp7IndvcmtzcGFjZURpYWdub3N0aWNzIjp7Im1vZGUiOiJBbGwifX0sImRlc3RpbmF0aW9ucyI6eyJldmVudGhvdXNlIjp7Im1vZGUiOiJBdXRvIn0sImV2ZW50U3RyZWFtIjp7ImN1c3RvbUVuZHBvaW50Ijp7ImVuYWJsZWQiOmZhbHNlfX19fV0sIm9wZXJhdGlvbnNBZ2VudCI6eyJlbmFibGVkIjpmYWxzZX19", + "payloadType": "InlineBase64" + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "displayName": "Monitoring_1", + "description": "A Monitoring description.", + "type": "Monitoring", + "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229", + "id": "5b218778-e7a5-4d73-8187-f10824047715" + } + }, + "202": { + "headers": { + "Location": "https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6", + "x-ms-operation-id": "0acd697c-1550-43cd-b998-91bfbfbd47c6", + "Retry-After": 30 + } + } + } +} diff --git a/monitoring/examples/CreateMonitoringWithoutDefinition.json b/monitoring/examples/CreateMonitoringWithoutDefinition.json new file mode 100644 index 0000000..fc97699 --- /dev/null +++ b/monitoring/examples/CreateMonitoringWithoutDefinition.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229", + "createMonitoringRequest": { + "displayName": "Monitoring_1", + "description": "A Monitoring description." + } + }, + "responses": { + "201": { + "body": { + "displayName": "Monitoring_1", + "description": "A Monitoring description.", + "type": "Monitoring", + "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229", + "id": "5b218778-e7a5-4d73-8187-f10824047715" + } + }, + "202": { + "headers": { + "Location": "https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6", + "x-ms-operation-id": "0acd697c-1550-43cd-b998-91bfbfbd47c6", + "Retry-After": 30 + } + } + } +} diff --git a/monitoring/examples/DeleteMonitoring.json b/monitoring/examples/DeleteMonitoring.json new file mode 100644 index 0000000..6a7aa1a --- /dev/null +++ b/monitoring/examples/DeleteMonitoring.json @@ -0,0 +1,9 @@ +{ + "parameters": { + "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229", + "monitoringId": "5b218778-e7a5-4d73-8187-f10824047715" + }, + "responses": { + "200": {} + } +} diff --git a/monitoring/examples/DisableDataCollection.json b/monitoring/examples/DisableDataCollection.json new file mode 100644 index 0000000..6a7aa1a --- /dev/null +++ b/monitoring/examples/DisableDataCollection.json @@ -0,0 +1,9 @@ +{ + "parameters": { + "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229", + "monitoringId": "5b218778-e7a5-4d73-8187-f10824047715" + }, + "responses": { + "200": {} + } +} diff --git a/monitoring/examples/EnableDataCollection.json b/monitoring/examples/EnableDataCollection.json new file mode 100644 index 0000000..6a7aa1a --- /dev/null +++ b/monitoring/examples/EnableDataCollection.json @@ -0,0 +1,9 @@ +{ + "parameters": { + "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229", + "monitoringId": "5b218778-e7a5-4d73-8187-f10824047715" + }, + "responses": { + "200": {} + } +} diff --git a/monitoring/examples/GetMonitoring.json b/monitoring/examples/GetMonitoring.json new file mode 100644 index 0000000..215db35 --- /dev/null +++ b/monitoring/examples/GetMonitoring.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229", + "monitoringId": "5b218778-e7a5-4d73-8187-f10824047715" + }, + "responses": { + "200": { + "body": { + "id": "5b218778-e7a5-4d73-8187-f10824047715", + "displayName": "Monitoring 1", + "description": "A Monitoring description.", + "type": "Monitoring", + "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229", + "properties": { + "dataCollectionState": "Enabled" + } + } + } + } +} diff --git a/monitoring/examples/GetMonitoringDefinition.json b/monitoring/examples/GetMonitoringDefinition.json new file mode 100644 index 0000000..149f2fe --- /dev/null +++ b/monitoring/examples/GetMonitoringDefinition.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "workspaceId": "6e335e92-a2a2-4b5a-970a-bd6a89fbb765", + "monitoringId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229" + }, + "responses": { + "200": { + "body": { + "definition": { + "format": "MonitoringV1", + "parts": [ + { + "path": "MonitoringProperties.json", + "payload": "eyJkYXRhQ29sbGVjdGlvblNldHRpbmdzIjpbeyJzb3VyY2VzIjp7IndvcmtzcGFjZURpYWdub3N0aWNzIjp7Im1vZGUiOiJBbGwifX0sImRlc3RpbmF0aW9ucyI6eyJldmVudGhvdXNlIjp7Im1vZGUiOiJBdXRvIn0sImV2ZW50U3RyZWFtIjp7ImN1c3RvbUVuZHBvaW50Ijp7ImVuYWJsZWQiOmZhbHNlfX19fV0sIm9wZXJhdGlvbnNBZ2VudCI6eyJlbmFibGVkIjpmYWxzZX19", + "payloadType": "InlineBase64" + } + ] + } + } + }, + "202": { + "headers": { + "Location": "https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7", + "x-ms-operation-id": "431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7", + "Retry-After": 30 + } + } + } +} diff --git a/monitoring/examples/ListMonitoringItemsInWorkspace.json b/monitoring/examples/ListMonitoringItemsInWorkspace.json new file mode 100644 index 0000000..1384a96 --- /dev/null +++ b/monitoring/examples/ListMonitoringItemsInWorkspace.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "3546052c-ae64-4526-b1a8-52af7761426f", + "displayName": "Monitoring Name 1", + "description": "A Monitoring description.", + "type": "Monitoring", + "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229", + "properties": { + "dataCollectionState": "Enabled" + } + }, + { + "id": "f697fb63-abd4-4399-9548-be7e3c3c0dac", + "displayName": "Monitoring Name 2", + "description": "A Monitoring description.", + "type": "Monitoring", + "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229", + "properties": { + "dataCollectionState": "Disabled" + } + } + ] + } + } + } +} diff --git a/monitoring/examples/UpdateMonitoring.json b/monitoring/examples/UpdateMonitoring.json new file mode 100644 index 0000000..c0357de --- /dev/null +++ b/monitoring/examples/UpdateMonitoring.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229", + "monitoringId": "5b218778-e7a5-4d73-8187-f10824047715", + "updateMonitoringRequest": { + "displayName": "Monitoring's New name", + "description": "Monitoring's New description" + } + }, + "responses": { + "200": { + "body": { + "displayName": "Monitoring's New name", + "description": "Monitoring's New description", + "type": "Monitoring", + "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229", + "id": "5b218778-e7a5-4d73-8187-f10824047715", + "properties": { + "dataCollectionState": "Enabled" + } + } + } + } +} diff --git a/monitoring/examples/UpdateMonitoringDefinition.json b/monitoring/examples/UpdateMonitoringDefinition.json new file mode 100644 index 0000000..0af73c9 --- /dev/null +++ b/monitoring/examples/UpdateMonitoringDefinition.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229", + "monitoringId": "5b218778-e7a5-4d73-8187-f10824047715", + "updateMonitoringDefinitionRequest": { + "definition": { + "format": "MonitoringV1", + "parts": [ + { + "path": "MonitoringProperties.json", + "payload": "eyJkYXRhQ29sbGVjdGlvblNldHRpbmdzIjpbeyJzb3VyY2VzIjp7IndvcmtzcGFjZURpYWdub3N0aWNzIjp7Im1vZGUiOiJBbGwifX0sImRlc3RpbmF0aW9ucyI6eyJldmVudGhvdXNlIjp7Im1vZGUiOiJBdXRvIn0sImV2ZW50U3RyZWFtIjp7ImN1c3RvbUVuZHBvaW50Ijp7ImVuYWJsZWQiOmZhbHNlfX19fV0sIm9wZXJhdGlvbnNBZ2VudCI6eyJlbmFibGVkIjpmYWxzZX19", + "payloadType": "InlineBase64" + } + ] + } + } + }, + "responses": { + "200": { + }, + "202": { + "headers": { + "Location": "https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef", + "x-ms-operation-id": "427f6c34-b64e-4ee4-8ea5-b533c0e203ef", + "Retry-After": 30 + } + } + } +} diff --git a/monitoring/swagger.json b/monitoring/swagger.json new file mode 100644 index 0000000..df081e2 --- /dev/null +++ b/monitoring/swagger.json @@ -0,0 +1,682 @@ +{ + "swagger": "2.0", + "info": { + "title": "Monitoring REST APIs", + "version": "v1" + }, + "schemes": [ + "https" + ], + "host": "api.fabric.microsoft.com", + "basePath": "/v1", + "paths": { + "/workspaces/{workspaceId}/monitoringItems": { + "get": { + "summary": "Lists Monitoring items in the specified workspace.", + "description": "> [!NOTE]\n> Monitoring item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\nThe caller must have a *viewer* workspace role.\n\n## Required Delegated Scopes\n\nWorkspace.Read.All or Workspace.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "tags": [ + "Items" + ], + "operationId": "Items_ListMonitoringItems", + "x-ms-pageable": { + "nextLinkName": "continuationUri" + }, + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "description": "The workspace ID.", + "type": "string", + "format": "uuid", + "required": true + }, + { + "in": "query", + "name": "recursive", + "description": "Specifies whether to include items in nested folders. When true, all items in the folder and its nested folders are listed. When false, only items in the folder are listed. The default value is true.", + "type": "boolean", + "required": false + }, + { + "in": "query", + "name": "rootFolderId", + "description": "This parameter allows users to filter items based on a specific root folder. If not provided, the workspace is used as the root folder.", + "type": "string", + "format": "uuid", + "required": false + }, + { + "in": "query", + "name": "continuationToken", + "description": "A token for retrieving the next page of results.", + "type": "string", + "required": false + } + ], + "responses": { + "200": { + "description": "Request completed successfully.", + "schema": { + "$ref": "./definitions.json#/definitions/MonitoringItems" + } + }, + "429": { + "description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.", + "x-ms-error-response": true, + "headers": { + "Retry-After": { + "type": "integer", + "description": "The number of seconds to wait before retrying the request." + } + }, + "schema": { + "$ref": "../common/definitions.json#/definitions/ErrorResponse" + } + }, + "default": { + "description": "Common error codes:\n\n* InvalidItemType - Invalid item type.", + "schema": { + "$ref": "../common/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Monitoring items in workspace example": { + "$ref": "./examples/ListMonitoringItemsInWorkspace.json" + } + } + }, + "post": { + "summary": "Creates a Monitoring in the specified workspace.", + "description": "> [!NOTE]\n> Monitoring item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nTo create a Monitoring with a definition, refer to [Monitoring](/rest/api/fabric/articles/item-management/definitions/monitoring-definition) article.\n\n## Permissions\n\nThe caller must have a *contributor* workspace role.\n\n## Required Delegated Scopes\n\nItem.ReadWrite.All\n\n## Limitations\n\n- To create a Monitoring, the workspace must be on a supported Fabric capacity. For more information see: [Microsoft Fabric license types](/fabric/enterprise/licenses#microsoft-fabric-license-types).\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "tags": [ + "Items" + ], + "operationId": "Items_CreateMonitoring", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-fabric-sdk-long-running-operation": true, + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "description": "The workspace ID.", + "type": "string", + "format": "uuid", + "required": true + }, + { + "in": "body", + "name": "createMonitoringRequest", + "description": "Create item request payload.", + "schema": { + "$ref": "./definitions.json#/definitions/CreateMonitoringRequest" + }, + "required": true + } + ], + "responses": { + "201": { + "description": "Successfully created.", + "schema": { + "$ref": "./definitions.json#/definitions/Monitoring" + } + }, + "202": { + "description": "Request accepted, Monitoring provisioning in progress.", + "headers": { + "Location": { + "description": "The URL of the operation status, which can be used to track the operation state.", + "type": "string" + }, + "x-ms-operation-id": { + "description": "The operation ID which can be used with long running operations (LRO) APIs to track the operation state and get the result.", + "type": "string", + "format": "uuid" + }, + "Retry-After": { + "type": "integer", + "description": "The number of seconds to wait before retrying the request." + } + } + }, + "429": { + "description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.", + "x-ms-error-response": true, + "headers": { + "Retry-After": { + "type": "integer", + "description": "The number of seconds to wait before retrying the request." + } + }, + "schema": { + "$ref": "../common/definitions.json#/definitions/ErrorResponse" + } + }, + "default": { + "description": "Common error codes:\n\n* ItemDisplayNameAlreadyInUse - Item display name is already used.\n\n* WSMDisplayNameRequired - A Monitoring display name was not supplied.\n\n* WSMDisplayNameInvalid - The Monitoring display name violates the length or allowed-character rules.\n\n* CorruptedPayload - The provided payload is corrupted.\n\n* WorkspaceItemsLimitExceeded - Workspace item limit exceeded.", + "schema": { + "$ref": "../common/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create a Monitoring example": { + "$ref": "./examples/CreateMonitoringWithoutDefinition.json" + }, + "Create a Monitoring with definition example": { + "$ref": "./examples/CreateMonitoring.json" + } + } + } + }, + "/workspaces/{workspaceId}/monitoringItems/{monitoringId}": { + "get": { + "summary": "Gets the specified Monitoring.", + "description": "> [!NOTE]\n> Monitoring item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\n## Permissions\n\nThe caller must have *read* permissions for the Monitoring.\n\n## Required Delegated Scopes\n\nItem.Read.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "tags": [ + "Items" + ], + "operationId": "Items_GetMonitoring", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "description": "The workspace ID.", + "type": "string", + "format": "uuid", + "required": true + }, + { + "in": "path", + "name": "monitoringId", + "description": "The Monitoring ID.", + "type": "string", + "format": "uuid", + "required": true + } + ], + "responses": { + "200": { + "description": "Request completed successfully.", + "schema": { + "$ref": "./definitions.json#/definitions/Monitoring" + } + }, + "429": { + "description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.", + "x-ms-error-response": true, + "headers": { + "Retry-After": { + "type": "integer", + "description": "The number of seconds to wait before retrying the request." + } + }, + "schema": { + "$ref": "../common/definitions.json#/definitions/ErrorResponse" + } + }, + "default": { + "description": "Common error codes:\n\n* ItemNotFound - The requested item was not found.", + "schema": { + "$ref": "../common/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a Monitoring example": { + "$ref": "./examples/GetMonitoring.json" + } + } + }, + "patch": { + "summary": "Updates the specified Monitoring.", + "description": "> [!NOTE]\n> Monitoring item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\n## Permissions\n\nThe caller must have *read and write* permissions for the Monitoring.\n\n## Required Delegated Scopes\n\nItem.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "tags": [ + "Items" + ], + "operationId": "Items_UpdateMonitoring", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "description": "The workspace ID.", + "type": "string", + "format": "uuid", + "required": true + }, + { + "in": "path", + "name": "monitoringId", + "description": "The Monitoring ID.", + "type": "string", + "format": "uuid", + "required": true + }, + { + "in": "body", + "name": "updateMonitoringRequest", + "description": "Update Monitoring request payload.", + "schema": { + "$ref": "./definitions.json#/definitions/UpdateMonitoringRequest" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "Request completed successfully.", + "schema": { + "$ref": "./definitions.json#/definitions/Monitoring" + } + }, + "429": { + "description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.", + "x-ms-error-response": true, + "headers": { + "Retry-After": { + "type": "integer", + "description": "The number of seconds to wait before retrying the request." + } + }, + "schema": { + "$ref": "../common/definitions.json#/definitions/ErrorResponse" + } + }, + "default": { + "description": "Common error codes:\n\n* ItemNotFound - The requested item was not found.\n\n* InvalidRequest - Invalid update request.", + "schema": { + "$ref": "../common/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update a Monitoring example": { + "$ref": "./examples/UpdateMonitoring.json" + } + } + }, + "delete": { + "summary": "Deletes the specified Monitoring.", + "description": "> [!NOTE]\n> Monitoring item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\n## Permissions\n\nThe caller must have *write* permissions for the Monitoring.\n\n## Required Delegated Scopes\n\nItem.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "tags": [ + "Items" + ], + "operationId": "Items_DeleteMonitoring", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "description": "The workspace ID.", + "type": "string", + "format": "uuid", + "required": true + }, + { + "in": "path", + "name": "monitoringId", + "description": "The Monitoring ID.", + "type": "string", + "format": "uuid", + "required": true + } + ], + "responses": { + "200": { + "description": "Request completed successfully." + }, + "429": { + "description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.", + "x-ms-error-response": true, + "headers": { + "Retry-After": { + "type": "integer", + "description": "The number of seconds to wait before retrying the request." + } + }, + "schema": { + "$ref": "../common/definitions.json#/definitions/ErrorResponse" + } + }, + "default": { + "description": "Common error codes:\n\n* ItemNotFound - The requested item was not found.", + "schema": { + "$ref": "../common/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete a Monitoring example": { + "$ref": "./examples/DeleteMonitoring.json" + } + } + } + }, + "/workspaces/{workspaceId}/monitoringItems/{monitoringId}/getDefinition": { + "post": { + "summary": "Gets the Monitoring definition.", + "description": "> [!NOTE]\n> Monitoring item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a Monitoring's definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\nThe caller must have *read and write* permissions for the Monitoring.\n\n## Required Delegated Scopes\n\nItem.ReadWrite.All\n\n## Limitations\n\nTo retrieve the definition of a Monitoring item protected by an encrypted sensitivity label, the caller must have sufficient [usage rights](/fabric/enterprise/powerbi/service-security-sensitivity-label-change-enforcement) to remove the label, as configured in [Microsoft Purview](/purview/purview).\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "tags": [ + "Items" + ], + "operationId": "Items_GetMonitoringDefinition", + "produces": [ + "application/json" + ], + "x-ms-fabric-sdk-long-running-operation": true, + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "description": "The workspace ID.", + "type": "string", + "format": "uuid", + "required": true + }, + { + "in": "path", + "name": "monitoringId", + "description": "The Monitoring ID.", + "type": "string", + "format": "uuid", + "required": true + }, + { + "in": "query", + "name": "format", + "description": "The format of the Monitoring definition.", + "type": "string", + "required": false + } + ], + "responses": { + "200": { + "description": "Request completed successfully.", + "schema": { + "$ref": "./definitions.json#/definitions/MonitoringDefinitionResponse" + } + }, + "202": { + "description": "Request accepted. Retrieving the definition is in progress.", + "headers": { + "Location": { + "description": "The URL of the operation status, which can be used to track the operation state.", + "type": "string" + }, + "x-ms-operation-id": { + "description": "The operation ID which can be used with long running operations (LRO) APIs to track the operation state and get the result.", + "type": "string", + "format": "uuid" + }, + "Retry-After": { + "type": "integer", + "description": "The number of seconds to wait before retrying the request." + } + } + }, + "429": { + "description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.", + "x-ms-error-response": true, + "headers": { + "Retry-After": { + "type": "integer", + "description": "The number of seconds to wait before retrying the request." + } + }, + "schema": { + "$ref": "../common/definitions.json#/definitions/ErrorResponse" + } + }, + "default": { + "description": "Common error codes:\n\n* OperationNotSupportedForItem - Operation not supported for requested item.", + "schema": { + "$ref": "../common/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a Monitoring definition example": { + "$ref": "./examples/GetMonitoringDefinition.json" + } + } + } + }, + "/workspaces/{workspaceId}/monitoringItems/{monitoringId}/updateDefinition": { + "post": { + "summary": "Updates the Monitoring definition.", + "description": "> [!NOTE]\n> Monitoring item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nUpdating the Monitoring's definition does not affect its sensitivity label. The optional `dataCollectionSettings` array must contain exactly one complete source/destination mapping when present. Once configured, the Eventhouse mode and Linked parent Monitoring reference cannot be changed or removed. The optional `operationsAgent` object requires `dataCollectionSettings` and an explicit `enabled` value. The Operations Agent may be enabled later, but once enabled cannot be disabled or removed.\n\n## Permissions\n\nThe caller must have *read and write* permissions for the Monitoring.\n\n## Required Delegated Scopes\n\nItem.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "tags": [ + "Items" + ], + "operationId": "Items_UpdateMonitoringDefinition", + "produces": [ + "application/json" + ], + "x-ms-fabric-sdk-long-running-operation": true, + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "description": "The workspace ID.", + "type": "string", + "format": "uuid", + "required": true + }, + { + "in": "path", + "name": "monitoringId", + "description": "The Monitoring ID.", + "type": "string", + "format": "uuid", + "required": true + }, + { + "in": "query", + "name": "updateMetadata", + "description": "When set to true and the .platform file is provided as part of the definition, the item's metadata is updated using the metadata in the .platform file.", + "type": "boolean", + "required": false + }, + { + "in": "body", + "name": "updateMonitoringDefinitionRequest", + "description": "Update Monitoring definition request payload.", + "schema": { + "$ref": "./definitions.json#/definitions/UpdateMonitoringDefinitionRequest" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "Request completed successfully." + }, + "202": { + "description": "Request accepted. Update definition is in progress.", + "headers": { + "Location": { + "description": "The URL of the operation status, which can be used to track the operation state.", + "type": "string" + }, + "x-ms-operation-id": { + "description": "The operation ID which can be used with long running operations (LRO) APIs to track the operation state and get the result.", + "type": "string", + "format": "uuid" + }, + "Retry-After": { + "type": "integer", + "description": "The number of seconds to wait before retrying the request." + } + } + }, + "429": { + "description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.", + "x-ms-error-response": true, + "headers": { + "Retry-After": { + "type": "integer", + "description": "The number of seconds to wait before retrying the request." + } + }, + "schema": { + "$ref": "../common/definitions.json#/definitions/ErrorResponse" + } + }, + "default": { + "description": "Common error codes:\n\n* OperationNotSupportedForItem - Operation not supported for the requested item.\n\n* CorruptedPayload - The provided payload is corrupted.\n\n* WSMAlmInvalidDefinition - The definition is malformed or violates the supported source/destination or Operations Agent constraints (HTTP 400).\n\n* WSMDefinitionImmutableProperty - The update changes or removes an immutable Eventhouse configuration, or disables or removes an enabled Operations Agent (HTTP 409).", + "schema": { + "$ref": "../common/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update a Monitoring definition example": { + "$ref": "./examples/UpdateMonitoringDefinition.json" + } + } + } + }, + "/workspaces/{workspaceId}/monitoringItems/{monitoringId}/enableDataCollection": { + "post": { + "summary": "Enables data collection for the specified Monitoring.", + "description": "> [!NOTE]\n> Monitoring item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nTurns on data collection for the specified Monitoring item using the data collection settings already configured in the item's definition, and transitions the read-only data collection state to `Enabled`. This operation takes no request body. Enabling an item that already has data collection enabled succeeds without making changes. To change what is collected or where it's routed, update the item's definition.\n\n## Permissions\n\nThe caller must have *write* permission on the Monitoring item and an *admin* workspace role.\n\n## Required Delegated Scopes\n\nItem.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "tags": [ + "DataCollection" + ], + "operationId": "DataCollection_Enable", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "description": "The workspace ID.", + "type": "string", + "format": "uuid", + "required": true + }, + { + "in": "path", + "name": "monitoringId", + "description": "The Monitoring ID.", + "type": "string", + "format": "uuid", + "required": true + } + ], + "responses": { + "200": { + "description": "Request completed successfully." + }, + "429": { + "description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.", + "x-ms-error-response": true, + "headers": { + "Retry-After": { + "type": "integer", + "description": "The number of seconds to wait before retrying the request." + } + }, + "schema": { + "$ref": "../common/definitions.json#/definitions/ErrorResponse" + } + }, + "default": { + "description": "Common error codes:\n\n* ItemNotFound - The requested item was not found.\n\n* WSMDataCollectionAlreadyEnabledInWorkspace - HTTP 409 Conflict. Another Monitoring item in the workspace is already collecting data. The existing item remains enabled; collection is not automatically transferred. Disable data collection on that item, then retry enabling the target item.", + "schema": { + "$ref": "../common/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Enable data collection example": { + "$ref": "./examples/EnableDataCollection.json" + } + } + } + }, + "/workspaces/{workspaceId}/monitoringItems/{monitoringId}/disableDataCollection": { + "post": { + "summary": "Disables data collection for the specified Monitoring.", + "description": "> [!NOTE]\n> Monitoring item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nTurns off data collection for the specified Monitoring item and transitions the read-only data collection state to `Disabled`. This operation takes no request body. The item's data collection settings definition is left unchanged; disabling only stops collection. Disabling an item that already has data collection disabled succeeds without making changes.\n\n## Permissions\n\nThe caller must have *write* permission on the Monitoring item and an *admin* workspace role.\n\n## Required Delegated Scopes\n\nItem.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "tags": [ + "DataCollection" + ], + "operationId": "DataCollection_Disable", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "description": "The workspace ID.", + "type": "string", + "format": "uuid", + "required": true + }, + { + "in": "path", + "name": "monitoringId", + "description": "The Monitoring ID.", + "type": "string", + "format": "uuid", + "required": true + } + ], + "responses": { + "200": { + "description": "Request completed successfully." + }, + "429": { + "description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.", + "x-ms-error-response": true, + "headers": { + "Retry-After": { + "type": "integer", + "description": "The number of seconds to wait before retrying the request." + } + }, + "schema": { + "$ref": "../common/definitions.json#/definitions/ErrorResponse" + } + }, + "default": { + "description": "Common error codes:\n\n* ItemNotFound - The requested item was not found.", + "schema": { + "$ref": "../common/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Disable data collection example": { + "$ref": "./examples/DisableDataCollection.json" + } + } + } + } + }, + "responses": {}, + "security": [], + "tags": [] +} diff --git a/mountedDataFactory/swagger.json b/mountedDataFactory/swagger.json index 562e430..d0bf84d 100644 --- a/mountedDataFactory/swagger.json +++ b/mountedDataFactory/swagger.json @@ -381,7 +381,7 @@ "/workspaces/{workspaceId}/mountedDataFactories/{mountedDataFactoryId}/getDefinition": { "post": { "summary": "Returns the specified mounted data factory public definition.", - "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a MountedDataFactory's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the mounted data factory. \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 [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a MountedDataFactory's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the mounted data factory. \n\n## Limitations\n\nTo retrieve the definition of a mounted data factory item protected by an encrypted sensitivity label, the caller must have sufficient [usage rights](/fabric/enterprise/powerbi/service-security-sensitivity-label-change-enforcement) to remove the label, as configured in [Microsoft Purview](/purview/purview).\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" ], diff --git a/notebook/swagger.json b/notebook/swagger.json index cf55f16..47c14ff 100644 --- a/notebook/swagger.json +++ b/notebook/swagger.json @@ -387,7 +387,7 @@ "/workspaces/{workspaceId}/notebooks/{notebookId}/getDefinition": { "post": { "summary": "Returns the specified notebook public definition.", - "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a notebook's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the notebook. \n\n## Required Delegated Scopes \n\n Notebook.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations\n\n This API is blocked for a notebook with an encrypted sensitivity label.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a notebook's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the notebook. \n\n## Required Delegated Scopes \n\n Notebook.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations\n\nTo retrieve the definition of a notebook item protected by an encrypted sensitivity label, the caller must have sufficient [usage rights](/fabric/enterprise/powerbi/service-security-sensitivity-label-change-enforcement) to remove the label, as configured in [Microsoft Purview](/purview/purview).\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" ], diff --git a/ontology/swagger.json b/ontology/swagger.json index 508c3a8..bbc50b7 100644 --- a/ontology/swagger.json +++ b/ontology/swagger.json @@ -387,7 +387,7 @@ "/workspaces/{workspaceId}/ontologies/{ontologyId}/getDefinition": { "post": { "summary": "Returns the specified Ontology public definition.", - "description": "> [!NOTE]\n> Ontology item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get an ontology public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the ontology. \n\n## Required Delegated Scopes \n\n Item.ReadWrite.All \n\n## Limitations\n\n This API is blocked for an ontology with an encrypted sensitivity label.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "description": "> [!NOTE]\n> Ontology item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get an ontology public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the ontology. \n\n## Required Delegated Scopes \n\n Item.ReadWrite.All \n\n## Limitations\n\nTo retrieve the definition of an ontology item protected by an encrypted sensitivity label, the caller must have sufficient [usage rights](/fabric/enterprise/powerbi/service-security-sensitivity-label-change-enforcement) to remove the label, as configured in [Microsoft Purview](/purview/purview).\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" ], diff --git a/operationsAgent/swagger.json b/operationsAgent/swagger.json index 6581833..2294a08 100644 --- a/operationsAgent/swagger.json +++ b/operationsAgent/swagger.json @@ -384,7 +384,7 @@ "/workspaces/{workspaceId}/operationsAgents/{operationsAgentId}/getDefinition": { "post": { "summary": "Returns the specified OperationsAgent public definition.", - "description": "> [!NOTE]\n> OperationsAgent item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a OperationsAgent's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the OperationsAgent. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface", + "description": "> [!NOTE]\n> OperationsAgent item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a OperationsAgent's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the OperationsAgent. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Limitations\n\nTo retrieve the definition of an Operations agent item protected by an encrypted sensitivity label, the caller must have sufficient [usage rights](/fabric/enterprise/powerbi/service-security-sensitivity-label-change-enforcement) to remove the label, as configured in [Microsoft Purview](/purview/purview).\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface", "tags": [ "Items" ], diff --git a/orgApp/swagger.json b/orgApp/swagger.json index e7c2657..a1bc08f 100644 --- a/orgApp/swagger.json +++ b/orgApp/swagger.json @@ -374,7 +374,7 @@ "/workspaces/{workspaceId}/orgApps/{orgAppId}/getDefinition": { "post": { "summary": "Returns the specified OrgApp public definition.", - "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get an OrgApp's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the OrgApp. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get an OrgApp's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the OrgApp. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Limitations\n\nTo retrieve the definition of an Org app item protected by an encrypted sensitivity label, the caller must have sufficient [usage rights](/fabric/enterprise/powerbi/service-security-sensitivity-label-change-enforcement) to remove the label, as configured in [Microsoft Purview](/purview/purview).\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" ], diff --git a/orgAppAudience/swagger.json b/orgAppAudience/swagger.json index e9d2c16..db16765 100644 --- a/orgAppAudience/swagger.json +++ b/orgAppAudience/swagger.json @@ -374,7 +374,7 @@ "/workspaces/{workspaceId}/orgAppAudiences/{orgAppAudienceId}/getDefinition": { "post": { "summary": "Returns the specified OrgAppAudience public definition.", - "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get an OrgAppAudience's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the OrgAppAudience. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get an OrgAppAudience's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the OrgAppAudience. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Limitations\n\nTo retrieve the definition of an Org app audience item protected by an encrypted sensitivity label, the caller must have sufficient [usage rights](/fabric/enterprise/powerbi/service-security-sensitivity-label-change-enforcement) to remove the label, as configured in [Microsoft Purview](/purview/purview).\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" ], diff --git a/paginatedReport/swagger.json b/paginatedReport/swagger.json index 3cb4adf..7799d1e 100644 --- a/paginatedReport/swagger.json +++ b/paginatedReport/swagger.json @@ -371,7 +371,7 @@ "/workspaces/{workspaceId}/paginatedReports/{paginatedReportId}/getDefinition": { "post": { "summary": "Returns the specified paginated report public definition.", - "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\n The caller must have *read and write* permissions for the paginated report. \n\n## Required Delegated Scopes \n\n PaginatedReport.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", + "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\n The caller must have *read and write* permissions for the paginated report. \n\n## Required Delegated Scopes \n\n PaginatedReport.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations\n\nTo retrieve the definition of a paginated report item protected by an encrypted sensitivity label, the caller must have sufficient [usage rights](/fabric/enterprise/powerbi/service-security-sensitivity-label-change-enforcement) to remove the label, as configured in [Microsoft Purview](/purview/purview).\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" ], diff --git a/plan/swagger.json b/plan/swagger.json index c89f594..5d5f411 100644 --- a/plan/swagger.json +++ b/plan/swagger.json @@ -371,7 +371,7 @@ "/workspaces/{workspaceId}/plans/{planId}/getDefinition": { "post": { "summary": "Returns the definition of the specified plan.", - "description": "Gets the definition of the specified plan.\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\nThe caller must have *read and write* permissions for the plan.\n\n## Required Delegated Scopes\n\nItem.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "description": "Gets the definition of the specified plan.\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\nThe caller must have *read and write* permissions for the plan.\n\n## Required Delegated Scopes\n\nItem.ReadWrite.All\n\n## Limitations\n\nTo retrieve the definition of a plan item protected by an encrypted sensitivity label, the caller must have sufficient [usage rights](/fabric/enterprise/powerbi/service-security-sensitivity-label-change-enforcement) to remove the label, as configured in [Microsoft Purview](/purview/purview).\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" ], diff --git a/platform/swagger.json b/platform/swagger.json index d33d6a6..e923925 100644 --- a/platform/swagger.json +++ b/platform/swagger.json @@ -1191,7 +1191,7 @@ "/workspaces/{workspaceId}/items/{itemId}/getDefinition": { "post": { "summary": "Returns the specified item definition.", - "description": "This API is supported for a number of item types, find the supported item types and information about their definition structure in [Item definition overview](/rest/api/fabric/articles/item-management/definitions/item-definition-overview).\nWhen you get an item's definition, the sensitivity label is not a part of the definition.\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\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## Limitations\n\n This API is blocked for an item with a protected sensitivity label, unless the caller has the usage rights to delete the sensitivity label. \n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | 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 definition overview](/rest/api/fabric/articles/item-management/definitions/item-definition-overview).\nWhen you get an item's definition, the sensitivity label is not a part of the definition.\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\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## Limitations\n\nTo retrieve the definition of an item protected by an encrypted sensitivity label, the caller must have sufficient [usage rights](/fabric/enterprise/powerbi/service-security-sensitivity-label-change-enforcement) to remove the label, as configured in [Microsoft Purview](/purview/purview).\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" ], diff --git a/policySet/swagger.json b/policySet/swagger.json index a7e6644..6806560 100644 --- a/policySet/swagger.json +++ b/policySet/swagger.json @@ -374,7 +374,7 @@ "/workspaces/{workspaceId}/policySets/{policySetId}/getDefinition": { "post": { "summary": "Returns the specified policy set public definition.", - "description": "> [!NOTE]\n> Policy set item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a PolicySet's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\nThe caller must have *read and write* permissions for the policy set.\n\n## Required Delegated Scopes\n\nItem.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "description": "> [!NOTE]\n> Policy set item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a PolicySet's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\nThe caller must have *read and write* permissions for the policy set.\n\n## Required Delegated Scopes\n\nItem.ReadWrite.All\n\n## Limitations\n\nTo retrieve the definition of a policy set item protected by an encrypted sensitivity label, the caller must have sufficient [usage rights](/fabric/enterprise/powerbi/service-security-sensitivity-label-change-enforcement) to remove the label, as configured in [Microsoft Purview](/purview/purview).\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" ], diff --git a/reflex/swagger.json b/reflex/swagger.json index 6685cc7..b114a3e 100644 --- a/reflex/swagger.json +++ b/reflex/swagger.json @@ -384,7 +384,7 @@ "/workspaces/{workspaceId}/reflexes/{reflexId}/getDefinition": { "post": { "summary": "Returns the specified Reflex public definition.", - "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a Reflex's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the reflex. \n\n## Required Delegated Scopes \n\n Reflex.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations\n\n This API is blocked for a Reflex with an encrypted sensitivity label.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a Reflex's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the reflex. \n\n## Required Delegated Scopes \n\n Reflex.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations\n\nTo retrieve the definition of a Reflex item protected by an encrypted sensitivity label, the caller must have sufficient [usage rights](/fabric/enterprise/powerbi/service-security-sensitivity-label-change-enforcement) to remove the label, as configured in [Microsoft Purview](/purview/purview).\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" ], diff --git a/report/swagger.json b/report/swagger.json index 467291c..9e5618e 100644 --- a/report/swagger.json +++ b/report/swagger.json @@ -381,7 +381,7 @@ "/workspaces/{workspaceId}/reports/{reportId}/getDefinition": { "post": { "summary": "Returns the specified report public definition.", - "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a report's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\nThe caller must have *read and write* permissions for the report.\n\n## Required Delegated Scopes \n\n Report.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations\n\n This API is blocked for a report with an encrypted sensitivity label.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a report's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\nThe caller must have *read and write* permissions for the report.\n\n## Required Delegated Scopes \n\n Report.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations\n\nTo retrieve the definition of a report item protected by an encrypted sensitivity label, the caller must have sufficient [usage rights](/fabric/enterprise/powerbi/service-security-sensitivity-label-change-enforcement) to remove the label, as configured in [Microsoft Purview](/purview/purview).\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" ], diff --git a/semanticModel/swagger.json b/semanticModel/swagger.json index c96364f..d43eaa4 100644 --- a/semanticModel/swagger.json +++ b/semanticModel/swagger.json @@ -381,7 +381,7 @@ "/workspaces/{workspaceId}/semanticModels/{semanticModelId}/getDefinition": { "post": { "summary": "Returns the specified semantic model public definition.", - "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a semantic model's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\nThe caller must have *read and write* permissions for the semantic model.\n\n## Required Delegated Scopes\n\n SemanticModel.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations\n\n This API is blocked for a semantic model with an encrypted sensitivity label.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a semantic model's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\nThe caller must have *read and write* permissions for the semantic model.\n\n## Required Delegated Scopes\n\n SemanticModel.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations\n\nTo retrieve the definition of a semantic model item protected by an encrypted sensitivity label, the caller must have sufficient [usage rights](/fabric/enterprise/powerbi/service-security-sensitivity-label-change-enforcement) to remove the label, as configured in [Microsoft Purview](/purview/purview).\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" ], diff --git a/snowflakeDatabase/swagger.json b/snowflakeDatabase/swagger.json index ab0d126..7ecfe44 100644 --- a/snowflakeDatabase/swagger.json +++ b/snowflakeDatabase/swagger.json @@ -387,7 +387,7 @@ "/workspaces/{workspaceId}/snowflakeDatabases/{snowflakeDatabaseId}/getDefinition": { "post": { "summary": "Returns the specified Snowflake Database public definition.", - "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\n The caller must have *read and write* permissions for the snowflake database. \n\n## Required Delegated Scopes \n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\n The caller must have *read and write* permissions for the snowflake database. \n\n## Required Delegated Scopes \n\n Item.ReadWrite.All\n\n## Limitations\n\nTo retrieve the definition of a Snowflake database item protected by an encrypted sensitivity label, the caller must have sufficient [usage rights](/fabric/enterprise/powerbi/service-security-sensitivity-label-change-enforcement) to remove the label, as configured in [Microsoft Purview](/purview/purview).\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" ], diff --git a/sparkjobdefinition/swagger.json b/sparkjobdefinition/swagger.json index b595eed..53adda3 100644 --- a/sparkjobdefinition/swagger.json +++ b/sparkjobdefinition/swagger.json @@ -387,7 +387,7 @@ "/workspaces/{workspaceId}/sparkJobDefinitions/{sparkJobDefinitionId}/getDefinition": { "post": { "summary": "Returns the specified spark job definition public definition.", - "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a spark job definition's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\nThe caller must have *read and write* permissions for the spark job definition.\n\n## Required Delegated Scopes\n\n SparkJobDefinition.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations\n\n This API is blocked for a spark job definition with an encrypted sensitivity label.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface", + "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a spark job definition's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\nThe caller must have *read and write* permissions for the spark job definition.\n\n## Required Delegated Scopes\n\n SparkJobDefinition.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations\n\nTo retrieve the definition of a Spark job definition item protected by an encrypted sensitivity label, the caller must have sufficient [usage rights](/fabric/enterprise/powerbi/service-security-sensitivity-label-change-enforcement) to remove the label, as configured in [Microsoft Purview](/purview/purview).\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" ], diff --git a/sqlDatabase/swagger.json b/sqlDatabase/swagger.json index 1733d94..88c9b39 100644 --- a/sqlDatabase/swagger.json +++ b/sqlDatabase/swagger.json @@ -390,7 +390,7 @@ "/workspaces/{workspaceId}/sqlDatabases/{sqlDatabaseId}/getDefinition": { "post": { "summary": "Returns the specified SQL database public definition.", - "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a SQL database's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the SQL database. \n\n## Required Delegated Scopes\n\n SQLDatabase.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", + "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a SQL database's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the SQL database. \n\n## Required Delegated Scopes\n\n SQLDatabase.ReadWrite.All or Item.ReadWrite.All\n\n## Limitations\n\nTo retrieve the definition of a SQL database item protected by an encrypted sensitivity label, the caller must have sufficient [usage rights](/fabric/enterprise/powerbi/service-security-sensitivity-label-change-enforcement) to remove the label, as configured in [Microsoft Purview](/purview/purview).\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" ], diff --git a/userDataFunction/swagger.json b/userDataFunction/swagger.json index 751dd3a..d6f8d07 100644 --- a/userDataFunction/swagger.json +++ b/userDataFunction/swagger.json @@ -384,7 +384,7 @@ "/workspaces/{workspaceId}/userDataFunctions/{userDataFunctionId}/getDefinition": { "post": { "summary": "Returns the specified UserDataFunction public definition.", - "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a UserDataFunction's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\nThe caller must have *read and write* permissions for the UserDataFunction.\n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface", + "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a UserDataFunction's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\nThe caller must have *read and write* permissions for the UserDataFunction.\n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Limitations\n\nTo retrieve the definition of a user data function item protected by an encrypted sensitivity label, the caller must have sufficient [usage rights](/fabric/enterprise/powerbi/service-security-sensitivity-label-change-enforcement) to remove the label, as configured in [Microsoft Purview](/purview/purview).\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface", "tags": [ "Items" ], diff --git a/variableLibrary/swagger.json b/variableLibrary/swagger.json index 8cf0b86..66ca82b 100644 --- a/variableLibrary/swagger.json +++ b/variableLibrary/swagger.json @@ -384,7 +384,7 @@ "/workspaces/{workspaceId}/variableLibraries/{variableLibraryId}/getDefinition": { "post": { "summary": "Returns the specified variable library public definition.", - "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a VariableLibrary's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\nThe caller must have *read and write* permissions for the variable library.\n\n## Required Delegated Scopes\n\n VariableLibrary.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", + "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a VariableLibrary's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\nThe caller must have *read and write* permissions for the variable library.\n\n## Required Delegated Scopes\n\n VariableLibrary.ReadWrite.All or Item.ReadWrite.All\n\n## Limitations\n\nTo retrieve the definition of a variable library item protected by an encrypted sensitivity label, the caller must have sufficient [usage rights](/fabric/enterprise/powerbi/service-security-sensitivity-label-change-enforcement) to remove the label, as configured in [Microsoft Purview](/purview/purview).\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" ],