Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Meraki Provider
  3. API Docs
  4. networks
  5. FloorPlans
Cisco Meraki v0.3.2 published on Tuesday, Sep 24, 2024 by Pulumi
pulumi/pulumi-meraki

meraki.networks.FloorPlans

Explore with Pulumi AI

meraki logo
Cisco Meraki v0.3.2 published on Tuesday, Sep 24, 2024 by Pulumi
pulumi/pulumi-meraki

    Example Usage

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

const example = new meraki.networks.FloorPlans("example", {
    bottomLeftCorner: {
        lat: 37.770040510499996,
        lng: -122.38714009525,
    },
    bottomRightCorner: {
        lat: 37.770040510499996,
        lng: -122.38714009525,
    },
    center: {
        lat: 37.770040510499996,
        lng: -122.38714009525,
    },
    imageContents: "2a9edd3f4ffd80130c647d13eacb59f3",
    name: "HQ Floor Plan",
    networkId: "string",
    topLeftCorner: {
        lat: 37.770040510499996,
        lng: -122.38714009525,
    },
    topRightCorner: {
        lat: 37.770040510499996,
        lng: -122.38714009525,
    },
});
export const merakiNetworksFloorPlansExample = example;

    import pulumi
import pulumi_meraki as meraki

example = meraki.networks.FloorPlans("example",
    bottom_left_corner={
        "lat": 37.770040510499996,
        "lng": -122.38714009525,
    },
    bottom_right_corner={
        "lat": 37.770040510499996,
        "lng": -122.38714009525,
    },
    center={
        "lat": 37.770040510499996,
        "lng": -122.38714009525,
    },
    image_contents="2a9edd3f4ffd80130c647d13eacb59f3",
    name="HQ Floor Plan",
    network_id="string",
    top_left_corner={
        "lat": 37.770040510499996,
        "lng": -122.38714009525,
    },
    top_right_corner={
        "lat": 37.770040510499996,
        "lng": -122.38714009525,
    })
pulumi.export("merakiNetworksFloorPlansExample", 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.NewFloorPlans(ctx, "example", &networks.FloorPlansArgs{
			BottomLeftCorner: &networks.FloorPlansBottomLeftCornerArgs{
				Lat: pulumi.Float64(37.770040510499996),
				Lng: -122.38714009525,
			},
			BottomRightCorner: &networks.FloorPlansBottomRightCornerArgs{
				Lat: pulumi.Float64(37.770040510499996),
				Lng: -122.38714009525,
			},
			Center: &networks.FloorPlansCenterArgs{
				Lat: pulumi.Float64(37.770040510499996),
				Lng: -122.38714009525,
			},
			ImageContents: pulumi.String("2a9edd3f4ffd80130c647d13eacb59f3"),
			Name:          pulumi.String("HQ Floor Plan"),
			NetworkId:     pulumi.String("string"),
			TopLeftCorner: &networks.FloorPlansTopLeftCornerArgs{
				Lat: pulumi.Float64(37.770040510499996),
				Lng: -122.38714009525,
			},
			TopRightCorner: &networks.FloorPlansTopRightCornerArgs{
				Lat: pulumi.Float64(37.770040510499996),
				Lng: -122.38714009525,
			},
		})
		if err != nil {
			return err
		}
		ctx.Export("merakiNetworksFloorPlansExample", 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.FloorPlans("example", new()
    {
        BottomLeftCorner = new Meraki.Networks.Inputs.FloorPlansBottomLeftCornerArgs
        {
            Lat = 37.770040510499996,
            Lng = -122.38714009525,
        },
        BottomRightCorner = new Meraki.Networks.Inputs.FloorPlansBottomRightCornerArgs
        {
            Lat = 37.770040510499996,
            Lng = -122.38714009525,
        },
        Center = new Meraki.Networks.Inputs.FloorPlansCenterArgs
        {
            Lat = 37.770040510499996,
            Lng = -122.38714009525,
        },
        ImageContents = "2a9edd3f4ffd80130c647d13eacb59f3",
        Name = "HQ Floor Plan",
        NetworkId = "string",
        TopLeftCorner = new Meraki.Networks.Inputs.FloorPlansTopLeftCornerArgs
        {
            Lat = 37.770040510499996,
            Lng = -122.38714009525,
        },
        TopRightCorner = new Meraki.Networks.Inputs.FloorPlansTopRightCornerArgs
        {
            Lat = 37.770040510499996,
            Lng = -122.38714009525,
        },
    });

    return new Dictionary<string, object?>
    {
        ["merakiNetworksFloorPlansExample"] = example,
    };
});

    Coming soon!

    resources:
  example:
    type: meraki:networks:FloorPlans
    properties:
      bottomLeftCorner:
        lat: 37.770040510499996
        lng: -122.38714009525
      bottomRightCorner:
        lat: 37.770040510499996
        lng: -122.38714009525
      center:
        lat: 37.770040510499996
        lng: -122.38714009525
      imageContents: 2a9edd3f4ffd80130c647d13eacb59f3
      name: HQ Floor Plan
      networkId: string
      topLeftCorner:
        lat: 37.770040510499996
        lng: -122.38714009525
      topRightCorner:
        lat: 37.770040510499996
        lng: -122.38714009525
outputs:
  merakiNetworksFloorPlansExample: ${example}

    Create FloorPlans Resource

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

    Constructor syntax

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

@overload
def FloorPlans(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               network_id: Optional[str] = None,
               bottom_left_corner: Optional[FloorPlansBottomLeftCornerArgs] = None,
               bottom_right_corner: Optional[FloorPlansBottomRightCornerArgs] = None,
               center: Optional[FloorPlansCenterArgs] = None,
               floor_plan_id: Optional[str] = None,
               image_contents: Optional[str] = None,
               name: Optional[str] = None,
               top_left_corner: Optional[FloorPlansTopLeftCornerArgs] = None,
               top_right_corner: Optional[FloorPlansTopRightCornerArgs] = None)
    func NewFloorPlans(ctx *Context, name string, args FloorPlansArgs, opts ...ResourceOption) (*FloorPlans, error)
    public FloorPlans(string name, FloorPlansArgs args, CustomResourceOptions? opts = null)
    public FloorPlans(String name, FloorPlansArgs args)
public FloorPlans(String name, FloorPlansArgs args, CustomResourceOptions options)

    type: meraki:networks:FloorPlans
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 FloorPlansArgs
    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 FloorPlansArgs
    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 FloorPlansArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FloorPlansArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FloorPlansArgs
    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 floorPlansResource = new Meraki.Networks.FloorPlans("floorPlansResource", new()
{
    NetworkId = "string",
    BottomLeftCorner = new Meraki.Networks.Inputs.FloorPlansBottomLeftCornerArgs
    {
        Lat = 0,
        Lng = 0,
    },
    BottomRightCorner = new Meraki.Networks.Inputs.FloorPlansBottomRightCornerArgs
    {
        Lat = 0,
        Lng = 0,
    },
    Center = new Meraki.Networks.Inputs.FloorPlansCenterArgs
    {
        Lat = 0,
        Lng = 0,
    },
    FloorPlanId = "string",
    ImageContents = "string",
    Name = "string",
    TopLeftCorner = new Meraki.Networks.Inputs.FloorPlansTopLeftCornerArgs
    {
        Lat = 0,
        Lng = 0,
    },
    TopRightCorner = new Meraki.Networks.Inputs.FloorPlansTopRightCornerArgs
    {
        Lat = 0,
        Lng = 0,
    },
});

    example, err := networks.NewFloorPlans(ctx, "floorPlansResource", &networks.FloorPlansArgs{
	NetworkId: pulumi.String("string"),
	BottomLeftCorner: &networks.FloorPlansBottomLeftCornerArgs{
		Lat: pulumi.Float64(0),
		Lng: pulumi.Float64(0),
	},
	BottomRightCorner: &networks.FloorPlansBottomRightCornerArgs{
		Lat: pulumi.Float64(0),
		Lng: pulumi.Float64(0),
	},
	Center: &networks.FloorPlansCenterArgs{
		Lat: pulumi.Float64(0),
		Lng: pulumi.Float64(0),
	},
	FloorPlanId:   pulumi.String("string"),
	ImageContents: pulumi.String("string"),
	Name:          pulumi.String("string"),
	TopLeftCorner: &networks.FloorPlansTopLeftCornerArgs{
		Lat: pulumi.Float64(0),
		Lng: pulumi.Float64(0),
	},
	TopRightCorner: &networks.FloorPlansTopRightCornerArgs{
		Lat: pulumi.Float64(0),
		Lng: pulumi.Float64(0),
	},
})

    var floorPlansResource = new FloorPlans("floorPlansResource", FloorPlansArgs.builder()
    .networkId("string")
    .bottomLeftCorner(FloorPlansBottomLeftCornerArgs.builder()
        .lat(0)
        .lng(0)
        .build())
    .bottomRightCorner(FloorPlansBottomRightCornerArgs.builder()
        .lat(0)
        .lng(0)
        .build())
    .center(FloorPlansCenterArgs.builder()
        .lat(0)
        .lng(0)
        .build())
    .floorPlanId("string")
    .imageContents("string")
    .name("string")
    .topLeftCorner(FloorPlansTopLeftCornerArgs.builder()
        .lat(0)
        .lng(0)
        .build())
    .topRightCorner(FloorPlansTopRightCornerArgs.builder()
        .lat(0)
        .lng(0)
        .build())
    .build());

    floor_plans_resource = meraki.networks.FloorPlans("floorPlansResource",
    network_id="string",
    bottom_left_corner={
        "lat": 0,
        "lng": 0,
    },
    bottom_right_corner={
        "lat": 0,
        "lng": 0,
    },
    center={
        "lat": 0,
        "lng": 0,
    },
    floor_plan_id="string",
    image_contents="string",
    name="string",
    top_left_corner={
        "lat": 0,
        "lng": 0,
    },
    top_right_corner={
        "lat": 0,
        "lng": 0,
    })

    const floorPlansResource = new meraki.networks.FloorPlans("floorPlansResource", {
    networkId: "string",
    bottomLeftCorner: {
        lat: 0,
        lng: 0,
    },
    bottomRightCorner: {
        lat: 0,
        lng: 0,
    },
    center: {
        lat: 0,
        lng: 0,
    },
    floorPlanId: "string",
    imageContents: "string",
    name: "string",
    topLeftCorner: {
        lat: 0,
        lng: 0,
    },
    topRightCorner: {
        lat: 0,
        lng: 0,
    },
});

    type: meraki:networks:FloorPlans
properties:
    bottomLeftCorner:
        lat: 0
        lng: 0
    bottomRightCorner:
        lat: 0
        lng: 0
    center:
        lat: 0
        lng: 0
    floorPlanId: string
    imageContents: string
    name: string
    networkId: string
    topLeftCorner:
        lat: 0
        lng: 0
    topRightCorner:
        lat: 0
        lng: 0

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

    NetworkId string
    networkId path parameter. Network ID
    BottomLeftCorner FloorPlansBottomLeftCorner
    The longitude and latitude of the bottom left corner of your floor plan.
    BottomRightCorner FloorPlansBottomRightCorner
    The longitude and latitude of the bottom right corner of your floor plan.
    Center FloorPlansCenter
    The longitude and latitude of the center of your floor plan. The 'center' or two adjacent corners (e.g. 'topLeftCorner' and 'bottomLeftCorner') must be specified. If 'center' is specified, the floor plan is placed over that point with no rotation. If two adjacent corners are specified, the floor plan is rotated to line up with the two specified points. The aspect ratio of the floor plan's image is preserved regardless of which corners/center are specified. (This means if that more than two corners are specified, only two corners may be used to preserve the floor plan's aspect ratio.). No two points can have the same latitude, longitude pair.
    FloorPlanId string
    Floor plan ID
    ImageContents string
    The file contents (a base 64 encoded string) of your image. Supported formats are PNG, GIF, and JPG. Note that all images are saved as PNG files, regardless of the format they are uploaded in.
    Name string
    The name of your floor plan.
    TopLeftCorner FloorPlansTopLeftCorner
    The longitude and latitude of the top left corner of your floor plan.
    TopRightCorner FloorPlansTopRightCorner
    The longitude and latitude of the top right corner of your floor plan.
    NetworkId string
    networkId path parameter. Network ID
    BottomLeftCorner FloorPlansBottomLeftCornerArgs
    The longitude and latitude of the bottom left corner of your floor plan.
    BottomRightCorner FloorPlansBottomRightCornerArgs
    The longitude and latitude of the bottom right corner of your floor plan.
    Center FloorPlansCenterArgs
    The longitude and latitude of the center of your floor plan. The 'center' or two adjacent corners (e.g. 'topLeftCorner' and 'bottomLeftCorner') must be specified. If 'center' is specified, the floor plan is placed over that point with no rotation. If two adjacent corners are specified, the floor plan is rotated to line up with the two specified points. The aspect ratio of the floor plan's image is preserved regardless of which corners/center are specified. (This means if that more than two corners are specified, only two corners may be used to preserve the floor plan's aspect ratio.). No two points can have the same latitude, longitude pair.
    FloorPlanId string
    Floor plan ID
    ImageContents string
    The file contents (a base 64 encoded string) of your image. Supported formats are PNG, GIF, and JPG. Note that all images are saved as PNG files, regardless of the format they are uploaded in.
    Name string
    The name of your floor plan.
    TopLeftCorner FloorPlansTopLeftCornerArgs
    The longitude and latitude of the top left corner of your floor plan.
    TopRightCorner FloorPlansTopRightCornerArgs
    The longitude and latitude of the top right corner of your floor plan.
    networkId String
    networkId path parameter. Network ID
    bottomLeftCorner FloorPlansBottomLeftCorner
    The longitude and latitude of the bottom left corner of your floor plan.
    bottomRightCorner FloorPlansBottomRightCorner
    The longitude and latitude of the bottom right corner of your floor plan.
    center FloorPlansCenter
    The longitude and latitude of the center of your floor plan. The 'center' or two adjacent corners (e.g. 'topLeftCorner' and 'bottomLeftCorner') must be specified. If 'center' is specified, the floor plan is placed over that point with no rotation. If two adjacent corners are specified, the floor plan is rotated to line up with the two specified points. The aspect ratio of the floor plan's image is preserved regardless of which corners/center are specified. (This means if that more than two corners are specified, only two corners may be used to preserve the floor plan's aspect ratio.). No two points can have the same latitude, longitude pair.
    floorPlanId String
    Floor plan ID
    imageContents String
    The file contents (a base 64 encoded string) of your image. Supported formats are PNG, GIF, and JPG. Note that all images are saved as PNG files, regardless of the format they are uploaded in.
    name String
    The name of your floor plan.
    topLeftCorner FloorPlansTopLeftCorner
    The longitude and latitude of the top left corner of your floor plan.
    topRightCorner FloorPlansTopRightCorner
    The longitude and latitude of the top right corner of your floor plan.
    networkId string
    networkId path parameter. Network ID
    bottomLeftCorner FloorPlansBottomLeftCorner
    The longitude and latitude of the bottom left corner of your floor plan.
    bottomRightCorner FloorPlansBottomRightCorner
    The longitude and latitude of the bottom right corner of your floor plan.
    center FloorPlansCenter
    The longitude and latitude of the center of your floor plan. The 'center' or two adjacent corners (e.g. 'topLeftCorner' and 'bottomLeftCorner') must be specified. If 'center' is specified, the floor plan is placed over that point with no rotation. If two adjacent corners are specified, the floor plan is rotated to line up with the two specified points. The aspect ratio of the floor plan's image is preserved regardless of which corners/center are specified. (This means if that more than two corners are specified, only two corners may be used to preserve the floor plan's aspect ratio.). No two points can have the same latitude, longitude pair.
    floorPlanId string
    Floor plan ID
    imageContents string
    The file contents (a base 64 encoded string) of your image. Supported formats are PNG, GIF, and JPG. Note that all images are saved as PNG files, regardless of the format they are uploaded in.
    name string
    The name of your floor plan.
    topLeftCorner FloorPlansTopLeftCorner
    The longitude and latitude of the top left corner of your floor plan.
    topRightCorner FloorPlansTopRightCorner
    The longitude and latitude of the top right corner of your floor plan.
    network_id str
    networkId path parameter. Network ID
    bottom_left_corner FloorPlansBottomLeftCornerArgs
    The longitude and latitude of the bottom left corner of your floor plan.
    bottom_right_corner FloorPlansBottomRightCornerArgs
    The longitude and latitude of the bottom right corner of your floor plan.
    center FloorPlansCenterArgs
    The longitude and latitude of the center of your floor plan. The 'center' or two adjacent corners (e.g. 'topLeftCorner' and 'bottomLeftCorner') must be specified. If 'center' is specified, the floor plan is placed over that point with no rotation. If two adjacent corners are specified, the floor plan is rotated to line up with the two specified points. The aspect ratio of the floor plan's image is preserved regardless of which corners/center are specified. (This means if that more than two corners are specified, only two corners may be used to preserve the floor plan's aspect ratio.). No two points can have the same latitude, longitude pair.
    floor_plan_id str
    Floor plan ID
    image_contents str
    The file contents (a base 64 encoded string) of your image. Supported formats are PNG, GIF, and JPG. Note that all images are saved as PNG files, regardless of the format they are uploaded in.
    name str
    The name of your floor plan.
    top_left_corner FloorPlansTopLeftCornerArgs
    The longitude and latitude of the top left corner of your floor plan.
    top_right_corner FloorPlansTopRightCornerArgs
    The longitude and latitude of the top right corner of your floor plan.
    networkId String
    networkId path parameter. Network ID
    bottomLeftCorner Property Map
    The longitude and latitude of the bottom left corner of your floor plan.
    bottomRightCorner Property Map
    The longitude and latitude of the bottom right corner of your floor plan.
    center Property Map
    The longitude and latitude of the center of your floor plan. The 'center' or two adjacent corners (e.g. 'topLeftCorner' and 'bottomLeftCorner') must be specified. If 'center' is specified, the floor plan is placed over that point with no rotation. If two adjacent corners are specified, the floor plan is rotated to line up with the two specified points. The aspect ratio of the floor plan's image is preserved regardless of which corners/center are specified. (This means if that more than two corners are specified, only two corners may be used to preserve the floor plan's aspect ratio.). No two points can have the same latitude, longitude pair.
    floorPlanId String
    Floor plan ID
    imageContents String
    The file contents (a base 64 encoded string) of your image. Supported formats are PNG, GIF, and JPG. Note that all images are saved as PNG files, regardless of the format they are uploaded in.
    name String
    The name of your floor plan.
    topLeftCorner Property Map
    The longitude and latitude of the top left corner of your floor plan.
    topRightCorner Property Map
    The longitude and latitude of the top right corner of your floor plan.

    Outputs

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

    Devices List<FloorPlansDevice>
    List of devices for the floorplan
    Height double
    The height of your floor plan.
    Id string
    The provider-assigned unique ID for this managed resource.
    ImageExtension string
    The format type of the image.
    ImageMd5 string
    The file contents (a base 64 encoded string) of your new image. Supported formats are PNG, GIF, and JPG. Note that all images are saved as PNG files, regardless of the format they are uploaded in. If you upload a new image, and you do NOT specify any new geolocation fields ('center, 'topLeftCorner', etc), the floor plan will be recentered with no rotation in order to maintain the aspect ratio of your new image.
    ImageUrl string
    The url link for the floor plan image.
    ImageUrlExpiresAt string
    The time the image url link will expire.
    Width double
    The width of your floor plan.
    Devices []FloorPlansDevice
    List of devices for the floorplan
    Height float64
    The height of your floor plan.
    Id string
    The provider-assigned unique ID for this managed resource.
    ImageExtension string
    The format type of the image.
    ImageMd5 string
    The file contents (a base 64 encoded string) of your new image. Supported formats are PNG, GIF, and JPG. Note that all images are saved as PNG files, regardless of the format they are uploaded in. If you upload a new image, and you do NOT specify any new geolocation fields ('center, 'topLeftCorner', etc), the floor plan will be recentered with no rotation in order to maintain the aspect ratio of your new image.
    ImageUrl string
    The url link for the floor plan image.
    ImageUrlExpiresAt string
    The time the image url link will expire.
    Width float64
    The width of your floor plan.
    devices List<FloorPlansDevice>
    List of devices for the floorplan
    height Double
    The height of your floor plan.
    id String
    The provider-assigned unique ID for this managed resource.
    imageExtension String
    The format type of the image.
    imageMd5 String
    The file contents (a base 64 encoded string) of your new image. Supported formats are PNG, GIF, and JPG. Note that all images are saved as PNG files, regardless of the format they are uploaded in. If you upload a new image, and you do NOT specify any new geolocation fields ('center, 'topLeftCorner', etc), the floor plan will be recentered with no rotation in order to maintain the aspect ratio of your new image.
    imageUrl String
    The url link for the floor plan image.
    imageUrlExpiresAt String
    The time the image url link will expire.
    width Double
    The width of your floor plan.
    devices FloorPlansDevice[]
    List of devices for the floorplan
    height number
    The height of your floor plan.
    id string
    The provider-assigned unique ID for this managed resource.
    imageExtension string
    The format type of the image.
    imageMd5 string
    The file contents (a base 64 encoded string) of your new image. Supported formats are PNG, GIF, and JPG. Note that all images are saved as PNG files, regardless of the format they are uploaded in. If you upload a new image, and you do NOT specify any new geolocation fields ('center, 'topLeftCorner', etc), the floor plan will be recentered with no rotation in order to maintain the aspect ratio of your new image.
    imageUrl string
    The url link for the floor plan image.
    imageUrlExpiresAt string
    The time the image url link will expire.
    width number
    The width of your floor plan.
    devices Sequence[FloorPlansDevice]
    List of devices for the floorplan
    height float
    The height of your floor plan.
    id str
    The provider-assigned unique ID for this managed resource.
    image_extension str
    The format type of the image.
    image_md5 str
    The file contents (a base 64 encoded string) of your new image. Supported formats are PNG, GIF, and JPG. Note that all images are saved as PNG files, regardless of the format they are uploaded in. If you upload a new image, and you do NOT specify any new geolocation fields ('center, 'topLeftCorner', etc), the floor plan will be recentered with no rotation in order to maintain the aspect ratio of your new image.
    image_url str
    The url link for the floor plan image.
    image_url_expires_at str
    The time the image url link will expire.
    width float
    The width of your floor plan.
    devices List<Property Map>
    List of devices for the floorplan
    height Number
    The height of your floor plan.
    id String
    The provider-assigned unique ID for this managed resource.
    imageExtension String
    The format type of the image.
    imageMd5 String
    The file contents (a base 64 encoded string) of your new image. Supported formats are PNG, GIF, and JPG. Note that all images are saved as PNG files, regardless of the format they are uploaded in. If you upload a new image, and you do NOT specify any new geolocation fields ('center, 'topLeftCorner', etc), the floor plan will be recentered with no rotation in order to maintain the aspect ratio of your new image.
    imageUrl String
    The url link for the floor plan image.
    imageUrlExpiresAt String
    The time the image url link will expire.
    width Number
    The width of your floor plan.

    Look up Existing FloorPlans Resource

    Get an existing FloorPlans 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?: FloorPlansState, opts?: CustomResourceOptions): FloorPlans
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        bottom_left_corner: Optional[FloorPlansBottomLeftCornerArgs] = None,
        bottom_right_corner: Optional[FloorPlansBottomRightCornerArgs] = None,
        center: Optional[FloorPlansCenterArgs] = None,
        devices: Optional[Sequence[FloorPlansDeviceArgs]] = None,
        floor_plan_id: Optional[str] = None,
        height: Optional[float] = None,
        image_contents: Optional[str] = None,
        image_extension: Optional[str] = None,
        image_md5: Optional[str] = None,
        image_url: Optional[str] = None,
        image_url_expires_at: Optional[str] = None,
        name: Optional[str] = None,
        network_id: Optional[str] = None,
        top_left_corner: Optional[FloorPlansTopLeftCornerArgs] = None,
        top_right_corner: Optional[FloorPlansTopRightCornerArgs] = None,
        width: Optional[float] = None) -> FloorPlans
    func GetFloorPlans(ctx *Context, name string, id IDInput, state *FloorPlansState, opts ...ResourceOption) (*FloorPlans, error)
    public static FloorPlans Get(string name, Input<string> id, FloorPlansState? state, CustomResourceOptions? opts = null)
    public static FloorPlans get(String name, Output<String> id, FloorPlansState 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:
    BottomLeftCorner FloorPlansBottomLeftCorner
    The longitude and latitude of the bottom left corner of your floor plan.
    BottomRightCorner FloorPlansBottomRightCorner
    The longitude and latitude of the bottom right corner of your floor plan.
    Center FloorPlansCenter
    The longitude and latitude of the center of your floor plan. The 'center' or two adjacent corners (e.g. 'topLeftCorner' and 'bottomLeftCorner') must be specified. If 'center' is specified, the floor plan is placed over that point with no rotation. If two adjacent corners are specified, the floor plan is rotated to line up with the two specified points. The aspect ratio of the floor plan's image is preserved regardless of which corners/center are specified. (This means if that more than two corners are specified, only two corners may be used to preserve the floor plan's aspect ratio.). No two points can have the same latitude, longitude pair.
    Devices List<FloorPlansDevice>
    List of devices for the floorplan
    FloorPlanId string
    Floor plan ID
    Height double
    The height of your floor plan.
    ImageContents string
    The file contents (a base 64 encoded string) of your image. Supported formats are PNG, GIF, and JPG. Note that all images are saved as PNG files, regardless of the format they are uploaded in.
    ImageExtension string
    The format type of the image.
    ImageMd5 string
    The file contents (a base 64 encoded string) of your new image. Supported formats are PNG, GIF, and JPG. Note that all images are saved as PNG files, regardless of the format they are uploaded in. If you upload a new image, and you do NOT specify any new geolocation fields ('center, 'topLeftCorner', etc), the floor plan will be recentered with no rotation in order to maintain the aspect ratio of your new image.
    ImageUrl string
    The url link for the floor plan image.
    ImageUrlExpiresAt string
    The time the image url link will expire.
    Name string
    The name of your floor plan.
    NetworkId string
    networkId path parameter. Network ID
    TopLeftCorner FloorPlansTopLeftCorner
    The longitude and latitude of the top left corner of your floor plan.
    TopRightCorner FloorPlansTopRightCorner
    The longitude and latitude of the top right corner of your floor plan.
    Width double
    The width of your floor plan.
    BottomLeftCorner FloorPlansBottomLeftCornerArgs
    The longitude and latitude of the bottom left corner of your floor plan.
    BottomRightCorner FloorPlansBottomRightCornerArgs
    The longitude and latitude of the bottom right corner of your floor plan.
    Center FloorPlansCenterArgs
    The longitude and latitude of the center of your floor plan. The 'center' or two adjacent corners (e.g. 'topLeftCorner' and 'bottomLeftCorner') must be specified. If 'center' is specified, the floor plan is placed over that point with no rotation. If two adjacent corners are specified, the floor plan is rotated to line up with the two specified points. The aspect ratio of the floor plan's image is preserved regardless of which corners/center are specified. (This means if that more than two corners are specified, only two corners may be used to preserve the floor plan's aspect ratio.). No two points can have the same latitude, longitude pair.
    Devices []FloorPlansDeviceArgs
    List of devices for the floorplan
    FloorPlanId string
    Floor plan ID
    Height float64
    The height of your floor plan.
    ImageContents string
    The file contents (a base 64 encoded string) of your image. Supported formats are PNG, GIF, and JPG. Note that all images are saved as PNG files, regardless of the format they are uploaded in.
    ImageExtension string
    The format type of the image.
    ImageMd5 string
    The file contents (a base 64 encoded string) of your new image. Supported formats are PNG, GIF, and JPG. Note that all images are saved as PNG files, regardless of the format they are uploaded in. If you upload a new image, and you do NOT specify any new geolocation fields ('center, 'topLeftCorner', etc), the floor plan will be recentered with no rotation in order to maintain the aspect ratio of your new image.
    ImageUrl string
    The url link for the floor plan image.
    ImageUrlExpiresAt string
    The time the image url link will expire.
    Name string
    The name of your floor plan.
    NetworkId string
    networkId path parameter. Network ID
    TopLeftCorner FloorPlansTopLeftCornerArgs
    The longitude and latitude of the top left corner of your floor plan.
    TopRightCorner FloorPlansTopRightCornerArgs
    The longitude and latitude of the top right corner of your floor plan.
    Width float64
    The width of your floor plan.
    bottomLeftCorner FloorPlansBottomLeftCorner
    The longitude and latitude of the bottom left corner of your floor plan.
    bottomRightCorner FloorPlansBottomRightCorner
    The longitude and latitude of the bottom right corner of your floor plan.
    center FloorPlansCenter
    The longitude and latitude of the center of your floor plan. The 'center' or two adjacent corners (e.g. 'topLeftCorner' and 'bottomLeftCorner') must be specified. If 'center' is specified, the floor plan is placed over that point with no rotation. If two adjacent corners are specified, the floor plan is rotated to line up with the two specified points. The aspect ratio of the floor plan's image is preserved regardless of which corners/center are specified. (This means if that more than two corners are specified, only two corners may be used to preserve the floor plan's aspect ratio.). No two points can have the same latitude, longitude pair.
    devices List<FloorPlansDevice>
    List of devices for the floorplan
    floorPlanId String
    Floor plan ID
    height Double
    The height of your floor plan.
    imageContents String
    The file contents (a base 64 encoded string) of your image. Supported formats are PNG, GIF, and JPG. Note that all images are saved as PNG files, regardless of the format they are uploaded in.
    imageExtension String
    The format type of the image.
    imageMd5 String
    The file contents (a base 64 encoded string) of your new image. Supported formats are PNG, GIF, and JPG. Note that all images are saved as PNG files, regardless of the format they are uploaded in. If you upload a new image, and you do NOT specify any new geolocation fields ('center, 'topLeftCorner', etc), the floor plan will be recentered with no rotation in order to maintain the aspect ratio of your new image.
    imageUrl String
    The url link for the floor plan image.
    imageUrlExpiresAt String
    The time the image url link will expire.
    name String
    The name of your floor plan.
    networkId String
    networkId path parameter. Network ID
    topLeftCorner FloorPlansTopLeftCorner
    The longitude and latitude of the top left corner of your floor plan.
    topRightCorner FloorPlansTopRightCorner
    The longitude and latitude of the top right corner of your floor plan.
    width Double
    The width of your floor plan.
    bottomLeftCorner FloorPlansBottomLeftCorner
    The longitude and latitude of the bottom left corner of your floor plan.
    bottomRightCorner FloorPlansBottomRightCorner
    The longitude and latitude of the bottom right corner of your floor plan.
    center FloorPlansCenter
    The longitude and latitude of the center of your floor plan. The 'center' or two adjacent corners (e.g. 'topLeftCorner' and 'bottomLeftCorner') must be specified. If 'center' is specified, the floor plan is placed over that point with no rotation. If two adjacent corners are specified, the floor plan is rotated to line up with the two specified points. The aspect ratio of the floor plan's image is preserved regardless of which corners/center are specified. (This means if that more than two corners are specified, only two corners may be used to preserve the floor plan's aspect ratio.). No two points can have the same latitude, longitude pair.
    devices FloorPlansDevice[]
    List of devices for the floorplan
    floorPlanId string
    Floor plan ID
    height number
    The height of your floor plan.
    imageContents string
    The file contents (a base 64 encoded string) of your image. Supported formats are PNG, GIF, and JPG. Note that all images are saved as PNG files, regardless of the format they are uploaded in.
    imageExtension string
    The format type of the image.
    imageMd5 string
    The file contents (a base 64 encoded string) of your new image. Supported formats are PNG, GIF, and JPG. Note that all images are saved as PNG files, regardless of the format they are uploaded in. If you upload a new image, and you do NOT specify any new geolocation fields ('center, 'topLeftCorner', etc), the floor plan will be recentered with no rotation in order to maintain the aspect ratio of your new image.
    imageUrl string
    The url link for the floor plan image.
    imageUrlExpiresAt string
    The time the image url link will expire.
    name string
    The name of your floor plan.
    networkId string
    networkId path parameter. Network ID
    topLeftCorner FloorPlansTopLeftCorner
    The longitude and latitude of the top left corner of your floor plan.
    topRightCorner FloorPlansTopRightCorner
    The longitude and latitude of the top right corner of your floor plan.
    width number
    The width of your floor plan.
    bottom_left_corner FloorPlansBottomLeftCornerArgs
    The longitude and latitude of the bottom left corner of your floor plan.
    bottom_right_corner FloorPlansBottomRightCornerArgs
    The longitude and latitude of the bottom right corner of your floor plan.
    center FloorPlansCenterArgs
    The longitude and latitude of the center of your floor plan. The 'center' or two adjacent corners (e.g. 'topLeftCorner' and 'bottomLeftCorner') must be specified. If 'center' is specified, the floor plan is placed over that point with no rotation. If two adjacent corners are specified, the floor plan is rotated to line up with the two specified points. The aspect ratio of the floor plan's image is preserved regardless of which corners/center are specified. (This means if that more than two corners are specified, only two corners may be used to preserve the floor plan's aspect ratio.). No two points can have the same latitude, longitude pair.
    devices Sequence[FloorPlansDeviceArgs]
    List of devices for the floorplan
    floor_plan_id str
    Floor plan ID
    height float
    The height of your floor plan.
    image_contents str
    The file contents (a base 64 encoded string) of your image. Supported formats are PNG, GIF, and JPG. Note that all images are saved as PNG files, regardless of the format they are uploaded in.
    image_extension str
    The format type of the image.
    image_md5 str
    The file contents (a base 64 encoded string) of your new image. Supported formats are PNG, GIF, and JPG. Note that all images are saved as PNG files, regardless of the format they are uploaded in. If you upload a new image, and you do NOT specify any new geolocation fields ('center, 'topLeftCorner', etc), the floor plan will be recentered with no rotation in order to maintain the aspect ratio of your new image.
    image_url str
    The url link for the floor plan image.
    image_url_expires_at str
    The time the image url link will expire.
    name str
    The name of your floor plan.
    network_id str
    networkId path parameter. Network ID
    top_left_corner FloorPlansTopLeftCornerArgs
    The longitude and latitude of the top left corner of your floor plan.
    top_right_corner FloorPlansTopRightCornerArgs
    The longitude and latitude of the top right corner of your floor plan.
    width float
    The width of your floor plan.
    bottomLeftCorner Property Map
    The longitude and latitude of the bottom left corner of your floor plan.
    bottomRightCorner Property Map
    The longitude and latitude of the bottom right corner of your floor plan.
    center Property Map
    The longitude and latitude of the center of your floor plan. The 'center' or two adjacent corners (e.g. 'topLeftCorner' and 'bottomLeftCorner') must be specified. If 'center' is specified, the floor plan is placed over that point with no rotation. If two adjacent corners are specified, the floor plan is rotated to line up with the two specified points. The aspect ratio of the floor plan's image is preserved regardless of which corners/center are specified. (This means if that more than two corners are specified, only two corners may be used to preserve the floor plan's aspect ratio.). No two points can have the same latitude, longitude pair.
    devices List<Property Map>
    List of devices for the floorplan
    floorPlanId String
    Floor plan ID
    height Number
    The height of your floor plan.
    imageContents String
    The file contents (a base 64 encoded string) of your image. Supported formats are PNG, GIF, and JPG. Note that all images are saved as PNG files, regardless of the format they are uploaded in.
    imageExtension String
    The format type of the image.
    imageMd5 String
    The file contents (a base 64 encoded string) of your new image. Supported formats are PNG, GIF, and JPG. Note that all images are saved as PNG files, regardless of the format they are uploaded in. If you upload a new image, and you do NOT specify any new geolocation fields ('center, 'topLeftCorner', etc), the floor plan will be recentered with no rotation in order to maintain the aspect ratio of your new image.
    imageUrl String
    The url link for the floor plan image.
    imageUrlExpiresAt String
    The time the image url link will expire.
    name String
    The name of your floor plan.
    networkId String
    networkId path parameter. Network ID
    topLeftCorner Property Map
    The longitude and latitude of the top left corner of your floor plan.
    topRightCorner Property Map
    The longitude and latitude of the top right corner of your floor plan.
    width Number
    The width of your floor plan.

    Supporting Types

    FloorPlansBottomLeftCorner, FloorPlansBottomLeftCornerArgs

    Lat double
    Latitude
    Lng double
    Longitude
    Lat float64
    Latitude
    Lng float64
    Longitude
    lat Double
    Latitude
    lng Double
    Longitude
    lat number
    Latitude
    lng number
    Longitude
    lat float
    Latitude
    lng float
    Longitude
    lat Number
    Latitude
    lng Number
    Longitude

    FloorPlansBottomRightCorner, FloorPlansBottomRightCornerArgs

    Lat double
    Latitude
    Lng double
    Longitude
    Lat float64
    Latitude
    Lng float64
    Longitude
    lat Double
    Latitude
    lng Double
    Longitude
    lat number
    Latitude
    lng number
    Longitude
    lat float
    Latitude
    lng float
    Longitude
    lat Number
    Latitude
    lng Number
    Longitude

    FloorPlansCenter, FloorPlansCenterArgs

    Lat double
    Latitude
    Lng double
    Longitude
    Lat float64
    Latitude
    Lng float64
    Longitude
    lat Double
    Latitude
    lng Double
    Longitude
    lat number
    Latitude
    lng number
    Longitude
    lat float
    Latitude
    lng float
    Longitude
    lat Number
    Latitude
    lng Number
    Longitude

    FloorPlansDevice, FloorPlansDeviceArgs

    Address string
    Physical address of the device
    Details List<FloorPlansDeviceDetail>
    Additional device information
    Firmware string
    Firmware version of the device
    Imei string
    IMEI of the device, if applicable
    LanIp string
    LAN IP address of the device
    Lat double
    Latitude of the device
    Lng double
    Longitude of the device
    Mac string
    MAC address of the device
    Model string
    Model of the device
    Name string
    Name of the device
    NetworkId string
    ID of the network the device belongs to
    Notes string
    Notes for the device, limited to 255 characters
    ProductType string
    Product type of the device
    Serial string
    Serial number of the device
    Tags List<string>
    List of tags assigned to the device
    Address string
    Physical address of the device
    Details []FloorPlansDeviceDetail
    Additional device information
    Firmware string
    Firmware version of the device
    Imei string
    IMEI of the device, if applicable
    LanIp string
    LAN IP address of the device
    Lat float64
    Latitude of the device
    Lng float64
    Longitude of the device
    Mac string
    MAC address of the device
    Model string
    Model of the device
    Name string
    Name of the device
    NetworkId string
    ID of the network the device belongs to
    Notes string
    Notes for the device, limited to 255 characters
    ProductType string
    Product type of the device
    Serial string
    Serial number of the device
    Tags []string
    List of tags assigned to the device
    address String
    Physical address of the device
    details List<FloorPlansDeviceDetail>
    Additional device information
    firmware String
    Firmware version of the device
    imei String
    IMEI of the device, if applicable
    lanIp String
    LAN IP address of the device
    lat Double
    Latitude of the device
    lng Double
    Longitude of the device
    mac String
    MAC address of the device
    model String
    Model of the device
    name String
    Name of the device
    networkId String
    ID of the network the device belongs to
    notes String
    Notes for the device, limited to 255 characters
    productType String
    Product type of the device
    serial String
    Serial number of the device
    tags List<String>
    List of tags assigned to the device
    address string
    Physical address of the device
    details FloorPlansDeviceDetail[]
    Additional device information
    firmware string
    Firmware version of the device
    imei string
    IMEI of the device, if applicable
    lanIp string
    LAN IP address of the device
    lat number
    Latitude of the device
    lng number
    Longitude of the device
    mac string
    MAC address of the device
    model string
    Model of the device
    name string
    Name of the device
    networkId string
    ID of the network the device belongs to
    notes string
    Notes for the device, limited to 255 characters
    productType string
    Product type of the device
    serial string
    Serial number of the device
    tags string[]
    List of tags assigned to the device
    address str
    Physical address of the device
    details Sequence[FloorPlansDeviceDetail]
    Additional device information
    firmware str
    Firmware version of the device
    imei str
    IMEI of the device, if applicable
    lan_ip str
    LAN IP address of the device
    lat float
    Latitude of the device
    lng float
    Longitude of the device
    mac str
    MAC address of the device
    model str
    Model of the device
    name str
    Name of the device
    network_id str
    ID of the network the device belongs to
    notes str
    Notes for the device, limited to 255 characters
    product_type str
    Product type of the device
    serial str
    Serial number of the device
    tags Sequence[str]
    List of tags assigned to the device
    address String
    Physical address of the device
    details List<Property Map>
    Additional device information
    firmware String
    Firmware version of the device
    imei String
    IMEI of the device, if applicable
    lanIp String
    LAN IP address of the device
    lat Number
    Latitude of the device
    lng Number
    Longitude of the device
    mac String
    MAC address of the device
    model String
    Model of the device
    name String
    Name of the device
    networkId String
    ID of the network the device belongs to
    notes String
    Notes for the device, limited to 255 characters
    productType String
    Product type of the device
    serial String
    Serial number of the device
    tags List<String>
    List of tags assigned to the device

    FloorPlansDeviceDetail, FloorPlansDeviceDetailArgs

    Name string
    Additional property name
    Value string
    Additional property value
    Name string
    Additional property name
    Value string
    Additional property value
    name String
    Additional property name
    value String
    Additional property value
    name string
    Additional property name
    value string
    Additional property value
    name str
    Additional property name
    value str
    Additional property value
    name String
    Additional property name
    value String
    Additional property value

    FloorPlansTopLeftCorner, FloorPlansTopLeftCornerArgs

    Lat double
    Latitude
    Lng double
    Longitude
    Lat float64
    Latitude
    Lng float64
    Longitude
    lat Double
    Latitude
    lng Double
    Longitude
    lat number
    Latitude
    lng number
    Longitude
    lat float
    Latitude
    lng float
    Longitude
    lat Number
    Latitude
    lng Number
    Longitude

    FloorPlansTopRightCorner, FloorPlansTopRightCornerArgs

    Lat double
    Latitude
    Lng double
    Longitude
    Lat float64
    Latitude
    Lng float64
    Longitude
    lat Double
    Latitude
    lng Double
    Longitude
    lat number
    Latitude
    lng number
    Longitude
    lat float
    Latitude
    lng float
    Longitude
    lat Number
    Latitude
    lng Number
    Longitude

    Import

    $ pulumi import meraki:networks/floorPlans:FloorPlans example "floor_plan_id,network_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.3.2 published on Tuesday, Sep 24, 2024 by Pulumi
    pulumi/pulumi-meraki