1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Core
  5. getByoasn
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

oci.Core.getByoasn

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

This data source provides details about a specific Byoasn resource in Oracle Cloud Infrastructure Core service.

Gets the Byoasn resource. You must specify the OCID.

Example Usage

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

const testByoasn = oci.Core.getByoasn({
    byoasnId: testByoasnOciCoreByoasn.id,
});
Copy
import pulumi
import pulumi_oci as oci

test_byoasn = oci.Core.get_byoasn(byoasn_id=test_byoasn_oci_core_byoasn["id"])
Copy
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/core"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := core.GetByoasn(ctx, &core.GetByoasnArgs{
			ByoasnId: testByoasnOciCoreByoasn.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testByoasn = Oci.Core.GetByoasn.Invoke(new()
    {
        ByoasnId = testByoasnOciCoreByoasn.Id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Core.CoreFunctions;
import com.pulumi.oci.Core.inputs.GetByoasnArgs;
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 testByoasn = CoreFunctions.getByoasn(GetByoasnArgs.builder()
            .byoasnId(testByoasnOciCoreByoasn.id())
            .build());

    }
}
Copy
variables:
  testByoasn:
    fn::invoke:
      function: oci:Core:getByoasn
      arguments:
        byoasnId: ${testByoasnOciCoreByoasn.id}
Copy

Using getByoasn

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 getByoasn(args: GetByoasnArgs, opts?: InvokeOptions): Promise<GetByoasnResult>
function getByoasnOutput(args: GetByoasnOutputArgs, opts?: InvokeOptions): Output<GetByoasnResult>
Copy
def get_byoasn(byoasn_id: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetByoasnResult
def get_byoasn_output(byoasn_id: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetByoasnResult]
Copy
func GetByoasn(ctx *Context, args *GetByoasnArgs, opts ...InvokeOption) (*GetByoasnResult, error)
func GetByoasnOutput(ctx *Context, args *GetByoasnOutputArgs, opts ...InvokeOption) GetByoasnResultOutput
Copy

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

public static class GetByoasn 
{
    public static Task<GetByoasnResult> InvokeAsync(GetByoasnArgs args, InvokeOptions? opts = null)
    public static Output<GetByoasnResult> Invoke(GetByoasnInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetByoasnResult> getByoasn(GetByoasnArgs args, InvokeOptions options)
public static Output<GetByoasnResult> getByoasn(GetByoasnArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:Core/getByoasn:getByoasn
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ByoasnId This property is required. string
The OCID of the Byoasn resource.
ByoasnId This property is required. string
The OCID of the Byoasn resource.
byoasnId This property is required. String
The OCID of the Byoasn resource.
byoasnId This property is required. string
The OCID of the Byoasn resource.
byoasn_id This property is required. str
The OCID of the Byoasn resource.
byoasnId This property is required. String
The OCID of the Byoasn resource.

getByoasn Result

The following output properties are available:

Asn string
The Autonomous System Number (ASN) you are importing to the Oracle cloud.
ByoasnId string
ByoipRanges List<GetByoasnByoipRange>
The BYOIP Ranges that has the Byoasn as origin.
CompartmentId string
The OCID of the compartment containing the Byoasn resource.
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 user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
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 Byoasn resource.
State string
The Byoasn resource's current state.
TimeCreated string
The date and time the Byoasn resource was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
TimeUpdated string
The date and time the Byoasn resource was last updated, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
TimeValidated string
The date and time the Byoasn resource was validated, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
ValidationToken string
The validation token is an internally-generated ASCII string used in the validation process. See Importing a Byoasn for details.
Asn string
The Autonomous System Number (ASN) you are importing to the Oracle cloud.
ByoasnId string
ByoipRanges []GetByoasnByoipRange
The BYOIP Ranges that has the Byoasn as origin.
CompartmentId string
The OCID of the compartment containing the Byoasn resource.
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 user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
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 Byoasn resource.
State string
The Byoasn resource's current state.
TimeCreated string
The date and time the Byoasn resource was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
TimeUpdated string
The date and time the Byoasn resource was last updated, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
TimeValidated string
The date and time the Byoasn resource was validated, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
ValidationToken string
The validation token is an internally-generated ASCII string used in the validation process. See Importing a Byoasn for details.
asn String
The Autonomous System Number (ASN) you are importing to the Oracle cloud.
byoasnId String
byoipRanges List<GetByoasnByoipRange>
The BYOIP Ranges that has the Byoasn as origin.
compartmentId String
The OCID of the compartment containing the Byoasn resource.
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 user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
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 Byoasn resource.
state String
The Byoasn resource's current state.
timeCreated String
The date and time the Byoasn resource was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
timeUpdated String
The date and time the Byoasn resource was last updated, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
timeValidated String
The date and time the Byoasn resource was validated, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
validationToken String
The validation token is an internally-generated ASCII string used in the validation process. See Importing a Byoasn for details.
asn string
The Autonomous System Number (ASN) you are importing to the Oracle cloud.
byoasnId string
byoipRanges GetByoasnByoipRange[]
The BYOIP Ranges that has the Byoasn as origin.
compartmentId string
The OCID of the compartment containing the Byoasn resource.
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 user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
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 Byoasn resource.
state string
The Byoasn resource's current state.
timeCreated string
The date and time the Byoasn resource was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
timeUpdated string
The date and time the Byoasn resource was last updated, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
timeValidated string
The date and time the Byoasn resource was validated, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
validationToken string
The validation token is an internally-generated ASCII string used in the validation process. See Importing a Byoasn for details.
asn str
The Autonomous System Number (ASN) you are importing to the Oracle cloud.
byoasn_id str
byoip_ranges Sequence[core.GetByoasnByoipRange]
The BYOIP Ranges that has the Byoasn as origin.
compartment_id str
The OCID of the compartment containing the Byoasn resource.
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 user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
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 Byoasn resource.
state str
The Byoasn resource's current state.
time_created str
The date and time the Byoasn resource was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
time_updated str
The date and time the Byoasn resource was last updated, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
time_validated str
The date and time the Byoasn resource was validated, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
validation_token str
The validation token is an internally-generated ASCII string used in the validation process. See Importing a Byoasn for details.
asn String
The Autonomous System Number (ASN) you are importing to the Oracle cloud.
byoasnId String
byoipRanges List<Property Map>
The BYOIP Ranges that has the Byoasn as origin.
compartmentId String
The OCID of the compartment containing the Byoasn resource.
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 user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
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 Byoasn resource.
state String
The Byoasn resource's current state.
timeCreated String
The date and time the Byoasn resource was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
timeUpdated String
The date and time the Byoasn resource was last updated, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
timeValidated String
The date and time the Byoasn resource was validated, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
validationToken String
The validation token is an internally-generated ASCII string used in the validation process. See Importing a Byoasn for details.

Supporting Types

GetByoasnByoipRange

AsPathPrependLength This property is required. int
The as path prepend length.
ByoipRangeId This property is required. string
The OCID of the ByoipRange resource to which the CIDR block belongs.
CidrBlock This property is required. string
The BYOIP CIDR block range or subrange allocated to an IP pool. This could be all or part of a BYOIP CIDR block.
Ipv6cidrBlock This property is required. string
The IPv6 prefix being imported to the Oracle cloud. This prefix must be /48 or larger, and can be subdivided into sub-ranges used across multiple VCNs. A BYOIPv6 prefix can be assigned across multiple VCNs, and each VCN must be /64 or larger. You may specify a ULA or private IPv6 prefix of /64 or larger to use in the VCN. IPv6-enabled subnets will remain a fixed /64 in size.
AsPathPrependLength This property is required. int
The as path prepend length.
ByoipRangeId This property is required. string
The OCID of the ByoipRange resource to which the CIDR block belongs.
CidrBlock This property is required. string
The BYOIP CIDR block range or subrange allocated to an IP pool. This could be all or part of a BYOIP CIDR block.
Ipv6cidrBlock This property is required. string
The IPv6 prefix being imported to the Oracle cloud. This prefix must be /48 or larger, and can be subdivided into sub-ranges used across multiple VCNs. A BYOIPv6 prefix can be assigned across multiple VCNs, and each VCN must be /64 or larger. You may specify a ULA or private IPv6 prefix of /64 or larger to use in the VCN. IPv6-enabled subnets will remain a fixed /64 in size.
asPathPrependLength This property is required. Integer
The as path prepend length.
byoipRangeId This property is required. String
The OCID of the ByoipRange resource to which the CIDR block belongs.
cidrBlock This property is required. String
The BYOIP CIDR block range or subrange allocated to an IP pool. This could be all or part of a BYOIP CIDR block.
ipv6cidrBlock This property is required. String
The IPv6 prefix being imported to the Oracle cloud. This prefix must be /48 or larger, and can be subdivided into sub-ranges used across multiple VCNs. A BYOIPv6 prefix can be assigned across multiple VCNs, and each VCN must be /64 or larger. You may specify a ULA or private IPv6 prefix of /64 or larger to use in the VCN. IPv6-enabled subnets will remain a fixed /64 in size.
asPathPrependLength This property is required. number
The as path prepend length.
byoipRangeId This property is required. string
The OCID of the ByoipRange resource to which the CIDR block belongs.
cidrBlock This property is required. string
The BYOIP CIDR block range or subrange allocated to an IP pool. This could be all or part of a BYOIP CIDR block.
ipv6cidrBlock This property is required. string
The IPv6 prefix being imported to the Oracle cloud. This prefix must be /48 or larger, and can be subdivided into sub-ranges used across multiple VCNs. A BYOIPv6 prefix can be assigned across multiple VCNs, and each VCN must be /64 or larger. You may specify a ULA or private IPv6 prefix of /64 or larger to use in the VCN. IPv6-enabled subnets will remain a fixed /64 in size.
as_path_prepend_length This property is required. int
The as path prepend length.
byoip_range_id This property is required. str
The OCID of the ByoipRange resource to which the CIDR block belongs.
cidr_block This property is required. str
The BYOIP CIDR block range or subrange allocated to an IP pool. This could be all or part of a BYOIP CIDR block.
ipv6cidr_block This property is required. str
The IPv6 prefix being imported to the Oracle cloud. This prefix must be /48 or larger, and can be subdivided into sub-ranges used across multiple VCNs. A BYOIPv6 prefix can be assigned across multiple VCNs, and each VCN must be /64 or larger. You may specify a ULA or private IPv6 prefix of /64 or larger to use in the VCN. IPv6-enabled subnets will remain a fixed /64 in size.
asPathPrependLength This property is required. Number
The as path prepend length.
byoipRangeId This property is required. String
The OCID of the ByoipRange resource to which the CIDR block belongs.
cidrBlock This property is required. String
The BYOIP CIDR block range or subrange allocated to an IP pool. This could be all or part of a BYOIP CIDR block.
ipv6cidrBlock This property is required. String
The IPv6 prefix being imported to the Oracle cloud. This prefix must be /48 or larger, and can be subdivided into sub-ranges used across multiple VCNs. A BYOIPv6 prefix can be assigned across multiple VCNs, and each VCN must be /64 or larger. You may specify a ULA or private IPv6 prefix of /64 or larger to use in the VCN. IPv6-enabled subnets will remain a fixed /64 in size.

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes
This Pulumi package is based on the oci Terraform Provider.
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi