Oracle Cloud Infrastructure v0.12.0, Mar 17 23

oci.DevOps.getDeployEnvironment

This data source provides details about a specific Deploy Environment resource in Oracle Cloud Infrastructure Devops service.

Retrieves a deployment environment by identifier.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var testDeployEnvironment = Oci.DevOps.GetDeployEnvironment.Invoke(new()
    {
        DeployEnvironmentId = oci_devops_deploy_environment.Test_deploy_environment.Id,
    });

});

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.GetDeployEnvironment(ctx, &devops.GetDeployEnvironmentArgs{
			DeployEnvironmentId: oci_devops_deploy_environment.Test_deploy_environment.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.oci.DevOps.DevOpsFunctions;
import com.pulumi.oci.DevOps.inputs.GetDeployEnvironmentArgs;
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 testDeployEnvironment = DevOpsFunctions.getDeployEnvironment(GetDeployEnvironmentArgs.builder()
            .deployEnvironmentId(oci_devops_deploy_environment.test_deploy_environment().id())
            .build());

    }
}

import pulumi
import pulumi_oci as oci

test_deploy_environment = oci.DevOps.get_deploy_environment(deploy_environment_id=oci_devops_deploy_environment["test_deploy_environment"]["id"])

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

const testDeployEnvironment = oci.DevOps.getDeployEnvironment({
    deployEnvironmentId: oci_devops_deploy_environment.test_deploy_environment.id,
});

variables:
  testDeployEnvironment:
    fn::invoke:
      Function: oci:DevOps:getDeployEnvironment
      Arguments:
        deployEnvironmentId: ${oci_devops_deploy_environment.test_deploy_environment.id}

Using getDeployEnvironment

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 getDeployEnvironment(args: GetDeployEnvironmentArgs, opts?: InvokeOptions): Promise<GetDeployEnvironmentResult>
function getDeployEnvironmentOutput(args: GetDeployEnvironmentOutputArgs, opts?: InvokeOptions): Output<GetDeployEnvironmentResult>

def get_deploy_environment(deploy_environment_id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetDeployEnvironmentResult
def get_deploy_environment_output(deploy_environment_id: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetDeployEnvironmentResult]

func GetDeployEnvironment(ctx *Context, args *GetDeployEnvironmentArgs, opts ...InvokeOption) (*GetDeployEnvironmentResult, error)
func GetDeployEnvironmentOutput(ctx *Context, args *GetDeployEnvironmentOutputArgs, opts ...InvokeOption) GetDeployEnvironmentResultOutput

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

public static class GetDeployEnvironment 
{
    public static Task<GetDeployEnvironmentResult> InvokeAsync(GetDeployEnvironmentArgs args, InvokeOptions? opts = null)
    public static Output<GetDeployEnvironmentResult> Invoke(GetDeployEnvironmentInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDeployEnvironmentResult> getDeployEnvironment(GetDeployEnvironmentArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: oci:DevOps/getDeployEnvironment:getDeployEnvironment
  arguments:
    # arguments dictionary

The following arguments are supported:

DeployEnvironmentId string: Unique environment identifier.

DeployEnvironmentId string: Unique environment identifier.

deployEnvironmentId String: Unique environment identifier.

deployEnvironmentId string: Unique environment identifier.

deploy_environment_id str: Unique environment identifier.

deployEnvironmentId String: Unique environment identifier.

getDeployEnvironment Result

The following output properties are available:

ClusterId string: The OCID of the Kubernetes cluster.
CompartmentId string: The OCID of a compartment.
ComputeInstanceGroupSelectors List<GetDeployEnvironmentComputeInstanceGroupSelector>: A collection of selectors. The combination of instances matching the selectors are included in the instance group.
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"}
DeployEnvironmentId string
DeployEnvironmentType string: Deployment environment type.
Description string: Optional description about the deployment environment.
DisplayName string: Deployment environment display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
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"}
FunctionId string: The OCID of the Function.
Id string: Unique identifier that is immutable on creation.
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.
NetworkChannels List<GetDeployEnvironmentNetworkChannel>: Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
ProjectId string: The OCID of a project.
State string: The current state of the deployment environment.
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: Time the deployment environment was created. Format defined by RFC3339.
TimeUpdated string: Time the deployment environment was updated. Format defined by RFC3339.

ClusterId string: The OCID of the Kubernetes cluster.
CompartmentId string: The OCID of a compartment.
ComputeInstanceGroupSelectors []GetDeployEnvironmentComputeInstanceGroupSelector: A collection of selectors. The combination of instances matching the selectors are included in the instance group.
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"}
DeployEnvironmentId string
DeployEnvironmentType string: Deployment environment type.
Description string: Optional description about the deployment environment.
DisplayName string: Deployment environment display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
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"}
FunctionId string: The OCID of the Function.
Id string: Unique identifier that is immutable on creation.
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.
NetworkChannels []GetDeployEnvironmentNetworkChannel: Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
ProjectId string: The OCID of a project.
State string: The current state of the deployment environment.
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: Time the deployment environment was created. Format defined by RFC3339.
TimeUpdated string: Time the deployment environment was updated. Format defined by RFC3339.

clusterId String: The OCID of the Kubernetes cluster.
compartmentId String: The OCID of a compartment.
computeInstanceGroupSelectors List<GetDeployEnvironmentComputeInstanceGroupSelector>: A collection of selectors. The combination of instances matching the selectors are included in the instance group.
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"}
deployEnvironmentId String
deployEnvironmentType String: Deployment environment type.
description String: Optional description about the deployment environment.
displayName String: Deployment environment display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
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"}
functionId String: The OCID of the Function.
id String: Unique identifier that is immutable on creation.
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.
networkChannels List<GetDeployEnvironmentNetworkChannel>: Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
projectId String: The OCID of a project.
state String: The current state of the deployment environment.
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: Time the deployment environment was created. Format defined by RFC3339.
timeUpdated String: Time the deployment environment was updated. Format defined by RFC3339.

clusterId string: The OCID of the Kubernetes cluster.
compartmentId string: The OCID of a compartment.
computeInstanceGroupSelectors GetDeployEnvironmentComputeInstanceGroupSelector[]: A collection of selectors. The combination of instances matching the selectors are included in the instance group.
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"}
deployEnvironmentId string
deployEnvironmentType string: Deployment environment type.
description string: Optional description about the deployment environment.
displayName string: Deployment environment display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
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"}
functionId string: The OCID of the Function.
id string: Unique identifier that is immutable on creation.
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.
networkChannels GetDeployEnvironmentNetworkChannel[]: Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
projectId string: The OCID of a project.
state string: The current state of the deployment environment.
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: Time the deployment environment was created. Format defined by RFC3339.
timeUpdated string: Time the deployment environment was updated. Format defined by RFC3339.

cluster_id str: The OCID of the Kubernetes cluster.
compartment_id str: The OCID of a compartment.
compute_instance_group_selectors GetDeployEnvironmentComputeInstanceGroupSelector]: A collection of selectors. The combination of instances matching the selectors are included in the instance group.
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"}
deploy_environment_id str
deploy_environment_type str: Deployment environment type.
description str: Optional description about the deployment environment.
display_name str: Deployment environment display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
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"}
function_id str: The OCID of the Function.
id str: Unique identifier that is immutable on creation.
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.
network_channels GetDeployEnvironmentNetworkChannel]: Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
project_id str: The OCID of a project.
state str: The current state of the deployment environment.
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: Time the deployment environment was created. Format defined by RFC3339.
time_updated str: Time the deployment environment was updated. Format defined by RFC3339.

clusterId String: The OCID of the Kubernetes cluster.
compartmentId String: The OCID of a compartment.
computeInstanceGroupSelectors List<Property Map>: A collection of selectors. The combination of instances matching the selectors are included in the instance group.
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"}
deployEnvironmentId String
deployEnvironmentType String: Deployment environment type.
description String: Optional description about the deployment environment.
displayName String: Deployment environment display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
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"}
functionId String: The OCID of the Function.
id String: Unique identifier that is immutable on creation.
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.
networkChannels List<Property Map>: Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
projectId String: The OCID of a project.
state String: The current state of the deployment environment.
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: Time the deployment environment was created. Format defined by RFC3339.
timeUpdated String: Time the deployment environment was updated. Format defined by RFC3339.

Supporting Types

GetDeployEnvironmentComputeInstanceGroupSelector

Items List<GetDeployEnvironmentComputeInstanceGroupSelectorItem>: A list of selectors for the instance group. UNION operator is used for combining the instances selected by each selector.

Items []GetDeployEnvironmentComputeInstanceGroupSelectorItem: A list of selectors for the instance group. UNION operator is used for combining the instances selected by each selector.

items List<GetDeployEnvironmentComputeInstanceGroupSelectorItem>: A list of selectors for the instance group. UNION operator is used for combining the instances selected by each selector.

items GetDeployEnvironmentComputeInstanceGroupSelectorItem[]: A list of selectors for the instance group. UNION operator is used for combining the instances selected by each selector.

items GetDeployEnvironmentComputeInstanceGroupSelectorItem]: A list of selectors for the instance group. UNION operator is used for combining the instances selected by each selector.

items List<Property Map>: A list of selectors for the instance group. UNION operator is used for combining the instances selected by each selector.

GetDeployEnvironmentComputeInstanceGroupSelectorItem

ComputeInstanceIds List<string>: Compute instance OCID identifiers that are members of this group.
Query string: Query expression confirming to the Oracle Cloud Infrastructure Search Language syntax to select compute instances for the group. The language is documented at https://docs.oracle.com/en-us/iaas/Content/Search/Concepts/querysyntax.htm
Region string: Region identifier referred by the deployment environment. Region identifiers are listed at https://docs.oracle.com/en-us/iaas/Content/General/Concepts/regions.htm
SelectorType string: Defines the type of the instance selector for the group.

ComputeInstanceIds []string: Compute instance OCID identifiers that are members of this group.
Query string: Query expression confirming to the Oracle Cloud Infrastructure Search Language syntax to select compute instances for the group. The language is documented at https://docs.oracle.com/en-us/iaas/Content/Search/Concepts/querysyntax.htm
Region string: Region identifier referred by the deployment environment. Region identifiers are listed at https://docs.oracle.com/en-us/iaas/Content/General/Concepts/regions.htm
SelectorType string: Defines the type of the instance selector for the group.

computeInstanceIds List<String>: Compute instance OCID identifiers that are members of this group.
query String: Query expression confirming to the Oracle Cloud Infrastructure Search Language syntax to select compute instances for the group. The language is documented at https://docs.oracle.com/en-us/iaas/Content/Search/Concepts/querysyntax.htm
region String: Region identifier referred by the deployment environment. Region identifiers are listed at https://docs.oracle.com/en-us/iaas/Content/General/Concepts/regions.htm
selectorType String: Defines the type of the instance selector for the group.

computeInstanceIds string[]: Compute instance OCID identifiers that are members of this group.
query string: Query expression confirming to the Oracle Cloud Infrastructure Search Language syntax to select compute instances for the group. The language is documented at https://docs.oracle.com/en-us/iaas/Content/Search/Concepts/querysyntax.htm
region string: Region identifier referred by the deployment environment. Region identifiers are listed at https://docs.oracle.com/en-us/iaas/Content/General/Concepts/regions.htm
selectorType string: Defines the type of the instance selector for the group.

compute_instance_ids Sequence[str]: Compute instance OCID identifiers that are members of this group.
query str: Query expression confirming to the Oracle Cloud Infrastructure Search Language syntax to select compute instances for the group. The language is documented at https://docs.oracle.com/en-us/iaas/Content/Search/Concepts/querysyntax.htm
region str: Region identifier referred by the deployment environment. Region identifiers are listed at https://docs.oracle.com/en-us/iaas/Content/General/Concepts/regions.htm
selector_type str: Defines the type of the instance selector for the group.

computeInstanceIds List<String>: Compute instance OCID identifiers that are members of this group.
query String: Query expression confirming to the Oracle Cloud Infrastructure Search Language syntax to select compute instances for the group. The language is documented at https://docs.oracle.com/en-us/iaas/Content/Search/Concepts/querysyntax.htm
region String: Region identifier referred by the deployment environment. Region identifiers are listed at https://docs.oracle.com/en-us/iaas/Content/General/Concepts/regions.htm
selectorType String: Defines the type of the instance selector for the group.

GetDeployEnvironmentNetworkChannel

NetworkChannelType string: Network channel type.
NsgIds List<string>: An array of network security group OCIDs.
SubnetId string: The OCID of the subnet where VNIC resources will be created for private endpoint.

NetworkChannelType string: Network channel type.
NsgIds []string: An array of network security group OCIDs.
SubnetId string: The OCID of the subnet where VNIC resources will be created for private endpoint.

networkChannelType String: Network channel type.
nsgIds List<String>: An array of network security group OCIDs.
subnetId String: The OCID of the subnet where VNIC resources will be created for private endpoint.

networkChannelType string: Network channel type.
nsgIds string[]: An array of network security group OCIDs.
subnetId string: The OCID of the subnet where VNIC resources will be created for private endpoint.

network_channel_type str: Network channel type.
nsg_ids Sequence[str]: An array of network security group OCIDs.
subnet_id str: The OCID of the subnet where VNIC resources will be created for private endpoint.

networkChannelType String: Network channel type.
nsgIds List<String>: An array of network security group OCIDs.
subnetId String: The OCID of the subnet where VNIC resources will be created for private endpoint.

Package Details

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