Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Cisco Catalyst SD-WAN Provider
  4. API Docs
  5. Scope
Viewing docs for Cisco Catalyst SD-WAN v0.9.4
published on Friday, Sep 25, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-sdwan

sdwan.Scope

sdwan logo
Viewing docs for Cisco Catalyst SD-WAN v0.9.4
published on Friday, Sep 25, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-sdwan

    This resource can manage a Scope .

    • Minimum SD-WAN Manager version: 20.15.0

    Example Usage

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

const example = new sdwan.Scope("example", {
    name: "west1",
    description: "West Coast Domain1",
    objects: [{
        objectType: "feature-profile",
        objectIds: ["003c4e0b-a2da-486d-8ee7-0e6dd4551bae"],
    }],
});

    import pulumi
import pulumi_sdwan as sdwan

example = sdwan.Scope("example",
    name="west1",
    description="West Coast Domain1",
    objects=[{
        "object_type": "feature-profile",
        "object_ids": ["003c4e0b-a2da-486d-8ee7-0e6dd4551bae"],
    }])

    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.NewScope(ctx, "example", &sdwan.ScopeArgs{
			Name:        pulumi.String("west1"),
			Description: pulumi.String("West Coast Domain1"),
			Objects: sdwan.ScopeObjectArray{
				&sdwan.ScopeObjectArgs{
					ObjectType: pulumi.String("feature-profile"),
					ObjectIds: pulumi.StringArray{
						pulumi.String("003c4e0b-a2da-486d-8ee7-0e6dd4551bae"),
					},
				},
			},
		})
		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 = new Sdwan.Scope("example", new()
    {
        Name = "west1",
        Description = "West Coast Domain1",
        Objects = new[]
        {
            new Sdwan.Inputs.ScopeObjectArgs
            {
                ObjectType = "feature-profile",
                ObjectIds = new[]
                {
                    "003c4e0b-a2da-486d-8ee7-0e6dd4551bae",
                },
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.sdwan.Scope;
import com.pulumi.sdwan.ScopeArgs;
import com.pulumi.sdwan.inputs.ScopeObjectArgs;
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) {
        var example = new Scope("example", ScopeArgs.builder()
            .name("west1")
            .description("West Coast Domain1")
            .objects(ScopeObjectArgs.builder()
                .objectType("feature-profile")
                .objectIds("003c4e0b-a2da-486d-8ee7-0e6dd4551bae")
                .build())
            .build());

    }
}

    resources:
  example:
    type: sdwan:Scope
    properties:
      name: west1
      description: West Coast Domain1
      objects:
        - objectType: feature-profile
          objectIds:
            - 003c4e0b-a2da-486d-8ee7-0e6dd4551bae

    pulumi {
  required_providers {
    sdwan = {
      source = "pulumi/sdwan"
    }
  }
}

resource "sdwan_scope" "example" {
  name        = "west1"
  description = "West Coast Domain1"
  objects {
    object_type = "feature-profile"
    object_ids  = ["003c4e0b-a2da-486d-8ee7-0e6dd4551bae"]
  }
}

    Create Scope Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Scope(name: string, args?: ScopeArgs, opts?: CustomResourceOptions);
    @overload
def Scope(resource_name: str,
          args: Optional[ScopeArgs] = None,
          opts: Optional[ResourceOptions] = None)

@overload
def Scope(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          description: Optional[str] = None,
          name: Optional[str] = None,
          objects: Optional[Sequence[ScopeObjectArgs]] = None,
          users: Optional[Sequence[str]] = None)
    func NewScope(ctx *Context, name string, args *ScopeArgs, opts ...ResourceOption) (*Scope, error)
    public Scope(string name, ScopeArgs? args = null, CustomResourceOptions? opts = null)
    public Scope(String name, ScopeArgs args)
public Scope(String name, ScopeArgs args, CustomResourceOptions options)

    type: sdwan:Scope
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "sdwan_scope" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args ScopeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ScopeArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ScopeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ScopeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ScopeArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var scopeResource = new Sdwan.Scope("scopeResource", new()
{
    Description = "string",
    Name = "string",
    Objects = new[]
    {
        new Sdwan.Inputs.ScopeObjectArgs
        {
            ObjectIds = new[]
            {
                "string",
            },
            ObjectType = "string",
        },
    },
    Users = new[]
    {
        "string",
    },
});

    example, err := sdwan.NewScope(ctx, "scopeResource", &sdwan.ScopeArgs{
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	Objects: sdwan.ScopeObjectArray{
		&sdwan.ScopeObjectArgs{
			ObjectIds: pulumi.StringArray{
				pulumi.String("string"),
			},
			ObjectType: pulumi.String("string"),
		},
	},
	Users: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    resource "sdwan_scope" "scopeResource" {
  lifecycle {
    create_before_destroy = true
  }
  description = "string"
  name        = "string"
  objects {
    object_ids  = ["string"]
    object_type = "string"
  }
  users = ["string"]
}

    var scopeResource = new Scope("scopeResource", ScopeArgs.builder()
    .description("string")
    .name("string")
    .objects(ScopeObjectArgs.builder()
        .objectIds("string")
        .objectType("string")
        .build())
    .users("string")
    .build());

    scope_resource = sdwan.Scope("scopeResource",
    description="string",
    name="string",
    objects=[{
        "object_ids": ["string"],
        "object_type": "string",
    }],
    users=["string"])

    const scopeResource = new sdwan.Scope("scopeResource", {
    description: "string",
    name: "string",
    objects: [{
        objectIds: ["string"],
        objectType: "string",
    }],
    users: ["string"],
});

    type: sdwan:Scope
properties:
    description: string
    name: string
    objects:
        - objectIds:
            - string
          objectType: string
    users:
        - string

    Scope Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Scope resource accepts the following input properties:

    Description string
    Description
    Name string
    The name of the scope
    Objects List<ScopeObject>
    List of objects belonging to the scope
    Users List<string>
    List of users who reference the scope
    Description string
    Description
    Name string
    The name of the scope
    Objects []ScopeObjectArgs
    List of objects belonging to the scope
    Users []string
    List of users who reference the scope
    description string
    Description
    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
    name String
    The name of the scope
    objects List<ScopeObject>
    List of objects belonging to the scope
    users List<String>
    List of users who reference the scope
    description string
    Description
    name string
    The name of the scope
    objects ScopeObject[]
    List of objects belonging to the scope
    users string[]
    List of users who reference the scope
    description str
    Description
    name str
    The name of the scope
    objects Sequence[ScopeObjectArgs]
    List of objects belonging to the scope
    users Sequence[str]
    List of users who reference the scope
    description String
    Description
    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

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Scope resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Scope Resource

    Get an existing Scope resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ScopeState, opts?: CustomResourceOptions): Scope
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        objects: Optional[Sequence[ScopeObjectArgs]] = None,
        users: Optional[Sequence[str]] = None) -> Scope
    func GetScope(ctx *Context, name string, id IDInput, state *ScopeState, opts ...ResourceOption) (*Scope, error)
    public static Scope Get(string name, Input<string> id, ScopeState? state, CustomResourceOptions? opts = null)
    public static Scope get(String name, Output<String> id, ScopeState state, CustomResourceOptions options)
    resources:  _:    type: sdwan:Scope    get:      id: ${id}
    import {
  to = sdwan_scope.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Description string
    Description
    Name string
    The name of the scope
    Objects List<ScopeObject>
    List of objects belonging to the scope
    Users List<string>
    List of users who reference the scope
    Description string
    Description
    Name string
    The name of the scope
    Objects []ScopeObjectArgs
    List of objects belonging to the scope
    Users []string
    List of users who reference the scope
    description string
    Description
    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
    name String
    The name of the scope
    objects List<ScopeObject>
    List of objects belonging to the scope
    users List<String>
    List of users who reference the scope
    description string
    Description
    name string
    The name of the scope
    objects ScopeObject[]
    List of objects belonging to the scope
    users string[]
    List of users who reference the scope
    description str
    Description
    name str
    The name of the scope
    objects Sequence[ScopeObjectArgs]
    List of objects belonging to the scope
    users Sequence[str]
    List of users who reference the scope
    description String
    Description
    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

    ScopeObject, ScopeObjectArgs

    ObjectIds List<string>
    List of object UUIDs
    ObjectType string
    Object type

    • Choices: network-hierarchy-node, config-group, feature-profile, device-template, feature-template, localized-policy, security-policy
    ObjectIds []string
    List of object UUIDs
    ObjectType string
    Object type

    • Choices: network-hierarchy-node, config-group, feature-profile, device-template, feature-template, localized-policy, security-policy
    object_ids list(string)
    List of object UUIDs
    object_type string
    Object type

    • Choices: network-hierarchy-node, config-group, feature-profile, device-template, feature-template, localized-policy, security-policy
    objectIds List<String>
    List of object UUIDs
    objectType String
    Object type

    • Choices: network-hierarchy-node, config-group, feature-profile, device-template, feature-template, localized-policy, security-policy
    objectIds string[]
    List of object UUIDs
    objectType string
    Object type

    • Choices: network-hierarchy-node, config-group, feature-profile, device-template, feature-template, localized-policy, security-policy
    object_ids Sequence[str]
    List of object UUIDs
    object_type str
    Object type

    • Choices: network-hierarchy-node, config-group, feature-profile, device-template, feature-template, localized-policy, security-policy
    objectIds List<String>
    List of object UUIDs
    objectType String
    Object type

    • Choices: network-hierarchy-node, config-group, feature-profile, device-template, feature-template, localized-policy, security-policy

    Import

    The pulumi import command can be used, for example:

    $ pulumi import sdwan:index/scope:Scope example "f6b2c44c-693c-4763-b010-895aa3d236bd"

    To learn more about importing existing cloud resources, see Importing resources.

    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
    Schema (JSON)
    pulumi/pulumi-sdwan

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial