Cisco Meraki v0.4.1 published on Saturday, Mar 15, 2025 by Pulumi
meraki.networks.getFloorPlans
Explore with Pulumi AI
Example Usage
Using getFloorPlans
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 getFloorPlans(args: GetFloorPlansArgs, opts?: InvokeOptions): Promise<GetFloorPlansResult>
function getFloorPlansOutput(args: GetFloorPlansOutputArgs, opts?: InvokeOptions): Output<GetFloorPlansResult>
def get_floor_plans(floor_plan_id: Optional[str] = None,
network_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetFloorPlansResult
def get_floor_plans_output(floor_plan_id: Optional[pulumi.Input[str]] = None,
network_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetFloorPlansResult]
func LookupFloorPlans(ctx *Context, args *LookupFloorPlansArgs, opts ...InvokeOption) (*LookupFloorPlansResult, error)
func LookupFloorPlansOutput(ctx *Context, args *LookupFloorPlansOutputArgs, opts ...InvokeOption) LookupFloorPlansResultOutput
> Note: This function is named LookupFloorPlans
in the Go SDK.
public static class GetFloorPlans
{
public static Task<GetFloorPlansResult> InvokeAsync(GetFloorPlansArgs args, InvokeOptions? opts = null)
public static Output<GetFloorPlansResult> Invoke(GetFloorPlansInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetFloorPlansResult> getFloorPlans(GetFloorPlansArgs args, InvokeOptions options)
public static Output<GetFloorPlansResult> getFloorPlans(GetFloorPlansArgs args, InvokeOptions options)
fn::invoke:
function: meraki:networks/getFloorPlans:getFloorPlans
arguments:
# arguments dictionary
The following arguments are supported:
- Floor
Plan stringId - floorPlanId path parameter. Floor plan ID
- Network
Id string - networkId path parameter. Network ID
- Floor
Plan stringId - floorPlanId path parameter. Floor plan ID
- Network
Id string - networkId path parameter. Network ID
- floor
Plan StringId - floorPlanId path parameter. Floor plan ID
- network
Id String - networkId path parameter. Network ID
- floor
Plan stringId - floorPlanId path parameter. Floor plan ID
- network
Id string - networkId path parameter. Network ID
- floor_
plan_ strid - floorPlanId path parameter. Floor plan ID
- network_
id str - networkId path parameter. Network ID
- floor
Plan StringId - floorPlanId path parameter. Floor plan ID
- network
Id String - networkId path parameter. Network ID
getFloorPlans Result
The following output properties are available:
- Id string
- The provider-assigned unique ID for this managed resource.
- Item
Get
Floor Plans Item - Items
List<Get
Floor Plans Item> - Array of ResponseNetworksGetNetworkFloorPlans
- Floor
Plan stringId - floorPlanId path parameter. Floor plan ID
- Network
Id string - networkId path parameter. Network ID
- Id string
- The provider-assigned unique ID for this managed resource.
- Item
Get
Floor Plans Item - Items
[]Get
Floor Plans Item - Array of ResponseNetworksGetNetworkFloorPlans
- Floor
Plan stringId - floorPlanId path parameter. Floor plan ID
- Network
Id string - networkId path parameter. Network ID
- id String
- The provider-assigned unique ID for this managed resource.
- item
Get
Floor Plans Item - items
List<Get
Floor Plans Item> - Array of ResponseNetworksGetNetworkFloorPlans
- floor
Plan StringId - floorPlanId path parameter. Floor plan ID
- network
Id String - networkId path parameter. Network ID
- id string
- The provider-assigned unique ID for this managed resource.
- item
Get
Floor Plans Item - items
Get
Floor Plans Item[] - Array of ResponseNetworksGetNetworkFloorPlans
- floor
Plan stringId - floorPlanId path parameter. Floor plan ID
- network
Id string - networkId path parameter. Network ID
- id str
- The provider-assigned unique ID for this managed resource.
- item
Get
Floor Plans Item - items
Sequence[Get
Floor Plans Item] - Array of ResponseNetworksGetNetworkFloorPlans
- floor_
plan_ strid - floorPlanId path parameter. Floor plan ID
- network_
id str - networkId path parameter. Network ID
- id String
- The provider-assigned unique ID for this managed resource.
- item Property Map
- items List<Property Map>
- Array of ResponseNetworksGetNetworkFloorPlans
- floor
Plan StringId - floorPlanId path parameter. Floor plan ID
- network
Id String - networkId path parameter. Network ID
Supporting Types
GetFloorPlansItem
- Bottom
Left Corner This property is required. GetFloor Plans Item Bottom Left Corner - The longitude and latitude of the bottom left corner of your floor plan.
- Bottom
Right Corner This property is required. GetFloor Plans Item Bottom Right Corner - The longitude and latitude of the bottom right corner of your floor plan.
- Center
This property is required. GetFloor Plans Item Center - 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
This property is required. List<GetFloor Plans Item Device> - List of devices for the floorplan
- Floor
Plan Id This property is required. string - Floor plan ID
- Height
This property is required. double - The height of your floor plan.
- Image
Extension This property is required. string - The format type of the image.
- Image
Md5 This property is required. 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.
- Image
Url This property is required. string - The url link for the floor plan image.
- Image
Url Expires At This property is required. string - The time the image url link will expire.
- Name
This property is required. string - The name of your floor plan.
- Top
Left Corner This property is required. GetFloor Plans Item Top Left Corner - The longitude and latitude of the top left corner of your floor plan.
- Top
Right Corner This property is required. GetFloor Plans Item Top Right Corner - The longitude and latitude of the top right corner of your floor plan.
- Width
This property is required. double - The width of your floor plan.
- Bottom
Left Corner This property is required. GetFloor Plans Item Bottom Left Corner - The longitude and latitude of the bottom left corner of your floor plan.
- Bottom
Right Corner This property is required. GetFloor Plans Item Bottom Right Corner - The longitude and latitude of the bottom right corner of your floor plan.
- Center
This property is required. GetFloor Plans Item Center - 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
This property is required. []GetFloor Plans Item Device - List of devices for the floorplan
- Floor
Plan Id This property is required. string - Floor plan ID
- Height
This property is required. float64 - The height of your floor plan.
- Image
Extension This property is required. string - The format type of the image.
- Image
Md5 This property is required. 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.
- Image
Url This property is required. string - The url link for the floor plan image.
- Image
Url Expires At This property is required. string - The time the image url link will expire.
- Name
This property is required. string - The name of your floor plan.
- Top
Left Corner This property is required. GetFloor Plans Item Top Left Corner - The longitude and latitude of the top left corner of your floor plan.
- Top
Right Corner This property is required. GetFloor Plans Item Top Right Corner - The longitude and latitude of the top right corner of your floor plan.
- Width
This property is required. float64 - The width of your floor plan.
- bottom
Left Corner This property is required. GetFloor Plans Item Bottom Left Corner - The longitude and latitude of the bottom left corner of your floor plan.
- bottom
Right Corner This property is required. GetFloor Plans Item Bottom Right Corner - The longitude and latitude of the bottom right corner of your floor plan.
- center
This property is required. GetFloor Plans Item Center - 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
This property is required. List<GetFloor Plans Item Device> - List of devices for the floorplan
- floor
Plan Id This property is required. String - Floor plan ID
- height
This property is required. Double - The height of your floor plan.
- image
Extension This property is required. String - The format type of the image.
- image
Md5 This property is required. 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.
- image
Url This property is required. String - The url link for the floor plan image.
- image
Url Expires At This property is required. String - The time the image url link will expire.
- name
This property is required. String - The name of your floor plan.
- top
Left Corner This property is required. GetFloor Plans Item Top Left Corner - The longitude and latitude of the top left corner of your floor plan.
- top
Right Corner This property is required. GetFloor Plans Item Top Right Corner - The longitude and latitude of the top right corner of your floor plan.
- width
This property is required. Double - The width of your floor plan.
- bottom
Left Corner This property is required. GetFloor Plans Item Bottom Left Corner - The longitude and latitude of the bottom left corner of your floor plan.
- bottom
Right Corner This property is required. GetFloor Plans Item Bottom Right Corner - The longitude and latitude of the bottom right corner of your floor plan.
- center
This property is required. GetFloor Plans Item Center - 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
This property is required. GetFloor Plans Item Device[] - List of devices for the floorplan
- floor
Plan Id This property is required. string - Floor plan ID
- height
This property is required. number - The height of your floor plan.
- image
Extension This property is required. string - The format type of the image.
- image
Md5 This property is required. 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.
- image
Url This property is required. string - The url link for the floor plan image.
- image
Url Expires At This property is required. string - The time the image url link will expire.
- name
This property is required. string - The name of your floor plan.
- top
Left Corner This property is required. GetFloor Plans Item Top Left Corner - The longitude and latitude of the top left corner of your floor plan.
- top
Right Corner This property is required. GetFloor Plans Item Top Right Corner - The longitude and latitude of the top right corner of your floor plan.
- width
This property is required. number - The width of your floor plan.
- bottom_
left_ corner This property is required. GetFloor Plans Item Bottom Left Corner - The longitude and latitude of the bottom left corner of your floor plan.
- bottom_
right_ corner This property is required. GetFloor Plans Item Bottom Right Corner - The longitude and latitude of the bottom right corner of your floor plan.
- center
This property is required. GetFloor Plans Item Center - 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
This property is required. Sequence[GetFloor Plans Item Device] - List of devices for the floorplan
- floor_
plan_ id This property is required. str - Floor plan ID
- height
This property is required. float - The height of your floor plan.
- image_
extension This property is required. str - The format type of the image.
- image_
md5 This property is required. 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 This property is required. str - The url link for the floor plan image.
- image_
url_ expires_ at This property is required. str - The time the image url link will expire.
- name
This property is required. str - The name of your floor plan.
- top_
left_ corner This property is required. GetFloor Plans Item Top Left Corner - The longitude and latitude of the top left corner of your floor plan.
- top_
right_ corner This property is required. GetFloor Plans Item Top Right Corner - The longitude and latitude of the top right corner of your floor plan.
- width
This property is required. float - The width of your floor plan.
- bottom
Left Corner This property is required. Property Map - The longitude and latitude of the bottom left corner of your floor plan.
- bottom
Right Corner This property is required. Property Map - The longitude and latitude of the bottom right corner of your floor plan.
- center
This property is required. 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
This property is required. List<Property Map> - List of devices for the floorplan
- floor
Plan Id This property is required. String - Floor plan ID
- height
This property is required. Number - The height of your floor plan.
- image
Extension This property is required. String - The format type of the image.
- image
Md5 This property is required. 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.
- image
Url This property is required. String - The url link for the floor plan image.
- image
Url Expires At This property is required. String - The time the image url link will expire.
- name
This property is required. String - The name of your floor plan.
- top
Left Corner This property is required. Property Map - The longitude and latitude of the top left corner of your floor plan.
- top
Right Corner This property is required. Property Map - The longitude and latitude of the top right corner of your floor plan.
- width
This property is required. Number - The width of your floor plan.
GetFloorPlansItemBottomLeftCorner
GetFloorPlansItemBottomRightCorner
GetFloorPlansItemCenter
GetFloorPlansItemDevice
- Address
This property is required. string - Physical address of the device
- Details
This property is required. List<GetFloor Plans Item Device Detail> - Additional device information
- Firmware
This property is required. string - Firmware version of the device
- Imei
This property is required. string - IMEI of the device, if applicable
- Lan
Ip This property is required. string - LAN IP address of the device
- Lat
This property is required. double - Latitude of the device
- Lng
This property is required. double - Longitude of the device
- Mac
This property is required. string - MAC address of the device
- Model
This property is required. string - Model of the device
- Name
This property is required. string - Name of the device
- Network
Id This property is required. string - ID of the network the device belongs to
- Notes
This property is required. string - Notes for the device, limited to 255 characters
- Product
Type This property is required. string - Product type of the device
- Serial
This property is required. string - Serial number of the device
This property is required. List<string>- List of tags assigned to the device
- Address
This property is required. string - Physical address of the device
- Details
This property is required. []GetFloor Plans Item Device Detail - Additional device information
- Firmware
This property is required. string - Firmware version of the device
- Imei
This property is required. string - IMEI of the device, if applicable
- Lan
Ip This property is required. string - LAN IP address of the device
- Lat
This property is required. float64 - Latitude of the device
- Lng
This property is required. float64 - Longitude of the device
- Mac
This property is required. string - MAC address of the device
- Model
This property is required. string - Model of the device
- Name
This property is required. string - Name of the device
- Network
Id This property is required. string - ID of the network the device belongs to
- Notes
This property is required. string - Notes for the device, limited to 255 characters
- Product
Type This property is required. string - Product type of the device
- Serial
This property is required. string - Serial number of the device
This property is required. []string- List of tags assigned to the device
- address
This property is required. String - Physical address of the device
- details
This property is required. List<GetFloor Plans Item Device Detail> - Additional device information
- firmware
This property is required. String - Firmware version of the device
- imei
This property is required. String - IMEI of the device, if applicable
- lan
Ip This property is required. String - LAN IP address of the device
- lat
This property is required. Double - Latitude of the device
- lng
This property is required. Double - Longitude of the device
- mac
This property is required. String - MAC address of the device
- model
This property is required. String - Model of the device
- name
This property is required. String - Name of the device
- network
Id This property is required. String - ID of the network the device belongs to
- notes
This property is required. String - Notes for the device, limited to 255 characters
- product
Type This property is required. String - Product type of the device
- serial
This property is required. String - Serial number of the device
This property is required. List<String>- List of tags assigned to the device
- address
This property is required. string - Physical address of the device
- details
This property is required. GetFloor Plans Item Device Detail[] - Additional device information
- firmware
This property is required. string - Firmware version of the device
- imei
This property is required. string - IMEI of the device, if applicable
- lan
Ip This property is required. string - LAN IP address of the device
- lat
This property is required. number - Latitude of the device
- lng
This property is required. number - Longitude of the device
- mac
This property is required. string - MAC address of the device
- model
This property is required. string - Model of the device
- name
This property is required. string - Name of the device
- network
Id This property is required. string - ID of the network the device belongs to
- notes
This property is required. string - Notes for the device, limited to 255 characters
- product
Type This property is required. string - Product type of the device
- serial
This property is required. string - Serial number of the device
This property is required. string[]- List of tags assigned to the device
- address
This property is required. str - Physical address of the device
- details
This property is required. Sequence[GetFloor Plans Item Device Detail] - Additional device information
- firmware
This property is required. str - Firmware version of the device
- imei
This property is required. str - IMEI of the device, if applicable
- lan_
ip This property is required. str - LAN IP address of the device
- lat
This property is required. float - Latitude of the device
- lng
This property is required. float - Longitude of the device
- mac
This property is required. str - MAC address of the device
- model
This property is required. str - Model of the device
- name
This property is required. str - Name of the device
- network_
id This property is required. str - ID of the network the device belongs to
- notes
This property is required. str - Notes for the device, limited to 255 characters
- product_
type This property is required. str - Product type of the device
- serial
This property is required. str - Serial number of the device
This property is required. Sequence[str]- List of tags assigned to the device
- address
This property is required. String - Physical address of the device
- details
This property is required. List<Property Map> - Additional device information
- firmware
This property is required. String - Firmware version of the device
- imei
This property is required. String - IMEI of the device, if applicable
- lan
Ip This property is required. String - LAN IP address of the device
- lat
This property is required. Number - Latitude of the device
- lng
This property is required. Number - Longitude of the device
- mac
This property is required. String - MAC address of the device
- model
This property is required. String - Model of the device
- name
This property is required. String - Name of the device
- network
Id This property is required. String - ID of the network the device belongs to
- notes
This property is required. String - Notes for the device, limited to 255 characters
- product
Type This property is required. String - Product type of the device
- serial
This property is required. String - Serial number of the device
This property is required. List<String>- List of tags assigned to the device
GetFloorPlansItemDeviceDetail
GetFloorPlansItemTopLeftCorner
GetFloorPlansItemTopRightCorner
Package Details
- Repository
- meraki pulumi/pulumi-meraki
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
meraki
Terraform Provider.