Skip to content

Latest commit

 

History

History
262 lines (202 loc) · 4.64 KB

Get-KshFile.md

File metadata and controls

262 lines (202 loc) · 4.64 KB
external help file Module Name online version schema
SPClientCore.dll-Help.xml
SPClientCore
2.0.0

Get-KshFile

SYNOPSIS

Retrieves one or more files.

SYNTAX

ParamSet1

Get-KshFile [-Identity] <File> [<CommonParameters>]

ParamSet2

Get-KshFile [-AttachmentFile] <AttachmentFile> [<CommonParameters>]

ParamSet3

Get-KshFile [-FileVersion] <FileVersion> [<CommonParameters>]

ParamSet4

Get-KshFile [-App] <App> [<CommonParameters>]

ParamSet5

Get-KshFile [-ListItem] <ListItem> [<CommonParameters>]

ParamSet6

Get-KshFile [-FileId] <Guid> [<CommonParameters>]

ParamSet7

Get-KshFile [-FileUrl] <Uri> [<CommonParameters>]

ParamSet8

Get-KshFile [-Folder] <Folder> [-FileName] <String> [<CommonParameters>]

ParamSet9

Get-KshFile [-Folder] <Folder> [-NoEnumerate] [<CommonParameters>]

DESCRIPTION

The Get-KshFile cmdlet retrieves files of the specified folder.

EXAMPLES

Example 1

PS C:\> Get-KshFile -FileId '2c7ceb97-193f-4d05-91a5-a03c6d58ae60'

Retrieves a file by file ID.

Example 2

PS C:\> Get-KshFile -FileUrl '/sites/japan/hr/Shared%20Documents/README.txt'

Retrieves a file by file URL.

Example 3

PS C:\> Get-KshFile -Folder '/sites/japan/hr/Shared%20Documents' -FileName 'README.txt'

Retrieves a file by folder and file name.

Example 4

PS C:\> Get-KshFile -Folder '/sites/japan/hr/Shared%20Documents'

Retrieves all files.

PARAMETERS

-App

Specifies the app.

Type: App
Parameter Sets: ParamSet4
Aliases:

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

-AttachmentFile

Specifies the attachment file.

Type: AttachmentFile
Parameter Sets: ParamSet2
Aliases:

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

-FileId

Specifies the file ID.

Type: Guid
Parameter Sets: ParamSet6
Aliases:

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

-FileName

Specifies the file name.

Type: String
Parameter Sets: ParamSet8
Aliases:

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

-FileUrl

Specifies the file URL.

Type: Uri
Parameter Sets: ParamSet7
Aliases:

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

-FileVersion

Specifies the file version.

Type: FileVersion
Parameter Sets: ParamSet3
Aliases:

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

-Folder

Specifies the folder.

Type: Folder
Parameter Sets: ParamSet8, ParamSet9
Aliases:

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

-Identity

Specifies the file.

Type: File
Parameter Sets: ParamSet1
Aliases:

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

-ListItem

Specifies the list item.

Type: ListItem
Parameter Sets: ParamSet5
Aliases:

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

-NoEnumerate

If specified, suppresses to enumerate objects.

Type: SwitchParameter
Parameter Sets: ParamSet9
Aliases:

Required: False
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

Karamem0.SharePoint.PowerShell.Models.V1.File

Karamem0.SharePoint.PowerShell.Models.V1.AttachmentFile

Karamem0.SharePoint.PowerShell.Models.V1.FileVersion

Karamem0.SharePoint.PowerShell.Models.V1.App

Karamem0.SharePoint.PowerShell.Models.V1.ListItem

OUTPUTS

Karamem0.SharePoint.PowerShell.Models.V1.File

NOTES

RELATED LINKS