Docs Packages
  1. Packages
  2. Cisco Meraki
  3. API Docs
  4. networks
  5. getFloorPlans
Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi
pulumi/pulumi-meraki

meraki.networks.getFloorPlans

Explore with Pulumi AI

meraki logo
Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi
pulumi/pulumi-meraki

    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)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: meraki:networks/getFloorPlans:getFloorPlans
  arguments:
    # arguments dictionary

    The following arguments are supported:

    FloorPlanId string
    floorPlanId path parameter. Floor plan ID
    NetworkId string
    networkId path parameter. Network ID
    FloorPlanId string
    floorPlanId path parameter. Floor plan ID
    NetworkId string
    networkId path parameter. Network ID
    floorPlanId String
    floorPlanId path parameter. Floor plan ID
    networkId String
    networkId path parameter. Network ID
    floorPlanId string
    floorPlanId path parameter. Floor plan ID
    networkId string
    networkId path parameter. Network ID
    floor_plan_id str
    floorPlanId path parameter. Floor plan ID
    network_id str
    networkId path parameter. Network ID
    floorPlanId String
    floorPlanId path parameter. Floor plan ID
    networkId 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 GetFloorPlansItem
    Items List<GetFloorPlansItem>
    Array of ResponseNetworksGetNetworkFloorPlans
    FloorPlanId string
    floorPlanId path parameter. Floor plan ID
    NetworkId string
    networkId path parameter. Network ID
    Id string
    The provider-assigned unique ID for this managed resource.
    Item GetFloorPlansItem
    Items []GetFloorPlansItem
    Array of ResponseNetworksGetNetworkFloorPlans
    FloorPlanId string
    floorPlanId path parameter. Floor plan ID
    NetworkId string
    networkId path parameter. Network ID
    id String
    The provider-assigned unique ID for this managed resource.
    item GetFloorPlansItem
    items List<GetFloorPlansItem>
    Array of ResponseNetworksGetNetworkFloorPlans
    floorPlanId String
    floorPlanId path parameter. Floor plan ID
    networkId String
    networkId path parameter. Network ID
    id string
    The provider-assigned unique ID for this managed resource.
    item GetFloorPlansItem
    items GetFloorPlansItem[]
    Array of ResponseNetworksGetNetworkFloorPlans
    floorPlanId string
    floorPlanId path parameter. Floor plan ID
    networkId string
    networkId path parameter. Network ID
    id str
    The provider-assigned unique ID for this managed resource.
    item GetFloorPlansItem
    items Sequence[GetFloorPlansItem]
    Array of ResponseNetworksGetNetworkFloorPlans
    floor_plan_id str
    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
    floorPlanId String
    floorPlanId path parameter. Floor plan ID
    networkId String
    networkId path parameter. Network ID

    Supporting Types

    GetFloorPlansItem

    BottomLeftCorner GetFloorPlansItemBottomLeftCorner
    The longitude and latitude of the bottom left corner of your floor plan.
    BottomRightCorner GetFloorPlansItemBottomRightCorner
    The longitude and latitude of the bottom right corner of your floor plan.
    Center GetFloorPlansItemCenter
    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<GetFloorPlansItemDevice>
    List of devices for the floorplan
    FloorPlanId string
    Floor plan ID
    Height double
    The height of your floor plan.
    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.
    TopLeftCorner GetFloorPlansItemTopLeftCorner
    The longitude and latitude of the top left corner of your floor plan.
    TopRightCorner GetFloorPlansItemTopRightCorner
    The longitude and latitude of the top right corner of your floor plan.
    Width double
    The width of your floor plan.
    BottomLeftCorner GetFloorPlansItemBottomLeftCorner
    The longitude and latitude of the bottom left corner of your floor plan.
    BottomRightCorner GetFloorPlansItemBottomRightCorner
    The longitude and latitude of the bottom right corner of your floor plan.
    Center GetFloorPlansItemCenter
    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 []GetFloorPlansItemDevice
    List of devices for the floorplan
    FloorPlanId string
    Floor plan ID
    Height float64
    The height of your floor plan.
    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.
    TopLeftCorner GetFloorPlansItemTopLeftCorner
    The longitude and latitude of the top left corner of your floor plan.
    TopRightCorner GetFloorPlansItemTopRightCorner
    The longitude and latitude of the top right corner of your floor plan.
    Width float64
    The width of your floor plan.
    bottomLeftCorner GetFloorPlansItemBottomLeftCorner
    The longitude and latitude of the bottom left corner of your floor plan.
    bottomRightCorner GetFloorPlansItemBottomRightCorner
    The longitude and latitude of the bottom right corner of your floor plan.
    center GetFloorPlansItemCenter
    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<GetFloorPlansItemDevice>
    List of devices for the floorplan
    floorPlanId String
    Floor plan ID
    height Double
    The height of your floor plan.
    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.
    topLeftCorner GetFloorPlansItemTopLeftCorner
    The longitude and latitude of the top left corner of your floor plan.
    topRightCorner GetFloorPlansItemTopRightCorner
    The longitude and latitude of the top right corner of your floor plan.
    width Double
    The width of your floor plan.
    bottomLeftCorner GetFloorPlansItemBottomLeftCorner
    The longitude and latitude of the bottom left corner of your floor plan.
    bottomRightCorner GetFloorPlansItemBottomRightCorner
    The longitude and latitude of the bottom right corner of your floor plan.
    center GetFloorPlansItemCenter
    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 GetFloorPlansItemDevice[]
    List of devices for the floorplan
    floorPlanId string
    Floor plan ID
    height number
    The height of your floor plan.
    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.
    topLeftCorner GetFloorPlansItemTopLeftCorner
    The longitude and latitude of the top left corner of your floor plan.
    topRightCorner GetFloorPlansItemTopRightCorner
    The longitude and latitude of the top right corner of your floor plan.
    width number
    The width of your floor plan.
    bottom_left_corner GetFloorPlansItemBottomLeftCorner
    The longitude and latitude of the bottom left corner of your floor plan.
    bottom_right_corner GetFloorPlansItemBottomRightCorner
    The longitude and latitude of the bottom right corner of your floor plan.
    center GetFloorPlansItemCenter
    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[GetFloorPlansItemDevice]
    List of devices for the floorplan
    floor_plan_id str
    Floor plan ID
    height float
    The height of your floor plan.
    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.
    top_left_corner GetFloorPlansItemTopLeftCorner
    The longitude and latitude of the top left corner of your floor plan.
    top_right_corner GetFloorPlansItemTopRightCorner
    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.
    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.
    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.

    GetFloorPlansItemBottomLeftCorner

    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

    GetFloorPlansItemBottomRightCorner

    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

    GetFloorPlansItemCenter

    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

    GetFloorPlansItemDevice

    Address string
    Physical address of the device
    Details List<GetFloorPlansItemDeviceDetail>
    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 []GetFloorPlansItemDeviceDetail
    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<GetFloorPlansItemDeviceDetail>
    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 GetFloorPlansItemDeviceDetail[]
    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[GetFloorPlansItemDeviceDetail]
    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

    GetFloorPlansItemDeviceDetail

    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

    GetFloorPlansItemTopLeftCorner

    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

    GetFloorPlansItemTopRightCorner

    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

    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.4 published on Friday, Jun 14, 2024 by Pulumi
    pulumi/pulumi-meraki