Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. IpamPool
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.network.IpamPool

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-azure-native

    Instance of Pool resource. Azure REST API version: 2024-01-01-preview.

    Example Usage

    IpamPools_Create

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

return await Deployment.RunAsync(() => 
{
    var ipamPool = new AzureNative.Network.IpamPool("ipamPool", new()
    {
        NetworkManagerName = "TestNetworkManager",
        PoolName = "TestPool",
        ResourceGroupName = "rg1",
    });

});

    package main

import (
	network "github.com/pulumi/pulumi-azure-native-sdk/network/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := network.NewIpamPool(ctx, "ipamPool", &network.IpamPoolArgs{
			NetworkManagerName: pulumi.String("TestNetworkManager"),
			PoolName:           pulumi.String("TestPool"),
			ResourceGroupName:  pulumi.String("rg1"),
		})
		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.azurenative.network.IpamPool;
import com.pulumi.azurenative.network.IpamPoolArgs;
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 ipamPool = new IpamPool("ipamPool", IpamPoolArgs.builder()
            .networkManagerName("TestNetworkManager")
            .poolName("TestPool")
            .resourceGroupName("rg1")
            .build());

    }
}

    import pulumi
import pulumi_azure_native as azure_native

ipam_pool = azure_native.network.IpamPool("ipamPool",
    network_manager_name="TestNetworkManager",
    pool_name="TestPool",
    resource_group_name="rg1")

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const ipamPool = new azure_native.network.IpamPool("ipamPool", {
    networkManagerName: "TestNetworkManager",
    poolName: "TestPool",
    resourceGroupName: "rg1",
});

    resources:
  ipamPool:
    type: azure-native:network:IpamPool
    properties:
      networkManagerName: TestNetworkManager
      poolName: TestPool
      resourceGroupName: rg1

    Create IpamPool Resource

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

    Constructor syntax

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

@overload
def IpamPool(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             network_manager_name: Optional[str] = None,
             resource_group_name: Optional[str] = None,
             location: Optional[str] = None,
             pool_name: Optional[str] = None,
             properties: Optional[IpamPoolPropertiesArgs] = None,
             tags: Optional[Mapping[str, str]] = None)
    func NewIpamPool(ctx *Context, name string, args IpamPoolArgs, opts ...ResourceOption) (*IpamPool, error)
    public IpamPool(string name, IpamPoolArgs args, CustomResourceOptions? opts = null)
    public IpamPool(String name, IpamPoolArgs args)
public IpamPool(String name, IpamPoolArgs args, CustomResourceOptions options)

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

    Parameters

    name string
    The unique name of the resource.
    args IpamPoolArgs
    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 IpamPoolArgs
    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 IpamPoolArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IpamPoolArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IpamPoolArgs
    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 ipamPoolResource = new AzureNative.Network.IpamPool("ipamPoolResource", new()
{
    NetworkManagerName = "string",
    ResourceGroupName = "string",
    Location = "string",
    PoolName = "string",
    Properties = new AzureNative.Network.Inputs.IpamPoolPropertiesArgs
    {
        AddressPrefixes = new[]
        {
            "string",
        },
        Description = "string",
        DisplayName = "string",
        ParentPoolName = "string",
    },
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := network.NewIpamPool(ctx, "ipamPoolResource", &network.IpamPoolArgs{
	NetworkManagerName: pulumi.String("string"),
	ResourceGroupName:  pulumi.String("string"),
	Location:           pulumi.String("string"),
	PoolName:           pulumi.String("string"),
	Properties: &network.IpamPoolPropertiesArgs{
		AddressPrefixes: pulumi.StringArray{
			pulumi.String("string"),
		},
		Description:    pulumi.String("string"),
		DisplayName:    pulumi.String("string"),
		ParentPoolName: pulumi.String("string"),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var ipamPoolResource = new IpamPool("ipamPoolResource", IpamPoolArgs.builder()
    .networkManagerName("string")
    .resourceGroupName("string")
    .location("string")
    .poolName("string")
    .properties(IpamPoolPropertiesArgs.builder()
        .addressPrefixes("string")
        .description("string")
        .displayName("string")
        .parentPoolName("string")
        .build())
    .tags(Map.of("string", "string"))
    .build());

    ipam_pool_resource = azure_native.network.IpamPool("ipamPoolResource",
    network_manager_name="string",
    resource_group_name="string",
    location="string",
    pool_name="string",
    properties={
        "address_prefixes": ["string"],
        "description": "string",
        "display_name": "string",
        "parent_pool_name": "string",
    },
    tags={
        "string": "string",
    })

    const ipamPoolResource = new azure_native.network.IpamPool("ipamPoolResource", {
    networkManagerName: "string",
    resourceGroupName: "string",
    location: "string",
    poolName: "string",
    properties: {
        addressPrefixes: ["string"],
        description: "string",
        displayName: "string",
        parentPoolName: "string",
    },
    tags: {
        string: "string",
    },
});

    type: azure-native:network:IpamPool
properties:
    location: string
    networkManagerName: string
    poolName: string
    properties:
        addressPrefixes:
            - string
        description: string
        displayName: string
        parentPoolName: string
    resourceGroupName: string
    tags:
        string: string

    IpamPool 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 IpamPool resource accepts the following input properties:

    NetworkManagerName string
    The name of the network manager.
    ResourceGroupName string
    The name of the resource group.
    Location string
    The geo-location where the resource lives
    PoolName string
    IP Address Manager Pool resource name.
    Properties Pulumi.AzureNative.Network.Inputs.IpamPoolProperties
    Properties of IpamPool resource properties which are specific to the Pool resource.
    Tags Dictionary<string, string>
    Resource tags.
    NetworkManagerName string
    The name of the network manager.
    ResourceGroupName string
    The name of the resource group.
    Location string
    The geo-location where the resource lives
    PoolName string
    IP Address Manager Pool resource name.
    Properties IpamPoolPropertiesArgs
    Properties of IpamPool resource properties which are specific to the Pool resource.
    Tags map[string]string
    Resource tags.
    networkManagerName String
    The name of the network manager.
    resourceGroupName String
    The name of the resource group.
    location String
    The geo-location where the resource lives
    poolName String
    IP Address Manager Pool resource name.
    properties IpamPoolProperties
    Properties of IpamPool resource properties which are specific to the Pool resource.
    tags Map<String,String>
    Resource tags.
    networkManagerName string
    The name of the network manager.
    resourceGroupName string
    The name of the resource group.
    location string
    The geo-location where the resource lives
    poolName string
    IP Address Manager Pool resource name.
    properties IpamPoolProperties
    Properties of IpamPool resource properties which are specific to the Pool resource.
    tags {[key: string]: string}
    Resource tags.
    network_manager_name str
    The name of the network manager.
    resource_group_name str
    The name of the resource group.
    location str
    The geo-location where the resource lives
    pool_name str
    IP Address Manager Pool resource name.
    properties IpamPoolPropertiesArgs
    Properties of IpamPool resource properties which are specific to the Pool resource.
    tags Mapping[str, str]
    Resource tags.
    networkManagerName String
    The name of the network manager.
    resourceGroupName String
    The name of the resource group.
    location String
    The geo-location where the resource lives
    poolName String
    IP Address Manager Pool resource name.
    properties Property Map
    Properties of IpamPool resource properties which are specific to the Pool resource.
    tags Map<String>
    Resource tags.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    SystemData Pulumi.AzureNative.Network.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Supporting Types

    IpamPoolProperties, IpamPoolPropertiesArgs

    AddressPrefixes List<string>
    List of IP address prefixes of the resource.
    Description string
    DisplayName string
    String representing a friendly name for the resource.
    ParentPoolName string
    String representing parent IpamPool resource name. If empty the IpamPool will be a root pool.
    AddressPrefixes []string
    List of IP address prefixes of the resource.
    Description string
    DisplayName string
    String representing a friendly name for the resource.
    ParentPoolName string
    String representing parent IpamPool resource name. If empty the IpamPool will be a root pool.
    addressPrefixes List<String>
    List of IP address prefixes of the resource.
    description String
    displayName String
    String representing a friendly name for the resource.
    parentPoolName String
    String representing parent IpamPool resource name. If empty the IpamPool will be a root pool.
    addressPrefixes string[]
    List of IP address prefixes of the resource.
    description string
    displayName string
    String representing a friendly name for the resource.
    parentPoolName string
    String representing parent IpamPool resource name. If empty the IpamPool will be a root pool.
    address_prefixes Sequence[str]
    List of IP address prefixes of the resource.
    description str
    display_name str
    String representing a friendly name for the resource.
    parent_pool_name str
    String representing parent IpamPool resource name. If empty the IpamPool will be a root pool.
    addressPrefixes List<String>
    List of IP address prefixes of the resource.
    description String
    displayName String
    String representing a friendly name for the resource.
    parentPoolName String
    String representing parent IpamPool resource name. If empty the IpamPool will be a root pool.

    IpamPoolPropertiesResponse, IpamPoolPropertiesResponseArgs

    AddressPrefixes List<string>
    List of IP address prefixes of the resource.
    IpAddressType List<string>
    List of IP address type for the IpamPool.
    ProvisioningState string
    Provisioning states of a resource.
    Description string
    DisplayName string
    String representing a friendly name for the resource.
    ParentPoolName string
    String representing parent IpamPool resource name. If empty the IpamPool will be a root pool.
    AddressPrefixes []string
    List of IP address prefixes of the resource.
    IpAddressType []string
    List of IP address type for the IpamPool.
    ProvisioningState string
    Provisioning states of a resource.
    Description string
    DisplayName string
    String representing a friendly name for the resource.
    ParentPoolName string
    String representing parent IpamPool resource name. If empty the IpamPool will be a root pool.
    addressPrefixes List<String>
    List of IP address prefixes of the resource.
    ipAddressType List<String>
    List of IP address type for the IpamPool.
    provisioningState String
    Provisioning states of a resource.
    description String
    displayName String
    String representing a friendly name for the resource.
    parentPoolName String
    String representing parent IpamPool resource name. If empty the IpamPool will be a root pool.
    addressPrefixes string[]
    List of IP address prefixes of the resource.
    ipAddressType string[]
    List of IP address type for the IpamPool.
    provisioningState string
    Provisioning states of a resource.
    description string
    displayName string
    String representing a friendly name for the resource.
    parentPoolName string
    String representing parent IpamPool resource name. If empty the IpamPool will be a root pool.
    address_prefixes Sequence[str]
    List of IP address prefixes of the resource.
    ip_address_type Sequence[str]
    List of IP address type for the IpamPool.
    provisioning_state str
    Provisioning states of a resource.
    description str
    display_name str
    String representing a friendly name for the resource.
    parent_pool_name str
    String representing parent IpamPool resource name. If empty the IpamPool will be a root pool.
    addressPrefixes List<String>
    List of IP address prefixes of the resource.
    ipAddressType List<String>
    List of IP address type for the IpamPool.
    provisioningState String
    Provisioning states of a resource.
    description String
    displayName String
    String representing a friendly name for the resource.
    parentPoolName String
    String representing parent IpamPool resource name. If empty the IpamPool will be a root pool.

    SystemDataResponse, SystemDataResponseArgs

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The type of identity that last modified the resource.
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The type of identity that last modified the resource.
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The type of identity that last modified the resource.
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The type of identity that last modified the resource.
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The type of identity that last modified the resource.
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The type of identity that last modified the resource.
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:network:IpamPool TestPool /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/ipamPools/{poolName}

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

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
    pulumi/pulumi-azure-native