Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Juniper Mist
  3. API Docs
  4. org
  5. Sitegroup
Juniper Mist v0.1.1 published on Monday, Nov 4, 2024 by Pulumi
pulumi/pulumi-junipermist

junipermist.org.Sitegroup

Explore with Pulumi AI

junipermist logo
Juniper Mist v0.1.1 published on Monday, Nov 4, 2024 by Pulumi
pulumi/pulumi-junipermist

    This resource managed the Org Site Groups (sitegroups). A site group is a feature that allows users to group multiple sites together based on regions, functions, or other parameters for efficient management of devices. Sites can exist in multiple groups simultaneously, and site groups can be used to ensure consistent settings, manage administrator access, and apply specific templates to groups of sites.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as junipermist from "@pulumi/juniper-mist";

const sitegroupOne = new junipermist.org.Sitegroup("sitegroup_one", {
    orgId: terraformTest.id,
    name: "sitegroup_one",
});

    import pulumi
import pulumi_juniper_mist as junipermist

sitegroup_one = junipermist.org.Sitegroup("sitegroup_one",
    org_id=terraform_test["id"],
    name="sitegroup_one")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := org.NewSitegroup(ctx, "sitegroup_one", &org.SitegroupArgs{
			OrgId: pulumi.Any(terraformTest.Id),
			Name:  pulumi.String("sitegroup_one"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var sitegroupOne = new JuniperMist.Org.Sitegroup("sitegroup_one", new()
    {
        OrgId = terraformTest.Id,
        Name = "sitegroup_one",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.junipermist.org.Sitegroup;
import com.pulumi.junipermist.org.SitegroupArgs;
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) {
        var sitegroupOne = new Sitegroup("sitegroupOne", SitegroupArgs.builder()
            .orgId(terraformTest.id())
            .name("sitegroup_one")
            .build());

    }
}

    resources:
  sitegroupOne:
    type: junipermist:org:Sitegroup
    name: sitegroup_one
    properties:
      orgId: ${terraformTest.id}
      name: sitegroup_one

    Create Sitegroup Resource

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

    Constructor syntax

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

@overload
def Sitegroup(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              org_id: Optional[str] = None,
              name: Optional[str] = None)
    func NewSitegroup(ctx *Context, name string, args SitegroupArgs, opts ...ResourceOption) (*Sitegroup, error)
    public Sitegroup(string name, SitegroupArgs args, CustomResourceOptions? opts = null)
    public Sitegroup(String name, SitegroupArgs args)
public Sitegroup(String name, SitegroupArgs args, CustomResourceOptions options)

    type: junipermist:org:Sitegroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args SitegroupArgs
    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 SitegroupArgs
    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 SitegroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SitegroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SitegroupArgs
    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 sitegroupResource = new JuniperMist.Org.Sitegroup("sitegroupResource", new()
{
    OrgId = "string",
    Name = "string",
});

    example, err := org.NewSitegroup(ctx, "sitegroupResource", &org.SitegroupArgs{
	OrgId: pulumi.String("string"),
	Name:  pulumi.String("string"),
})

    var sitegroupResource = new Sitegroup("sitegroupResource", SitegroupArgs.builder()
    .orgId("string")
    .name("string")
    .build());

    sitegroup_resource = junipermist.org.Sitegroup("sitegroupResource",
    org_id="string",
    name="string")

    const sitegroupResource = new junipermist.org.Sitegroup("sitegroupResource", {
    orgId: "string",
    name: "string",
});

    type: junipermist:org:Sitegroup
properties:
    name: string
    orgId: string

    Sitegroup 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 Sitegroup resource accepts the following input properties:

    OrgId string
    Name string
    OrgId string
    Name string
    orgId String
    name String
    orgId string
    name string
    org_id str
    name str
    orgId String
    name String

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Sitegroup 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 str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Sitegroup Resource

    Get an existing Sitegroup 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?: SitegroupState, opts?: CustomResourceOptions): Sitegroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        name: Optional[str] = None,
        org_id: Optional[str] = None) -> Sitegroup
    func GetSitegroup(ctx *Context, name string, id IDInput, state *SitegroupState, opts ...ResourceOption) (*Sitegroup, error)
    public static Sitegroup Get(string name, Input<string> id, SitegroupState? state, CustomResourceOptions? opts = null)
    public static Sitegroup get(String name, Output<String> id, SitegroupState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    Name string
    OrgId string
    Name string
    OrgId string
    name String
    orgId String
    name string
    orgId string
    name str
    org_id str
    name String
    orgId String

    Import

    Using pulumi import, import mist_org_sitegroup with:

    Org Site Group can be imported by specifying the org_id and the sitegroup_id

    $ pulumi import junipermist:org/sitegroup:Sitegroup sitegroup_one 17b46405-3a6d-4715-8bb4-6bb6d06f316a.d3c42998-9012-4859-9743-6b9bee475309

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

    Package Details

    Repository
    junipermist pulumi/pulumi-junipermist
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the mist Terraform Provider.
    junipermist logo
    Juniper Mist v0.1.1 published on Monday, Nov 4, 2024 by Pulumi
    pulumi/pulumi-junipermist