getByolAllocation

Oracle Cloud Infrastructure v4.9.0, Apr 30 26

Viewing docs for Oracle Cloud Infrastructure v4.9.0
published on Thursday, Apr 30, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-oci

Viewing docs for Oracle Cloud Infrastructure v4.9.0
published on Thursday, Apr 30, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-oci

Example Usage

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

const testByolAllocation = oci.Ocvp.getByolAllocation({
    byolAllocationId: testByolAllocationOciOcvpByolAllocation.id,
});

import pulumi
import pulumi_oci as oci

test_byol_allocation = oci.Ocvp.get_byol_allocation(byol_allocation_id=test_byol_allocation_oci_ocvp_byol_allocation["id"])

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.GetByolAllocation(ctx, &ocvp.GetByolAllocationArgs{
			ByolAllocationId: testByolAllocationOciOcvpByolAllocation.Id,
		}, nil)
		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 = Oci.Ocvp.GetByolAllocation.Invoke(new()
    {
        ByolAllocationId = testByolAllocationOciOcvpByolAllocation.Id,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Ocvp.OcvpFunctions;
import com.pulumi.oci.Ocvp.inputs.GetByolAllocationArgs;
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 testByolAllocation = OcvpFunctions.getByolAllocation(GetByolAllocationArgs.builder()
            .byolAllocationId(testByolAllocationOciOcvpByolAllocation.id())
            .build());

    }
}

variables:
  testByolAllocation:
    fn::invoke:
      function: oci:Ocvp:getByolAllocation
      arguments:
        byolAllocationId: ${testByolAllocationOciOcvpByolAllocation.id}

Using getByolAllocation

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 getByolAllocation(args: GetByolAllocationArgs, opts?: InvokeOptions): Promise<GetByolAllocationResult>
function getByolAllocationOutput(args: GetByolAllocationOutputArgs, opts?: InvokeOptions): Output<GetByolAllocationResult>

def get_byol_allocation(byol_allocation_id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetByolAllocationResult
def get_byol_allocation_output(byol_allocation_id: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetByolAllocationResult]

func LookupByolAllocation(ctx *Context, args *LookupByolAllocationArgs, opts ...InvokeOption) (*LookupByolAllocationResult, error)
func LookupByolAllocationOutput(ctx *Context, args *LookupByolAllocationOutputArgs, opts ...InvokeOption) LookupByolAllocationResultOutput

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

public static class GetByolAllocation 
{
    public static Task<GetByolAllocationResult> InvokeAsync(GetByolAllocationArgs args, InvokeOptions? opts = null)
    public static Output<GetByolAllocationResult> Invoke(GetByolAllocationInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetByolAllocationResult> getByolAllocation(GetByolAllocationArgs args, InvokeOptions options)
public static Output<GetByolAllocationResult> getByolAllocation(GetByolAllocationArgs args, InvokeOptions options)

fn::invoke:
  function: oci:Ocvp/getByolAllocation:getByolAllocation
  arguments:
    # arguments dictionary

The following arguments are supported:

ByolAllocationId string: The OCID of the BYOL Allocation.

ByolAllocationId string: The OCID of the BYOL Allocation.

byolAllocationId String: The OCID of the BYOL Allocation.

byolAllocationId string: The OCID of the BYOL Allocation.

byol_allocation_id str: The OCID of the BYOL Allocation.

byolAllocationId String: The OCID of the BYOL Allocation.

getByolAllocation Result

The following output properties are available:

AllocatedUnits int

The quantity of licensed units that allocated to this region.

AvailableUnits int

The quantity of licensed units that not yet consumed by resources.

ByolAllocationId string

ByolId string

The OCID of the BYOL resource from which this BYOL Allocation is derived.

CompartmentId string

The OCID of the compartment that contains the BYOL Allocation.

DefinedTags Dictionary<string, string>

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

A descriptive name for the BYOL Allocation.

EntitlementKey string

The Broadcom-supplied identifier of a BYOL license.

FreeformTags Dictionary<string, string>

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"}

Id string

The OCID of the BYOL Allocation.

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

The quantity of licensed units that allocated to this region.

AvailableUnits int

The quantity of licensed units that not yet consumed by resources.

ByolAllocationId string

ByolId string

The OCID of the BYOL resource from which this BYOL Allocation is derived.

CompartmentId string

The OCID of the compartment that contains the BYOL Allocation.

DefinedTags map[string]string

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

A descriptive name for the BYOL Allocation.

EntitlementKey string

The Broadcom-supplied identifier of a BYOL license.

FreeformTags map[string]string

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"}

Id string

The OCID of the BYOL Allocation.

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

The quantity of licensed units that allocated to this region.

availableUnits Integer

The quantity of licensed units that not yet consumed by resources.

byolAllocationId String

byolId String

The OCID of the BYOL resource from which this BYOL Allocation is derived.

compartmentId String

The OCID of the compartment that contains the BYOL Allocation.

definedTags Map<String,String>

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

A descriptive name for the BYOL Allocation.

entitlementKey String

The Broadcom-supplied identifier of a BYOL license.

freeformTags Map<String,String>

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"}

id String

The OCID of the BYOL Allocation.

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

The quantity of licensed units that allocated to this region.

availableUnits number

The quantity of licensed units that not yet consumed by resources.

byolAllocationId string

byolId string

The OCID of the BYOL resource from which this BYOL Allocation is derived.

compartmentId string

The OCID of the compartment that contains the BYOL Allocation.

definedTags {[key: string]: string}

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

A descriptive name for the BYOL Allocation.

entitlementKey string

The Broadcom-supplied identifier of a BYOL license.

freeformTags {[key: string]: string}

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"}

id string

The OCID of the BYOL Allocation.

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

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_allocation_id str

byol_id str

The OCID of the BYOL resource from which this BYOL Allocation is derived.

compartment_id str

The OCID of the compartment that contains the BYOL Allocation.

defined_tags Mapping[str, str]

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

A descriptive name for the BYOL Allocation.

entitlement_key str

The Broadcom-supplied identifier of a BYOL license.

freeform_tags Mapping[str, str]

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"}

id str

The OCID of the BYOL Allocation.

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

The quantity of licensed units that allocated to this region.

availableUnits Number

The quantity of licensed units that not yet consumed by resources.

byolAllocationId String

byolId String

The OCID of the BYOL resource from which this BYOL Allocation is derived.

compartmentId String

The OCID of the compartment that contains the BYOL Allocation.

definedTags Map<String>

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

A descriptive name for the BYOL Allocation.

entitlementKey String

The Broadcom-supplied identifier of a BYOL license.

freeformTags Map<String>

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"}

id String

The OCID of the BYOL Allocation.

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