1. Packages
  2. Juniper Mist
  3. API Docs
  4. org
  5. getSitegroups
Juniper Mist v0.1.1 published on Monday, Nov 4, 2024 by Pulumi

junipermist.org.getSitegroups

Explore with Pulumi AI

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

    This data source provides the list of 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/junipermist";
    
    const sitegroups = junipermist.org.getSitegroups({
        orgId: "15fca2ac-b1a6-47cc-9953-cc6906281550",
    });
    
    import pulumi
    import pulumi_junipermist as junipermist
    
    sitegroups = junipermist.org.get_sitegroups(org_id="15fca2ac-b1a6-47cc-9953-cc6906281550")
    
    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.GetSitegroups(ctx, &org.GetSitegroupsArgs{
    			OrgId: "15fca2ac-b1a6-47cc-9953-cc6906281550",
    		}, nil)
    		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 sitegroups = JuniperMist.Org.GetSitegroups.Invoke(new()
        {
            OrgId = "15fca2ac-b1a6-47cc-9953-cc6906281550",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.junipermist.org.OrgFunctions;
    import com.pulumi.junipermist.org.inputs.GetSitegroupsArgs;
    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 sitegroups = OrgFunctions.getSitegroups(GetSitegroupsArgs.builder()
                .orgId("15fca2ac-b1a6-47cc-9953-cc6906281550")
                .build());
    
        }
    }
    
    variables:
      sitegroups:
        fn::invoke:
          Function: junipermist:org:getSitegroups
          Arguments:
            orgId: 15fca2ac-b1a6-47cc-9953-cc6906281550
    

    Using getSitegroups

    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 getSitegroups(args: GetSitegroupsArgs, opts?: InvokeOptions): Promise<GetSitegroupsResult>
    function getSitegroupsOutput(args: GetSitegroupsOutputArgs, opts?: InvokeOptions): Output<GetSitegroupsResult>
    def get_sitegroups(org_id: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetSitegroupsResult
    def get_sitegroups_output(org_id: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetSitegroupsResult]
    func GetSitegroups(ctx *Context, args *GetSitegroupsArgs, opts ...InvokeOption) (*GetSitegroupsResult, error)
    func GetSitegroupsOutput(ctx *Context, args *GetSitegroupsOutputArgs, opts ...InvokeOption) GetSitegroupsResultOutput

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

    public static class GetSitegroups 
    {
        public static Task<GetSitegroupsResult> InvokeAsync(GetSitegroupsArgs args, InvokeOptions? opts = null)
        public static Output<GetSitegroupsResult> Invoke(GetSitegroupsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSitegroupsResult> getSitegroups(GetSitegroupsArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: junipermist:org/getSitegroups:getSitegroups
      arguments:
        # arguments dictionary

    The following arguments are supported:

    OrgId string
    OrgId string
    orgId String
    orgId string
    org_id str
    orgId String

    getSitegroups Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    OrgId string
    OrgSitegroups List<Pulumi.JuniperMist.Org.Outputs.GetSitegroupsOrgSitegroup>
    Id string
    The provider-assigned unique ID for this managed resource.
    OrgId string
    OrgSitegroups []GetSitegroupsOrgSitegroup
    id String
    The provider-assigned unique ID for this managed resource.
    orgId String
    orgSitegroups List<GetSitegroupsOrgSitegroup>
    id string
    The provider-assigned unique ID for this managed resource.
    orgId string
    orgSitegroups GetSitegroupsOrgSitegroup[]
    id str
    The provider-assigned unique ID for this managed resource.
    org_id str
    org_sitegroups Sequence[GetSitegroupsOrgSitegroup]
    id String
    The provider-assigned unique ID for this managed resource.
    orgId String
    orgSitegroups List<Property Map>

    Supporting Types

    GetSitegroupsOrgSitegroup

    CreatedTime double
    Id string
    ModifiedTime double
    Name string
    OrgId string
    SiteIds List<string>
    CreatedTime float64
    Id string
    ModifiedTime float64
    Name string
    OrgId string
    SiteIds []string
    createdTime Double
    id String
    modifiedTime Double
    name String
    orgId String
    siteIds List<String>
    createdTime number
    id string
    modifiedTime number
    name string
    orgId string
    siteIds string[]
    created_time float
    id str
    modified_time float
    name str
    org_id str
    site_ids Sequence[str]
    createdTime Number
    id String
    modifiedTime Number
    name String
    orgId String
    siteIds List<String>

    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