Skip to content

Latest commit

 

History

History
371 lines (291 loc) · 9.3 KB

Get-MgDriveItemPermission.md

File metadata and controls

371 lines (291 loc) · 9.3 KB
Raw
external help file Module Name online version schema
Microsoft.Graph.Files-help.xml
Microsoft.Graph.Files
2.0.0

Get-MgDriveItemPermission

SYNOPSIS

Return the effective sharing permission for a particular permission resource. Effective permissions of an item can come from two sources: permissions set directly on the item itself or permissions that are inherited from the item's ancestors. Callers can differentiate if the permission is inherited or not by checking the inheritedFrom property.This property is an ItemReference resource referencing the ancestor that the permission is inherited from.

Note

To view the beta release of this cmdlet, view Get-MgBetaDriveItemPermission

SYNTAX

List (Default)

Get-MgDriveItemPermission -DriveId <String> -DriveItemId <String> [-ExpandProperty <String[]>]
 [-Property <String[]>] [-Filter <String>] [-Search <String>] [-Skip <Int32>] [-Sort <String[]>] [-Top <Int32>]
 [-ResponseHeadersVariable <String>] [-Headers <IDictionary>] [-PageSize <Int32>] [-All]
 [-CountVariable <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Get

Get-MgDriveItemPermission -DriveId <String> -DriveItemId <String> -PermissionId <String>
 [-ExpandProperty <String[]>] [-Property <String[]>] [-ResponseHeadersVariable <String>]
 [-Headers <IDictionary>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

GetViaIdentity

Get-MgDriveItemPermission -InputObject <IFilesIdentity> [-ExpandProperty <String[]>] [-Property <String[]>]
 [-ResponseHeadersVariable <String>] [-Headers <IDictionary>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

DESCRIPTION

Return the effective sharing permission for a particular permission resource. Effective permissions of an item can come from two sources: permissions set directly on the item itself or permissions that are inherited from the item's ancestors. Callers can differentiate if the permission is inherited or not by checking the inheritedFrom property.This property is an ItemReference resource referencing the ancestor that the permission is inherited from.

EXAMPLES

Example 1: Code snippet

Import-Module Microsoft.Graph.Files

Get-MgDriveItemPermission -DriveId $driveId -DriveItemId $driveItemId

This example shows how to use the Get-MgDriveItemPermission Cmdlet.

PARAMETERS

-All

List all pages.

Type: SwitchParameter
Parameter Sets: List
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-CountVariable

Specifies a count of the total number of items in a collection. By default, this variable will be set in the global scope.

Type: String
Parameter Sets: List
Aliases: CV

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DriveId

The unique identifier of drive

Type: String
Parameter Sets: List, Get
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DriveItemId

The unique identifier of driveItem

Type: String
Parameter Sets: List, Get
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ExpandProperty

Expand related entities

Type: String[]
Parameter Sets: (All)
Aliases: Expand

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Filter

Filter items by property values

Type: String
Parameter Sets: List
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Headers

Optional headers that will be added to the request.

Type: IDictionary
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-InputObject

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

Type: IFilesIdentity
Parameter Sets: GetViaIdentity
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-PageSize

Sets the page size of results.

Type: Int32
Parameter Sets: List
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-PermissionId

The unique identifier of permission

Type: String
Parameter Sets: Get
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Property

Select properties to be returned

Type: String[]
Parameter Sets: (All)
Aliases: Select

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ResponseHeadersVariable

Optional Response Headers Variable.

Type: String
Parameter Sets: (All)
Aliases: RHV

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Search

Search items by search phrases

Type: String
Parameter Sets: List
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Sort

Order items by property values

Type: String[]
Parameter Sets: List
Aliases: OrderBy

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Top

Show only the first n items

Type: Int32
Parameter Sets: List
Aliases: Limit

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Skip

Skip the first n items

Type: Int32
Parameter Sets: List
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

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

INPUTS

Microsoft.Graph.PowerShell.Models.IFilesIdentity

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.

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

RELATED LINKS

https://learn.microsoft.com/powershell/module/microsoft.graph.files/get-mgdriveitempermission

https://learn.microsoft.com/graph/api/permission-get?view=graph-rest-1.0

https://learn.microsoft.com/graph/api/driveitem-list-permissions?view=graph-rest-1.0