Harness v0.0.5, Oct 31 22

harness.platform.getEnvironment

Data source for retrieving a Harness environment.

Example Usage

using System.Collections.Generic;
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 main

import (
	"github.com/lbrlabs/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: pulumi.StringRef("identifier"),
			OrgId:      "org_id",
			ProjectId:  "project_id",
		}, 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.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());

    }
}

import pulumi
import pulumi_harness as harness

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

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

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

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(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(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)
// Output-based functions aren't available in Java yet

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

The following arguments are supported:

OrgId string: Unique identifier of the Organization.
ProjectId string: Unique identifier of the Project.
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.
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.
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.
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.
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.
identifier String: Unique identifier of the resource.
name String: Name of the resource.

getEnvironment Result

The following output properties are available:

Color string: Color of the environment.
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. Tags should be in the form name:value.
Type string: The type of environment.
Yaml string: Input Set YAML
Identifier string: Unique identifier of the resource.
Name string: Name of the resource.

Color string: Color of the environment.
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. Tags should be in the form name:value.
Type string: The type of environment.
Yaml string: Input Set YAML
Identifier string: Unique identifier of the resource.
Name string: Name of the resource.

color String: Color of the environment.
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. Tags should be in the form name:value.
type String: The type of environment.
yaml String: Input Set YAML
identifier String: Unique identifier of the resource.
name String: Name of the resource.

color string: Color of the environment.
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. Tags should be in the form name:value.
type string: The type of environment.
yaml string: Input Set YAML
identifier string: Unique identifier of the resource.
name string: Name of the resource.

color str: Color of the environment.
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. Tags should be in the form name:value.
type str: The type of environment.
yaml str: Input Set YAML
identifier str: Unique identifier of the resource.
name str: Name of the resource.

color String: Color of the environment.
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. Tags should be in the form name:value.
type String: The type of environment.
yaml String: Input Set YAML
identifier String: Unique identifier of the resource.
name String: Name of the resource.

Package Details

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

harness.platform.getEnvironment

Example Usage

Using getEnvironment

getEnvironment Result

Package Details

Contents