1. Packages
  2. Vra Provider
  3. API Docs
  4. getStorageProfile
vra 0.12.0 published on Monday, Apr 14, 2025 by vmware

vra.getStorageProfile

Explore with Pulumi AI

vra logo
vra 0.12.0 published on Monday, Apr 14, 2025 by vmware

    Example Usage

    S

    This is an example of how to create a storage profile data source.

    Storage profile data source by its id:

    import * as pulumi from "@pulumi/pulumi";
    import * as vra from "@pulumi/vra";
    
    const _this = vra.getStorageProfile({
        id: vra_storage_profile["this"].id,
    });
    
    import pulumi
    import pulumi_vra as vra
    
    this = vra.get_storage_profile(id=vra_storage_profile["this"]["id"])
    
    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.LookupStorageProfile(ctx, &vra.LookupStorageProfileArgs{
    			Id: pulumi.StringRef(vra_storage_profile.This.Id),
    		}, 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.GetStorageProfile.Invoke(new()
        {
            Id = vra_storage_profile.This.Id,
        });
    
    });
    
    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.GetStorageProfileArgs;
    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.getStorageProfile(GetStorageProfileArgs.builder()
                .id(vra_storage_profile.this().id())
                .build());
    
        }
    }
    
    variables:
      this:
        fn::invoke:
          function: vra:getStorageProfile
          arguments:
            id: ${vra_storage_profile.this.id}
    

    Vra storage profile data source filter by external region id:

    import * as pulumi from "@pulumi/pulumi";
    import * as vra from "@pulumi/vra";
    
    const _this = vra.getStorageProfile({
        filter: "externalRegionId eq 'foobar'",
    });
    
    import pulumi
    import pulumi_vra as vra
    
    this = vra.get_storage_profile(filter="externalRegionId 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.LookupStorageProfile(ctx, &vra.LookupStorageProfileArgs{
    			Filter: pulumi.StringRef("externalRegionId 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.GetStorageProfile.Invoke(new()
        {
            Filter = "externalRegionId 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.GetStorageProfileArgs;
    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.getStorageProfile(GetStorageProfileArgs.builder()
                .filter("externalRegionId eq 'foobar'")
                .build());
    
        }
    }
    
    variables:
      this:
        fn::invoke:
          function: vra:getStorageProfile
          arguments:
            filter: externalRegionId eq 'foobar'
    

    A storage profile data source supports the following arguments:

    Using getStorageProfile

    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 getStorageProfile(args: GetStorageProfileArgs, opts?: InvokeOptions): Promise<GetStorageProfileResult>
    function getStorageProfileOutput(args: GetStorageProfileOutputArgs, opts?: InvokeOptions): Output<GetStorageProfileResult>
    def get_storage_profile(description: Optional[str] = None,
                            disk_properties: Optional[Mapping[str, str]] = None,
                            filter: Optional[str] = None,
                            id: Optional[str] = None,
                            tags: Optional[Sequence[GetStorageProfileTag]] = None,
                            opts: Optional[InvokeOptions] = None) -> GetStorageProfileResult
    def get_storage_profile_output(description: Optional[pulumi.Input[str]] = None,
                            disk_properties: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                            filter: Optional[pulumi.Input[str]] = None,
                            id: Optional[pulumi.Input[str]] = None,
                            tags: Optional[pulumi.Input[Sequence[pulumi.Input[GetStorageProfileTagArgs]]]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetStorageProfileResult]
    func LookupStorageProfile(ctx *Context, args *LookupStorageProfileArgs, opts ...InvokeOption) (*LookupStorageProfileResult, error)
    func LookupStorageProfileOutput(ctx *Context, args *LookupStorageProfileOutputArgs, opts ...InvokeOption) LookupStorageProfileResultOutput

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

    public static class GetStorageProfile 
    {
        public static Task<GetStorageProfileResult> InvokeAsync(GetStorageProfileArgs args, InvokeOptions? opts = null)
        public static Output<GetStorageProfileResult> Invoke(GetStorageProfileInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetStorageProfileResult> getStorageProfile(GetStorageProfileArgs args, InvokeOptions options)
    public static Output<GetStorageProfileResult> getStorageProfile(GetStorageProfileArgs args, InvokeOptions options)
    
    fn::invoke:
      function: vra:index/getStorageProfile:getStorageProfile
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Description string
    A human-friendly description.
    DiskProperties Dictionary<string, string>
    Map of storage properties that are to be applied on disk while provisioning.
    Filter string
    Filter query string that is supported by vRA multi-cloud IaaS API. Example: regionId eq '<regionId>' and cloudAccountId eq '<cloudAccountId>'.
    Id string
    The id of the image profile instance.
    Tags List<GetStorageProfileTag>
    A set of tag keys and optional values that were set on this Network Profile. example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    Description string
    A human-friendly description.
    DiskProperties map[string]string
    Map of storage properties that are to be applied on disk while provisioning.
    Filter string
    Filter query string that is supported by vRA multi-cloud IaaS API. Example: regionId eq '<regionId>' and cloudAccountId eq '<cloudAccountId>'.
    Id string
    The id of the image profile instance.
    Tags []GetStorageProfileTag
    A set of tag keys and optional values that were set on this Network Profile. example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    description String
    A human-friendly description.
    diskProperties Map<String,String>
    Map of storage properties that are to be applied on disk while provisioning.
    filter String
    Filter query string that is supported by vRA multi-cloud IaaS API. Example: regionId eq '<regionId>' and cloudAccountId eq '<cloudAccountId>'.
    id String
    The id of the image profile instance.
    tags List<GetStorageProfileTag>
    A set of tag keys and optional values that were set on this Network Profile. example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    description string
    A human-friendly description.
    diskProperties {[key: string]: string}
    Map of storage properties that are to be applied on disk while provisioning.
    filter string
    Filter query string that is supported by vRA multi-cloud IaaS API. Example: regionId eq '<regionId>' and cloudAccountId eq '<cloudAccountId>'.
    id string
    The id of the image profile instance.
    tags GetStorageProfileTag[]
    A set of tag keys and optional values that were set on this Network Profile. example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    description str
    A human-friendly description.
    disk_properties Mapping[str, str]
    Map of storage properties that are to be applied on disk while provisioning.
    filter str
    Filter query string that is supported by vRA multi-cloud IaaS API. Example: regionId eq '<regionId>' and cloudAccountId eq '<cloudAccountId>'.
    id str
    The id of the image profile instance.
    tags Sequence[GetStorageProfileTag]
    A set of tag keys and optional values that were set on this Network Profile. example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    description String
    A human-friendly description.
    diskProperties Map<String>
    Map of storage properties that are to be applied on disk while provisioning.
    filter String
    Filter query string that is supported by vRA multi-cloud IaaS API. Example: regionId eq '<regionId>' and cloudAccountId eq '<cloudAccountId>'.
    id String
    The id of the image profile instance.
    tags List<Property Map>
    A set of tag keys and optional values that were set on this Network Profile. example: [ { "key" : "ownedBy", "value": "Rainpole" } ]

    getStorageProfile Result

    The following output properties are available:

    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.
    DiskProperties Dictionary<string, string>
    ExternalRegionId string
    The id of the region as seen in the cloud provider for which this profile is defined.
    Id string
    Links List<GetStorageProfileLink>
    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.
    SupportsEncryption bool
    Indicates whether this storage profile supports encryption or not.
    UpdatedAt string
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    Description string
    Filter string
    Tags List<GetStorageProfileTag>
    A set of tag keys and optional values that were set on this Network Profile. example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    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.
    DiskProperties map[string]string
    ExternalRegionId string
    The id of the region as seen in the cloud provider for which this profile is defined.
    Id string
    Links []GetStorageProfileLink
    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.
    SupportsEncryption bool
    Indicates whether this storage profile supports encryption or not.
    UpdatedAt string
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    Description string
    Filter string
    Tags []GetStorageProfileTag
    A set of tag keys and optional values that were set on this Network Profile. example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    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.
    diskProperties Map<String,String>
    externalRegionId String
    The id of the region as seen in the cloud provider for which this profile is defined.
    id String
    links List<GetStorageProfileLink>
    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.
    supportsEncryption Boolean
    Indicates whether this storage profile supports encryption or not.
    updatedAt String
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    description String
    filter String
    tags List<GetStorageProfileTag>
    A set of tag keys and optional values that were set on this Network Profile. example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    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.
    diskProperties {[key: string]: string}
    externalRegionId string
    The id of the region as seen in the cloud provider for which this profile is defined.
    id string
    links GetStorageProfileLink[]
    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.
    supportsEncryption boolean
    Indicates whether this storage profile supports encryption or not.
    updatedAt string
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    description string
    filter string
    tags GetStorageProfileTag[]
    A set of tag keys and optional values that were set on this Network Profile. example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    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.
    disk_properties Mapping[str, str]
    external_region_id str
    The id of the region as seen in the cloud provider for which this profile is defined.
    id str
    links Sequence[GetStorageProfileLink]
    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.
    supports_encryption bool
    Indicates whether this storage profile supports encryption or not.
    updated_at str
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    description str
    filter str
    tags Sequence[GetStorageProfileTag]
    A set of tag keys and optional values that were set on this Network Profile. example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    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.
    diskProperties Map<String>
    externalRegionId String
    The id of the region as seen in the cloud provider for which this profile is defined.
    id String
    links List<Property Map>
    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.
    supportsEncryption Boolean
    Indicates whether this storage profile supports encryption or not.
    updatedAt String
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    description String
    filter String
    tags List<Property Map>
    A set of tag keys and optional values that were set on this Network Profile. example: [ { "key" : "ownedBy", "value": "Rainpole" } ]

    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

    GetStorageProfileTag

    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
    vra 0.12.0 published on Monday, Apr 14, 2025 by vmware