1. Packages
  2. Packages
  3. Oracle Cloud Infrastructure
  4. API Docs
  5. Ocvp
  6. ByolAllocation
Viewing docs for Oracle Cloud Infrastructure v4.9.0
published on Thursday, Apr 30, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-oci

oci.Ocvp.ByolAllocation

oci logo
Viewing docs for Oracle Cloud Infrastructure v4.9.0
published on Thursday, Apr 30, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-oci

    This resource provides the Byol Allocation resource in Oracle Cloud Infrastructure Oracle Cloud VMware Solution service. Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/vmware/latest/ByolAllocation

    Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/ocvp

    Creates an Allocation on an specific Bring-You-Own-License (BYOL).

    Use the WorkRequest operations to track the creation of the BYOL.

    Example Usage

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

const testByolAllocation = new oci.ocvp.ByolAllocation("test_byol_allocation", {
    allocatedUnits: byolAllocationAllocatedUnits,
    byolId: testByol.id,
    compartmentId: compartmentId,
    displayName: byolAllocationDisplayName,
    definedTags: {
        "Operations.CostCenter": "42",
    },
    freeformTags: {
        Department: "Finance",
    },
});

    import pulumi
import pulumi_oci as oci

test_byol_allocation = oci.ocvp.ByolAllocation("test_byol_allocation",
    allocated_units=byol_allocation_allocated_units,
    byol_id=test_byol["id"],
    compartment_id=compartment_id,
    display_name=byol_allocation_display_name,
    defined_tags={
        "Operations.CostCenter": "42",
    },
    freeform_tags={
        "Department": "Finance",
    })

    package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v4/go/oci/ocvp"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ocvp.NewByolAllocation(ctx, "test_byol_allocation", &ocvp.ByolAllocationArgs{
			AllocatedUnits: pulumi.Any(byolAllocationAllocatedUnits),
			ByolId:         pulumi.Any(testByol.Id),
			CompartmentId:  pulumi.Any(compartmentId),
			DisplayName:    pulumi.Any(byolAllocationDisplayName),
			DefinedTags: pulumi.StringMap{
				"Operations.CostCenter": pulumi.String("42"),
			},
			FreeformTags: pulumi.StringMap{
				"Department": pulumi.String("Finance"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testByolAllocation = new Oci.Ocvp.ByolAllocation("test_byol_allocation", new()
    {
        AllocatedUnits = byolAllocationAllocatedUnits,
        ByolId = testByol.Id,
        CompartmentId = compartmentId,
        DisplayName = byolAllocationDisplayName,
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Ocvp.ByolAllocation;
import com.pulumi.oci.Ocvp.ByolAllocationArgs;
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) {
        var testByolAllocation = new ByolAllocation("testByolAllocation", ByolAllocationArgs.builder()
            .allocatedUnits(byolAllocationAllocatedUnits)
            .byolId(testByol.id())
            .compartmentId(compartmentId)
            .displayName(byolAllocationDisplayName)
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .freeformTags(Map.of("Department", "Finance"))
            .build());

    }
}

    resources:
  testByolAllocation:
    type: oci:Ocvp:ByolAllocation
    name: test_byol_allocation
    properties:
      allocatedUnits: ${byolAllocationAllocatedUnits}
      byolId: ${testByol.id}
      compartmentId: ${compartmentId}
      displayName: ${byolAllocationDisplayName}
      definedTags:
        Operations.CostCenter: '42'
      freeformTags:
        Department: Finance

    Create ByolAllocation Resource

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

    Constructor syntax

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

@overload
def ByolAllocation(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   allocated_units: Optional[int] = None,
                   byol_id: Optional[str] = None,
                   compartment_id: Optional[str] = None,
                   display_name: Optional[str] = None,
                   defined_tags: Optional[Mapping[str, str]] = None,
                   freeform_tags: Optional[Mapping[str, str]] = None)
    func NewByolAllocation(ctx *Context, name string, args ByolAllocationArgs, opts ...ResourceOption) (*ByolAllocation, error)
    public ByolAllocation(string name, ByolAllocationArgs args, CustomResourceOptions? opts = null)
    public ByolAllocation(String name, ByolAllocationArgs args)
public ByolAllocation(String name, ByolAllocationArgs args, CustomResourceOptions options)

    type: oci:Ocvp:ByolAllocation
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 ByolAllocationArgs
    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 ByolAllocationArgs
    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 ByolAllocationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ByolAllocationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ByolAllocationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    ByolAllocation 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 ByolAllocation resource accepts the following input properties:

    AllocatedUnits int
    (Updatable) The quantity of licensed units that allocated to this region.
    ByolId string
    The OCID of the BYOL resource from which this BYOL Allocation is derived.
    CompartmentId string
    (Updatable) The OCID of the compartment that contains the BYOL Allocation.
    DisplayName string
    (Updatable) A descriptive name for the BYOL Allocation.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    FreeformTags Dictionary<string, string>

    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    AllocatedUnits int
    (Updatable) The quantity of licensed units that allocated to this region.
    ByolId string
    The OCID of the BYOL resource from which this BYOL Allocation is derived.
    CompartmentId string
    (Updatable) The OCID of the compartment that contains the BYOL Allocation.
    DisplayName string
    (Updatable) A descriptive name for the BYOL Allocation.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    FreeformTags map[string]string

    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    allocatedUnits Integer
    (Updatable) The quantity of licensed units that allocated to this region.
    byolId String
    The OCID of the BYOL resource from which this BYOL Allocation is derived.
    compartmentId String
    (Updatable) The OCID of the compartment that contains the BYOL Allocation.
    displayName String
    (Updatable) A descriptive name for the BYOL Allocation.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    freeformTags Map<String,String>

    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    allocatedUnits number
    (Updatable) The quantity of licensed units that allocated to this region.
    byolId string
    The OCID of the BYOL resource from which this BYOL Allocation is derived.
    compartmentId string
    (Updatable) The OCID of the compartment that contains the BYOL Allocation.
    displayName string
    (Updatable) A descriptive name for the BYOL Allocation.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    freeformTags {[key: string]: string}

    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    allocated_units int
    (Updatable) The quantity of licensed units that allocated to this region.
    byol_id str
    The OCID of the BYOL resource from which this BYOL Allocation is derived.
    compartment_id str
    (Updatable) The OCID of the compartment that contains the BYOL Allocation.
    display_name str
    (Updatable) A descriptive name for the BYOL Allocation.
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    freeform_tags Mapping[str, str]

    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    allocatedUnits Number
    (Updatable) The quantity of licensed units that allocated to this region.
    byolId String
    The OCID of the BYOL resource from which this BYOL Allocation is derived.
    compartmentId String
    (Updatable) The OCID of the compartment that contains the BYOL Allocation.
    displayName String
    (Updatable) A descriptive name for the BYOL Allocation.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    freeformTags Map<String>

    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Outputs

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

    AvailableUnits int
    The quantity of licensed units that not yet consumed by resources.
    EntitlementKey string
    The Broadcom-supplied identifier of a BYOL license.
    Id string
    The provider-assigned unique ID for this managed resource.
    SoftwareType string
    The type of VMware software the BYOL applies to. Supported values:

    • VCF (VMware Cloud Foundation)
    • VSAN (VMware vSAN)
    • VDEFEND (VMware vDefend Firewall)
    • AVI_LOAD_BALANCER (VMware Avi Load Balancer)
    State string
    The current state of the BYOL Allocation.
    SystemTags Dictionary<string, string>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {orcl-cloud: {free-tier-retain: true}}
    TimeCreated string
    The date and time the BYOL Allocation was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    TimeTermEnd string
    The date and time when the BYOL Allocation expires and becomes inactive. In the format defined byRFC3339.
    TimeTermStart string
    The date and time when the BYOL Allocation becomes active. VMware software functionality cannot begin before this time. In the format defined byRFC3339. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time the BYOL Allocation was updated, in the format defined by RFC3339.
    AvailableUnits int
    The quantity of licensed units that not yet consumed by resources.
    EntitlementKey string
    The Broadcom-supplied identifier of a BYOL license.
    Id string
    The provider-assigned unique ID for this managed resource.
    SoftwareType string
    The type of VMware software the BYOL applies to. Supported values:

    • VCF (VMware Cloud Foundation)
    • VSAN (VMware vSAN)
    • VDEFEND (VMware vDefend Firewall)
    • AVI_LOAD_BALANCER (VMware Avi Load Balancer)
    State string
    The current state of the BYOL Allocation.
    SystemTags map[string]string
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {orcl-cloud: {free-tier-retain: true}}
    TimeCreated string
    The date and time the BYOL Allocation was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    TimeTermEnd string
    The date and time when the BYOL Allocation expires and becomes inactive. In the format defined byRFC3339.
    TimeTermStart string
    The date and time when the BYOL Allocation becomes active. VMware software functionality cannot begin before this time. In the format defined byRFC3339. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time the BYOL Allocation was updated, in the format defined by RFC3339.
    availableUnits Integer
    The quantity of licensed units that not yet consumed by resources.
    entitlementKey String
    The Broadcom-supplied identifier of a BYOL license.
    id String
    The provider-assigned unique ID for this managed resource.
    softwareType String
    The type of VMware software the BYOL applies to. Supported values:

    • VCF (VMware Cloud Foundation)
    • VSAN (VMware vSAN)
    • VDEFEND (VMware vDefend Firewall)
    • AVI_LOAD_BALANCER (VMware Avi Load Balancer)
    state String
    The current state of the BYOL Allocation.
    systemTags Map<String,String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {orcl-cloud: {free-tier-retain: true}}
    timeCreated String
    The date and time the BYOL Allocation was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    timeTermEnd String
    The date and time when the BYOL Allocation expires and becomes inactive. In the format defined byRFC3339.
    timeTermStart String
    The date and time when the BYOL Allocation becomes active. VMware software functionality cannot begin before this time. In the format defined byRFC3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time the BYOL Allocation was updated, in the format defined by RFC3339.
    availableUnits number
    The quantity of licensed units that not yet consumed by resources.
    entitlementKey string
    The Broadcom-supplied identifier of a BYOL license.
    id string
    The provider-assigned unique ID for this managed resource.
    softwareType string
    The type of VMware software the BYOL applies to. Supported values:

    • VCF (VMware Cloud Foundation)
    • VSAN (VMware vSAN)
    • VDEFEND (VMware vDefend Firewall)
    • AVI_LOAD_BALANCER (VMware Avi Load Balancer)
    state string
    The current state of the BYOL Allocation.
    systemTags {[key: string]: string}
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {orcl-cloud: {free-tier-retain: true}}
    timeCreated string
    The date and time the BYOL Allocation was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    timeTermEnd string
    The date and time when the BYOL Allocation expires and becomes inactive. In the format defined byRFC3339.
    timeTermStart string
    The date and time when the BYOL Allocation becomes active. VMware software functionality cannot begin before this time. In the format defined byRFC3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated string
    The date and time the BYOL Allocation was updated, in the format defined by RFC3339.
    available_units int
    The quantity of licensed units that not yet consumed by resources.
    entitlement_key str
    The Broadcom-supplied identifier of a BYOL license.
    id str
    The provider-assigned unique ID for this managed resource.
    software_type str
    The type of VMware software the BYOL applies to. Supported values:

    • VCF (VMware Cloud Foundation)
    • VSAN (VMware vSAN)
    • VDEFEND (VMware vDefend Firewall)
    • AVI_LOAD_BALANCER (VMware Avi Load Balancer)
    state str
    The current state of the BYOL Allocation.
    system_tags Mapping[str, str]
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {orcl-cloud: {free-tier-retain: true}}
    time_created str
    The date and time the BYOL Allocation was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    time_term_end str
    The date and time when the BYOL Allocation expires and becomes inactive. In the format defined byRFC3339.
    time_term_start str
    The date and time when the BYOL Allocation becomes active. VMware software functionality cannot begin before this time. In the format defined byRFC3339. Example: 2016-08-25T21:10:29.600Z
    time_updated str
    The date and time the BYOL Allocation was updated, in the format defined by RFC3339.
    availableUnits Number
    The quantity of licensed units that not yet consumed by resources.
    entitlementKey String
    The Broadcom-supplied identifier of a BYOL license.
    id String
    The provider-assigned unique ID for this managed resource.
    softwareType String
    The type of VMware software the BYOL applies to. Supported values:

    • VCF (VMware Cloud Foundation)
    • VSAN (VMware vSAN)
    • VDEFEND (VMware vDefend Firewall)
    • AVI_LOAD_BALANCER (VMware Avi Load Balancer)
    state String
    The current state of the BYOL Allocation.
    systemTags Map<String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {orcl-cloud: {free-tier-retain: true}}
    timeCreated String
    The date and time the BYOL Allocation was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    timeTermEnd String
    The date and time when the BYOL Allocation expires and becomes inactive. In the format defined byRFC3339.
    timeTermStart String
    The date and time when the BYOL Allocation becomes active. VMware software functionality cannot begin before this time. In the format defined byRFC3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time the BYOL Allocation was updated, in the format defined by RFC3339.

    Look up Existing ByolAllocation Resource

    Get an existing ByolAllocation 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?: ByolAllocationState, opts?: CustomResourceOptions): ByolAllocation
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allocated_units: Optional[int] = None,
        available_units: Optional[int] = None,
        byol_id: Optional[str] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        display_name: Optional[str] = None,
        entitlement_key: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        software_type: Optional[str] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        time_created: Optional[str] = None,
        time_term_end: Optional[str] = None,
        time_term_start: Optional[str] = None,
        time_updated: Optional[str] = None) -> ByolAllocation
    func GetByolAllocation(ctx *Context, name string, id IDInput, state *ByolAllocationState, opts ...ResourceOption) (*ByolAllocation, error)
    public static ByolAllocation Get(string name, Input<string> id, ByolAllocationState? state, CustomResourceOptions? opts = null)
    public static ByolAllocation get(String name, Output<String> id, ByolAllocationState state, CustomResourceOptions options)
    resources:  _:    type: oci:Ocvp:ByolAllocation    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:
    AllocatedUnits int
    (Updatable) The quantity of licensed units that allocated to this region.
    AvailableUnits int
    The quantity of licensed units that not yet consumed by resources.
    ByolId string
    The OCID of the BYOL resource from which this BYOL Allocation is derived.
    CompartmentId string
    (Updatable) The OCID of the compartment that contains the BYOL Allocation.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    (Updatable) A descriptive name for the BYOL Allocation.
    EntitlementKey string
    The Broadcom-supplied identifier of a BYOL license.
    FreeformTags Dictionary<string, string>

    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    SoftwareType string
    The type of VMware software the BYOL applies to. Supported values:

    • VCF (VMware Cloud Foundation)
    • VSAN (VMware vSAN)
    • VDEFEND (VMware vDefend Firewall)
    • AVI_LOAD_BALANCER (VMware Avi Load Balancer)
    State string
    The current state of the BYOL Allocation.
    SystemTags Dictionary<string, string>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {orcl-cloud: {free-tier-retain: true}}
    TimeCreated string
    The date and time the BYOL Allocation was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    TimeTermEnd string
    The date and time when the BYOL Allocation expires and becomes inactive. In the format defined byRFC3339.
    TimeTermStart string
    The date and time when the BYOL Allocation becomes active. VMware software functionality cannot begin before this time. In the format defined byRFC3339. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time the BYOL Allocation was updated, in the format defined by RFC3339.
    AllocatedUnits int
    (Updatable) The quantity of licensed units that allocated to this region.
    AvailableUnits int
    The quantity of licensed units that not yet consumed by resources.
    ByolId string
    The OCID of the BYOL resource from which this BYOL Allocation is derived.
    CompartmentId string
    (Updatable) The OCID of the compartment that contains the BYOL Allocation.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    (Updatable) A descriptive name for the BYOL Allocation.
    EntitlementKey string
    The Broadcom-supplied identifier of a BYOL license.
    FreeformTags map[string]string

    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    SoftwareType string
    The type of VMware software the BYOL applies to. Supported values:

    • VCF (VMware Cloud Foundation)
    • VSAN (VMware vSAN)
    • VDEFEND (VMware vDefend Firewall)
    • AVI_LOAD_BALANCER (VMware Avi Load Balancer)
    State string
    The current state of the BYOL Allocation.
    SystemTags map[string]string
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {orcl-cloud: {free-tier-retain: true}}
    TimeCreated string
    The date and time the BYOL Allocation was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    TimeTermEnd string
    The date and time when the BYOL Allocation expires and becomes inactive. In the format defined byRFC3339.
    TimeTermStart string
    The date and time when the BYOL Allocation becomes active. VMware software functionality cannot begin before this time. In the format defined byRFC3339. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time the BYOL Allocation was updated, in the format defined by RFC3339.
    allocatedUnits Integer
    (Updatable) The quantity of licensed units that allocated to this region.
    availableUnits Integer
    The quantity of licensed units that not yet consumed by resources.
    byolId String
    The OCID of the BYOL resource from which this BYOL Allocation is derived.
    compartmentId String
    (Updatable) The OCID of the compartment that contains the BYOL Allocation.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    (Updatable) A descriptive name for the BYOL Allocation.
    entitlementKey String
    The Broadcom-supplied identifier of a BYOL license.
    freeformTags Map<String,String>

    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    softwareType String
    The type of VMware software the BYOL applies to. Supported values:

    • VCF (VMware Cloud Foundation)
    • VSAN (VMware vSAN)
    • VDEFEND (VMware vDefend Firewall)
    • AVI_LOAD_BALANCER (VMware Avi Load Balancer)
    state String
    The current state of the BYOL Allocation.
    systemTags Map<String,String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {orcl-cloud: {free-tier-retain: true}}
    timeCreated String
    The date and time the BYOL Allocation was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    timeTermEnd String
    The date and time when the BYOL Allocation expires and becomes inactive. In the format defined byRFC3339.
    timeTermStart String
    The date and time when the BYOL Allocation becomes active. VMware software functionality cannot begin before this time. In the format defined byRFC3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time the BYOL Allocation was updated, in the format defined by RFC3339.
    allocatedUnits number
    (Updatable) The quantity of licensed units that allocated to this region.
    availableUnits number
    The quantity of licensed units that not yet consumed by resources.
    byolId string
    The OCID of the BYOL resource from which this BYOL Allocation is derived.
    compartmentId string
    (Updatable) The OCID of the compartment that contains the BYOL Allocation.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName string
    (Updatable) A descriptive name for the BYOL Allocation.
    entitlementKey string
    The Broadcom-supplied identifier of a BYOL license.
    freeformTags {[key: string]: string}

    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    softwareType string
    The type of VMware software the BYOL applies to. Supported values:

    • VCF (VMware Cloud Foundation)
    • VSAN (VMware vSAN)
    • VDEFEND (VMware vDefend Firewall)
    • AVI_LOAD_BALANCER (VMware Avi Load Balancer)
    state string
    The current state of the BYOL Allocation.
    systemTags {[key: string]: string}
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {orcl-cloud: {free-tier-retain: true}}
    timeCreated string
    The date and time the BYOL Allocation was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    timeTermEnd string
    The date and time when the BYOL Allocation expires and becomes inactive. In the format defined byRFC3339.
    timeTermStart string
    The date and time when the BYOL Allocation becomes active. VMware software functionality cannot begin before this time. In the format defined byRFC3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated string
    The date and time the BYOL Allocation was updated, in the format defined by RFC3339.
    allocated_units int
    (Updatable) The quantity of licensed units that allocated to this region.
    available_units int
    The quantity of licensed units that not yet consumed by resources.
    byol_id str
    The OCID of the BYOL resource from which this BYOL Allocation is derived.
    compartment_id str
    (Updatable) The OCID of the compartment that contains the BYOL Allocation.
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    display_name str
    (Updatable) A descriptive name for the BYOL Allocation.
    entitlement_key str
    The Broadcom-supplied identifier of a BYOL license.
    freeform_tags Mapping[str, str]

    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    software_type str
    The type of VMware software the BYOL applies to. Supported values:

    • VCF (VMware Cloud Foundation)
    • VSAN (VMware vSAN)
    • VDEFEND (VMware vDefend Firewall)
    • AVI_LOAD_BALANCER (VMware Avi Load Balancer)
    state str
    The current state of the BYOL Allocation.
    system_tags Mapping[str, str]
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {orcl-cloud: {free-tier-retain: true}}
    time_created str
    The date and time the BYOL Allocation was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    time_term_end str
    The date and time when the BYOL Allocation expires and becomes inactive. In the format defined byRFC3339.
    time_term_start str
    The date and time when the BYOL Allocation becomes active. VMware software functionality cannot begin before this time. In the format defined byRFC3339. Example: 2016-08-25T21:10:29.600Z
    time_updated str
    The date and time the BYOL Allocation was updated, in the format defined by RFC3339.
    allocatedUnits Number
    (Updatable) The quantity of licensed units that allocated to this region.
    availableUnits Number
    The quantity of licensed units that not yet consumed by resources.
    byolId String
    The OCID of the BYOL resource from which this BYOL Allocation is derived.
    compartmentId String
    (Updatable) The OCID of the compartment that contains the BYOL Allocation.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    (Updatable) A descriptive name for the BYOL Allocation.
    entitlementKey String
    The Broadcom-supplied identifier of a BYOL license.
    freeformTags Map<String>

    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    softwareType String
    The type of VMware software the BYOL applies to. Supported values:

    • VCF (VMware Cloud Foundation)
    • VSAN (VMware vSAN)
    • VDEFEND (VMware vDefend Firewall)
    • AVI_LOAD_BALANCER (VMware Avi Load Balancer)
    state String
    The current state of the BYOL Allocation.
    systemTags Map<String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {orcl-cloud: {free-tier-retain: true}}
    timeCreated String
    The date and time the BYOL Allocation was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    timeTermEnd String
    The date and time when the BYOL Allocation expires and becomes inactive. In the format defined byRFC3339.
    timeTermStart String
    The date and time when the BYOL Allocation becomes active. VMware software functionality cannot begin before this time. In the format defined byRFC3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time the BYOL Allocation was updated, in the format defined by RFC3339.

    Import

    ByolAllocations can be imported using the id, e.g.

    $ pulumi import oci:Ocvp/byolAllocation:ByolAllocation test_byol_allocation "id"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Viewing docs for Oracle Cloud Infrastructure v4.9.0
    published on Thursday, Apr 30, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-oci
      Try Pulumi Cloud free. Your team will thank you.