getAggregateInterface

Strata Cloud Manager v0.4.3, Nov 8 25

Strata Cloud Manager v0.4.3 published on Saturday, Nov 8, 2025 by Pulumi

Schema (JSON)

pulumi/pulumi-scm

Strata Cloud Manager v0.4.3 published on Saturday, Nov 8, 2025 by Pulumi

Schema (JSON)

pulumi/pulumi-scm

Example Usage

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

// Look up aggregate interface by its ID.
const scmAggregateInterfaceDs = scm.getAggregateInterface({
    id: "ddad1e64-0b64-41a4-b361-c6199761a8f1",
});
export const aggregateInterfaceDataSourceResults = {
    id: scmAggregateInterfaceDs.then(scmAggregateInterfaceDs => scmAggregateInterfaceDs.id),
    name: scmAggregateInterfaceDs.then(scmAggregateInterfaceDs => scmAggregateInterfaceDs.name),
    comment: scmAggregateInterfaceDs.then(scmAggregateInterfaceDs => scmAggregateInterfaceDs.comment),
    layer3: scmAggregateInterfaceDs.then(scmAggregateInterfaceDs => scmAggregateInterfaceDs.layer3),
    folder: scmAggregateInterfaceDs.then(scmAggregateInterfaceDs => scmAggregateInterfaceDs.folder),
};

import pulumi
import pulumi_scm as scm

# Look up aggregate interface by its ID.
scm_aggregate_interface_ds = scm.get_aggregate_interface(id="ddad1e64-0b64-41a4-b361-c6199761a8f1")
pulumi.export("aggregateInterfaceDataSourceResults", {
    "id": scm_aggregate_interface_ds.id,
    "name": scm_aggregate_interface_ds.name,
    "comment": scm_aggregate_interface_ds.comment,
    "layer3": scm_aggregate_interface_ds.layer3,
    "folder": scm_aggregate_interface_ds.folder,
})

package main

import (
	"github.com/pulumi/pulumi-scm/sdk/go/scm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Look up aggregate interface by its ID.
		scmAggregateInterfaceDs, err := scm.LookupAggregateInterface(ctx, &scm.LookupAggregateInterfaceArgs{
			Id: "ddad1e64-0b64-41a4-b361-c6199761a8f1",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("aggregateInterfaceDataSourceResults", pulumi.Map{
			"id":      scmAggregateInterfaceDs.Id,
			"name":    scmAggregateInterfaceDs.Name,
			"comment": scmAggregateInterfaceDs.Comment,
			"layer3":  scmAggregateInterfaceDs.Layer3,
			"folder":  scmAggregateInterfaceDs.Folder,
		})
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    // Look up aggregate interface by its ID.
    var scmAggregateInterfaceDs = Scm.GetAggregateInterface.Invoke(new()
    {
        Id = "ddad1e64-0b64-41a4-b361-c6199761a8f1",
    });

    return new Dictionary<string, object?>
    {
        ["aggregateInterfaceDataSourceResults"] = 
        {
            { "id", scmAggregateInterfaceDs.Apply(getAggregateInterfaceResult => getAggregateInterfaceResult.Id) },
            { "name", scmAggregateInterfaceDs.Apply(getAggregateInterfaceResult => getAggregateInterfaceResult.Name) },
            { "comment", scmAggregateInterfaceDs.Apply(getAggregateInterfaceResult => getAggregateInterfaceResult.Comment) },
            { "layer3", scmAggregateInterfaceDs.Apply(getAggregateInterfaceResult => getAggregateInterfaceResult.Layer3) },
            { "folder", scmAggregateInterfaceDs.Apply(getAggregateInterfaceResult => getAggregateInterfaceResult.Folder) },
        },
    };
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scm.ScmFunctions;
import com.pulumi.scm.inputs.GetAggregateInterfaceArgs;
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) {
        // Look up aggregate interface by its ID.
        final var scmAggregateInterfaceDs = ScmFunctions.getAggregateInterface(GetAggregateInterfaceArgs.builder()
            .id("ddad1e64-0b64-41a4-b361-c6199761a8f1")
            .build());

        ctx.export("aggregateInterfaceDataSourceResults", Map.ofEntries(
            Map.entry("id", scmAggregateInterfaceDs.id()),
            Map.entry("name", scmAggregateInterfaceDs.name()),
            Map.entry("comment", scmAggregateInterfaceDs.comment()),
            Map.entry("layer3", scmAggregateInterfaceDs.layer3()),
            Map.entry("folder", scmAggregateInterfaceDs.folder())
        ));
    }
}

variables:
  # Look up aggregate interface by its ID.
  scmAggregateInterfaceDs:
    fn::invoke:
      function: scm:getAggregateInterface
      arguments:
        id: ddad1e64-0b64-41a4-b361-c6199761a8f1
outputs:
  # Output various attributes from the found aggregate interface to verify the lookups were successful.
  aggregateInterfaceDataSourceResults:
    id: ${scmAggregateInterfaceDs.id}
    name: ${scmAggregateInterfaceDs.name}
    comment: ${scmAggregateInterfaceDs.comment}
    layer3: ${scmAggregateInterfaceDs.layer3}
    folder: ${scmAggregateInterfaceDs.folder}

Using getAggregateInterface

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 getAggregateInterface(args: GetAggregateInterfaceArgs, opts?: InvokeOptions): Promise<GetAggregateInterfaceResult>
function getAggregateInterfaceOutput(args: GetAggregateInterfaceOutputArgs, opts?: InvokeOptions): Output<GetAggregateInterfaceResult>

def get_aggregate_interface(id: Optional[str] = None,
                            name: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetAggregateInterfaceResult
def get_aggregate_interface_output(id: Optional[pulumi.Input[str]] = None,
                            name: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetAggregateInterfaceResult]

func LookupAggregateInterface(ctx *Context, args *LookupAggregateInterfaceArgs, opts ...InvokeOption) (*LookupAggregateInterfaceResult, error)
func LookupAggregateInterfaceOutput(ctx *Context, args *LookupAggregateInterfaceOutputArgs, opts ...InvokeOption) LookupAggregateInterfaceResultOutput

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

public static class GetAggregateInterface 
{
    public static Task<GetAggregateInterfaceResult> InvokeAsync(GetAggregateInterfaceArgs args, InvokeOptions? opts = null)
    public static Output<GetAggregateInterfaceResult> Invoke(GetAggregateInterfaceInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetAggregateInterfaceResult> getAggregateInterface(GetAggregateInterfaceArgs args, InvokeOptions options)
public static Output<GetAggregateInterfaceResult> getAggregateInterface(GetAggregateInterfaceArgs args, InvokeOptions options)

fn::invoke:
  function: scm:index/getAggregateInterface:getAggregateInterface
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string: UUID of the resource
Name string: Aggregate interface name

Id string: UUID of the resource
Name string: Aggregate interface name

id String: UUID of the resource
name String: Aggregate interface name

id string: UUID of the resource
name string: Aggregate interface name

id str: UUID of the resource
name str: Aggregate interface name

id String: UUID of the resource
name String: Aggregate interface name