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

vra.StorageProfile

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

    Create StorageProfile Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new StorageProfile(name: string, args: StorageProfileArgs, opts?: CustomResourceOptions);
    @overload
def StorageProfile(resource_name: str,
                   args: StorageProfileArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def StorageProfile(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   default_item: Optional[bool] = None,
                   region_id: Optional[str] = None,
                   description: Optional[str] = None,
                   disk_properties: Optional[Mapping[str, str]] = None,
                   disk_target_properties: Optional[Mapping[str, str]] = None,
                   name: Optional[str] = None,
                   storage_profile_id: Optional[str] = None,
                   supports_encryption: Optional[bool] = None,
                   tags: Optional[Sequence[StorageProfileTagArgs]] = None)
    func NewStorageProfile(ctx *Context, name string, args StorageProfileArgs, opts ...ResourceOption) (*StorageProfile, error)
    public StorageProfile(string name, StorageProfileArgs args, CustomResourceOptions? opts = null)
    public StorageProfile(String name, StorageProfileArgs args)
public StorageProfile(String name, StorageProfileArgs args, CustomResourceOptions options)

    type: vra:StorageProfile
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args StorageProfileArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args StorageProfileArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args StorageProfileArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StorageProfileArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StorageProfileArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var storageProfileResource = new Vra.StorageProfile("storageProfileResource", new()
{
    DefaultItem = false,
    RegionId = "string",
    Description = "string",
    DiskProperties = 
    {
        { "string", "string" },
    },
    DiskTargetProperties = 
    {
        { "string", "string" },
    },
    Name = "string",
    StorageProfileId = "string",
    SupportsEncryption = false,
    Tags = new[]
    {
        new Vra.Inputs.StorageProfileTagArgs
        {
            Key = "string",
            Value = "string",
        },
    },
});

    example, err := vra.NewStorageProfile(ctx, "storageProfileResource", &vra.StorageProfileArgs{
	DefaultItem: pulumi.Bool(false),
	RegionId:    pulumi.String("string"),
	Description: pulumi.String("string"),
	DiskProperties: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	DiskTargetProperties: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name:               pulumi.String("string"),
	StorageProfileId:   pulumi.String("string"),
	SupportsEncryption: pulumi.Bool(false),
	Tags: vra.StorageProfileTagArray{
		&vra.StorageProfileTagArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
})

    var storageProfileResource = new StorageProfile("storageProfileResource", StorageProfileArgs.builder()
    .defaultItem(false)
    .regionId("string")
    .description("string")
    .diskProperties(Map.of("string", "string"))
    .diskTargetProperties(Map.of("string", "string"))
    .name("string")
    .storageProfileId("string")
    .supportsEncryption(false)
    .tags(StorageProfileTagArgs.builder()
        .key("string")
        .value("string")
        .build())
    .build());

    storage_profile_resource = vra.StorageProfile("storageProfileResource",
    default_item=False,
    region_id="string",
    description="string",
    disk_properties={
        "string": "string",
    },
    disk_target_properties={
        "string": "string",
    },
    name="string",
    storage_profile_id="string",
    supports_encryption=False,
    tags=[{
        "key": "string",
        "value": "string",
    }])

    const storageProfileResource = new vra.StorageProfile("storageProfileResource", {
    defaultItem: false,
    regionId: "string",
    description: "string",
    diskProperties: {
        string: "string",
    },
    diskTargetProperties: {
        string: "string",
    },
    name: "string",
    storageProfileId: "string",
    supportsEncryption: false,
    tags: [{
        key: "string",
        value: "string",
    }],
});

    type: vra:StorageProfile
properties:
    defaultItem: false
    description: string
    diskProperties:
        string: string
    diskTargetProperties:
        string: string
    name: string
    regionId: string
    storageProfileId: string
    supportsEncryption: false
    tags:
        - key: string
          value: string

    StorageProfile Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The StorageProfile resource accepts the following input properties:

    DefaultItem bool
    Indicates if this storage profile is a default profile.
    RegionId string
    The id of the region for which this profile is defined as in VMware Aria Automation.
    Description string
    A human-friendly description.
    DiskProperties Dictionary<string, string>
    Map of storage properties that are to be applied on disk while provisioning.
    DiskTargetProperties Dictionary<string, string>
    Map of storage placements to know where the disk is provisioned.
    Name string
    A human-friendly name used as an identifier in APIs that support this option.
    StorageProfileId string
    SupportsEncryption bool
    Indicates whether this storage profile supports encryption or not.
    Tags List<StorageProfileTag>
    A set of tag keys and optional values that were set on this Network Profile. Example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    DefaultItem bool
    Indicates if this storage profile is a default profile.
    RegionId string
    The id of the region for which this profile is defined as in VMware Aria Automation.
    Description string
    A human-friendly description.
    DiskProperties map[string]string
    Map of storage properties that are to be applied on disk while provisioning.
    DiskTargetProperties map[string]string
    Map of storage placements to know where the disk is provisioned.
    Name string
    A human-friendly name used as an identifier in APIs that support this option.
    StorageProfileId string
    SupportsEncryption bool
    Indicates whether this storage profile supports encryption or not.
    Tags []StorageProfileTagArgs
    A set of tag keys and optional values that were set on this Network Profile. Example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    defaultItem Boolean
    Indicates if this storage profile is a default profile.
    regionId String
    The id of the region for which this profile is defined as in VMware Aria Automation.
    description String
    A human-friendly description.
    diskProperties Map<String,String>
    Map of storage properties that are to be applied on disk while provisioning.
    diskTargetProperties Map<String,String>
    Map of storage placements to know where the disk is provisioned.
    name String
    A human-friendly name used as an identifier in APIs that support this option.
    storageProfileId String
    supportsEncryption Boolean
    Indicates whether this storage profile supports encryption or not.
    tags List<StorageProfileTag>
    A set of tag keys and optional values that were set on this Network Profile. Example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    defaultItem boolean
    Indicates if this storage profile is a default profile.
    regionId string
    The id of the region for which this profile is defined as in VMware Aria Automation.
    description string
    A human-friendly description.
    diskProperties {[key: string]: string}
    Map of storage properties that are to be applied on disk while provisioning.
    diskTargetProperties {[key: string]: string}
    Map of storage placements to know where the disk is provisioned.
    name string
    A human-friendly name used as an identifier in APIs that support this option.
    storageProfileId string
    supportsEncryption boolean
    Indicates whether this storage profile supports encryption or not.
    tags StorageProfileTag[]
    A set of tag keys and optional values that were set on this Network Profile. Example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    default_item bool
    Indicates if this storage profile is a default profile.
    region_id str
    The id of the region for which this profile is defined as in VMware Aria Automation.
    description str
    A human-friendly description.
    disk_properties Mapping[str, str]
    Map of storage properties that are to be applied on disk while provisioning.
    disk_target_properties Mapping[str, str]
    Map of storage placements to know where the disk is provisioned.
    name str
    A human-friendly name used as an identifier in APIs that support this option.
    storage_profile_id str
    supports_encryption bool
    Indicates whether this storage profile supports encryption or not.
    tags Sequence[StorageProfileTagArgs]
    A set of tag keys and optional values that were set on this Network Profile. Example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    defaultItem Boolean
    Indicates if this storage profile is a default profile.
    regionId String
    The id of the region for which this profile is defined as in VMware Aria Automation.
    description String
    A human-friendly description.
    diskProperties Map<String>
    Map of storage properties that are to be applied on disk while provisioning.
    diskTargetProperties Map<String>
    Map of storage placements to know where the disk is provisioned.
    name String
    A human-friendly name used as an identifier in APIs that support this option.
    storageProfileId String
    supportsEncryption Boolean
    Indicates whether this storage profile supports encryption or not.
    tags List<Property Map>
    A set of tag keys and optional values that were set on this Network Profile. Example: [ { "key" : "ownedBy", "value": "Rainpole" } ]

    Outputs

    All input properties are implicitly available as output properties. Additionally, the StorageProfile resource produces the following output properties:

    CloudAccountId string
    Id of the cloud account this storage profile belongs to.
    CreatedAt string
    Date when the entity was created. The date is in ISO 6801 and UTC.
    ExternalRegionId string
    The id of the region as seen in the cloud provider for which this profile is defined.
    Id string
    The provider-assigned unique ID for this managed resource.
    Links List<StorageProfileLink>
    Hypermedia as the Engine of Application State (HATEOAS) of the entity.
    OrgId string
    The id of the organization this entity belongs to.
    Owner string
    Email of the user that owns the entity.
    UpdatedAt string
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    CloudAccountId string
    Id of the cloud account this storage profile belongs to.
    CreatedAt string
    Date when the entity was created. The date is in ISO 6801 and UTC.
    ExternalRegionId string
    The id of the region as seen in the cloud provider for which this profile is defined.
    Id string
    The provider-assigned unique ID for this managed resource.
    Links []StorageProfileLink
    Hypermedia as the Engine of Application State (HATEOAS) of the entity.
    OrgId string
    The id of the organization this entity belongs to.
    Owner string
    Email of the user that owns the entity.
    UpdatedAt string
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    cloudAccountId String
    Id of the cloud account this storage profile belongs to.
    createdAt String
    Date when the entity was created. The date is in ISO 6801 and UTC.
    externalRegionId String
    The id of the region as seen in the cloud provider for which this profile is defined.
    id String
    The provider-assigned unique ID for this managed resource.
    links List<StorageProfileLink>
    Hypermedia as the Engine of Application State (HATEOAS) of the entity.
    orgId String
    The id of the organization this entity belongs to.
    owner String
    Email of the user that owns the entity.
    updatedAt String
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    cloudAccountId string
    Id of the cloud account this storage profile belongs to.
    createdAt string
    Date when the entity was created. The date is in ISO 6801 and UTC.
    externalRegionId string
    The id of the region as seen in the cloud provider for which this profile is defined.
    id string
    The provider-assigned unique ID for this managed resource.
    links StorageProfileLink[]
    Hypermedia as the Engine of Application State (HATEOAS) of the entity.
    orgId string
    The id of the organization this entity belongs to.
    owner string
    Email of the user that owns the entity.
    updatedAt string
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    cloud_account_id str
    Id of the cloud account this storage profile belongs to.
    created_at str
    Date when the entity was created. The date is in ISO 6801 and UTC.
    external_region_id str
    The id of the region as seen in the cloud provider for which this profile is defined.
    id str
    The provider-assigned unique ID for this managed resource.
    links Sequence[StorageProfileLink]
    Hypermedia as the Engine of Application State (HATEOAS) of the entity.
    org_id str
    The id of the organization this entity belongs to.
    owner str
    Email of the user that owns the entity.
    updated_at str
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    cloudAccountId String
    Id of the cloud account this storage profile belongs to.
    createdAt String
    Date when the entity was created. The date is in ISO 6801 and UTC.
    externalRegionId String
    The id of the region as seen in the cloud provider for which this profile is defined.
    id String
    The provider-assigned unique ID for this managed resource.
    links List<Property Map>
    Hypermedia as the Engine of Application State (HATEOAS) of the entity.
    orgId String
    The id of the organization this entity belongs to.
    owner String
    Email of the user that owns the entity.
    updatedAt String
    Date when the entity was last updated. The date is ISO 8601 and UTC.

    Look up Existing StorageProfile Resource

    Get an existing StorageProfile resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: StorageProfileState, opts?: CustomResourceOptions): StorageProfile
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cloud_account_id: Optional[str] = None,
        created_at: Optional[str] = None,
        default_item: Optional[bool] = None,
        description: Optional[str] = None,
        disk_properties: Optional[Mapping[str, str]] = None,
        disk_target_properties: Optional[Mapping[str, str]] = None,
        external_region_id: Optional[str] = None,
        links: Optional[Sequence[StorageProfileLinkArgs]] = None,
        name: Optional[str] = None,
        org_id: Optional[str] = None,
        owner: Optional[str] = None,
        region_id: Optional[str] = None,
        storage_profile_id: Optional[str] = None,
        supports_encryption: Optional[bool] = None,
        tags: Optional[Sequence[StorageProfileTagArgs]] = None,
        updated_at: Optional[str] = None) -> StorageProfile
    func GetStorageProfile(ctx *Context, name string, id IDInput, state *StorageProfileState, opts ...ResourceOption) (*StorageProfile, error)
    public static StorageProfile Get(string name, Input<string> id, StorageProfileState? state, CustomResourceOptions? opts = null)
    public static StorageProfile get(String name, Output<String> id, StorageProfileState state, CustomResourceOptions options)
    resources:  _:    type: vra:StorageProfile    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CloudAccountId string
    Id of the cloud account this storage profile belongs to.
    CreatedAt string
    Date when the entity was created. The date is in ISO 6801 and UTC.
    DefaultItem bool
    Indicates if this storage profile is a default profile.
    Description string
    A human-friendly description.
    DiskProperties Dictionary<string, string>
    Map of storage properties that are to be applied on disk while provisioning.
    DiskTargetProperties Dictionary<string, string>
    Map of storage placements to know where the disk is provisioned.
    ExternalRegionId string
    The id of the region as seen in the cloud provider for which this profile is defined.
    Links List<StorageProfileLink>
    Hypermedia as the Engine of Application State (HATEOAS) of the entity.
    Name string
    A human-friendly name used as an identifier in APIs that support this option.
    OrgId string
    The id of the organization this entity belongs to.
    Owner string
    Email of the user that owns the entity.
    RegionId string
    The id of the region for which this profile is defined as in VMware Aria Automation.
    StorageProfileId string
    SupportsEncryption bool
    Indicates whether this storage profile supports encryption or not.
    Tags List<StorageProfileTag>
    A set of tag keys and optional values that were set on this Network Profile. Example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    UpdatedAt string
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    CloudAccountId string
    Id of the cloud account this storage profile belongs to.
    CreatedAt string
    Date when the entity was created. The date is in ISO 6801 and UTC.
    DefaultItem bool
    Indicates if this storage profile is a default profile.
    Description string
    A human-friendly description.
    DiskProperties map[string]string
    Map of storage properties that are to be applied on disk while provisioning.
    DiskTargetProperties map[string]string
    Map of storage placements to know where the disk is provisioned.
    ExternalRegionId string
    The id of the region as seen in the cloud provider for which this profile is defined.
    Links []StorageProfileLinkArgs
    Hypermedia as the Engine of Application State (HATEOAS) of the entity.
    Name string
    A human-friendly name used as an identifier in APIs that support this option.
    OrgId string
    The id of the organization this entity belongs to.
    Owner string
    Email of the user that owns the entity.
    RegionId string
    The id of the region for which this profile is defined as in VMware Aria Automation.
    StorageProfileId string
    SupportsEncryption bool
    Indicates whether this storage profile supports encryption or not.
    Tags []StorageProfileTagArgs
    A set of tag keys and optional values that were set on this Network Profile. Example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    UpdatedAt string
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    cloudAccountId String
    Id of the cloud account this storage profile belongs to.
    createdAt String
    Date when the entity was created. The date is in ISO 6801 and UTC.
    defaultItem Boolean
    Indicates if this storage profile is a default profile.
    description String
    A human-friendly description.
    diskProperties Map<String,String>
    Map of storage properties that are to be applied on disk while provisioning.
    diskTargetProperties Map<String,String>
    Map of storage placements to know where the disk is provisioned.
    externalRegionId String
    The id of the region as seen in the cloud provider for which this profile is defined.
    links List<StorageProfileLink>
    Hypermedia as the Engine of Application State (HATEOAS) of the entity.
    name String
    A human-friendly name used as an identifier in APIs that support this option.
    orgId String
    The id of the organization this entity belongs to.
    owner String
    Email of the user that owns the entity.
    regionId String
    The id of the region for which this profile is defined as in VMware Aria Automation.
    storageProfileId String
    supportsEncryption Boolean
    Indicates whether this storage profile supports encryption or not.
    tags List<StorageProfileTag>
    A set of tag keys and optional values that were set on this Network Profile. Example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    updatedAt String
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    cloudAccountId string
    Id of the cloud account this storage profile belongs to.
    createdAt string
    Date when the entity was created. The date is in ISO 6801 and UTC.
    defaultItem boolean
    Indicates if this storage profile is a default profile.
    description string
    A human-friendly description.
    diskProperties {[key: string]: string}
    Map of storage properties that are to be applied on disk while provisioning.
    diskTargetProperties {[key: string]: string}
    Map of storage placements to know where the disk is provisioned.
    externalRegionId string
    The id of the region as seen in the cloud provider for which this profile is defined.
    links StorageProfileLink[]
    Hypermedia as the Engine of Application State (HATEOAS) of the entity.
    name string
    A human-friendly name used as an identifier in APIs that support this option.
    orgId string
    The id of the organization this entity belongs to.
    owner string
    Email of the user that owns the entity.
    regionId string
    The id of the region for which this profile is defined as in VMware Aria Automation.
    storageProfileId string
    supportsEncryption boolean
    Indicates whether this storage profile supports encryption or not.
    tags StorageProfileTag[]
    A set of tag keys and optional values that were set on this Network Profile. Example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    updatedAt string
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    cloud_account_id str
    Id of the cloud account this storage profile belongs to.
    created_at str
    Date when the entity was created. The date is in ISO 6801 and UTC.
    default_item bool
    Indicates if this storage profile is a default profile.
    description str
    A human-friendly description.
    disk_properties Mapping[str, str]
    Map of storage properties that are to be applied on disk while provisioning.
    disk_target_properties Mapping[str, str]
    Map of storage placements to know where the disk is provisioned.
    external_region_id str
    The id of the region as seen in the cloud provider for which this profile is defined.
    links Sequence[StorageProfileLinkArgs]
    Hypermedia as the Engine of Application State (HATEOAS) of the entity.
    name str
    A human-friendly name used as an identifier in APIs that support this option.
    org_id str
    The id of the organization this entity belongs to.
    owner str
    Email of the user that owns the entity.
    region_id str
    The id of the region for which this profile is defined as in VMware Aria Automation.
    storage_profile_id str
    supports_encryption bool
    Indicates whether this storage profile supports encryption or not.
    tags Sequence[StorageProfileTagArgs]
    A set of tag keys and optional values that were set on this Network Profile. Example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    updated_at str
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    cloudAccountId String
    Id of the cloud account this storage profile belongs to.
    createdAt String
    Date when the entity was created. The date is in ISO 6801 and UTC.
    defaultItem Boolean
    Indicates if this storage profile is a default profile.
    description String
    A human-friendly description.
    diskProperties Map<String>
    Map of storage properties that are to be applied on disk while provisioning.
    diskTargetProperties Map<String>
    Map of storage placements to know where the disk is provisioned.
    externalRegionId String
    The id of the region as seen in the cloud provider for which this profile is defined.
    links List<Property Map>
    Hypermedia as the Engine of Application State (HATEOAS) of the entity.
    name String
    A human-friendly name used as an identifier in APIs that support this option.
    orgId String
    The id of the organization this entity belongs to.
    owner String
    Email of the user that owns the entity.
    regionId String
    The id of the region for which this profile is defined as in VMware Aria Automation.
    storageProfileId String
    supportsEncryption Boolean
    Indicates whether this storage profile supports encryption or not.
    tags List<Property Map>
    A set of tag keys and optional values that were set on this Network Profile. Example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    updatedAt String
    Date when the entity was last updated. The date is ISO 8601 and UTC.

    Supporting Types

    Href string
    Hrefs List<string>
    Rel string
    Href string
    Hrefs []string
    Rel string
    href String
    hrefs List<String>
    rel String
    href string
    hrefs string[]
    rel string
    href str
    hrefs Sequence[str]
    rel str
    href String
    hrefs List<String>
    rel String

    StorageProfileTag, StorageProfileTagArgs

    Key string
    Value string
    Key string
    Value string
    key String
    value String
    key string
    value string
    key str
    value str
    key String
    value String

    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.