Oracle Cloud Infrastructure

Pulumi Official

Package maintained by Pulumi

v0.1.1 published on Tuesday, May 3, 2022 by Pulumi

getNetworkLoadBalancers

This data source provides the list of Network Load Balancers in Oracle Cloud Infrastructure Network Load Balancer service.

Returns a list of network load balancers.

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testNetworkLoadBalancers = Output.Create(Oci.NetworkLoadBalancer.GetNetworkLoadBalancers.InvokeAsync(new Oci.NetworkLoadBalancer.GetNetworkLoadBalancersArgs
        {
            CompartmentId = @var.Compartment_id,
            DisplayName = @var.Network_load_balancer_display_name,
            State = @var.Network_load_balancer_state,
        }));
    }

}

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.GetNetworkLoadBalancers(ctx, &networkloadbalancer.GetNetworkLoadBalancersArgs{
			CompartmentId: _var.Compartment_id,
			DisplayName:   pulumi.StringRef(_var.Network_load_balancer_display_name),
			State:         pulumi.StringRef(_var.Network_load_balancer_state),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_network_load_balancers = oci.NetworkLoadBalancer.get_network_load_balancers(compartment_id=var["compartment_id"],
    display_name=var["network_load_balancer_display_name"],
    state=var["network_load_balancer_state"])

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

const testNetworkLoadBalancers = oci.NetworkLoadBalancer.getNetworkLoadBalancers({
    compartmentId: _var.compartment_id,
    displayName: _var.network_load_balancer_display_name,
    state: _var.network_load_balancer_state,
});

Coming soon!

Using getNetworkLoadBalancers

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 getNetworkLoadBalancers(args: GetNetworkLoadBalancersArgs, opts?: InvokeOptions): Promise<GetNetworkLoadBalancersResult>
function getNetworkLoadBalancersOutput(args: GetNetworkLoadBalancersOutputArgs, opts?: InvokeOptions): Output<GetNetworkLoadBalancersResult>

def get_network_load_balancers(compartment_id: Optional[str] = None,
                               display_name: Optional[str] = None,
                               filters: Optional[Sequence[_networkloadbalancer.GetNetworkLoadBalancersFilter]] = None,
                               state: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetNetworkLoadBalancersResult
def get_network_load_balancers_output(compartment_id: Optional[pulumi.Input[str]] = None,
                               display_name: Optional[pulumi.Input[str]] = None,
                               filters: Optional[pulumi.Input[Sequence[pulumi.Input[_networkloadbalancer.GetNetworkLoadBalancersFilterArgs]]]] = None,
                               state: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetNetworkLoadBalancersResult]

func GetNetworkLoadBalancers(ctx *Context, args *GetNetworkLoadBalancersArgs, opts ...InvokeOption) (*GetNetworkLoadBalancersResult, error)
func GetNetworkLoadBalancersOutput(ctx *Context, args *GetNetworkLoadBalancersOutputArgs, opts ...InvokeOption) GetNetworkLoadBalancersResultOutput

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

public static class GetNetworkLoadBalancers 
{
    public static Task<GetNetworkLoadBalancersResult> InvokeAsync(GetNetworkLoadBalancersArgs args, InvokeOptions? opts = null)
    public static Output<GetNetworkLoadBalancersResult> Invoke(GetNetworkLoadBalancersInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetNetworkLoadBalancersResult> getNetworkLoadBalancers(GetNetworkLoadBalancersArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

Fn::Invoke:
  Function: oci:NetworkLoadBalancer/getNetworkLoadBalancers:getNetworkLoadBalancers
  Arguments:
    # Arguments dictionary

The following arguments are supported:

CompartmentId string: The OCID of the compartment containing the network load balancers to list.
DisplayName string: A filter to return only resources that match the entire display name given.
Filters List<GetNetworkLoadBalancersFilter>
State string: A filter to return only resources that match the given lifecycle state.

CompartmentId string: The OCID of the compartment containing the network load balancers to list.
DisplayName string: A filter to return only resources that match the entire display name given.
Filters []GetNetworkLoadBalancersFilter
State string: A filter to return only resources that match the given lifecycle state.

compartmentId String: The OCID of the compartment containing the network load balancers to list.
displayName String: A filter to return only resources that match the entire display name given.
filters List<GetsFilter>
state String: A filter to return only resources that match the given lifecycle state.

compartmentId string: The OCID of the compartment containing the network load balancers to list.
displayName string: A filter to return only resources that match the entire display name given.
filters GetNetworkLoadBalancersFilter[]
state string: A filter to return only resources that match the given lifecycle state.

compartment_id str: The OCID of the compartment containing the network load balancers to list.
display_name str: A filter to return only resources that match the entire display name given.
filters GetNetworkLoadBalancersFilter]
state str: A filter to return only resources that match the given lifecycle state.

compartmentId String: The OCID of the compartment containing the network load balancers to list.
displayName String: A filter to return only resources that match the entire display name given.
filters List<Property Map>
state String: A filter to return only resources that match the given lifecycle state.

getNetworkLoadBalancers Result

The following output properties are available:

CompartmentId string: The OCID of the compartment containing the network load balancer.
Id string: The provider-assigned unique ID for this managed resource.
NetworkLoadBalancerCollections List<GetNetworkLoadBalancersNetworkLoadBalancerCollection>: The list of network_load_balancer_collection.
DisplayName string: A user-friendly name, which does not have to be unique, and can be changed. Example: example_load_balancer
Filters List<GetNetworkLoadBalancersFilter>
State string: The current state of the network load balancer.

CompartmentId string: The OCID of the compartment containing the network load balancer.
Id string: The provider-assigned unique ID for this managed resource.
NetworkLoadBalancerCollections []GetNetworkLoadBalancersNetworkLoadBalancerCollection: The list of network_load_balancer_collection.
DisplayName string: A user-friendly name, which does not have to be unique, and can be changed. Example: example_load_balancer
Filters []GetNetworkLoadBalancersFilter
State string: The current state of the network load balancer.

compartmentId String: The OCID of the compartment containing the network load balancer.
id String: The provider-assigned unique ID for this managed resource.
networkLoadBalancerCollections List<GetsCollection>: The list of network_load_balancer_collection.
displayName String: A user-friendly name, which does not have to be unique, and can be changed. Example: example_load_balancer
filters List<GetsFilter>
state String: The current state of the network load balancer.

compartmentId string: The OCID of the compartment containing the network load balancer.
id string: The provider-assigned unique ID for this managed resource.
networkLoadBalancerCollections GetNetworkLoadBalancersNetworkLoadBalancerCollection[]: The list of network_load_balancer_collection.
displayName string: A user-friendly name, which does not have to be unique, and can be changed. Example: example_load_balancer
filters GetNetworkLoadBalancersFilter[]
state string: The current state of the network load balancer.

compartment_id str: The OCID of the compartment containing the network load balancer.
id str: The provider-assigned unique ID for this managed resource.
network_load_balancer_collections GetNetworkLoadBalancersNetworkLoadBalancerCollection]: The list of network_load_balancer_collection.
display_name str: A user-friendly name, which does not have to be unique, and can be changed. Example: example_load_balancer
filters GetNetworkLoadBalancersFilter]
state str: The current state of the network load balancer.

compartmentId String: The OCID of the compartment containing the network load balancer.
id String: The provider-assigned unique ID for this managed resource.
networkLoadBalancerCollections List<Property Map>: The list of network_load_balancer_collection.
displayName String: A user-friendly name, which does not have to be unique, and can be changed. Example: example_load_balancer
filters List<Property Map>
state String: The current state of the network load balancer.

Supporting Types

GetNetworkLoadBalancersFilter

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

GetNetworkLoadBalancersNetworkLoadBalancerCollection

Items List<GetNetworkLoadBalancersNetworkLoadBalancerCollectionItem>

Items []GetNetworkLoadBalancersNetworkLoadBalancerCollectionItem

items List<GetsCollectionItem>

items GetNetworkLoadBalancersNetworkLoadBalancerCollectionItem[]

items GetNetworkLoadBalancersNetworkLoadBalancerCollectionItem]

items List<Property Map>

GetNetworkLoadBalancersNetworkLoadBalancerCollectionItem

CompartmentId string: The OCID of the compartment containing the network load balancers to list.
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"}
DisplayName string: A filter to return only resources that match the entire display name given.
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: OCID of the reserved public IP address created with the virtual cloud network.
IpAddresses List<GetNetworkLoadBalancersNetworkLoadBalancerCollectionItemIpAddress>: An array of IP addresses.
IsPreserveSourceDestination bool: 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.
IsPrivate bool: Whether the network load balancer has a virtual cloud network-local (private) IP address.
LifecycleDetails 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.
NetworkSecurityGroupIds List<string>: An array of network security groups OCIDs associated with the network load balancer.
NlbIpVersion string: IP version associated with the NLB.
ReservedIps List<GetNetworkLoadBalancersNetworkLoadBalancerCollectionItemReservedIp>
State string: A filter to return only resources that match the given lifecycle state.
SubnetId string: The subnet in which the network load balancer is spawned OCIDs."
SystemTags Dictionary<string, object>: Key-value pair representing system tags' keys and values scoped to a namespace. Example: {"bar-key": "value"}
TimeCreated string: The date and time the network load balancer was created, in the format defined by RFC3339. Example: 2020-05-01T21:10:29.600Z
TimeUpdated string: The time the network load balancer was updated. An RFC3339 formatted date-time string. Example: 2020-05-01T22:10:29.600Z

CompartmentId string: The OCID of the compartment containing the network load balancers to list.
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"}
DisplayName string: A filter to return only resources that match the entire display name given.
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: OCID of the reserved public IP address created with the virtual cloud network.
IpAddresses []GetNetworkLoadBalancersNetworkLoadBalancerCollectionItemIpAddress: An array of IP addresses.
IsPreserveSourceDestination bool: 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.
IsPrivate bool: Whether the network load balancer has a virtual cloud network-local (private) IP address.
LifecycleDetails 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.
NetworkSecurityGroupIds []string: An array of network security groups OCIDs associated with the network load balancer.
NlbIpVersion string: IP version associated with the NLB.
ReservedIps []GetNetworkLoadBalancersNetworkLoadBalancerCollectionItemReservedIp
State string: A filter to return only resources that match the given lifecycle state.
SubnetId string: The subnet in which the network load balancer is spawned OCIDs."
SystemTags map[string]interface{}: Key-value pair representing system tags' keys and values scoped to a namespace. Example: {"bar-key": "value"}
TimeCreated string: The date and time the network load balancer was created, in the format defined by RFC3339. Example: 2020-05-01T21:10:29.600Z
TimeUpdated string: The time the network load balancer was updated. An RFC3339 formatted date-time string. Example: 2020-05-01T22:10:29.600Z

compartmentId String: The OCID of the compartment containing the network load balancers to list.
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"}
displayName String: A filter to return only resources that match the entire display name given.
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: OCID of the reserved public IP address created with the virtual cloud network.
ipAddresses List<GetsCollectionItemIpAddress>: An array of IP addresses.
isPreserveSourceDestination Boolean: 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.
isPrivate Boolean: Whether the network load balancer has a virtual cloud network-local (private) IP address.
lifecycleDetails 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.
networkSecurityGroupIds List<String>: An array of network security groups OCIDs associated with the network load balancer.
nlbIpVersion String: IP version associated with the NLB.
reservedIps List<GetsCollectionItemReservedIp>
state String: A filter to return only resources that match the given lifecycle state.
subnetId String: The subnet in which the network load balancer is spawned OCIDs."
systemTags Map<String,Object>: Key-value pair representing system tags' keys and values scoped to a namespace. Example: {"bar-key": "value"}
timeCreated String: The date and time the network load balancer was created, in the format defined by RFC3339. Example: 2020-05-01T21:10:29.600Z
timeUpdated String: The time the network load balancer was updated. An RFC3339 formatted date-time string. Example: 2020-05-01T22:10:29.600Z

compartmentId string: The OCID of the compartment containing the network load balancers to list.
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"}
displayName string: A filter to return only resources that match the entire display name given.
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: OCID of the reserved public IP address created with the virtual cloud network.
ipAddresses GetNetworkLoadBalancersNetworkLoadBalancerCollectionItemIpAddress[]: An array of IP addresses.
isPreserveSourceDestination boolean: 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.
isPrivate boolean: Whether the network load balancer has a virtual cloud network-local (private) IP address.
lifecycleDetails 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.
networkSecurityGroupIds string[]: An array of network security groups OCIDs associated with the network load balancer.
nlbIpVersion string: IP version associated with the NLB.
reservedIps GetNetworkLoadBalancersNetworkLoadBalancerCollectionItemReservedIp[]
state string: A filter to return only resources that match the given lifecycle state.
subnetId string: The subnet in which the network load balancer is spawned OCIDs."
systemTags {[key: string]: any}: Key-value pair representing system tags' keys and values scoped to a namespace. Example: {"bar-key": "value"}
timeCreated string: The date and time the network load balancer was created, in the format defined by RFC3339. Example: 2020-05-01T21:10:29.600Z
timeUpdated 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 balancers to list.
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"}
display_name str: A filter to return only resources that match the entire display name given.
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: OCID of the reserved public IP address created with the virtual cloud network.
ip_addresses GetNetworkLoadBalancersNetworkLoadBalancerCollectionItemIpAddress]: An array of IP addresses.
is_preserve_source_destination bool: 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_security_group_ids Sequence[str]: An array of network security groups OCIDs associated with the network load balancer.
nlb_ip_version str: IP version associated with the NLB.
reserved_ips GetNetworkLoadBalancersNetworkLoadBalancerCollectionItemReservedIp]
state str: A filter to return only resources that match the given lifecycle state.
subnet_id str: The subnet in which the network load balancer is spawned OCIDs."
system_tags 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

compartmentId String: The OCID of the compartment containing the network load balancers to list.
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"}
displayName String: A filter to return only resources that match the entire display name given.
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: OCID of the reserved public IP address created with the virtual cloud network.
ipAddresses List<Property Map>: An array of IP addresses.
isPreserveSourceDestination Boolean: 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.
isPrivate Boolean: Whether the network load balancer has a virtual cloud network-local (private) IP address.
lifecycleDetails 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.
networkSecurityGroupIds List<String>: An array of network security groups OCIDs associated with the network load balancer.
nlbIpVersion String: IP version associated with the NLB.
reservedIps List<Property Map>
state String: A filter to return only resources that match the given lifecycle state.
subnetId String: The subnet in which the network load balancer is spawned OCIDs."
systemTags Map<Any>: Key-value pair representing system tags' keys and values scoped to a namespace. Example: {"bar-key": "value"}
timeCreated String: The date and time the network load balancer was created, in the format defined by RFC3339. Example: 2020-05-01T21:10:29.600Z
timeUpdated String: The time the network load balancer was updated. An RFC3339 formatted date-time string. Example: 2020-05-01T22:10:29.600Z

GetNetworkLoadBalancersNetworkLoadBalancerCollectionItemIpAddress

IpAddress string: An IP address. Example: 192.168.0.3
IpVersion string: IP version associated with this IP address.
IsPublic bool: Whether the IP address is public or private. If "true", then the IP address is public and accessible from the internet.
ReservedIps List<GetNetworkLoadBalancersNetworkLoadBalancerCollectionItemIpAddressReservedIp>: An object representing a reserved IP address to be attached or that is already attached to a network load balancer.

IpAddress string: An IP address. Example: 192.168.0.3
IpVersion string: IP version associated with this IP address.
IsPublic bool: Whether the IP address is public or private. If "true", then the IP address is public and accessible from the internet.
ReservedIps []GetNetworkLoadBalancersNetworkLoadBalancerCollectionItemIpAddressReservedIp: An object representing a reserved IP address to be attached or that is already attached to a network load balancer.

ipAddress String: An IP address. Example: 192.168.0.3
ipVersion String: IP version associated with this IP address.
isPublic Boolean: Whether the IP address is public or private. If "true", then the IP address is public and accessible from the internet.
reservedIps List<GetsCollectionItemIpAddressReservedIp>: An object representing a reserved IP address to be attached or that is already attached to a network load balancer.

ipAddress string: An IP address. Example: 192.168.0.3
ipVersion string: IP version associated with this IP address.
isPublic boolean: Whether the IP address is public or private. If "true", then the IP address is public and accessible from the internet.
reservedIps GetNetworkLoadBalancersNetworkLoadBalancerCollectionItemIpAddressReservedIp[]: 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. If "true", then the IP address is public and accessible from the internet.
reserved_ips GetNetworkLoadBalancersNetworkLoadBalancerCollectionItemIpAddressReservedIp]: An object representing a reserved IP address to be attached or that is already attached to a network load balancer.

ipAddress String: An IP address. Example: 192.168.0.3
ipVersion String: IP version associated with this IP address.
isPublic Boolean: Whether the IP address is public or private. If "true", then the IP address is public and accessible from the internet.
reservedIps List<Property Map>: An object representing a reserved IP address to be attached or that is already attached to a network load balancer.

GetNetworkLoadBalancersNetworkLoadBalancerCollectionItemIpAddressReservedIp

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.

GetNetworkLoadBalancersNetworkLoadBalancerCollectionItemReservedIp

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.