Share via

Invoke-MgInviteDriveItem

Module:
Microsoft.Graph.Files Module

Sends a sharing invitation for a driveItem.A sharing invitation provides permissions to the recipients and optionally sends them an email with a sharing link.

Note

To view the beta release of this cmdlet, view Invoke-MgBetaInviteDriveItem

Syntax

InviteExpanded (Default) 

Invoke-MgInviteDriveItem
    -DriveId <string>
    -DriveItemId <string>
    [-ResponseHeadersVariable <string>]
    [-AdditionalProperties <hashtable>]
    [-ExpirationDateTime <string>]
    [-Message <string>]
    [-Password <string>]
    [-Recipients <IMicrosoftGraphDriveRecipient[]>]
    [-RequireSignIn]
    [-RetainInheritedPermissions]
    [-Roles <string[]>]
    [-SendInvitation]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Invite 

Invoke-MgInviteDriveItem
    -DriveId <string>
    -DriveItemId <string>
    -BodyParameter <IPaths193Fjg3DrivesDriveIdItemsDriveitemIdMicrosoftGraphInvitePostRequestbodyContentApplicationJsonSchema>
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

InviteViaIdentityExpanded 

Invoke-MgInviteDriveItem
    -InputObject <IFilesIdentity>
    [-ResponseHeadersVariable <string>]
    [-AdditionalProperties <hashtable>]
    [-ExpirationDateTime <string>]
    [-Message <string>]
    [-Password <string>]
    [-Recipients <IMicrosoftGraphDriveRecipient[]>]
    [-RequireSignIn]
    [-RetainInheritedPermissions]
    [-Roles <string[]>]
    [-SendInvitation]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

InviteViaIdentity 

Invoke-MgInviteDriveItem
    -InputObject <IFilesIdentity>
    -BodyParameter <IPaths193Fjg3DrivesDriveIdItemsDriveitemIdMicrosoftGraphInvitePostRequestbodyContentApplicationJsonSchema>
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Sends a sharing invitation for a driveItem.A sharing invitation provides permissions to the recipients and optionally sends them an email with a sharing link.

Permissions

Permission type Permissions (from least to most privileged)
Delegated (work or school account) Files.ReadWrite, Sites.ReadWrite.All, Files.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.Files

$params = @{
	recipients = @(
		@{
			email = "ryan@contoso.com"
		}
	)
	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-MgInviteDriveItem -DriveId $driveId -DriveItemId $driveItemId -BodyParameter $params

This example shows how to use the Invoke-MgInviteDriveItem Cmdlet.

Parameters

-AdditionalProperties

Additional Parameters

Parameter properties

Type:System.Collections.Hashtable
Supports wildcards:False
DontShow:False

Parameter sets

InviteViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
InviteExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-BodyParameter

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

Parameter properties

Type:Microsoft.Graph.PowerShell.Models.IPaths193Fjg3DrivesDriveIdItemsDriveitemIdMicrosoftGraphInvitePostRequestbodyContentApplicationJsonSchema
Supports wildcards:False
DontShow:False

Parameter sets

InviteViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
Invite
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Break

Wait for .NET debugger to attach

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:System.Management.Automation.SwitchParameter
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DriveId

The unique identifier of drive

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

InviteExpanded
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Invite
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DriveItemId

The unique identifier of driveItem

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

InviteExpanded
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Invite
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ExpirationDateTime

Sends a sharing invitation for a driveItem.A sharing invitation provides permissions to the recipients and optionally sends them an email with a sharing link.

Permissions

Permission type Permissions (from least to most privileged)
Delegated (work or school account) Files.ReadWrite, Sites.ReadWrite.All, Files.ReadWrite.All,
Delegated (personal Microsoft account) Files.ReadWrite, Files.ReadWrite.All,
Application Files.ReadWrite.All, Sites.ReadWrite.All,

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

InviteViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
InviteExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Headers

Optional headers that will be added to the request.

Parameter properties

Type:System.Collections.IDictionary
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-HttpPipelineAppend

SendAsync Pipeline Steps to be appended to the front of the pipeline

Parameter properties

Type:

Microsoft.Graph.PowerShell.Runtime.SendAsyncStep[]

Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-HttpPipelinePrepend

SendAsync Pipeline Steps to be prepended to the front of the pipeline

Parameter properties

Type:

Microsoft.Graph.PowerShell.Runtime.SendAsyncStep[]

Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Parameter properties

Type:Microsoft.Graph.PowerShell.Models.IFilesIdentity
Supports wildcards:False
DontShow:False

Parameter sets

InviteViaIdentityExpanded
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
InviteViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Message

Sends a sharing invitation for a driveItem.A sharing invitation provides permissions to the recipients and optionally sends them an email with a sharing link.

Permissions

Permission type Permissions (from least to most privileged)
Delegated (work or school account) Files.ReadWrite, Sites.ReadWrite.All, Files.ReadWrite.All,
Delegated (personal Microsoft account) Files.ReadWrite, Files.ReadWrite.All,
Application Files.ReadWrite.All, Sites.ReadWrite.All,

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

InviteViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
InviteExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Password

Sends a sharing invitation for a driveItem.A sharing invitation provides permissions to the recipients and optionally sends them an email with a sharing link.

Permissions

Permission type Permissions (from least to most privileged)
Delegated (work or school account) Files.ReadWrite, Sites.ReadWrite.All, Files.ReadWrite.All,
Delegated (personal Microsoft account) Files.ReadWrite, Files.ReadWrite.All,
Application Files.ReadWrite.All, Sites.ReadWrite.All,

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

InviteViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
InviteExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Proxy

The URI for the proxy server to use

Parameter properties

Type:System.Uri
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ProxyCredential

Credentials for a proxy server to use for the remote call

Parameter properties

Type:System.Management.Automation.PSCredential
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ProxyUseDefaultCredentials

Use the default credentials for the proxy

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Recipients

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

Parameter properties

Type:

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphDriveRecipient[]

Supports wildcards:False
DontShow:False

Parameter sets

InviteViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
InviteExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RequireSignIn

Sends a sharing invitation for a driveItem.A sharing invitation provides permissions to the recipients and optionally sends them an email with a sharing link.

Permissions

Permission type Permissions (from least to most privileged)
Delegated (work or school account) Files.ReadWrite, Sites.ReadWrite.All, Files.ReadWrite.All,
Delegated (personal Microsoft account) Files.ReadWrite, Files.ReadWrite.All,
Application Files.ReadWrite.All, Sites.ReadWrite.All,

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

InviteViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
InviteExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResponseHeadersVariable

Optional Response Headers Variable.

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False
Aliases:RHV

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RetainInheritedPermissions

Sends a sharing invitation for a driveItem.A sharing invitation provides permissions to the recipients and optionally sends them an email with a sharing link.

Permissions

Permission type Permissions (from least to most privileged)
Delegated (work or school account) Files.ReadWrite, Sites.ReadWrite.All, Files.ReadWrite.All,
Delegated (personal Microsoft account) Files.ReadWrite, Files.ReadWrite.All,
Application Files.ReadWrite.All, Sites.ReadWrite.All,

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

InviteViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
InviteExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Roles

Sends a sharing invitation for a driveItem.A sharing invitation provides permissions to the recipients and optionally sends them an email with a sharing link.

Permissions

Permission type Permissions (from least to most privileged)
Delegated (work or school account) Files.ReadWrite, Sites.ReadWrite.All, Files.ReadWrite.All,
Delegated (personal Microsoft account) Files.ReadWrite, Files.ReadWrite.All,
Application Files.ReadWrite.All, Sites.ReadWrite.All,

Parameter properties

Type:

System.String[]

Supports wildcards:False
DontShow:False

Parameter sets

InviteViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
InviteExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SendInvitation

Sends a sharing invitation for a driveItem.A sharing invitation provides permissions to the recipients and optionally sends them an email with a sharing link.

Permissions

Permission type Permissions (from least to most privileged)
Delegated (work or school account) Files.ReadWrite, Sites.ReadWrite.All, Files.ReadWrite.All,
Delegated (personal Microsoft account) Files.ReadWrite, Files.ReadWrite.All,
Application Files.ReadWrite.All, Sites.ReadWrite.All,

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

InviteViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
InviteExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Runs the command in a mode that only reports what would happen without performing the actions.

Parameter properties

Type:System.Management.Automation.SwitchParameter
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.Graph.PowerShell.Models.IFilesIdentity

{{ Fill in the Description }}

Microsoft.Graph.PowerShell.Models.IPaths193Fjg3DrivesDriveIdItemsDriveitemIdMicrosoftGraphInvitePostRequestbodyContentApplicationJsonSchema

{{ Fill in the Description }}

System.Collections.IDictionary

{{ Fill in the Description }}

Outputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphPermission

{{ Fill in the Description }}

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 (for example, 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 (for example, 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.