Harness v0.5.7, Mar 8 25

Harness v0.5.7 published on Saturday, Mar 8, 2025 by Pulumi

harness.platform.getPipeline

Explore with Pulumi AI

Harness v0.5.7 published on Saturday, Mar 8, 2025 by Pulumi

Example Usage

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

const example = harness.platform.getPipeline({
    identifier: "identifier",
    orgId: "org_id",
    projectId: "project_id",
});

import pulumi
import pulumi_harness as harness

example = harness.platform.get_pipeline(identifier="identifier",
    org_id="org_id",
    project_id="project_id")

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.LookupPipeline(ctx, &platform.LookupPipelineArgs{
			Identifier: pulumi.StringRef("identifier"),
			OrgId:      "org_id",
			ProjectId:  "project_id",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

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

});

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.GetPipelineArgs;
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.getPipeline(GetPipelineArgs.builder()
            .identifier("identifier")
            .orgId("org_id")
            .projectId("project_id")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: harness:platform:getPipeline
      arguments:
        identifier: identifier
        orgId: org_id
        projectId: project_id

Using getPipeline

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 getPipeline(args: GetPipelineArgs, opts?: InvokeOptions): Promise<GetPipelineResult>
function getPipelineOutput(args: GetPipelineOutputArgs, opts?: InvokeOptions): Output<GetPipelineResult>

def get_pipeline(git_details: Optional[GetPipelineGitDetails] = None,
                 identifier: Optional[str] = None,
                 name: Optional[str] = None,
                 org_id: Optional[str] = None,
                 project_id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetPipelineResult
def get_pipeline_output(git_details: Optional[pulumi.Input[GetPipelineGitDetailsArgs]] = None,
                 identifier: Optional[pulumi.Input[str]] = None,
                 name: Optional[pulumi.Input[str]] = None,
                 org_id: Optional[pulumi.Input[str]] = None,
                 project_id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetPipelineResult]

func LookupPipeline(ctx *Context, args *LookupPipelineArgs, opts ...InvokeOption) (*LookupPipelineResult, error)
func LookupPipelineOutput(ctx *Context, args *LookupPipelineOutputArgs, opts ...InvokeOption) LookupPipelineResultOutput

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

public static class GetPipeline 
{
    public static Task<GetPipelineResult> InvokeAsync(GetPipelineArgs args, InvokeOptions? opts = null)
    public static Output<GetPipelineResult> Invoke(GetPipelineInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPipelineResult> getPipeline(GetPipelineArgs args, InvokeOptions options)
public static Output<GetPipelineResult> getPipeline(GetPipelineArgs args, InvokeOptions options)

fn::invoke:
  function: harness:platform/getPipeline:getPipeline
  arguments:
    # arguments dictionary

The following arguments are supported:

OrgId string: Unique identifier of the organization.
ProjectId string: Unique identifier of the project.
GitDetails GetPipelineGitDetails: Contains parameters related to creating an Entity for Git Experience.
Identifier string: Unique identifier of the resource.
Name string: Name of the resource.

OrgId string: Unique identifier of the organization.
ProjectId string: Unique identifier of the project.
GitDetails GetPipelineGitDetails: Contains parameters related to creating an Entity for Git Experience.
Identifier string: Unique identifier of the resource.
Name string: Name of the resource.

orgId String: Unique identifier of the organization.
projectId String: Unique identifier of the project.
gitDetails GetPipelineGitDetails: Contains parameters related to creating an Entity for Git Experience.
identifier String: Unique identifier of the resource.
name String: Name of the resource.

orgId string: Unique identifier of the organization.
projectId string: Unique identifier of the project.
gitDetails GetPipelineGitDetails: Contains parameters related to creating an Entity for Git Experience.
identifier string: Unique identifier of the resource.
name string: Name of the resource.

org_id str: Unique identifier of the organization.
project_id str: Unique identifier of the project.
git_details GetPipelineGitDetails: Contains parameters related to creating an Entity for Git Experience.
identifier str: Unique identifier of the resource.
name str: Name of the resource.

orgId String: Unique identifier of the organization.
projectId String: Unique identifier of the project.
gitDetails Property Map: Contains parameters related to creating an Entity for Git Experience.
identifier String: Unique identifier of the resource.
name String: Name of the resource.

getPipeline Result

The following output properties are available:

Description string: Description of the resource.
Id string: The provider-assigned unique ID for this managed resource.
OrgId string: Unique identifier of the organization.
ProjectId string: Unique identifier of the project.
Tags List<string>: Tags to associate with the resource.
TemplateApplied bool: If true, returns Pipeline YAML with Templates applied on it.
TemplateAppliedPipelineYaml string: Pipeline YAML after resolving Templates (returned as a String).
Yaml string: YAML of the pipeline.
GitDetails GetPipelineGitDetails: Contains parameters related to creating an Entity for Git Experience.
Identifier string: Unique identifier of the resource.
Name string: Name of the resource.

Description string: Description of the resource.
Id string: The provider-assigned unique ID for this managed resource.
OrgId string: Unique identifier of the organization.
ProjectId string: Unique identifier of the project.
Tags []string: Tags to associate with the resource.
TemplateApplied bool: If true, returns Pipeline YAML with Templates applied on it.
TemplateAppliedPipelineYaml string: Pipeline YAML after resolving Templates (returned as a String).
Yaml string: YAML of the pipeline.
GitDetails GetPipelineGitDetails: Contains parameters related to creating an Entity for Git Experience.
Identifier string: Unique identifier of the resource.
Name string: Name of the resource.

description String: Description of the resource.
id String: The provider-assigned unique ID for this managed resource.
orgId String: Unique identifier of the organization.
projectId String: Unique identifier of the project.
tags List<String>: Tags to associate with the resource.
templateApplied Boolean: If true, returns Pipeline YAML with Templates applied on it.
templateAppliedPipelineYaml String: Pipeline YAML after resolving Templates (returned as a String).
yaml String: YAML of the pipeline.
gitDetails GetPipelineGitDetails: Contains parameters related to creating an Entity for Git Experience.
identifier String: Unique identifier of the resource.
name String: Name of the resource.

description string: Description of the resource.
id string: The provider-assigned unique ID for this managed resource.
orgId string: Unique identifier of the organization.
projectId string: Unique identifier of the project.
tags string[]: Tags to associate with the resource.
templateApplied boolean: If true, returns Pipeline YAML with Templates applied on it.
templateAppliedPipelineYaml string: Pipeline YAML after resolving Templates (returned as a String).
yaml string: YAML of the pipeline.
gitDetails GetPipelineGitDetails: Contains parameters related to creating an Entity for Git Experience.
identifier string: Unique identifier of the resource.
name string: Name of the resource.

description str: Description of the resource.
id str: The provider-assigned unique ID for this managed resource.
org_id str: Unique identifier of the organization.
project_id str: Unique identifier of the project.
tags Sequence[str]: Tags to associate with the resource.
template_applied bool: If true, returns Pipeline YAML with Templates applied on it.
template_applied_pipeline_yaml str: Pipeline YAML after resolving Templates (returned as a String).
yaml str: YAML of the pipeline.
git_details GetPipelineGitDetails: Contains parameters related to creating an Entity for Git Experience.
identifier str: Unique identifier of the resource.
name str: Name of the resource.

description String: Description of the resource.
id String: The provider-assigned unique ID for this managed resource.
orgId String: Unique identifier of the organization.
projectId String: Unique identifier of the project.
tags List<String>: Tags to associate with the resource.
templateApplied Boolean: If true, returns Pipeline YAML with Templates applied on it.
templateAppliedPipelineYaml String: Pipeline YAML after resolving Templates (returned as a String).
yaml String: YAML of the pipeline.
gitDetails Property Map: Contains parameters related to creating an Entity for Git Experience.
identifier String: Unique identifier of the resource.
name String: Name of the resource.

Supporting Types

GetPipelineGitDetails

BaseBranch string: Name of the default branch (this checks out a new branch titled by branch_name).
BranchName string: Name of the branch.
CommitMessage string: Commit message used for the merge commit.
ConnectorRef string: Identifier of the Harness Connector used for CRUD operations on the Entity.
FilePath string: File path of the Entity in the repository.
LastCommitId string: Last commit identifier (for Git Repositories other than Github). To be provided only when updating Pipeline.
LastObjectId string: Last object identifier (for Github). To be provided only when updating Pipeline.
RepoName string: Name of the repository.
StoreType string: Specifies whether the Entity is to be stored in Git or not. Possible values: INLINE, REMOTE.

BaseBranch string: Name of the default branch (this checks out a new branch titled by branch_name).
BranchName string: Name of the branch.
CommitMessage string: Commit message used for the merge commit.
ConnectorRef string: Identifier of the Harness Connector used for CRUD operations on the Entity.
FilePath string: File path of the Entity in the repository.
LastCommitId string: Last commit identifier (for Git Repositories other than Github). To be provided only when updating Pipeline.
LastObjectId string: Last object identifier (for Github). To be provided only when updating Pipeline.
RepoName string: Name of the repository.
StoreType string: Specifies whether the Entity is to be stored in Git or not. Possible values: INLINE, REMOTE.

baseBranch String: Name of the default branch (this checks out a new branch titled by branch_name).
branchName String: Name of the branch.
commitMessage String: Commit message used for the merge commit.
connectorRef String: Identifier of the Harness Connector used for CRUD operations on the Entity.
filePath String: File path of the Entity in the repository.
lastCommitId String: Last commit identifier (for Git Repositories other than Github). To be provided only when updating Pipeline.
lastObjectId String: Last object identifier (for Github). To be provided only when updating Pipeline.
repoName String: Name of the repository.
storeType String: Specifies whether the Entity is to be stored in Git or not. Possible values: INLINE, REMOTE.

baseBranch string: Name of the default branch (this checks out a new branch titled by branch_name).
branchName string: Name of the branch.
commitMessage string: Commit message used for the merge commit.
connectorRef string: Identifier of the Harness Connector used for CRUD operations on the Entity.
filePath string: File path of the Entity in the repository.
lastCommitId string: Last commit identifier (for Git Repositories other than Github). To be provided only when updating Pipeline.
lastObjectId string: Last object identifier (for Github). To be provided only when updating Pipeline.
repoName string: Name of the repository.
storeType string: Specifies whether the Entity is to be stored in Git or not. Possible values: INLINE, REMOTE.

base_branch str: Name of the default branch (this checks out a new branch titled by branch_name).
branch_name str: Name of the branch.
commit_message str: Commit message used for the merge commit.
connector_ref str: Identifier of the Harness Connector used for CRUD operations on the Entity.
file_path str: File path of the Entity in the repository.
last_commit_id str: Last commit identifier (for Git Repositories other than Github). To be provided only when updating Pipeline.
last_object_id str: Last object identifier (for Github). To be provided only when updating Pipeline.
repo_name str: Name of the repository.
store_type str: Specifies whether the Entity is to be stored in Git or not. Possible values: INLINE, REMOTE.

baseBranch String: Name of the default branch (this checks out a new branch titled by branch_name).
branchName String: Name of the branch.
commitMessage String: Commit message used for the merge commit.
connectorRef String: Identifier of the Harness Connector used for CRUD operations on the Entity.
filePath String: File path of the Entity in the repository.
lastCommitId String: Last commit identifier (for Git Repositories other than Github). To be provided only when updating Pipeline.
lastObjectId String: Last object identifier (for Github). To be provided only when updating Pipeline.
repoName String: Name of the repository.
storeType String: Specifies whether the Entity is to be stored in Git or not. Possible values: INLINE, REMOTE.

Package Details

Repository: harness pulumi/pulumi-harness
License: Apache-2.0
Notes: This Pulumi package is based on the harness Terraform Provider.

Harness v0.5.7 published on Saturday, Mar 8, 2025 by Pulumi

pulumi/pulumi-harness

harness.platform.getPipeline

On this page

On this page

Example Usage

Using getPipeline

getPipeline Result

Supporting Types

GetPipelineGitDetails

Package Details

On this page

On this page