Share via

New-MgBetaDriveItemLink

Module:
Microsoft.Graph.Beta.Files Module

Create a link to share a driveItem driveItem.The createLink action creates a new sharing link if the specified link type doesn't already exist for the calling application.If a sharing link of the specified type already exists for the app, the existing sharing link is returned. DriveItem resources inherit sharing permissions from their ancestors.

Note

To view the v1.0 release of this cmdlet, view New-MgDriveItemLink

Syntax

CreateExpanded (Default) 

New-MgBetaDriveItemLink
    -DriveId <String>
    -DriveItemId <String>
    [-ResponseHeadersVariable <String>]
    [-AdditionalProperties <Hashtable>]
    [-ExpirationDateTime <DateTime>]
    [-Message <String>]
    [-Password <String>]
    [-Recipients <IMicrosoftGraphDriveRecipient[]>]
    [-RetainInheritedPermissions]
    [-Scope <String>]
    [-SendNotification]
    [-Type <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Create 

New-MgBetaDriveItemLink
    -DriveId <String>
    -DriveItemId <String>
    -BodyParameter <IPaths1Sp1J5CDrivesDriveIdItemsDriveitemIdMicrosoftGraphCreatelinkPostRequestbodyContentApplicationJsonSchema>
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

CreateViaIdentityExpanded 

New-MgBetaDriveItemLink
    -InputObject <IFilesIdentity>
    [-ResponseHeadersVariable <String>]
    [-AdditionalProperties <Hashtable>]
    [-ExpirationDateTime <DateTime>]
    [-Message <String>]
    [-Password <String>]
    [-Recipients <IMicrosoftGraphDriveRecipient[]>]
    [-RetainInheritedPermissions]
    [-Scope <String>]
    [-SendNotification]
    [-Type <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

CreateViaIdentity 

New-MgBetaDriveItemLink
    -InputObject <IFilesIdentity>
    -BodyParameter <IPaths1Sp1J5CDrivesDriveIdItemsDriveitemIdMicrosoftGraphCreatelinkPostRequestbodyContentApplicationJsonSchema>
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Create a link to share a driveItem driveItem.The createLink action creates a new sharing link if the specified link type doesn't already exist for the calling application.If a sharing link of the specified type already exists for the app, the existing sharing link is returned. DriveItem resources inherit sharing permissions from their ancestors.

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


Import-Module Microsoft.Graph.Beta.Files

$params = @{
	type = "view"
	scope = "anonymous"
	password = "String"
	recipients = @(
		@{
			"@odata.type" = "microsoft.graph.driveRecipient"
		}
	)
	sendNotification = $true
	retainInheritedPermissions = $false
}

New-MgBetaDriveItemLink -DriveId $driveId -DriveItemId $driveItemId -BodyParameter $params

This example will create an anonymous sharing link


Import-Module Microsoft.Graph.Beta.Files

$params = @{
	type = "edit"
	scope = "organization"
}

New-MgBetaDriveItemLink -DriveId $driveId -DriveItemId $driveItemId -BodyParameter $params

This example shows creating company sharable links


Import-Module Microsoft.Graph.Beta.Files

$params = @{
	type = "embed"
}

New-MgBetaDriveItemLink -DriveId $driveId -DriveItemId $driveItemId -BodyParameter $params

This example shows creating embeddable links

Parameters

-AdditionalProperties

Additional Parameters

Parameter properties

Type:Hashtable
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
CreateViaIdentityExpanded
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:IPaths1Sp1J5CDrivesDriveIdItemsDriveitemIdMicrosoftGraphCreatelinkPostRequestbodyContentApplicationJsonSchema
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Create
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
CreateViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
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:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Create
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:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Create
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ExpirationDateTime

Create a link to share a driveItem driveItem.The createLink action creates a new sharing link if the specified link type doesn't already exist for the calling application.If a sharing link of the specified type already exists for the app, the existing sharing link is returned. DriveItem resources inherit sharing permissions from their ancestors.

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:DateTime
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
CreateViaIdentityExpanded
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:IDictionary
Default value:None
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

-InputObject

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

Parameter properties

Type:IFilesIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateViaIdentityExpanded
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
CreateViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Message

Create a link to share a driveItem driveItem.The createLink action creates a new sharing link if the specified link type doesn't already exist for the calling application.If a sharing link of the specified type already exists for the app, the existing sharing link is returned. DriveItem resources inherit sharing permissions from their ancestors.

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:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
CreateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Password

Create a link to share a driveItem driveItem.The createLink action creates a new sharing link if the specified link type doesn't already exist for the calling application.If a sharing link of the specified type already exists for the app, the existing sharing link is returned. DriveItem resources inherit sharing permissions from their ancestors.

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:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
CreateViaIdentityExpanded
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:

IMicrosoftGraphDriveRecipient[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
CreateViaIdentityExpanded
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:String
Default value:None
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

Create a link to share a driveItem driveItem.The createLink action creates a new sharing link if the specified link type doesn't already exist for the calling application.If a sharing link of the specified type already exists for the app, the existing sharing link is returned. DriveItem resources inherit sharing permissions from their ancestors.

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:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
CreateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Scope

Create a link to share a driveItem driveItem.The createLink action creates a new sharing link if the specified link type doesn't already exist for the calling application.If a sharing link of the specified type already exists for the app, the existing sharing link is returned. DriveItem resources inherit sharing permissions from their ancestors.

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:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
CreateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SendNotification

Create a link to share a driveItem driveItem.The createLink action creates a new sharing link if the specified link type doesn't already exist for the calling application.If a sharing link of the specified type already exists for the app, the existing sharing link is returned. DriveItem resources inherit sharing permissions from their ancestors.

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:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
CreateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Type

Create a link to share a driveItem driveItem.The createLink action creates a new sharing link if the specified link type doesn't already exist for the calling application.If a sharing link of the specified type already exists for the app, the existing sharing link is returned. DriveItem resources inherit sharing permissions from their ancestors.

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:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
CreateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:None
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.Beta.PowerShell.Models.IFilesIdentity

Microsoft.Graph.Beta.PowerShell.Models.IPaths1Sp1J5CDrivesDriveIdItemsDriveitemIdMicrosoftGraphCreatelinkPostRequestbodyContentApplicationJsonSchema

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

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [ExpirationDateTime <DateTime?>]:
  • [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.
  • [RetainInheritedPermissions <Boolean?>]:
  • [Scope <String>]:
  • [SendNotification <Boolean?>]:
  • [Type <String>]:

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}'
  • [ExtensionId <String>]: The unique identifier of extension
  • [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.