1. Packages
  2. Vra Provider
  3. API Docs
  4. getImageProfile
Viewing docs for vra 0.17.0
published on Tuesday, Mar 10, 2026 by vmware
Schema (JSON)
vmware/terraform-provider-vra

vra.getImageProfile

vra logo
Viewing docs for vra 0.17.0
published on Tuesday, Mar 10, 2026 by vmware
Schema (JSON)
vmware/terraform-provider-vra

    Example Usage

    S

    This is an example of how to read an image profile as data source.

    Image profile data source by its id:

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

const _this = vra.getImageProfile({
    filter: "name eq 'foobar'",
});

    import pulumi
import pulumi_vra as vra

this = vra.get_image_profile(filter="name eq 'foobar'")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/vra/vra"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vra.LookupImageProfile(ctx, &vra.LookupImageProfileArgs{
			Filter: pulumi.StringRef("name eq 'foobar'"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vra = Pulumi.Vra;

return await Deployment.RunAsync(() => 
{
    var @this = Vra.GetImageProfile.Invoke(new()
    {
        Filter = "name eq 'foobar'",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vra.VraFunctions;
import com.pulumi.vra.inputs.GetImageProfileArgs;
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 this = VraFunctions.getImageProfile(GetImageProfileArgs.builder()
            .filter("name eq 'foobar'")
            .build());

    }
}

    variables:
  this:
    fn::invoke:
      function: vra:getImageProfile
      arguments:
        filter: name eq 'foobar'

    image profile data source filter by region id:

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

const _this = vra.getImageProfile({
    regionId: thisVraImageProfile.regionId,
});

    import pulumi
import pulumi_vra as vra

this = vra.get_image_profile(region_id=this_vra_image_profile["regionId"])

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/vra/vra"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vra.LookupImageProfile(ctx, &vra.LookupImageProfileArgs{
			RegionId: pulumi.StringRef(thisVraImageProfile.RegionId),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vra = Pulumi.Vra;

return await Deployment.RunAsync(() => 
{
    var @this = Vra.GetImageProfile.Invoke(new()
    {
        RegionId = thisVraImageProfile.RegionId,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vra.VraFunctions;
import com.pulumi.vra.inputs.GetImageProfileArgs;
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 this = VraFunctions.getImageProfile(GetImageProfileArgs.builder()
            .regionId(thisVraImageProfile.regionId())
            .build());

    }
}

    variables:
  this:
    fn::invoke:
      function: vra:getImageProfile
      arguments:
        regionId: ${thisVraImageProfile.regionId}

    An image profile data source supports the following arguments:

    Using getImageProfile

    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 getImageProfile(args: GetImageProfileArgs, opts?: InvokeOptions): Promise<GetImageProfileResult>
function getImageProfileOutput(args: GetImageProfileOutputArgs, opts?: InvokeOptions): Output<GetImageProfileResult>
    def get_image_profile(description: Optional[str] = None,
                      filter: Optional[str] = None,
                      id: Optional[str] = None,
                      image_mappings: Optional[Sequence[GetImageProfileImageMapping]] = None,
                      name: Optional[str] = None,
                      region_id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetImageProfileResult
def get_image_profile_output(description: Optional[pulumi.Input[str]] = None,
                      filter: Optional[pulumi.Input[str]] = None,
                      id: Optional[pulumi.Input[str]] = None,
                      image_mappings: Optional[pulumi.Input[Sequence[pulumi.Input[GetImageProfileImageMappingArgs]]]] = None,
                      name: Optional[pulumi.Input[str]] = None,
                      region_id: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetImageProfileResult]
    func LookupImageProfile(ctx *Context, args *LookupImageProfileArgs, opts ...InvokeOption) (*LookupImageProfileResult, error)
func LookupImageProfileOutput(ctx *Context, args *LookupImageProfileOutputArgs, opts ...InvokeOption) LookupImageProfileResultOutput

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

    public static class GetImageProfile 
{
    public static Task<GetImageProfileResult> InvokeAsync(GetImageProfileArgs args, InvokeOptions? opts = null)
    public static Output<GetImageProfileResult> Invoke(GetImageProfileInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetImageProfileResult> getImageProfile(GetImageProfileArgs args, InvokeOptions options)
public static Output<GetImageProfileResult> getImageProfile(GetImageProfileArgs args, InvokeOptions options)

    fn::invoke:
  function: vra:index/getImageProfile:getImageProfile
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Description string
    A human-friendly description.
    Filter string
    Filter query string that is supported by VMware Aria Automation multi-cloud IaaS API. Example: regionId eq '<regionId>' and cloudAccountId eq '<cloudAccountId>'.
    Id string
    The id of the image profile instance.
    ImageMappings List<GetImageProfileImageMapping>
    Image mapping defined for the corresponding region.
    Name string
    A human-friendly name used as an identifier in APIs that support this option.
    RegionId string
    The id of the region for which this profile is defined as in VMware Aria Automation.
    Description string
    A human-friendly description.
    Filter string
    Filter query string that is supported by VMware Aria Automation multi-cloud IaaS API. Example: regionId eq '<regionId>' and cloudAccountId eq '<cloudAccountId>'.
    Id string
    The id of the image profile instance.
    ImageMappings []GetImageProfileImageMapping
    Image mapping defined for the corresponding region.
    Name string
    A human-friendly name used as an identifier in APIs that support this option.
    RegionId string
    The id of the region for which this profile is defined as in VMware Aria Automation.
    description String
    A human-friendly description.
    filter String
    Filter query string that is supported by VMware Aria Automation multi-cloud IaaS API. Example: regionId eq '<regionId>' and cloudAccountId eq '<cloudAccountId>'.
    id String
    The id of the image profile instance.
    imageMappings List<GetImageProfileImageMapping>
    Image mapping defined for the corresponding region.
    name String
    A human-friendly name used as an identifier in APIs that support this option.
    regionId String
    The id of the region for which this profile is defined as in VMware Aria Automation.
    description string
    A human-friendly description.
    filter string
    Filter query string that is supported by VMware Aria Automation multi-cloud IaaS API. Example: regionId eq '<regionId>' and cloudAccountId eq '<cloudAccountId>'.
    id string
    The id of the image profile instance.
    imageMappings GetImageProfileImageMapping[]
    Image mapping defined for the corresponding region.
    name string
    A human-friendly name used as an identifier in APIs that support this option.
    regionId string
    The id of the region for which this profile is defined as in VMware Aria Automation.
    description str
    A human-friendly description.
    filter str
    Filter query string that is supported by VMware Aria Automation multi-cloud IaaS API. Example: regionId eq '<regionId>' and cloudAccountId eq '<cloudAccountId>'.
    id str
    The id of the image profile instance.
    image_mappings Sequence[GetImageProfileImageMapping]
    Image mapping defined for the corresponding region.
    name str
    A human-friendly name used as an identifier in APIs that support this option.
    region_id str
    The id of the region for which this profile is defined as in VMware Aria Automation.
    description String
    A human-friendly description.
    filter String
    Filter query string that is supported by VMware Aria Automation multi-cloud IaaS API. Example: regionId eq '<regionId>' and cloudAccountId eq '<cloudAccountId>'.
    id String
    The id of the image profile instance.
    imageMappings List<Property Map>
    Image mapping defined for the corresponding region.
    name String
    A human-friendly name used as an identifier in APIs that support this option.
    regionId String
    The id of the region for which this profile is defined as in VMware Aria Automation.

    getImageProfile Result

    The following output properties are available:

    CreatedAt string
    Date when the entity was created. The date is in ISO 6801 and UTC.
    ExternalRegionId string
    The external regionId of the resource.
    Id string
    Name string
    Owner string
    Email of the user that owns the entity.
    RegionId string
    UpdatedAt string
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    Description string
    A human-friendly description.
    Filter string
    ImageMappings List<GetImageProfileImageMapping>
    Image mapping defined for the corresponding region.
    CreatedAt string
    Date when the entity was created. The date is in ISO 6801 and UTC.
    ExternalRegionId string
    The external regionId of the resource.
    Id string
    Name string
    Owner string
    Email of the user that owns the entity.
    RegionId string
    UpdatedAt string
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    Description string
    A human-friendly description.
    Filter string
    ImageMappings []GetImageProfileImageMapping
    Image mapping defined for the corresponding region.
    createdAt String
    Date when the entity was created. The date is in ISO 6801 and UTC.
    externalRegionId String
    The external regionId of the resource.
    id String
    name String
    owner String
    Email of the user that owns the entity.
    regionId String
    updatedAt String
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    description String
    A human-friendly description.
    filter String
    imageMappings List<GetImageProfileImageMapping>
    Image mapping defined for the corresponding region.
    createdAt string
    Date when the entity was created. The date is in ISO 6801 and UTC.
    externalRegionId string
    The external regionId of the resource.
    id string
    name string
    owner string
    Email of the user that owns the entity.
    regionId string
    updatedAt string
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    description string
    A human-friendly description.
    filter string
    imageMappings GetImageProfileImageMapping[]
    Image mapping defined for the corresponding region.
    created_at str
    Date when the entity was created. The date is in ISO 6801 and UTC.
    external_region_id str
    The external regionId of the resource.
    id str
    name str
    owner str
    Email of the user that owns the entity.
    region_id str
    updated_at str
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    description str
    A human-friendly description.
    filter str
    image_mappings Sequence[GetImageProfileImageMapping]
    Image mapping defined for the corresponding region.
    createdAt String
    Date when the entity was created. The date is in ISO 6801 and UTC.
    externalRegionId String
    The external regionId of the resource.
    id String
    name String
    owner String
    Email of the user that owns the entity.
    regionId String
    updatedAt String
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    description String
    A human-friendly description.
    filter String
    imageMappings List<Property Map>
    Image mapping defined for the corresponding region.

    Supporting Types

    GetImageProfileImageMapping

    Description string
    A human-friendly description.
    ExternalId string
    External entity id on the cloud provider side.
    ExternalRegionId string
    The external regionId of the resource.
    Name string
    A human-friendly name used as an identifier in APIs that support this option.
    Organization string
    A human-friendly description.
    OsFamily string
    Operating system family of the image.
    Owner string
    Email of the user that owns the entity.
    Private bool
    Indicates whether this fabric image is private. For vSphere, private images are considered to be templates and snapshots and public are Content Library items.
    CloudConfig string
    Cloud config for this image. This cloud config will be merged during provisioning with other cloud configurations such as the bootConfig provided in MachineSpecification or vRA cloud templates.
    Constraints List<GetImageProfileImageMappingConstraint>
    Constraints that are used to drive placement policies for entities such as image, network, storage, etc. Constraint expressions are matched against tags on existing placement targets.
    ImageId string
    The id of this resource instance.
    ImageName string
    A human-friendly image name as seen on the cloud provider side.
    Description string
    A human-friendly description.
    ExternalId string
    External entity id on the cloud provider side.
    ExternalRegionId string
    The external regionId of the resource.
    Name string
    A human-friendly name used as an identifier in APIs that support this option.
    Organization string
    A human-friendly description.
    OsFamily string
    Operating system family of the image.
    Owner string
    Email of the user that owns the entity.
    Private bool
    Indicates whether this fabric image is private. For vSphere, private images are considered to be templates and snapshots and public are Content Library items.
    CloudConfig string
    Cloud config for this image. This cloud config will be merged during provisioning with other cloud configurations such as the bootConfig provided in MachineSpecification or vRA cloud templates.
    Constraints []GetImageProfileImageMappingConstraint
    Constraints that are used to drive placement policies for entities such as image, network, storage, etc. Constraint expressions are matched against tags on existing placement targets.
    ImageId string
    The id of this resource instance.
    ImageName string
    A human-friendly image name as seen on the cloud provider side.
    description String
    A human-friendly description.
    externalId String
    External entity id on the cloud provider side.
    externalRegionId String
    The external regionId of the resource.
    name String
    A human-friendly name used as an identifier in APIs that support this option.
    organization String
    A human-friendly description.
    osFamily String
    Operating system family of the image.
    owner String
    Email of the user that owns the entity.
    private_ Boolean
    Indicates whether this fabric image is private. For vSphere, private images are considered to be templates and snapshots and public are Content Library items.
    cloudConfig String
    Cloud config for this image. This cloud config will be merged during provisioning with other cloud configurations such as the bootConfig provided in MachineSpecification or vRA cloud templates.
    constraints List<GetImageProfileImageMappingConstraint>
    Constraints that are used to drive placement policies for entities such as image, network, storage, etc. Constraint expressions are matched against tags on existing placement targets.
    imageId String
    The id of this resource instance.
    imageName String
    A human-friendly image name as seen on the cloud provider side.
    description string
    A human-friendly description.
    externalId string
    External entity id on the cloud provider side.
    externalRegionId string
    The external regionId of the resource.
    name string
    A human-friendly name used as an identifier in APIs that support this option.
    organization string
    A human-friendly description.
    osFamily string
    Operating system family of the image.
    owner string
    Email of the user that owns the entity.
    private boolean
    Indicates whether this fabric image is private. For vSphere, private images are considered to be templates and snapshots and public are Content Library items.
    cloudConfig string
    Cloud config for this image. This cloud config will be merged during provisioning with other cloud configurations such as the bootConfig provided in MachineSpecification or vRA cloud templates.
    constraints GetImageProfileImageMappingConstraint[]
    Constraints that are used to drive placement policies for entities such as image, network, storage, etc. Constraint expressions are matched against tags on existing placement targets.
    imageId string
    The id of this resource instance.
    imageName string
    A human-friendly image name as seen on the cloud provider side.
    description str
    A human-friendly description.
    external_id str
    External entity id on the cloud provider side.
    external_region_id str
    The external regionId of the resource.
    name str
    A human-friendly name used as an identifier in APIs that support this option.
    organization str
    A human-friendly description.
    os_family str
    Operating system family of the image.
    owner str
    Email of the user that owns the entity.
    private bool
    Indicates whether this fabric image is private. For vSphere, private images are considered to be templates and snapshots and public are Content Library items.
    cloud_config str
    Cloud config for this image. This cloud config will be merged during provisioning with other cloud configurations such as the bootConfig provided in MachineSpecification or vRA cloud templates.
    constraints Sequence[GetImageProfileImageMappingConstraint]
    Constraints that are used to drive placement policies for entities such as image, network, storage, etc. Constraint expressions are matched against tags on existing placement targets.
    image_id str
    The id of this resource instance.
    image_name str
    A human-friendly image name as seen on the cloud provider side.
    description String
    A human-friendly description.
    externalId String
    External entity id on the cloud provider side.
    externalRegionId String
    The external regionId of the resource.
    name String
    A human-friendly name used as an identifier in APIs that support this option.
    organization String
    A human-friendly description.
    osFamily String
    Operating system family of the image.
    owner String
    Email of the user that owns the entity.
    private Boolean
    Indicates whether this fabric image is private. For vSphere, private images are considered to be templates and snapshots and public are Content Library items.
    cloudConfig String
    Cloud config for this image. This cloud config will be merged during provisioning with other cloud configurations such as the bootConfig provided in MachineSpecification or vRA cloud templates.
    constraints List<Property Map>
    Constraints that are used to drive placement policies for entities such as image, network, storage, etc. Constraint expressions are matched against tags on existing placement targets.
    imageId String
    The id of this resource instance.
    imageName String
    A human-friendly image name as seen on the cloud provider side.

    GetImageProfileImageMappingConstraint

    Expression string
    An expression of the form "[!]tag-key[:[tag-value]]", used to indicate a constraint match on keys and values of tags.
    Mandatory bool
    Indicates whether this constraint should be strictly enforced or not.
    Expression string
    An expression of the form "[!]tag-key[:[tag-value]]", used to indicate a constraint match on keys and values of tags.
    Mandatory bool
    Indicates whether this constraint should be strictly enforced or not.
    expression String
    An expression of the form "[!]tag-key[:[tag-value]]", used to indicate a constraint match on keys and values of tags.
    mandatory Boolean
    Indicates whether this constraint should be strictly enforced or not.
    expression string
    An expression of the form "[!]tag-key[:[tag-value]]", used to indicate a constraint match on keys and values of tags.
    mandatory boolean
    Indicates whether this constraint should be strictly enforced or not.
    expression str
    An expression of the form "[!]tag-key[:[tag-value]]", used to indicate a constraint match on keys and values of tags.
    mandatory bool
    Indicates whether this constraint should be strictly enforced or not.
    expression String
    An expression of the form "[!]tag-key[:[tag-value]]", used to indicate a constraint match on keys and values of tags.
    mandatory Boolean
    Indicates whether this constraint should be strictly enforced or not.

    Package Details

    Repository
    vra vmware/terraform-provider-vra
    License
    Notes
    This Pulumi package is based on the vra Terraform Provider.
    vra logo
    Viewing docs for vra 0.17.0
    published on Tuesday, Mar 10, 2026 by vmware
    Schema (JSON)
    vmware/terraform-provider-vra
      Try Pulumi Cloud free. Your team will thank you.