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

oci.Ocvp.getByol

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 data source provides details about a specific Byol resource in Oracle Cloud Infrastructure Oracle Cloud VMware Solution service.

    Gets the specified BYOL’s information.

    Example Usage

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

const testByol = oci.Ocvp.getByol({
    byolId: testByolOciOcvpByol.id,
});

    import pulumi
import pulumi_oci as oci

test_byol = oci.Ocvp.get_byol(byol_id=test_byol_oci_ocvp_byol["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.GetByol(ctx, &ocvp.GetByolArgs{
			ByolId: testByolOciOcvpByol.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 testByol = Oci.Ocvp.GetByol.Invoke(new()
    {
        ByolId = testByolOciOcvpByol.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.GetByolArgs;
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 testByol = OcvpFunctions.getByol(GetByolArgs.builder()
            .byolId(testByolOciOcvpByol.id())
            .build());

    }
}

    variables:
  testByol:
    fn::invoke:
      function: oci:Ocvp:getByol
      arguments:
        byolId: ${testByolOciOcvpByol.id}

    Using getByol

    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 getByol(args: GetByolArgs, opts?: InvokeOptions): Promise<GetByolResult>
function getByolOutput(args: GetByolOutputArgs, opts?: InvokeOptions): Output<GetByolResult>
    def get_byol(byol_id: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetByolResult
def get_byol_output(byol_id: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetByolResult]
    func LookupByol(ctx *Context, args *LookupByolArgs, opts ...InvokeOption) (*LookupByolResult, error)
func LookupByolOutput(ctx *Context, args *LookupByolOutputArgs, opts ...InvokeOption) LookupByolResultOutput

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

    public static class GetByol 
{
    public static Task<GetByolResult> InvokeAsync(GetByolArgs args, InvokeOptions? opts = null)
    public static Output<GetByolResult> Invoke(GetByolInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetByolResult> getByol(GetByolArgs args, InvokeOptions options)
public static Output<GetByolResult> getByol(GetByolArgs args, InvokeOptions options)

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

    The following arguments are supported:

    ByolId string
    The OCID of the BYOL.
    ByolId string
    The OCID of the BYOL.
    byolId String
    The OCID of the BYOL.
    byolId string
    The OCID of the BYOL.
    byol_id str
    The OCID of the BYOL.
    byolId String
    The OCID of the BYOL.

    getByol Result

    The following output properties are available:

    AvailableUnits int
    The quantity of licensed units that not yet allocated to specific region.
    ByolId string
    CompartmentId string
    The OCID of the compartment that contains the BYOL.
    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"}
    Description string
    A description of the BYOL.
    DisplayName string
    A descriptive name for the BYOL.
    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.
    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.
    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 was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    TimeTermEnd string
    The date and time when the BYOL expires and becomes inactive. In the format defined byRFC3339.
    TimeTermStart string
    The date and time when the BYOL 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 was updated, in the format defined by RFC3339.
    TotalUnits int
    Total quantity of licensed units for the specified softwareType:

    • VCF, VDEFEND: number of OCPUs
    • VSAN: storage capacity in TiB (tebibytes)
    • AVI_LOAD_BALANCER: number of instances
    AvailableUnits int
    The quantity of licensed units that not yet allocated to specific region.
    ByolId string
    CompartmentId string
    The OCID of the compartment that contains the BYOL.
    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"}
    Description string
    A description of the BYOL.
    DisplayName string
    A descriptive name for the BYOL.
    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.
    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.
    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 was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    TimeTermEnd string
    The date and time when the BYOL expires and becomes inactive. In the format defined byRFC3339.
    TimeTermStart string
    The date and time when the BYOL 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 was updated, in the format defined by RFC3339.
    TotalUnits int
    Total quantity of licensed units for the specified softwareType:

    • VCF, VDEFEND: number of OCPUs
    • VSAN: storage capacity in TiB (tebibytes)
    • AVI_LOAD_BALANCER: number of instances
    availableUnits Integer
    The quantity of licensed units that not yet allocated to specific region.
    byolId String
    compartmentId String
    The OCID of the compartment that contains the BYOL.
    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"}
    description String
    A description of the BYOL.
    displayName String
    A descriptive name for the BYOL.
    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.
    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.
    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 was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    timeTermEnd String
    The date and time when the BYOL expires and becomes inactive. In the format defined byRFC3339.
    timeTermStart String
    The date and time when the BYOL 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 was updated, in the format defined by RFC3339.
    totalUnits Integer
    Total quantity of licensed units for the specified softwareType:

    • VCF, VDEFEND: number of OCPUs
    • VSAN: storage capacity in TiB (tebibytes)
    • AVI_LOAD_BALANCER: number of instances
    availableUnits number
    The quantity of licensed units that not yet allocated to specific region.
    byolId string
    compartmentId string
    The OCID of the compartment that contains the BYOL.
    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"}
    description string
    A description of the BYOL.
    displayName string
    A descriptive name for the BYOL.
    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.
    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.
    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 was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    timeTermEnd string
    The date and time when the BYOL expires and becomes inactive. In the format defined byRFC3339.
    timeTermStart string
    The date and time when the BYOL 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 was updated, in the format defined by RFC3339.
    totalUnits number
    Total quantity of licensed units for the specified softwareType:

    • VCF, VDEFEND: number of OCPUs
    • VSAN: storage capacity in TiB (tebibytes)
    • AVI_LOAD_BALANCER: number of instances
    available_units int
    The quantity of licensed units that not yet allocated to specific region.
    byol_id str
    compartment_id str
    The OCID of the compartment that contains the BYOL.
    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"}
    description str
    A description of the BYOL.
    display_name str
    A descriptive name for the BYOL.
    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.
    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.
    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 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 expires and becomes inactive. In the format defined byRFC3339.
    time_term_start str
    The date and time when the BYOL 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 was updated, in the format defined by RFC3339.
    total_units int
    Total quantity of licensed units for the specified softwareType:

    • VCF, VDEFEND: number of OCPUs
    • VSAN: storage capacity in TiB (tebibytes)
    • AVI_LOAD_BALANCER: number of instances
    availableUnits Number
    The quantity of licensed units that not yet allocated to specific region.
    byolId String
    compartmentId String
    The OCID of the compartment that contains the BYOL.
    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"}
    description String
    A description of the BYOL.
    displayName String
    A descriptive name for the BYOL.
    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.
    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.
    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 was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    timeTermEnd String
    The date and time when the BYOL expires and becomes inactive. In the format defined byRFC3339.
    timeTermStart String
    The date and time when the BYOL 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 was updated, in the format defined by RFC3339.
    totalUnits Number
    Total quantity of licensed units for the specified softwareType:

    • VCF, VDEFEND: number of OCPUs
    • VSAN: storage capacity in TiB (tebibytes)
    • AVI_LOAD_BALANCER: number of instances

    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.