New-MgBetaTeamScheduleTimeOff
Create a new timeOff instance in a schedule.
Note
To view the v1.0 release of this cmdlet, view New-MgTeamScheduleTimeOff
Syntax
New-MgBetaTeamScheduleTimeOff
-TeamId <String>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-CreatedBy <IMicrosoftGraphIdentitySet>]
[-DraftTimeOff <IMicrosoftGraphTimeOffItem>]
[-Id <String>]
[-IsStagedForDeletion]
[-LastModifiedBy <IMicrosoftGraphIdentitySet>]
[-SharedTimeOff <IMicrosoftGraphTimeOffItem>]
[-TeamInfo <IMicrosoftGraphShiftsTeamInfo>]
[-UserId <String>]
[-UserInfo <IMicrosoftGraphShiftsUserInfo>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-MgBetaTeamScheduleTimeOff
-TeamId <String>
-BodyParameter <IMicrosoftGraphTimeOff>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-MgBetaTeamScheduleTimeOff
-InputObject <ITeamsIdentity>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-CreatedBy <IMicrosoftGraphIdentitySet>]
[-DraftTimeOff <IMicrosoftGraphTimeOffItem>]
[-Id <String>]
[-IsStagedForDeletion]
[-LastModifiedBy <IMicrosoftGraphIdentitySet>]
[-SharedTimeOff <IMicrosoftGraphTimeOffItem>]
[-TeamInfo <IMicrosoftGraphShiftsTeamInfo>]
[-UserId <String>]
[-UserInfo <IMicrosoftGraphShiftsUserInfo>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-MgBetaTeamScheduleTimeOff
-InputObject <ITeamsIdentity>
-BodyParameter <IMicrosoftGraphTimeOff>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Create a new timeOff instance in a schedule.
Permissions
Permission type | Least privileged permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | Schedule.ReadWrite.All | Group.ReadWrite.All |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | Schedule.ReadWrite.All | Not available. |
Examples
Example 1: Code snippet
Import-Module Microsoft.Graph.Beta.Teams
$params = @{
userId = "c5d0c76b-80c4-481c-be50-923cd8d680a1"
sharedTimeOff = @{
timeOffReasonId = "TOR_891045ca-b5d2-406b-aa06-a3c8921245d7"
startDateTime = [System.DateTime]::Parse("2019-03-11T07:00:00Z")
endDateTime = [System.DateTime]::Parse("2019-03-12T07:00:00Z")
theme = "white"
}
draftTimeOff = @{
timeOffReasonId = "TOR_891045ca-b5d2-406b-aa06-a3c8921245d7"
startDateTime = [System.DateTime]::Parse("2019-03-11T07:00:00Z")
endDateTime = [System.DateTime]::Parse("2019-03-12T07:00:00Z")
theme = "pink"
}
}
New-MgBetaTeamScheduleTimeOff -TeamId $teamId -BodyParameter $params
This example shows how to use the New-MgBetaTeamScheduleTimeOff Cmdlet.
Parameters
-AdditionalProperties
Additional Parameters
Type: | Hashtable |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-BodyParameter
timeOff To construct, see NOTES section for BODYPARAMETER properties and create a hash table.
Type: | IMicrosoftGraphTimeOff |
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 |
-CreatedBy
identitySet To construct, see NOTES section for CREATEDBY properties and create a hash table.
Type: | IMicrosoftGraphIdentitySet |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DraftTimeOff
timeOffItem To construct, see NOTES section for DRAFTTIMEOFF properties and create a hash table.
Type: | IMicrosoftGraphTimeOffItem |
Position: | Named |
Default value: | None |
Required: | False |
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 |
-Id
The unique identifier for an entity. Read-only.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
Type: | ITeamsIdentity |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-IsStagedForDeletion
The timeOff is marked for deletion, a process that is finalized when the schedule is shared.
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-LastModifiedBy
identitySet To construct, see NOTES section for LASTMODIFIEDBY properties and create a hash table.
Type: | IMicrosoftGraphIdentitySet |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
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 |
-SharedTimeOff
timeOffItem To construct, see NOTES section for SHAREDTIMEOFF properties and create a hash table.
Type: | IMicrosoftGraphTimeOffItem |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-TeamId
The unique identifier of team
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-TeamInfo
shiftsTeamInfo To construct, see NOTES section for TEAMINFO properties and create a hash table.
Type: | IMicrosoftGraphShiftsTeamInfo |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-UserId
ID of the user assigned to the timeOff. Required.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-UserInfo
shiftsUserInfo To construct, see NOTES section for USERINFO properties and create a hash table.
Type: | IMicrosoftGraphShiftsUserInfo |
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.Beta.PowerShell.Models.IMicrosoftGraphTimeOff
Microsoft.Graph.Beta.PowerShell.Models.ITeamsIdentity
System.Collections.IDictionary
Outputs
Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphTimeOff
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 <IMicrosoftGraphTimeOff>
: timeOff
[(Any) <Object>]
: This indicates any property can be added to this object.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[(Any) <Object>]
: This indicates any property can be added to this object.[Application <IMicrosoftGraphIdentity>]
: identity[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: The display name of the identity. This property is read-only.[Id <String>]
: The identifier of the identity. This property is read-only.
[Device <IMicrosoftGraphIdentity>]
: identity[User <IMicrosoftGraphIdentity>]
: identity
[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[Id <String>]
: The unique identifier for an entity. Read-only.[DraftTimeOff <IMicrosoftGraphTimeOffItem>]
: timeOffItem[(Any) <Object>]
: This indicates any property can be added to this object.[EndDateTime <DateTime?>]
:[StartDateTime <DateTime?>]
:[Theme <String>]
: scheduleEntityTheme[TimeOffReasonId <String>]
: ID of the timeOffReason for this timeOffItem. Required.
[IsStagedForDeletion <Boolean?>]
: The timeOff is marked for deletion, a process that is finalized when the schedule is shared.[SharedTimeOff <IMicrosoftGraphTimeOffItem>]
: timeOffItem[TeamInfo <IMicrosoftGraphShiftsTeamInfo>]
: shiftsTeamInfo[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: The display name for the team. Required.[TeamId <String>]
: ID of the team.
[UserId <String>]
: ID of the user assigned to the timeOff. Required.[UserInfo <IMicrosoftGraphShiftsUserInfo>]
: shiftsUserInfo[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: The display name for the user. Required.[UserId <String>]
: ID of the user.
CREATEDBY <IMicrosoftGraphIdentitySet>
: identitySet
[(Any) <Object>]
: This indicates any property can be added to this object.[Application <IMicrosoftGraphIdentity>]
: identity[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: The display name of the identity. This property is read-only.[Id <String>]
: The identifier of the identity. This property is read-only.
[Device <IMicrosoftGraphIdentity>]
: identity[User <IMicrosoftGraphIdentity>]
: identity
DRAFTTIMEOFF <IMicrosoftGraphTimeOffItem>
: timeOffItem
[(Any) <Object>]
: This indicates any property can be added to this object.[EndDateTime <DateTime?>]
:[StartDateTime <DateTime?>]
:[Theme <String>]
: scheduleEntityTheme[TimeOffReasonId <String>]
: ID of the timeOffReason for this timeOffItem. Required.
INPUTOBJECT <ITeamsIdentity>
: Identity Parameter
[AssociatedTeamInfoId <String>]
: The unique identifier of associatedTeamInfo[ChannelId <String>]
: The unique identifier of channel[ChatId <String>]
: The unique identifier of chat[ChatMessageHostedContentId <String>]
: The unique identifier of chatMessageHostedContent[ChatMessageId <String>]
: The unique identifier of chatMessage[ChatMessageId1 <String>]
: The unique identifier of chatMessage[ConversationMemberId <String>]
: The unique identifier of conversationMember[DayNoteId <String>]
: The unique identifier of dayNote[DeletedChatId <String>]
: The unique identifier of deletedChat[DeletedTeamId <String>]
: The unique identifier of deletedTeam[GroupId <String>]
: The unique identifier of group[OfferShiftRequestId <String>]
: The unique identifier of offerShiftRequest[OpenShiftChangeRequestId <String>]
: The unique identifier of openShiftChangeRequest[OpenShiftId <String>]
: The unique identifier of openShift[PinnedChatMessageInfoId <String>]
: The unique identifier of pinnedChatMessageInfo[ResourceSpecificPermissionGrantId <String>]
: The unique identifier of resourceSpecificPermissionGrant[SchedulingGroupId <String>]
: The unique identifier of schedulingGroup[SharedWithChannelTeamInfoId <String>]
: The unique identifier of sharedWithChannelTeamInfo[ShiftId <String>]
: The unique identifier of shift[ShiftsRoleDefinitionId <String>]
: The unique identifier of shiftsRoleDefinition[SwapShiftsChangeRequestId <String>]
: The unique identifier of swapShiftsChangeRequest[TeamId <String>]
: The unique identifier of team[TeamTemplateDefinitionId <String>]
: The unique identifier of teamTemplateDefinition[TeamTemplateId <String>]
: The unique identifier of teamTemplate[TeamsAppDashboardCardDefinitionId <String>]
: The unique identifier of teamsAppDashboardCardDefinition[TeamsAppDefinitionId <String>]
: The unique identifier of teamsAppDefinition[TeamsAppId <String>]
: The unique identifier of teamsApp[TeamsAppInstallationId <String>]
: The unique identifier of teamsAppInstallation[TeamsAsyncOperationId <String>]
: The unique identifier of teamsAsyncOperation[TeamsTabId <String>]
: The unique identifier of teamsTab[TeamworkDeviceId <String>]
: The unique identifier of teamworkDevice[TeamworkDeviceOperationId <String>]
: The unique identifier of teamworkDeviceOperation[TeamworkTagId <String>]
: The unique identifier of teamworkTag[TeamworkTagMemberId <String>]
: The unique identifier of teamworkTagMember[TimeCardId <String>]
: The unique identifier of timeCard[TimeOffId <String>]
: The unique identifier of timeOff[TimeOffReasonId <String>]
: The unique identifier of timeOffReason[TimeOffRequestId <String>]
: The unique identifier of timeOffRequest[UserId <String>]
: The unique identifier of user[UserScopeTeamsAppInstallationId <String>]
: The unique identifier of userScopeTeamsAppInstallation[WorkforceIntegrationId <String>]
: The unique identifier of workforceIntegration
LASTMODIFIEDBY <IMicrosoftGraphIdentitySet>
: identitySet
[(Any) <Object>]
: This indicates any property can be added to this object.[Application <IMicrosoftGraphIdentity>]
: identity[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: The display name of the identity. This property is read-only.[Id <String>]
: The identifier of the identity. This property is read-only.
[Device <IMicrosoftGraphIdentity>]
: identity[User <IMicrosoftGraphIdentity>]
: identity
SHAREDTIMEOFF <IMicrosoftGraphTimeOffItem>
: timeOffItem
[(Any) <Object>]
: This indicates any property can be added to this object.[EndDateTime <DateTime?>]
:[StartDateTime <DateTime?>]
:[Theme <String>]
: scheduleEntityTheme[TimeOffReasonId <String>]
: ID of the timeOffReason for this timeOffItem. Required.
TEAMINFO <IMicrosoftGraphShiftsTeamInfo>
: shiftsTeamInfo
[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: The display name for the team. Required.[TeamId <String>]
: ID of the team.
USERINFO <IMicrosoftGraphShiftsUserInfo>
: shiftsUserInfo
[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: The display name for the user. Required.[UserId <String>]
: ID of the user.