1. Packages
  2. Nsxt Provider
  3. API Docs
  4. NsServiceGroup
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware

nsxt.NsServiceGroup

Explore with Pulumi AI

nsxt logo
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware

    Create NsServiceGroup Resource

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

    Constructor syntax

    new NsServiceGroup(name: string, args: NsServiceGroupArgs, opts?: CustomResourceOptions);
    @overload
    def NsServiceGroup(resource_name: str,
                       args: NsServiceGroupArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def NsServiceGroup(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       members: Optional[Sequence[str]] = None,
                       description: Optional[str] = None,
                       display_name: Optional[str] = None,
                       ns_service_group_id: Optional[str] = None,
                       tags: Optional[Sequence[NsServiceGroupTagArgs]] = None)
    func NewNsServiceGroup(ctx *Context, name string, args NsServiceGroupArgs, opts ...ResourceOption) (*NsServiceGroup, error)
    public NsServiceGroup(string name, NsServiceGroupArgs args, CustomResourceOptions? opts = null)
    public NsServiceGroup(String name, NsServiceGroupArgs args)
    public NsServiceGroup(String name, NsServiceGroupArgs args, CustomResourceOptions options)
    
    type: nsxt:NsServiceGroup
    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 NsServiceGroupArgs
    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 NsServiceGroupArgs
    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 NsServiceGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NsServiceGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NsServiceGroupArgs
    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 nsServiceGroupResource = new Nsxt.NsServiceGroup("nsServiceGroupResource", new()
    {
        Members = new[]
        {
            "string",
        },
        Description = "string",
        DisplayName = "string",
        NsServiceGroupId = "string",
        Tags = new[]
        {
            new Nsxt.Inputs.NsServiceGroupTagArgs
            {
                Scope = "string",
                Tag = "string",
            },
        },
    });
    
    example, err := nsxt.NewNsServiceGroup(ctx, "nsServiceGroupResource", &nsxt.NsServiceGroupArgs{
    	Members: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Description:      pulumi.String("string"),
    	DisplayName:      pulumi.String("string"),
    	NsServiceGroupId: pulumi.String("string"),
    	Tags: nsxt.NsServiceGroupTagArray{
    		&nsxt.NsServiceGroupTagArgs{
    			Scope: pulumi.String("string"),
    			Tag:   pulumi.String("string"),
    		},
    	},
    })
    
    var nsServiceGroupResource = new NsServiceGroup("nsServiceGroupResource", NsServiceGroupArgs.builder()
        .members("string")
        .description("string")
        .displayName("string")
        .nsServiceGroupId("string")
        .tags(NsServiceGroupTagArgs.builder()
            .scope("string")
            .tag("string")
            .build())
        .build());
    
    ns_service_group_resource = nsxt.NsServiceGroup("nsServiceGroupResource",
        members=["string"],
        description="string",
        display_name="string",
        ns_service_group_id="string",
        tags=[{
            "scope": "string",
            "tag": "string",
        }])
    
    const nsServiceGroupResource = new nsxt.NsServiceGroup("nsServiceGroupResource", {
        members: ["string"],
        description: "string",
        displayName: "string",
        nsServiceGroupId: "string",
        tags: [{
            scope: "string",
            tag: "string",
        }],
    });
    
    type: nsxt:NsServiceGroup
    properties:
        description: string
        displayName: string
        members:
            - string
        nsServiceGroupId: string
        tags:
            - scope: string
              tag: string
    

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

    Members List<string>
    List of NSServices IDs that can be added as members to an NSServiceGroup. All members should be of the same L2 type: Ethernet, or Non Ethernet.
    Description string
    Description of this resource.
    DisplayName string
    The display name of this resource. Defaults to ID if not set.
    NsServiceGroupId string
    ID of the NS service group.
    Tags List<NsServiceGroupTag>
    A list of scope + tag pairs to associate with this NS service group.
    Members []string
    List of NSServices IDs that can be added as members to an NSServiceGroup. All members should be of the same L2 type: Ethernet, or Non Ethernet.
    Description string
    Description of this resource.
    DisplayName string
    The display name of this resource. Defaults to ID if not set.
    NsServiceGroupId string
    ID of the NS service group.
    Tags []NsServiceGroupTagArgs
    A list of scope + tag pairs to associate with this NS service group.
    members List<String>
    List of NSServices IDs that can be added as members to an NSServiceGroup. All members should be of the same L2 type: Ethernet, or Non Ethernet.
    description String
    Description of this resource.
    displayName String
    The display name of this resource. Defaults to ID if not set.
    nsServiceGroupId String
    ID of the NS service group.
    tags List<NsServiceGroupTag>
    A list of scope + tag pairs to associate with this NS service group.
    members string[]
    List of NSServices IDs that can be added as members to an NSServiceGroup. All members should be of the same L2 type: Ethernet, or Non Ethernet.
    description string
    Description of this resource.
    displayName string
    The display name of this resource. Defaults to ID if not set.
    nsServiceGroupId string
    ID of the NS service group.
    tags NsServiceGroupTag[]
    A list of scope + tag pairs to associate with this NS service group.
    members Sequence[str]
    List of NSServices IDs that can be added as members to an NSServiceGroup. All members should be of the same L2 type: Ethernet, or Non Ethernet.
    description str
    Description of this resource.
    display_name str
    The display name of this resource. Defaults to ID if not set.
    ns_service_group_id str
    ID of the NS service group.
    tags Sequence[NsServiceGroupTagArgs]
    A list of scope + tag pairs to associate with this NS service group.
    members List<String>
    List of NSServices IDs that can be added as members to an NSServiceGroup. All members should be of the same L2 type: Ethernet, or Non Ethernet.
    description String
    Description of this resource.
    displayName String
    The display name of this resource. Defaults to ID if not set.
    nsServiceGroupId String
    ID of the NS service group.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this NS service group.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the NsServiceGroup 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 NsServiceGroup Resource

    Get an existing NsServiceGroup 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?: NsServiceGroupState, opts?: CustomResourceOptions): NsServiceGroup
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            display_name: Optional[str] = None,
            members: Optional[Sequence[str]] = None,
            ns_service_group_id: Optional[str] = None,
            revision: Optional[float] = None,
            tags: Optional[Sequence[NsServiceGroupTagArgs]] = None) -> NsServiceGroup
    func GetNsServiceGroup(ctx *Context, name string, id IDInput, state *NsServiceGroupState, opts ...ResourceOption) (*NsServiceGroup, error)
    public static NsServiceGroup Get(string name, Input<string> id, NsServiceGroupState? state, CustomResourceOptions? opts = null)
    public static NsServiceGroup get(String name, Output<String> id, NsServiceGroupState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:NsServiceGroup    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.
    Members List<string>
    List of NSServices IDs that can be added as members to an NSServiceGroup. All members should be of the same L2 type: Ethernet, or Non Ethernet.
    NsServiceGroupId string
    ID of the NS service group.
    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<NsServiceGroupTag>
    A list of scope + tag pairs to associate with this NS service group.
    Description string
    Description of this resource.
    DisplayName string
    The display name of this resource. Defaults to ID if not set.
    Members []string
    List of NSServices IDs that can be added as members to an NSServiceGroup. All members should be of the same L2 type: Ethernet, or Non Ethernet.
    NsServiceGroupId string
    ID of the NS service group.
    Revision float64
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    Tags []NsServiceGroupTagArgs
    A list of scope + tag pairs to associate with this NS service group.
    description String
    Description of this resource.
    displayName String
    The display name of this resource. Defaults to ID if not set.
    members List<String>
    List of NSServices IDs that can be added as members to an NSServiceGroup. All members should be of the same L2 type: Ethernet, or Non Ethernet.
    nsServiceGroupId String
    ID of the NS service group.
    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<NsServiceGroupTag>
    A list of scope + tag pairs to associate with this NS service group.
    description string
    Description of this resource.
    displayName string
    The display name of this resource. Defaults to ID if not set.
    members string[]
    List of NSServices IDs that can be added as members to an NSServiceGroup. All members should be of the same L2 type: Ethernet, or Non Ethernet.
    nsServiceGroupId string
    ID of the NS service group.
    revision number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags NsServiceGroupTag[]
    A list of scope + tag pairs to associate with this NS service group.
    description str
    Description of this resource.
    display_name str
    The display name of this resource. Defaults to ID if not set.
    members Sequence[str]
    List of NSServices IDs that can be added as members to an NSServiceGroup. All members should be of the same L2 type: Ethernet, or Non Ethernet.
    ns_service_group_id str
    ID of the NS service group.
    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[NsServiceGroupTagArgs]
    A list of scope + tag pairs to associate with this NS service group.
    description String
    Description of this resource.
    displayName String
    The display name of this resource. Defaults to ID if not set.
    members List<String>
    List of NSServices IDs that can be added as members to an NSServiceGroup. All members should be of the same L2 type: Ethernet, or Non Ethernet.
    nsServiceGroupId String
    ID of the NS service group.
    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 NS service group.

    Supporting Types

    NsServiceGroupTag, NsServiceGroupTagArgs

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

    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