1. Registry
  2. Packages
  3. Cisco Catalyst SD-WAN Provider
  4. API Docs
  5. getScope
Viewing docs for Cisco Catalyst SD-WAN v0.9.4
published on Friday, Sep 25, 2026 by Pulumi
sdwan logo
Viewing docs for Cisco Catalyst SD-WAN v0.9.4
published on Friday, Sep 25, 2026 by Pulumi

    This data source can read the Scope .

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as sdwan from "@pulumi/sdwan";
    
    const example = sdwan.getScope({
        id: "f6b2c44c-693c-4763-b010-895aa3d236bd",
    });
    
    import pulumi
    import pulumi_sdwan as sdwan
    
    example = sdwan.get_scope(id="f6b2c44c-693c-4763-b010-895aa3d236bd")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-sdwan/sdk/go/sdwan"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := sdwan.GetScope(ctx, &sdwan.LookupScopeArgs{
    			Id: "f6b2c44c-693c-4763-b010-895aa3d236bd",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Sdwan = Pulumi.Sdwan;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Sdwan.GetScope.Invoke(new()
        {
            Id = "f6b2c44c-693c-4763-b010-895aa3d236bd",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.sdwan.SdwanFunctions;
    import com.pulumi.sdwan.inputs.GetScopeArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    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 example = SdwanFunctions.getScope(GetScopeArgs.builder()
                .id("f6b2c44c-693c-4763-b010-895aa3d236bd")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: sdwan:getScope
          arguments:
            id: f6b2c44c-693c-4763-b010-895aa3d236bd
    
    pulumi {
      required_providers {
        sdwan = {
          source = "pulumi/sdwan"
        }
      }
    }
    
    data "sdwan_getscope" "example" {
      id = "f6b2c44c-693c-4763-b010-895aa3d236bd"
    }
    

    Using getScope

    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 getScope(args: GetScopeArgs, opts?: InvokeOptions): Promise<GetScopeResult>
    function getScopeOutput(args: GetScopeOutputArgs, opts?: InvokeOutputOptions): Output<GetScopeResult>
    def get_scope(id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetScopeResult
    def get_scope_output(id: pulumi.Input[Optional[str]] = None,
                  opts: Optional[InvokeOutputOptions] = None) -> Output[GetScopeResult]
    func LookupScope(ctx *Context, args *LookupScopeArgs, opts ...InvokeOption) (*LookupScopeResult, error)
    func LookupScopeOutput(ctx *Context, args *LookupScopeOutputArgs, opts ...InvokeOption) LookupScopeResultOutput

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

    public static class GetScope 
    {
        public static Task<GetScopeResult> InvokeAsync(GetScopeArgs args, InvokeOptions? opts = null)
        public static Output<GetScopeResult> Invoke(GetScopeInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetScopeResult> Invoke(GetScopeInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetScopeResult> getScope(GetScopeArgs args, InvokeOptions options)
    public static Output<GetScopeResult> getScope(GetScopeArgs args, InvokeOptions options)
    public static Output<GetScopeResult> getScope(GetScopeArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: sdwan:index/getScope:getScope
      arguments:
        # arguments dictionary
    data "sdwan_get_scope" "name" {
        # arguments
    }

    The following arguments are supported:

    Id string
    The id of the object
    Id string
    The id of the object
    id string
    The id of the object
    id String
    The id of the object
    id string
    The id of the object
    id str
    The id of the object
    id String
    The id of the object

    getScope Result

    The following output properties are available:

    Description string
    Description
    Id string
    The id of the object
    Name string
    The name of the scope
    Objects List<GetScopeObject>
    List of objects belonging to the scope
    Users List<string>
    List of users who reference the scope
    Description string
    Description
    Id string
    The id of the object
    Name string
    The name of the scope
    Objects []GetScopeObject
    List of objects belonging to the scope
    Users []string
    List of users who reference the scope
    description string
    Description
    id string
    The id of the object
    name string
    The name of the scope
    objects list(object)
    List of objects belonging to the scope
    users list(string)
    List of users who reference the scope
    description String
    Description
    id String
    The id of the object
    name String
    The name of the scope
    objects List<GetScopeObject>
    List of objects belonging to the scope
    users List<String>
    List of users who reference the scope
    description string
    Description
    id string
    The id of the object
    name string
    The name of the scope
    objects GetScopeObject[]
    List of objects belonging to the scope
    users string[]
    List of users who reference the scope
    description str
    Description
    id str
    The id of the object
    name str
    The name of the scope
    objects Sequence[GetScopeObject]
    List of objects belonging to the scope
    users Sequence[str]
    List of users who reference the scope
    description String
    Description
    id String
    The id of the object
    name String
    The name of the scope
    objects List<Property Map>
    List of objects belonging to the scope
    users List<String>
    List of users who reference the scope

    Supporting Types

    GetScopeObject

    ObjectIds List<string>
    List of object UUIDs
    ObjectType string
    Object type
    ObjectIds []string
    List of object UUIDs
    ObjectType string
    Object type
    object_ids list(string)
    List of object UUIDs
    object_type string
    Object type
    objectIds List<String>
    List of object UUIDs
    objectType String
    Object type
    objectIds string[]
    List of object UUIDs
    objectType string
    Object type
    object_ids Sequence[str]
    List of object UUIDs
    object_type str
    Object type
    objectIds List<String>
    List of object UUIDs
    objectType String
    Object type

    Package Details

    Repository
    sdwan pulumi/pulumi-sdwan
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the sdwan Terraform Provider.
    sdwan logo
    Viewing docs for Cisco Catalyst SD-WAN v0.9.4
    published on Friday, Sep 25, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial