Invoke-MgBetaInviteDriveItem

Module:

Microsoft.Graph.Beta.Files

Sends a sharing invitation for a driveItem.A sharing invitation provides permissions to the recipients and optionally sends an email to the recipients to notify them the item was shared.

Note

To view the v1.0 release of this cmdlet, view Invoke-MgInviteDriveItem

Syntax

Invoke-MgBetaInviteDriveItem
      -DriveId <String>
      -DriveItemId <String>
      [-ResponseHeadersVariable <String>]
      [-AdditionalProperties <Hashtable>]
      [-ExpirationDateTime <String>]
      [-Message <String>]
      [-Password <String>]
      [-Recipients <IMicrosoftGraphDriveRecipient[]>]
      [-RequireSignIn]
      [-RetainInheritedPermissions]
      [-Roles <String[]>]
      [-SendInvitation]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-MgBetaInviteDriveItem
      -DriveId <String>
      -DriveItemId <String>
      -BodyParameter <IPaths193Fjg3DrivesDriveIdItemsDriveitemIdMicrosoftGraphInvitePostRequestbodyContentApplicationJsonSchema>
      [-ResponseHeadersVariable <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-MgBetaInviteDriveItem
      -InputObject <IFilesIdentity>
      [-ResponseHeadersVariable <String>]
      [-AdditionalProperties <Hashtable>]
      [-ExpirationDateTime <String>]
      [-Message <String>]
      [-Password <String>]
      [-Recipients <IMicrosoftGraphDriveRecipient[]>]
      [-RequireSignIn]
      [-RetainInheritedPermissions]
      [-Roles <String[]>]
      [-SendInvitation]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-MgBetaInviteDriveItem
      -InputObject <IFilesIdentity>
      -BodyParameter <IPaths193Fjg3DrivesDriveIdItemsDriveitemIdMicrosoftGraphInvitePostRequestbodyContentApplicationJsonSchema>
      [-ResponseHeadersVariable <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Sends a sharing invitation for a driveItem.A sharing invitation provides permissions to the recipients and optionally sends an email to the recipients to notify them the item was shared.

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 = @{
	recipients = @(
		@{
			email = "robin@contoso.org"
		}
	)
	message = "Here's the file that we're collaborating on."
	requireSignIn = $true
	sendInvitation = $true
	roles = @(
	"write"
)
password = "password123"
expirationDateTime = "2018-07-15T14:00:00.000Z"
}

Invoke-MgBetaInviteDriveItem -DriveId $driveId -DriveItemId $driveItemId -BodyParameter $params

This example shows how to use the Invoke-MgBetaInviteDriveItem 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:	IPaths193Fjg3DrivesDriveIdItemsDriveitemIdMicrosoftGraphInvitePostRequestbodyContentApplicationJsonSchema
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

-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

-ExpirationDateTime

.

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

-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

-Message

.

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

-Password

.

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

-Recipients

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

Type:	IMicrosoftGraphDriveRecipient[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RequireSignIn

.

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

-RetainInheritedPermissions

.

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

-Roles

.

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

-SendInvitation

.

Type:	SwitchParameter
Position:	Named
Default value:	False
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.IPaths193Fjg3DrivesDriveIdItemsDriveitemIdMicrosoftGraphInvitePostRequestbodyContentApplicationJsonSchema

System.Collections.IDictionary

Outputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphPermission

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

• [(Any) <Object>]: This indicates any property can be added to this object.
• [ExpirationDateTime <String>]:
• [Message <String>]:
• [Password <String>]:
• [Recipients <IMicrosoftGraphDriveRecipient- []>]:
  • [Alias <String>]: The alias of the domain object, for cases where an email address is unavailable (e.g. security groups).
  • [Email <String>]: The email address for the recipient, if the recipient has an associated email address.
  • [ObjectId <String>]: The unique identifier for the recipient in the directory.
• [RequireSignIn <Boolean?>]:
• [RetainInheritedPermissions <Boolean?>]:
• [Roles <String- []>]:
• [SendInvitation <Boolean?>]:

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

RECIPIENTS <IMicrosoftGraphDriveRecipient- []>: .

• [Alias <String>]: The alias of the domain object, for cases where an email address is unavailable (e.g. security groups).
• [Email <String>]: The email address for the recipient, if the recipient has an associated email address.
• [ObjectId <String>]: The unique identifier for the recipient in the directory.

Related Links

• https://learn.microsoft.com/powershell/module/microsoft.graph.beta.files/invoke-mgbetainvitedriveitem
• https://learn.microsoft.com/graph/api/driveitem-invite?view=graph-rest-beta