Share via

Copy-MgBetaDriveItem

  • Reference
Module:
Microsoft.Graph.Beta.Files

Asynchronously create a copy of a driveItem (including any children) under a new parent item or with a new name. After the request is acknowledged, it enters a queue. The actual copying, including any subitems, occurs at an undetermined time. Progress is reported until the operation is completed by monitoring the progress.

Note

To view the v1.0 release of this cmdlet, view Copy-MgDriveItem

Syntax

Copy-MgBetaDriveItem
    -DriveId <String>
    -DriveItemId <String>
    [-ResponseHeadersVariable <String>]
    [-AdditionalProperties <Hashtable>]
    [-ChildrenOnly]
    [-IncludeAllVersionHistory]
    [-Name <String>]
    [-ParentReference <IMicrosoftGraphItemReference>]
    [-Headers <IDictionary>]
    [-ProgressAction <ActionPreference>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
Copy-MgBetaDriveItem
    -DriveId <String>
    -DriveItemId <String>
    -BodyParameter <IPaths17Tusw5DrivesDriveIdItemsDriveitemIdMicrosoftGraphCopyPostRequestbodyContentApplicationJsonSchema>
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-ProgressAction <ActionPreference>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
Copy-MgBetaDriveItem
    -InputObject <IFilesIdentity>
    [-ResponseHeadersVariable <String>]
    [-AdditionalProperties <Hashtable>]
    [-ChildrenOnly]
    [-IncludeAllVersionHistory]
    [-Name <String>]
    [-ParentReference <IMicrosoftGraphItemReference>]
    [-Headers <IDictionary>]
    [-ProgressAction <ActionPreference>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
Copy-MgBetaDriveItem
    -InputObject <IFilesIdentity>
    -BodyParameter <IPaths17Tusw5DrivesDriveIdItemsDriveitemIdMicrosoftGraphCopyPostRequestbodyContentApplicationJsonSchema>
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-ProgressAction <ActionPreference>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Asynchronously create a copy of a driveItem (including any children) under a new parent item or with a new name. After the request is acknowledged, it enters a queue. The actual copying, including any subitems, occurs at an undetermined time. Progress is reported until the operation is completed by monitoring the progress.

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

Examples

Example 1: Code snippet

Import-Module Microsoft.Graph.Beta.Files

$params = @{
	parentReference = @{
		driveId = "b!s8RqPCGh0ESQS2EYnKM0IKS3lM7GxjdAviiob7oc5pXv_0LiL-62Qq3IXyrXnEop"
		id = "DCD0D3AD-8989-4F23-A5A2-2C086050513F"
	}
	name = "contoso plan (copy).txt"
}

Copy-MgBetaDriveItem -DriveId $driveId -DriveItemId $driveItemId -BodyParameter $params

This example shows how to use the Copy-MgBetaDriveItem Cmdlet.

Example 2: Code snippet

Import-Module Microsoft.Graph.Beta.Files

$params = @{
	parentReference = @{
		driveId = "b!s8RqPCGh0ESQS2EYnKM0IKS3lM7GxjdAviiob7oc5pXv_0LiL-62Qq3IXyrXnEop"
		id = "DCD0D3AD-8989-4F23-A5A2-2C086050513F"
	}
	childrenOnly = $true
}

Copy-MgBetaDriveItem -DriveId $driveId -DriveItemId $driveItemId -BodyParameter $params

This example shows how to use the Copy-MgBetaDriveItem Cmdlet.

Example 3: Code snippet

Import-Module Microsoft.Graph.Beta.Files

$params = @{
	parentReference = @{
		driveId = "b!s8RqPCGh0ESQS2EYnKM0IKS3lM7GxjdAviiob7oc5pXv_0LiL-62Qq3IXyrXnEop"
		id = "DCD0D3AD-8989-4F23-A5A2-2C086050513F"
	}
}

Copy-MgBetaDriveItem -DriveId $driveId -DriveItemId $driveItemId -BodyParameter $params

This example shows how to use the Copy-MgBetaDriveItem Cmdlet.

Example 4: Code snippet

Import-Module Microsoft.Graph.Beta.Files

$params = @{
	parentReference = @{
		driveId = "b!s8RqPCGh0ESQS2EYnKM0IKS3lM7GxjdAviiob7oc5pXv_0LiL-62Qq3IXyrXnEop"
		id = "DCD0D3AD-8989-4F23-A5A2-2C086050513F"
	}
}

Copy-MgBetaDriveItem -DriveId $driveId -DriveItemId $driveItemId -@microsoft.graph.conflictbehavior "replace"  -BodyParameter $params

This example shows how to use the Copy-MgBetaDriveItem Cmdlet.

Example 5: Code snippet

Import-Module Microsoft.Graph.Beta.Files

$params = @{
	parentReference = @{
		driveId = "b!s8RqPCGh0ESQS2EYnKM0IKS3lM7GxjdAviiob7oc5pXv_0LiL-62Qq3IXyrXnEop"
		id = "DCD0D3AD-8989-4F23-A5A2-2C086050513F"
	}
	includeAllVersionHistory = $true
}

Copy-MgBetaDriveItem -DriveId $driveId -DriveItemId $driveItemId -BodyParameter $params

This example shows how to use the Copy-MgBetaDriveItem Cmdlet.

Parameters

-AdditionalProperties

Additional Parameters

Type:Hashtable
Position:Named
Default value:None
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:IPaths17Tusw5DrivesDriveIdItemsDriveitemIdMicrosoftGraphCopyPostRequestbodyContentApplicationJsonSchema
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ChildrenOnly

.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
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

-DriveId

The unique identifier of drive

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-DriveItemId

The unique identifier of driveItem

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

-IncludeAllVersionHistory

.

Type:SwitchParameter
Position:Named
Default value:False
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:IFilesIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ParentReference

itemReference To construct, see NOTES section for PARENTREFERENCE properties and create a hash table.

Type:IMicrosoftGraphItemReference
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

-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.IFilesIdentity

Microsoft.Graph.Beta.PowerShell.Models.IPaths17Tusw5DrivesDriveIdItemsDriveitemIdMicrosoftGraphCopyPostRequestbodyContentApplicationJsonSchema

System.Collections.IDictionary

Outputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphDriveItem

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 <IPaths17Tusw5DrivesDriveIdItemsDriveitemIdMicrosoftGraphCopyPostRequestbodyContentApplicationJsonSchema>: .

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [ChildrenOnly <Boolean?>]:
  • [IncludeAllVersionHistory <Boolean?>]:
  • [Name <String>]:
  • [ParentReference <IMicrosoftGraphItemReference>]: itemReference
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [DriveId <String>]: Unique identifier of the drive instance that contains the driveItem. Only returned if the item is located in a drive. Read-only.
    • [DriveType <String>]: Identifies the type of drive. Only returned if the item is located in a drive. See drive resource for values.
    • [Id <String>]: Unique identifier of the driveItem in the drive or a listItem in a list. Read-only.
    • [Name <String>]: The name of the item being referenced. Read-only.
    • [Path <String>]: Percent-encoded path that can be used to navigate to the item. Read-only.
    • [ShareId <String>]: A unique identifier for a shared resource that can be accessed via the Shares API.
    • [SharepointIds <IMicrosoftGraphSharepointIds>]: sharepointIds
      • [(Any) <Object>]: This indicates any property can be added to this object.
      • [ListId <String>]: The unique identifier (guid) for the item's list in SharePoint.
      • [ListItemId <String>]: An integer identifier for the item within the containing list.
      • [ListItemUniqueId <String>]: The unique identifier (guid) for the item within OneDrive for Business or a SharePoint site.
      • [SiteId <String>]: The unique identifier (guid) for the item's site collection (SPSite).
      • [SiteUrl <String>]: The SharePoint URL for the site that contains the item.
      • [TenantId <String>]: The unique identifier (guid) for the tenancy.
      • [WebId <String>]: The unique identifier (guid) for the item's site (SPWeb).
    • [SiteId <String>]: For OneDrive for Business and SharePoint, this property represents the ID of the site that contains the parent document library of the driveItem resource or the parent list of the listItem resource. The value is the same as the id property of that site resource. It's an opaque string that consists of three identifiers of the site. For OneDrive, this property isn't populated.

INPUTOBJECT <IFilesIdentity>: Identity Parameter

  • [ColumnDefinitionId <String>]: The unique identifier of columnDefinition
  • [ColumnLinkId <String>]: The unique identifier of columnLink
  • [ContentTypeId <String>]: The unique identifier of contentType
  • [ContentTypeId1 <String>]: The unique identifier of contentType
  • [DocumentSetVersionId <String>]: The unique identifier of documentSetVersion
  • [DriveId <String>]: The unique identifier of drive
  • [DriveItemId <String>]: The unique identifier of driveItem
  • [DriveItemId1 <String>]: The unique identifier of driveItem
  • [DriveItemVersionId <String>]: The unique identifier of driveItemVersion
  • [EndDateTime <String>]: Usage: endDateTime='{endDateTime}'
  • [GroupId <String>]: The unique identifier of group
  • [Interval <String>]: Usage: interval='{interval}'
  • [ItemActivityStatId <String>]: The unique identifier of itemActivityStat
  • [ListItemId <String>]: The unique identifier of listItem
  • [ListItemVersionId <String>]: The unique identifier of listItemVersion
  • [PermissionId <String>]: The unique identifier of permission
  • [Q <String>]: Usage: q='{q}'
  • [RichLongRunningOperationId <String>]: The unique identifier of richLongRunningOperation
  • [SharedDriveItemId <String>]: The unique identifier of sharedDriveItem
  • [StartDateTime <String>]: Usage: startDateTime='{startDateTime}'
  • [SubscriptionId <String>]: The unique identifier of subscription
  • [ThumbnailSetId <String>]: The unique identifier of thumbnailSet
  • [Token <String>]: Usage: token='{token}'
  • [UserId <String>]: The unique identifier of user

PARENTREFERENCE <IMicrosoftGraphItemReference>: itemReference

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [DriveId <String>]: Unique identifier of the drive instance that contains the driveItem. Only returned if the item is located in a drive. Read-only.
  • [DriveType <String>]: Identifies the type of drive. Only returned if the item is located in a drive. See drive resource for values.
  • [Id <String>]: Unique identifier of the driveItem in the drive or a listItem in a list. Read-only.
  • [Name <String>]: The name of the item being referenced. Read-only.
  • [Path <String>]: Percent-encoded path that can be used to navigate to the item. Read-only.
  • [ShareId <String>]: A unique identifier for a shared resource that can be accessed via the Shares API.
  • [SharepointIds <IMicrosoftGraphSharepointIds>]: sharepointIds
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [ListId <String>]: The unique identifier (guid) for the item's list in SharePoint.
    • [ListItemId <String>]: An integer identifier for the item within the containing list.
    • [ListItemUniqueId <String>]: The unique identifier (guid) for the item within OneDrive for Business or a SharePoint site.
    • [SiteId <String>]: The unique identifier (guid) for the item's site collection (SPSite).
    • [SiteUrl <String>]: The SharePoint URL for the site that contains the item.
    • [TenantId <String>]: The unique identifier (guid) for the tenancy.
    • [WebId <String>]: The unique identifier (guid) for the item's site (SPWeb).
  • [SiteId <String>]: For OneDrive for Business and SharePoint, this property represents the ID of the site that contains the parent document library of the driveItem resource or the parent list of the listItem resource. The value is the same as the id property of that site resource. It's an opaque string that consists of three identifiers of the site. For OneDrive, this property isn't populated.