getSecurityGroup

vra 0.17.0, Mar 10 26

Viewing docs for vra 0.17.0
published on Tuesday, Mar 10, 2026 by vmware

Schema (JSON)

vmware/terraform-provider-vra

Viewing docs for vra 0.17.0
published on Tuesday, Mar 10, 2026 by vmware

Schema (JSON)

vmware/terraform-provider-vra

Example Usage

S

This is an example of how to lookup security groups.

Security groups by filter query:

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

// Lookup Security groups using its name
const _this = vra.getSecurityGroup({
    filter: `name eq '${name}'`,
});

import pulumi
import pulumi_vra as vra

# Lookup Security groups using its name
this = vra.get_security_group(filter=f"name eq '{name}'")

package main

import (
	"fmt"

	"github.com/pulumi/pulumi-terraform-provider/sdks/go/vra/vra"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Lookup Security groups using its name
		_, err := vra.GetSecurityGroup(ctx, &vra.GetSecurityGroupArgs{
			Filter: fmt.Sprintf("name eq '%v'", name),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vra = Pulumi.Vra;

return await Deployment.RunAsync(() => 
{
    // Lookup Security groups using its name
    var @this = Vra.GetSecurityGroup.Invoke(new()
    {
        Filter = $"name eq '{name}'",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vra.VraFunctions;
import com.pulumi.vra.inputs.GetSecurityGroupArgs;
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) {
        // Lookup Security groups using its name
        final var this = VraFunctions.getSecurityGroup(GetSecurityGroupArgs.builder()
            .filter(String.format("name eq '%s'", name))
            .build());

    }
}

variables:
  # Lookup Security groups using its name
  this:
    fn::invoke:
      function: vra:getSecurityGroup
      arguments:
        filter: name eq '${name}'

A Security group supports the following arguments:

Using getSecurityGroup

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 getSecurityGroup(args: GetSecurityGroupArgs, opts?: InvokeOptions): Promise<GetSecurityGroupResult>
function getSecurityGroupOutput(args: GetSecurityGroupOutputArgs, opts?: InvokeOptions): Output<GetSecurityGroupResult>

def get_security_group(filter: Optional[str] = None,
                       rules: Optional[Sequence[GetSecurityGroupRule]] = None,
                       opts: Optional[InvokeOptions] = None) -> GetSecurityGroupResult
def get_security_group_output(filter: Optional[pulumi.Input[str]] = None,
                       rules: Optional[pulumi.Input[Sequence[pulumi.Input[GetSecurityGroupRuleArgs]]]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetSecurityGroupResult]

func GetSecurityGroup(ctx *Context, args *GetSecurityGroupArgs, opts ...InvokeOption) (*GetSecurityGroupResult, error)
func GetSecurityGroupOutput(ctx *Context, args *GetSecurityGroupOutputArgs, opts ...InvokeOption) GetSecurityGroupResultOutput

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

public static class GetSecurityGroup 
{
    public static Task<GetSecurityGroupResult> InvokeAsync(GetSecurityGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetSecurityGroupResult> Invoke(GetSecurityGroupInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetSecurityGroupResult> getSecurityGroup(GetSecurityGroupArgs args, InvokeOptions options)
public static Output<GetSecurityGroupResult> getSecurityGroup(GetSecurityGroupArgs args, InvokeOptions options)

fn::invoke:
  function: vra:index/getSecurityGroup:getSecurityGroup
  arguments:
    # arguments dictionary

The following arguments are supported:

Filter string: Search criteria to narrow down the Security groups.
Rules List<GetSecurityGroupRule>: List of security rules.

Filter string: Search criteria to narrow down the Security groups.
Rules []GetSecurityGroupRule: List of security rules.

filter String: Search criteria to narrow down the Security groups.
rules List<GetSecurityGroupRule>: List of security rules.

filter string: Search criteria to narrow down the Security groups.
rules GetSecurityGroupRule[]: List of security rules.

filter str: Search criteria to narrow down the Security groups.
rules Sequence[GetSecurityGroupRule]: List of security rules.

filter String: Search criteria to narrow down the Security groups.
rules List<Property Map>: List of security rules.