1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Core
  5. getSubnet
Oracle Cloud Infrastructure v1.31.0 published on Wednesday, Apr 10, 2024 by Pulumi

oci.Core.getSubnet

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.31.0 published on Wednesday, Apr 10, 2024 by Pulumi

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

    Gets the specified subnet’s information.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testSubnet = oci.Core.getSubnet({
        subnetId: oci_core_subnet.test_subnet.id,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_subnet = oci.Core.get_subnet(subnet_id=oci_core_subnet["test_subnet"]["id"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/go/oci/Core"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Core.GetSubnet(ctx, &core.GetSubnetArgs{
    			SubnetId: oci_core_subnet.Test_subnet.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 testSubnet = Oci.Core.GetSubnet.Invoke(new()
        {
            SubnetId = oci_core_subnet.Test_subnet.Id,
        });
    
    });
    
    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.GetSubnetArgs;
    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 testSubnet = CoreFunctions.getSubnet(GetSubnetArgs.builder()
                .subnetId(oci_core_subnet.test_subnet().id())
                .build());
    
        }
    }
    
    variables:
      testSubnet:
        fn::invoke:
          Function: oci:Core:getSubnet
          Arguments:
            subnetId: ${oci_core_subnet.test_subnet.id}
    

    Using getSubnet

    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 getSubnet(args: GetSubnetArgs, opts?: InvokeOptions): Promise<GetSubnetResult>
    function getSubnetOutput(args: GetSubnetOutputArgs, opts?: InvokeOptions): Output<GetSubnetResult>
    def get_subnet(subnet_id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetSubnetResult
    def get_subnet_output(subnet_id: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetSubnetResult]
    func GetSubnet(ctx *Context, args *GetSubnetArgs, opts ...InvokeOption) (*GetSubnetResult, error)
    func GetSubnetOutput(ctx *Context, args *GetSubnetOutputArgs, opts ...InvokeOption) GetSubnetResultOutput

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

    public static class GetSubnet 
    {
        public static Task<GetSubnetResult> InvokeAsync(GetSubnetArgs args, InvokeOptions? opts = null)
        public static Output<GetSubnetResult> Invoke(GetSubnetInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSubnetResult> getSubnet(GetSubnetArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:Core/getSubnet:getSubnet
      arguments:
        # arguments dictionary

    The following arguments are supported:

    SubnetId string
    The OCID of the subnet.
    SubnetId string
    The OCID of the subnet.
    subnetId String
    The OCID of the subnet.
    subnetId string
    The OCID of the subnet.
    subnet_id str
    The OCID of the subnet.
    subnetId String
    The OCID of the subnet.

    getSubnet Result

    The following output properties are available:

    AvailabilityDomain string
    The subnet's availability domain. This attribute will be null if this is a regional subnet instead of an AD-specific subnet. Oracle recommends creating regional subnets. Example: Uocm:PHX-AD-1
    CidrBlock string
    The subnet's CIDR block. Example: 10.0.1.0/24
    CompartmentId string
    The OCID of the compartment containing the subnet.
    DefinedTags Dictionary<string, object>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DhcpOptionsId string
    The OCID of the set of DHCP options that the subnet uses.
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    DnsLabel string
    A DNS label for the subnet, used in conjunction with the VNIC's hostname and VCN'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 and is unique within the VCN. The value cannot be changed.
    FreeformTags Dictionary<string, object>
    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 subnet's Oracle ID (OCID).
    Ipv6cidrBlock string
    For an IPv6-enabled subnet, this is the IPv6 prefix for the subnet's IP address space. The subnet size is always /64. See IPv6 Addresses. Example: 2001:0db8:0123:1111::/64
    Ipv6cidrBlocks List<string>
    The list of all IPv6 prefixes (Oracle allocated IPv6 GUA, ULA or private IPv6 prefixes, BYOIPv6 prefixes) for the subnet.
    Ipv6virtualRouterIp string
    For an IPv6-enabled subnet, this is the IPv6 address of the virtual router. Example: 2001:0db8:0123:1111:89ab:cdef:1234:5678
    ProhibitInternetIngress bool
    Whether to disallow ingress internet traffic to VNICs within this subnet. Defaults to false.
    ProhibitPublicIpOnVnic bool
    Whether VNICs within this subnet can have public IP addresses. Defaults to false, which means VNICs created in this subnet will automatically be assigned public IP addresses unless specified otherwise during instance launch or VNIC creation (with the assignPublicIp flag in CreateVnicDetails). If prohibitPublicIpOnVnic is set to true, VNICs created in this subnet cannot have public IP addresses (that is, it's a private subnet). Example: true
    RouteTableId string
    The OCID of the route table that the subnet uses.
    SecurityListIds List<string>
    The OCIDs of the security list or lists that the subnet uses. Remember that security lists are associated with the subnet, but the rules are applied to the individual VNICs in the subnet.
    State string
    The subnet's current state.
    SubnetDomainName string
    The subnet's domain name, which consists of the subnet's DNS label, the VCN's DNS label, and the oraclevcn.com domain.
    SubnetId string
    TimeCreated string
    The date and time the subnet was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    VcnId string
    The OCID of the VCN the subnet is in.
    VirtualRouterIp string
    The IP address of the virtual router. Example: 10.0.14.1
    VirtualRouterMac string
    The MAC address of the virtual router. Example: 00:00:00:00:00:01
    AvailabilityDomain string
    The subnet's availability domain. This attribute will be null if this is a regional subnet instead of an AD-specific subnet. Oracle recommends creating regional subnets. Example: Uocm:PHX-AD-1
    CidrBlock string
    The subnet's CIDR block. Example: 10.0.1.0/24
    CompartmentId string
    The OCID of the compartment containing the subnet.
    DefinedTags map[string]interface{}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DhcpOptionsId string
    The OCID of the set of DHCP options that the subnet uses.
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    DnsLabel string
    A DNS label for the subnet, used in conjunction with the VNIC's hostname and VCN'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 and is unique within the VCN. The value cannot be changed.
    FreeformTags map[string]interface{}
    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 subnet's Oracle ID (OCID).
    Ipv6cidrBlock string
    For an IPv6-enabled subnet, this is the IPv6 prefix for the subnet's IP address space. The subnet size is always /64. See IPv6 Addresses. Example: 2001:0db8:0123:1111::/64
    Ipv6cidrBlocks []string
    The list of all IPv6 prefixes (Oracle allocated IPv6 GUA, ULA or private IPv6 prefixes, BYOIPv6 prefixes) for the subnet.
    Ipv6virtualRouterIp string
    For an IPv6-enabled subnet, this is the IPv6 address of the virtual router. Example: 2001:0db8:0123:1111:89ab:cdef:1234:5678
    ProhibitInternetIngress bool
    Whether to disallow ingress internet traffic to VNICs within this subnet. Defaults to false.
    ProhibitPublicIpOnVnic bool
    Whether VNICs within this subnet can have public IP addresses. Defaults to false, which means VNICs created in this subnet will automatically be assigned public IP addresses unless specified otherwise during instance launch or VNIC creation (with the assignPublicIp flag in CreateVnicDetails). If prohibitPublicIpOnVnic is set to true, VNICs created in this subnet cannot have public IP addresses (that is, it's a private subnet). Example: true
    RouteTableId string
    The OCID of the route table that the subnet uses.
    SecurityListIds []string
    The OCIDs of the security list or lists that the subnet uses. Remember that security lists are associated with the subnet, but the rules are applied to the individual VNICs in the subnet.
    State string
    The subnet's current state.
    SubnetDomainName string
    The subnet's domain name, which consists of the subnet's DNS label, the VCN's DNS label, and the oraclevcn.com domain.
    SubnetId string
    TimeCreated string
    The date and time the subnet was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    VcnId string
    The OCID of the VCN the subnet is in.
    VirtualRouterIp string
    The IP address of the virtual router. Example: 10.0.14.1
    VirtualRouterMac string
    The MAC address of the virtual router. Example: 00:00:00:00:00:01
    availabilityDomain String
    The subnet's availability domain. This attribute will be null if this is a regional subnet instead of an AD-specific subnet. Oracle recommends creating regional subnets. Example: Uocm:PHX-AD-1
    cidrBlock String
    The subnet's CIDR block. Example: 10.0.1.0/24
    compartmentId String
    The OCID of the compartment containing the subnet.
    definedTags Map<String,Object>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    dhcpOptionsId String
    The OCID of the set of DHCP options that the subnet uses.
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    dnsLabel String
    A DNS label for the subnet, used in conjunction with the VNIC's hostname and VCN'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 and is unique within the VCN. The value cannot be changed.
    freeformTags Map<String,Object>
    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 subnet's Oracle ID (OCID).
    ipv6cidrBlock String
    For an IPv6-enabled subnet, this is the IPv6 prefix for the subnet's IP address space. The subnet size is always /64. See IPv6 Addresses. Example: 2001:0db8:0123:1111::/64
    ipv6cidrBlocks List<String>
    The list of all IPv6 prefixes (Oracle allocated IPv6 GUA, ULA or private IPv6 prefixes, BYOIPv6 prefixes) for the subnet.
    ipv6virtualRouterIp String
    For an IPv6-enabled subnet, this is the IPv6 address of the virtual router. Example: 2001:0db8:0123:1111:89ab:cdef:1234:5678
    prohibitInternetIngress Boolean
    Whether to disallow ingress internet traffic to VNICs within this subnet. Defaults to false.
    prohibitPublicIpOnVnic Boolean
    Whether VNICs within this subnet can have public IP addresses. Defaults to false, which means VNICs created in this subnet will automatically be assigned public IP addresses unless specified otherwise during instance launch or VNIC creation (with the assignPublicIp flag in CreateVnicDetails). If prohibitPublicIpOnVnic is set to true, VNICs created in this subnet cannot have public IP addresses (that is, it's a private subnet). Example: true
    routeTableId String
    The OCID of the route table that the subnet uses.
    securityListIds List<String>
    The OCIDs of the security list or lists that the subnet uses. Remember that security lists are associated with the subnet, but the rules are applied to the individual VNICs in the subnet.
    state String
    The subnet's current state.
    subnetDomainName String
    The subnet's domain name, which consists of the subnet's DNS label, the VCN's DNS label, and the oraclevcn.com domain.
    subnetId String
    timeCreated String
    The date and time the subnet was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    vcnId String
    The OCID of the VCN the subnet is in.
    virtualRouterIp String
    The IP address of the virtual router. Example: 10.0.14.1
    virtualRouterMac String
    The MAC address of the virtual router. Example: 00:00:00:00:00:01
    availabilityDomain string
    The subnet's availability domain. This attribute will be null if this is a regional subnet instead of an AD-specific subnet. Oracle recommends creating regional subnets. Example: Uocm:PHX-AD-1
    cidrBlock string
    The subnet's CIDR block. Example: 10.0.1.0/24
    compartmentId string
    The OCID of the compartment containing the subnet.
    definedTags {[key: string]: any}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    dhcpOptionsId string
    The OCID of the set of DHCP options that the subnet uses.
    displayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    dnsLabel string
    A DNS label for the subnet, used in conjunction with the VNIC's hostname and VCN'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 and is unique within the VCN. The value cannot be changed.
    freeformTags {[key: string]: any}
    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 subnet's Oracle ID (OCID).
    ipv6cidrBlock string
    For an IPv6-enabled subnet, this is the IPv6 prefix for the subnet's IP address space. The subnet size is always /64. See IPv6 Addresses. Example: 2001:0db8:0123:1111::/64
    ipv6cidrBlocks string[]
    The list of all IPv6 prefixes (Oracle allocated IPv6 GUA, ULA or private IPv6 prefixes, BYOIPv6 prefixes) for the subnet.
    ipv6virtualRouterIp string
    For an IPv6-enabled subnet, this is the IPv6 address of the virtual router. Example: 2001:0db8:0123:1111:89ab:cdef:1234:5678
    prohibitInternetIngress boolean
    Whether to disallow ingress internet traffic to VNICs within this subnet. Defaults to false.
    prohibitPublicIpOnVnic boolean
    Whether VNICs within this subnet can have public IP addresses. Defaults to false, which means VNICs created in this subnet will automatically be assigned public IP addresses unless specified otherwise during instance launch or VNIC creation (with the assignPublicIp flag in CreateVnicDetails). If prohibitPublicIpOnVnic is set to true, VNICs created in this subnet cannot have public IP addresses (that is, it's a private subnet). Example: true
    routeTableId string
    The OCID of the route table that the subnet uses.
    securityListIds string[]
    The OCIDs of the security list or lists that the subnet uses. Remember that security lists are associated with the subnet, but the rules are applied to the individual VNICs in the subnet.
    state string
    The subnet's current state.
    subnetDomainName string
    The subnet's domain name, which consists of the subnet's DNS label, the VCN's DNS label, and the oraclevcn.com domain.
    subnetId string
    timeCreated string
    The date and time the subnet was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    vcnId string
    The OCID of the VCN the subnet is in.
    virtualRouterIp string
    The IP address of the virtual router. Example: 10.0.14.1
    virtualRouterMac string
    The MAC address of the virtual router. Example: 00:00:00:00:00:01
    availability_domain str
    The subnet's availability domain. This attribute will be null if this is a regional subnet instead of an AD-specific subnet. Oracle recommends creating regional subnets. Example: Uocm:PHX-AD-1
    cidr_block str
    The subnet's CIDR block. Example: 10.0.1.0/24
    compartment_id str
    The OCID of the compartment containing the subnet.
    defined_tags Mapping[str, Any]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    dhcp_options_id str
    The OCID of the set of DHCP options that the subnet uses.
    display_name str
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    dns_label str
    A DNS label for the subnet, used in conjunction with the VNIC's hostname and VCN'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 and is unique within the VCN. The value cannot be changed.
    freeform_tags Mapping[str, Any]
    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 subnet's Oracle ID (OCID).
    ipv6cidr_block str
    For an IPv6-enabled subnet, this is the IPv6 prefix for the subnet's IP address space. The subnet size is always /64. See IPv6 Addresses. Example: 2001:0db8:0123:1111::/64
    ipv6cidr_blocks Sequence[str]
    The list of all IPv6 prefixes (Oracle allocated IPv6 GUA, ULA or private IPv6 prefixes, BYOIPv6 prefixes) for the subnet.
    ipv6virtual_router_ip str
    For an IPv6-enabled subnet, this is the IPv6 address of the virtual router. Example: 2001:0db8:0123:1111:89ab:cdef:1234:5678
    prohibit_internet_ingress bool
    Whether to disallow ingress internet traffic to VNICs within this subnet. Defaults to false.
    prohibit_public_ip_on_vnic bool
    Whether VNICs within this subnet can have public IP addresses. Defaults to false, which means VNICs created in this subnet will automatically be assigned public IP addresses unless specified otherwise during instance launch or VNIC creation (with the assignPublicIp flag in CreateVnicDetails). If prohibitPublicIpOnVnic is set to true, VNICs created in this subnet cannot have public IP addresses (that is, it's a private subnet). Example: true
    route_table_id str
    The OCID of the route table that the subnet uses.
    security_list_ids Sequence[str]
    The OCIDs of the security list or lists that the subnet uses. Remember that security lists are associated with the subnet, but the rules are applied to the individual VNICs in the subnet.
    state str
    The subnet's current state.
    subnet_domain_name str
    The subnet's domain name, which consists of the subnet's DNS label, the VCN's DNS label, and the oraclevcn.com domain.
    subnet_id str
    time_created str
    The date and time the subnet was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    vcn_id str
    The OCID of the VCN the subnet is in.
    virtual_router_ip str
    The IP address of the virtual router. Example: 10.0.14.1
    virtual_router_mac str
    The MAC address of the virtual router. Example: 00:00:00:00:00:01
    availabilityDomain String
    The subnet's availability domain. This attribute will be null if this is a regional subnet instead of an AD-specific subnet. Oracle recommends creating regional subnets. Example: Uocm:PHX-AD-1
    cidrBlock String
    The subnet's CIDR block. Example: 10.0.1.0/24
    compartmentId String
    The OCID of the compartment containing the subnet.
    definedTags Map<Any>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    dhcpOptionsId String
    The OCID of the set of DHCP options that the subnet uses.
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    dnsLabel String
    A DNS label for the subnet, used in conjunction with the VNIC's hostname and VCN'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 and is unique within the VCN. The value cannot be changed.
    freeformTags Map<Any>
    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 subnet's Oracle ID (OCID).
    ipv6cidrBlock String
    For an IPv6-enabled subnet, this is the IPv6 prefix for the subnet's IP address space. The subnet size is always /64. See IPv6 Addresses. Example: 2001:0db8:0123:1111::/64
    ipv6cidrBlocks List<String>
    The list of all IPv6 prefixes (Oracle allocated IPv6 GUA, ULA or private IPv6 prefixes, BYOIPv6 prefixes) for the subnet.
    ipv6virtualRouterIp String
    For an IPv6-enabled subnet, this is the IPv6 address of the virtual router. Example: 2001:0db8:0123:1111:89ab:cdef:1234:5678
    prohibitInternetIngress Boolean
    Whether to disallow ingress internet traffic to VNICs within this subnet. Defaults to false.
    prohibitPublicIpOnVnic Boolean
    Whether VNICs within this subnet can have public IP addresses. Defaults to false, which means VNICs created in this subnet will automatically be assigned public IP addresses unless specified otherwise during instance launch or VNIC creation (with the assignPublicIp flag in CreateVnicDetails). If prohibitPublicIpOnVnic is set to true, VNICs created in this subnet cannot have public IP addresses (that is, it's a private subnet). Example: true
    routeTableId String
    The OCID of the route table that the subnet uses.
    securityListIds List<String>
    The OCIDs of the security list or lists that the subnet uses. Remember that security lists are associated with the subnet, but the rules are applied to the individual VNICs in the subnet.
    state String
    The subnet's current state.
    subnetDomainName String
    The subnet's domain name, which consists of the subnet's DNS label, the VCN's DNS label, and the oraclevcn.com domain.
    subnetId String
    timeCreated String
    The date and time the subnet was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    vcnId String
    The OCID of the VCN the subnet is in.
    virtualRouterIp String
    The IP address of the virtual router. Example: 10.0.14.1
    virtualRouterMac String
    The MAC address of the virtual router. Example: 00:00:00:00:00:01

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v1.31.0 published on Wednesday, Apr 10, 2024 by Pulumi