Invoke-MgInviteGroupDriveItem
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-MgBetaInviteGroupDriveItem
Syntax
Invoke-MgInviteGroupDriveItem
-DriveId <String>
-DriveItemId <String>
-GroupId <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-MgInviteGroupDriveItem
-DriveId <String>
-DriveItemId <String>
-GroupId <String>
-BodyParameter <IPathsLx1Fn7GroupsGroupIdDrivesDriveIdItemsDriveitemIdMicrosoftGraphInvitePostRequestbodyContentApplicationJsonSchema>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Invoke-MgInviteGroupDriveItem
-InputObject <IGroupsIdentity>
[-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-MgInviteGroupDriveItem
-InputObject <IGroupsIdentity>
-BodyParameter <IPathsLx1Fn7GroupsGroupIdDrivesDriveIdItemsDriveitemIdMicrosoftGraphInvitePostRequestbodyContentApplicationJsonSchema>
[-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 them an email with a sharing link.
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
-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: | IPathsLx1Fn7GroupsGroupIdDrivesDriveIdItemsDriveitemIdMicrosoftGraphInvitePostRequestbodyContentApplicationJsonSchema |
| 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 |
-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 |
-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.PowerShell.Models.IGroupsIdentity
Microsoft.Graph.PowerShell.Models.IPathsLx1Fn7GroupsGroupIdDrivesDriveIdItemsDriveitemIdMicrosoftGraphInvitePostRequestbodyContentApplicationJsonSchema
System.Collections.IDictionary
Outputs
Microsoft.Graph.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 <IPathsLx1Fn7GroupsGroupIdDrivesDriveIdItemsDriveitemIdMicrosoftGraphInvitePostRequestbodyContentApplicationJsonSchema>: .
[(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 <IGroupsIdentity>: Identity Parameter
[AttachmentId <String>]: The unique identifier of attachment[BaseSitePageId <String>]: The unique identifier of baseSitePage[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[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}'[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[GroupSettingId <String>]: The unique identifier of groupSetting[GroupSettingTemplateId <String>]: The unique identifier of groupSettingTemplate[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[NotebookId <String>]: The unique identifier of notebook[OnenotePageId <String>]: The unique identifier of onenotePage[OnenoteSectionId <String>]: The unique identifier of onenoteSection[Path <String>]: Usage: path='{path}'[PermissionId <String>]: The unique identifier of permission[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[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}'[WebPartId <String>]: The unique identifier of webPart
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.