Oracle Cloud Infrastructure

v0.5.0 published on Monday, Sep 12, 2022 by Pulumi

getBuildPipelines

This data source provides the list of Build Pipelines in Oracle Cloud Infrastructure Devops service.

Returns a list of build pipelines.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testBuildPipelines = Oci.DevOps.GetBuildPipelines.Invoke(new()
    {
        CompartmentId = @var.Compartment_id,
        DisplayName = @var.Build_pipeline_display_name,
        Id = @var.Build_pipeline_id,
        ProjectId = oci_devops_project.Test_project.Id,
        State = @var.Build_pipeline_state,
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := DevOps.GetBuildPipelines(ctx, &devops.GetBuildPipelinesArgs{
			CompartmentId: pulumi.StringRef(_var.Compartment_id),
			DisplayName:   pulumi.StringRef(_var.Build_pipeline_display_name),
			Id:            pulumi.StringRef(_var.Build_pipeline_id),
			ProjectId:     pulumi.StringRef(oci_devops_project.Test_project.Id),
			State:         pulumi.StringRef(_var.Build_pipeline_state),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DevOps.DevOpsFunctions;
import com.pulumi.oci.DevOps.inputs.GetBuildPipelinesArgs;
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 testBuildPipelines = DevOpsFunctions.getBuildPipelines(GetBuildPipelinesArgs.builder()
            .compartmentId(var_.compartment_id())
            .displayName(var_.build_pipeline_display_name())
            .id(var_.build_pipeline_id())
            .projectId(oci_devops_project.test_project().id())
            .state(var_.build_pipeline_state())
            .build());

    }
}

import pulumi
import pulumi_oci as oci

test_build_pipelines = oci.DevOps.get_build_pipelines(compartment_id=var["compartment_id"],
    display_name=var["build_pipeline_display_name"],
    id=var["build_pipeline_id"],
    project_id=oci_devops_project["test_project"]["id"],
    state=var["build_pipeline_state"])

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

const testBuildPipelines = oci.DevOps.getBuildPipelines({
    compartmentId: _var.compartment_id,
    displayName: _var.build_pipeline_display_name,
    id: _var.build_pipeline_id,
    projectId: oci_devops_project.test_project.id,
    state: _var.build_pipeline_state,
});

variables:
  testBuildPipelines:
    Fn::Invoke:
      Function: oci:DevOps:getBuildPipelines
      Arguments:
        compartmentId: ${var.compartment_id}
        displayName: ${var.build_pipeline_display_name}
        id: ${var.build_pipeline_id}
        projectId: ${oci_devops_project.test_project.id}
        state: ${var.build_pipeline_state}

Using getBuildPipelines

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 getBuildPipelines(args: GetBuildPipelinesArgs, opts?: InvokeOptions): Promise<GetBuildPipelinesResult>
function getBuildPipelinesOutput(args: GetBuildPipelinesOutputArgs, opts?: InvokeOptions): Output<GetBuildPipelinesResult>

def get_build_pipelines(compartment_id: Optional[str] = None,
                        display_name: Optional[str] = None,
                        filters: Optional[Sequence[_devops.GetBuildPipelinesFilter]] = None,
                        id: Optional[str] = None,
                        project_id: Optional[str] = None,
                        state: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetBuildPipelinesResult
def get_build_pipelines_output(compartment_id: Optional[pulumi.Input[str]] = None,
                        display_name: Optional[pulumi.Input[str]] = None,
                        filters: Optional[pulumi.Input[Sequence[pulumi.Input[_devops.GetBuildPipelinesFilterArgs]]]] = None,
                        id: Optional[pulumi.Input[str]] = None,
                        project_id: Optional[pulumi.Input[str]] = None,
                        state: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetBuildPipelinesResult]

func GetBuildPipelines(ctx *Context, args *GetBuildPipelinesArgs, opts ...InvokeOption) (*GetBuildPipelinesResult, error)
func GetBuildPipelinesOutput(ctx *Context, args *GetBuildPipelinesOutputArgs, opts ...InvokeOption) GetBuildPipelinesResultOutput

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

public static class GetBuildPipelines 
{
    public static Task<GetBuildPipelinesResult> InvokeAsync(GetBuildPipelinesArgs args, InvokeOptions? opts = null)
    public static Output<GetBuildPipelinesResult> Invoke(GetBuildPipelinesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetBuildPipelinesResult> getBuildPipelines(GetBuildPipelinesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

Fn::Invoke:
  Function: oci:DevOps/getBuildPipelines:getBuildPipelines
  Arguments:
    # Arguments dictionary

The following arguments are supported:

CompartmentId string: The OCID of the compartment in which to list resources.
DisplayName string: A filter to return only resources that match the entire display name given.
Filters List<GetBuildPipelinesFilter>
Id string: Unique identifier or OCID for listing a single resource by ID.
ProjectId string: unique project identifier
State string: A filter to return only build pipelines that matches the given lifecycle state.

CompartmentId string: The OCID of the compartment in which to list resources.
DisplayName string: A filter to return only resources that match the entire display name given.
Filters []GetBuildPipelinesFilter
Id string: Unique identifier or OCID for listing a single resource by ID.
ProjectId string: unique project identifier
State string: A filter to return only build pipelines that matches the given lifecycle state.

compartmentId String: The OCID of the compartment in which to list resources.
displayName String: A filter to return only resources that match the entire display name given.
filters List<GetBuildPipelinesFilter>
id String: Unique identifier or OCID for listing a single resource by ID.
projectId String: unique project identifier
state String: A filter to return only build pipelines that matches the given lifecycle state.

compartmentId string: The OCID of the compartment in which to list resources.
displayName string: A filter to return only resources that match the entire display name given.
filters GetBuildPipelinesFilter[]
id string: Unique identifier or OCID for listing a single resource by ID.
projectId string: unique project identifier
state string: A filter to return only build pipelines that matches the given lifecycle state.

compartment_id str: The OCID of the compartment in which to list resources.
display_name str: A filter to return only resources that match the entire display name given.
filters GetBuildPipelinesFilter]
id str: Unique identifier or OCID for listing a single resource by ID.
project_id str: unique project identifier
state str: A filter to return only build pipelines that matches the given lifecycle state.

compartmentId String: The OCID of the compartment in which to list resources.
displayName String: A filter to return only resources that match the entire display name given.
filters List<Property Map>
id String: Unique identifier or OCID for listing a single resource by ID.
projectId String: unique project identifier
state String: A filter to return only build pipelines that matches the given lifecycle state.

getBuildPipelines Result

The following output properties are available:

BuildPipelineCollections List<GetBuildPipelinesBuildPipelineCollection>: The list of build_pipeline_collection.
CompartmentId string: The OCID of the compartment where the build pipeline is created.
DisplayName string: Build pipeline display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
Filters List<GetBuildPipelinesFilter>
Id string: Unique identifier that is immutable on creation.
ProjectId string: The OCID of the DevOps project.
State string: The current state of the build pipeline.

BuildPipelineCollections []GetBuildPipelinesBuildPipelineCollection: The list of build_pipeline_collection.
CompartmentId string: The OCID of the compartment where the build pipeline is created.
DisplayName string: Build pipeline display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
Filters []GetBuildPipelinesFilter
Id string: Unique identifier that is immutable on creation.
ProjectId string: The OCID of the DevOps project.
State string: The current state of the build pipeline.

buildPipelineCollections List<GetBuildPipelinesBuildPipelineCollection>: The list of build_pipeline_collection.
compartmentId String: The OCID of the compartment where the build pipeline is created.
displayName String: Build pipeline display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
filters List<GetBuildPipelinesFilter>
id String: Unique identifier that is immutable on creation.
projectId String: The OCID of the DevOps project.
state String: The current state of the build pipeline.

buildPipelineCollections GetBuildPipelinesBuildPipelineCollection[]: The list of build_pipeline_collection.
compartmentId string: The OCID of the compartment where the build pipeline is created.
displayName string: Build pipeline display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
filters GetBuildPipelinesFilter[]
id string: Unique identifier that is immutable on creation.
projectId string: The OCID of the DevOps project.
state string: The current state of the build pipeline.

build_pipeline_collections GetBuildPipelinesBuildPipelineCollection]: The list of build_pipeline_collection.
compartment_id str: The OCID of the compartment where the build pipeline is created.
display_name str: Build pipeline display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
filters GetBuildPipelinesFilter]
id str: Unique identifier that is immutable on creation.
project_id str: The OCID of the DevOps project.
state str: The current state of the build pipeline.

buildPipelineCollections List<Property Map>: The list of build_pipeline_collection.
compartmentId String: The OCID of the compartment where the build pipeline is created.
displayName String: Build pipeline display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
filters List<Property Map>
id String: Unique identifier that is immutable on creation.
projectId String: The OCID of the DevOps project.
state String: The current state of the build pipeline.

Supporting Types

GetBuildPipelinesBuildPipelineCollection

Items List<GetBuildPipelinesBuildPipelineCollectionItem>: List of parameters defined for a build pipeline.

Items []GetBuildPipelinesBuildPipelineCollectionItem: List of parameters defined for a build pipeline.

items List<GetBuildPipelinesBuildPipelineCollectionItem>: List of parameters defined for a build pipeline.

items GetBuildPipelinesBuildPipelineCollectionItem[]: List of parameters defined for a build pipeline.

items GetBuildPipelinesBuildPipelineCollectionItem]: List of parameters defined for a build pipeline.

items List<Property Map>: List of parameters defined for a build pipeline.

GetBuildPipelinesBuildPipelineCollectionItem

BuildPipelineParameters List<GetBuildPipelinesBuildPipelineCollectionItemBuildPipelineParameter>: Specifies list of parameters present in a build pipeline. An UPDATE operation replaces the existing parameters list entirely.
CompartmentId string: The OCID of the compartment in which to list resources.
DefinedTags Dictionary<string, object>: Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}
Description string: Optional description about the build pipeline.
DisplayName string: A filter to return only resources that match the entire display name given.
FreeformTags Dictionary<string, object>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: {"bar-key": "value"}
Id string: Unique identifier or OCID for listing a single resource by ID.
LifecycleDetails string: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
ProjectId string: unique project identifier
State string: A filter to return only build pipelines that matches the given lifecycle state.
SystemTags Dictionary<string, object>: Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string: The time the build pipeline was created. Format defined by RFC3339.
TimeUpdated string: The time the build pipeline was updated. Format defined by RFC3339.

BuildPipelineParameters []GetBuildPipelinesBuildPipelineCollectionItemBuildPipelineParameter: Specifies list of parameters present in a build pipeline. An UPDATE operation replaces the existing parameters list entirely.
CompartmentId string: The OCID of the compartment in which to list resources.
DefinedTags map[string]interface{}: Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}
Description string: Optional description about the build pipeline.
DisplayName string: A filter to return only resources that match the entire display name given.
FreeformTags map[string]interface{}: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: {"bar-key": "value"}
Id string: Unique identifier or OCID for listing a single resource by ID.
LifecycleDetails string: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
ProjectId string: unique project identifier
State string: A filter to return only build pipelines that matches the given lifecycle state.
SystemTags map[string]interface{}: Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string: The time the build pipeline was created. Format defined by RFC3339.
TimeUpdated string: The time the build pipeline was updated. Format defined by RFC3339.

buildPipelineParameters List<GetBuildPipelinesBuildPipelineCollectionItemBuildPipelineParameter>: Specifies list of parameters present in a build pipeline. An UPDATE operation replaces the existing parameters list entirely.
compartmentId String: The OCID of the compartment in which to list resources.
definedTags Map<String,Object>: Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}
description String: Optional description about the build pipeline.
displayName String: A filter to return only resources that match the entire display name given.
freeformTags Map<String,Object>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: {"bar-key": "value"}
id String: Unique identifier or OCID for listing a single resource by ID.
lifecycleDetails String: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
projectId String: unique project identifier
state String: A filter to return only build pipelines that matches the given lifecycle state.
systemTags Map<String,Object>: Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String: The time the build pipeline was created. Format defined by RFC3339.
timeUpdated String: The time the build pipeline was updated. Format defined by RFC3339.

buildPipelineParameters GetBuildPipelinesBuildPipelineCollectionItemBuildPipelineParameter[]: Specifies list of parameters present in a build pipeline. An UPDATE operation replaces the existing parameters list entirely.
compartmentId string: The OCID of the compartment in which to list resources.
definedTags {[key: string]: any}: Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}
description string: Optional description about the build pipeline.
displayName string: A filter to return only resources that match the entire display name given.
freeformTags {[key: string]: any}: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: {"bar-key": "value"}
id string: Unique identifier or OCID for listing a single resource by ID.
lifecycleDetails string: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
projectId string: unique project identifier
state string: A filter to return only build pipelines that matches the given lifecycle state.
systemTags {[key: string]: any}: Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated string: The time the build pipeline was created. Format defined by RFC3339.
timeUpdated string: The time the build pipeline was updated. Format defined by RFC3339.

build_pipeline_parameters GetBuildPipelinesBuildPipelineCollectionItemBuildPipelineParameter]: Specifies list of parameters present in a build pipeline. An UPDATE operation replaces the existing parameters list entirely.
compartment_id str: The OCID of the compartment in which to list resources.
defined_tags Mapping[str, Any]: Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}
description str: Optional description about the build pipeline.
display_name str: A filter to return only resources that match the entire display name given.
freeform_tags Mapping[str, Any]: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: {"bar-key": "value"}
id str: Unique identifier or OCID for listing a single resource by ID.
lifecycle_details str: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
project_id str: unique project identifier
state str: A filter to return only build pipelines that matches the given lifecycle state.
system_tags Mapping[str, Any]: Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
time_created str: The time the build pipeline was created. Format defined by RFC3339.
time_updated str: The time the build pipeline was updated. Format defined by RFC3339.

buildPipelineParameters List<Property Map>: Specifies list of parameters present in a build pipeline. An UPDATE operation replaces the existing parameters list entirely.
compartmentId String: The OCID of the compartment in which to list resources.
definedTags Map<Any>: Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}
description String: Optional description about the build pipeline.
displayName String: A filter to return only resources that match the entire display name given.
freeformTags Map<Any>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: {"bar-key": "value"}
id String: Unique identifier or OCID for listing a single resource by ID.
lifecycleDetails String: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
projectId String: unique project identifier
state String: A filter to return only build pipelines that matches the given lifecycle state.
systemTags Map<Any>: Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String: The time the build pipeline was created. Format defined by RFC3339.
timeUpdated String: The time the build pipeline was updated. Format defined by RFC3339.

GetBuildPipelinesBuildPipelineCollectionItemBuildPipelineParameter

Items List<GetBuildPipelinesBuildPipelineCollectionItemBuildPipelineParameterItem>: List of parameters defined for a build pipeline.

Items []GetBuildPipelinesBuildPipelineCollectionItemBuildPipelineParameterItem: List of parameters defined for a build pipeline.

items List<GetBuildPipelinesBuildPipelineCollectionItemBuildPipelineParameterItem>: List of parameters defined for a build pipeline.

items GetBuildPipelinesBuildPipelineCollectionItemBuildPipelineParameterItem[]: List of parameters defined for a build pipeline.

items GetBuildPipelinesBuildPipelineCollectionItemBuildPipelineParameterItem]: List of parameters defined for a build pipeline.

items List<Property Map>: List of parameters defined for a build pipeline.

GetBuildPipelinesBuildPipelineCollectionItemBuildPipelineParameterItem

DefaultValue string: Default value of the parameter.
Description string: Optional description about the build pipeline.
Name string: Name of the parameter (case-sensitive). Parameter name must be ^[a-zA-Z][a-zA-Z_0-9]*$. Example: 'Build_Pipeline_param' is not same as 'build_pipeline_Param'

DefaultValue string: Default value of the parameter.
Description string: Optional description about the build pipeline.
Name string: Name of the parameter (case-sensitive). Parameter name must be ^[a-zA-Z][a-zA-Z_0-9]*$. Example: 'Build_Pipeline_param' is not same as 'build_pipeline_Param'

defaultValue String: Default value of the parameter.
description String: Optional description about the build pipeline.
name String: Name of the parameter (case-sensitive). Parameter name must be ^[a-zA-Z][a-zA-Z_0-9]*$. Example: 'Build_Pipeline_param' is not same as 'build_pipeline_Param'

defaultValue string: Default value of the parameter.
description string: Optional description about the build pipeline.
name string: Name of the parameter (case-sensitive). Parameter name must be ^[a-zA-Z][a-zA-Z_0-9]*$. Example: 'Build_Pipeline_param' is not same as 'build_pipeline_Param'

default_value str: Default value of the parameter.
description str: Optional description about the build pipeline.
name str: Name of the parameter (case-sensitive). Parameter name must be ^[a-zA-Z][a-zA-Z_0-9]*$. Example: 'Build_Pipeline_param' is not same as 'build_pipeline_Param'

defaultValue String: Default value of the parameter.
description String: Optional description about the build pipeline.
name String: Name of the parameter (case-sensitive). Parameter name must be ^[a-zA-Z][a-zA-Z_0-9]*$. Example: 'Build_Pipeline_param' is not same as 'build_pipeline_Param'

GetBuildPipelinesFilter

Name string: Name of the parameter (case-sensitive). Parameter name must be ^[a-zA-Z][a-zA-Z_0-9]*$. Example: 'Build_Pipeline_param' is not same as 'build_pipeline_Param'
Values List<string>
Regex bool

Name string: Name of the parameter (case-sensitive). Parameter name must be ^[a-zA-Z][a-zA-Z_0-9]*$. Example: 'Build_Pipeline_param' is not same as 'build_pipeline_Param'
Values []string
Regex bool

name String: Name of the parameter (case-sensitive). Parameter name must be ^[a-zA-Z][a-zA-Z_0-9]*$. Example: 'Build_Pipeline_param' is not same as 'build_pipeline_Param'
values List<String>
regex Boolean

name string: Name of the parameter (case-sensitive). Parameter name must be ^[a-zA-Z][a-zA-Z_0-9]*$. Example: 'Build_Pipeline_param' is not same as 'build_pipeline_Param'
values string[]
regex boolean

name str: Name of the parameter (case-sensitive). Parameter name must be ^[a-zA-Z][a-zA-Z_0-9]*$. Example: 'Build_Pipeline_param' is not same as 'build_pipeline_Param'
values Sequence[str]
regex bool

name String: Name of the parameter (case-sensitive). Parameter name must be ^[a-zA-Z][a-zA-Z_0-9]*$. Example: 'Build_Pipeline_param' is not same as 'build_pipeline_Param'
values List<String>
regex Boolean

Package Details

Repository: https://github.com/pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.