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

vra.getBlueprint

Explore with Pulumi AI

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

    This data source provides information about a cloud template (blueprint) in vRA.

    Example Usage

    S

    This is an example of how to get a vRA cloud template by its name.

    import * as pulumi from "@pulumi/pulumi";
    import * as vra from "@pulumi/vra";
    
    const _this = vra.getBlueprint({
        name: vra_blueprint["this"].name,
    });
    
    import pulumi
    import pulumi_vra as vra
    
    this = vra.get_blueprint(name=vra_blueprint["this"]["name"])
    
    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.LookupBlueprint(ctx, &vra.LookupBlueprintArgs{
    			Name: pulumi.StringRef(vra_blueprint.This.Name),
    		}, 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.GetBlueprint.Invoke(new()
        {
            Name = vra_blueprint.This.Name,
        });
    
    });
    
    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.GetBlueprintArgs;
    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.getBlueprint(GetBlueprintArgs.builder()
                .name(vra_blueprint.this().name())
                .build());
    
        }
    }
    
    variables:
      this:
        fn::invoke:
          function: vra:getBlueprint
          arguments:
            name: ${vra_blueprint.this.name}
    

    This is an example of how to get a vRA cloud template by its id.

    import * as pulumi from "@pulumi/pulumi";
    import * as vra from "@pulumi/vra";
    
    const _this = vra.getBlueprint({
        id: vra_blueprint["this"].id,
    });
    
    import pulumi
    import pulumi_vra as vra
    
    this = vra.get_blueprint(id=vra_blueprint["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.LookupBlueprint(ctx, &vra.LookupBlueprintArgs{
    			Id: pulumi.StringRef(vra_blueprint.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.GetBlueprint.Invoke(new()
        {
            Id = vra_blueprint.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.GetBlueprintArgs;
    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.getBlueprint(GetBlueprintArgs.builder()
                .id(vra_blueprint.this().id())
                .build());
    
        }
    }
    
    variables:
      this:
        fn::invoke:
          function: vra:getBlueprint
          arguments:
            id: ${vra_blueprint.this.id}
    

    Using getBlueprint

    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 getBlueprint(args: GetBlueprintArgs, opts?: InvokeOptions): Promise<GetBlueprintResult>
    function getBlueprintOutput(args: GetBlueprintOutputArgs, opts?: InvokeOptions): Output<GetBlueprintResult>
    def get_blueprint(id: Optional[str] = None,
                      name: Optional[str] = None,
                      project_id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetBlueprintResult
    def get_blueprint_output(id: Optional[pulumi.Input[str]] = None,
                      name: Optional[pulumi.Input[str]] = None,
                      project_id: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetBlueprintResult]
    func LookupBlueprint(ctx *Context, args *LookupBlueprintArgs, opts ...InvokeOption) (*LookupBlueprintResult, error)
    func LookupBlueprintOutput(ctx *Context, args *LookupBlueprintOutputArgs, opts ...InvokeOption) LookupBlueprintResultOutput

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

    public static class GetBlueprint 
    {
        public static Task<GetBlueprintResult> InvokeAsync(GetBlueprintArgs args, InvokeOptions? opts = null)
        public static Output<GetBlueprintResult> Invoke(GetBlueprintInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetBlueprintResult> getBlueprint(GetBlueprintArgs args, InvokeOptions options)
    public static Output<GetBlueprintResult> getBlueprint(GetBlueprintArgs args, InvokeOptions options)
    
    fn::invoke:
      function: vra:index/getBlueprint:getBlueprint
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    The id of this cloud template. One of id or name must be provided.
    Name string
    Name of the cloud template. One of id or name must be provided.
    ProjectId string
    The id of the project to narrow the search while looking for cloud templates.
    Id string
    The id of this cloud template. One of id or name must be provided.
    Name string
    Name of the cloud template. One of id or name must be provided.
    ProjectId string
    The id of the project to narrow the search while looking for cloud templates.
    id String
    The id of this cloud template. One of id or name must be provided.
    name String
    Name of the cloud template. One of id or name must be provided.
    projectId String
    The id of the project to narrow the search while looking for cloud templates.
    id string
    The id of this cloud template. One of id or name must be provided.
    name string
    Name of the cloud template. One of id or name must be provided.
    projectId string
    The id of the project to narrow the search while looking for cloud templates.
    id str
    The id of this cloud template. One of id or name must be provided.
    name str
    Name of the cloud template. One of id or name must be provided.
    project_id str
    The id of the project to narrow the search while looking for cloud templates.
    id String
    The id of this cloud template. One of id or name must be provided.
    name String
    Name of the cloud template. One of id or name must be provided.
    projectId String
    The id of the project to narrow the search while looking for cloud templates.

    getBlueprint Result

    The following output properties are available:

    Content string
    Blueprint YAML content.
    ContentSourceId string
    The id of the content source.
    ContentSourcePath string
    Content source path.
    ContentSourceSyncAt string
    Content source last sync at.
    ContentSourceSyncMessages List<string>
    Content source last sync messages.
    ContentSourceSyncStatus string
    Content source last sync status. Supported values: SUCCESSFUL, FAILED.
    ContentSourceType string
    Content source type.
    CreatedAt string
    Date when the entity was created. The date is in ISO 6801 and UTC.
    CreatedBy string
    The user the entity was created by.
    Description string
    A human-friendly description.
    Id string
    Name string
    OrgId string
    The id of the organization this entity belongs to.
    ProjectId string
    ProjectName string
    The name of the project the entity belongs to.
    RequestScopeOrg bool
    Flag to indicate whether this blueprint can be requested from any project in the organization this entity belongs to.
    SelfLink string
    HATEOAS of the entity.
    Status string
    Status of the cloud template. Supported values: DRAFT, VERSIONED, RELEASED.
    TotalReleasedVersions double
    Total number of released versions.
    TotalVersions double
    Total number of versions.
    UpdatedAt string
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    UpdatedBy string
    The user the entity was last updated by.
    Valid bool
    Flag to indicate if the current content of the cloud template is valid.
    ValidationMessages List<GetBlueprintValidationMessage>
    List of validations messages.

    • message - Validation message.
    Content string
    Blueprint YAML content.
    ContentSourceId string
    The id of the content source.
    ContentSourcePath string
    Content source path.
    ContentSourceSyncAt string
    Content source last sync at.
    ContentSourceSyncMessages []string
    Content source last sync messages.
    ContentSourceSyncStatus string
    Content source last sync status. Supported values: SUCCESSFUL, FAILED.
    ContentSourceType string
    Content source type.
    CreatedAt string
    Date when the entity was created. The date is in ISO 6801 and UTC.
    CreatedBy string
    The user the entity was created by.
    Description string
    A human-friendly description.
    Id string
    Name string
    OrgId string
    The id of the organization this entity belongs to.
    ProjectId string
    ProjectName string
    The name of the project the entity belongs to.
    RequestScopeOrg bool
    Flag to indicate whether this blueprint can be requested from any project in the organization this entity belongs to.
    SelfLink string
    HATEOAS of the entity.
    Status string
    Status of the cloud template. Supported values: DRAFT, VERSIONED, RELEASED.
    TotalReleasedVersions float64
    Total number of released versions.
    TotalVersions float64
    Total number of versions.
    UpdatedAt string
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    UpdatedBy string
    The user the entity was last updated by.
    Valid bool
    Flag to indicate if the current content of the cloud template is valid.
    ValidationMessages []GetBlueprintValidationMessage
    List of validations messages.

    • message - Validation message.
    content String
    Blueprint YAML content.
    contentSourceId String
    The id of the content source.
    contentSourcePath String
    Content source path.
    contentSourceSyncAt String
    Content source last sync at.
    contentSourceSyncMessages List<String>
    Content source last sync messages.
    contentSourceSyncStatus String
    Content source last sync status. Supported values: SUCCESSFUL, FAILED.
    contentSourceType String
    Content source type.
    createdAt String
    Date when the entity was created. The date is in ISO 6801 and UTC.
    createdBy String
    The user the entity was created by.
    description String
    A human-friendly description.
    id String
    name String
    orgId String
    The id of the organization this entity belongs to.
    projectId String
    projectName String
    The name of the project the entity belongs to.
    requestScopeOrg Boolean
    Flag to indicate whether this blueprint can be requested from any project in the organization this entity belongs to.
    selfLink String
    HATEOAS of the entity.
    status String
    Status of the cloud template. Supported values: DRAFT, VERSIONED, RELEASED.
    totalReleasedVersions Double
    Total number of released versions.
    totalVersions Double
    Total number of versions.
    updatedAt String
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    updatedBy String
    The user the entity was last updated by.
    valid Boolean
    Flag to indicate if the current content of the cloud template is valid.
    validationMessages List<GetBlueprintValidationMessage>
    List of validations messages.

    • message - Validation message.
    content string
    Blueprint YAML content.
    contentSourceId string
    The id of the content source.
    contentSourcePath string
    Content source path.
    contentSourceSyncAt string
    Content source last sync at.
    contentSourceSyncMessages string[]
    Content source last sync messages.
    contentSourceSyncStatus string
    Content source last sync status. Supported values: SUCCESSFUL, FAILED.
    contentSourceType string
    Content source type.
    createdAt string
    Date when the entity was created. The date is in ISO 6801 and UTC.
    createdBy string
    The user the entity was created by.
    description string
    A human-friendly description.
    id string
    name string
    orgId string
    The id of the organization this entity belongs to.
    projectId string
    projectName string
    The name of the project the entity belongs to.
    requestScopeOrg boolean
    Flag to indicate whether this blueprint can be requested from any project in the organization this entity belongs to.
    selfLink string
    HATEOAS of the entity.
    status string
    Status of the cloud template. Supported values: DRAFT, VERSIONED, RELEASED.
    totalReleasedVersions number
    Total number of released versions.
    totalVersions number
    Total number of versions.
    updatedAt string
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    updatedBy string
    The user the entity was last updated by.
    valid boolean
    Flag to indicate if the current content of the cloud template is valid.
    validationMessages GetBlueprintValidationMessage[]
    List of validations messages.

    • message - Validation message.
    content str
    Blueprint YAML content.
    content_source_id str
    The id of the content source.
    content_source_path str
    Content source path.
    content_source_sync_at str
    Content source last sync at.
    content_source_sync_messages Sequence[str]
    Content source last sync messages.
    content_source_sync_status str
    Content source last sync status. Supported values: SUCCESSFUL, FAILED.
    content_source_type str
    Content source type.
    created_at str
    Date when the entity was created. The date is in ISO 6801 and UTC.
    created_by str
    The user the entity was created by.
    description str
    A human-friendly description.
    id str
    name str
    org_id str
    The id of the organization this entity belongs to.
    project_id str
    project_name str
    The name of the project the entity belongs to.
    request_scope_org bool
    Flag to indicate whether this blueprint can be requested from any project in the organization this entity belongs to.
    self_link str
    HATEOAS of the entity.
    status str
    Status of the cloud template. Supported values: DRAFT, VERSIONED, RELEASED.
    total_released_versions float
    Total number of released versions.
    total_versions float
    Total number of versions.
    updated_at str
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    updated_by str
    The user the entity was last updated by.
    valid bool
    Flag to indicate if the current content of the cloud template is valid.
    validation_messages Sequence[GetBlueprintValidationMessage]
    List of validations messages.

    • message - Validation message.
    content String
    Blueprint YAML content.
    contentSourceId String
    The id of the content source.
    contentSourcePath String
    Content source path.
    contentSourceSyncAt String
    Content source last sync at.
    contentSourceSyncMessages List<String>
    Content source last sync messages.
    contentSourceSyncStatus String
    Content source last sync status. Supported values: SUCCESSFUL, FAILED.
    contentSourceType String
    Content source type.
    createdAt String
    Date when the entity was created. The date is in ISO 6801 and UTC.
    createdBy String
    The user the entity was created by.
    description String
    A human-friendly description.
    id String
    name String
    orgId String
    The id of the organization this entity belongs to.
    projectId String
    projectName String
    The name of the project the entity belongs to.
    requestScopeOrg Boolean
    Flag to indicate whether this blueprint can be requested from any project in the organization this entity belongs to.
    selfLink String
    HATEOAS of the entity.
    status String
    Status of the cloud template. Supported values: DRAFT, VERSIONED, RELEASED.
    totalReleasedVersions Number
    Total number of released versions.
    totalVersions Number
    Total number of versions.
    updatedAt String
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    updatedBy String
    The user the entity was last updated by.
    valid Boolean
    Flag to indicate if the current content of the cloud template is valid.
    validationMessages List<Property Map>
    List of validations messages.

    • message - Validation message.

    Supporting Types

    GetBlueprintValidationMessage

    Message string
    Metadata Dictionary<string, string>
    Path string
    ResourceName string
    Type string
    Message string
    Metadata map[string]string
    Path string
    ResourceName string
    Type string
    message String
    metadata Map<String,String>
    path String
    resourceName String
    type String
    message string
    metadata {[key: string]: string}
    path string
    resourceName string
    type string
    message str
    metadata Mapping[str, str]
    path str
    resource_name str
    type str
    message String
    metadata Map<String>
    path String
    resourceName String
    type 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