vcd.getApiFilter

Explore with Pulumi AI

vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware

Example Usage

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

const apiFilter1 = vcd.getApiFilter({
    apiFilterId: "urn:vcloud:apiFilter:4252ab09-eed8-4bc6-86d7-6019090273f5",
});

import pulumi
import pulumi_vcd as vcd

api_filter1 = vcd.get_api_filter(api_filter_id="urn:vcloud:apiFilter:4252ab09-eed8-4bc6-86d7-6019090273f5")

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vcd.LookupApiFilter(ctx, &vcd.LookupApiFilterArgs{
			ApiFilterId: "urn:vcloud:apiFilter:4252ab09-eed8-4bc6-86d7-6019090273f5",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var apiFilter1 = Vcd.GetApiFilter.Invoke(new()
    {
        ApiFilterId = "urn:vcloud:apiFilter:4252ab09-eed8-4bc6-86d7-6019090273f5",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vcd.VcdFunctions;
import com.pulumi.vcd.inputs.GetApiFilterArgs;
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 apiFilter1 = VcdFunctions.getApiFilter(GetApiFilterArgs.builder()
            .apiFilterId("urn:vcloud:apiFilter:4252ab09-eed8-4bc6-86d7-6019090273f5")
            .build());

    }
}

variables:
  apiFilter1:
    fn::invoke:
      function: vcd:getApiFilter
      arguments:
        apiFilterId: urn:vcloud:apiFilter:4252ab09-eed8-4bc6-86d7-6019090273f5

Using getApiFilter

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 getApiFilter(args: GetApiFilterArgs, opts?: InvokeOptions): Promise<GetApiFilterResult>
function getApiFilterOutput(args: GetApiFilterOutputArgs, opts?: InvokeOptions): Output<GetApiFilterResult>

def get_api_filter(api_filter_id: Optional[str] = None,
                   id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetApiFilterResult
def get_api_filter_output(api_filter_id: Optional[pulumi.Input[str]] = None,
                   id: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetApiFilterResult]

func LookupApiFilter(ctx *Context, args *LookupApiFilterArgs, opts ...InvokeOption) (*LookupApiFilterResult, error)
func LookupApiFilterOutput(ctx *Context, args *LookupApiFilterOutputArgs, opts ...InvokeOption) LookupApiFilterResultOutput

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

public static class GetApiFilter 
{
    public static Task<GetApiFilterResult> InvokeAsync(GetApiFilterArgs args, InvokeOptions? opts = null)
    public static Output<GetApiFilterResult> Invoke(GetApiFilterInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetApiFilterResult> getApiFilter(GetApiFilterArgs args, InvokeOptions options)
public static Output<GetApiFilterResult> getApiFilter(GetApiFilterArgs args, InvokeOptions options)

fn::invoke:
  function: vcd:index/getApiFilter:getApiFilter
  arguments:
    # arguments dictionary

The following arguments are supported:

ApiFilterId string: ID of the API Filter. This is the only way of unequivocally identify an API Filter. A list of available API Filters can be obtained by using the list@ option of the import mechanism of the resource
Id string

ApiFilterId string: ID of the API Filter. This is the only way of unequivocally identify an API Filter. A list of available API Filters can be obtained by using the list@ option of the import mechanism of the resource
Id string

apiFilterId String: ID of the API Filter. This is the only way of unequivocally identify an API Filter. A list of available API Filters can be obtained by using the list@ option of the import mechanism of the resource
id String

apiFilterId string: ID of the API Filter. This is the only way of unequivocally identify an API Filter. A list of available API Filters can be obtained by using the list@ option of the import mechanism of the resource
id string

api_filter_id str: ID of the API Filter. This is the only way of unequivocally identify an API Filter. A list of available API Filters can be obtained by using the list@ option of the import mechanism of the resource
id str

apiFilterId String: ID of the API Filter. This is the only way of unequivocally identify an API Filter. A list of available API Filters can be obtained by using the list@ option of the import mechanism of the resource
id String