1. Packages
  2. Nsxt Provider
  3. API Docs
  4. IpPoolAllocationIpAddress
nsxt 3.8.0 published on Monday, Apr 14, 2025 by vmware

nsxt.IpPoolAllocationIpAddress

Explore with Pulumi AI

Create IpPoolAllocationIpAddress Resource

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

Constructor syntax

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

@overload
def IpPoolAllocationIpAddress(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              ip_pool_id: Optional[str] = None,
                              allocation_id: Optional[str] = None,
                              ip_pool_allocation_ip_address_id: Optional[str] = None)
func NewIpPoolAllocationIpAddress(ctx *Context, name string, args IpPoolAllocationIpAddressArgs, opts ...ResourceOption) (*IpPoolAllocationIpAddress, error)
public IpPoolAllocationIpAddress(string name, IpPoolAllocationIpAddressArgs args, CustomResourceOptions? opts = null)
public IpPoolAllocationIpAddress(String name, IpPoolAllocationIpAddressArgs args)
public IpPoolAllocationIpAddress(String name, IpPoolAllocationIpAddressArgs args, CustomResourceOptions options)
type: nsxt:IpPoolAllocationIpAddress
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. IpPoolAllocationIpAddressArgs
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. IpPoolAllocationIpAddressArgs
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. IpPoolAllocationIpAddressArgs
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. IpPoolAllocationIpAddressArgs
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. IpPoolAllocationIpAddressArgs
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 ipPoolAllocationIpAddressResource = new Nsxt.IpPoolAllocationIpAddress("ipPoolAllocationIpAddressResource", new()
{
    IpPoolId = "string",
    AllocationId = "string",
    IpPoolAllocationIpAddressId = "string",
});
Copy
example, err := nsxt.NewIpPoolAllocationIpAddress(ctx, "ipPoolAllocationIpAddressResource", &nsxt.IpPoolAllocationIpAddressArgs{
IpPoolId: pulumi.String("string"),
AllocationId: pulumi.String("string"),
IpPoolAllocationIpAddressId: pulumi.String("string"),
})
Copy
var ipPoolAllocationIpAddressResource = new IpPoolAllocationIpAddress("ipPoolAllocationIpAddressResource", IpPoolAllocationIpAddressArgs.builder()
    .ipPoolId("string")
    .allocationId("string")
    .ipPoolAllocationIpAddressId("string")
    .build());
Copy
ip_pool_allocation_ip_address_resource = nsxt.IpPoolAllocationIpAddress("ipPoolAllocationIpAddressResource",
    ip_pool_id="string",
    allocation_id="string",
    ip_pool_allocation_ip_address_id="string")
Copy
const ipPoolAllocationIpAddressResource = new nsxt.IpPoolAllocationIpAddress("ipPoolAllocationIpAddressResource", {
    ipPoolId: "string",
    allocationId: "string",
    ipPoolAllocationIpAddressId: "string",
});
Copy
type: nsxt:IpPoolAllocationIpAddress
properties:
    allocationId: string
    ipPoolAllocationIpAddressId: string
    ipPoolId: string
Copy

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

IpPoolId This property is required. string
Ip Pool ID from which the IP address will be allocated.
AllocationId string
IP Address that is allocated from the pool
IpPoolAllocationIpAddressId string
ID of the IP pool allocation IP address (currently identical to allocation_ip).
IpPoolId This property is required. string
Ip Pool ID from which the IP address will be allocated.
AllocationId string
IP Address that is allocated from the pool
IpPoolAllocationIpAddressId string
ID of the IP pool allocation IP address (currently identical to allocation_ip).
ipPoolId This property is required. String
Ip Pool ID from which the IP address will be allocated.
allocationId String
IP Address that is allocated from the pool
ipPoolAllocationIpAddressId String
ID of the IP pool allocation IP address (currently identical to allocation_ip).
ipPoolId This property is required. string
Ip Pool ID from which the IP address will be allocated.
allocationId string
IP Address that is allocated from the pool
ipPoolAllocationIpAddressId string
ID of the IP pool allocation IP address (currently identical to allocation_ip).
ip_pool_id This property is required. str
Ip Pool ID from which the IP address will be allocated.
allocation_id str
IP Address that is allocated from the pool
ip_pool_allocation_ip_address_id str
ID of the IP pool allocation IP address (currently identical to allocation_ip).
ipPoolId This property is required. String
Ip Pool ID from which the IP address will be allocated.
allocationId String
IP Address that is allocated from the pool
ipPoolAllocationIpAddressId String
ID of the IP pool allocation IP address (currently identical to allocation_ip).

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing IpPoolAllocationIpAddress Resource

Get an existing IpPoolAllocationIpAddress 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?: IpPoolAllocationIpAddressState, opts?: CustomResourceOptions): IpPoolAllocationIpAddress
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allocation_id: Optional[str] = None,
        ip_pool_allocation_ip_address_id: Optional[str] = None,
        ip_pool_id: Optional[str] = None) -> IpPoolAllocationIpAddress
func GetIpPoolAllocationIpAddress(ctx *Context, name string, id IDInput, state *IpPoolAllocationIpAddressState, opts ...ResourceOption) (*IpPoolAllocationIpAddress, error)
public static IpPoolAllocationIpAddress Get(string name, Input<string> id, IpPoolAllocationIpAddressState? state, CustomResourceOptions? opts = null)
public static IpPoolAllocationIpAddress get(String name, Output<String> id, IpPoolAllocationIpAddressState state, CustomResourceOptions options)
resources:  _:    type: nsxt:IpPoolAllocationIpAddress    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:
AllocationId string
IP Address that is allocated from the pool
IpPoolAllocationIpAddressId string
ID of the IP pool allocation IP address (currently identical to allocation_ip).
IpPoolId string
Ip Pool ID from which the IP address will be allocated.
AllocationId string
IP Address that is allocated from the pool
IpPoolAllocationIpAddressId string
ID of the IP pool allocation IP address (currently identical to allocation_ip).
IpPoolId string
Ip Pool ID from which the IP address will be allocated.
allocationId String
IP Address that is allocated from the pool
ipPoolAllocationIpAddressId String
ID of the IP pool allocation IP address (currently identical to allocation_ip).
ipPoolId String
Ip Pool ID from which the IP address will be allocated.
allocationId string
IP Address that is allocated from the pool
ipPoolAllocationIpAddressId string
ID of the IP pool allocation IP address (currently identical to allocation_ip).
ipPoolId string
Ip Pool ID from which the IP address will be allocated.
allocation_id str
IP Address that is allocated from the pool
ip_pool_allocation_ip_address_id str
ID of the IP pool allocation IP address (currently identical to allocation_ip).
ip_pool_id str
Ip Pool ID from which the IP address will be allocated.
allocationId String
IP Address that is allocated from the pool
ipPoolAllocationIpAddressId String
ID of the IP pool allocation IP address (currently identical to allocation_ip).
ipPoolId String
Ip Pool ID from which the IP address will be allocated.

Package Details

Repository
nsxt vmware/terraform-provider-nsxt
License
Notes
This Pulumi package is based on the nsxt Terraform Provider.