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

nsxt.IpSet

Explore with Pulumi AI

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

    Create IpSet Resource

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

    Constructor syntax

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

@overload
def IpSet(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          description: Optional[str] = None,
          display_name: Optional[str] = None,
          ip_addresses: Optional[Sequence[str]] = None,
          ip_set_id: Optional[str] = None,
          tags: Optional[Sequence[IpSetTagArgs]] = None)
    func NewIpSet(ctx *Context, name string, args *IpSetArgs, opts ...ResourceOption) (*IpSet, error)
    public IpSet(string name, IpSetArgs? args = null, CustomResourceOptions? opts = null)
    public IpSet(String name, IpSetArgs args)
public IpSet(String name, IpSetArgs args, CustomResourceOptions options)

    type: nsxt:IpSet
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 IpSetArgs
    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 IpSetArgs
    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 IpSetArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IpSetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IpSetArgs
    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 ipSetResource = new Nsxt.IpSet("ipSetResource", new()
{
    Description = "string",
    DisplayName = "string",
    IpAddresses = new[]
    {
        "string",
    },
    IpSetId = "string",
    Tags = new[]
    {
        new Nsxt.Inputs.IpSetTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
});

    example, err := nsxt.NewIpSet(ctx, "ipSetResource", &nsxt.IpSetArgs{
	Description: pulumi.String("string"),
	DisplayName: pulumi.String("string"),
	IpAddresses: pulumi.StringArray{
		pulumi.String("string"),
	},
	IpSetId: pulumi.String("string"),
	Tags: nsxt.IpSetTagArray{
		&nsxt.IpSetTagArgs{
			Scope: pulumi.String("string"),
			Tag:   pulumi.String("string"),
		},
	},
})

    var ipSetResource = new IpSet("ipSetResource", IpSetArgs.builder()
    .description("string")
    .displayName("string")
    .ipAddresses("string")
    .ipSetId("string")
    .tags(IpSetTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .build());

    ip_set_resource = nsxt.IpSet("ipSetResource",
    description="string",
    display_name="string",
    ip_addresses=["string"],
    ip_set_id="string",
    tags=[{
        "scope": "string",
        "tag": "string",
    }])

    const ipSetResource = new nsxt.IpSet("ipSetResource", {
    description: "string",
    displayName: "string",
    ipAddresses: ["string"],
    ipSetId: "string",
    tags: [{
        scope: "string",
        tag: "string",
    }],
});

    type: nsxt:IpSet
properties:
    description: string
    displayName: string
    ipAddresses:
        - string
    ipSetId: string
    tags:
        - scope: string
          tag: string

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

    Description string
    Description of this resource.
    DisplayName string
    The display name of this resource. Defaults to ID if not set.
    IpAddresses List<string>
    IP addresses.
    IpSetId string
    ID of the IP set.
    Tags List<IpSetTag>
    A list of scope + tag pairs to associate with this IP set.
    Description string
    Description of this resource.
    DisplayName string
    The display name of this resource. Defaults to ID if not set.
    IpAddresses []string
    IP addresses.
    IpSetId string
    ID of the IP set.
    Tags []IpSetTagArgs
    A list of scope + tag pairs to associate with this IP set.
    description String
    Description of this resource.
    displayName String
    The display name of this resource. Defaults to ID if not set.
    ipAddresses List<String>
    IP addresses.
    ipSetId String
    ID of the IP set.
    tags List<IpSetTag>
    A list of scope + tag pairs to associate with this IP set.
    description string
    Description of this resource.
    displayName string
    The display name of this resource. Defaults to ID if not set.
    ipAddresses string[]
    IP addresses.
    ipSetId string
    ID of the IP set.
    tags IpSetTag[]
    A list of scope + tag pairs to associate with this IP set.
    description str
    Description of this resource.
    display_name str
    The display name of this resource. Defaults to ID if not set.
    ip_addresses Sequence[str]
    IP addresses.
    ip_set_id str
    ID of the IP set.
    tags Sequence[IpSetTagArgs]
    A list of scope + tag pairs to associate with this IP set.
    description String
    Description of this resource.
    displayName String
    The display name of this resource. Defaults to ID if not set.
    ipAddresses List<String>
    IP addresses.
    ipSetId String
    ID of the IP set.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this IP set.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed 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.
    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.
    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.
    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.
    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.
    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 IpSet Resource

    Get an existing IpSet 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?: IpSetState, opts?: CustomResourceOptions): IpSet
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        ip_addresses: Optional[Sequence[str]] = None,
        ip_set_id: Optional[str] = None,
        revision: Optional[float] = None,
        tags: Optional[Sequence[IpSetTagArgs]] = None) -> IpSet
    func GetIpSet(ctx *Context, name string, id IDInput, state *IpSetState, opts ...ResourceOption) (*IpSet, error)
    public static IpSet Get(string name, Input<string> id, IpSetState? state, CustomResourceOptions? opts = null)
    public static IpSet get(String name, Output<String> id, IpSetState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:IpSet    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:
    Description string
    Description of this resource.
    DisplayName string
    The display name of this resource. Defaults to ID if not set.
    IpAddresses List<string>
    IP addresses.
    IpSetId string
    ID of the IP set.
    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<IpSetTag>
    A list of scope + tag pairs to associate with this IP set.
    Description string
    Description of this resource.
    DisplayName string
    The display name of this resource. Defaults to ID if not set.
    IpAddresses []string
    IP addresses.
    IpSetId string
    ID of the IP set.
    Revision float64
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    Tags []IpSetTagArgs
    A list of scope + tag pairs to associate with this IP set.
    description String
    Description of this resource.
    displayName String
    The display name of this resource. Defaults to ID if not set.
    ipAddresses List<String>
    IP addresses.
    ipSetId String
    ID of the IP set.
    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<IpSetTag>
    A list of scope + tag pairs to associate with this IP set.
    description string
    Description of this resource.
    displayName string
    The display name of this resource. Defaults to ID if not set.
    ipAddresses string[]
    IP addresses.
    ipSetId string
    ID of the IP set.
    revision number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags IpSetTag[]
    A list of scope + tag pairs to associate with this IP set.
    description str
    Description of this resource.
    display_name str
    The display name of this resource. Defaults to ID if not set.
    ip_addresses Sequence[str]
    IP addresses.
    ip_set_id str
    ID of the IP set.
    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[IpSetTagArgs]
    A list of scope + tag pairs to associate with this IP set.
    description String
    Description of this resource.
    displayName String
    The display name of this resource. Defaults to ID if not set.
    ipAddresses List<String>
    IP addresses.
    ipSetId String
    ID of the IP set.
    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 IP set.

    Supporting Types

    IpSetTag, IpSetTagArgs

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

    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