1. Packages
  2. Cisco Meraki
  3. API Docs
  4. networks
  5. Base
Cisco Meraki v0.2.0 published on Friday, May 24, 2024 by Pulumi

meraki.networks.Base

Explore with Pulumi AI

meraki logo
Cisco Meraki v0.2.0 published on Friday, May 24, 2024 by Pulumi

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as meraki from "@pulumi/meraki";
    
    const example = new meraki.networks.Base("example", {
        name: "Main Office",
        notes: "Additional description of the network",
        organizationId: "string",
        productTypes: [
            "appliance",
            "switch",
            "wireless",
        ],
        tags: [
            "tag1",
            "tag2",
        ],
        timeZone: "America/Los_Angeles",
    });
    export const merakiNetworksExample = example;
    
    import pulumi
    import pulumi_meraki as meraki
    
    example = meraki.networks.Base("example",
        name="Main Office",
        notes="Additional description of the network",
        organization_id="string",
        product_types=[
            "appliance",
            "switch",
            "wireless",
        ],
        tags=[
            "tag1",
            "tag2",
        ],
        time_zone="America/Los_Angeles")
    pulumi.export("merakiNetworksExample", example)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-meraki/sdk/go/meraki/networks"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := networks.Newbase(ctx, "example", &networks.baseArgs{
    			Name:           pulumi.String("Main Office"),
    			Notes:          pulumi.String("Additional description of the network"),
    			OrganizationId: pulumi.String("string"),
    			ProductTypes: pulumi.StringArray{
    				pulumi.String("appliance"),
    				pulumi.String("switch"),
    				pulumi.String("wireless"),
    			},
    			Tags: pulumi.StringArray{
    				pulumi.String("tag1"),
    				pulumi.String("tag2"),
    			},
    			TimeZone: pulumi.String("America/Los_Angeles"),
    		})
    		if err != nil {
    			return err
    		}
    		ctx.Export("merakiNetworksExample", example)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Meraki = Pulumi.Meraki;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Meraki.Networks.Base("example", new()
        {
            Name = "Main Office",
            Notes = "Additional description of the network",
            OrganizationId = "string",
            ProductTypes = new[]
            {
                "appliance",
                "switch",
                "wireless",
            },
            Tags = new[]
            {
                "tag1",
                "tag2",
            },
            TimeZone = "America/Los_Angeles",
        });
    
        return new Dictionary<string, object?>
        {
            ["merakiNetworksExample"] = example,
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.meraki.networks.base;
    import com.pulumi.meraki.networks.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 example = new Base("example", BaseArgs.builder()
                .name("Main Office")
                .notes("Additional description of the network")
                .organizationId("string")
                .productTypes(            
                    "appliance",
                    "switch",
                    "wireless")
                .tags(            
                    "tag1",
                    "tag2")
                .timeZone("America/Los_Angeles")
                .build());
    
            ctx.export("merakiNetworksExample", example);
        }
    }
    
    resources:
      example:
        type: meraki:networks:base
        properties:
          name: Main Office
          notes: Additional description of the network
          organizationId: string
          productTypes:
            - appliance
            - switch
            - wireless
          tags:
            - tag1
            - tag2
          timeZone: America/Los_Angeles
    outputs:
      merakiNetworksExample: ${example}
    

    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: BaseArgs,
             opts: Optional[ResourceOptions] = None)
    
    @overload
    def Base(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             organization_id: Optional[str] = None,
             enrollment_string: Optional[str] = None,
             name: Optional[str] = None,
             network_id: Optional[str] = None,
             notes: Optional[str] = None,
             product_types: Optional[Sequence[str]] = None,
             tags: Optional[Sequence[str]] = None,
             time_zone: Optional[str] = None)
    func NewBase(ctx *Context, name string, args BaseArgs, opts ...ResourceOption) (*Base, error)
    public Base(string name, BaseArgs args, CustomResourceOptions? opts = null)
    public Base(String name, BaseArgs args)
    public Base(String name, BaseArgs args, CustomResourceOptions options)
    
    type: meraki:networks/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.

    Example

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

    var merakibaseResource = new Meraki.Networks.Base("merakibaseResource", new()
    {
        OrganizationId = "string",
        EnrollmentString = "string",
        Name = "string",
        NetworkId = "string",
        Notes = "string",
        ProductTypes = new[]
        {
            "string",
        },
        Tags = new[]
        {
            "string",
        },
        TimeZone = "string",
    });
    
    example, err := networks.Newbase(ctx, "merakibaseResource", &networks.baseArgs{
    	OrganizationId:   pulumi.String("string"),
    	EnrollmentString: pulumi.String("string"),
    	Name:             pulumi.String("string"),
    	NetworkId:        pulumi.String("string"),
    	Notes:            pulumi.String("string"),
    	ProductTypes: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Tags: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	TimeZone: pulumi.String("string"),
    })
    
    var merakibaseResource = new Base("merakibaseResource", BaseArgs.builder()        
        .organizationId("string")
        .enrollmentString("string")
        .name("string")
        .networkId("string")
        .notes("string")
        .productTypes("string")
        .tags("string")
        .timeZone("string")
        .build());
    
    merakibase_resource = meraki.networks.Base("merakibaseResource",
        organization_id="string",
        enrollment_string="string",
        name="string",
        network_id="string",
        notes="string",
        product_types=["string"],
        tags=["string"],
        time_zone="string")
    
    const merakibaseResource = new meraki.networks.Base("merakibaseResource", {
        organizationId: "string",
        enrollmentString: "string",
        name: "string",
        networkId: "string",
        notes: "string",
        productTypes: ["string"],
        tags: ["string"],
        timeZone: "string",
    });
    
    Coming soon!
    

    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

    The Base resource accepts the following input properties:

    OrganizationId string
    Organization ID
    EnrollmentString string
    Enrollment string for the network
    Name string
    Network name
    NetworkId string
    networkId path parameter. Network ID
    Notes string
    Notes for the network
    ProductTypes List<string>
    List of the product types that the network supports
    Tags List<string>
    Network tags
    TimeZone string
    Timezone of the network
    OrganizationId string
    Organization ID
    EnrollmentString string
    Enrollment string for the network
    Name string
    Network name
    NetworkId string
    networkId path parameter. Network ID
    Notes string
    Notes for the network
    ProductTypes []string
    List of the product types that the network supports
    Tags []string
    Network tags
    TimeZone string
    Timezone of the network
    organizationId String
    Organization ID
    enrollmentString String
    Enrollment string for the network
    name String
    Network name
    networkId String
    networkId path parameter. Network ID
    notes String
    Notes for the network
    productTypes List<String>
    List of the product types that the network supports
    tags List<String>
    Network tags
    timeZone String
    Timezone of the network
    organizationId string
    Organization ID
    enrollmentString string
    Enrollment string for the network
    name string
    Network name
    networkId string
    networkId path parameter. Network ID
    notes string
    Notes for the network
    productTypes string[]
    List of the product types that the network supports
    tags string[]
    Network tags
    timeZone string
    Timezone of the network
    organization_id str
    Organization ID
    enrollment_string str
    Enrollment string for the network
    name str
    Network name
    network_id str
    networkId path parameter. Network ID
    notes str
    Notes for the network
    product_types Sequence[str]
    List of the product types that the network supports
    tags Sequence[str]
    Network tags
    time_zone str
    Timezone of the network
    organizationId String
    Organization ID
    enrollmentString String
    Enrollment string for the network
    name String
    Network name
    networkId String
    networkId path parameter. Network ID
    notes String
    Notes for the network
    productTypes List<String>
    List of the product types that the network supports
    tags List<String>
    Network tags
    timeZone String
    Timezone of the network

    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.
    IsBoundToConfigTemplate bool
    If the network is bound to a config template
    Url string
    URL to the network Dashboard UI
    Id string
    The provider-assigned unique ID for this managed resource.
    IsBoundToConfigTemplate bool
    If the network is bound to a config template
    Url string
    URL to the network Dashboard UI
    id String
    The provider-assigned unique ID for this managed resource.
    isBoundToConfigTemplate Boolean
    If the network is bound to a config template
    url String
    URL to the network Dashboard UI
    id string
    The provider-assigned unique ID for this managed resource.
    isBoundToConfigTemplate boolean
    If the network is bound to a config template
    url string
    URL to the network Dashboard UI
    id str
    The provider-assigned unique ID for this managed resource.
    is_bound_to_config_template bool
    If the network is bound to a config template
    url str
    URL to the network Dashboard UI
    id String
    The provider-assigned unique ID for this managed resource.
    isBoundToConfigTemplate Boolean
    If the network is bound to a config template
    url String
    URL to the network Dashboard UI

    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,
            enrollment_string: Optional[str] = None,
            is_bound_to_config_template: Optional[bool] = None,
            name: Optional[str] = None,
            network_id: Optional[str] = None,
            notes: Optional[str] = None,
            organization_id: Optional[str] = None,
            product_types: Optional[Sequence[str]] = None,
            tags: Optional[Sequence[str]] = None,
            time_zone: Optional[str] = None,
            url: Optional[str] = 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:
    EnrollmentString string
    Enrollment string for the network
    IsBoundToConfigTemplate bool
    If the network is bound to a config template
    Name string
    Network name
    NetworkId string
    networkId path parameter. Network ID
    Notes string
    Notes for the network
    OrganizationId string
    Organization ID
    ProductTypes List<string>
    List of the product types that the network supports
    Tags List<string>
    Network tags
    TimeZone string
    Timezone of the network
    Url string
    URL to the network Dashboard UI
    EnrollmentString string
    Enrollment string for the network
    IsBoundToConfigTemplate bool
    If the network is bound to a config template
    Name string
    Network name
    NetworkId string
    networkId path parameter. Network ID
    Notes string
    Notes for the network
    OrganizationId string
    Organization ID
    ProductTypes []string
    List of the product types that the network supports
    Tags []string
    Network tags
    TimeZone string
    Timezone of the network
    Url string
    URL to the network Dashboard UI
    enrollmentString String
    Enrollment string for the network
    isBoundToConfigTemplate Boolean
    If the network is bound to a config template
    name String
    Network name
    networkId String
    networkId path parameter. Network ID
    notes String
    Notes for the network
    organizationId String
    Organization ID
    productTypes List<String>
    List of the product types that the network supports
    tags List<String>
    Network tags
    timeZone String
    Timezone of the network
    url String
    URL to the network Dashboard UI
    enrollmentString string
    Enrollment string for the network
    isBoundToConfigTemplate boolean
    If the network is bound to a config template
    name string
    Network name
    networkId string
    networkId path parameter. Network ID
    notes string
    Notes for the network
    organizationId string
    Organization ID
    productTypes string[]
    List of the product types that the network supports
    tags string[]
    Network tags
    timeZone string
    Timezone of the network
    url string
    URL to the network Dashboard UI
    enrollment_string str
    Enrollment string for the network
    is_bound_to_config_template bool
    If the network is bound to a config template
    name str
    Network name
    network_id str
    networkId path parameter. Network ID
    notes str
    Notes for the network
    organization_id str
    Organization ID
    product_types Sequence[str]
    List of the product types that the network supports
    tags Sequence[str]
    Network tags
    time_zone str
    Timezone of the network
    url str
    URL to the network Dashboard UI
    enrollmentString String
    Enrollment string for the network
    isBoundToConfigTemplate Boolean
    If the network is bound to a config template
    name String
    Network name
    networkId String
    networkId path parameter. Network ID
    notes String
    Notes for the network
    organizationId String
    Organization ID
    productTypes List<String>
    List of the product types that the network supports
    tags List<String>
    Network tags
    timeZone String
    Timezone of the network
    url String
    URL to the network Dashboard UI

    Import

    $ pulumi import meraki:networks/base:base example "network_id,organization_id"
    

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

    Package Details

    Repository
    meraki pulumi/pulumi-meraki
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the meraki Terraform Provider.
    meraki logo
    Cisco Meraki v0.2.0 published on Friday, May 24, 2024 by Pulumi