1. Packages
  2. Packages
  3. Gcorelabs Provider
  4. API Docs
  5. getNetwork
Viewing docs for gcorelabs 0.3.63
published on Monday, Apr 14, 2025 by g-core
Viewing docs for gcorelabs 0.3.63
published on Monday, Apr 14, 2025 by g-core

    Represent network. A network is a software-defined network in a cloud computing infrastructure

    Using getNetwork

    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 getNetwork(args: GetNetworkArgs, opts?: InvokeOptions): Promise<GetNetworkResult>
    function getNetworkOutput(args: GetNetworkOutputArgs, opts?: InvokeOptions): Output<GetNetworkResult>
    def get_network(id: Optional[str] = None,
                    metadata_k: Optional[str] = None,
                    metadata_kv: Optional[Mapping[str, str]] = None,
                    name: Optional[str] = None,
                    project_id: Optional[float] = None,
                    project_name: Optional[str] = None,
                    region_id: Optional[float] = None,
                    region_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetNetworkResult
    def get_network_output(id: pulumi.Input[Optional[str]] = None,
                    metadata_k: pulumi.Input[Optional[str]] = None,
                    metadata_kv: pulumi.Input[Optional[Mapping[str, pulumi.Input[str]]]] = None,
                    name: pulumi.Input[Optional[str]] = None,
                    project_id: pulumi.Input[Optional[float]] = None,
                    project_name: pulumi.Input[Optional[str]] = None,
                    region_id: pulumi.Input[Optional[float]] = None,
                    region_name: pulumi.Input[Optional[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetNetworkResult]
    func LookupNetwork(ctx *Context, args *LookupNetworkArgs, opts ...InvokeOption) (*LookupNetworkResult, error)
    func LookupNetworkOutput(ctx *Context, args *LookupNetworkOutputArgs, opts ...InvokeOption) LookupNetworkResultOutput

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

    public static class GetNetwork 
    {
        public static Task<GetNetworkResult> InvokeAsync(GetNetworkArgs args, InvokeOptions? opts = null)
        public static Output<GetNetworkResult> Invoke(GetNetworkInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetNetworkResult> getNetwork(GetNetworkArgs args, InvokeOptions options)
    public static Output<GetNetworkResult> getNetwork(GetNetworkArgs args, InvokeOptions options)
    
    fn::invoke:
      function: gcorelabs:index/getNetwork:getNetwork
      arguments:
        # arguments dictionary
    data "gcorelabs_getnetwork" "name" {
        # arguments
    }

    The following arguments are supported:

    Name string
    Id string
    The ID of this resource.
    MetadataK string
    MetadataKv Dictionary<string, string>
    ProjectId double
    ProjectName string
    RegionId double
    RegionName string
    Name string
    Id string
    The ID of this resource.
    MetadataK string
    MetadataKv map[string]string
    ProjectId float64
    ProjectName string
    RegionId float64
    RegionName string
    name string
    id string
    The ID of this resource.
    metadata_k string
    metadata_kv map(string)
    project_id number
    project_name string
    region_id number
    region_name string
    name String
    id String
    The ID of this resource.
    metadataK String
    metadataKv Map<String,String>
    projectId Double
    projectName String
    regionId Double
    regionName String
    name string
    id string
    The ID of this resource.
    metadataK string
    metadataKv {[key: string]: string}
    projectId number
    projectName string
    regionId number
    regionName string
    name str
    id str
    The ID of this resource.
    metadata_k str
    metadata_kv Mapping[str, str]
    project_id float
    project_name str
    region_id float
    region_name str
    name String
    id String
    The ID of this resource.
    metadataK String
    metadataKv Map<String>
    projectId Number
    projectName String
    regionId Number
    regionName String

    getNetwork Result

    The following output properties are available:

    External bool
    Id string
    The ID of this resource.
    MetadataReadOnlies List<GetNetworkMetadataReadOnly>
    Mtu double
    Name string
    Shared bool
    Type string
    'vlan' or 'vxlan' network type is allowed. Default value is 'vxlan'
    MetadataK string
    MetadataKv Dictionary<string, string>
    ProjectId double
    ProjectName string
    RegionId double
    RegionName string
    External bool
    Id string
    The ID of this resource.
    MetadataReadOnlies []GetNetworkMetadataReadOnly
    Mtu float64
    Name string
    Shared bool
    Type string
    'vlan' or 'vxlan' network type is allowed. Default value is 'vxlan'
    MetadataK string
    MetadataKv map[string]string
    ProjectId float64
    ProjectName string
    RegionId float64
    RegionName string
    external bool
    id string
    The ID of this resource.
    metadata_read_onlies list(object)
    mtu number
    name string
    shared bool
    type string
    'vlan' or 'vxlan' network type is allowed. Default value is 'vxlan'
    metadata_k string
    metadata_kv map(string)
    project_id number
    project_name string
    region_id number
    region_name string
    external Boolean
    id String
    The ID of this resource.
    metadataReadOnlies List<GetNetworkMetadataReadOnly>
    mtu Double
    name String
    shared Boolean
    type String
    'vlan' or 'vxlan' network type is allowed. Default value is 'vxlan'
    metadataK String
    metadataKv Map<String,String>
    projectId Double
    projectName String
    regionId Double
    regionName String
    external boolean
    id string
    The ID of this resource.
    metadataReadOnlies GetNetworkMetadataReadOnly[]
    mtu number
    name string
    shared boolean
    type string
    'vlan' or 'vxlan' network type is allowed. Default value is 'vxlan'
    metadataK string
    metadataKv {[key: string]: string}
    projectId number
    projectName string
    regionId number
    regionName string
    external bool
    id str
    The ID of this resource.
    metadata_read_onlies Sequence[GetNetworkMetadataReadOnly]
    mtu float
    name str
    shared bool
    type str
    'vlan' or 'vxlan' network type is allowed. Default value is 'vxlan'
    metadata_k str
    metadata_kv Mapping[str, str]
    project_id float
    project_name str
    region_id float
    region_name str
    external Boolean
    id String
    The ID of this resource.
    metadataReadOnlies List<Property Map>
    mtu Number
    name String
    shared Boolean
    type String
    'vlan' or 'vxlan' network type is allowed. Default value is 'vxlan'
    metadataK String
    metadataKv Map<String>
    projectId Number
    projectName String
    regionId Number
    regionName String

    Supporting Types

    GetNetworkMetadataReadOnly

    Key string
    ReadOnly bool
    Value string
    Key string
    ReadOnly bool
    Value string
    key string
    read_only bool
    value string
    key String
    readOnly Boolean
    value String
    key string
    readOnly boolean
    value string
    key str
    read_only bool
    value str
    key String
    readOnly Boolean
    value String

    Package Details

    Repository
    gcorelabs g-core/terraform-provider-gcorelabs
    License
    Notes
    This Pulumi package is based on the gcorelabs Terraform Provider.
    Viewing docs for gcorelabs 0.3.63
    published on Monday, Apr 14, 2025 by g-core
      Try Pulumi Cloud free. Your team will thank you.