Oracle Cloud Infrastructure v2.27.0, Mar 20 25

Oracle Cloud Infrastructure v2.27.0 published on Thursday, Mar 20, 2025 by Pulumi

oci.DataScience.getContainers

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.27.0 published on Thursday, Mar 20, 2025 by Pulumi

Example Usage

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

const testContainers = oci.DataScience.getContainers({
    containerName: testContainer.name,
    displayName: containerDisplayName,
    isLatest: containerIsLatest,
    state: containerState,
    tagQueryParam: containerTagQueryParam,
    targetWorkload: containerTargetWorkload,
    usageQueryParam: containerUsageQueryParam,
});

import pulumi
import pulumi_oci as oci

test_containers = oci.DataScience.get_containers(container_name=test_container["name"],
    display_name=container_display_name,
    is_latest=container_is_latest,
    state=container_state,
    tag_query_param=container_tag_query_param,
    target_workload=container_target_workload,
    usage_query_param=container_usage_query_param)

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := datascience.GetContainers(ctx, &datascience.GetContainersArgs{
			ContainerName:   pulumi.StringRef(testContainer.Name),
			DisplayName:     pulumi.StringRef(containerDisplayName),
			IsLatest:        pulumi.BoolRef(containerIsLatest),
			State:           pulumi.StringRef(containerState),
			TagQueryParam:   pulumi.StringRef(containerTagQueryParam),
			TargetWorkload:  pulumi.StringRef(containerTargetWorkload),
			UsageQueryParam: pulumi.StringRef(containerUsageQueryParam),
		}, 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 testContainers = Oci.DataScience.GetContainers.Invoke(new()
    {
        ContainerName = testContainer.Name,
        DisplayName = containerDisplayName,
        IsLatest = containerIsLatest,
        State = containerState,
        TagQueryParam = containerTagQueryParam,
        TargetWorkload = containerTargetWorkload,
        UsageQueryParam = containerUsageQueryParam,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DataScience.DataScienceFunctions;
import com.pulumi.oci.DataScience.inputs.GetContainersArgs;
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 testContainers = DataScienceFunctions.getContainers(GetContainersArgs.builder()
            .containerName(testContainer.name())
            .displayName(containerDisplayName)
            .isLatest(containerIsLatest)
            .state(containerState)
            .tagQueryParam(containerTagQueryParam)
            .targetWorkload(containerTargetWorkload)
            .usageQueryParam(containerUsageQueryParam)
            .build());

    }
}

variables:
  testContainers:
    fn::invoke:
      function: oci:DataScience:getContainers
      arguments:
        containerName: ${testContainer.name}
        displayName: ${containerDisplayName}
        isLatest: ${containerIsLatest}
        state: ${containerState}
        tagQueryParam: ${containerTagQueryParam}
        targetWorkload: ${containerTargetWorkload}
        usageQueryParam: ${containerUsageQueryParam}

Using getContainers

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 getContainers(args: GetContainersArgs, opts?: InvokeOptions): Promise<GetContainersResult>
function getContainersOutput(args: GetContainersOutputArgs, opts?: InvokeOptions): Output<GetContainersResult>

def get_containers(container_name: Optional[str] = None,
                   display_name: Optional[str] = None,
                   filters: Optional[Sequence[_datascience.GetContainersFilter]] = None,
                   is_latest: Optional[bool] = None,
                   state: Optional[str] = None,
                   tag_query_param: Optional[str] = None,
                   target_workload: Optional[str] = None,
                   usage_query_param: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetContainersResult
def get_containers_output(container_name: Optional[pulumi.Input[str]] = None,
                   display_name: Optional[pulumi.Input[str]] = None,
                   filters: Optional[pulumi.Input[Sequence[pulumi.Input[_datascience.GetContainersFilterArgs]]]] = None,
                   is_latest: Optional[pulumi.Input[bool]] = None,
                   state: Optional[pulumi.Input[str]] = None,
                   tag_query_param: Optional[pulumi.Input[str]] = None,
                   target_workload: Optional[pulumi.Input[str]] = None,
                   usage_query_param: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetContainersResult]

func GetContainers(ctx *Context, args *GetContainersArgs, opts ...InvokeOption) (*GetContainersResult, error)
func GetContainersOutput(ctx *Context, args *GetContainersOutputArgs, opts ...InvokeOption) GetContainersResultOutput

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

public static class GetContainers 
{
    public static Task<GetContainersResult> InvokeAsync(GetContainersArgs args, InvokeOptions? opts = null)
    public static Output<GetContainersResult> Invoke(GetContainersInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetContainersResult> getContainers(GetContainersArgs args, InvokeOptions options)
public static Output<GetContainersResult> getContainers(GetContainersArgs args, InvokeOptions options)

fn::invoke:
  function: oci:DataScience/getContainers:getContainers
  arguments:
    # arguments dictionary

The following arguments are supported:

ContainerName string: Filter results by the container name.
DisplayName string: Filter results by its user-friendly name.
Filters List<GetContainersFilter>
IsLatest bool: if true, this returns latest version of container.
State string: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
TagQueryParam string: Filter results by the container version tag.
TargetWorkload string: Filter results by the target workload.
UsageQueryParam string: Filter results by the usage.

ContainerName string: Filter results by the container name.
DisplayName string: Filter results by its user-friendly name.
Filters []GetContainersFilter
IsLatest bool: if true, this returns latest version of container.
State string: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
TagQueryParam string: Filter results by the container version tag.
TargetWorkload string: Filter results by the target workload.
UsageQueryParam string: Filter results by the usage.

containerName String: Filter results by the container name.
displayName String: Filter results by its user-friendly name.
filters List<GetContainersFilter>
isLatest Boolean: if true, this returns latest version of container.
state String: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
tagQueryParam String: Filter results by the container version tag.
targetWorkload String: Filter results by the target workload.
usageQueryParam String: Filter results by the usage.

containerName string: Filter results by the container name.
displayName string: Filter results by its user-friendly name.
filters GetContainersFilter[]
isLatest boolean: if true, this returns latest version of container.
state string: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
tagQueryParam string: Filter results by the container version tag.
targetWorkload string: Filter results by the target workload.
usageQueryParam string: Filter results by the usage.

container_name str: Filter results by the container name.
display_name str: Filter results by its user-friendly name.
filters Sequence[datascience.GetContainersFilter]
is_latest bool: if true, this returns latest version of container.
state str: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
tag_query_param str: Filter results by the container version tag.
target_workload str: Filter results by the target workload.
usage_query_param str: Filter results by the usage.

containerName String: Filter results by the container name.
displayName String: Filter results by its user-friendly name.
filters List<Property Map>
isLatest Boolean: if true, this returns latest version of container.
state String: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
tagQueryParam String: Filter results by the container version tag.
targetWorkload String: Filter results by the target workload.
usageQueryParam String: Filter results by the usage.

getContainers Result

The following output properties are available:

Containers List<GetContainersContainer>: The list of containers.
Id string: The provider-assigned unique ID for this managed resource.
ContainerName string: The name of the container. This can be same for different tags
DisplayName string: The display name of the container.
Filters List<GetContainersFilter>
IsLatest bool: The latest tag of the container.
State string: Container Version LifecycleState.
TagQueryParam string
TargetWorkload string
UsageQueryParam string

Containers []GetContainersContainer: The list of containers.
Id string: The provider-assigned unique ID for this managed resource.
ContainerName string: The name of the container. This can be same for different tags
DisplayName string: The display name of the container.
Filters []GetContainersFilter
IsLatest bool: The latest tag of the container.
State string: Container Version LifecycleState.
TagQueryParam string
TargetWorkload string
UsageQueryParam string

containers List<GetContainersContainer>: The list of containers.
id String: The provider-assigned unique ID for this managed resource.
containerName String: The name of the container. This can be same for different tags
displayName String: The display name of the container.
filters List<GetContainersFilter>
isLatest Boolean: The latest tag of the container.
state String: Container Version LifecycleState.
tagQueryParam String
targetWorkload String
usageQueryParam String

containers GetContainersContainer[]: The list of containers.
id string: The provider-assigned unique ID for this managed resource.
containerName string: The name of the container. This can be same for different tags
displayName string: The display name of the container.
filters GetContainersFilter[]
isLatest boolean: The latest tag of the container.
state string: Container Version LifecycleState.
tagQueryParam string
targetWorkload string
usageQueryParam string

containers Sequence[datascience.GetContainersContainer]: The list of containers.
id str: The provider-assigned unique ID for this managed resource.
container_name str: The name of the container. This can be same for different tags
display_name str: The display name of the container.
filters Sequence[datascience.GetContainersFilter]
is_latest bool: The latest tag of the container.
state str: Container Version LifecycleState.
tag_query_param str
target_workload str
usage_query_param str

containers List<Property Map>: The list of containers.
id String: The provider-assigned unique ID for this managed resource.
containerName String: The name of the container. This can be same for different tags
displayName String: The display name of the container.
filters List<Property Map>
isLatest Boolean: The latest tag of the container.
state String: Container Version LifecycleState.
tagQueryParam String
targetWorkload String
usageQueryParam String

Supporting Types

GetContainersContainer

ContainerName string: Filter results by the container name.
DefinedTags Dictionary<string, string>: Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}
Description string: Description of the container.
DisplayName string: Filter results by its user-friendly name.
FamilyName string: The family name of the container.
FreeformTags Dictionary<string, string>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}
IsLatest bool: if true, this returns latest version of container.
State string: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
Tag string: Container Tag.
TagConfigurationLists List<GetContainersContainerTagConfigurationList>: An array of defined metadata details for the model.
TargetWorkloads List<string>: The list of target workload. This Container can be used with given data science resources.
Usages List<string>: The list of usages of this container. This Container can be used for given use-cases.
WorkloadConfigurationDetailsLists List<GetContainersContainerWorkloadConfigurationDetailsList>: workload configuration of the container.

ContainerName string: Filter results by the container name.
DefinedTags map[string]string: Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}
Description string: Description of the container.
DisplayName string: Filter results by its user-friendly name.
FamilyName string: The family name of the container.
FreeformTags map[string]string: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}
IsLatest bool: if true, this returns latest version of container.
State string: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
Tag string: Container Tag.
TagConfigurationLists []GetContainersContainerTagConfigurationList: An array of defined metadata details for the model.
TargetWorkloads []string: The list of target workload. This Container can be used with given data science resources.
Usages []string: The list of usages of this container. This Container can be used for given use-cases.
WorkloadConfigurationDetailsLists []GetContainersContainerWorkloadConfigurationDetailsList: workload configuration of the container.

containerName String: Filter results by the container name.
definedTags Map<String,String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}
description String: Description of the container.
displayName String: Filter results by its user-friendly name.
familyName String: The family name of the container.
freeformTags Map<String,String>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}
isLatest Boolean: if true, this returns latest version of container.
state String: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
tag String: Container Tag.
tagConfigurationLists List<GetContainersContainerTagConfigurationList>: An array of defined metadata details for the model.
targetWorkloads List<String>: The list of target workload. This Container can be used with given data science resources.
usages List<String>: The list of usages of this container. This Container can be used for given use-cases.
workloadConfigurationDetailsLists List<GetContainersContainerWorkloadConfigurationDetailsList>: workload configuration of the container.

containerName string: Filter results by the container name.
definedTags {[key: string]: string}: Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}
description string: Description of the container.
displayName string: Filter results by its user-friendly name.
familyName string: The family name of the container.
freeformTags {[key: string]: string}: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}
isLatest boolean: if true, this returns latest version of container.
state string: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
tag string: Container Tag.
tagConfigurationLists GetContainersContainerTagConfigurationList[]: An array of defined metadata details for the model.
targetWorkloads string[]: The list of target workload. This Container can be used with given data science resources.
usages string[]: The list of usages of this container. This Container can be used for given use-cases.
workloadConfigurationDetailsLists GetContainersContainerWorkloadConfigurationDetailsList[]: workload configuration of the container.

container_name str: Filter results by the container name.
defined_tags Mapping[str, str]: Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}
description str: Description of the container.
display_name str: Filter results by its user-friendly name.
family_name str: The family name of the container.
freeform_tags Mapping[str, str]: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}
is_latest bool: if true, this returns latest version of container.
state str: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
tag str: Container Tag.
tag_configuration_lists Sequence[datascience.GetContainersContainerTagConfigurationList]: An array of defined metadata details for the model.
target_workloads Sequence[str]: The list of target workload. This Container can be used with given data science resources.
usages Sequence[str]: The list of usages of this container. This Container can be used for given use-cases.
workload_configuration_details_lists Sequence[datascience.GetContainersContainerWorkloadConfigurationDetailsList]: workload configuration of the container.

containerName String: Filter results by the container name.
definedTags Map<String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}
description String: Description of the container.
displayName String: Filter results by its user-friendly name.
familyName String: The family name of the container.
freeformTags Map<String>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}
isLatest Boolean: if true, this returns latest version of container.
state String: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
tag String: Container Tag.
tagConfigurationLists List<Property Map>: An array of defined metadata details for the model.
targetWorkloads List<String>: The list of target workload. This Container can be used with given data science resources.
usages List<String>: The list of usages of this container. This Container can be used for given use-cases.
workloadConfigurationDetailsLists List<Property Map>: workload configuration of the container.

GetContainersContainerTagConfigurationList

Key string: Key of the container tag Metadata
Value string: Value of the container tag Metadata

Key string: Key of the container tag Metadata
Value string: Value of the container tag Metadata

key String: Key of the container tag Metadata
value String: Value of the container tag Metadata

key string: Key of the container tag Metadata
value string: Value of the container tag Metadata

key str: Key of the container tag Metadata
value str: Value of the container tag Metadata

key String: Key of the container tag Metadata
value String: Value of the container tag Metadata

GetContainersContainerWorkloadConfigurationDetailsList

AdditionalConfigurations Dictionary<string, string>: The additional configurations
Cmd string: The container image run CMD as a list of strings. Use CMD as arguments to the ENTRYPOINT or the only command to run in the absence of an ENTRYPOINT. The combined size of CMD and ENTRYPOINT must be less than 2048 bytes.
HealthCheckPort int: The port on which the container HEALTHCHECK would listen. The port can be anything between 1024 and 65535. The following ports cannot be used 24224, 8446, 8447.
ServerPort int: The port on which the web server serving the inference is running. The port can be anything between 1024 and 65535. The following ports cannot be used 24224, 8446, 8447.
UseCaseConfigurations List<GetContainersContainerWorkloadConfigurationDetailsListUseCaseConfiguration>: The use-case configuration details
WorkloadType string: The workload use case.

AdditionalConfigurations map[string]string: The additional configurations
Cmd string: The container image run CMD as a list of strings. Use CMD as arguments to the ENTRYPOINT or the only command to run in the absence of an ENTRYPOINT. The combined size of CMD and ENTRYPOINT must be less than 2048 bytes.
HealthCheckPort int: The port on which the container HEALTHCHECK would listen. The port can be anything between 1024 and 65535. The following ports cannot be used 24224, 8446, 8447.
ServerPort int: The port on which the web server serving the inference is running. The port can be anything between 1024 and 65535. The following ports cannot be used 24224, 8446, 8447.
UseCaseConfigurations []GetContainersContainerWorkloadConfigurationDetailsListUseCaseConfiguration: The use-case configuration details
WorkloadType string: The workload use case.

additionalConfigurations Map<String,String>: The additional configurations
cmd String: The container image run CMD as a list of strings. Use CMD as arguments to the ENTRYPOINT or the only command to run in the absence of an ENTRYPOINT. The combined size of CMD and ENTRYPOINT must be less than 2048 bytes.
healthCheckPort Integer: The port on which the container HEALTHCHECK would listen. The port can be anything between 1024 and 65535. The following ports cannot be used 24224, 8446, 8447.
serverPort Integer: The port on which the web server serving the inference is running. The port can be anything between 1024 and 65535. The following ports cannot be used 24224, 8446, 8447.
useCaseConfigurations List<GetContainersContainerWorkloadConfigurationDetailsListUseCaseConfiguration>: The use-case configuration details
workloadType String: The workload use case.

additionalConfigurations {[key: string]: string}: The additional configurations
cmd string: The container image run CMD as a list of strings. Use CMD as arguments to the ENTRYPOINT or the only command to run in the absence of an ENTRYPOINT. The combined size of CMD and ENTRYPOINT must be less than 2048 bytes.
healthCheckPort number: The port on which the container HEALTHCHECK would listen. The port can be anything between 1024 and 65535. The following ports cannot be used 24224, 8446, 8447.
serverPort number: The port on which the web server serving the inference is running. The port can be anything between 1024 and 65535. The following ports cannot be used 24224, 8446, 8447.
useCaseConfigurations GetContainersContainerWorkloadConfigurationDetailsListUseCaseConfiguration[]: The use-case configuration details
workloadType string: The workload use case.

additional_configurations Mapping[str, str]: The additional configurations
cmd str: The container image run CMD as a list of strings. Use CMD as arguments to the ENTRYPOINT or the only command to run in the absence of an ENTRYPOINT. The combined size of CMD and ENTRYPOINT must be less than 2048 bytes.
health_check_port int: The port on which the container HEALTHCHECK would listen. The port can be anything between 1024 and 65535. The following ports cannot be used 24224, 8446, 8447.
server_port int: The port on which the web server serving the inference is running. The port can be anything between 1024 and 65535. The following ports cannot be used 24224, 8446, 8447.
use_case_configurations Sequence[datascience.GetContainersContainerWorkloadConfigurationDetailsListUseCaseConfiguration]: The use-case configuration details
workload_type str: The workload use case.

additionalConfigurations Map<String>: The additional configurations
cmd String: The container image run CMD as a list of strings. Use CMD as arguments to the ENTRYPOINT or the only command to run in the absence of an ENTRYPOINT. The combined size of CMD and ENTRYPOINT must be less than 2048 bytes.
healthCheckPort Number: The port on which the container HEALTHCHECK would listen. The port can be anything between 1024 and 65535. The following ports cannot be used 24224, 8446, 8447.
serverPort Number: The port on which the web server serving the inference is running. The port can be anything between 1024 and 65535. The following ports cannot be used 24224, 8446, 8447.
useCaseConfigurations List<Property Map>: The use-case configuration details
workloadType String: The workload use case.

GetContainersContainerWorkloadConfigurationDetailsListUseCaseConfiguration

AdditionalConfigurations Dictionary<string, string>: The additional configurations
UseCaseType string: The job-run use-case.

AdditionalConfigurations map[string]string: The additional configurations
UseCaseType string: The job-run use-case.

additionalConfigurations Map<String,String>: The additional configurations
useCaseType String: The job-run use-case.

additionalConfigurations {[key: string]: string}: The additional configurations
useCaseType string: The job-run use-case.

additional_configurations Mapping[str, str]: The additional configurations
use_case_type str: The job-run use-case.

additionalConfigurations Map<String>: The additional configurations
useCaseType String: The job-run use-case.

GetContainersFilter

Name string
Values List<string>
Regex bool

Name string
Values []string
Regex bool

name String
values List<String>
regex Boolean

name string
values string[]
regex boolean

name str
values Sequence[str]
regex bool

name String
values List<String>
regex Boolean

Package Details

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

Oracle Cloud Infrastructure v2.27.0 published on Thursday, Mar 20, 2025 by Pulumi

pulumi/pulumi-oci

oci.DataScience.getContainers

On this page

On this page

Example Usage

Using getContainers

getContainers Result

Supporting Types

GetContainersContainer

GetContainersContainerTagConfigurationList

GetContainersContainerWorkloadConfigurationDetailsList

GetContainersContainerWorkloadConfigurationDetailsListUseCaseConfiguration

GetContainersFilter

Package Details

On this page

On this page