Grant-MgSharePermission

Module:

Microsoft.Graph.Files Module

Grant users access to a link represented by a permission.

Note

To view the beta release of this cmdlet, view Grant-MgBetaSharePermission

Syntax

GrantExpanded (Default)

Grant-MgSharePermission
    -SharedDriveItemId <string>
    [-ResponseHeadersVariable <string>]
    [-AdditionalProperties <hashtable>]
    [-Recipients <IMicrosoftGraphDriveRecipient[]>]
    [-Roles <string[]>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Grant

Grant-MgSharePermission
    -SharedDriveItemId <string>
    -BodyParameter <IPaths1Mcxy93SharesShareddriveitemIdPermissionMicrosoftGraphGrantPostRequestbodyContentApplicationJsonSchema>
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

GrantViaIdentityExpanded

Grant-MgSharePermission
    -InputObject <IFilesIdentity>
    [-ResponseHeadersVariable <string>]
    [-AdditionalProperties <hashtable>]
    [-Recipients <IMicrosoftGraphDriveRecipient[]>]
    [-Roles <string[]>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

GrantViaIdentity

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

Description

Grant users access to a link represented by a permission.

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)	Not supported
Application	Files.ReadWrite.All, Sites.ReadWrite.All,

Examples

Example 1: Code snippet

Import-Module Microsoft.Graph.Files

$params = @{
	recipients = @(
		@{
			email = "john@contoso.com"
		}
		@{
			email = "ryan@external.com"
		}
	)
	roles = @(
	"read"
)
}

Grant-MgSharePermission -SharedDriveItemId $sharedDriveItemId -BodyParameter $params

This example shows how to use the Grant-MgSharePermission Cmdlet.

Parameters

-AdditionalProperties

Additional Parameters

Parameter properties

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

Parameter sets

GrantViaIdentityExpanded

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

GrantExpanded

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

Parameter sets

GrantViaIdentity

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

Grant

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

-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

GrantViaIdentityExpanded

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

GrantViaIdentity

Position:	Named
Mandatory:	True
Value from pipeline:	True
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

GrantViaIdentityExpanded

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

GrantExpanded

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

-Roles

Grant users access to a link represented by a permission.

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)	Not supported
Application	Files.ReadWrite.All, Sites.ReadWrite.All,

Parameter properties

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

Parameter sets

GrantViaIdentityExpanded

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

GrantExpanded

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

-SharedDriveItemId

The unique identifier of sharedDriveItem

Parameter properties

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

Parameter sets

GrantExpanded

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

Grant

Position:	Named
Mandatory:	True
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.IPaths1Mcxy93SharesShareddriveitemIdPermissionMicrosoftGraphGrantPostRequestbodyContentApplicationJsonSchema

{{ 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 <IPaths1Mcxy93SharesShareddriveitemIdPermissionMicrosoftGraphGrantPostRequestbodyContentApplicationJsonSchema>: . [(Any) <Object>]: This indicates any property can be added to this object. [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. [Roles <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}' [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.

Related Links

• Grant-MgSharePermission
• Graph API Reference