Invoke-MgBetaCheckoutGroupDriveRoot
Check out a driveItem resource to prevent others from editing the document, and prevent your changes from being visible until the documented is checked in.
Note
To view the v1.0 release of this cmdlet, view Invoke-MgCheckoutGroupDriveRoot
Syntax
Invoke-MgBetaCheckoutGroupDriveRoot
-DriveId <String>
-GroupId <String>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-PassThru]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Invoke-MgBetaCheckoutGroupDriveRoot
-InputObject <IGroupsIdentity>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-PassThru]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
Check out a driveItem resource to prevent others from editing the document, and prevent your changes from being visible until the documented is checked in.
Permissions
| Permission type | Least privileged permissions | Higher privileged permissions |
|---|---|---|
| Delegated (work or school account) | Files.ReadWrite | Files.ReadWrite.All, Sites.ReadWrite.All |
| Delegated (personal Microsoft account) | Files.ReadWrite | Files.ReadWrite.All |
| Application | Files.ReadWrite.All | Sites.ReadWrite.All |
Parameters
-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 |
-DriveId
The unique identifier of drive
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| 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 |
-PassThru
Returns true when the command succeeds
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| 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 |
-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.IGroupsIdentity
System.Collections.IDictionary
Outputs
System.Boolean
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.
INPUTOBJECT <IGroupsIdentity>: Identity Parameter
[AttachmentId <String>]: The unique identifier of attachment[BaseSitePageId <String>]: The unique identifier of baseSitePage[ContentModelId <String>]: The unique identifier of contentModel[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[DirectorySettingId <String>]: The unique identifier of directorySetting[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}'[EndpointId <String>]: The unique identifier of endpoint[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[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[MentionId <String>]: The unique identifier of mention[ModelName <String>]: Usage: modelName='{modelName}'[NotebookId <String>]: The unique identifier of notebook[OnenotePageId <String>]: The unique identifier of onenotePage[OnenoteSectionId <String>]: The unique identifier of onenoteSection[PageTemplateId <String>]: The unique identifier of pageTemplate[Path <String>]: Usage: path='{path}'[PermissionId <String>]: The unique identifier of permission[PlannerBucketId <String>]: The unique identifier of plannerBucket[PlannerPlanId <String>]: The unique identifier of plannerPlan[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[SensitivityLabelId <String>]: The unique identifier of sensitivityLabel[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}'[UserId <String>]: The unique identifier of user[WebPartId <String>]: The unique identifier of webPart