Skip to main content
Microsoft Fabric Pipeline

Microsoft Fabric Pipeline

BETA
Feature List
Metadata
Pipeline Status
Lineage
Owners
Tags
In this section, we provide guides and references to use the Microsoft Fabric Pipeline connector. Configure and schedule Microsoft Fabric pipeline metadata workflows from the Collate UI:

How to Run the Connector Externally

To run the Ingestion via the UI you’ll need to use the OpenMetadata Ingestion Container, which comes shipped with custom Airflow plugins to handle the workflow deployment. If, instead, you want to manage your workflows externally on your preferred orchestrator, you can check the following docs to run the Ingestion Framework anywhere.

Requirements

Python Requirements

We have support for Python versions 3.9-3.11
To run the Microsoft Fabric Pipeline ingestion, you will need to install:
pip3 install "collate-ingestion[microsoftfabricpipeline]"

Metadata Ingestion

All connectors are defined as JSON Schemas. Here you can find the structure to create a connection to Microsoft Fabric Pipeline. In order to create and run a Metadata Ingestion workflow, we will follow the steps to create a YAML configuration able to connect to the source, process the Entities if needed, and reach the Collate server. The workflow is modeled around the following JSON Schema

1. Define the YAML Config

This is a sample config for Microsoft Fabric Pipeline:

Configuration Examples

Basic Configuration

source:
  type: microsoftfabricpipeline
  serviceName: fabric_pipelines_prod
  serviceConnection:
    config:
      type: MicrosoftFabricPipeline
      workspaceId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
      clientId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
      clientSecret: your_client_secret_value
      tenantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Configuration with Pipeline Filtering

source:
  type: microsoftfabricpipeline
  serviceName: fabric_pipelines_prod
  serviceConnection:
    config:
      type: MicrosoftFabricPipeline
      workspaceId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
      clientId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
      clientSecret: your_client_secret_value
      tenantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
      pipelineFilterPattern:
        includes:
          - etl_.*
          - ingest_.*
          - transform_.*
        excludes:
          - test_.*
          - dev_.*

Configuration with Custom Authority URI

source:
  type: microsoftfabricpipeline
  serviceName: fabric_pipelines_gov
  serviceConnection:
    config:
      type: MicrosoftFabricPipeline
      workspaceId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
      clientId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
      clientSecret: your_client_secret_value
      tenantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
      authorityUri: https://login.microsoftonline.us/

2. Run with the CLI

First, we will need to save the YAML file. Afterward, and with all requirements installed, we can run:
metadata ingest -c <path-to-yaml>
Note that from connector to connector, this recipe will always be the same. By updating the YAML configuration, you will be able to extract metadata from different sources.