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

vra.getPolicyLease

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

    The following examples shows how to lookup for a lease policy:

    Lease policy data source by its id:

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

const _this = vra.getPolicyLease({
    id: vraLeasePolicyId,
});

    import pulumi
import pulumi_vra as vra

this = vra.get_policy_lease(id=vra_lease_policy_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.LookupPolicyLease(ctx, &vra.LookupPolicyLeaseArgs{
			Id: pulumi.StringRef(vraLeasePolicyId),
		}, 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.GetPolicyLease.Invoke(new()
    {
        Id = vraLeasePolicyId,
    });

});

    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.GetPolicyLeaseArgs;
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.getPolicyLease(GetPolicyLeaseArgs.builder()
            .id(vraLeasePolicyId)
            .build());

    }
}

    variables:
  this:
    fn::invoke:
      function: vra:getPolicyLease
      arguments:
        id: ${vraLeasePolicyId}

    Lease policy data source by name search:

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

const _this = vra.getPolicyLease({
    search: vraLeasePolicySearchName,
});

    import pulumi
import pulumi_vra as vra

this = vra.get_policy_lease(search=vra_lease_policy_search_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.LookupPolicyLease(ctx, &vra.LookupPolicyLeaseArgs{
			Search: pulumi.StringRef(vraLeasePolicySearchName),
		}, 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.GetPolicyLease.Invoke(new()
    {
        Search = vraLeasePolicySearchName,
    });

});

    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.GetPolicyLeaseArgs;
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.getPolicyLease(GetPolicyLeaseArgs.builder()
            .search(vraLeasePolicySearchName)
            .build());

    }
}

    variables:
  this:
    fn::invoke:
      function: vra:getPolicyLease
      arguments:
        search: ${vraLeasePolicySearchName}

    Using getPolicyLease

    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 getPolicyLease(args: GetPolicyLeaseArgs, opts?: InvokeOptions): Promise<GetPolicyLeaseResult>
function getPolicyLeaseOutput(args: GetPolicyLeaseOutputArgs, opts?: InvokeOptions): Output<GetPolicyLeaseResult>
    def get_policy_lease(id: Optional[str] = None,
                     search: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetPolicyLeaseResult
def get_policy_lease_output(id: Optional[pulumi.Input[str]] = None,
                     search: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetPolicyLeaseResult]
    func LookupPolicyLease(ctx *Context, args *LookupPolicyLeaseArgs, opts ...InvokeOption) (*LookupPolicyLeaseResult, error)
func LookupPolicyLeaseOutput(ctx *Context, args *LookupPolicyLeaseOutputArgs, opts ...InvokeOption) LookupPolicyLeaseResultOutput

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

    public static class GetPolicyLease 
{
    public static Task<GetPolicyLeaseResult> InvokeAsync(GetPolicyLeaseArgs args, InvokeOptions? opts = null)
    public static Output<GetPolicyLeaseResult> Invoke(GetPolicyLeaseInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPolicyLeaseResult> getPolicyLease(GetPolicyLeaseArgs args, InvokeOptions options)
public static Output<GetPolicyLeaseResult> getPolicyLease(GetPolicyLeaseArgs args, InvokeOptions options)

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

    The following arguments are supported:

    Id string
    The id of the policy instance.
    Search string

    Search criteria to narrow down the policy instance.

    Note: One of id or search must be specified.

    Id string
    The id of the policy instance.
    Search string

    Search criteria to narrow down the policy instance.

    Note: One of id or search must be specified.

    id String
    The id of the policy instance.
    search String

    Search criteria to narrow down the policy instance.

    Note: One of id or search must be specified.

    id string
    The id of the policy instance.
    search string

    Search criteria to narrow down the policy instance.

    Note: One of id or search must be specified.

    id str
    The id of the policy instance.
    search str

    Search criteria to narrow down the policy instance.

    Note: One of id or search must be specified.

    id String
    The id of the policy instance.
    search String

    Search criteria to narrow down the policy instance.

    Note: One of id or search must be specified.

    getPolicyLease Result

    The following output properties are available:

    CreatedAt string
    Date when the entity was created. The date is in ISO 8601 and UTC.
    CreatedBy string
    The user the entity was created by.
    Criterias List<ImmutableDictionary<string, string>>
    The policy criteria.
    Description string
    A human-friendly description for the policy instance.
    EnforcementType string
    The type of enforcement for the policy.
    Id string
    LastUpdatedAt string
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    LastUpdatedBy string
    The user the entity was last updated by.
    LeaseGrace double
    The duration in days that an expired object should be held before it is deleted.
    LeaseTermMax double
    The maximum duration in days between creation (or renewal) and expiration.
    LeaseTotalTermMax double
    The maximum duration in days between creation and expiration. Unaffected by renewal.
    Name string
    A human-friendly name used as an identifier for the policy instance.
    OrgId string
    The id of the organization this entity belongs to.
    ProjectCriterias List<ImmutableDictionary<string, string>>
    The project based criteria.
    ProjectId string
    The id of the project this entity belongs to.
    Search string
    CreatedAt string
    Date when the entity was created. The date is in ISO 8601 and UTC.
    CreatedBy string
    The user the entity was created by.
    Criterias []map[string]string
    The policy criteria.
    Description string
    A human-friendly description for the policy instance.
    EnforcementType string
    The type of enforcement for the policy.
    Id string
    LastUpdatedAt string
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    LastUpdatedBy string
    The user the entity was last updated by.
    LeaseGrace float64
    The duration in days that an expired object should be held before it is deleted.
    LeaseTermMax float64
    The maximum duration in days between creation (or renewal) and expiration.
    LeaseTotalTermMax float64
    The maximum duration in days between creation and expiration. Unaffected by renewal.
    Name string
    A human-friendly name used as an identifier for the policy instance.
    OrgId string
    The id of the organization this entity belongs to.
    ProjectCriterias []map[string]string
    The project based criteria.
    ProjectId string
    The id of the project this entity belongs to.
    Search string
    createdAt String
    Date when the entity was created. The date is in ISO 8601 and UTC.
    createdBy String
    The user the entity was created by.
    criterias List<Map<String,String>>
    The policy criteria.
    description String
    A human-friendly description for the policy instance.
    enforcementType String
    The type of enforcement for the policy.
    id String
    lastUpdatedAt String
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    lastUpdatedBy String
    The user the entity was last updated by.
    leaseGrace Double
    The duration in days that an expired object should be held before it is deleted.
    leaseTermMax Double
    The maximum duration in days between creation (or renewal) and expiration.
    leaseTotalTermMax Double
    The maximum duration in days between creation and expiration. Unaffected by renewal.
    name String
    A human-friendly name used as an identifier for the policy instance.
    orgId String
    The id of the organization this entity belongs to.
    projectCriterias List<Map<String,String>>
    The project based criteria.
    projectId String
    The id of the project this entity belongs to.
    search String
    createdAt string
    Date when the entity was created. The date is in ISO 8601 and UTC.
    createdBy string
    The user the entity was created by.
    criterias {[key: string]: string}[]
    The policy criteria.
    description string
    A human-friendly description for the policy instance.
    enforcementType string
    The type of enforcement for the policy.
    id string
    lastUpdatedAt string
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    lastUpdatedBy string
    The user the entity was last updated by.
    leaseGrace number
    The duration in days that an expired object should be held before it is deleted.
    leaseTermMax number
    The maximum duration in days between creation (or renewal) and expiration.
    leaseTotalTermMax number
    The maximum duration in days between creation and expiration. Unaffected by renewal.
    name string
    A human-friendly name used as an identifier for the policy instance.
    orgId string
    The id of the organization this entity belongs to.
    projectCriterias {[key: string]: string}[]
    The project based criteria.
    projectId string
    The id of the project this entity belongs to.
    search string
    created_at str
    Date when the entity was created. The date is in ISO 8601 and UTC.
    created_by str
    The user the entity was created by.
    criterias Sequence[Mapping[str, str]]
    The policy criteria.
    description str
    A human-friendly description for the policy instance.
    enforcement_type str
    The type of enforcement for the policy.
    id str
    last_updated_at str
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    last_updated_by str
    The user the entity was last updated by.
    lease_grace float
    The duration in days that an expired object should be held before it is deleted.
    lease_term_max float
    The maximum duration in days between creation (or renewal) and expiration.
    lease_total_term_max float
    The maximum duration in days between creation and expiration. Unaffected by renewal.
    name str
    A human-friendly name used as an identifier for the policy instance.
    org_id str
    The id of the organization this entity belongs to.
    project_criterias Sequence[Mapping[str, str]]
    The project based criteria.
    project_id str
    The id of the project this entity belongs to.
    search str
    createdAt String
    Date when the entity was created. The date is in ISO 8601 and UTC.
    createdBy String
    The user the entity was created by.
    criterias List<Map<String>>
    The policy criteria.
    description String
    A human-friendly description for the policy instance.
    enforcementType String
    The type of enforcement for the policy.
    id String
    lastUpdatedAt String
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    lastUpdatedBy String
    The user the entity was last updated by.
    leaseGrace Number
    The duration in days that an expired object should be held before it is deleted.
    leaseTermMax Number
    The maximum duration in days between creation (or renewal) and expiration.
    leaseTotalTermMax Number
    The maximum duration in days between creation and expiration. Unaffected by renewal.
    name String
    A human-friendly name used as an identifier for the policy instance.
    orgId String
    The id of the organization this entity belongs to.
    projectCriterias List<Map<String>>
    The project based criteria.
    projectId String
    The id of the project this entity belongs to.
    search 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.