1. Packages
  2. Ibm Provider
  3. API Docs
  4. getIsVirtualNetworkInterfaceIps
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

ibm.getIsVirtualNetworkInterfaceIps

Explore with Pulumi AI

Provides a read-only data source to retrieve information about a ReservedIP Collection bound to a virtual network interface. You can then reference the fields of the data source in other resources within the same configuration by using interpolation syntax.

Example Usage

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

const isReservedIps = ibm.getIsVirtualNetworkInterfaceIps({
    virtualNetworkInterface: ibm_is_virtual_network_interface.testacc_vni.id,
});
Copy
import pulumi
import pulumi_ibm as ibm

is_reserved_ips = ibm.get_is_virtual_network_interface_ips(virtual_network_interface=ibm_is_virtual_network_interface["testacc_vni"]["id"])
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.GetIsVirtualNetworkInterfaceIps(ctx, &ibm.GetIsVirtualNetworkInterfaceIpsArgs{
			VirtualNetworkInterface: ibm_is_virtual_network_interface.Testacc_vni.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var isReservedIps = Ibm.GetIsVirtualNetworkInterfaceIps.Invoke(new()
    {
        VirtualNetworkInterface = ibm_is_virtual_network_interface.Testacc_vni.Id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetIsVirtualNetworkInterfaceIpsArgs;
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 isReservedIps = IbmFunctions.getIsVirtualNetworkInterfaceIps(GetIsVirtualNetworkInterfaceIpsArgs.builder()
            .virtualNetworkInterface(ibm_is_virtual_network_interface.testacc_vni().id())
            .build());

    }
}
Copy
variables:
  isReservedIps:
    fn::invoke:
      function: ibm:getIsVirtualNetworkInterfaceIps
      arguments:
        virtualNetworkInterface: ${ibm_is_virtual_network_interface.testacc_vni.id}
Copy

Using getIsVirtualNetworkInterfaceIps

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 getIsVirtualNetworkInterfaceIps(args: GetIsVirtualNetworkInterfaceIpsArgs, opts?: InvokeOptions): Promise<GetIsVirtualNetworkInterfaceIpsResult>
function getIsVirtualNetworkInterfaceIpsOutput(args: GetIsVirtualNetworkInterfaceIpsOutputArgs, opts?: InvokeOptions): Output<GetIsVirtualNetworkInterfaceIpsResult>
Copy
def get_is_virtual_network_interface_ips(id: Optional[str] = None,
                                         virtual_network_interface: Optional[str] = None,
                                         opts: Optional[InvokeOptions] = None) -> GetIsVirtualNetworkInterfaceIpsResult
def get_is_virtual_network_interface_ips_output(id: Optional[pulumi.Input[str]] = None,
                                         virtual_network_interface: Optional[pulumi.Input[str]] = None,
                                         opts: Optional[InvokeOptions] = None) -> Output[GetIsVirtualNetworkInterfaceIpsResult]
Copy
func GetIsVirtualNetworkInterfaceIps(ctx *Context, args *GetIsVirtualNetworkInterfaceIpsArgs, opts ...InvokeOption) (*GetIsVirtualNetworkInterfaceIpsResult, error)
func GetIsVirtualNetworkInterfaceIpsOutput(ctx *Context, args *GetIsVirtualNetworkInterfaceIpsOutputArgs, opts ...InvokeOption) GetIsVirtualNetworkInterfaceIpsResultOutput
Copy

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

public static class GetIsVirtualNetworkInterfaceIps 
{
    public static Task<GetIsVirtualNetworkInterfaceIpsResult> InvokeAsync(GetIsVirtualNetworkInterfaceIpsArgs args, InvokeOptions? opts = null)
    public static Output<GetIsVirtualNetworkInterfaceIpsResult> Invoke(GetIsVirtualNetworkInterfaceIpsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetIsVirtualNetworkInterfaceIpsResult> getIsVirtualNetworkInterfaceIps(GetIsVirtualNetworkInterfaceIpsArgs args, InvokeOptions options)
public static Output<GetIsVirtualNetworkInterfaceIpsResult> getIsVirtualNetworkInterfaceIps(GetIsVirtualNetworkInterfaceIpsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ibm:index/getIsVirtualNetworkInterfaceIps:getIsVirtualNetworkInterfaceIps
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

VirtualNetworkInterface This property is required. string
The virtual network interface identifier.
Id string
(String) The unique identifier for this reserved IP.
VirtualNetworkInterface This property is required. string
The virtual network interface identifier.
Id string
(String) The unique identifier for this reserved IP.
virtualNetworkInterface This property is required. String
The virtual network interface identifier.
id String
(String) The unique identifier for this reserved IP.
virtualNetworkInterface This property is required. string
The virtual network interface identifier.
id string
(String) The unique identifier for this reserved IP.
virtual_network_interface This property is required. str
The virtual network interface identifier.
id str
(String) The unique identifier for this reserved IP.
virtualNetworkInterface This property is required. String
The virtual network interface identifier.
id String
(String) The unique identifier for this reserved IP.

getIsVirtualNetworkInterfaceIps Result

The following output properties are available:

Id string
(String) The unique identifier for this reserved IP.
ReservedIps List<GetIsVirtualNetworkInterfaceIpsReservedIp>
(List) Collection of reserved IPs in this subnet. Nested schema for reserved_ips:
VirtualNetworkInterface string
Id string
(String) The unique identifier for this reserved IP.
ReservedIps []GetIsVirtualNetworkInterfaceIpsReservedIp
(List) Collection of reserved IPs in this subnet. Nested schema for reserved_ips:
VirtualNetworkInterface string
id String
(String) The unique identifier for this reserved IP.
reservedIps List<GetIsVirtualNetworkInterfaceIpsReservedIp>
(List) Collection of reserved IPs in this subnet. Nested schema for reserved_ips:
virtualNetworkInterface String
id string
(String) The unique identifier for this reserved IP.
reservedIps GetIsVirtualNetworkInterfaceIpsReservedIp[]
(List) Collection of reserved IPs in this subnet. Nested schema for reserved_ips:
virtualNetworkInterface string
id str
(String) The unique identifier for this reserved IP.
reserved_ips Sequence[GetIsVirtualNetworkInterfaceIpsReservedIp]
(List) Collection of reserved IPs in this subnet. Nested schema for reserved_ips:
virtual_network_interface str
id String
(String) The unique identifier for this reserved IP.
reservedIps List<Property Map>
(List) Collection of reserved IPs in this subnet. Nested schema for reserved_ips:
virtualNetworkInterface String

Supporting Types

GetIsVirtualNetworkInterfaceIpsReservedIp

Address This property is required. string
(String) The IP address.If the address has not yet been selected, the value will be 0.0.0.0.This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
Href This property is required. string
(String) The URL for this reserved IP.
Id This property is required. string
(String) The unique identifier for this reserved IP.
Name This property is required. string
(String) The name for this reserved IP. The name is unique across all reserved IPs in a subnet.
ReservedIp This property is required. string
ResourceType This property is required. string
(String) The resource type.
Address This property is required. string
(String) The IP address.If the address has not yet been selected, the value will be 0.0.0.0.This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
Href This property is required. string
(String) The URL for this reserved IP.
Id This property is required. string
(String) The unique identifier for this reserved IP.
Name This property is required. string
(String) The name for this reserved IP. The name is unique across all reserved IPs in a subnet.
ReservedIp This property is required. string
ResourceType This property is required. string
(String) The resource type.
address This property is required. String
(String) The IP address.If the address has not yet been selected, the value will be 0.0.0.0.This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
href This property is required. String
(String) The URL for this reserved IP.
id This property is required. String
(String) The unique identifier for this reserved IP.
name This property is required. String
(String) The name for this reserved IP. The name is unique across all reserved IPs in a subnet.
reservedIp This property is required. String
resourceType This property is required. String
(String) The resource type.
address This property is required. string
(String) The IP address.If the address has not yet been selected, the value will be 0.0.0.0.This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
href This property is required. string
(String) The URL for this reserved IP.
id This property is required. string
(String) The unique identifier for this reserved IP.
name This property is required. string
(String) The name for this reserved IP. The name is unique across all reserved IPs in a subnet.
reservedIp This property is required. string
resourceType This property is required. string
(String) The resource type.
address This property is required. str
(String) The IP address.If the address has not yet been selected, the value will be 0.0.0.0.This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
href This property is required. str
(String) The URL for this reserved IP.
id This property is required. str
(String) The unique identifier for this reserved IP.
name This property is required. str
(String) The name for this reserved IP. The name is unique across all reserved IPs in a subnet.
reserved_ip This property is required. str
resource_type This property is required. str
(String) The resource type.
address This property is required. String
(String) The IP address.If the address has not yet been selected, the value will be 0.0.0.0.This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
href This property is required. String
(String) The URL for this reserved IP.
id This property is required. String
(String) The unique identifier for this reserved IP.
name This property is required. String
(String) The name for this reserved IP. The name is unique across all reserved IPs in a subnet.
reservedIp This property is required. String
resourceType This property is required. String
(String) The resource type.

Package Details

Repository
ibm ibm-cloud/terraform-provider-ibm
License
Notes
This Pulumi package is based on the ibm Terraform Provider.