Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Nsxt Provider
  3. API Docs
  4. getNsService
nsxt 3.8.0 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-nsxt

nsxt.getNsService

Explore with Pulumi AI

nsxt 3.8.0 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-nsxt

This data source provides information about a network and security (NS) service configured in NSX. NS services are either factory defined in NSX or can be defined by the NSX administrator. They provide a convenience name for a port/protocol pair that is often used in fire walling or load balancing.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as nsxt from "@pulumi/nsxt";

const nsServiceDns = nsxt.getNsService({
    displayName: "DNS",
});
Copy
import pulumi
import pulumi_nsxt as nsxt

ns_service_dns = nsxt.get_ns_service(display_name="DNS")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/nsxt/v3/nsxt"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := nsxt.GetNsService(ctx, &nsxt.GetNsServiceArgs{
			DisplayName: pulumi.StringRef("DNS"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Nsxt = Pulumi.Nsxt;

return await Deployment.RunAsync(() => 
{
    var nsServiceDns = Nsxt.GetNsService.Invoke(new()
    {
        DisplayName = "DNS",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.nsxt.NsxtFunctions;
import com.pulumi.nsxt.inputs.GetNsServiceArgs;
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) {
        final var nsServiceDns = NsxtFunctions.getNsService(GetNsServiceArgs.builder()
            .displayName("DNS")
            .build());

    }
}
Copy
variables:
  nsServiceDns:
    fn::invoke:
      function: nsxt:getNsService
      arguments:
        displayName: DNS
Copy

Using getNsService

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getNsService(args: GetNsServiceArgs, opts?: InvokeOptions): Promise<GetNsServiceResult>
function getNsServiceOutput(args: GetNsServiceOutputArgs, opts?: InvokeOptions): Output<GetNsServiceResult>
Copy
def get_ns_service(description: Optional[str] = None,
                   display_name: Optional[str] = None,
                   id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetNsServiceResult
def get_ns_service_output(description: Optional[pulumi.Input[str]] = None,
                   display_name: Optional[pulumi.Input[str]] = None,
                   id: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetNsServiceResult]
Copy
func GetNsService(ctx *Context, args *GetNsServiceArgs, opts ...InvokeOption) (*GetNsServiceResult, error)
func GetNsServiceOutput(ctx *Context, args *GetNsServiceOutputArgs, opts ...InvokeOption) GetNsServiceResultOutput
Copy

> Note: This function is named GetNsService in the Go SDK.

public static class GetNsService 
{
    public static Task<GetNsServiceResult> InvokeAsync(GetNsServiceArgs args, InvokeOptions? opts = null)
    public static Output<GetNsServiceResult> Invoke(GetNsServiceInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetNsServiceResult> getNsService(GetNsServiceArgs args, InvokeOptions options)
public static Output<GetNsServiceResult> getNsService(GetNsServiceArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: nsxt:index/getNsService:getNsService
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Description string
The description of the NS service.
DisplayName string
The Display Name of the NS service to retrieve.
Id string
The ID of NS service to retrieve
Description string
The description of the NS service.
DisplayName string
The Display Name of the NS service to retrieve.
Id string
The ID of NS service to retrieve
description String
The description of the NS service.
displayName String
The Display Name of the NS service to retrieve.
id String
The ID of NS service to retrieve
description string
The description of the NS service.
displayName string
The Display Name of the NS service to retrieve.
id string
The ID of NS service to retrieve
description str
The description of the NS service.
display_name str
The Display Name of the NS service to retrieve.
id str
The ID of NS service to retrieve
description String
The description of the NS service.
displayName String
The Display Name of the NS service to retrieve.
id String
The ID of NS service to retrieve

getNsService Result

The following output properties are available:

Description string
The description of the NS service.
DisplayName string
Id string
Description string
The description of the NS service.
DisplayName string
Id string
description String
The description of the NS service.
displayName String
id String
description string
The description of the NS service.
displayName string
id string
description str
The description of the NS service.
display_name str
id str
description String
The description of the NS service.
displayName String
id String

Package Details

Repository
nsxt vmware/terraform-provider-nsxt
License
Notes
This Pulumi package is based on the nsxt Terraform Provider.
nsxt 3.8.0 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-nsxt