Runs the command in a mode that only reports what would happen without performing the actions.
Parameter properties
Type:
System.Management.Automation.SwitchParameter
Supports wildcards:
False
DontShow:
False
Aliases:
wi
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters.
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.
BODYPARAMETER <IMicrosoftGraphWorkHoursAndLocationsSetting>: workHoursAndLocationsSetting
[(Any) <Object>]: This indicates any property can be added to this object.
[Id <String>]: The unique identifier for an entity.
Read-only.
[MaxSharedWorkLocationDetails <String>]: maxWorkLocationDetails
[Occurrences <IMicrosoftGraphWorkPlanOccurrence[]>]: Collection of work plan occurrences.
[Id <String>]: The unique identifier for an entity.
Read-only.
[End <IMicrosoftGraphDateTimeZone>]: dateTimeTimeZone
[(Any) <Object>]: This indicates any property can be added to this object.
[DateTime <String>]: A single point of time in a combined date and time representation ({date}T{time}).
For example, '2019-04-16T09:00:00'.
[TimeZone <String>]: Represents a time zone, for example, 'Pacific Standard Time'.
See below for possible values.
[PlaceId <String>]: Identifier of a place from the Microsoft Graph Places Directory API.
Only applicable when workLocationType is set to office.
[RecurrenceId <String>]: The identifier of the parent recurrence pattern that generated this occurrence.
The value is null for time-off occurrences because they don't have a parent recurrence.
[Start <IMicrosoftGraphDateTimeZone>]: dateTimeTimeZone
[TimeOffDetails <IMicrosoftGraphTimeOffDetails>]: timeOffDetails
[(Any) <Object>]: This indicates any property can be added to this object.
[IsAllDay <Boolean?>]: Indicates whether the time-off entry spans the entire day.
[Subject <String>]: The subject or reason for the time-off entry.
[WorkLocationType <String>]: workLocationType
[Recurrences <IMicrosoftGraphWorkPlanRecurrence[]>]: Collection of recurring work plans defined by the user.
[Id <String>]: The unique identifier for an entity.
Read-only.
[End <IMicrosoftGraphDateTimeZone>]: dateTimeTimeZone
[PlaceId <String>]: Identifier of a place from the Microsoft Graph Places Directory API.
Only applicable when workLocationType is set to office.
[Recurrence <IMicrosoftGraphPatternedRecurrence>]: patternedRecurrence
[(Any) <Object>]: This indicates any property can be added to this object.
[Pattern <IMicrosoftGraphRecurrencePattern>]: recurrencePattern
[(Any) <Object>]: This indicates any property can be added to this object.
[DayOfMonth <Int32?>]: The day of the month on which the event occurs.
Required if type is absoluteMonthly or absoluteYearly.
[DaysOfWeek <String[]>]: A collection of the days of the week on which the event occurs.
The possible values are: sunday, monday, tuesday, wednesday, thursday, friday, saturday.
If type is relativeMonthly or relativeYearly, and daysOfWeek specifies more than one day, the event falls on the first day that satisfies the pattern.
Required if type is weekly, relativeMonthly, or relativeYearly.
[FirstDayOfWeek <String>]: dayOfWeek
[Index <String>]: weekIndex
[Interval <Int32?>]: The number of units between occurrences, where units can be in days, weeks, months, or years, depending on the type.
Required.
[Month <Int32?>]: The month in which the event occurs.
This is a number from 1 to 12.
[Type <String>]: recurrencePatternType
[Range <IMicrosoftGraphRecurrenceRange>]: recurrenceRange
[(Any) <Object>]: This indicates any property can be added to this object.
[EndDate <DateTime?>]: The date to stop applying the recurrence pattern.
Depending on the recurrence pattern of the event, the last occurrence of the meeting may not be this date.
Required if type is endDate.
[NumberOfOccurrences <Int32?>]: The number of times to repeat the event.
Required and must be positive if type is numbered.
[RecurrenceTimeZone <String>]: Time zone for the startDate and endDate properties.
Optional.
If not specified, the time zone of the event is used.
[StartDate <DateTime?>]: The date to start applying the recurrence pattern.
The first occurrence of the meeting may be this date or later, depending on the recurrence pattern of the event.
Must be the same value as the start property of the recurring event.
Required.
[Type <String>]: recurrenceRangeType
[Start <IMicrosoftGraphDateTimeZone>]: dateTimeTimeZone
[WorkLocationType <String>]: workLocationType
INPUTOBJECT <IUsersIdentity>: Identity Parameter
[AppId <String>]: Alternate key of servicePrincipal
[AttachmentBaseId <String>]: The unique identifier of attachmentBase
[AttachmentId <String>]: The unique identifier of attachment
[AttachmentSessionId <String>]: The unique identifier of attachmentSession
[ChecklistItemId <String>]: The unique identifier of checklistItem
[DirectoryObjectId <String>]: The unique identifier of directoryObject
[EndDateTime <String>]: Usage: endDateTime='{endDateTime}'
[ExtensionId <String>]: The unique identifier of extension
[LicenseDetailsId <String>]: The unique identifier of licenseDetails
[LinkedResourceId <String>]: The unique identifier of linkedResource
[NotificationId <String>]: The unique identifier of notification
[OAuth2PermissionGrantId <String>]: The unique identifier of oAuth2PermissionGrant
[OutlookCategoryId <String>]: The unique identifier of outlookCategory
[OutlookTaskFolderId <String>]: The unique identifier of outlookTaskFolder
[OutlookTaskGroupId <String>]: The unique identifier of outlookTaskGroup
[OutlookTaskId <String>]: The unique identifier of outlookTask
[ProfilePhotoId <String>]: The unique identifier of profilePhoto
[ServicePrincipalId <String>]: The unique identifier of servicePrincipal
[ServiceStorageQuotaBreakdownId <String>]: The unique identifier of serviceStorageQuotaBreakdown
[SharedInsightId <String>]: The unique identifier of sharedInsight
[StartDateTime <String>]: Usage: startDateTime='{startDateTime}'
[TimeZoneStandard <String>]: Usage: TimeZoneStandard='{TimeZoneStandard}'
[TodoTaskId <String>]: The unique identifier of todoTask
[TodoTaskListId <String>]: The unique identifier of todoTaskList
[TrendingId <String>]: The unique identifier of trending
[UsedInsightId <String>]: The unique identifier of usedInsight
[UserId <String>]: The unique identifier of user
[UserPrincipalName <String>]: Alternate key of user
[WindowsSettingId <String>]: The unique identifier of windowsSetting
[WindowsSettingInstanceId <String>]: The unique identifier of windowsSettingInstance
[WorkPlanOccurrenceId <String>]: The unique identifier of workPlanOccurrence
[WorkPlanRecurrenceId <String>]: The unique identifier of workPlanRecurrence
OCCURRENCES <IMicrosoftGraphWorkPlanOccurrence[]>: Collection of work plan occurrences.
[Id <String>]: The unique identifier for an entity.
Read-only.
[End <IMicrosoftGraphDateTimeZone>]: dateTimeTimeZone
[(Any) <Object>]: This indicates any property can be added to this object.
[DateTime <String>]: A single point of time in a combined date and time representation ({date}T{time}).
For example, '2019-04-16T09:00:00'.
[TimeZone <String>]: Represents a time zone, for example, 'Pacific Standard Time'.
See below for possible values.
[PlaceId <String>]: Identifier of a place from the Microsoft Graph Places Directory API.
Only applicable when workLocationType is set to office.
[RecurrenceId <String>]: The identifier of the parent recurrence pattern that generated this occurrence.
The value is null for time-off occurrences because they don't have a parent recurrence.
[Start <IMicrosoftGraphDateTimeZone>]: dateTimeTimeZone
[TimeOffDetails <IMicrosoftGraphTimeOffDetails>]: timeOffDetails
[(Any) <Object>]: This indicates any property can be added to this object.
[IsAllDay <Boolean?>]: Indicates whether the time-off entry spans the entire day.
[Subject <String>]: The subject or reason for the time-off entry.
[WorkLocationType <String>]: workLocationType
RECURRENCES <IMicrosoftGraphWorkPlanRecurrence[]>: Collection of recurring work plans defined by the user.
[Id <String>]: The unique identifier for an entity.
Read-only.
[End <IMicrosoftGraphDateTimeZone>]: dateTimeTimeZone
[(Any) <Object>]: This indicates any property can be added to this object.
[DateTime <String>]: A single point of time in a combined date and time representation ({date}T{time}).
For example, '2019-04-16T09:00:00'.
[TimeZone <String>]: Represents a time zone, for example, 'Pacific Standard Time'.
See below for possible values.
[PlaceId <String>]: Identifier of a place from the Microsoft Graph Places Directory API.
Only applicable when workLocationType is set to office.
[Recurrence <IMicrosoftGraphPatternedRecurrence>]: patternedRecurrence
[(Any) <Object>]: This indicates any property can be added to this object.
[Pattern <IMicrosoftGraphRecurrencePattern>]: recurrencePattern
[(Any) <Object>]: This indicates any property can be added to this object.
[DayOfMonth <Int32?>]: The day of the month on which the event occurs.
Required if type is absoluteMonthly or absoluteYearly.
[DaysOfWeek <String[]>]: A collection of the days of the week on which the event occurs.
The possible values are: sunday, monday, tuesday, wednesday, thursday, friday, saturday.
If type is relativeMonthly or relativeYearly, and daysOfWeek specifies more than one day, the event falls on the first day that satisfies the pattern.
Required if type is weekly, relativeMonthly, or relativeYearly.
[FirstDayOfWeek <String>]: dayOfWeek
[Index <String>]: weekIndex
[Interval <Int32?>]: The number of units between occurrences, where units can be in days, weeks, months, or years, depending on the type.
Required.
[Month <Int32?>]: The month in which the event occurs.
This is a number from 1 to 12.
[Type <String>]: recurrencePatternType
[Range <IMicrosoftGraphRecurrenceRange>]: recurrenceRange
[(Any) <Object>]: This indicates any property can be added to this object.
[EndDate <DateTime?>]: The date to stop applying the recurrence pattern.
Depending on the recurrence pattern of the event, the last occurrence of the meeting may not be this date.
Required if type is endDate.
[NumberOfOccurrences <Int32?>]: The number of times to repeat the event.
Required and must be positive if type is numbered.
[RecurrenceTimeZone <String>]: Time zone for the startDate and endDate properties.
Optional.
If not specified, the time zone of the event is used.
[StartDate <DateTime?>]: The date to start applying the recurrence pattern.
The first occurrence of the meeting may be this date or later, depending on the recurrence pattern of the event.
Must be the same value as the start property of the recurring event.
Required.
[Type <String>]: recurrenceRangeType
[Start <IMicrosoftGraphDateTimeZone>]: dateTimeTimeZone
[WorkLocationType <String>]: workLocationType