Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. getPiNetworkAddressGroup
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.getPiNetworkAddressGroup

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Retrieves information about a network address group.

    Example Usage

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

const networkAddressGroup = ibm.getPiNetworkAddressGroup({
    piCloudInstanceId: "<value of the cloud_instance_id>",
    piNetworkAddressGroupId: "<value of the network_address_group_id>",
});

    import pulumi
import pulumi_ibm as ibm

network_address_group = ibm.get_pi_network_address_group(pi_cloud_instance_id="<value of the cloud_instance_id>",
    pi_network_address_group_id="<value of the network_address_group_id>")

    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.LookupPiNetworkAddressGroup(ctx, &ibm.LookupPiNetworkAddressGroupArgs{
			PiCloudInstanceId:       "<value of the cloud_instance_id>",
			PiNetworkAddressGroupId: "<value of the network_address_group_id>",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var networkAddressGroup = Ibm.GetPiNetworkAddressGroup.Invoke(new()
    {
        PiCloudInstanceId = "<value of the cloud_instance_id>",
        PiNetworkAddressGroupId = "<value of the network_address_group_id>",
    });

});

    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.GetPiNetworkAddressGroupArgs;
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 networkAddressGroup = IbmFunctions.getPiNetworkAddressGroup(GetPiNetworkAddressGroupArgs.builder()
            .piCloudInstanceId("<value of the cloud_instance_id>")
            .piNetworkAddressGroupId("<value of the network_address_group_id>")
            .build());

    }
}

    variables:
  networkAddressGroup:
    fn::invoke:
      function: ibm:getPiNetworkAddressGroup
      arguments:
        piCloudInstanceId: <value of the cloud_instance_id>
        piNetworkAddressGroupId: <value of the network_address_group_id>

    Notes

    • Please find supported Regions for endpoints.
    • If a Power cloud instance is provisioned at lon04, The provider level attributes should be as follows:
      • region - lon
      • zone - lon04

    Example usage:

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

    import pulumi

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;

return await Deployment.RunAsync(() => 
{
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
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) {
    }
}

    {}

    Using getPiNetworkAddressGroup

    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 getPiNetworkAddressGroup(args: GetPiNetworkAddressGroupArgs, opts?: InvokeOptions): Promise<GetPiNetworkAddressGroupResult>
function getPiNetworkAddressGroupOutput(args: GetPiNetworkAddressGroupOutputArgs, opts?: InvokeOptions): Output<GetPiNetworkAddressGroupResult>
    def get_pi_network_address_group(id: Optional[str] = None,
                                 pi_cloud_instance_id: Optional[str] = None,
                                 pi_network_address_group_id: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetPiNetworkAddressGroupResult
def get_pi_network_address_group_output(id: Optional[pulumi.Input[str]] = None,
                                 pi_cloud_instance_id: Optional[pulumi.Input[str]] = None,
                                 pi_network_address_group_id: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetPiNetworkAddressGroupResult]
    func LookupPiNetworkAddressGroup(ctx *Context, args *LookupPiNetworkAddressGroupArgs, opts ...InvokeOption) (*LookupPiNetworkAddressGroupResult, error)
func LookupPiNetworkAddressGroupOutput(ctx *Context, args *LookupPiNetworkAddressGroupOutputArgs, opts ...InvokeOption) LookupPiNetworkAddressGroupResultOutput

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

    public static class GetPiNetworkAddressGroup 
{
    public static Task<GetPiNetworkAddressGroupResult> InvokeAsync(GetPiNetworkAddressGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetPiNetworkAddressGroupResult> Invoke(GetPiNetworkAddressGroupInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPiNetworkAddressGroupResult> getPiNetworkAddressGroup(GetPiNetworkAddressGroupArgs args, InvokeOptions options)
public static Output<GetPiNetworkAddressGroupResult> getPiNetworkAddressGroup(GetPiNetworkAddressGroupArgs args, InvokeOptions options)

    fn::invoke:
  function: ibm:index/getPiNetworkAddressGroup:getPiNetworkAddressGroup
  arguments:
    # arguments dictionary

    The following arguments are supported:

    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    PiNetworkAddressGroupId string
    The network address group id.
    Id string
    (String) The id of the network address group member IP addresses.
    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    PiNetworkAddressGroupId string
    The network address group id.
    Id string
    (String) The id of the network address group member IP addresses.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piNetworkAddressGroupId String
    The network address group id.
    id String
    (String) The id of the network address group member IP addresses.
    piCloudInstanceId string
    The GUID of the service instance associated with an account.
    piNetworkAddressGroupId string
    The network address group id.
    id string
    (String) The id of the network address group member IP addresses.
    pi_cloud_instance_id str
    The GUID of the service instance associated with an account.
    pi_network_address_group_id str
    The network address group id.
    id str
    (String) The id of the network address group member IP addresses.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piNetworkAddressGroupId String
    The network address group id.
    id String
    (String) The id of the network address group member IP addresses.

    getPiNetworkAddressGroup Result

    The following output properties are available:

    Crn string
    (String) The network address group's crn.
    Id string
    (String) The id of the network address group member IP addresses.
    Members List<GetPiNetworkAddressGroupMember>
    (List) The list of IP addresses in CIDR notation in the network address group.
    Name string
    (String) The name of the network address group.
    PiCloudInstanceId string
    PiNetworkAddressGroupId string
    UserTags List<string>
    (List) List of user tags attached to the resource.
    Crn string
    (String) The network address group's crn.
    Id string
    (String) The id of the network address group member IP addresses.
    Members []GetPiNetworkAddressGroupMemberType
    (List) The list of IP addresses in CIDR notation in the network address group.
    Name string
    (String) The name of the network address group.
    PiCloudInstanceId string
    PiNetworkAddressGroupId string
    UserTags []string
    (List) List of user tags attached to the resource.
    crn String
    (String) The network address group's crn.
    id String
    (String) The id of the network address group member IP addresses.
    members List<GetPiNetworkAddressGroupMember>
    (List) The list of IP addresses in CIDR notation in the network address group.
    name String
    (String) The name of the network address group.
    piCloudInstanceId String
    piNetworkAddressGroupId String
    userTags List<String>
    (List) List of user tags attached to the resource.
    crn string
    (String) The network address group's crn.
    id string
    (String) The id of the network address group member IP addresses.
    members GetPiNetworkAddressGroupMember[]
    (List) The list of IP addresses in CIDR notation in the network address group.
    name string
    (String) The name of the network address group.
    piCloudInstanceId string
    piNetworkAddressGroupId string
    userTags string[]
    (List) List of user tags attached to the resource.
    crn str
    (String) The network address group's crn.
    id str
    (String) The id of the network address group member IP addresses.
    members Sequence[GetPiNetworkAddressGroupMember]
    (List) The list of IP addresses in CIDR notation in the network address group.
    name str
    (String) The name of the network address group.
    pi_cloud_instance_id str
    pi_network_address_group_id str
    user_tags Sequence[str]
    (List) List of user tags attached to the resource.
    crn String
    (String) The network address group's crn.
    id String
    (String) The id of the network address group member IP addresses.
    members List<Property Map>
    (List) The list of IP addresses in CIDR notation in the network address group.
    name String
    (String) The name of the network address group.
    piCloudInstanceId String
    piNetworkAddressGroupId String
    userTags List<String>
    (List) List of user tags attached to the resource.

    Supporting Types

    GetPiNetworkAddressGroupMember

    Cidr string
    (String) The IP addresses in CIDR notation.
    Id string
    (String) The id of the network address group member IP addresses.
    Cidr string
    (String) The IP addresses in CIDR notation.
    Id string
    (String) The id of the network address group member IP addresses.
    cidr String
    (String) The IP addresses in CIDR notation.
    id String
    (String) The id of the network address group member IP addresses.
    cidr string
    (String) The IP addresses in CIDR notation.
    id string
    (String) The id of the network address group member IP addresses.
    cidr str
    (String) The IP addresses in CIDR notation.
    id str
    (String) The id of the network address group member IP addresses.
    cidr String
    (String) The IP addresses in CIDR notation.
    id String
    (String) The id of the network address group member IP addresses.

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm