aquasec.getImage

Explore with Pulumi AI

Aquasec v0.8.27 published on Monday, Jan 29, 2024 by Pulumiverse

Using getImage

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 getImage(args: GetImageArgs, opts?: InvokeOptions): Promise<GetImageResult>
function getImageOutput(args: GetImageOutputArgs, opts?: InvokeOptions): Output<GetImageResult>

def get_image(registry: Optional[str] = None,
              repository: Optional[str] = None,
              tag: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetImageResult
def get_image_output(registry: Optional[pulumi.Input[str]] = None,
              repository: Optional[pulumi.Input[str]] = None,
              tag: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetImageResult]

func LookupImage(ctx *Context, args *LookupImageArgs, opts ...InvokeOption) (*LookupImageResult, error)
func LookupImageOutput(ctx *Context, args *LookupImageOutputArgs, opts ...InvokeOption) LookupImageResultOutput

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

public static class GetImage 
{
    public static Task<GetImageResult> InvokeAsync(GetImageArgs args, InvokeOptions? opts = null)
    public static Output<GetImageResult> Invoke(GetImageInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetImageResult> getImage(GetImageArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aquasec:index/getImage:getImage
  arguments:
    # arguments dictionary

The following arguments are supported:

Registry string
Repository string
Tag string: The tag of the image.

Registry string
Repository string
Tag string: The tag of the image.

registry String
repository String
tag String: The tag of the image.

registry string
repository string
tag string: The tag of the image.

registry str
repository str
tag str: The tag of the image.

registry String
repository String
tag String: The tag of the image.

getImage Result

The following output properties are available:

Architecture string: The image architecture.
AssuranceChecksPerformeds List<Pulumiverse.Aquasec.Outputs.GetImageAssuranceChecksPerformed>: The list of image assurance checks performed on the image.
Author string: The name of the user who registered the image.
Blacklisted bool: Whether the image is blacklisted.
Comment string: The image creation comment.
Created string: The date and time when the image was registered.
CriticalVulnerabilities int: Number of critical severity vulnerabilities detected in the image.
DefaultUser string: The default user of the image.
Digest string: The content digest of the image.
Disallowed bool: Whether the image is disallowed (non-compliant).
DisallowedByAssuranceChecks bool: Whether the image was disallowed because of Image Assurance Policies.
DockerId string: The Docker image ID.
DockerLabels List<string>: Docker labels of the image.
DockerVersion string: The Docker version used when building the image.
DtaSeverityScore string: DTA severity score.
DtaSkipped bool: If DTA was skipped.
DtaSkippedReason string: The reason why DTA was skipped.
EnvironmentVariables List<string>: Environment variables in the image.
HighVulnerabilities int: Number of high severity vulnerabilities detected in the image.
Histories List<Pulumiverse.Aquasec.Outputs.GetImageHistory>: The Docker history of the image.
Id string: The provider-assigned unique ID for this managed resource.
ImageSize int: The size of the image in bytes.
ImageType string: The type of the image.
Labels List<string>: Aqua labels of the image.
LowVulnerabilities int: Number of low severity vulnerabilities detected in the image.
Malware int: Number of malware found on the image.
MediumVulnerabilities int: Number of medium severity vulnerabilities detected in the image.
Name string: The name of the image.
NegligibleVulnerabilities int: Number of negligible severity vulnerabilities detected in the image.
NewerImageExists bool: Whether a new version of the image is available in the registry but is not scanned and registered yet.
Os string: The operating system detected in the image
OsVersion string: The version of the OS detected in the image.
Parent string: The ID of the parent image.
PartialResults bool: Whether the image could only be partially scanned.
PendingDisallowed bool: Whether the image is non-compliant, but is pending this status due to running containers.
Permission string: Permission of the image.
PermissionAuthor string: The name of the user who last modified the image permissions.
PermissionComment string: The comment provided when the image permissions were last modified
Registry string: The name of the registry where the image is stored.
RegistryType string: Type of the registry.
RepoDigests List<string>: The repository digests.
Repository string: The name of the image's repository.
ScanDate string: The date and time when the image was last scanned.
ScanError string: If the image scan failed, the failure message.
ScanStatus string: The scan status of the image (either 'pending', 'inprogress', 'finished', 'failed' or 'notstarted').
SensitiveData int: Number of sensitive data detected in the image.
Tag string: The tag of the image.
TotalVulnerabilities int: The total number of vulnerabilities detected in the image.
VirtualSize int: The virtual size of the image.
Vulnerabilities List<Pulumiverse.Aquasec.Outputs.GetImageVulnerability>: A list of all the vulnerabilities found in the image
Whitelisted bool: Whether the image is whitelisted.

Architecture string: The image architecture.
AssuranceChecksPerformeds []GetImageAssuranceChecksPerformed: The list of image assurance checks performed on the image.
Author string: The name of the user who registered the image.
Blacklisted bool: Whether the image is blacklisted.
Comment string: The image creation comment.
Created string: The date and time when the image was registered.
CriticalVulnerabilities int: Number of critical severity vulnerabilities detected in the image.
DefaultUser string: The default user of the image.
Digest string: The content digest of the image.
Disallowed bool: Whether the image is disallowed (non-compliant).
DisallowedByAssuranceChecks bool: Whether the image was disallowed because of Image Assurance Policies.
DockerId string: The Docker image ID.
DockerLabels []string: Docker labels of the image.
DockerVersion string: The Docker version used when building the image.
DtaSeverityScore string: DTA severity score.
DtaSkipped bool: If DTA was skipped.
DtaSkippedReason string: The reason why DTA was skipped.
EnvironmentVariables []string: Environment variables in the image.
HighVulnerabilities int: Number of high severity vulnerabilities detected in the image.
Histories []GetImageHistory: The Docker history of the image.
Id string: The provider-assigned unique ID for this managed resource.
ImageSize int: The size of the image in bytes.
ImageType string: The type of the image.
Labels []string: Aqua labels of the image.
LowVulnerabilities int: Number of low severity vulnerabilities detected in the image.
Malware int: Number of malware found on the image.
MediumVulnerabilities int: Number of medium severity vulnerabilities detected in the image.
Name string: The name of the image.
NegligibleVulnerabilities int: Number of negligible severity vulnerabilities detected in the image.
NewerImageExists bool: Whether a new version of the image is available in the registry but is not scanned and registered yet.
Os string: The operating system detected in the image
OsVersion string: The version of the OS detected in the image.
Parent string: The ID of the parent image.
PartialResults bool: Whether the image could only be partially scanned.
PendingDisallowed bool: Whether the image is non-compliant, but is pending this status due to running containers.
Permission string: Permission of the image.
PermissionAuthor string: The name of the user who last modified the image permissions.
PermissionComment string: The comment provided when the image permissions were last modified
Registry string: The name of the registry where the image is stored.
RegistryType string: Type of the registry.
RepoDigests []string: The repository digests.
Repository string: The name of the image's repository.
ScanDate string: The date and time when the image was last scanned.
ScanError string: If the image scan failed, the failure message.
ScanStatus string: The scan status of the image (either 'pending', 'inprogress', 'finished', 'failed' or 'notstarted').
SensitiveData int: Number of sensitive data detected in the image.
Tag string: The tag of the image.
TotalVulnerabilities int: The total number of vulnerabilities detected in the image.
VirtualSize int: The virtual size of the image.
Vulnerabilities []GetImageVulnerability: A list of all the vulnerabilities found in the image
Whitelisted bool: Whether the image is whitelisted.

architecture String: The image architecture.
assuranceChecksPerformeds List<GetImageAssuranceChecksPerformed>: The list of image assurance checks performed on the image.
author String: The name of the user who registered the image.
blacklisted Boolean: Whether the image is blacklisted.
comment String: The image creation comment.
created String: The date and time when the image was registered.
criticalVulnerabilities Integer: Number of critical severity vulnerabilities detected in the image.
defaultUser String: The default user of the image.
digest String: The content digest of the image.
disallowed Boolean: Whether the image is disallowed (non-compliant).
disallowedByAssuranceChecks Boolean: Whether the image was disallowed because of Image Assurance Policies.
dockerId String: The Docker image ID.
dockerLabels List<String>: Docker labels of the image.
dockerVersion String: The Docker version used when building the image.
dtaSeverityScore String: DTA severity score.
dtaSkipped Boolean: If DTA was skipped.
dtaSkippedReason String: The reason why DTA was skipped.
environmentVariables List<String>: Environment variables in the image.
highVulnerabilities Integer: Number of high severity vulnerabilities detected in the image.
histories List<GetImageHistory>: The Docker history of the image.
id String: The provider-assigned unique ID for this managed resource.
imageSize Integer: The size of the image in bytes.
imageType String: The type of the image.
labels List<String>: Aqua labels of the image.
lowVulnerabilities Integer: Number of low severity vulnerabilities detected in the image.
malware Integer: Number of malware found on the image.
mediumVulnerabilities Integer: Number of medium severity vulnerabilities detected in the image.
name String: The name of the image.
negligibleVulnerabilities Integer: Number of negligible severity vulnerabilities detected in the image.
newerImageExists Boolean: Whether a new version of the image is available in the registry but is not scanned and registered yet.
os String: The operating system detected in the image
osVersion String: The version of the OS detected in the image.
parent String: The ID of the parent image.
partialResults Boolean: Whether the image could only be partially scanned.
pendingDisallowed Boolean: Whether the image is non-compliant, but is pending this status due to running containers.
permission String: Permission of the image.
permissionAuthor String: The name of the user who last modified the image permissions.
permissionComment String: The comment provided when the image permissions were last modified
registry String: The name of the registry where the image is stored.
registryType String: Type of the registry.
repoDigests List<String>: The repository digests.
repository String: The name of the image's repository.
scanDate String: The date and time when the image was last scanned.
scanError String: If the image scan failed, the failure message.
scanStatus String: The scan status of the image (either 'pending', 'inprogress', 'finished', 'failed' or 'notstarted').
sensitiveData Integer: Number of sensitive data detected in the image.
tag String: The tag of the image.
totalVulnerabilities Integer: The total number of vulnerabilities detected in the image.
virtualSize Integer: The virtual size of the image.
vulnerabilities List<GetImageVulnerability>: A list of all the vulnerabilities found in the image
whitelisted Boolean: Whether the image is whitelisted.

architecture string: The image architecture.
assuranceChecksPerformeds GetImageAssuranceChecksPerformed[]: The list of image assurance checks performed on the image.
author string: The name of the user who registered the image.
blacklisted boolean: Whether the image is blacklisted.
comment string: The image creation comment.
created string: The date and time when the image was registered.
criticalVulnerabilities number: Number of critical severity vulnerabilities detected in the image.
defaultUser string: The default user of the image.
digest string: The content digest of the image.
disallowed boolean: Whether the image is disallowed (non-compliant).
disallowedByAssuranceChecks boolean: Whether the image was disallowed because of Image Assurance Policies.
dockerId string: The Docker image ID.
dockerLabels string[]: Docker labels of the image.
dockerVersion string: The Docker version used when building the image.
dtaSeverityScore string: DTA severity score.
dtaSkipped boolean: If DTA was skipped.
dtaSkippedReason string: The reason why DTA was skipped.
environmentVariables string[]: Environment variables in the image.
highVulnerabilities number: Number of high severity vulnerabilities detected in the image.
histories GetImageHistory[]: The Docker history of the image.
id string: The provider-assigned unique ID for this managed resource.
imageSize number: The size of the image in bytes.
imageType string: The type of the image.
labels string[]: Aqua labels of the image.
lowVulnerabilities number: Number of low severity vulnerabilities detected in the image.
malware number: Number of malware found on the image.
mediumVulnerabilities number: Number of medium severity vulnerabilities detected in the image.
name string: The name of the image.
negligibleVulnerabilities number: Number of negligible severity vulnerabilities detected in the image.
newerImageExists boolean: Whether a new version of the image is available in the registry but is not scanned and registered yet.
os string: The operating system detected in the image
osVersion string: The version of the OS detected in the image.
parent string: The ID of the parent image.
partialResults boolean: Whether the image could only be partially scanned.
pendingDisallowed boolean: Whether the image is non-compliant, but is pending this status due to running containers.
permission string: Permission of the image.
permissionAuthor string: The name of the user who last modified the image permissions.
permissionComment string: The comment provided when the image permissions were last modified
registry string: The name of the registry where the image is stored.
registryType string: Type of the registry.
repoDigests string[]: The repository digests.
repository string: The name of the image's repository.
scanDate string: The date and time when the image was last scanned.
scanError string: If the image scan failed, the failure message.
scanStatus string: The scan status of the image (either 'pending', 'inprogress', 'finished', 'failed' or 'notstarted').
sensitiveData number: Number of sensitive data detected in the image.
tag string: The tag of the image.
totalVulnerabilities number: The total number of vulnerabilities detected in the image.
virtualSize number: The virtual size of the image.
vulnerabilities GetImageVulnerability[]: A list of all the vulnerabilities found in the image
whitelisted boolean: Whether the image is whitelisted.

architecture str: The image architecture.
assurance_checks_performeds Sequence[GetImageAssuranceChecksPerformed]: The list of image assurance checks performed on the image.
author str: The name of the user who registered the image.
blacklisted bool: Whether the image is blacklisted.
comment str: The image creation comment.
created str: The date and time when the image was registered.
critical_vulnerabilities int: Number of critical severity vulnerabilities detected in the image.
default_user str: The default user of the image.
digest str: The content digest of the image.
disallowed bool: Whether the image is disallowed (non-compliant).
disallowed_by_assurance_checks bool: Whether the image was disallowed because of Image Assurance Policies.
docker_id str: The Docker image ID.
docker_labels Sequence[str]: Docker labels of the image.
docker_version str: The Docker version used when building the image.
dta_severity_score str: DTA severity score.
dta_skipped bool: If DTA was skipped.
dta_skipped_reason str: The reason why DTA was skipped.
environment_variables Sequence[str]: Environment variables in the image.
high_vulnerabilities int: Number of high severity vulnerabilities detected in the image.
histories Sequence[GetImageHistory]: The Docker history of the image.
id str: The provider-assigned unique ID for this managed resource.
image_size int: The size of the image in bytes.
image_type str: The type of the image.
labels Sequence[str]: Aqua labels of the image.
low_vulnerabilities int: Number of low severity vulnerabilities detected in the image.
malware int: Number of malware found on the image.
medium_vulnerabilities int: Number of medium severity vulnerabilities detected in the image.
name str: The name of the image.
negligible_vulnerabilities int: Number of negligible severity vulnerabilities detected in the image.
newer_image_exists bool: Whether a new version of the image is available in the registry but is not scanned and registered yet.
os str: The operating system detected in the image
os_version str: The version of the OS detected in the image.
parent str: The ID of the parent image.
partial_results bool: Whether the image could only be partially scanned.
pending_disallowed bool: Whether the image is non-compliant, but is pending this status due to running containers.
permission str: Permission of the image.
permission_author str: The name of the user who last modified the image permissions.
permission_comment str: The comment provided when the image permissions were last modified
registry str: The name of the registry where the image is stored.
registry_type str: Type of the registry.
repo_digests Sequence[str]: The repository digests.
repository str: The name of the image's repository.
scan_date str: The date and time when the image was last scanned.
scan_error str: If the image scan failed, the failure message.
scan_status str: The scan status of the image (either 'pending', 'inprogress', 'finished', 'failed' or 'notstarted').
sensitive_data int: Number of sensitive data detected in the image.
tag str: The tag of the image.
total_vulnerabilities int: The total number of vulnerabilities detected in the image.
virtual_size int: The virtual size of the image.
vulnerabilities Sequence[GetImageVulnerability]: A list of all the vulnerabilities found in the image
whitelisted bool: Whether the image is whitelisted.

architecture String: The image architecture.
assuranceChecksPerformeds List<Property Map>: The list of image assurance checks performed on the image.
author String: The name of the user who registered the image.
blacklisted Boolean: Whether the image is blacklisted.
comment String: The image creation comment.
created String: The date and time when the image was registered.
criticalVulnerabilities Number: Number of critical severity vulnerabilities detected in the image.
defaultUser String: The default user of the image.
digest String: The content digest of the image.
disallowed Boolean: Whether the image is disallowed (non-compliant).
disallowedByAssuranceChecks Boolean: Whether the image was disallowed because of Image Assurance Policies.
dockerId String: The Docker image ID.
dockerLabels List<String>: Docker labels of the image.
dockerVersion String: The Docker version used when building the image.
dtaSeverityScore String: DTA severity score.
dtaSkipped Boolean: If DTA was skipped.
dtaSkippedReason String: The reason why DTA was skipped.
environmentVariables List<String>: Environment variables in the image.
highVulnerabilities Number: Number of high severity vulnerabilities detected in the image.
histories List<Property Map>: The Docker history of the image.
id String: The provider-assigned unique ID for this managed resource.
imageSize Number: The size of the image in bytes.
imageType String: The type of the image.
labels List<String>: Aqua labels of the image.
lowVulnerabilities Number: Number of low severity vulnerabilities detected in the image.
malware Number: Number of malware found on the image.
mediumVulnerabilities Number: Number of medium severity vulnerabilities detected in the image.
name String: The name of the image.
negligibleVulnerabilities Number: Number of negligible severity vulnerabilities detected in the image.
newerImageExists Boolean: Whether a new version of the image is available in the registry but is not scanned and registered yet.
os String: The operating system detected in the image
osVersion String: The version of the OS detected in the image.
parent String: The ID of the parent image.
partialResults Boolean: Whether the image could only be partially scanned.
pendingDisallowed Boolean: Whether the image is non-compliant, but is pending this status due to running containers.
permission String: Permission of the image.
permissionAuthor String: The name of the user who last modified the image permissions.
permissionComment String: The comment provided when the image permissions were last modified
registry String: The name of the registry where the image is stored.
registryType String: Type of the registry.
repoDigests List<String>: The repository digests.
repository String: The name of the image's repository.
scanDate String: The date and time when the image was last scanned.
scanError String: If the image scan failed, the failure message.
scanStatus String: The scan status of the image (either 'pending', 'inprogress', 'finished', 'failed' or 'notstarted').
sensitiveData Number: Number of sensitive data detected in the image.
tag String: The tag of the image.
totalVulnerabilities Number: The total number of vulnerabilities detected in the image.
virtualSize Number: The virtual size of the image.
vulnerabilities List<Property Map>: A list of all the vulnerabilities found in the image
whitelisted Boolean: Whether the image is whitelisted.