Get-MgGroupCalendarSchedule
Get the free/busy availability information for a collection of users, distributions lists, or resources (rooms or equipment) for a specified time period.
Note
To view the beta release of this cmdlet, view Get-MgBetaGroupCalendarSchedule
Syntax
Get-MgGroupCalendarSchedule
-GroupId <String>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-AvailabilityViewInterval <Int32>]
[-EndTime <IMicrosoftGraphDateTimeZone>]
[-Schedules <String[]>]
[-StartTime <IMicrosoftGraphDateTimeZone>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Get-MgGroupCalendarSchedule
-GroupId <String>
-BodyParameter <IPathsB1HbbpGroupsGroupIdCalendarMicrosoftGraphGetschedulePostRequestbodyContentApplicationJsonSchema>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Get-MgGroupCalendarSchedule
-InputObject <IGroupsIdentity>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-AvailabilityViewInterval <Int32>]
[-EndTime <IMicrosoftGraphDateTimeZone>]
[-Schedules <String[]>]
[-StartTime <IMicrosoftGraphDateTimeZone>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Get-MgGroupCalendarSchedule
-InputObject <IGroupsIdentity>
-BodyParameter <IPathsB1HbbpGroupsGroupIdCalendarMicrosoftGraphGetschedulePostRequestbodyContentApplicationJsonSchema>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Get the free/busy availability information for a collection of users, distributions lists, or resources (rooms or equipment) for a specified time period.
Permissions
Permission type | Least privileged permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | Calendars.ReadBasic | Calendars.Read, Calendars.ReadWrite |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | Calendars.ReadBasic | Calendars.Read, Calendars.ReadWrite |
Parameters
-AdditionalProperties
Additional Parameters
Type: | Hashtable |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-AvailabilityViewInterval
.
Type: | Int32 |
Position: | Named |
Default value: | 0 |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-BodyParameter
. To construct, see NOTES section for BODYPARAMETER properties and create a hash table.
Type: | IPathsB1HbbpGroupsGroupIdCalendarMicrosoftGraphGetschedulePostRequestbodyContentApplicationJsonSchema |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-EndTime
dateTimeTimeZone To construct, see NOTES section for ENDTIME properties and create a hash table.
Type: | IMicrosoftGraphDateTimeZone |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-GroupId
The unique identifier of group
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Headers
Optional headers that will be added to the request.
Type: | IDictionary |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
Type: | IGroupsIdentity |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ProgressAction
{{ Fill ProgressAction Description }}
Type: | ActionPreference |
Aliases: | proga |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResponseHeadersVariable
Optional Response Headers Variable.
Type: | String |
Aliases: | RHV |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Schedules
.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-StartTime
dateTimeTimeZone To construct, see NOTES section for STARTTIME properties and create a hash table.
Type: | IMicrosoftGraphDateTimeZone |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
Microsoft.Graph.PowerShell.Models.IGroupsIdentity
Microsoft.Graph.PowerShell.Models.IPathsB1HbbpGroupsGroupIdCalendarMicrosoftGraphGetschedulePostRequestbodyContentApplicationJsonSchema
System.Collections.IDictionary
Outputs
Microsoft.Graph.PowerShell.Models.IMicrosoftGraphScheduleInformation
Notes
COMPLEX PARAMETER PROPERTIES
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 <IPathsB1HbbpGroupsGroupIdCalendarMicrosoftGraphGetschedulePostRequestbodyContentApplicationJsonSchema>
: .
[(Any) <Object>]
: This indicates any property can be added to this object.[AvailabilityViewInterval <Int32?>]
:[EndTime <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, 2017-08-29T04:00:00.0000000).[TimeZone <String>]
: Represents a time zone, for example, 'Pacific Standard Time'. See below for more possible values.
[Schedules <String-
[]>]
:[StartTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
ENDTIME <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, 2017-08-29T04:00:00.0000000).[TimeZone <String>]
: Represents a time zone, for example, 'Pacific Standard Time'. See below for more possible values.
INPUTOBJECT <IGroupsIdentity>
: Identity Parameter
[AttachmentId <String>]
: The unique identifier of attachment[BaseSitePageId <String>]
: The unique identifier of baseSitePage[ContentTypeId <String>]
: The unique identifier of contentType[ConversationId <String>]
: The unique identifier of conversation[ConversationThreadId <String>]
: The unique identifier of conversationThread[DirectoryObjectId <String>]
: The unique identifier of directoryObject[DocumentSetVersionId <String>]
: The unique identifier of documentSetVersion[DriveId <String>]
: The unique identifier of drive[DriveItemId <String>]
: The unique identifier of driveItem[DriveItemVersionId <String>]
: The unique identifier of driveItemVersion[EndDateTime <String>]
: Usage: endDateTime='{endDateTime}'[EventId <String>]
: The unique identifier of event[ExtensionId <String>]
: The unique identifier of extension[GroupId <String>]
: The unique identifier of group[GroupLifecyclePolicyId <String>]
: The unique identifier of groupLifecyclePolicy[GroupSettingId <String>]
: The unique identifier of groupSetting[GroupSettingTemplateId <String>]
: The unique identifier of groupSettingTemplate[HorizontalSectionColumnId <String>]
: The unique identifier of horizontalSectionColumn[HorizontalSectionId <String>]
: The unique identifier of horizontalSection[IncludePersonalNotebooks <Boolean?>]
: Usage: includePersonalNotebooks={includePersonalNotebooks}[Interval <String>]
: Usage: interval='{interval}'[ListId <String>]
: The unique identifier of list[ListItemId <String>]
: The unique identifier of listItem[ListItemVersionId <String>]
: The unique identifier of listItemVersion[NotebookId <String>]
: The unique identifier of notebook[OnenotePageId <String>]
: The unique identifier of onenotePage[OnenoteSectionId <String>]
: The unique identifier of onenoteSection[Path <String>]
: Usage: path='{path}'[PermissionId <String>]
: The unique identifier of permission[PostId <String>]
: The unique identifier of post[ProfilePhotoId <String>]
: The unique identifier of profilePhoto[Q <String>]
: Usage: q='{q}'[ResourceSpecificPermissionGrantId <String>]
: The unique identifier of resourceSpecificPermissionGrant[SiteId <String>]
: The unique identifier of site[StartDateTime <String>]
: Usage: startDateTime='{startDateTime}'[SubscriptionId <String>]
: The unique identifier of subscription[Token <String>]
: Usage: token='{token}'[UniqueName <String>]
: Alternate key of group[User <String>]
: Usage: User='{User}'[WebPartId <String>]
: The unique identifier of webPart
STARTTIME <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, 2017-08-29T04:00:00.0000000).[TimeZone <String>]
: Represents a time zone, for example, 'Pacific Standard Time'. See below for more possible values.