getAddressGroups function

Future<GetAddressGroupsResult> getAddressGroups(GetAddressGroupsArgs args, { InvokeOptions? options, })

AddressGroups are used to group IP addresses together for use in firewall policies. This data source allows you to list address groups in a project or organization and location.

To get more information about Address Groups, see:

• API documentation
• How-to Guides
• Official Documentation

Example Usage

Project Level

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

const all = gcp.networksecurity.getAddressGroups({
    location: "us-central1",
    project: "my-project-id",
});

import pulumi
import pulumi_gcp as gcp

all = gcp.networksecurity.get_address_groups(location="us-central1",
    project="my-project-id")

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

return await Deployment.RunAsync(() =>
{
    var all = Gcp.NetworkSecurity.GetAddressGroups.Invoke(new()
    {
        Location = "us-central1",
        Project = "my-project-id",
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/networksecurity"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := networksecurity.GetAddressGroups(ctx, &networksecurity.GetAddressGroupsArgs{
			Location: "us-central1",
			Project:  pulumi.StringRef("my-project-id"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

data "gcp_networksecurity_getaddressgroups" "all" {
  location = "us-central1"
  project  = "my-project-id"
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.networksecurity.NetworksecurityFunctions;
import com.pulumi.gcp.networksecurity.inputs.GetAddressGroupsArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 all = NetworksecurityFunctions.getAddressGroups(GetAddressGroupsArgs.builder()
            .location("us-central1")
            .project("my-project-id")
            .build());

    }
}

variables:
  all:
    fn::invoke:
      function: gcp:networksecurity:getAddressGroups
      arguments:
        location: us-central1
        project: my-project-id

Organization Level

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

const orgAll = gcp.networksecurity.getAddressGroups({
    location: "us-central1",
    parent: "organizations/123456789",
});

import pulumi
import pulumi_gcp as gcp

org_all = gcp.networksecurity.get_address_groups(location="us-central1",
    parent="organizations/123456789")

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

return await Deployment.RunAsync(() =>
{
    var orgAll = Gcp.NetworkSecurity.GetAddressGroups.Invoke(new()
    {
        Location = "us-central1",
        Parent = "organizations/123456789",
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/networksecurity"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := networksecurity.GetAddressGroups(ctx, &networksecurity.GetAddressGroupsArgs{
			Location: "us-central1",
			Parent:   pulumi.StringRef("organizations/123456789"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

data "gcp_networksecurity_getaddressgroups" "orgAll" {
  location = "us-central1"
  parent   = "organizations/123456789"
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.networksecurity.NetworksecurityFunctions;
import com.pulumi.gcp.networksecurity.inputs.GetAddressGroupsArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 orgAll = NetworksecurityFunctions.getAddressGroups(GetAddressGroupsArgs.builder()
            .location("us-central1")
            .parent("organizations/123456789")
            .build());

    }
}

variables:
  orgAll:
    fn::invoke:
      function: gcp:networksecurity:getAddressGroups
      arguments:
        location: us-central1
        parent: organizations/123456789

args Arguments passed to this invoke. Arguments for getAddressGroups. options Invoke options controlling this call.

Implementation

Future<GetAddressGroupsResult> getAddressGroups(
  GetAddressGroupsArgs args, {
  pulumi.InvokeOptions? options,
}) async {
  final deployment = pulumi.Deployment.instance;
  final result = await deployment.invoke<Map<String, dynamic>>(
    'gcp:networksecurity/getAddressGroups:getAddressGroups',
    args.toMap(),
    options: pulumi.toDeploymentInvokeOptions(options),
  );
  return GetAddressGroupsResult.fromMap(result);
}