Oracle Cloud Infrastructure v2.15.0 published on Thursday, Oct 31, 2024 by Pulumi
oci.DevOps.getDeployEnvironment
Explore with Pulumi AI
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
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testDeployEnvironment = oci.DevOps.getDeployEnvironment({
deployEnvironmentId: testDeployEnvironmentOciDevopsDeployEnvironment.id,
});
import pulumi
import pulumi_oci as oci
test_deploy_environment = oci.DevOps.get_deploy_environment(deploy_environment_id=test_deploy_environment_oci_devops_deploy_environment["id"])
package main
import (
"github.com/pulumi/pulumi-oci/sdk/v2/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: testDeployEnvironmentOciDevopsDeployEnvironment.Id,
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() =>
{
var testDeployEnvironment = Oci.DevOps.GetDeployEnvironment.Invoke(new()
{
DeployEnvironmentId = testDeployEnvironmentOciDevopsDeployEnvironment.Id,
});
});
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(testDeployEnvironmentOciDevopsDeployEnvironment.id())
.build());
}
}
variables:
testDeployEnvironment:
fn::invoke:
Function: oci:DevOps:getDeployEnvironment
Arguments:
deployEnvironmentId: ${testDeployEnvironmentOciDevopsDeployEnvironment.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:
- Deploy
Environment stringId - Unique environment identifier.
- Deploy
Environment stringId - Unique environment identifier.
- deploy
Environment StringId - Unique environment identifier.
- deploy
Environment stringId - Unique environment identifier.
- deploy_
environment_ strid - Unique environment identifier.
- deploy
Environment StringId - Unique environment identifier.
getDeployEnvironment Result
The following output properties are available:
- Cluster
Id string - The OCID of the Kubernetes cluster.
- Compartment
Id string - The OCID of a compartment.
- Compute
Instance List<GetGroup Selectors Deploy Environment Compute Instance Group Selector> - A collection of selectors. The combination of instances matching the selectors are included in the instance group.
- Dictionary<string, string>
- 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 stringId - Deploy
Environment stringType - Deployment environment type.
- Description string
- Optional description about the deployment environment.
- Display
Name string - Deployment environment display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
- Dictionary<string, string>
- 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 string - The OCID of the Function.
- Id string
- Unique identifier that is immutable on creation.
- Lifecycle
Details 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.
- Network
Channels List<GetDeploy Environment Network Channel> - Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
- Project
Id string - The OCID of a project.
- State string
- The current state of the deployment environment.
- Dictionary<string, string>
- Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example:
{"orcl-cloud.free-tier-retained": "true"}
- Time
Created string - Time the deployment environment was created. Format defined by RFC3339.
- Time
Updated string - Time the deployment environment was updated. Format defined by RFC3339.
- Cluster
Id string - The OCID of the Kubernetes cluster.
- Compartment
Id string - The OCID of a compartment.
- Compute
Instance []GetGroup Selectors Deploy Environment Compute Instance Group Selector - A collection of selectors. The combination of instances matching the selectors are included in the instance group.
- map[string]string
- 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 stringId - Deploy
Environment stringType - Deployment environment type.
- Description string
- Optional description about the deployment environment.
- Display
Name string - Deployment environment display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
- map[string]string
- 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 string - The OCID of the Function.
- Id string
- Unique identifier that is immutable on creation.
- Lifecycle
Details 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.
- Network
Channels []GetDeploy Environment Network Channel - Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
- Project
Id string - The OCID of a project.
- State string
- The current state of the deployment environment.
- map[string]string
- Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example:
{"orcl-cloud.free-tier-retained": "true"}
- Time
Created string - Time the deployment environment was created. Format defined by RFC3339.
- Time
Updated string - Time the deployment environment was updated. Format defined by RFC3339.
- cluster
Id String - The OCID of the Kubernetes cluster.
- compartment
Id String - The OCID of a compartment.
- compute
Instance List<GetGroup Selectors Deploy Environment Compute Instance Group Selector> - A collection of selectors. The combination of instances matching the selectors are included in the instance group.
- Map<String,String>
- 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 StringId - deploy
Environment StringType - Deployment environment type.
- description String
- Optional description about the deployment environment.
- display
Name String - Deployment environment display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
- Map<String,String>
- 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 String - The OCID of the Function.
- id String
- Unique identifier that is immutable on creation.
- lifecycle
Details 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.
- network
Channels List<GetDeploy Environment Network Channel> - Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
- project
Id String - The OCID of a project.
- state String
- The current state of the deployment environment.
- Map<String,String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time
Created String - Time the deployment environment was created. Format defined by RFC3339.
- time
Updated String - Time the deployment environment was updated. Format defined by RFC3339.
- cluster
Id string - The OCID of the Kubernetes cluster.
- compartment
Id string - The OCID of a compartment.
- compute
Instance GetGroup Selectors Deploy Environment Compute Instance Group Selector[] - A collection of selectors. The combination of instances matching the selectors are included in the instance group.
- {[key: string]: string}
- 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 stringId - deploy
Environment stringType - Deployment environment type.
- description string
- Optional description about the deployment environment.
- display
Name string - Deployment environment display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
- {[key: string]: string}
- 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 string - The OCID of the Function.
- id string
- Unique identifier that is immutable on creation.
- lifecycle
Details 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.
- network
Channels GetDeploy Environment Network Channel[] - Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
- project
Id string - The OCID of a project.
- state string
- The current state of the deployment environment.
- {[key: string]: string}
- Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time
Created string - Time the deployment environment was created. Format defined by RFC3339.
- time
Updated 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_ Sequence[devops.group_ selectors Get Deploy Environment Compute Instance Group Selector] - A collection of selectors. The combination of instances matching the selectors are included in the instance group.
- Mapping[str, str]
- 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_ strid - deploy_
environment_ strtype - 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.
- Mapping[str, str]
- 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 Sequence[devops.Get Deploy Environment Network Channel] - 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.
- Mapping[str, str]
- 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.
- cluster
Id String - The OCID of the Kubernetes cluster.
- compartment
Id String - The OCID of a compartment.
- compute
Instance List<Property Map>Group Selectors - A collection of selectors. The combination of instances matching the selectors are included in the instance group.
- Map<String>
- 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 StringId - deploy
Environment StringType - Deployment environment type.
- description String
- Optional description about the deployment environment.
- display
Name String - Deployment environment display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
- Map<String>
- 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 String - The OCID of the Function.
- id String
- Unique identifier that is immutable on creation.
- lifecycle
Details 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.
- network
Channels List<Property Map> - Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
- project
Id String - The OCID of a project.
- state String
- The current state of the deployment environment.
- Map<String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time
Created String - Time the deployment environment was created. Format defined by RFC3339.
- time
Updated String - Time the deployment environment was updated. Format defined by RFC3339.
Supporting Types
GetDeployEnvironmentComputeInstanceGroupSelector
- Items
List<Get
Deploy Environment Compute Instance Group Selector Item> - A list of selectors for the instance group. UNION operator is used for combining the instances selected by each selector.
- Items
[]Get
Deploy Environment Compute Instance Group Selector Item - A list of selectors for the instance group. UNION operator is used for combining the instances selected by each selector.
- items
List<Get
Deploy Environment Compute Instance Group Selector Item> - A list of selectors for the instance group. UNION operator is used for combining the instances selected by each selector.
- items
Get
Deploy Environment Compute Instance Group Selector Item[] - A list of selectors for the instance group. UNION operator is used for combining the instances selected by each selector.
- items
Sequence[devops.
Get Deploy Environment Compute Instance Group Selector Item] - 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
- Compute
Instance List<string>Ids - 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
- Selector
Type string - Defines the type of the instance selector for the group.
- Compute
Instance []stringIds - 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
- Selector
Type string - Defines the type of the instance selector for the group.
- compute
Instance List<String>Ids - 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
- selector
Type String - Defines the type of the instance selector for the group.
- compute
Instance string[]Ids - 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
- selector
Type string - Defines the type of the instance selector for the group.
- compute_
instance_ Sequence[str]ids - 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.
- compute
Instance List<String>Ids - 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
- selector
Type String - Defines the type of the instance selector for the group.
GetDeployEnvironmentNetworkChannel
- Network
Channel stringType - Network channel type.
- Nsg
Ids List<string> - An array of network security group OCIDs.
- Subnet
Id string - The OCID of the subnet where VNIC resources will be created for private endpoint.
- Network
Channel stringType - Network channel type.
- Nsg
Ids []string - An array of network security group OCIDs.
- Subnet
Id string - The OCID of the subnet where VNIC resources will be created for private endpoint.
- network
Channel StringType - Network channel type.
- nsg
Ids List<String> - An array of network security group OCIDs.
- subnet
Id String - The OCID of the subnet where VNIC resources will be created for private endpoint.
- network
Channel stringType - Network channel type.
- nsg
Ids string[] - An array of network security group OCIDs.
- subnet
Id string - The OCID of the subnet where VNIC resources will be created for private endpoint.
- network_
channel_ strtype - 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.
- network
Channel StringType - Network channel type.
- nsg
Ids List<String> - An array of network security group OCIDs.
- subnet
Id 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.