Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. network
  5. IPGroup

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-azure

azure.network.IPGroup

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-azure

Manages an IP group that contains a list of CIDRs and/or IP addresses.

Example Usage

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

const example = new azure.core.ResourceGroup("example", {
    name: "example-rg",
    location: "West Europe",
});
const exampleIPGroup = new azure.network.IPGroup("example", {
    name: "example1-ipgroup",
    location: example.location,
    resourceGroupName: example.name,
    cidrs: [
        "192.168.0.1",
        "172.16.240.0/20",
        "10.48.0.0/12",
    ],
    tags: {
        environment: "Production",
    },
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-rg",
    location="West Europe")
example_ip_group = azure.network.IPGroup("example",
    name="example1-ipgroup",
    location=example.location,
    resource_group_name=example.name,
    cidrs=[
        "192.168.0.1",
        "172.16.240.0/20",
        "10.48.0.0/12",
    ],
    tags={
        "environment": "Production",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/network"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-rg"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = network.NewIPGroup(ctx, "example", &network.IPGroupArgs{
			Name:              pulumi.String("example1-ipgroup"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
			Cidrs: pulumi.StringArray{
				pulumi.String("192.168.0.1"),
				pulumi.String("172.16.240.0/20"),
				pulumi.String("10.48.0.0/12"),
			},
			Tags: pulumi.StringMap{
				"environment": pulumi.String("Production"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-rg",
        Location = "West Europe",
    });

    var exampleIPGroup = new Azure.Network.IPGroup("example", new()
    {
        Name = "example1-ipgroup",
        Location = example.Location,
        ResourceGroupName = example.Name,
        Cidrs = new[]
        {
            "192.168.0.1",
            "172.16.240.0/20",
            "10.48.0.0/12",
        },
        Tags = 
        {
            { "environment", "Production" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.network.IPGroup;
import com.pulumi.azure.network.IPGroupArgs;
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) {
        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-rg")
            .location("West Europe")
            .build());

        var exampleIPGroup = new IPGroup("exampleIPGroup", IPGroupArgs.builder()
            .name("example1-ipgroup")
            .location(example.location())
            .resourceGroupName(example.name())
            .cidrs(            
                "192.168.0.1",
                "172.16.240.0/20",
                "10.48.0.0/12")
            .tags(Map.of("environment", "Production"))
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-rg
      location: West Europe
  exampleIPGroup:
    type: azure:network:IPGroup
    name: example
    properties:
      name: example1-ipgroup
      location: ${example.location}
      resourceGroupName: ${example.name}
      cidrs:
        - 192.168.0.1
        - 172.16.240.0/20
        - 10.48.0.0/12
      tags:
        environment: Production
Copy

Create IPGroup Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new IPGroup(name: string, args: IPGroupArgs, opts?: CustomResourceOptions);
@overload
def IPGroup(resource_name: str,
            args: IPGroupArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def IPGroup(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            resource_group_name: Optional[str] = None,
            cidrs: Optional[Sequence[str]] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None)
func NewIPGroup(ctx *Context, name string, args IPGroupArgs, opts ...ResourceOption) (*IPGroup, error)
public IPGroup(string name, IPGroupArgs args, CustomResourceOptions? opts = null)
public IPGroup(String name, IPGroupArgs args)
public IPGroup(String name, IPGroupArgs args, CustomResourceOptions options)

type: azure:network:IPGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. IPGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. IPGroupArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. IPGroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. IPGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. IPGroupArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var ipgroupResource = new Azure.Network.IPGroup("ipgroupResource", new()
{
    ResourceGroupName = "string",
    Cidrs = new[]
    {
        "string",
    },
    Location = "string",
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := network.NewIPGroup(ctx, "ipgroupResource", &network.IPGroupArgs{
	ResourceGroupName: pulumi.String("string"),
	Cidrs: pulumi.StringArray{
		pulumi.String("string"),
	},
	Location: pulumi.String("string"),
	Name:     pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var ipgroupResource = new IPGroup("ipgroupResource", IPGroupArgs.builder()
    .resourceGroupName("string")
    .cidrs("string")
    .location("string")
    .name("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
ipgroup_resource = azure.network.IPGroup("ipgroupResource",
    resource_group_name="string",
    cidrs=["string"],
    location="string",
    name="string",
    tags={
        "string": "string",
    })
Copy
const ipgroupResource = new azure.network.IPGroup("ipgroupResource", {
    resourceGroupName: "string",
    cidrs: ["string"],
    location: "string",
    name: "string",
    tags: {
        string: "string",
    },
});
Copy
type: azure:network:IPGroup
properties:
    cidrs:
        - string
    location: string
    name: string
    resourceGroupName: string
    tags:
        string: string
Copy

IPGroup Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The IPGroup resource accepts the following input properties:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group in which to create the IP group. Changing this forces a new resource to be created.
Cidrs List<string>
Location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of the IP group. Changing this forces a new resource to be created.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group in which to create the IP group. Changing this forces a new resource to be created.
Cidrs []string
Location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of the IP group. Changing this forces a new resource to be created.
Tags map[string]string
A mapping of tags to assign to the resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group in which to create the IP group. Changing this forces a new resource to be created.
cidrs List<String>
location Changes to this property will trigger replacement. String
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
Specifies the name of the IP group. Changing this forces a new resource to be created.
tags Map<String,String>
A mapping of tags to assign to the resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group in which to create the IP group. Changing this forces a new resource to be created.
cidrs string[]
location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. string
Specifies the name of the IP group. Changing this forces a new resource to be created.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group in which to create the IP group. Changing this forces a new resource to be created.
cidrs Sequence[str]
location Changes to this property will trigger replacement. str
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. str
Specifies the name of the IP group. Changing this forces a new resource to be created.
tags Mapping[str, str]
A mapping of tags to assign to the resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group in which to create the IP group. Changing this forces a new resource to be created.
cidrs List<String>
location Changes to this property will trigger replacement. String
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
Specifies the name of the IP group. Changing this forces a new resource to be created.
tags Map<String>
A mapping of tags to assign to the resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the IPGroup resource produces the following output properties:

FirewallIds List<string>
A list of ID of Firewall.
FirewallPolicyIds List<string>
A list of ID of Firewall Policy`.
Id string
The provider-assigned unique ID for this managed resource.
FirewallIds []string
A list of ID of Firewall.
FirewallPolicyIds []string
A list of ID of Firewall Policy`.
Id string
The provider-assigned unique ID for this managed resource.
firewallIds List<String>
A list of ID of Firewall.
firewallPolicyIds List<String>
A list of ID of Firewall Policy`.
id String
The provider-assigned unique ID for this managed resource.
firewallIds string[]
A list of ID of Firewall.
firewallPolicyIds string[]
A list of ID of Firewall Policy`.
id string
The provider-assigned unique ID for this managed resource.
firewall_ids Sequence[str]
A list of ID of Firewall.
firewall_policy_ids Sequence[str]
A list of ID of Firewall Policy`.
id str
The provider-assigned unique ID for this managed resource.
firewallIds List<String>
A list of ID of Firewall.
firewallPolicyIds List<String>
A list of ID of Firewall Policy`.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing IPGroup Resource

Get an existing IPGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: IPGroupState, opts?: CustomResourceOptions): IPGroup
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cidrs: Optional[Sequence[str]] = None,
        firewall_ids: Optional[Sequence[str]] = None,
        firewall_policy_ids: Optional[Sequence[str]] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None) -> IPGroup
func GetIPGroup(ctx *Context, name string, id IDInput, state *IPGroupState, opts ...ResourceOption) (*IPGroup, error)
public static IPGroup Get(string name, Input<string> id, IPGroupState? state, CustomResourceOptions? opts = null)
public static IPGroup get(String name, Output<String> id, IPGroupState state, CustomResourceOptions options)
resources:  _:    type: azure:network:IPGroup    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Cidrs List<string>
FirewallIds List<string>
A list of ID of Firewall.
FirewallPolicyIds List<string>
A list of ID of Firewall Policy`.
Location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of the IP group. Changing this forces a new resource to be created.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the resource group in which to create the IP group. Changing this forces a new resource to be created.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
Cidrs []string
FirewallIds []string
A list of ID of Firewall.
FirewallPolicyIds []string
A list of ID of Firewall Policy`.
Location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of the IP group. Changing this forces a new resource to be created.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the resource group in which to create the IP group. Changing this forces a new resource to be created.
Tags map[string]string
A mapping of tags to assign to the resource.
cidrs List<String>
firewallIds List<String>
A list of ID of Firewall.
firewallPolicyIds List<String>
A list of ID of Firewall Policy`.
location Changes to this property will trigger replacement. String
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
Specifies the name of the IP group. Changing this forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. String
The name of the resource group in which to create the IP group. Changing this forces a new resource to be created.
tags Map<String,String>
A mapping of tags to assign to the resource.
cidrs string[]
firewallIds string[]
A list of ID of Firewall.
firewallPolicyIds string[]
A list of ID of Firewall Policy`.
location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. string
Specifies the name of the IP group. Changing this forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. string
The name of the resource group in which to create the IP group. Changing this forces a new resource to be created.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
cidrs Sequence[str]
firewall_ids Sequence[str]
A list of ID of Firewall.
firewall_policy_ids Sequence[str]
A list of ID of Firewall Policy`.
location Changes to this property will trigger replacement. str
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. str
Specifies the name of the IP group. Changing this forces a new resource to be created.
resource_group_name Changes to this property will trigger replacement. str
The name of the resource group in which to create the IP group. Changing this forces a new resource to be created.
tags Mapping[str, str]
A mapping of tags to assign to the resource.
cidrs List<String>
firewallIds List<String>
A list of ID of Firewall.
firewallPolicyIds List<String>
A list of ID of Firewall Policy`.
location Changes to this property will trigger replacement. String
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
Specifies the name of the IP group. Changing this forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. String
The name of the resource group in which to create the IP group. Changing this forces a new resource to be created.
tags Map<String>
A mapping of tags to assign to the resource.

Import

IP Groups can be imported using the resource id, e.g.

$ pulumi import azure:network/iPGroup:IPGroup ipgroup1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Network/ipGroups/myIpGroup
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-azure