oci.Core.getVcns

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi

pulumi/pulumi-oci

Supported Aliases

oci.Core.getVirtualNetworks

Example Usage

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

const testVcns = oci.Core.getVcns({
    compartmentId: compartmentId,
    displayName: vcnDisplayName,
    state: vcnState,
});

import pulumi
import pulumi_oci as oci

test_vcns = oci.Core.get_vcns(compartment_id=compartment_id,
    display_name=vcn_display_name,
    state=vcn_state)

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.GetVcns(ctx, &core.GetVcnsArgs{
			CompartmentId: compartmentId,
			DisplayName:   pulumi.StringRef(vcnDisplayName),
			State:         pulumi.StringRef(vcnState),
		}, 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 testVcns = Oci.Core.GetVcns.Invoke(new()
    {
        CompartmentId = compartmentId,
        DisplayName = vcnDisplayName,
        State = vcnState,
    });

});

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.GetVcnsArgs;
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 testVcns = CoreFunctions.getVcns(GetVcnsArgs.builder()
            .compartmentId(compartmentId)
            .displayName(vcnDisplayName)
            .state(vcnState)
            .build());

    }
}

variables:
  testVcns:
    fn::invoke:
      function: oci:Core:getVcns
      arguments:
        compartmentId: ${compartmentId}
        displayName: ${vcnDisplayName}
        state: ${vcnState}

Using getVcns

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 getVcns(args: GetVcnsArgs, opts?: InvokeOptions): Promise<GetVcnsResult>
function getVcnsOutput(args: GetVcnsOutputArgs, opts?: InvokeOptions): Output<GetVcnsResult>

def get_vcns(compartment_id: Optional[str] = None,
             display_name: Optional[str] = None,
             filters: Optional[Sequence[GetVcnsFilter]] = None,
             state: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetVcnsResult
def get_vcns_output(compartment_id: Optional[pulumi.Input[str]] = None,
             display_name: Optional[pulumi.Input[str]] = None,
             filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetVcnsFilterArgs]]]] = None,
             state: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetVcnsResult]

func GetVcns(ctx *Context, args *GetVcnsArgs, opts ...InvokeOption) (*GetVcnsResult, error)
func GetVcnsOutput(ctx *Context, args *GetVcnsOutputArgs, opts ...InvokeOption) GetVcnsResultOutput

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

public static class GetVcns 
{
    public static Task<GetVcnsResult> InvokeAsync(GetVcnsArgs args, InvokeOptions? opts = null)
    public static Output<GetVcnsResult> Invoke(GetVcnsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetVcnsResult> getVcns(GetVcnsArgs args, InvokeOptions options)
public static Output<GetVcnsResult> getVcns(GetVcnsArgs args, InvokeOptions options)

fn::invoke:
  function: oci:Core/getVcns:getVcns
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string: The OCID of the compartment.
DisplayName string: A filter to return only resources that match the given display name exactly.
Filters List<GetVcnsFilter>
State string: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

CompartmentId string: The OCID of the compartment.
DisplayName string: A filter to return only resources that match the given display name exactly.
Filters []GetVcnsFilter
State string: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

compartmentId String: The OCID of the compartment.
displayName String: A filter to return only resources that match the given display name exactly.
filters List<GetVcnsFilter>
state String: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

compartmentId string: The OCID of the compartment.
displayName string: A filter to return only resources that match the given display name exactly.
filters GetVcnsFilter[]
state string: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

compartment_id str: The OCID of the compartment.
display_name str: A filter to return only resources that match the given display name exactly.
filters Sequence[GetVcnsFilter]
state str: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

compartmentId String: The OCID of the compartment.
displayName String: A filter to return only resources that match the given display name exactly.
filters List<Property Map>
state String: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

getVcns Result

The following output properties are available:

CompartmentId string: The OCID of the compartment containing the VCN.
Id string: The provider-assigned unique ID for this managed resource.
VirtualNetworks List<GetVcnsVirtualNetwork>: The list of virtual_networks.
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Filters List<GetVcnsFilter>
State string: The VCN's current state.

CompartmentId string: The OCID of the compartment containing the VCN.
Id string: The provider-assigned unique ID for this managed resource.
VirtualNetworks []GetVcnsVirtualNetwork: The list of virtual_networks.
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Filters []GetVcnsFilter
State string: The VCN's current state.

compartmentId String: The OCID of the compartment containing the VCN.
id String: The provider-assigned unique ID for this managed resource.
virtualNetworks List<GetVcnsVirtualNetwork>: The list of virtual_networks.
displayName String: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
filters List<GetVcnsFilter>
state String: The VCN's current state.

compartmentId string: The OCID of the compartment containing the VCN.
id string: The provider-assigned unique ID for this managed resource.
virtualNetworks GetVcnsVirtualNetwork[]: The list of virtual_networks.
displayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
filters GetVcnsFilter[]
state string: The VCN's current state.

compartment_id str: The OCID of the compartment containing the VCN.
id str: The provider-assigned unique ID for this managed resource.
virtual_networks Sequence[GetVcnsVirtualNetwork]: The list of virtual_networks.
display_name str: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
filters Sequence[GetVcnsFilter]
state str: The VCN's current state.

compartmentId String: The OCID of the compartment containing the VCN.
id String: The provider-assigned unique ID for this managed resource.
virtualNetworks List<Property Map>: The list of virtual_networks.
displayName String: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
filters List<Property Map>
state String: The VCN's current state.

Supporting Types

GetVcnsFilter

Name string
Values List<string>
Regex bool

Name string
Values []string
Regex bool

name String
values List<String>
regex Boolean

name string
values string[]
regex boolean

name str
values Sequence[str]
regex bool

name String
values List<String>
regex Boolean

GetVcnsVirtualNetwork

Byoipv6cidrBlocks List<string>: The list of BYOIPv6 prefixes required to create a VCN that uses BYOIPv6 ranges.
Byoipv6cidrDetails List<GetVcnsVirtualNetworkByoipv6cidrDetail>
CidrBlock string: Deprecated. The first CIDR IP address from cidr_blocks. Example: 172.16.0.0/16
CidrBlocks List<string>: The list of IPv4 CIDR blocks the VCN will use.
CompartmentId string: The OCID of the compartment.
DefaultDhcpOptionsId string: The OCID for the VCN's default set of DHCP options.
DefaultRouteTableId string: The OCID for the VCN's default route table.
DefaultSecurityListId string: The OCID for the VCN's default security list.
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 filter to return only resources that match the given display name exactly.
DnsLabel string: A DNS label for the VCN, used in conjunction with the VNIC's hostname and subnet's DNS label to form a fully qualified domain name (FQDN) for each VNIC within this subnet (for example, bminstance1.subnet123.vcn1.oraclevcn.com). Must be an alphanumeric string that begins with a letter. The value cannot be changed.
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 VCN's Oracle ID (OCID).
Ipv6cidrBlocks List<string>: For an IPv6-enabled VCN, this is the list of IPv6 prefixes for the VCN's IP address space. The prefixes are provided by Oracle and the sizes are always /56.
Ipv6privateCidrBlocks List<string>: For an IPv6-enabled VCN, this is the list of Private IPv6 prefixes for the VCN's IP address space.
IsIpv6enabled bool
IsOracleGuaAllocationEnabled bool
SecurityAttributes Dictionary<string, string>: Security Attributes for this resource. This is unique to ZPR, and helps identify which resources are allowed to be accessed by what permission controls. Example: {"Oracle-DataSecurity-ZPR.MaxEgressCount.value": "42", "Oracle-DataSecurity-ZPR.MaxEgressCount.mode": "audit"}
State string: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
TimeCreated string: The date and time the VCN was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
VcnDomainName string: The VCN's domain name, which consists of the VCN's DNS label, and the oraclevcn.com domain.

Byoipv6cidrBlocks []string: The list of BYOIPv6 prefixes required to create a VCN that uses BYOIPv6 ranges.
Byoipv6cidrDetails []GetVcnsVirtualNetworkByoipv6cidrDetail
CidrBlock string: Deprecated. The first CIDR IP address from cidr_blocks. Example: 172.16.0.0/16
CidrBlocks []string: The list of IPv4 CIDR blocks the VCN will use.
CompartmentId string: The OCID of the compartment.
DefaultDhcpOptionsId string: The OCID for the VCN's default set of DHCP options.
DefaultRouteTableId string: The OCID for the VCN's default route table.
DefaultSecurityListId string: The OCID for the VCN's default security list.
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 filter to return only resources that match the given display name exactly.
DnsLabel string: A DNS label for the VCN, used in conjunction with the VNIC's hostname and subnet's DNS label to form a fully qualified domain name (FQDN) for each VNIC within this subnet (for example, bminstance1.subnet123.vcn1.oraclevcn.com). Must be an alphanumeric string that begins with a letter. The value cannot be changed.
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 VCN's Oracle ID (OCID).
Ipv6cidrBlocks []string: For an IPv6-enabled VCN, this is the list of IPv6 prefixes for the VCN's IP address space. The prefixes are provided by Oracle and the sizes are always /56.
Ipv6privateCidrBlocks []string: For an IPv6-enabled VCN, this is the list of Private IPv6 prefixes for the VCN's IP address space.
IsIpv6enabled bool
IsOracleGuaAllocationEnabled bool
SecurityAttributes map[string]string: Security Attributes for this resource. This is unique to ZPR, and helps identify which resources are allowed to be accessed by what permission controls. Example: {"Oracle-DataSecurity-ZPR.MaxEgressCount.value": "42", "Oracle-DataSecurity-ZPR.MaxEgressCount.mode": "audit"}
State string: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
TimeCreated string: The date and time the VCN was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
VcnDomainName string: The VCN's domain name, which consists of the VCN's DNS label, and the oraclevcn.com domain.

byoipv6cidrBlocks List<String>: The list of BYOIPv6 prefixes required to create a VCN that uses BYOIPv6 ranges.
byoipv6cidrDetails List<GetVcnsVirtualNetworkByoipv6cidrDetail>
cidrBlock String: Deprecated. The first CIDR IP address from cidr_blocks. Example: 172.16.0.0/16
cidrBlocks List<String>: The list of IPv4 CIDR blocks the VCN will use.
compartmentId String: The OCID of the compartment.
defaultDhcpOptionsId String: The OCID for the VCN's default set of DHCP options.
defaultRouteTableId String: The OCID for the VCN's default route table.
defaultSecurityListId String: The OCID for the VCN's default security list.
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 filter to return only resources that match the given display name exactly.
dnsLabel String: A DNS label for the VCN, used in conjunction with the VNIC's hostname and subnet's DNS label to form a fully qualified domain name (FQDN) for each VNIC within this subnet (for example, bminstance1.subnet123.vcn1.oraclevcn.com). Must be an alphanumeric string that begins with a letter. The value cannot be changed.
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 VCN's Oracle ID (OCID).
ipv6cidrBlocks List<String>: For an IPv6-enabled VCN, this is the list of IPv6 prefixes for the VCN's IP address space. The prefixes are provided by Oracle and the sizes are always /56.
ipv6privateCidrBlocks List<String>: For an IPv6-enabled VCN, this is the list of Private IPv6 prefixes for the VCN's IP address space.
isIpv6enabled Boolean
isOracleGuaAllocationEnabled Boolean
securityAttributes Map<String,String>: Security Attributes for this resource. This is unique to ZPR, and helps identify which resources are allowed to be accessed by what permission controls. Example: {"Oracle-DataSecurity-ZPR.MaxEgressCount.value": "42", "Oracle-DataSecurity-ZPR.MaxEgressCount.mode": "audit"}
state String: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
timeCreated String: The date and time the VCN was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
vcnDomainName String: The VCN's domain name, which consists of the VCN's DNS label, and the oraclevcn.com domain.

byoipv6cidrBlocks string[]: The list of BYOIPv6 prefixes required to create a VCN that uses BYOIPv6 ranges.
byoipv6cidrDetails GetVcnsVirtualNetworkByoipv6cidrDetail[]
cidrBlock string: Deprecated. The first CIDR IP address from cidr_blocks. Example: 172.16.0.0/16
cidrBlocks string[]: The list of IPv4 CIDR blocks the VCN will use.
compartmentId string: The OCID of the compartment.
defaultDhcpOptionsId string: The OCID for the VCN's default set of DHCP options.
defaultRouteTableId string: The OCID for the VCN's default route table.
defaultSecurityListId string: The OCID for the VCN's default security list.
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 filter to return only resources that match the given display name exactly.
dnsLabel string: A DNS label for the VCN, used in conjunction with the VNIC's hostname and subnet's DNS label to form a fully qualified domain name (FQDN) for each VNIC within this subnet (for example, bminstance1.subnet123.vcn1.oraclevcn.com). Must be an alphanumeric string that begins with a letter. The value cannot be changed.
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 VCN's Oracle ID (OCID).
ipv6cidrBlocks string[]: For an IPv6-enabled VCN, this is the list of IPv6 prefixes for the VCN's IP address space. The prefixes are provided by Oracle and the sizes are always /56.
ipv6privateCidrBlocks string[]: For an IPv6-enabled VCN, this is the list of Private IPv6 prefixes for the VCN's IP address space.
isIpv6enabled boolean
isOracleGuaAllocationEnabled boolean
securityAttributes {[key: string]: string}: Security Attributes for this resource. This is unique to ZPR, and helps identify which resources are allowed to be accessed by what permission controls. Example: {"Oracle-DataSecurity-ZPR.MaxEgressCount.value": "42", "Oracle-DataSecurity-ZPR.MaxEgressCount.mode": "audit"}
state string: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
timeCreated string: The date and time the VCN was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
vcnDomainName string: The VCN's domain name, which consists of the VCN's DNS label, and the oraclevcn.com domain.

byoipv6cidr_blocks Sequence[str]: The list of BYOIPv6 prefixes required to create a VCN that uses BYOIPv6 ranges.
byoipv6cidr_details Sequence[GetVcnsVirtualNetworkByoipv6cidrDetail]
cidr_block str: Deprecated. The first CIDR IP address from cidr_blocks. Example: 172.16.0.0/16
cidr_blocks Sequence[str]: The list of IPv4 CIDR blocks the VCN will use.
compartment_id str: The OCID of the compartment.
default_dhcp_options_id str: The OCID for the VCN's default set of DHCP options.
default_route_table_id str: The OCID for the VCN's default route table.
default_security_list_id str: The OCID for the VCN's default security list.
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 filter to return only resources that match the given display name exactly.
dns_label str: A DNS label for the VCN, used in conjunction with the VNIC's hostname and subnet's DNS label to form a fully qualified domain name (FQDN) for each VNIC within this subnet (for example, bminstance1.subnet123.vcn1.oraclevcn.com). Must be an alphanumeric string that begins with a letter. The value cannot be changed.
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 VCN's Oracle ID (OCID).
ipv6cidr_blocks Sequence[str]: For an IPv6-enabled VCN, this is the list of IPv6 prefixes for the VCN's IP address space. The prefixes are provided by Oracle and the sizes are always /56.
ipv6private_cidr_blocks Sequence[str]: For an IPv6-enabled VCN, this is the list of Private IPv6 prefixes for the VCN's IP address space.
is_ipv6enabled bool
is_oracle_gua_allocation_enabled bool
security_attributes Mapping[str, str]: Security Attributes for this resource. This is unique to ZPR, and helps identify which resources are allowed to be accessed by what permission controls. Example: {"Oracle-DataSecurity-ZPR.MaxEgressCount.value": "42", "Oracle-DataSecurity-ZPR.MaxEgressCount.mode": "audit"}
state str: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
time_created str: The date and time the VCN was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
vcn_domain_name str: The VCN's domain name, which consists of the VCN's DNS label, and the oraclevcn.com domain.

byoipv6cidrBlocks List<String>: The list of BYOIPv6 prefixes required to create a VCN that uses BYOIPv6 ranges.
byoipv6cidrDetails List<Property Map>
cidrBlock String: Deprecated. The first CIDR IP address from cidr_blocks. Example: 172.16.0.0/16
cidrBlocks List<String>: The list of IPv4 CIDR blocks the VCN will use.
compartmentId String: The OCID of the compartment.
defaultDhcpOptionsId String: The OCID for the VCN's default set of DHCP options.
defaultRouteTableId String: The OCID for the VCN's default route table.
defaultSecurityListId String: The OCID for the VCN's default security list.
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 filter to return only resources that match the given display name exactly.
dnsLabel String: A DNS label for the VCN, used in conjunction with the VNIC's hostname and subnet's DNS label to form a fully qualified domain name (FQDN) for each VNIC within this subnet (for example, bminstance1.subnet123.vcn1.oraclevcn.com). Must be an alphanumeric string that begins with a letter. The value cannot be changed.
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 VCN's Oracle ID (OCID).
ipv6cidrBlocks List<String>: For an IPv6-enabled VCN, this is the list of IPv6 prefixes for the VCN's IP address space. The prefixes are provided by Oracle and the sizes are always /56.
ipv6privateCidrBlocks List<String>: For an IPv6-enabled VCN, this is the list of Private IPv6 prefixes for the VCN's IP address space.
isIpv6enabled Boolean
isOracleGuaAllocationEnabled Boolean
securityAttributes Map<String>: Security Attributes for this resource. This is unique to ZPR, and helps identify which resources are allowed to be accessed by what permission controls. Example: {"Oracle-DataSecurity-ZPR.MaxEgressCount.value": "42", "Oracle-DataSecurity-ZPR.MaxEgressCount.mode": "audit"}
state String: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
timeCreated String: The date and time the VCN was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
vcnDomainName String: The VCN's domain name, which consists of the VCN's DNS label, and the oraclevcn.com domain.