Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Harness Provider
  3. API Docs
  4. platform
  5. getPipelineList
Harness v0.7.3 published on Friday, Apr 18, 2025 by Pulumi
pulumi/pulumi-harness

harness.platform.getPipelineList

Explore with Pulumi AI

Harness v0.7.3 published on Friday, Apr 18, 2025 by Pulumi
pulumi/pulumi-harness

Data source for retrieving a Harness pipeline list.

Example Usage

Without the Pagination

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

const example = harness.platform.getPipelineList({
    orgId: "org_id",
    projectId: "project_id",
});
Copy
import pulumi
import pulumi_harness as harness

example = harness.platform.get_pipeline_list(org_id="org_id",
    project_id="project_id")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := platform.GetPipelineList(ctx, &platform.GetPipelineListArgs{
			OrgId:     "org_id",
			ProjectId: "project_id",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Harness = Pulumi.Harness;

return await Deployment.RunAsync(() => 
{
    var example = Harness.Platform.GetPipelineList.Invoke(new()
    {
        OrgId = "org_id",
        ProjectId = "project_id",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.harness.platform.PlatformFunctions;
import com.pulumi.harness.platform.inputs.GetPipelineListArgs;
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 example = PlatformFunctions.getPipelineList(GetPipelineListArgs.builder()
            .orgId("org_id")
            .projectId("project_id")
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: harness:platform:getPipelineList
      arguments:
        orgId: org_id
        projectId: project_id
Copy

With Pagination Logic

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

const example = harness.platform.getPipelineList({
    orgId: "org_id",
    projectId: "project_id",
    page: 1,
    limit: 4,
});
Copy
import pulumi
import pulumi_harness as harness

example = harness.platform.get_pipeline_list(org_id="org_id",
    project_id="project_id",
    page=1,
    limit=4)
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := platform.GetPipelineList(ctx, &platform.GetPipelineListArgs{
			OrgId:     "org_id",
			ProjectId: "project_id",
			Page:      pulumi.IntRef(1),
			Limit:     pulumi.IntRef(4),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Harness = Pulumi.Harness;

return await Deployment.RunAsync(() => 
{
    var example = Harness.Platform.GetPipelineList.Invoke(new()
    {
        OrgId = "org_id",
        ProjectId = "project_id",
        Page = 1,
        Limit = 4,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.harness.platform.PlatformFunctions;
import com.pulumi.harness.platform.inputs.GetPipelineListArgs;
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 example = PlatformFunctions.getPipelineList(GetPipelineListArgs.builder()
            .orgId("org_id")
            .projectId("project_id")
            .page(1)
            .limit(4)
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: harness:platform:getPipelineList
      arguments:
        orgId: org_id
        projectId: project_id
        page: 1
        limit: 4
Copy

Using getPipelineList

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 getPipelineList(args: GetPipelineListArgs, opts?: InvokeOptions): Promise<GetPipelineListResult>
function getPipelineListOutput(args: GetPipelineListOutputArgs, opts?: InvokeOptions): Output<GetPipelineListResult>
Copy
def get_pipeline_list(identifier: Optional[str] = None,
                      limit: Optional[int] = None,
                      name: Optional[str] = None,
                      org_id: Optional[str] = None,
                      page: Optional[int] = None,
                      project_id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetPipelineListResult
def get_pipeline_list_output(identifier: Optional[pulumi.Input[str]] = None,
                      limit: Optional[pulumi.Input[int]] = None,
                      name: Optional[pulumi.Input[str]] = None,
                      org_id: Optional[pulumi.Input[str]] = None,
                      page: Optional[pulumi.Input[int]] = None,
                      project_id: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetPipelineListResult]
Copy
func GetPipelineList(ctx *Context, args *GetPipelineListArgs, opts ...InvokeOption) (*GetPipelineListResult, error)
func GetPipelineListOutput(ctx *Context, args *GetPipelineListOutputArgs, opts ...InvokeOption) GetPipelineListResultOutput
Copy

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

public static class GetPipelineList 
{
    public static Task<GetPipelineListResult> InvokeAsync(GetPipelineListArgs args, InvokeOptions? opts = null)
    public static Output<GetPipelineListResult> Invoke(GetPipelineListInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetPipelineListResult> getPipelineList(GetPipelineListArgs args, InvokeOptions options)
public static Output<GetPipelineListResult> getPipelineList(GetPipelineListArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: harness:platform/getPipelineList:getPipelineList
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

OrgId
This property is required.
Changes to this property will trigger replacement.
string
Unique identifier of the organization.
ProjectId
This property is required.
Changes to this property will trigger replacement.
string
Unique identifier of the project.
Identifier string
Limit int
Optional pagination parameter indicating the maximum number of entities to retrieve per page.
Name string
Page int
Optional pagination parameter indicating the page number when retrieving entities.
OrgId
This property is required.
Changes to this property will trigger replacement.
string
Unique identifier of the organization.
ProjectId
This property is required.
Changes to this property will trigger replacement.
string
Unique identifier of the project.
Identifier string
Limit int
Optional pagination parameter indicating the maximum number of entities to retrieve per page.
Name string
Page int
Optional pagination parameter indicating the page number when retrieving entities.
orgId
This property is required.
Changes to this property will trigger replacement.
String
Unique identifier of the organization.
projectId
This property is required.
Changes to this property will trigger replacement.
String
Unique identifier of the project.
identifier String
limit Integer
Optional pagination parameter indicating the maximum number of entities to retrieve per page.
name String
page Integer
Optional pagination parameter indicating the page number when retrieving entities.
orgId
This property is required.
Changes to this property will trigger replacement.
string
Unique identifier of the organization.
projectId
This property is required.
Changes to this property will trigger replacement.
string
Unique identifier of the project.
identifier string
limit number
Optional pagination parameter indicating the maximum number of entities to retrieve per page.
name string
page number
Optional pagination parameter indicating the page number when retrieving entities.
org_id
This property is required.
Changes to this property will trigger replacement.
str
Unique identifier of the organization.
project_id
This property is required.
Changes to this property will trigger replacement.
str
Unique identifier of the project.
identifier str
limit int
Optional pagination parameter indicating the maximum number of entities to retrieve per page.
name str
page int
Optional pagination parameter indicating the page number when retrieving entities.
orgId
This property is required.
Changes to this property will trigger replacement.
String
Unique identifier of the organization.
projectId
This property is required.
Changes to this property will trigger replacement.
String
Unique identifier of the project.
identifier String
limit Number
Optional pagination parameter indicating the maximum number of entities to retrieve per page.
name String
page Number
Optional pagination parameter indicating the page number when retrieving entities.

getPipelineList Result

The following output properties are available:

Description string
Id string
The provider-assigned unique ID for this managed resource.
OrgId string
Unique identifier of the organization.
Pipelines List<GetPipelineListPipeline>
Containing list of all pipeline with details identifier and name.
ProjectId string
Unique identifier of the project.
Tags List<string>
Identifier string
Limit int
Optional pagination parameter indicating the maximum number of entities to retrieve per page.
Name string
Page int
Optional pagination parameter indicating the page number when retrieving entities.
Description string
Id string
The provider-assigned unique ID for this managed resource.
OrgId string
Unique identifier of the organization.
Pipelines []GetPipelineListPipeline
Containing list of all pipeline with details identifier and name.
ProjectId string
Unique identifier of the project.
Tags []string
Identifier string
Limit int
Optional pagination parameter indicating the maximum number of entities to retrieve per page.
Name string
Page int
Optional pagination parameter indicating the page number when retrieving entities.
description String
id String
The provider-assigned unique ID for this managed resource.
orgId String
Unique identifier of the organization.
pipelines List<GetPipelineListPipeline>
Containing list of all pipeline with details identifier and name.
projectId String
Unique identifier of the project.
tags List<String>
identifier String
limit Integer
Optional pagination parameter indicating the maximum number of entities to retrieve per page.
name String
page Integer
Optional pagination parameter indicating the page number when retrieving entities.
description string
id string
The provider-assigned unique ID for this managed resource.
orgId string
Unique identifier of the organization.
pipelines GetPipelineListPipeline[]
Containing list of all pipeline with details identifier and name.
projectId string
Unique identifier of the project.
tags string[]
identifier string
limit number
Optional pagination parameter indicating the maximum number of entities to retrieve per page.
name string
page number
Optional pagination parameter indicating the page number when retrieving entities.
description str
id str
The provider-assigned unique ID for this managed resource.
org_id str
Unique identifier of the organization.
pipelines Sequence[GetPipelineListPipeline]
Containing list of all pipeline with details identifier and name.
project_id str
Unique identifier of the project.
tags Sequence[str]
identifier str
limit int
Optional pagination parameter indicating the maximum number of entities to retrieve per page.
name str
page int
Optional pagination parameter indicating the page number when retrieving entities.
description String
id String
The provider-assigned unique ID for this managed resource.
orgId String
Unique identifier of the organization.
pipelines List<Property Map>
Containing list of all pipeline with details identifier and name.
projectId String
Unique identifier of the project.
tags List<String>
identifier String
limit Number
Optional pagination parameter indicating the maximum number of entities to retrieve per page.
name String
page Number
Optional pagination parameter indicating the page number when retrieving entities.

Supporting Types

GetPipelineListPipeline

Identifier This property is required. string
Name This property is required. string
Identifier This property is required. string
Name This property is required. string
identifier This property is required. String
name This property is required. String
identifier This property is required. string
name This property is required. string
identifier This property is required. str
name This property is required. str
identifier This property is required. String
name This property is required. String

Package Details

Repository
harness pulumi/pulumi-harness
License
Apache-2.0
Notes
This Pulumi package is based on the harness Terraform Provider.
Harness v0.7.3 published on Friday, Apr 18, 2025 by Pulumi
pulumi/pulumi-harness