Skip to content

Latest commit

 

History

History
168 lines (128 loc) · 3.29 KB

Get-KshSharingInfo.md

File metadata and controls

168 lines (128 loc) · 3.29 KB
external help file Module Name online version schema
SPClientCore.dll-Help.xml
SPClientCore
2.0.0

Get-KshSharingInfo

SYNOPSIS

Retrieves a sharing information.

SYNTAX

Get-KshSharingInfo -Url <Uri> [-CheckForAccessRequests <Boolean>] [-ExcludeCurrentUser <Boolean>]
 [-ExcludeSecurityGroups <Boolean>] [-ExcludeSiteAdmin <Boolean>] [-RetrieveAnonymousLinks <Boolean>]
 [-RetrievePermissionLevels <Boolean>] [-RetrieveUserInfoDetails <Boolean>] [<CommonParameters>]

DESCRIPTION

The Get-KshSharingInfo cmdlet retrieves a sharing information of the specified URL.

EXAMPLES

Example 1

PS C:\> Get-KshSharingInfo -Url 'https://example.sharepoint.com/Shared%20Documents/README.txt'

Retrieves a sharing information.

PARAMETERS

-CheckForAccessRequests

Specifies whether to check for access requests.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-ExcludeCurrentUser

Specifies whether to exclude the current user.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-ExcludeSecurityGroups

Specifies whether to exclude security groups.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-ExcludeSiteAdmin

Specifies whether to exclude the site administrators.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-RetrieveAnonymousLinks

Specifies whether to retrieve anonymous links.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-RetrievePermissionLevels

Specifies whether to retrieve permission levels.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-RetrieveUserInfoDetails

Specifies whether to retrieve user information details.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-Url

Specifies the URL.

Type: Uri
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
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

None

OUTPUTS

Karamem0.SharePoint.PowerShell.Models.V1.SharingInfo

NOTES

RELATED LINKS