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

junipermist.org.Base

Explore with Pulumi AI

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

    This resource manages the Mist Organization. An organization usually represents a customer - which has inventories, licenses. An Organization can contain multiple sites. A site usually represents a deployment at the same location (a campus, an office).

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as junipermist from "@pulumi/juniper-mist";
    
    const orgOne = new junipermist.org.Base("org_one", {
        name: "Org One",
        alarmtemplateId: alarmtemplateOne.id,
    });
    
    import pulumi
    import pulumi_juniper_mist as junipermist
    
    org_one = junipermist.org.Base("org_one",
        name="Org One",
        alarmtemplate_id=alarmtemplate_one["id"])
    
    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.Newbase(ctx, "org_one", &org.baseArgs{
    			Name:            pulumi.String("Org One"),
    			AlarmtemplateId: pulumi.Any(alarmtemplateOne.Id),
    		})
    		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 orgOne = new JuniperMist.Org.Base("org_one", new()
        {
            Name = "Org One",
            AlarmtemplateId = alarmtemplateOne.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.junipermist.org.base;
    import com.pulumi.junipermist.org.BaseArgs;
    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 orgOne = new Base("orgOne", BaseArgs.builder()
                .name("Org One")
                .alarmtemplateId(alarmtemplateOne.id())
                .build());
    
        }
    }
    
    resources:
      orgOne:
        type: junipermist:org:base
        name: org_one
        properties:
          name: Org One
          alarmtemplateId: ${alarmtemplateOne.id}
    

    Create Base Resource

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

    Constructor syntax

    new Base(name: string, args?: BaseArgs, opts?: CustomResourceOptions);
    @overload
    def Base(resource_name: str,
             args: Optional[BaseArgs] = None,
             opts: Optional[ResourceOptions] = None)
    
    @overload
    def Base(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             alarmtemplate_id: Optional[str] = None,
             allow_mist: Optional[bool] = None,
             name: Optional[str] = None,
             session_expiry: Optional[int] = None)
    func NewBase(ctx *Context, name string, args *BaseArgs, opts ...ResourceOption) (*Base, error)
    public Base(string name, BaseArgs? args = null, CustomResourceOptions? opts = null)
    public Base(String name, BaseArgs args)
    public Base(String name, BaseArgs args, CustomResourceOptions options)
    
    type: junipermist:org/base:base
    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 BaseArgs
    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 BaseArgs
    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 BaseArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BaseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BaseArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    alarmtemplateId String
    allowMist Boolean
    name String
    sessionExpiry Integer
    alarmtemplateId string
    allowMist boolean
    name string
    sessionExpiry number
    alarmtemplateId String
    allowMist Boolean
    name String
    sessionExpiry Number

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    MspId string
    MspLogoUrl string
    logo uploaded by the MSP with advanced tier, only present if provided
    MspName string
    name of the msp the org belongs to
    OrggroupIds List<string>
    Id string
    The provider-assigned unique ID for this managed resource.
    MspId string
    MspLogoUrl string
    logo uploaded by the MSP with advanced tier, only present if provided
    MspName string
    name of the msp the org belongs to
    OrggroupIds []string
    id String
    The provider-assigned unique ID for this managed resource.
    mspId String
    mspLogoUrl String
    logo uploaded by the MSP with advanced tier, only present if provided
    mspName String
    name of the msp the org belongs to
    orggroupIds List<String>
    id string
    The provider-assigned unique ID for this managed resource.
    mspId string
    mspLogoUrl string
    logo uploaded by the MSP with advanced tier, only present if provided
    mspName string
    name of the msp the org belongs to
    orggroupIds string[]
    id str
    The provider-assigned unique ID for this managed resource.
    msp_id str
    msp_logo_url str
    logo uploaded by the MSP with advanced tier, only present if provided
    msp_name str
    name of the msp the org belongs to
    orggroup_ids Sequence[str]
    id String
    The provider-assigned unique ID for this managed resource.
    mspId String
    mspLogoUrl String
    logo uploaded by the MSP with advanced tier, only present if provided
    mspName String
    name of the msp the org belongs to
    orggroupIds List<String>

    Look up Existing Base Resource

    Get an existing Base 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?: BaseState, opts?: CustomResourceOptions): Base
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            alarmtemplate_id: Optional[str] = None,
            allow_mist: Optional[bool] = None,
            msp_id: Optional[str] = None,
            msp_logo_url: Optional[str] = None,
            msp_name: Optional[str] = None,
            name: Optional[str] = None,
            orggroup_ids: Optional[Sequence[str]] = None,
            session_expiry: Optional[int] = None) -> Base
    func GetBase(ctx *Context, name string, id IDInput, state *BaseState, opts ...ResourceOption) (*Base, error)
    public static Base Get(string name, Input<string> id, BaseState? state, CustomResourceOptions? opts = null)
    public static Base get(String name, Output<String> id, BaseState 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:
    AlarmtemplateId string
    AllowMist bool
    MspId string
    MspLogoUrl string
    logo uploaded by the MSP with advanced tier, only present if provided
    MspName string
    name of the msp the org belongs to
    Name string
    OrggroupIds List<string>
    SessionExpiry int
    AlarmtemplateId string
    AllowMist bool
    MspId string
    MspLogoUrl string
    logo uploaded by the MSP with advanced tier, only present if provided
    MspName string
    name of the msp the org belongs to
    Name string
    OrggroupIds []string
    SessionExpiry int
    alarmtemplateId String
    allowMist Boolean
    mspId String
    mspLogoUrl String
    logo uploaded by the MSP with advanced tier, only present if provided
    mspName String
    name of the msp the org belongs to
    name String
    orggroupIds List<String>
    sessionExpiry Integer
    alarmtemplateId string
    allowMist boolean
    mspId string
    mspLogoUrl string
    logo uploaded by the MSP with advanced tier, only present if provided
    mspName string
    name of the msp the org belongs to
    name string
    orggroupIds string[]
    sessionExpiry number
    alarmtemplate_id str
    allow_mist bool
    msp_id str
    msp_logo_url str
    logo uploaded by the MSP with advanced tier, only present if provided
    msp_name str
    name of the msp the org belongs to
    name str
    orggroup_ids Sequence[str]
    session_expiry int
    alarmtemplateId String
    allowMist Boolean
    mspId String
    mspLogoUrl String
    logo uploaded by the MSP with advanced tier, only present if provided
    mspName String
    name of the msp the org belongs to
    name String
    orggroupIds List<String>
    sessionExpiry Number

    Import

    Using pulumi import, import mist_org with:

    Organization can be imported by specifying the org_id

    $ pulumi import junipermist:org/base:base org_one 17b46405-3a6d-4715-8bb4-6bb6d06f316a
    

    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