New-MgBetaSiteListItemLink

Create a sharing link for a listItem. The createLink action creates a new sharing link if the specified link type doesn't already exist for the calling application.\rIf a sharing link of the specified type already exists for the app, this action returns the existing sharing link. listItem resources inherit sharing permissions from the list the item resides in.

Note

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

Syntax

CreateExpanded (Default)

New-MgBetaSiteListItemLink
    -ListId <string>
    -ListItemId <string>
    -SiteId <string>
    [-ResponseHeadersVariable <string>]
    [-AdditionalProperties <hashtable>]
    [-ExpirationDateTime <datetime>]
    [-Message <string>]
    [-Password <string>]
    [-Recipients <IMicrosoftGraphDriveRecipient[]>]
    [-RetainInheritedPermissions]
    [-Scope <string>]
    [-SendNotification]
    [-Type <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Create

New-MgBetaSiteListItemLink
    -ListId <string>
    -ListItemId <string>
    -SiteId <string>
    -BodyParameter <IPaths1HqqvqwSitesSiteIdListsListIdItemsListitemIdMicrosoftGraphCreatelinkPostRequestbodyContentApplicationJsonSchema>
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

CreateViaIdentityExpanded

New-MgBetaSiteListItemLink
    -InputObject <ISitesIdentity>
    [-ResponseHeadersVariable <string>]
    [-AdditionalProperties <hashtable>]
    [-ExpirationDateTime <datetime>]
    [-Message <string>]
    [-Password <string>]
    [-Recipients <IMicrosoftGraphDriveRecipient[]>]
    [-RetainInheritedPermissions]
    [-Scope <string>]
    [-SendNotification]
    [-Type <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

CreateViaIdentity

New-MgBetaSiteListItemLink
    -InputObject <ISitesIdentity>
    -BodyParameter <IPaths1HqqvqwSitesSiteIdListsListIdItemsListitemIdMicrosoftGraphCreatelinkPostRequestbodyContentApplicationJsonSchema>
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Create a sharing link for a listItem. The createLink action creates a new sharing link if the specified link type doesn't already exist for the calling application.\rIf a sharing link of the specified type already exists for the app, this action returns the existing sharing link. listItem resources inherit sharing permissions from the list the item resides in.

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

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

New-MgBetaSiteListItemLink -SiteId $siteId -ListId $listId -ListItemId $listItemId -BodyParameter $params

This example will create an anonymous sharing link


Import-Module Microsoft.Graph.Beta.Sites

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

New-MgBetaSiteListItemLink -SiteId $siteId -ListId $listId -ListItemId $listItemId -BodyParameter $params

This example shows creating company sharable links


Import-Module Microsoft.Graph.Beta.Sites

$params = @{
	type = "embed"
}

New-MgBetaSiteListItemLink -SiteId $siteId -ListId $listId -ListItemId $listItemId -BodyParameter $params

This example shows creating embeddable links

Parameters

-AdditionalProperties

Additional Parameters

Parameter properties

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

Parameter sets

CreateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
CreateExpanded
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.Beta.PowerShell.Models.IPaths1HqqvqwSitesSiteIdListsListIdItemsListitemIdMicrosoftGraphCreatelinkPostRequestbodyContentApplicationJsonSchema
Supports wildcards:False
DontShow:False

Parameter sets

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

-ExpirationDateTime

Create a sharing link for a listItem. The createLink action creates a new sharing link if the specified link type doesn't already exist for the calling application.\rIf a sharing link of the specified type already exists for the app, this action returns the existing sharing link. listItem resources inherit sharing permissions from the list the item resides in.

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.DateTime
Supports wildcards:False
DontShow:False

Parameter sets

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

-ListId

The unique identifier of list

Parameter properties

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

-ListItemId

The unique identifier of listItem

Parameter properties

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

-Message

Create a sharing link for a listItem. The createLink action creates a new sharing link if the specified link type doesn't already exist for the calling application.\rIf a sharing link of the specified type already exists for the app, this action returns the existing sharing link. listItem resources inherit sharing permissions from the list the item resides in.

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

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

-Password

Create a sharing link for a listItem. The createLink action creates a new sharing link if the specified link type doesn't already exist for the calling application.\rIf a sharing link of the specified type already exists for the app, this action returns the existing sharing link. listItem resources inherit sharing permissions from the list the item resides in.

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

CreateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
CreateExpanded
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.Beta.PowerShell.Models.IMicrosoftGraphDriveRecipient[]

Supports wildcards:False
DontShow:False

Parameter sets

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

Create a sharing link for a listItem. The createLink action creates a new sharing link if the specified link type doesn't already exist for the calling application.\rIf a sharing link of the specified type already exists for the app, this action returns the existing sharing link. listItem resources inherit sharing permissions from the list the item resides in.

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

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

-Scope

Create a sharing link for a listItem. The createLink action creates a new sharing link if the specified link type doesn't already exist for the calling application.\rIf a sharing link of the specified type already exists for the app, this action returns the existing sharing link. listItem resources inherit sharing permissions from the list the item resides in.

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

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

-SendNotification

Create a sharing link for a listItem. The createLink action creates a new sharing link if the specified link type doesn't already exist for the calling application.\rIf a sharing link of the specified type already exists for the app, this action returns the existing sharing link. listItem resources inherit sharing permissions from the list the item resides in.

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

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

-SiteId

The unique identifier of site

Parameter properties

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

-Type

Create a sharing link for a listItem. The createLink action creates a new sharing link if the specified link type doesn't already exist for the calling application.\rIf a sharing link of the specified type already exists for the app, this action returns the existing sharing link. listItem resources inherit sharing permissions from the list the item resides in.

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

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

{{ Fill in the Description }}

Microsoft.Graph.Beta.PowerShell.Models.ISitesIdentity

{{ Fill in the Description }}

System.Collections.IDictionary

{{ Fill in the Description }}

Outputs

Microsoft.Graph.Beta.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 <IPaths1HqqvqwSitesSiteIdListsListIdItemsListitemIdMicrosoftGraphCreatelinkPostRequestbodyContentApplicationJsonSchema>: . [(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 (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. [RetainInheritedPermissions <Boolean?>]: [Scope <String>]: [SendNotification <Boolean?>]: [Type <String>]:

INPUTOBJECT <ISitesIdentity>: Identity Parameter [BaseItemId <String>]: The unique identifier of baseItem [BaseSitePageId <String>]: The unique identifier of baseSitePage [BitlockerRecoveryKeyId <String>]: The unique identifier of bitlockerRecoveryKey [ColumnDefinitionId <String>]: The unique identifier of columnDefinition [ColumnLinkId <String>]: The unique identifier of columnLink [ContentFormats <String[]>]: Usage: contentFormats={contentFormats} [ContentModelId <String>]: The unique identifier of contentModel [ContentTypeId <String>]: The unique identifier of contentType [ContentTypeId1 <String>]: The unique identifier of contentType [DataLossPreventionPolicyId <String>]: The unique identifier of dataLossPreventionPolicy [DocumentProcessingJobId <String>]: The unique identifier of documentProcessingJob [DocumentSetVersionId <String>]: The unique identifier of documentSetVersion [DriveId <String>]: The unique identifier of drive [EndDateTime <String>]: Usage: endDateTime='{endDateTime}' [ExtensionId <String>]: The unique identifier of extension [GroupId <String>]: The unique identifier of group [GroupId1 <String>]: The unique identifier of group [HorizontalSectionColumnId <String>]: The unique identifier of horizontalSectionColumn [HorizontalSectionId <String>]: The unique identifier of horizontalSection [IncludePersonalNotebooks <Boolean?>]: Usage: includePersonalNotebooks={includePersonalNotebooks} [InformationProtectionLabelId <String>]: The unique identifier of informationProtectionLabel [Interval <String>]: Usage: interval='{interval}' [ItemActivityId <String>]: The unique identifier of itemActivity [ItemActivityOldId <String>]: The unique identifier of itemActivityOLD [ItemActivityStatId <String>]: The unique identifier of itemActivityStat [LabelIds <String[]>]: Usage: labelIds={labelIds} [ListId <String>]: The unique identifier of list [ListItemId <String>]: The unique identifier of listItem [ListItemVersionId <String>]: The unique identifier of listItemVersion [Locale <String>]: Usage: locale='{locale}' [ModelName <String>]: Usage: modelName='{modelName}' [NotebookId <String>]: The unique identifier of notebook [OnenoteOperationId <String>]: The unique identifier of onenoteOperation [OnenotePageId <String>]: The unique identifier of onenotePage [OnenoteResourceId <String>]: The unique identifier of onenoteResource [OnenoteSectionId <String>]: The unique identifier of onenoteSection [OperationId <String>]: Usage: operationId='{operationId}' [PageTemplateId <String>]: The unique identifier of pageTemplate [Path <String>]: Usage: path='{path}' [PermissionId <String>]: The unique identifier of permission [RecycleBinItemId <String>]: The unique identifier of recycleBinItem [RelationId <String>]: The unique identifier of relation [RichLongRunningOperationId <String>]: The unique identifier of richLongRunningOperation [SectionGroupId <String>]: The unique identifier of sectionGroup [SectionGroupId1 <String>]: The unique identifier of sectionGroup [SensitivityLabelId <String>]: The unique identifier of sensitivityLabel [SensitivityLabelId1 <String>]: The unique identifier of sensitivityLabel [SetId <String>]: The unique identifier of set [SetId1 <String>]: The unique identifier of set [SiteId <String>]: The unique identifier of site [SiteId1 <String>]: The unique identifier of site [StartDateTime <String>]: Usage: startDateTime='{startDateTime}' [SubscriptionId <String>]: The unique identifier of subscription [TermId <String>]: The unique identifier of term [TermId1 <String>]: The unique identifier of term [ThreatAssessmentRequestId <String>]: The unique identifier of threatAssessmentRequest [ThreatAssessmentResultId <String>]: The unique identifier of threatAssessmentResult [Token <String>]: Usage: token='{token}' [UserId <String>]: The unique identifier of 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 (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.