Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Nsxt Provider
  3. API Docs
  4. PolicyIpAddressAllocation
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
vmware/terraform-provider-nsxt

nsxt.PolicyIpAddressAllocation

Explore with Pulumi AI

nsxt logo
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
vmware/terraform-provider-nsxt

    Create PolicyIpAddressAllocation Resource

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

    Constructor syntax

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

@overload
def PolicyIpAddressAllocation(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              display_name: Optional[str] = None,
                              pool_path: Optional[str] = None,
                              allocation_ip: Optional[str] = None,
                              context: Optional[PolicyIpAddressAllocationContextArgs] = None,
                              description: Optional[str] = None,
                              nsx_id: Optional[str] = None,
                              policy_ip_address_allocation_id: Optional[str] = None,
                              tags: Optional[Sequence[PolicyIpAddressAllocationTagArgs]] = None,
                              timeout: Optional[float] = None)
    func NewPolicyIpAddressAllocation(ctx *Context, name string, args PolicyIpAddressAllocationArgs, opts ...ResourceOption) (*PolicyIpAddressAllocation, error)
    public PolicyIpAddressAllocation(string name, PolicyIpAddressAllocationArgs args, CustomResourceOptions? opts = null)
    public PolicyIpAddressAllocation(String name, PolicyIpAddressAllocationArgs args)
public PolicyIpAddressAllocation(String name, PolicyIpAddressAllocationArgs args, CustomResourceOptions options)

    type: nsxt:PolicyIpAddressAllocation
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 PolicyIpAddressAllocationArgs
    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 PolicyIpAddressAllocationArgs
    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 PolicyIpAddressAllocationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyIpAddressAllocationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyIpAddressAllocationArgs
    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 policyIpAddressAllocationResource = new Nsxt.PolicyIpAddressAllocation("policyIpAddressAllocationResource", new()
{
    DisplayName = "string",
    PoolPath = "string",
    AllocationIp = "string",
    Context = new Nsxt.Inputs.PolicyIpAddressAllocationContextArgs
    {
        ProjectId = "string",
    },
    Description = "string",
    NsxId = "string",
    PolicyIpAddressAllocationId = "string",
    Tags = new[]
    {
        new Nsxt.Inputs.PolicyIpAddressAllocationTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
    Timeout = 0,
});

    example, err := nsxt.NewPolicyIpAddressAllocation(ctx, "policyIpAddressAllocationResource", &nsxt.PolicyIpAddressAllocationArgs{
	DisplayName:  pulumi.String("string"),
	PoolPath:     pulumi.String("string"),
	AllocationIp: pulumi.String("string"),
	Context: &nsxt.PolicyIpAddressAllocationContextArgs{
		ProjectId: pulumi.String("string"),
	},
	Description:                 pulumi.String("string"),
	NsxId:                       pulumi.String("string"),
	PolicyIpAddressAllocationId: pulumi.String("string"),
	Tags: nsxt.PolicyIpAddressAllocationTagArray{
		&nsxt.PolicyIpAddressAllocationTagArgs{
			Scope: pulumi.String("string"),
			Tag:   pulumi.String("string"),
		},
	},
	Timeout: pulumi.Float64(0),
})

    var policyIpAddressAllocationResource = new PolicyIpAddressAllocation("policyIpAddressAllocationResource", PolicyIpAddressAllocationArgs.builder()
    .displayName("string")
    .poolPath("string")
    .allocationIp("string")
    .context(PolicyIpAddressAllocationContextArgs.builder()
        .projectId("string")
        .build())
    .description("string")
    .nsxId("string")
    .policyIpAddressAllocationId("string")
    .tags(PolicyIpAddressAllocationTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .timeout(0)
    .build());

    policy_ip_address_allocation_resource = nsxt.PolicyIpAddressAllocation("policyIpAddressAllocationResource",
    display_name="string",
    pool_path="string",
    allocation_ip="string",
    context={
        "project_id": "string",
    },
    description="string",
    nsx_id="string",
    policy_ip_address_allocation_id="string",
    tags=[{
        "scope": "string",
        "tag": "string",
    }],
    timeout=0)

    const policyIpAddressAllocationResource = new nsxt.PolicyIpAddressAllocation("policyIpAddressAllocationResource", {
    displayName: "string",
    poolPath: "string",
    allocationIp: "string",
    context: {
        projectId: "string",
    },
    description: "string",
    nsxId: "string",
    policyIpAddressAllocationId: "string",
    tags: [{
        scope: "string",
        tag: "string",
    }],
    timeout: 0,
});

    type: nsxt:PolicyIpAddressAllocation
properties:
    allocationIp: string
    context:
        projectId: string
    description: string
    displayName: string
    nsxId: string
    policyIpAddressAllocationId: string
    poolPath: string
    tags:
        - scope: string
          tag: string
    timeout: 0

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

    DisplayName string
    Display name of the resource.
    PoolPath string
    The policy path to the IP Pool for this Allocation.
    AllocationIp string
    The IP Address to allocate. If unspecified any free IP in the pool will be allocated.
    Context PolicyIpAddressAllocationContext
    The context which the object belongs to
    Description string
    Description of the resource.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    PolicyIpAddressAllocationId string
    ID of the Allocation.
    Tags List<PolicyIpAddressAllocationTag>
    A list of scope + tag pairs to associate with this resource.
    Timeout double
    Realization timeout in seconds
    DisplayName string
    Display name of the resource.
    PoolPath string
    The policy path to the IP Pool for this Allocation.
    AllocationIp string
    The IP Address to allocate. If unspecified any free IP in the pool will be allocated.
    Context PolicyIpAddressAllocationContextArgs
    The context which the object belongs to
    Description string
    Description of the resource.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    PolicyIpAddressAllocationId string
    ID of the Allocation.
    Tags []PolicyIpAddressAllocationTagArgs
    A list of scope + tag pairs to associate with this resource.
    Timeout float64
    Realization timeout in seconds
    displayName String
    Display name of the resource.
    poolPath String
    The policy path to the IP Pool for this Allocation.
    allocationIp String
    The IP Address to allocate. If unspecified any free IP in the pool will be allocated.
    context PolicyIpAddressAllocationContext
    The context which the object belongs to
    description String
    Description of the resource.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policyIpAddressAllocationId String
    ID of the Allocation.
    tags List<PolicyIpAddressAllocationTag>
    A list of scope + tag pairs to associate with this resource.
    timeout Double
    Realization timeout in seconds
    displayName string
    Display name of the resource.
    poolPath string
    The policy path to the IP Pool for this Allocation.
    allocationIp string
    The IP Address to allocate. If unspecified any free IP in the pool will be allocated.
    context PolicyIpAddressAllocationContext
    The context which the object belongs to
    description string
    Description of the resource.
    nsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policyIpAddressAllocationId string
    ID of the Allocation.
    tags PolicyIpAddressAllocationTag[]
    A list of scope + tag pairs to associate with this resource.
    timeout number
    Realization timeout in seconds
    display_name str
    Display name of the resource.
    pool_path str
    The policy path to the IP Pool for this Allocation.
    allocation_ip str
    The IP Address to allocate. If unspecified any free IP in the pool will be allocated.
    context PolicyIpAddressAllocationContextArgs
    The context which the object belongs to
    description str
    Description of the resource.
    nsx_id str
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policy_ip_address_allocation_id str
    ID of the Allocation.
    tags Sequence[PolicyIpAddressAllocationTagArgs]
    A list of scope + tag pairs to associate with this resource.
    timeout float
    Realization timeout in seconds
    displayName String
    Display name of the resource.
    poolPath String
    The policy path to the IP Pool for this Allocation.
    allocationIp String
    The IP Address to allocate. If unspecified any free IP in the pool will be allocated.
    context Property Map
    The context which the object belongs to
    description String
    Description of the resource.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policyIpAddressAllocationId String
    ID of the Allocation.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this resource.
    timeout Number
    Realization timeout in seconds

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Path string
    The NSX path of the policy resource.
    Revision double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    Id string
    The provider-assigned unique ID for this managed resource.
    Path string
    The NSX path of the policy resource.
    Revision float64
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    id String
    The provider-assigned unique ID for this managed resource.
    path String
    The NSX path of the policy resource.
    revision Double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    id string
    The provider-assigned unique ID for this managed resource.
    path string
    The NSX path of the policy resource.
    revision number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    id str
    The provider-assigned unique ID for this managed resource.
    path str
    The NSX path of the policy resource.
    revision float
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    id String
    The provider-assigned unique ID for this managed resource.
    path String
    The NSX path of the policy resource.
    revision Number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.

    Look up Existing PolicyIpAddressAllocation Resource

    Get an existing PolicyIpAddressAllocation 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?: PolicyIpAddressAllocationState, opts?: CustomResourceOptions): PolicyIpAddressAllocation
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allocation_ip: Optional[str] = None,
        context: Optional[PolicyIpAddressAllocationContextArgs] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        nsx_id: Optional[str] = None,
        path: Optional[str] = None,
        policy_ip_address_allocation_id: Optional[str] = None,
        pool_path: Optional[str] = None,
        revision: Optional[float] = None,
        tags: Optional[Sequence[PolicyIpAddressAllocationTagArgs]] = None,
        timeout: Optional[float] = None) -> PolicyIpAddressAllocation
    func GetPolicyIpAddressAllocation(ctx *Context, name string, id IDInput, state *PolicyIpAddressAllocationState, opts ...ResourceOption) (*PolicyIpAddressAllocation, error)
    public static PolicyIpAddressAllocation Get(string name, Input<string> id, PolicyIpAddressAllocationState? state, CustomResourceOptions? opts = null)
    public static PolicyIpAddressAllocation get(String name, Output<String> id, PolicyIpAddressAllocationState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:PolicyIpAddressAllocation    get:      id: ${id}
    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:
    AllocationIp string
    The IP Address to allocate. If unspecified any free IP in the pool will be allocated.
    Context PolicyIpAddressAllocationContext
    The context which the object belongs to
    Description string
    Description of the resource.
    DisplayName string
    Display name of the resource.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    Path string
    The NSX path of the policy resource.
    PolicyIpAddressAllocationId string
    ID of the Allocation.
    PoolPath string
    The policy path to the IP Pool for this Allocation.
    Revision double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    Tags List<PolicyIpAddressAllocationTag>
    A list of scope + tag pairs to associate with this resource.
    Timeout double
    Realization timeout in seconds
    AllocationIp string
    The IP Address to allocate. If unspecified any free IP in the pool will be allocated.
    Context PolicyIpAddressAllocationContextArgs
    The context which the object belongs to
    Description string
    Description of the resource.
    DisplayName string
    Display name of the resource.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    Path string
    The NSX path of the policy resource.
    PolicyIpAddressAllocationId string
    ID of the Allocation.
    PoolPath string
    The policy path to the IP Pool for this Allocation.
    Revision float64
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    Tags []PolicyIpAddressAllocationTagArgs
    A list of scope + tag pairs to associate with this resource.
    Timeout float64
    Realization timeout in seconds
    allocationIp String
    The IP Address to allocate. If unspecified any free IP in the pool will be allocated.
    context PolicyIpAddressAllocationContext
    The context which the object belongs to
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    path String
    The NSX path of the policy resource.
    policyIpAddressAllocationId String
    ID of the Allocation.
    poolPath String
    The policy path to the IP Pool for this Allocation.
    revision Double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags List<PolicyIpAddressAllocationTag>
    A list of scope + tag pairs to associate with this resource.
    timeout Double
    Realization timeout in seconds
    allocationIp string
    The IP Address to allocate. If unspecified any free IP in the pool will be allocated.
    context PolicyIpAddressAllocationContext
    The context which the object belongs to
    description string
    Description of the resource.
    displayName string
    Display name of the resource.
    nsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    path string
    The NSX path of the policy resource.
    policyIpAddressAllocationId string
    ID of the Allocation.
    poolPath string
    The policy path to the IP Pool for this Allocation.
    revision number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags PolicyIpAddressAllocationTag[]
    A list of scope + tag pairs to associate with this resource.
    timeout number
    Realization timeout in seconds
    allocation_ip str
    The IP Address to allocate. If unspecified any free IP in the pool will be allocated.
    context PolicyIpAddressAllocationContextArgs
    The context which the object belongs to
    description str
    Description of the resource.
    display_name str
    Display name of the resource.
    nsx_id str
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    path str
    The NSX path of the policy resource.
    policy_ip_address_allocation_id str
    ID of the Allocation.
    pool_path str
    The policy path to the IP Pool for this Allocation.
    revision float
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags Sequence[PolicyIpAddressAllocationTagArgs]
    A list of scope + tag pairs to associate with this resource.
    timeout float
    Realization timeout in seconds
    allocationIp String
    The IP Address to allocate. If unspecified any free IP in the pool will be allocated.
    context Property Map
    The context which the object belongs to
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    path String
    The NSX path of the policy resource.
    policyIpAddressAllocationId String
    ID of the Allocation.
    poolPath String
    The policy path to the IP Pool for this Allocation.
    revision Number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this resource.
    timeout Number
    Realization timeout in seconds

    Supporting Types

    PolicyIpAddressAllocationContext, PolicyIpAddressAllocationContextArgs

    ProjectId string
    The ID of the project which the object belongs to
    ProjectId string
    The ID of the project which the object belongs to
    projectId String
    The ID of the project which the object belongs to
    projectId string
    The ID of the project which the object belongs to
    project_id str
    The ID of the project which the object belongs to
    projectId String
    The ID of the project which the object belongs to

    PolicyIpAddressAllocationTag, PolicyIpAddressAllocationTagArgs

    Scope string
    Tag string
    A list of scope + tag pairs to associate with this resource.
    Scope string
    Tag string
    A list of scope + tag pairs to associate with this resource.
    scope String
    tag String
    A list of scope + tag pairs to associate with this resource.
    scope string
    tag string
    A list of scope + tag pairs to associate with this resource.
    scope str
    tag str
    A list of scope + tag pairs to associate with this resource.
    scope String
    tag String
    A list of scope + tag pairs to associate with this resource.

    Package Details

    Repository
    nsxt vmware/terraform-provider-nsxt
    License
    Notes
    This Pulumi package is based on the nsxt Terraform Provider.
    nsxt logo
    nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
    vmware/terraform-provider-nsxt