Oracle Cloud Infrastructure
getNetworkLoadBalancer
This data source provides details about a specific Network Load Balancer resource in Oracle Cloud Infrastructure Network Load Balancer service.
Retrieves network load balancer configuration information by identifier.
Example Usage
using Pulumi;
using Oci = Pulumi.Oci;
class MyStack : Stack
{
public MyStack()
{
var testNetworkLoadBalancer = Output.Create(Oci.NetworkLoadBalancer.GetNetworkLoadBalancer.InvokeAsync(new Oci.NetworkLoadBalancer.GetNetworkLoadBalancerArgs
{
NetworkLoadBalancerId = oci_network_load_balancer_network_load_balancer.Test_network_load_balancer.Id,
}));
}
}
package main
import (
"github.com/pulumi/pulumi-oci/sdk/go/oci/NetworkLoadBalancer"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := NetworkLoadBalancer.GetNetworkLoadBalancer(ctx, &networkloadbalancer.GetNetworkLoadBalancerArgs{
NetworkLoadBalancerId: oci_network_load_balancer_network_load_balancer.Test_network_load_balancer.Id,
}, nil)
if err != nil {
return err
}
return nil
})
}
Coming soon!
import pulumi
import pulumi_oci as oci
test_network_load_balancer = oci.NetworkLoadBalancer.get_network_load_balancer(network_load_balancer_id=oci_network_load_balancer_network_load_balancer["test_network_load_balancer"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testNetworkLoadBalancer = oci.NetworkLoadBalancer.getNetworkLoadBalancer({
networkLoadBalancerId: oci_network_load_balancer_network_load_balancer.test_network_load_balancer.id,
});
Coming soon!
Using getNetworkLoadBalancer
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 getNetworkLoadBalancer(args: GetNetworkLoadBalancerArgs, opts?: InvokeOptions): Promise<GetNetworkLoadBalancerResult>
function getNetworkLoadBalancerOutput(args: GetNetworkLoadBalancerOutputArgs, opts?: InvokeOptions): Output<GetNetworkLoadBalancerResult>
def get_network_load_balancer(network_load_balancer_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetNetworkLoadBalancerResult
def get_network_load_balancer_output(network_load_balancer_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetNetworkLoadBalancerResult]
func GetNetworkLoadBalancer(ctx *Context, args *GetNetworkLoadBalancerArgs, opts ...InvokeOption) (*GetNetworkLoadBalancerResult, error)
func GetNetworkLoadBalancerOutput(ctx *Context, args *GetNetworkLoadBalancerOutputArgs, opts ...InvokeOption) GetNetworkLoadBalancerResultOutput
> Note: This function is named GetNetworkLoadBalancer
in the Go SDK.
public static class GetNetworkLoadBalancer
{
public static Task<GetNetworkLoadBalancerResult> InvokeAsync(GetNetworkLoadBalancerArgs args, InvokeOptions? opts = null)
public static Output<GetNetworkLoadBalancerResult> Invoke(GetNetworkLoadBalancerInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetNetworkLoadBalancerResult> getNetworkLoadBalancer(GetNetworkLoadBalancerArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
Function: oci:NetworkLoadBalancer/getNetworkLoadBalancer:getNetworkLoadBalancer
Arguments:
# Arguments dictionary
The following arguments are supported:
- Network
Load stringBalancer Id The OCID of the network load balancer to update.
- Network
Load stringBalancer Id The OCID of the network load balancer to update.
- network
Load StringBalancer Id The OCID of the network load balancer to update.
- network
Load stringBalancer Id The OCID of the network load balancer to update.
- network_
load_ strbalancer_ id The OCID of the network load balancer to update.
- network
Load StringBalancer Id The OCID of the network load balancer to update.
getNetworkLoadBalancer Result
The following output properties are available:
- Compartment
Id string The OCID of the compartment containing the network load balancer.
- 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"}
- Display
Name string A user-friendly name, which does not have to be unique, and can be changed. Example:
example_load_balancer
- 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
OCID of the reserved public IP address created with the virtual cloud network.
- Ip
Addresses List<GetNetwork Load Balancer Ip Address> An array of IP addresses.
- Is
Preserve boolSource Destination When enabled, the skipSourceDestinationCheck parameter is automatically enabled on the load balancer VNIC. Packets are sent to the backend set without any changes to the source and destination IP.
- Is
Private bool Whether the network load balancer has a virtual cloud network-local (private) IP address.
- Lifecycle
Details string A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- Network
Load stringBalancer Id - Network
Security List<string>Group Ids An array of network security groups OCIDs associated with the network load balancer.
- Nlb
Ip stringVersion IP version associated with the NLB.
- Reserved
Ips List<GetNetwork Load Balancer Reserved Ip> - State string
The current state of the network load balancer.
- Subnet
Id string The subnet in which the network load balancer is spawned OCIDs."
- Dictionary<string, object>
Key-value pair representing system tags' keys and values scoped to a namespace. Example:
{"bar-key": "value"}
- Time
Created string The date and time the network load balancer was created, in the format defined by RFC3339. Example:
2020-05-01T21:10:29.600Z
- Time
Updated string The time the network load balancer was updated. An RFC3339 formatted date-time string. Example:
2020-05-01T22:10:29.600Z
- Compartment
Id string The OCID of the compartment containing the network load balancer.
- 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"}
- Display
Name string A user-friendly name, which does not have to be unique, and can be changed. Example:
example_load_balancer
- 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
OCID of the reserved public IP address created with the virtual cloud network.
- Ip
Addresses []GetNetwork Load Balancer Ip Address An array of IP addresses.
- Is
Preserve boolSource Destination When enabled, the skipSourceDestinationCheck parameter is automatically enabled on the load balancer VNIC. Packets are sent to the backend set without any changes to the source and destination IP.
- Is
Private bool Whether the network load balancer has a virtual cloud network-local (private) IP address.
- Lifecycle
Details string A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- Network
Load stringBalancer Id - Network
Security []stringGroup Ids An array of network security groups OCIDs associated with the network load balancer.
- Nlb
Ip stringVersion IP version associated with the NLB.
- Reserved
Ips []GetNetwork Load Balancer Reserved Ip - State string
The current state of the network load balancer.
- Subnet
Id string The subnet in which the network load balancer is spawned OCIDs."
- map[string]interface{}
Key-value pair representing system tags' keys and values scoped to a namespace. Example:
{"bar-key": "value"}
- Time
Created string The date and time the network load balancer was created, in the format defined by RFC3339. Example:
2020-05-01T21:10:29.600Z
- Time
Updated string The time the network load balancer was updated. An RFC3339 formatted date-time string. Example:
2020-05-01T22:10:29.600Z
- compartment
Id String The OCID of the compartment containing the network load balancer.
- 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"}
- display
Name String A user-friendly name, which does not have to be unique, and can be changed. Example:
example_load_balancer
- 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
OCID of the reserved public IP address created with the virtual cloud network.
- ip
Addresses List<GetIp Address> An array of IP addresses.
- is
Preserve BooleanSource Destination When enabled, the skipSourceDestinationCheck parameter is automatically enabled on the load balancer VNIC. Packets are sent to the backend set without any changes to the source and destination IP.
- is
Private Boolean Whether the network load balancer has a virtual cloud network-local (private) IP address.
- lifecycle
Details String A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- network
Load StringBalancer Id - network
Security List<String>Group Ids An array of network security groups OCIDs associated with the network load balancer.
- nlb
Ip StringVersion IP version associated with the NLB.
- reserved
Ips List<GetReserved Ip> - state String
The current state of the network load balancer.
- subnet
Id String The subnet in which the network load balancer is spawned OCIDs."
- Map<String,Object>
Key-value pair representing system tags' keys and values scoped to a namespace. Example:
{"bar-key": "value"}
- time
Created String The date and time the network load balancer was created, in the format defined by RFC3339. Example:
2020-05-01T21:10:29.600Z
- time
Updated String The time the network load balancer was updated. An RFC3339 formatted date-time string. Example:
2020-05-01T22:10:29.600Z
- compartment
Id string The OCID of the compartment containing the network load balancer.
- {[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"}
- display
Name string A user-friendly name, which does not have to be unique, and can be changed. Example:
example_load_balancer
- {[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
OCID of the reserved public IP address created with the virtual cloud network.
- ip
Addresses GetNetwork Load Balancer Ip Address[] An array of IP addresses.
- is
Preserve booleanSource Destination When enabled, the skipSourceDestinationCheck parameter is automatically enabled on the load balancer VNIC. Packets are sent to the backend set without any changes to the source and destination IP.
- is
Private boolean Whether the network load balancer has a virtual cloud network-local (private) IP address.
- lifecycle
Details string A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- network
Load stringBalancer Id - network
Security string[]Group Ids An array of network security groups OCIDs associated with the network load balancer.
- nlb
Ip stringVersion IP version associated with the NLB.
- reserved
Ips GetNetwork Load Balancer Reserved Ip[] - state string
The current state of the network load balancer.
- subnet
Id string The subnet in which the network load balancer is spawned OCIDs."
- {[key: string]: any}
Key-value pair representing system tags' keys and values scoped to a namespace. Example:
{"bar-key": "value"}
- time
Created string The date and time the network load balancer was created, in the format defined by RFC3339. Example:
2020-05-01T21:10:29.600Z
- time
Updated string The time the network load balancer was updated. An RFC3339 formatted date-time string. Example:
2020-05-01T22:10:29.600Z
- compartment_
id str The OCID of the compartment containing the network load balancer.
- 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"}
- display_
name str A user-friendly name, which does not have to be unique, and can be changed. Example:
example_load_balancer
- 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
OCID of the reserved public IP address created with the virtual cloud network.
- ip_
addresses GetNetwork Load Balancer Ip Address] An array of IP addresses.
- is_
preserve_ boolsource_ destination When enabled, the skipSourceDestinationCheck parameter is automatically enabled on the load balancer VNIC. Packets are sent to the backend set without any changes to the source and destination IP.
- is_
private bool Whether the network load balancer has a virtual cloud network-local (private) IP address.
- lifecycle_
details str A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- network_
load_ strbalancer_ id - network_
security_ Sequence[str]group_ ids An array of network security groups OCIDs associated with the network load balancer.
- nlb_
ip_ strversion IP version associated with the NLB.
- reserved_
ips GetNetwork Load Balancer Reserved Ip] - state str
The current state of the network load balancer.
- subnet_
id str The subnet in which the network load balancer is spawned OCIDs."
- Mapping[str, Any]
Key-value pair representing system tags' keys and values scoped to a namespace. Example:
{"bar-key": "value"}
- time_
created str The date and time the network load balancer was created, in the format defined by RFC3339. Example:
2020-05-01T21:10:29.600Z
- time_
updated str The time the network load balancer was updated. An RFC3339 formatted date-time string. Example:
2020-05-01T22:10:29.600Z
- compartment
Id String The OCID of the compartment containing the network load balancer.
- 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"}
- display
Name String A user-friendly name, which does not have to be unique, and can be changed. Example:
example_load_balancer
- 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
OCID of the reserved public IP address created with the virtual cloud network.
- ip
Addresses List<Property Map> An array of IP addresses.
- is
Preserve BooleanSource Destination When enabled, the skipSourceDestinationCheck parameter is automatically enabled on the load balancer VNIC. Packets are sent to the backend set without any changes to the source and destination IP.
- is
Private Boolean Whether the network load balancer has a virtual cloud network-local (private) IP address.
- lifecycle
Details String A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- network
Load StringBalancer Id - network
Security List<String>Group Ids An array of network security groups OCIDs associated with the network load balancer.
- nlb
Ip StringVersion IP version associated with the NLB.
- reserved
Ips List<Property Map> - state String
The current state of the network load balancer.
- subnet
Id String The subnet in which the network load balancer is spawned OCIDs."
- Map<Any>
Key-value pair representing system tags' keys and values scoped to a namespace. Example:
{"bar-key": "value"}
- time
Created String The date and time the network load balancer was created, in the format defined by RFC3339. Example:
2020-05-01T21:10:29.600Z
- time
Updated String The time the network load balancer was updated. An RFC3339 formatted date-time string. Example:
2020-05-01T22:10:29.600Z
Supporting Types
GetNetworkLoadBalancerIpAddress
- Ip
Address string An IP address. Example:
192.168.0.3
- Ip
Version string IP version associated with this IP address.
- Is
Public bool Whether the IP address is public or private.
- Reserved
Ips List<GetNetwork Load Balancer Ip Address Reserved Ip> An object representing a reserved IP address to be attached or that is already attached to a network load balancer.
- Ip
Address string An IP address. Example:
192.168.0.3
- Ip
Version string IP version associated with this IP address.
- Is
Public bool Whether the IP address is public or private.
- Reserved
Ips []GetNetwork Load Balancer Ip Address Reserved Ip An object representing a reserved IP address to be attached or that is already attached to a network load balancer.
- ip
Address String An IP address. Example:
192.168.0.3
- ip
Version String IP version associated with this IP address.
- is
Public Boolean Whether the IP address is public or private.
- reserved
Ips List<GetIp Address Reserved Ip> An object representing a reserved IP address to be attached or that is already attached to a network load balancer.
- ip
Address string An IP address. Example:
192.168.0.3
- ip
Version string IP version associated with this IP address.
- is
Public boolean Whether the IP address is public or private.
- reserved
Ips GetNetwork Load Balancer Ip Address Reserved Ip[] An object representing a reserved IP address to be attached or that is already attached to a network load balancer.
- ip_
address str An IP address. Example:
192.168.0.3
- ip_
version str IP version associated with this IP address.
- is_
public bool Whether the IP address is public or private.
- reserved_
ips GetNetwork Load Balancer Ip Address Reserved Ip] An object representing a reserved IP address to be attached or that is already attached to a network load balancer.
- ip
Address String An IP address. Example:
192.168.0.3
- ip
Version String IP version associated with this IP address.
- is
Public Boolean Whether the IP address is public or private.
- reserved
Ips List<Property Map> An object representing a reserved IP address to be attached or that is already attached to a network load balancer.
GetNetworkLoadBalancerIpAddressReservedIp
- Id string
OCID of the reserved public IP address created with the virtual cloud network.
- Id string
OCID of the reserved public IP address created with the virtual cloud network.
- id String
OCID of the reserved public IP address created with the virtual cloud network.
- id string
OCID of the reserved public IP address created with the virtual cloud network.
- id str
OCID of the reserved public IP address created with the virtual cloud network.
- id String
OCID of the reserved public IP address created with the virtual cloud network.
GetNetworkLoadBalancerReservedIp
- Id string
OCID of the reserved public IP address created with the virtual cloud network.
- Id string
OCID of the reserved public IP address created with the virtual cloud network.
- id String
OCID of the reserved public IP address created with the virtual cloud network.
- id string
OCID of the reserved public IP address created with the virtual cloud network.
- id str
OCID of the reserved public IP address created with the virtual cloud network.
- id String
OCID of the reserved public IP address created with the virtual cloud network.
Package Details
- Repository
- https://github.com/pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
oci
Terraform Provider.