New-Place
Use the New-Place cmdlet to create buildings, floors, sections, or desks within your Places directory.
Note
To create rooms or workspaces, you need to continue to use the New-Mailbox cmdlet documented here.
Syntax
Building
New-Place
[-DisplayName]
[-Type]
[-Label]
[-PostalCode]
[-CountryOrRegion]
[-State]
[-City]
[-Street]
[-GeoCoordinates]
[-ResourceLinks]
[-Tags]
Floor
New-Place
[-DisplayName]
[-Type]
[-Label]
[-ParentId]
[-SortOrder]
[-Tags]
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.
New-Place
[-DisplayName]
[-Type]
[-Label]
[-ParentId]
Desk
Desks are a new entity type in Places, which represent individual desks. These objects can be either bookable or non bookable (default).
To make a desk bookable, you are required to create a Desk mailbox and associate it with the desk object by passing the mailbox Alias to the Mailbox parameter of Set-PlaceV3. Note that unlike the Room/Workspace types, desks are not implicitly provisioned by creating the mailbox alone. Also, the metadata (such as the Capacity or DisplayName fields) is not kept in sync with mailbox metadata. Mailbox is primarily required for the reservation engine only and metadata is read from Places Directory.
New-Place
[-DisplayName]
[-Type]
[-Label]
[-ParentId]
[-GeoCoordinates]
[-Mailbox]
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.
Caution
You might find additional parameters in the PowerShell cmdlet, but those are not currently supported. It is not recommended to use any parameter that is not documented on this page.
Examples
Example 1
This example creates a new building and a floor within that building.
New-Place -Type Building -Name 'Building 3'
After Building 3 is created successfully, read its PlaceId to use when setting the ParentId on the floors.
New-Place -Type Floor -Name 'Lobby' -ParentId f12172b6-195d-4e6e-8f4f-eb72e41de99a
New-Place -Type Floor -Name '1' -ParentId f12172b6-195d-4e6e-8f4f-eb72e41de99a
Example 2
This example creates a new building with address information.
New-Place -Name 'Building 3' -Type Building -Description 'Building 3 in North of Redmond Campus' -CountryOrRegion US -State WA -City Redmond -Street 'Street 3' -PostalCode 98052
Example 3
This example creates a new building with resource links.
New-Place -Name 'Building 3' -Type Building -ResourceLinks @{name="TestLink";value="https://contoso.com/";type="Url"}'
Example 4
This example creates a section parented to a floor, then creates a desk mailbox and assigns it to an existing desk entity. Note that you have ExchangeOnlineManagement module installed and run the Connect-ExchangeOnline cmdlet before running this sample script.
$mbx = New-Mailbox -Room <DeskMailboxName>
Set-Mailbox $mbx.Identity -Type Desk -HiddenFromAddressListsEnabled $true
$section = New-Place -Name 'Section1' -Type Section -ParentId 'someFloorId'
New-Place -Name 'Desk101' -Type Desk -ParentId $section.PlaceId -Mailbox $mbx.Alias
Parameters
-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.
| Attribute | Description |
|---|---|
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-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.
Address information is used by the Places Explore page to show nearby buildings.
| Attribute | Description |
|---|---|
| Type: | CountryInfo |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-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.
| Attribute | Description |
|---|---|
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-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"
Note
If period separators don't work for you, use commas instead.
| Attribute | Description |
|---|---|
| Type: | GeoCoordinates |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DisplayName
The DisplayName parameter specifies the display name of the place. The maximum length is 200 characters.
A building's display name is visible:
- In Outlook, when users are setting up their work hours and location, they're able to select a building.
- In Places Explore page that shows who else is in the same building, nearby buildings, and more.
- In Places Finder, as a filter when searching for a conference room or workspace.
A floor's display name is visible in Places Finder as a filter when searching for a conference room or workspace.
| Attribute | Description |
|---|---|
| Type: | String |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-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.
Note
If you need backward compatibility with Outlook Roomfinder, make sure to also update the "Floor"/"FloorLabel" properties, in parallel with parenting the room to the floor entity. Places Finder uses the new hierarchy while Outlook Roomfinder continues to use the legacy "Floor" and "FloorLabel" objects. You also need to make sure the room is associated with a Roomlist, as documented here Configure rooms and workspaces for Room Finder in Outlook.
| Attribute | Description |
|---|---|
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PostalCode
The PostalCode parameter specifies the building's postal code. The maximum length is 200 characters.
| Attribute | Description |
|---|---|
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceLinks
The ResourceLinks parameter specifies external links or Teams app IDs that should be associated with 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 1000 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.
Note
The entire set is replaced. To add or remove a value, be sure to include previous values that should be persisted.
| Attribute | Description |
|---|---|
| Type: | ResourceLink[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-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.
| Attribute | Description |
|---|---|
| Type: | System.Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-State
The State parameter specifies the building's state or province. The maximum length is 200 characters.
| Attribute | Description |
|---|---|
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Street
The Street parameter specifies the building's physical address. The maximum length is 200 characters.
| Attribute | Description |
|---|---|
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Tags
The Tags parameter specifies other 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".
Note
The entire set is replaced on update. To add or remove a value, be sure to include previous values that should be persisted.
| Attribute | Description |
|---|---|
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Type
The Type parameter specifies the type of the place that is being created. Valid values are:
- Building
- Floor
- Section
- Desk
| Attribute | Description |
|---|---|
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |