Set-PlaceV3

Use the Set-PlaceV3 cmdlet to update metadata about your desks, rooms, workspaces, sections, floors, or buildings within your Places directory.

Syntax

Building

Set-PlaceV3
 [-Identity]
 [-DisplayName]
 [-Label]
 [-IsWheelChairAccessible]
 [-GeoCoordinates]
 [-Phone]
 [-Street]
 [-City]
 [-State]
 [-PostalCode]
 [-CountryOrRegion]
 [-ResourceLinks]

Floor

Set-PlaceV3
 [-Identity]
 [-DisplayName]
 [-ParentId]
 [-Label]
 [-SortOrder]

Section

A section is a grouping of spaces within a floor, for example, a neighborhood. Desks and workspaces are required to be parented to a section. Rooms can also optionally be parented to a section or they can be directly parented to a floor.

Set-PlaceV3
 [-Identity]
 [-DisplayName]
 [-ParentId]
 [-Label]

Desk

Desks are a newly introduced entity type in Microsoft Places, representing individual desk units. Each desk includes a Mode property that specifies how the desk can be booked. For more information, refer to the mode section below.

For Desk, There are some dependencies between mode and mailbox as follows:

• If the Mode property is not defined, the desk defaults to Unavailable, and no desk mailbox is created automatically.
• For desks set to Reservable or DropIn mode, a desk mailbox is required. One is automatically created when the desk is provisioned. Alternatively, you can link an existing mailbox by specifying the EmailAddress in the Mailbox parameter.
• For desks in Assigned or Unavailable mode, linking a mailbox is optional, and no mailbox is created by default. However, you may manually associate these desks with custom mailboxes if needed.
• If no mode is configured initially, the desk remains in Unavailable mode. Linking a mailbox afterward does not automatically update the desk’s mode.

Unlike Room or Workspace types, desks are not automatically provisioned by simply creating a mailbox. Additionally, metadata such as Capacity or DisplayName is not synchronized with mailbox properties. The mailbox is used primarily by the reservation engine, while metadata is read from the Places Directory.

Set-PlaceV3
 [-Identity]
 [-DisplayName]
 [-ParentId]
 [-Label]
 [-IsWheelChairAccessible]
 [-DisplayDeviceName]
 [-Tags]
 [-Mailbox]
 [-Mode]

Room

Set-PlaceV3 supports legacy location parameters that are already available in the Exchange Set-Place cmdlet. However, once a room is linked to a floor or building using the -ParentId parameter, location details (Street and City) should be managed at the building level—not on the individual room or workspace.

Set-PlaceV3
 [-Identity]
 [-DisplayName]
 [-ParentId]
 [-Label]
 [-Capacity]
 [-IsWheelChairAccessible]
 [-AudioDeviceName]
 [-DisplayDeviceName]
 [-VideoDeviceName]
 [-MTREnabled]
 [-GeoCoordinates]
 [-Phone]
 [-Tags]

Workspace

Set-PlaceV3 supports legacy location parameters that are already available in the Exchange Set-Place cmdlet. However, once a workspace is linked to a section using the -ParentId parameter, location details (Street and City) should be managed at the building level—not on the individual room or workspace.

Workspace supports Mode property. The details for the same are documented in Mode parameter section.

Set-PlaceV3
 [-Identity]
 [-DisplayName]
 [-ParentId]
 [-Label]
 [-Capacity]
 [-IsWheelChairAccessible]
 [-AudioDeviceName]
 [-DisplayDeviceName]
 [-VideoDeviceName]
 [-MTREnabled]
 [-GeoCoordinates]
 [-Phone]
 [-Tags]
 [-Mode]

Description

Places depends on a fully set up hierarchy among your rooms/workspaces, floors, and buildings. Once buildings and floors are created, you can link them using parentId. A room should have a parent floor or section. A workspace or desk should have a parent section. A section should have a parent floor. A floor should have a parent building.

You need to be assigned permissions before you can run this cmdlet. You must have either the Exchange Admin role or the Places TenantPlacesManagement role.

Examples

Example 1

This example sets up the directory hierarchy for a room, floor, and building.

In this example, the floor's PlaceId is f12172b6-195d-4e6e-8f4f-eb72e41de99a, and the building's PlaceId is daa2f89b-75c4-4eb7-adcc-ff249233338d.

Set-PlaceV3 -Identity 'room@contoso.com' -ParentId f12172b6-195d-4e6e-8f4f-eb72e41de99a
Set-PlaceV3 -Identity f12172b6-195d-4e6e-8f4f-eb72e41de99a -ParentId daa2f89b-75c4-4eb7-adcc-ff249233338d

Example 2

This example updates a building's address.

Set-PlaceV3 -Identity f12172b6-195d-4e6e-8f4f-eb72e41de99a -CountryOrRegion US -State WA -City Redmond -Street 'Street 3' -PostalCode 98052

Example 3

This example updates a building's geo coordinates.

Set-PlaceV3 -Identity f12172b6-195d-4e6e-8f4f-eb72e41de99a -GeoCoordinates "47.644125;-122.122411"

Example 4

This example updates the resource links for a building with resource links. The entire set is replaced on update. To add or remove a value, be sure to include previous values that should be persisted.

Set-PlaceV3 -Identity f12172b6-195d-4e6e-8f4f-eb72e41de99a -ResourceLinks @{name="TestLink";value="https://contoso.com/";type="Url"}

Example 5

This example creates a desk mailbox and assigns it to an existing desk entity. Please note that you need to have installed ExchangeOnlineManagement module and ran the Connect-ExchangeOnline cmdlet before running the following:

$mbx = New-Mailbox -Room <DeskMailboxName>
Set-Mailbox $mbx.Identity -Type Desk -HiddenFromAddressListsEnabled $true
Set-PlaceV3 {DeskId} -Mailbox $mbx.EmailAddress

Example 6

This example updates the mode value to DropIn mode.

Set-PlaceV3 -Identity f12172b6-195d-4e6e-8f4f-eb72e41de99a -Mode @{Name='DropIn'}

Example 7

This example updates the mode value to Assigned mode.

Note that even if the desk is already an assigned mode desk, the change is only the metadata field. A whole new mode object needs to be created and to replace the old one.

$modemetadata = New-Object 'System.Collections.Generic.Dictionary[String,object]'
$modemetadata.Add("AssignedPersonEmailAddress","someUserEmailAddress")
Set-PlaceV3 -Identity f12172b6-195d-4e6e-8f4f-eb72e41de99a Mode @{Name='Assigned';Metadata=$modemetadata}

Parameters

-Identity

The identity parameter specifies the place that you want to update. You can use any value that uniquely identifies a place.

For example, for places based on a mailbox (conference rooms and workspaces):

• Name [deprecated]
• Alias [deprecated]
• Distinguished name (DN) [deprecated]
• Canonical DN [deprecated]
• GUID [deprecated]
• Email address

For example, for places that aren't based on a mailbox (buildings, floors, sections and desks):

• Name
• GUID

-AudioDeviceName, and -VideoDeviceName

These parameters specify the name of the audio, and video devices in the room. If the value contains spaces, enclose the value in quotation marks (").

The default value is blank ($null). To indicate that this room has no audio, or video device, use the value $null for the parameter.

-Building

The Building parameter specifies the building name or building number that the room is in. If the value contains spaces, enclose the value in quotation marks (").

-Capacity

The Capacity parameter specifies the capacity of the room or workspace. A valid value is an integer.

-City

The City parameter specifies the building's city. If the value contains spaces, enclose the value in quotation marks ("). The maximum length is 200 characters.

-CountryOrRegion

The CountryOrRegion parameter specifies the building's country or region. A valid value is a valid ISO 3166-1 two-letter country code (for example, AU for Australia) or the corresponding friendly name for the country (which might be different from the official ISO 3166 Maintenance Agency short name).

A reference for two-letter country codes is available at Country Codes List.

-Label

The Label parameter specifies a descriptive label for the place. If the value contains spaces, enclose the value in quotation marks ("). The maximum length is 200 characters.

For rooms and workspaces, the command updates the value named -Label in Exchange Set-Place.

-DisplayDeviceName

The DisplayDeviceName parameter specifies the name of the display device in the place (room, desk, or workspace). If the value contains spaces, enclose the value in quotation marks (").

The default value is blank ($null). To indicate that this place has no display device, use the value $null for this parameter.

-FloorLabel

The FloorLabel parameter specifies a descriptive label for the floor. If the value contains spaces, enclose the value in quotation marks (").

-Floor

The Floor parameter specifies the sort order of the floor within a particular building.

-GeoCoordinates

The GeoCoordinates parameter specifies the building's location in latitude, longitude, and (optionally) altitude coordinates. A valid value for this parameter uses one of the following formats:

• Latitude and longitude: For example, "47.644125;-122.122411"
• Latitude, longitude, and altitude: For example, "47.644125;-122.122411;161.432"

If period separators don't work for you, use commas instead.

-IsWheelChairAccessible

The IsWheelChairAccessible parameter specifies whether the place is wheelchair accessible. Valid values are:

• $true: The place is wheelchair accessible.
• $false: The place isn't wheelchair accessible. This is the default value.

-MTREnabled

The MTREnabled parameter identifies the room as configured with a Microsoft Teams room system. You can add Teams room systems as audio sources in Teams meetings that involve the room. Valid values are:

• $true: The room has a Teams room system. You can add the Teams room system to Microsoft Teams meetings when selecting to join a meeting with room audio.
• $false: The room doesn't have a Teams room system. Users can join Teams meetings using their PC or mobile device audio instead of using room audio. This is the default value.

For more information about Microsoft Teams Rooms, see Microsoft Teams Rooms.

-DisplayName

The DisplayName parameter specifies the display name of the place. The maximum length is 200 characters. To update the display name of a room or workspace place that has an associated SMTP address, you need Place Administrator, Exchange Administrator or Global Admin role.

-ParentId

The ParentId parameter specifies the ID of a Place in the parent location hierarchy in Microsoft Places. A room should have a parent floor or section. A workspace or desk should have a parent section. A section should have a parent floor. A floor should have a parent building.

-PostalCode

The PostalCode parameter specifies the building's postal code.

-ResourceLinks

The ResourceLinks parameter specifies external links or Teams app IDs that should be associated to this building, such as a dining menu, a link to services or a Teams app for visitor management. For more information on how to set up services in Places, see Services in Places.

The value must be provided as an array of links, as shown in Example 4. Each link should contain the following properties: Name, Value, and Type. For example, a link would be written as @{name="TestLink"; value="https://contoso.com/"; type="Url"}.

• Name

  • This string is used to show how your link or app name is displayed in the Places app.

  • The maximum length is 200 characters.

• Value

  • This value should be either a url link or a Teams app ID. Teams app IDs can be found in the App Details page of the app in the Manage apps page in Teams admin center.

  • The maximum length is 1,000 characters.

• Type must be one of the supported types:

  • Url - indicates that this is a url link.

  • MetaOsApp - indicates that this link is a Teams app.

-SortOrder

The SortOrder parameter specifies the sort order of the floor. For example, a floor might be named "Lobby" with a sort order of 0 to show this floor first in ordered lists.

-State

The State parameter specifies the building's state or province. The maximum length is 200 characters.

-Street

The Street parameter specifies the building's physical address. The maximum length is 200 characters.

-Mode

The Mode parameter defines how a place is intended to be used or booked. Currently, mode is only available for desks and desk pools(workspaces).

Currently, there are four modes in total.

• Reservable- Reservable desks are the desks that are configured to be booked in advance or on-the-spot.
• Drop-in- The desk is available for on-the-spot use and cannot be reserved in advance. You can use the capability from Microsoft Teams to link the peripheral devices present on these desks to the individual desk object in the directory.
• Assigned - An assigned desk is permanently linked to a specific user and cannot be booked by others. Every assigned desk must always have a designated user.
• Unavailable- The desk is not available for reservation due to maintenance or for any other reason.

The mode value should contain the following properties: Name and Metadata, as shown in Example 6. Name is string and metadata is a dictionary object.

• Name: The Name field specifies the active mode for a place. It uses an enumeration value, and the available options vary by place type. For desks, supported modes include Reservable, DropIn, Assigned and Unavailable. For desk pools, the supported modes are Reservable, DropIn and Unavailable.

• Metadata: The Metadata field is a dictionary used to store additional information relevant to the selected mode. This metadata supports business logic tied to specific booking scenarios.

  • Places in Reservable and DropIn modes do not support any metadata fields.
  • Places in Unavailable mode support a Reason field (string) that explains why the desk is unavailable. Values include New for newly created desks and Maintenance for Places undergoing service.
  • Assigned mode supports two metadata fields: AssignedPersonEmailAddress and AssignedPersonId. These identify the user assigned to the desk. Providing either field is sufficient to enable the assigned mode.

-Tags

The Tags parameter specifies additional features of the room (for example, details like the type of view or furniture type). There's no maximum length currently.

You can specify multiple labels separated by commas. If the labels contains spaces, enclose the values in quotation marks: "Label 1","Label 2",..."Label N".

Troubleshooting

I am receiving a permission denied error.

Set-PlaceV3 requires one of the following roles: TenantPlacesManagement, GlobalAdmin, or MailRecepients. Because roles can be assigned in different ways, the following are the supported ways to assign role permissions:

• If the permission is assigned through Exchange Admin Center (which only supports permanent permissions), you should have no issues with using the Places cmdlets. It wouldn't be expected for you to see a Permission Denied error.
• If the permission is assigned through Entra directly to the user (as a permanent or a temporary role), you should have no issues with using the Places cmdlets. It wouldn't be expected for you to see a Permission Denied error. However, there might be some delay in the sync between Entra and Exchange.
• If the permission is assigned through Entra to a group in Entra, which the user is a part of, this isn't supported by Exchange and the role-through-group won't be respected. Exchange cmdlets and Places cmdlets will both fail with permission denied. This expected behavior is described here.

I assigned a ParentId to a resource, but I don't see it yet in Places Finder.

It can take up to 24 hours for the correlation between the resource and its parent Floor to appear in Places experiences. We're working on eliminating this delay.

How do I set a photo on a resource?

The Set-UserPhoto was deprecated in April 2024. We're working on adding a parameter to this cmdlet to set a photo on rooms and workspaces when using Set-PlaceV3. In the meantime, please follow these instructions set the photo on a room or workspace.

It is not currently possible to set photos on a building or on a floor.