Oracle Cloud Infrastructure

Pulumi Official
Package maintained by Pulumi
v0.1.1 published on Tuesday, May 3, 2022 by Pulumi

getContainerImages

This data source provides the list of Container Images in Oracle Cloud Infrastructure Artifacts service.

List container images in a compartment.

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testContainerImages = Output.Create(Oci.Artifacts.GetContainerImages.InvokeAsync(new Oci.Artifacts.GetContainerImagesArgs
        {
            CompartmentId = @var.Compartment_id,
            CompartmentIdInSubtree = @var.Container_image_compartment_id_in_subtree,
            DisplayName = @var.Container_image_display_name,
            ImageId = oci_core_image.Test_image.Id,
            IsVersioned = @var.Container_image_is_versioned,
            RepositoryId = oci_artifacts_repository.Test_repository.Id,
            RepositoryName = oci_artifacts_repository.Test_repository.Name,
            State = @var.Container_image_state,
            Version = @var.Container_image_version,
        }));
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Artifacts.GetContainerImages(ctx, &artifacts.GetContainerImagesArgs{
			CompartmentId:          _var.Compartment_id,
			CompartmentIdInSubtree: pulumi.BoolRef(_var.Container_image_compartment_id_in_subtree),
			DisplayName:            pulumi.StringRef(_var.Container_image_display_name),
			ImageId:                pulumi.StringRef(oci_core_image.Test_image.Id),
			IsVersioned:            pulumi.BoolRef(_var.Container_image_is_versioned),
			RepositoryId:           pulumi.StringRef(oci_artifacts_repository.Test_repository.Id),
			RepositoryName:         pulumi.StringRef(oci_artifacts_repository.Test_repository.Name),
			State:                  pulumi.StringRef(_var.Container_image_state),
			Version:                pulumi.StringRef(_var.Container_image_version),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_container_images = oci.Artifacts.get_container_images(compartment_id=var["compartment_id"],
    compartment_id_in_subtree=var["container_image_compartment_id_in_subtree"],
    display_name=var["container_image_display_name"],
    image_id=oci_core_image["test_image"]["id"],
    is_versioned=var["container_image_is_versioned"],
    repository_id=oci_artifacts_repository["test_repository"]["id"],
    repository_name=oci_artifacts_repository["test_repository"]["name"],
    state=var["container_image_state"],
    version=var["container_image_version"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testContainerImages = oci.Artifacts.getContainerImages({
    compartmentId: _var.compartment_id,
    compartmentIdInSubtree: _var.container_image_compartment_id_in_subtree,
    displayName: _var.container_image_display_name,
    imageId: oci_core_image.test_image.id,
    isVersioned: _var.container_image_is_versioned,
    repositoryId: oci_artifacts_repository.test_repository.id,
    repositoryName: oci_artifacts_repository.test_repository.name,
    state: _var.container_image_state,
    version: _var.container_image_version,
});

Coming soon!

Using getContainerImages

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 getContainerImages(args: GetContainerImagesArgs, opts?: InvokeOptions): Promise<GetContainerImagesResult>
function getContainerImagesOutput(args: GetContainerImagesOutputArgs, opts?: InvokeOptions): Output<GetContainerImagesResult>
def get_container_images(compartment_id: Optional[str] = None,
                         compartment_id_in_subtree: Optional[bool] = None,
                         display_name: Optional[str] = None,
                         filters: Optional[Sequence[_artifacts.GetContainerImagesFilter]] = None,
                         image_id: Optional[str] = None,
                         is_versioned: Optional[bool] = None,
                         repository_id: Optional[str] = None,
                         repository_name: Optional[str] = None,
                         state: Optional[str] = None,
                         version: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetContainerImagesResult
def get_container_images_output(compartment_id: Optional[pulumi.Input[str]] = None,
                         compartment_id_in_subtree: Optional[pulumi.Input[bool]] = None,
                         display_name: Optional[pulumi.Input[str]] = None,
                         filters: Optional[pulumi.Input[Sequence[pulumi.Input[_artifacts.GetContainerImagesFilterArgs]]]] = None,
                         image_id: Optional[pulumi.Input[str]] = None,
                         is_versioned: Optional[pulumi.Input[bool]] = None,
                         repository_id: Optional[pulumi.Input[str]] = None,
                         repository_name: Optional[pulumi.Input[str]] = None,
                         state: Optional[pulumi.Input[str]] = None,
                         version: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetContainerImagesResult]
func GetContainerImages(ctx *Context, args *GetContainerImagesArgs, opts ...InvokeOption) (*GetContainerImagesResult, error)
func GetContainerImagesOutput(ctx *Context, args *GetContainerImagesOutputArgs, opts ...InvokeOption) GetContainerImagesResultOutput

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

public static class GetContainerImages 
{
    public static Task<GetContainerImagesResult> InvokeAsync(GetContainerImagesArgs args, InvokeOptions? opts = null)
    public static Output<GetContainerImagesResult> Invoke(GetContainerImagesInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetContainerImagesResult> getContainerImages(GetContainerImagesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: oci:Artifacts/getContainerImages:getContainerImages
  Arguments:
    # Arguments dictionary

The following arguments are supported:

CompartmentId string

The OCID of the compartment.

CompartmentIdInSubtree bool

When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are inspected depending on the the setting of accessLevel. Default is false. Can only be set to true when calling the API on the tenancy (root compartment).

DisplayName string

A filter to return only resources that match the given display name exactly.

Filters List<GetContainerImagesFilter>
ImageId string

A filter to return a container image summary only for the specified container image OCID.

IsVersioned bool

A filter to return container images based on whether there are any associated versions.

RepositoryId string

A filter to return container images only for the specified container repository OCID.

RepositoryName string

A filter to return container images or container image signatures that match the repository name. Example: foo or foo*

State string

A filter to return only resources that match the given lifecycle state name exactly.

Version string

A filter to return container images that match the version. Example: foo or foo*

CompartmentId string

The OCID of the compartment.

CompartmentIdInSubtree bool

When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are inspected depending on the the setting of accessLevel. Default is false. Can only be set to true when calling the API on the tenancy (root compartment).

DisplayName string

A filter to return only resources that match the given display name exactly.

Filters []GetContainerImagesFilter
ImageId string

A filter to return a container image summary only for the specified container image OCID.

IsVersioned bool

A filter to return container images based on whether there are any associated versions.

RepositoryId string

A filter to return container images only for the specified container repository OCID.

RepositoryName string

A filter to return container images or container image signatures that match the repository name. Example: foo or foo*

State string

A filter to return only resources that match the given lifecycle state name exactly.

Version string

A filter to return container images that match the version. Example: foo or foo*

compartmentId String

The OCID of the compartment.

compartmentIdInSubtree Boolean

When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are inspected depending on the the setting of accessLevel. Default is false. Can only be set to true when calling the API on the tenancy (root compartment).

displayName String

A filter to return only resources that match the given display name exactly.

filters List<GetContainerImagesFilter>
imageId String

A filter to return a container image summary only for the specified container image OCID.

isVersioned Boolean

A filter to return container images based on whether there are any associated versions.

repositoryId String

A filter to return container images only for the specified container repository OCID.

repositoryName String

A filter to return container images or container image signatures that match the repository name. Example: foo or foo*

state String

A filter to return only resources that match the given lifecycle state name exactly.

version String

A filter to return container images that match the version. Example: foo or foo*

compartmentId string

The OCID of the compartment.

compartmentIdInSubtree boolean

When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are inspected depending on the the setting of accessLevel. Default is false. Can only be set to true when calling the API on the tenancy (root compartment).

displayName string

A filter to return only resources that match the given display name exactly.

filters GetContainerImagesFilter[]
imageId string

A filter to return a container image summary only for the specified container image OCID.

isVersioned boolean

A filter to return container images based on whether there are any associated versions.

repositoryId string

A filter to return container images only for the specified container repository OCID.

repositoryName string

A filter to return container images or container image signatures that match the repository name. Example: foo or foo*

state string

A filter to return only resources that match the given lifecycle state name exactly.

version string

A filter to return container images that match the version. Example: foo or foo*

compartment_id str

The OCID of the compartment.

compartment_id_in_subtree bool

When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are inspected depending on the the setting of accessLevel. Default is false. Can only be set to true when calling the API on the tenancy (root compartment).

display_name str

A filter to return only resources that match the given display name exactly.

filters GetContainerImagesFilter]
image_id str

A filter to return a container image summary only for the specified container image OCID.

is_versioned bool

A filter to return container images based on whether there are any associated versions.

repository_id str

A filter to return container images only for the specified container repository OCID.

repository_name str

A filter to return container images or container image signatures that match the repository name. Example: foo or foo*

state str

A filter to return only resources that match the given lifecycle state name exactly.

version str

A filter to return container images that match the version. Example: foo or foo*

compartmentId String

The OCID of the compartment.

compartmentIdInSubtree Boolean

When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are inspected depending on the the setting of accessLevel. Default is false. Can only be set to true when calling the API on the tenancy (root compartment).

displayName String

A filter to return only resources that match the given display name exactly.

filters List<Property Map>
imageId String

A filter to return a container image summary only for the specified container image OCID.

isVersioned Boolean

A filter to return container images based on whether there are any associated versions.

repositoryId String

A filter to return container images only for the specified container repository OCID.

repositoryName String

A filter to return container images or container image signatures that match the repository name. Example: foo or foo*

state String

A filter to return only resources that match the given lifecycle state name exactly.

version String

A filter to return container images that match the version. Example: foo or foo*

getContainerImages Result

The following output properties are available:

CompartmentId string

The compartment OCID to which the container image belongs. Inferred from the container repository.

ContainerImageCollections List<GetContainerImagesContainerImageCollection>

The list of container_image_collection.

Id string

The provider-assigned unique ID for this managed resource.

CompartmentIdInSubtree bool
DisplayName string

The repository name and the most recent version associated with the image. If there are no versions associated with the image, then last known version and digest are used instead. If the last known version is unavailable, then 'unknown' is used instead of the version. Example: ubuntu:latest or ubuntu:latest@sha256:45b23dee08af5e43a7fea6c4cf9c25ccf269ee113168c19722f87876677c5cb2

Filters List<GetContainerImagesFilter>
ImageId string
IsVersioned bool
RepositoryId string

The OCID of the container repository.

RepositoryName string

The container repository name.

State string

The current state of the container image.

Version string

The version name.

CompartmentId string

The compartment OCID to which the container image belongs. Inferred from the container repository.

ContainerImageCollections []GetContainerImagesContainerImageCollection

The list of container_image_collection.

Id string

The provider-assigned unique ID for this managed resource.

CompartmentIdInSubtree bool
DisplayName string

The repository name and the most recent version associated with the image. If there are no versions associated with the image, then last known version and digest are used instead. If the last known version is unavailable, then 'unknown' is used instead of the version. Example: ubuntu:latest or ubuntu:latest@sha256:45b23dee08af5e43a7fea6c4cf9c25ccf269ee113168c19722f87876677c5cb2

Filters []GetContainerImagesFilter
ImageId string
IsVersioned bool
RepositoryId string

The OCID of the container repository.

RepositoryName string

The container repository name.

State string

The current state of the container image.

Version string

The version name.

compartmentId String

The compartment OCID to which the container image belongs. Inferred from the container repository.

containerImageCollections List<GetContainerImagesContainerImageCollection>

The list of container_image_collection.

id String

The provider-assigned unique ID for this managed resource.

compartmentIdInSubtree Boolean
displayName String

The repository name and the most recent version associated with the image. If there are no versions associated with the image, then last known version and digest are used instead. If the last known version is unavailable, then 'unknown' is used instead of the version. Example: ubuntu:latest or ubuntu:latest@sha256:45b23dee08af5e43a7fea6c4cf9c25ccf269ee113168c19722f87876677c5cb2

filters List<GetContainerImagesFilter>
imageId String
isVersioned Boolean
repositoryId String

The OCID of the container repository.

repositoryName String

The container repository name.

state String

The current state of the container image.

version String

The version name.

compartmentId string

The compartment OCID to which the container image belongs. Inferred from the container repository.

containerImageCollections GetContainerImagesContainerImageCollection[]

The list of container_image_collection.

id string

The provider-assigned unique ID for this managed resource.

compartmentIdInSubtree boolean
displayName string

The repository name and the most recent version associated with the image. If there are no versions associated with the image, then last known version and digest are used instead. If the last known version is unavailable, then 'unknown' is used instead of the version. Example: ubuntu:latest or ubuntu:latest@sha256:45b23dee08af5e43a7fea6c4cf9c25ccf269ee113168c19722f87876677c5cb2

filters GetContainerImagesFilter[]
imageId string
isVersioned boolean
repositoryId string

The OCID of the container repository.

repositoryName string

The container repository name.

state string

The current state of the container image.

version string

The version name.

compartment_id str

The compartment OCID to which the container image belongs. Inferred from the container repository.

container_image_collections GetContainerImagesContainerImageCollection]

The list of container_image_collection.

id str

The provider-assigned unique ID for this managed resource.

compartment_id_in_subtree bool
display_name str

The repository name and the most recent version associated with the image. If there are no versions associated with the image, then last known version and digest are used instead. If the last known version is unavailable, then 'unknown' is used instead of the version. Example: ubuntu:latest or ubuntu:latest@sha256:45b23dee08af5e43a7fea6c4cf9c25ccf269ee113168c19722f87876677c5cb2

filters GetContainerImagesFilter]
image_id str
is_versioned bool
repository_id str

The OCID of the container repository.

repository_name str

The container repository name.

state str

The current state of the container image.

version str

The version name.

compartmentId String

The compartment OCID to which the container image belongs. Inferred from the container repository.

containerImageCollections List<Property Map>

The list of container_image_collection.

id String

The provider-assigned unique ID for this managed resource.

compartmentIdInSubtree Boolean
displayName String

The repository name and the most recent version associated with the image. If there are no versions associated with the image, then last known version and digest are used instead. If the last known version is unavailable, then 'unknown' is used instead of the version. Example: ubuntu:latest or ubuntu:latest@sha256:45b23dee08af5e43a7fea6c4cf9c25ccf269ee113168c19722f87876677c5cb2

filters List<Property Map>
imageId String
isVersioned Boolean
repositoryId String

The OCID of the container repository.

repositoryName String

The container repository name.

state String

The current state of the container image.

version String

The version name.

Supporting Types

GetContainerImagesContainerImageCollection

GetContainerImagesContainerImageCollectionItem

CompartmentId string

The OCID of the compartment.

CreatedBy string

The OCID of the user or principal that pushed the version.

Digest string

The sha256 digest of the image layer.

DisplayName string

A filter to return only resources that match the given display name exactly.

Id string

The OCID of the container image. Example: ocid1.containerimage.oc1..exampleuniqueID

Layers List<GetContainerImagesContainerImageCollectionItemLayer>

Layers of which the image is composed, ordered by the layer digest.

LayersSizeInBytes string

The total size of the container image layers in bytes.

ManifestSizeInBytes int

The size of the container image manifest in bytes.

PullCount string

Total number of pulls.

RepositoryId string

A filter to return container images only for the specified container repository OCID.

RepositoryName string

A filter to return container images or container image signatures that match the repository name. Example: foo or foo*

State string

A filter to return only resources that match the given lifecycle state name exactly.

TimeCreated string

The creation time of the version.

TimeLastPulled string

An RFC 3339 timestamp indicating when the image was last pulled.

Version string

A filter to return container images that match the version. Example: foo or foo*

Versions List<GetContainerImagesContainerImageCollectionItemVersion>

The versions associated with this image.

CompartmentId string

The OCID of the compartment.

CreatedBy string

The OCID of the user or principal that pushed the version.

Digest string

The sha256 digest of the image layer.

DisplayName string

A filter to return only resources that match the given display name exactly.

Id string

The OCID of the container image. Example: ocid1.containerimage.oc1..exampleuniqueID

Layers []GetContainerImagesContainerImageCollectionItemLayer

Layers of which the image is composed, ordered by the layer digest.

LayersSizeInBytes string

The total size of the container image layers in bytes.

ManifestSizeInBytes int

The size of the container image manifest in bytes.

PullCount string

Total number of pulls.

RepositoryId string

A filter to return container images only for the specified container repository OCID.

RepositoryName string

A filter to return container images or container image signatures that match the repository name. Example: foo or foo*

State string

A filter to return only resources that match the given lifecycle state name exactly.

TimeCreated string

The creation time of the version.

TimeLastPulled string

An RFC 3339 timestamp indicating when the image was last pulled.

Version string

A filter to return container images that match the version. Example: foo or foo*

Versions []GetContainerImagesContainerImageCollectionItemVersion

The versions associated with this image.

compartmentId String

The OCID of the compartment.

createdBy String

The OCID of the user or principal that pushed the version.

digest String

The sha256 digest of the image layer.

displayName String

A filter to return only resources that match the given display name exactly.

id String

The OCID of the container image. Example: ocid1.containerimage.oc1..exampleuniqueID

layers List<GetContainerImagesContainerImageCollectionItemLayer>

Layers of which the image is composed, ordered by the layer digest.

layersSizeInBytes String

The total size of the container image layers in bytes.

manifestSizeInBytes Integer

The size of the container image manifest in bytes.

pullCount String

Total number of pulls.

repositoryId String

A filter to return container images only for the specified container repository OCID.

repositoryName String

A filter to return container images or container image signatures that match the repository name. Example: foo or foo*

state String

A filter to return only resources that match the given lifecycle state name exactly.

timeCreated String

The creation time of the version.

timeLastPulled String

An RFC 3339 timestamp indicating when the image was last pulled.

version String

A filter to return container images that match the version. Example: foo or foo*

versions List<GetContainerImagesContainerImageCollectionItemVersion>

The versions associated with this image.

compartmentId string

The OCID of the compartment.

createdBy string

The OCID of the user or principal that pushed the version.

digest string

The sha256 digest of the image layer.

displayName string

A filter to return only resources that match the given display name exactly.

id string

The OCID of the container image. Example: ocid1.containerimage.oc1..exampleuniqueID

layers GetContainerImagesContainerImageCollectionItemLayer[]

Layers of which the image is composed, ordered by the layer digest.

layersSizeInBytes string

The total size of the container image layers in bytes.

manifestSizeInBytes number

The size of the container image manifest in bytes.

pullCount string

Total number of pulls.

repositoryId string

A filter to return container images only for the specified container repository OCID.

repositoryName string

A filter to return container images or container image signatures that match the repository name. Example: foo or foo*

state string

A filter to return only resources that match the given lifecycle state name exactly.

timeCreated string

The creation time of the version.

timeLastPulled string

An RFC 3339 timestamp indicating when the image was last pulled.

version string

A filter to return container images that match the version. Example: foo or foo*

versions GetContainerImagesContainerImageCollectionItemVersion[]

The versions associated with this image.

compartment_id str

The OCID of the compartment.

created_by str

The OCID of the user or principal that pushed the version.

digest str

The sha256 digest of the image layer.

display_name str

A filter to return only resources that match the given display name exactly.

id str

The OCID of the container image. Example: ocid1.containerimage.oc1..exampleuniqueID

layers GetContainerImagesContainerImageCollectionItemLayer]

Layers of which the image is composed, ordered by the layer digest.

layers_size_in_bytes str

The total size of the container image layers in bytes.

manifest_size_in_bytes int

The size of the container image manifest in bytes.

pull_count str

Total number of pulls.

repository_id str

A filter to return container images only for the specified container repository OCID.

repository_name str

A filter to return container images or container image signatures that match the repository name. Example: foo or foo*

state str

A filter to return only resources that match the given lifecycle state name exactly.

time_created str

The creation time of the version.

time_last_pulled str

An RFC 3339 timestamp indicating when the image was last pulled.

version str

A filter to return container images that match the version. Example: foo or foo*

versions GetContainerImagesContainerImageCollectionItemVersion]

The versions associated with this image.

compartmentId String

The OCID of the compartment.

createdBy String

The OCID of the user or principal that pushed the version.

digest String

The sha256 digest of the image layer.

displayName String

A filter to return only resources that match the given display name exactly.

id String

The OCID of the container image. Example: ocid1.containerimage.oc1..exampleuniqueID

layers List<Property Map>

Layers of which the image is composed, ordered by the layer digest.

layersSizeInBytes String

The total size of the container image layers in bytes.

manifestSizeInBytes Number

The size of the container image manifest in bytes.

pullCount String

Total number of pulls.

repositoryId String

A filter to return container images only for the specified container repository OCID.

repositoryName String

A filter to return container images or container image signatures that match the repository name. Example: foo or foo*

state String

A filter to return only resources that match the given lifecycle state name exactly.

timeCreated String

The creation time of the version.

timeLastPulled String

An RFC 3339 timestamp indicating when the image was last pulled.

version String

A filter to return container images that match the version. Example: foo or foo*

versions List<Property Map>

The versions associated with this image.

GetContainerImagesContainerImageCollectionItemLayer

Digest string

The sha256 digest of the image layer.

SizeInBytes string

The size of the layer in bytes.

TimeCreated string

The creation time of the version.

Digest string

The sha256 digest of the image layer.

SizeInBytes string

The size of the layer in bytes.

TimeCreated string

The creation time of the version.

digest String

The sha256 digest of the image layer.

sizeInBytes String

The size of the layer in bytes.

timeCreated String

The creation time of the version.

digest string

The sha256 digest of the image layer.

sizeInBytes string

The size of the layer in bytes.

timeCreated string

The creation time of the version.

digest str

The sha256 digest of the image layer.

size_in_bytes str

The size of the layer in bytes.

time_created str

The creation time of the version.

digest String

The sha256 digest of the image layer.

sizeInBytes String

The size of the layer in bytes.

timeCreated String

The creation time of the version.

GetContainerImagesContainerImageCollectionItemVersion

CreatedBy string

The OCID of the user or principal that pushed the version.

TimeCreated string

The creation time of the version.

Version string

A filter to return container images that match the version. Example: foo or foo*

CreatedBy string

The OCID of the user or principal that pushed the version.

TimeCreated string

The creation time of the version.

Version string

A filter to return container images that match the version. Example: foo or foo*

createdBy String

The OCID of the user or principal that pushed the version.

timeCreated String

The creation time of the version.

version String

A filter to return container images that match the version. Example: foo or foo*

createdBy string

The OCID of the user or principal that pushed the version.

timeCreated string

The creation time of the version.

version string

A filter to return container images that match the version. Example: foo or foo*

created_by str

The OCID of the user or principal that pushed the version.

time_created str

The creation time of the version.

version str

A filter to return container images that match the version. Example: foo or foo*

createdBy String

The OCID of the user or principal that pushed the version.

timeCreated String

The creation time of the version.

version String

A filter to return container images that match the version. Example: foo or foo*

GetContainerImagesFilter

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
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.