> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getcollate.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Microsoft Fabric Pipeline Connector | Collate Pipeline Guide

> Connect Microsoft Fabric Data Factory pipelines to Collate with our comprehensive pipeline connector guide. Step-by-step setup, configuration, and metadata extraction for seamless integration.

export const MetadataIngestionUi = ({connector, selectServicePath, addNewServicePath, serviceConnectionPath}) => {
  return <>
   <p>
      To ingest metadata from your sources, you need to create a service connection.
      The service connects your source system with Collate. Once you create
      a service, you can use it to configure your ingestion workflows.<br />
      <br />
      To create a service connection and ingest your metadata, follow the steps below:
  </p>
  <Steps>
    <Step title="Select the Service">
    <ol>
          <li>
            On the left navigation bar, click <strong>Settings</strong>.
          </li>
          <li>
            On the next page, click <strong>Services</strong>, and then select the service.
            <img src="/public/images/connectors/visit-services-page.png" alt="Visit Services Page" />
          </li>
    </ol>
   </Step>


   <Step title="Create a New Service">

       To add a new service connection, click <strong>Add New Service</strong>.
      <img src="/public/images/connectors/create-new-service.png" alt="Create a new Service" />


   </Step>


     <Step title="Select the Connector">
       Select <strong>{connector}</strong> as the service type and click <strong>Next</strong>.


       {selectServicePath && <img src={selectServicePath} alt="Select Service" />}
   </Step>


   <Step title="Name and Describe your Service">
       Enter a unique, descriptive <strong>Service Name</strong> and <strong>Description</strong>.
       <ul>
         <li><strong>Service Name</strong>: Collate identifies services by their service name. Enter a name that distinguishes this deployment from other services, including other {connector} services you are ingesting metadata from.</li>
       </ul>


       <Note>
           The service name cannot be changed after it is set.
       </Note>


       {addNewServicePath && <img src={addNewServicePath} alt="Add New Service" />}
   </Step>


   <Step title="Configure the Service Connection">
       Set up the connection settings required for {connector}. <br /><br />

       Configure the following connection options to set up the service and start ingesting metadata from your sources. The right-hand panel displays help documentation for the selected connection type in the product UI

       {serviceConnectionPath && <img src={serviceConnectionPath} alt="Configure Service connection" />}
   </Step>
   </Steps>
   </>;
};

export const ConnectorDetailsHeader = ({name, icon, stage, availableFeatures, unavailableFeatures = [], availableFeaturesCollate = []}) => {
  const showSubHeading = availableFeatures?.length > 0 || unavailableFeatures?.length > 0 || availableFeaturesCollate?.length > 0;
  const totalAvailableFeatures = [...availableFeatures || [], ...availableFeaturesCollate || []];
  return <div className="container">
      <div className="Heading">
        <div className="flex items-center gap-3">
          {icon && <div className="IconContainer">
              <img src={icon} alt={name} noZoom className="ConnectorIcon" />
            </div>}
          <h1 className="ConnectorName">{name}</h1>
          <span className={`StageBadge ${stage === 'PROD' ? 'prod' : 'beta'}`}>
            {stage}
          </span>
        </div>
      </div>
      {showSubHeading && <div className="SubHeading">
          <div className="FeaturesHeading">Feature List</div>
          <div className="FeaturesList">
            {totalAvailableFeatures.map(feature => <div className="FeatureTag AvailableFeature" key={feature}>
                ✓ {feature}
              </div>)}
            {unavailableFeatures.map(feature => <div className="FeatureTag UnavailableFeature" key={feature}>
                ✕ {feature}
              </div>)}
          </div>
        </div>}
    </div>;
};

<ConnectorDetailsHeader icon="/public/images/connectors/microsoftfabric.webp" name="Microsoft Fabric Pipeline" stage="BETA" collateOnly={true} availableFeatures={["Metadata", "Pipeline Status"]} unavailableFeatures={["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:

* [Requirements](#requirements)
* [Metadata Ingestion](#metadata-ingestion)
* [Troubleshooting](/connectors/pipeline/microsoftfabricpipeline/troubleshooting)

<Note>
  This connector is available exclusively in **Collate** and is not part of the open-source OpenMetadata distribution.
</Note>

## Requirements

### Metadata

To extract pipeline metadata from Microsoft Fabric, you need to authenticate using an **Azure Service Principal**. The Service Principal must have the following:

* A registered Azure AD application with `clientId`, `clientSecret`, and `tenantId`
* The Service Principal must be added as a **Member** of the Microsoft Fabric workspace containing the Data Pipelines
* In the **Microsoft Fabric Admin Portal**, the setting **"Service Principals can use Fabric APIs"** must be enabled

The connector uses the Microsoft Fabric REST API to:

* List all Data Pipelines in the specified workspace
* Retrieve pipeline activity (task) definitions
* Fetch pipeline run history with activity-level execution status

### Azure Service Principal Setup

1. Register an application in [Azure Active Directory](https://portal.azure.com/#blade/Microsoft_AAD_RegisteredApps/ApplicationsListBlade)
2. Create a client secret under **Certificates & secrets**
3. Note the **Application (client) ID**, **Directory (tenant) ID**, and the **client secret value**
4. In the Microsoft Fabric Admin Portal, enable **"Service Principals can use Fabric APIs"** under **Developer settings**
5. In your Fabric workspace, add the Service Principal as a **Member** or **Admin**
6. Note the **Workspace ID** from the workspace URL: `https://app.fabric.microsoft.com/groups/<workspace-id>/...`

You can find more details in the [Microsoft Fabric documentation](https://learn.microsoft.com/en-us/fabric/admin/metadata-scanning-enable-read-only-apis).

## Metadata Ingestion

<MetadataIngestionUi connector={"MicrosoftFabricPipeline"} selectServicePath={"/public/images/connectors/microsoftfabricpipeline/select-service.png"} addNewServicePath={"/public/images/connectors/microsoftfabricpipeline/add-new-service.png"} serviceConnectionPath={"/public/images/connectors/microsoftfabricpipeline/service-connection.png"} />

## Connection Options

<Steps>
  <Step title="Connection Options">
    * **Workspace ID**: The Microsoft Fabric workspace ID where the pipelines are located. Found in the workspace URL: `https://app.fabric.microsoft.com/groups/<workspace-id>/...`.
    * **Client ID**: Azure Application (client) ID for Service Principal authentication.
    * **Client Secret**: Azure Application client secret for Service Principal authentication.
    * **Tenant ID**: Azure Directory (tenant) ID for Service Principal authentication.
    * **Authority URI** *(Optional)*: Azure Active Directory authority URI. Defaults to `https://login.microsoftonline.com/`.
    * **Pipeline Filter Pattern** *(Optional)*: Regex to only include/exclude pipelines that match the pattern.
  </Step>

  <Step title="Test the Connection">
    Once the credentials have been added, click on *Test Connection* and *Save* the changes.

    <img src="https://mintcdn.com/collatedocs/L7psA65ao88vmcRI/public/images/connectors/test-connection.png?fit=max&auto=format&n=L7psA65ao88vmcRI&q=85&s=2133f0d65f18df1e57f69d2cc3bdeff4" alt="Test Connection" width="1494" height="310" data-path="public/images/connectors/test-connection.png" />
  </Step>

  <Step title="Configure Metadata Ingestion">
    In this step we will configure the metadata ingestion pipeline,
    Please follow the instructions below

    <img src="https://mintcdn.com/collatedocs/12mtkhFtvTP7FUxZ/public/images/connectors/configure-metadata-ingestion-pipeline.png?fit=max&auto=format&n=12mtkhFtvTP7FUxZ&q=85&s=b310e691eaec850bc9eda3ed0b8a340f" alt="Configure Metadata Ingestion" width="1508" height="1614" data-path="public/images/connectors/configure-metadata-ingestion-pipeline.png" />

    #### Metadata Ingestion Options

    * **Name**: This field refers to the name of ingestion pipeline, you can customize the name or use the generated name.
    * **Pipeline Filter Pattern (Optional)**: Use to pipeline filter patterns to control whether or not to include pipeline as part of metadata ingestion.
      * **Include**: Explicitly include pipeline by adding a list of comma-separated regular expressions to the Include field. OpenMetadata will include all pipeline with names matching one or more of the supplied regular expressions. All other schemas will be excluded.
      * **Exclude**: Explicitly exclude pipeline by adding a list of comma-separated regular expressions to the Exclude field. OpenMetadata will exclude all pipeline with names matching one or more of the supplied regular expressions. All other schemas will be included.
    * **Include lineage (toggle)**: Set the Include lineage toggle to control whether to include lineage between pipelines and data sources as part of metadata ingestion.
    * **Enable Debug Log (toggle)**: Set the Enable Debug Log toggle to set the default log level to debug.
    * **Mark Deleted Pipelines (toggle)**: Set the Mark Deleted Pipelines toggle to flag pipelines as soft-deleted if they are not present anymore in the source system.
  </Step>

  <Step title="Schedule the Ingestion and Deploy">
    Scheduling can be set up at an hourly, daily, weekly, or manual cadence. The
    timezone is in UTC. Select a Start Date to schedule for ingestion. It is
    optional to add an End Date.

    Review your configuration settings. If they match what you intended,
    click Deploy to create the service and schedule metadata ingestion.

    If something doesn't look right, click the Back button to return to the
    appropriate step and change the settings as needed.

    After configuring the workflow, you can click on Deploy to create the
    pipeline.

    <img src="https://mintcdn.com/collatedocs/piJyXg9wW6Ik1lg-/public/images/connectors/schedule.png?fit=max&auto=format&n=piJyXg9wW6Ik1lg-&q=85&s=f1add591824b44456f0e2ff259a21c6f" alt="Schedule the Workflow" width="2733" height="1083" data-path="public/images/connectors/schedule.png" />
  </Step>

  <Step title="View the Ingestion Pipeline">
    Once the workflow has been successfully deployed, you can view the
    Ingestion Pipeline running from the Service Page.

    <img src="https://mintcdn.com/collatedocs/cOe_QuHYxAbkMtTI/public/images/connectors/view-ingestion-pipeline.png?fit=max&auto=format&n=cOe_QuHYxAbkMtTI&q=85&s=8c754af74f99ee70e714f6f707b827e4" alt="View Ingestion Pipeline" width="2733" height="1271" data-path="public/images/connectors/view-ingestion-pipeline.png" />

    <Tip>
      If [AutoPilot](/how-to-guides/admin-guide/applications/autopilot) is enabled, workflows like usage tracking, data lineage, and similar tasks will be handled automatically. Users don’t need to set up or manage them - AutoPilot takes care of everything in the system.
    </Tip>
  </Step>
</Steps>

## Troubleshooting

<Columns cols={2}>
  <Card title="Microsoft Fabric Pipeline Troubleshooting" href="/connectors/pipeline/microsoftfabricpipeline/troubleshooting">
    Learn more about how to troubleshoot common Microsoft Fabric Pipeline connector issues and resolve configuration or ingestion errors.
  </Card>
</Columns>

## Related

<Columns cols={2}>
  <Card title="Metadata Ingestion" href="/how-to-guides/guide-for-data-users/ingestion/workflows/metadata">
    Learn more about how to configure metadata ingestion workflows from the UI.
  </Card>

  <Card title="Ingestion Best Practices" href="/how-to-guides/guide-for-data-users/ingestion/best-practices">
    Learn more about recommended ingestion setup and operations.
  </Card>
</Columns>
