Docs Packages
  1. Pulumi Registry
  2. Azure Classic
  3. API Docs
  4. network
  5. IPGroup
azure logo
Azure Classic v5.43.0, May 6 23

azure.network.IPGroup

Explore with Pulumi AI

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

Example Usage

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

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

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

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = network.NewIPGroup(ctx, "exampleIPGroup", &network.IPGroupArgs{
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.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
	})
}

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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("West Europe")
            .build());

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

    }
}

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_ip_group = azure.network.IPGroup("exampleIPGroup",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    cidrs=[
        "192.168.0.1",
        "172.16.240.0/20",
        "10.48.0.0/12",
    ],
    tags={
        "environment": "Production",
    })

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleIPGroup = new azure.network.IPGroup("exampleIPGroup", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    cidrs: [
        "192.168.0.1",
        "172.16.240.0/20",
        "10.48.0.0/12",
    ],
    tags: {
        environment: "Production",
    },
});

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

Create IPGroup Resource

new IPGroup(name: string, args: IPGroupArgs, opts?: CustomResourceOptions);
@overload
def IPGroup(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            cidrs: Optional[Sequence[str]] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None)
@overload
def IPGroup(resource_name: str,
            args: IPGroupArgs,
            opts: Optional[ResourceOptions] = 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.
name string
The unique name of the resource.
args IPGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args 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 string
The unique name of the resource.
args IPGroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args IPGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args IPGroupArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

The IPGroup resource accepts the following input properties:

ResourceGroupName 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>

A list of CIDRs or IP addresses.

Location string

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

Name 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 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

A list of CIDRs or IP addresses.

Location string

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

Name 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 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>

A list of CIDRs or IP addresses.

location String

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name 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 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[]

A list of CIDRs or IP addresses.

location string

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name 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 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]

A list of CIDRs or IP addresses.

location str

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name 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 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>

A list of CIDRs or IP addresses.

location String

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name 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 firewall_ids block as defined below.

FirewallPolicyIds List<string>

A firewall_policy_ids block as defined below.

Id string

The provider-assigned unique ID for this managed resource.

FirewallIds []string

A firewall_ids block as defined below.

FirewallPolicyIds []string

A firewall_policy_ids block as defined below.

Id string

The provider-assigned unique ID for this managed resource.

firewallIds List<String>

A firewall_ids block as defined below.

firewallPolicyIds List<String>

A firewall_policy_ids block as defined below.

id String

The provider-assigned unique ID for this managed resource.

firewallIds string[]

A firewall_ids block as defined below.

firewallPolicyIds string[]

A firewall_policy_ids block as defined below.

id string

The provider-assigned unique ID for this managed resource.

firewall_ids Sequence[str]

A firewall_ids block as defined below.

firewall_policy_ids Sequence[str]

A firewall_policy_ids block as defined below.

id str

The provider-assigned unique ID for this managed resource.

firewallIds List<String>

A firewall_ids block as defined below.

firewallPolicyIds List<String>

A firewall_policy_ids block as defined below.

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)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
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
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
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
The unique name of the resulting resource.
id
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
The unique name of the resulting resource.
id
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>

A list of CIDRs or IP addresses.

FirewallIds List<string>

A firewall_ids block as defined below.

FirewallPolicyIds List<string>

A firewall_policy_ids block as defined below.

Location string

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

Name string

Specifies the name of the IP group. Changing this forces a new resource to be created.

ResourceGroupName 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

A list of CIDRs or IP addresses.

FirewallIds []string

A firewall_ids block as defined below.

FirewallPolicyIds []string

A firewall_policy_ids block as defined below.

Location string

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

Name string

Specifies the name of the IP group. Changing this forces a new resource to be created.

ResourceGroupName 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>

A list of CIDRs or IP addresses.

firewallIds List<String>

A firewall_ids block as defined below.

firewallPolicyIds List<String>

A firewall_policy_ids block as defined below.

location String

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name String

Specifies the name of the IP group. Changing this forces a new resource to be created.

resourceGroupName 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[]

A list of CIDRs or IP addresses.

firewallIds string[]

A firewall_ids block as defined below.

firewallPolicyIds string[]

A firewall_policy_ids block as defined below.

location string

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name string

Specifies the name of the IP group. Changing this forces a new resource to be created.

resourceGroupName 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]

A list of CIDRs or IP addresses.

firewall_ids Sequence[str]

A firewall_ids block as defined below.

firewall_policy_ids Sequence[str]

A firewall_policy_ids block as defined below.

location str

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name str

Specifies the name of the IP group. Changing this forces a new resource to be created.

resource_group_name 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>

A list of CIDRs or IP addresses.

firewallIds List<String>

A firewall_ids block as defined below.

firewallPolicyIds List<String>

A firewall_policy_ids block as defined below.

location String

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name String

Specifies the name of the IP group. Changing this forces a new resource to be created.

resourceGroupName 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

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.