|
| 1 | +--- |
| 2 | +external help file: |
| 3 | +Module Name: Microsoft.Graph.Calendar |
| 4 | +online version: https://docs.microsoft.com/en-us/powershell/module/microsoft.graph.calendar/get-mgplace |
| 5 | +schema: 2.0.0 |
| 6 | +--- |
| 7 | + |
| 8 | +# Get-MgPlace |
| 9 | + |
| 10 | +## SYNOPSIS |
| 11 | +Get the properties and relationships of a place object specified by either its ID or email address. |
| 12 | +The **place** object can be one of the following types: Both **room** and **roomList** are derived from the place object. |
| 13 | + |
| 14 | +## SYNTAX |
| 15 | + |
| 16 | +### List1 (Default) |
| 17 | +``` |
| 18 | +Get-MgPlace [-ExpandProperty <String[]>] [-Filter <String>] [-Property <String[]>] [-Search <String>] |
| 19 | + [-Skip <Int32>] [-Sort <String[]>] [-Top <Int32>] [-All] [-CountVariable <String>] [-PageSize <Int32>] |
| 20 | + [<CommonParameters>] |
| 21 | +``` |
| 22 | + |
| 23 | +### Get1 |
| 24 | +``` |
| 25 | +Get-MgPlace -PlaceId <String> [-ExpandProperty <String[]>] [-Property <String[]>] [<CommonParameters>] |
| 26 | +``` |
| 27 | + |
| 28 | +### GetViaIdentity1 |
| 29 | +``` |
| 30 | +Get-MgPlace -InputObject <ICalendarIdentity> [-ExpandProperty <String[]>] [-Property <String[]>] |
| 31 | + [<CommonParameters>] |
| 32 | +``` |
| 33 | + |
| 34 | +## DESCRIPTION |
| 35 | +Get the properties and relationships of a place object specified by either its ID or email address. |
| 36 | +The **place** object can be one of the following types: Both **room** and **roomList** are derived from the place object. |
| 37 | + |
| 38 | +## EXAMPLES |
| 39 | + |
| 40 | +### Example 1: Using the Get-MgPlace Cmdlet |
| 41 | +```powershell |
| 42 | +Import-Module Microsoft.Graph.Calendar |
| 43 | +Get-MgPlace -PlaceId $placeId |
| 44 | +``` |
| 45 | + |
| 46 | +This example shows how to use the Get-MgPlace Cmdlet. |
| 47 | +To learn about permissions for this resource, see the [permissions reference](/graph/permissions-reference). |
| 48 | + |
| 49 | +### Example 2: Using the Get-MgPlace Cmdlet |
| 50 | +```powershell |
| 51 | +Import-Module Microsoft.Graph.Calendar |
| 52 | +Get-MgPlace -PlaceId $placeId |
| 53 | +``` |
| 54 | + |
| 55 | +This example shows how to use the Get-MgPlace Cmdlet. |
| 56 | +To learn about permissions for this resource, see the [permissions reference](/graph/permissions-reference). |
| 57 | + |
| 58 | +### Example 3: Using the Get-MgPlace Cmdlet |
| 59 | +```powershell |
| 60 | +Import-Module Microsoft.Graph.Calendar |
| 61 | +Get-MgPlace -PlaceId $placeId |
| 62 | +``` |
| 63 | + |
| 64 | +This example shows how to use the Get-MgPlace Cmdlet. |
| 65 | +To learn about permissions for this resource, see the [permissions reference](/graph/permissions-reference). |
| 66 | + |
| 67 | +### Example 4: Using the Get-MgPlace Cmdlet |
| 68 | +```powershell |
| 69 | +Import-Module Microsoft.Graph.Calendar |
| 70 | +Get-MgPlace -PlaceId $placeId |
| 71 | +``` |
| 72 | + |
| 73 | +This example shows how to use the Get-MgPlace Cmdlet. |
| 74 | +To learn about permissions for this resource, see the [permissions reference](/graph/permissions-reference). |
| 75 | + |
| 76 | +## PARAMETERS |
| 77 | + |
| 78 | +### -All |
| 79 | +List all pages. |
| 80 | + |
| 81 | +```yaml |
| 82 | +Type: System.Management.Automation.SwitchParameter |
| 83 | +Parameter Sets: List1 |
| 84 | +Aliases: |
| 85 | + |
| 86 | +Required: False |
| 87 | +Position: Named |
| 88 | +Default value: None |
| 89 | +Accept pipeline input: False |
| 90 | +Accept wildcard characters: False |
| 91 | +``` |
| 92 | +
|
| 93 | +### -CountVariable |
| 94 | +Specifies a count of the total number of items in a collection. |
| 95 | +By default, this variable will be set in the global scope. |
| 96 | +
|
| 97 | +```yaml |
| 98 | +Type: System.String |
| 99 | +Parameter Sets: List1 |
| 100 | +Aliases: CV |
| 101 | + |
| 102 | +Required: False |
| 103 | +Position: Named |
| 104 | +Default value: None |
| 105 | +Accept pipeline input: False |
| 106 | +Accept wildcard characters: False |
| 107 | +``` |
| 108 | +
|
| 109 | +### -ExpandProperty |
| 110 | +Expand related entities |
| 111 | +
|
| 112 | +```yaml |
| 113 | +Type: System.String[] |
| 114 | +Parameter Sets: (All) |
| 115 | +Aliases: Expand |
| 116 | + |
| 117 | +Required: False |
| 118 | +Position: Named |
| 119 | +Default value: None |
| 120 | +Accept pipeline input: False |
| 121 | +Accept wildcard characters: False |
| 122 | +``` |
| 123 | +
|
| 124 | +### -Filter |
| 125 | +Filter items by property values |
| 126 | +
|
| 127 | +```yaml |
| 128 | +Type: System.String |
| 129 | +Parameter Sets: List1 |
| 130 | +Aliases: |
| 131 | + |
| 132 | +Required: False |
| 133 | +Position: Named |
| 134 | +Default value: None |
| 135 | +Accept pipeline input: False |
| 136 | +Accept wildcard characters: False |
| 137 | +``` |
| 138 | +
|
| 139 | +### -InputObject |
| 140 | +Identity Parameter |
| 141 | +To construct, please use Get-Help -Online and see NOTES section for INPUTOBJECT properties and create a hash table. |
| 142 | +
|
| 143 | +```yaml |
| 144 | +Type: Microsoft.Graph.PowerShell.Models.ICalendarIdentity |
| 145 | +Parameter Sets: GetViaIdentity1 |
| 146 | +Aliases: |
| 147 | + |
| 148 | +Required: True |
| 149 | +Position: Named |
| 150 | +Default value: None |
| 151 | +Accept pipeline input: True (ByValue) |
| 152 | +Accept wildcard characters: False |
| 153 | +``` |
| 154 | +
|
| 155 | +### -PageSize |
| 156 | +Sets the page size of results. |
| 157 | +
|
| 158 | +```yaml |
| 159 | +Type: System.Int32 |
| 160 | +Parameter Sets: List1 |
| 161 | +Aliases: |
| 162 | + |
| 163 | +Required: False |
| 164 | +Position: Named |
| 165 | +Default value: None |
| 166 | +Accept pipeline input: False |
| 167 | +Accept wildcard characters: False |
| 168 | +``` |
| 169 | +
|
| 170 | +### -PlaceId |
| 171 | +key: id of place |
| 172 | +
|
| 173 | +```yaml |
| 174 | +Type: System.String |
| 175 | +Parameter Sets: Get1 |
| 176 | +Aliases: |
| 177 | + |
| 178 | +Required: True |
| 179 | +Position: Named |
| 180 | +Default value: None |
| 181 | +Accept pipeline input: False |
| 182 | +Accept wildcard characters: False |
| 183 | +``` |
| 184 | +
|
| 185 | +### -Property |
| 186 | +Select properties to be returned |
| 187 | +
|
| 188 | +```yaml |
| 189 | +Type: System.String[] |
| 190 | +Parameter Sets: (All) |
| 191 | +Aliases: Select |
| 192 | + |
| 193 | +Required: False |
| 194 | +Position: Named |
| 195 | +Default value: None |
| 196 | +Accept pipeline input: False |
| 197 | +Accept wildcard characters: False |
| 198 | +``` |
| 199 | +
|
| 200 | +### -Search |
| 201 | +Search items by search phrases |
| 202 | +
|
| 203 | +```yaml |
| 204 | +Type: System.String |
| 205 | +Parameter Sets: List1 |
| 206 | +Aliases: |
| 207 | + |
| 208 | +Required: False |
| 209 | +Position: Named |
| 210 | +Default value: None |
| 211 | +Accept pipeline input: False |
| 212 | +Accept wildcard characters: False |
| 213 | +``` |
| 214 | +
|
| 215 | +### -Skip |
| 216 | +Skip the first n items |
| 217 | +
|
| 218 | +```yaml |
| 219 | +Type: System.Int32 |
| 220 | +Parameter Sets: List1 |
| 221 | +Aliases: |
| 222 | + |
| 223 | +Required: False |
| 224 | +Position: Named |
| 225 | +Default value: None |
| 226 | +Accept pipeline input: False |
| 227 | +Accept wildcard characters: False |
| 228 | +``` |
| 229 | +
|
| 230 | +### -Sort |
| 231 | +Order items by property values |
| 232 | +
|
| 233 | +```yaml |
| 234 | +Type: System.String[] |
| 235 | +Parameter Sets: List1 |
| 236 | +Aliases: OrderBy |
| 237 | + |
| 238 | +Required: False |
| 239 | +Position: Named |
| 240 | +Default value: None |
| 241 | +Accept pipeline input: False |
| 242 | +Accept wildcard characters: False |
| 243 | +``` |
| 244 | +
|
| 245 | +### -Top |
| 246 | +Show only the first n items |
| 247 | +
|
| 248 | +```yaml |
| 249 | +Type: System.Int32 |
| 250 | +Parameter Sets: List1 |
| 251 | +Aliases: Limit |
| 252 | + |
| 253 | +Required: False |
| 254 | +Position: Named |
| 255 | +Default value: None |
| 256 | +Accept pipeline input: False |
| 257 | +Accept wildcard characters: False |
| 258 | +``` |
| 259 | +
|
| 260 | +### CommonParameters |
| 261 | +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). |
| 262 | +
|
| 263 | +## INPUTS |
| 264 | +
|
| 265 | +### Microsoft.Graph.PowerShell.Models.ICalendarIdentity |
| 266 | +
|
| 267 | +## OUTPUTS |
| 268 | +
|
| 269 | +### Microsoft.Graph.PowerShell.Models.IMicrosoftGraphPlace1 |
| 270 | +
|
| 271 | +## NOTES |
| 272 | +
|
| 273 | +ALIASES |
| 274 | +
|
| 275 | +COMPLEX PARAMETER PROPERTIES |
| 276 | +
|
| 277 | +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. |
| 278 | +
|
| 279 | +
|
| 280 | +INPUTOBJECT `<ICalendarIdentity>`: Identity Parameter |
| 281 | + - `[AttachmentId <String>]`: key: id of attachment |
| 282 | + - `[CalendarGroupId <String>]`: key: id of calendarGroup |
| 283 | + - `[CalendarId <String>]`: key: id of calendar |
| 284 | + - `[CalendarPermissionId <String>]`: key: id of calendarPermission |
| 285 | + - `[EventId <String>]`: key: id of event |
| 286 | + - `[EventId1 <String>]`: key: id of event |
| 287 | + - `[EventId2 <String>]`: key: id of event |
| 288 | + - `[ExtensionId <String>]`: key: id of extension |
| 289 | + - `[GroupId <String>]`: key: id of group |
| 290 | + - `[MultiValueLegacyExtendedPropertyId <String>]`: key: id of multiValueLegacyExtendedProperty |
| 291 | + - `[PlaceId <String>]`: key: id of place |
| 292 | + - `[SingleValueLegacyExtendedPropertyId <String>]`: key: id of singleValueLegacyExtendedProperty |
| 293 | + - `[UserId <String>]`: key: id of user |
| 294 | + |
| 295 | +## RELATED LINKS |
| 296 | + |
0 commit comments