Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Databricks Provider
  3. API Docs
  4. getPipelines
Databricks v1.63.0 published on Thursday, Mar 13, 2025 by Pulumi
pulumi/pulumi-databricks

databricks.getPipelines

Explore with Pulumi AI

databricks logo
Databricks v1.63.0 published on Thursday, Mar 13, 2025 by Pulumi
pulumi/pulumi-databricks

    Note If you have a fully automated setup with workspaces created by databricks.MwsWorkspaces or azurerm_databricks_workspace, please make sure to add depends_on attribute in order to prevent authentication is not configured for provider errors.

    Retrieves a list of all databricks.Pipeline (Delta Live Tables) ids deployed in a workspace, or those matching the provided search term. Maximum 100 results.

    Example Usage

    Get all Delta Live Tables pipelines:

    import * as pulumi from "@pulumi/pulumi";
import * as databricks from "@pulumi/databricks";

const all = databricks.getPipelines({});
export const allPipelines = all.then(all => all.ids);

    import pulumi
import pulumi_databricks as databricks

all = databricks.get_pipelines()
pulumi.export("allPipelines", all.ids)

    package main

import (
	"github.com/pulumi/pulumi-databricks/sdk/go/databricks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		all, err := databricks.GetPipelines(ctx, &databricks.GetPipelinesArgs{}, nil)
		if err != nil {
			return err
		}
		ctx.Export("allPipelines", all.Ids)
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Databricks = Pulumi.Databricks;

return await Deployment.RunAsync(() => 
{
    var all = Databricks.GetPipelines.Invoke();

    return new Dictionary<string, object?>
    {
        ["allPipelines"] = all.Apply(getPipelinesResult => getPipelinesResult.Ids),
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.DatabricksFunctions;
import com.pulumi.databricks.inputs.GetPipelinesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var all = DatabricksFunctions.getPipelines();

        ctx.export("allPipelines", all.applyValue(getPipelinesResult -> getPipelinesResult.ids()));
    }
}

    variables:
  all:
    fn::invoke:
      function: databricks:getPipelines
      arguments: {}
outputs:
  allPipelines: ${all.ids}

    Filter Delta Live Tables pipelines by name (exact match):

    import * as pulumi from "@pulumi/pulumi";
import * as databricks from "@pulumi/databricks";

const _this = databricks.getPipelines({
    pipelineName: "my_pipeline",
});
export const myPipeline = _this.then(_this => _this.ids);

    import pulumi
import pulumi_databricks as databricks

this = databricks.get_pipelines(pipeline_name="my_pipeline")
pulumi.export("myPipeline", this.ids)

    package main

import (
	"github.com/pulumi/pulumi-databricks/sdk/go/databricks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		this, err := databricks.GetPipelines(ctx, &databricks.GetPipelinesArgs{
			PipelineName: pulumi.StringRef("my_pipeline"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("myPipeline", this.Ids)
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Databricks = Pulumi.Databricks;

return await Deployment.RunAsync(() => 
{
    var @this = Databricks.GetPipelines.Invoke(new()
    {
        PipelineName = "my_pipeline",
    });

    return new Dictionary<string, object?>
    {
        ["myPipeline"] = @this.Apply(@this => @this.Apply(getPipelinesResult => getPipelinesResult.Ids)),
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.DatabricksFunctions;
import com.pulumi.databricks.inputs.GetPipelinesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var this = DatabricksFunctions.getPipelines(GetPipelinesArgs.builder()
            .pipelineName("my_pipeline")
            .build());

        ctx.export("myPipeline", this_.ids());
    }
}

    variables:
  this:
    fn::invoke:
      function: databricks:getPipelines
      arguments:
        pipelineName: my_pipeline
outputs:
  myPipeline: ${this.ids}

    Filter Delta Live Tables pipelines by name (wildcard search):

    import * as pulumi from "@pulumi/pulumi";
import * as databricks from "@pulumi/databricks";

const _this = databricks.getPipelines({
    pipelineName: "%pipeline%",
});
export const wildcardPipelines = _this.then(_this => _this.ids);

    import pulumi
import pulumi_databricks as databricks

this = databricks.get_pipelines(pipeline_name="%pipeline%")
pulumi.export("wildcardPipelines", this.ids)

    package main

import (
	"github.com/pulumi/pulumi-databricks/sdk/go/databricks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		this, err := databricks.GetPipelines(ctx, &databricks.GetPipelinesArgs{
			PipelineName: pulumi.StringRef("%pipeline%"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("wildcardPipelines", this.Ids)
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Databricks = Pulumi.Databricks;

return await Deployment.RunAsync(() => 
{
    var @this = Databricks.GetPipelines.Invoke(new()
    {
        PipelineName = "%pipeline%",
    });

    return new Dictionary<string, object?>
    {
        ["wildcardPipelines"] = @this.Apply(@this => @this.Apply(getPipelinesResult => getPipelinesResult.Ids)),
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.DatabricksFunctions;
import com.pulumi.databricks.inputs.GetPipelinesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var this = DatabricksFunctions.getPipelines(GetPipelinesArgs.builder()
            .pipelineName("%pipeline%")
            .build());

        ctx.export("wildcardPipelines", this_.ids());
    }
}

    variables:
  this:
    fn::invoke:
      function: databricks:getPipelines
      arguments:
        pipelineName: '%pipeline%'
outputs:
  wildcardPipelines: ${this.ids}

    The following resources are used in the same context:

    Using getPipelines

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getPipelines(args: GetPipelinesArgs, opts?: InvokeOptions): Promise<GetPipelinesResult>
function getPipelinesOutput(args: GetPipelinesOutputArgs, opts?: InvokeOptions): Output<GetPipelinesResult>
    def get_pipelines(ids: Optional[Sequence[str]] = None,
                  pipeline_name: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetPipelinesResult
def get_pipelines_output(ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                  pipeline_name: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetPipelinesResult]
    func GetPipelines(ctx *Context, args *GetPipelinesArgs, opts ...InvokeOption) (*GetPipelinesResult, error)
func GetPipelinesOutput(ctx *Context, args *GetPipelinesOutputArgs, opts ...InvokeOption) GetPipelinesResultOutput

    > Note: This function is named GetPipelines in the Go SDK.

    public static class GetPipelines 
{
    public static Task<GetPipelinesResult> InvokeAsync(GetPipelinesArgs args, InvokeOptions? opts = null)
    public static Output<GetPipelinesResult> Invoke(GetPipelinesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPipelinesResult> getPipelines(GetPipelinesArgs args, InvokeOptions options)
public static Output<GetPipelinesResult> getPipelines(GetPipelinesArgs args, InvokeOptions options)

    fn::invoke:
  function: databricks:index/getPipelines:getPipelines
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Ids List<string>
    List of ids for Delta Live Tables pipelines matching the provided search criteria.
    PipelineName string
    Filter Delta Live Tables pipelines by name for a given search term. % is the supported wildcard operator.
    Ids []string
    List of ids for Delta Live Tables pipelines matching the provided search criteria.
    PipelineName string
    Filter Delta Live Tables pipelines by name for a given search term. % is the supported wildcard operator.
    ids List<String>
    List of ids for Delta Live Tables pipelines matching the provided search criteria.
    pipelineName String
    Filter Delta Live Tables pipelines by name for a given search term. % is the supported wildcard operator.
    ids string[]
    List of ids for Delta Live Tables pipelines matching the provided search criteria.
    pipelineName string
    Filter Delta Live Tables pipelines by name for a given search term. % is the supported wildcard operator.
    ids Sequence[str]
    List of ids for Delta Live Tables pipelines matching the provided search criteria.
    pipeline_name str
    Filter Delta Live Tables pipelines by name for a given search term. % is the supported wildcard operator.
    ids List<String>
    List of ids for Delta Live Tables pipelines matching the provided search criteria.
    pipelineName String
    Filter Delta Live Tables pipelines by name for a given search term. % is the supported wildcard operator.

    getPipelines Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Ids List<string>
    List of ids for Delta Live Tables pipelines matching the provided search criteria.
    PipelineName string
    Id string
    The provider-assigned unique ID for this managed resource.
    Ids []string
    List of ids for Delta Live Tables pipelines matching the provided search criteria.
    PipelineName string
    id String
    The provider-assigned unique ID for this managed resource.
    ids List<String>
    List of ids for Delta Live Tables pipelines matching the provided search criteria.
    pipelineName String
    id string
    The provider-assigned unique ID for this managed resource.
    ids string[]
    List of ids for Delta Live Tables pipelines matching the provided search criteria.
    pipelineName string
    id str
    The provider-assigned unique ID for this managed resource.
    ids Sequence[str]
    List of ids for Delta Live Tables pipelines matching the provided search criteria.
    pipeline_name str
    id String
    The provider-assigned unique ID for this managed resource.
    ids List<String>
    List of ids for Delta Live Tables pipelines matching the provided search criteria.
    pipelineName String

    Package Details

    Repository
    databricks pulumi/pulumi-databricks
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the databricks Terraform Provider.
    databricks logo
    Databricks v1.63.0 published on Thursday, Mar 13, 2025 by Pulumi
    pulumi/pulumi-databricks