Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Harness Provider
  3. API Docs
  4. platform
  5. getEnvironment
Harness v0.5.7 published on Saturday, Mar 8, 2025 by Pulumi
pulumi/pulumi-harness

harness.platform.getEnvironment

Explore with Pulumi AI

harness logo
Harness v0.5.7 published on Saturday, Mar 8, 2025 by Pulumi
pulumi/pulumi-harness

    Data source for retrieving a Harness environment.

    Example Usage

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

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

    import pulumi
import pulumi_harness as harness

example = harness.platform.get_environment(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.LookupEnvironment(ctx, &platform.LookupEnvironmentArgs{
			Identifier: "identifier",
			OrgId:      pulumi.StringRef("org_id"),
			ProjectId:  pulumi.StringRef("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.GetEnvironment.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.GetEnvironmentArgs;
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.getEnvironment(GetEnvironmentArgs.builder()
            .identifier("identifier")
            .orgId("org_id")
            .projectId("project_id")
            .build());

    }
}

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

    Using getEnvironment

    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 getEnvironment(args: GetEnvironmentArgs, opts?: InvokeOptions): Promise<GetEnvironmentResult>
function getEnvironmentOutput(args: GetEnvironmentOutputArgs, opts?: InvokeOptions): Output<GetEnvironmentResult>
    def get_environment(git_details: Optional[GetEnvironmentGitDetails] = None,
                    identifier: Optional[str] = None,
                    name: Optional[str] = None,
                    org_id: Optional[str] = None,
                    project_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetEnvironmentResult
def get_environment_output(git_details: Optional[pulumi.Input[GetEnvironmentGitDetailsArgs]] = 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[GetEnvironmentResult]
    func LookupEnvironment(ctx *Context, args *LookupEnvironmentArgs, opts ...InvokeOption) (*LookupEnvironmentResult, error)
func LookupEnvironmentOutput(ctx *Context, args *LookupEnvironmentOutputArgs, opts ...InvokeOption) LookupEnvironmentResultOutput

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

    public static class GetEnvironment 
{
    public static Task<GetEnvironmentResult> InvokeAsync(GetEnvironmentArgs args, InvokeOptions? opts = null)
    public static Output<GetEnvironmentResult> Invoke(GetEnvironmentInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetEnvironmentResult> getEnvironment(GetEnvironmentArgs args, InvokeOptions options)
public static Output<GetEnvironmentResult> getEnvironment(GetEnvironmentArgs args, InvokeOptions options)

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

    The following arguments are supported:

    Identifier string
    Unique identifier of the resource.
    GitDetails GetEnvironmentGitDetails
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Identifier string
    Unique identifier of the resource.
    GitDetails GetEnvironmentGitDetails
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    identifier String
    Unique identifier of the resource.
    gitDetails GetEnvironmentGitDetails
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    identifier string
    Unique identifier of the resource.
    gitDetails GetEnvironmentGitDetails
    name string
    Name of the resource.
    orgId string
    Unique identifier of the organization.
    projectId string
    Unique identifier of the project.
    identifier str
    Unique identifier of the resource.
    git_details GetEnvironmentGitDetails
    name str
    Name of the resource.
    org_id str
    Unique identifier of the organization.
    project_id str
    Unique identifier of the project.
    identifier String
    Unique identifier of the resource.
    gitDetails Property Map
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.

    getEnvironment Result

    The following output properties are available:

    Color string
    Color of the environment.
    Description string
    Description of the resource.
    GitDetails GetEnvironmentGitDetails
    Id string
    The provider-assigned unique ID for this managed resource.
    Identifier string
    Unique identifier of the resource.
    Tags List<string>
    Tags to associate with the resource.
    Type string
    The type of environment.
    Yaml string
    Environment YAML. In YAML, to reference an entity at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference an entity at the account scope, prefix 'account` to the expression: account.{identifier}. For eg, to reference a connector with identifier 'connectorId' at the organization scope in a stage mention it as connectorRef: org.connectorId.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Color string
    Color of the environment.
    Description string
    Description of the resource.
    GitDetails GetEnvironmentGitDetails
    Id string
    The provider-assigned unique ID for this managed resource.
    Identifier string
    Unique identifier of the resource.
    Tags []string
    Tags to associate with the resource.
    Type string
    The type of environment.
    Yaml string
    Environment YAML. In YAML, to reference an entity at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference an entity at the account scope, prefix 'account` to the expression: account.{identifier}. For eg, to reference a connector with identifier 'connectorId' at the organization scope in a stage mention it as connectorRef: org.connectorId.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    color String
    Color of the environment.
    description String
    Description of the resource.
    gitDetails GetEnvironmentGitDetails
    id String
    The provider-assigned unique ID for this managed resource.
    identifier String
    Unique identifier of the resource.
    tags List<String>
    Tags to associate with the resource.
    type String
    The type of environment.
    yaml String
    Environment YAML. In YAML, to reference an entity at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference an entity at the account scope, prefix 'account` to the expression: account.{identifier}. For eg, to reference a connector with identifier 'connectorId' at the organization scope in a stage mention it as connectorRef: org.connectorId.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    color string
    Color of the environment.
    description string
    Description of the resource.
    gitDetails GetEnvironmentGitDetails
    id string
    The provider-assigned unique ID for this managed resource.
    identifier string
    Unique identifier of the resource.
    tags string[]
    Tags to associate with the resource.
    type string
    The type of environment.
    yaml string
    Environment YAML. In YAML, to reference an entity at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference an entity at the account scope, prefix 'account` to the expression: account.{identifier}. For eg, to reference a connector with identifier 'connectorId' at the organization scope in a stage mention it as connectorRef: org.connectorId.
    name string
    Name of the resource.
    orgId string
    Unique identifier of the organization.
    projectId string
    Unique identifier of the project.
    color str
    Color of the environment.
    description str
    Description of the resource.
    git_details GetEnvironmentGitDetails
    id str
    The provider-assigned unique ID for this managed resource.
    identifier str
    Unique identifier of the resource.
    tags Sequence[str]
    Tags to associate with the resource.
    type str
    The type of environment.
    yaml str
    Environment YAML. In YAML, to reference an entity at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference an entity at the account scope, prefix 'account` to the expression: account.{identifier}. For eg, to reference a connector with identifier 'connectorId' at the organization scope in a stage mention it as connectorRef: org.connectorId.
    name str
    Name of the resource.
    org_id str
    Unique identifier of the organization.
    project_id str
    Unique identifier of the project.
    color String
    Color of the environment.
    description String
    Description of the resource.
    gitDetails Property Map
    id String
    The provider-assigned unique ID for this managed resource.
    identifier String
    Unique identifier of the resource.
    tags List<String>
    Tags to associate with the resource.
    type String
    The type of environment.
    yaml String
    Environment YAML. In YAML, to reference an entity at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference an entity at the account scope, prefix 'account` to the expression: account.{identifier}. For eg, to reference a connector with identifier 'connectorId' at the organization scope in a stage mention it as connectorRef: org.connectorId.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.

    Supporting Types

    GetEnvironmentGitDetails

    Branch string
    Name of the branch.
    LoadFromFallbackBranch bool
    Load environment yaml from fallback branch
    RepoName string
    Repo name of remote environment
    Branch string
    Name of the branch.
    LoadFromFallbackBranch bool
    Load environment yaml from fallback branch
    RepoName string
    Repo name of remote environment
    branch String
    Name of the branch.
    loadFromFallbackBranch Boolean
    Load environment yaml from fallback branch
    repoName String
    Repo name of remote environment
    branch string
    Name of the branch.
    loadFromFallbackBranch boolean
    Load environment yaml from fallback branch
    repoName string
    Repo name of remote environment
    branch str
    Name of the branch.
    load_from_fallback_branch bool
    Load environment yaml from fallback branch
    repo_name str
    Repo name of remote environment
    branch String
    Name of the branch.
    loadFromFallbackBranch Boolean
    Load environment yaml from fallback branch
    repoName String
    Repo name of remote environment

    Package Details

    Repository
    harness pulumi/pulumi-harness
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the harness Terraform Provider.
    harness logo
    Harness v0.5.7 published on Saturday, Mar 8, 2025 by Pulumi
    pulumi/pulumi-harness