Get-AzStorageFile

Module:

Az.Storage Module

Lists directories and files for a path.

Syntax

ShareName (Default)

Get-AzStorageFile
    [-ShareName] <String>
    [[-Path] <String>]
    [-ExcludeExtendedInfo]
    [-DisAllowTrailingDot]
    [-Context <IStorageContext>]
    [-ServerTimeoutPerRequest <Int32>]
    [-ClientTimeoutPerRequest <Int32>]
    [-DefaultProfile <IAzureContextContainer>]
    [-ConcurrentTaskCount <Int32>]
    [<CommonParameters>]

Share

Get-AzStorageFile
    [-ShareClient] <ShareClient>
    [[-Path] <String>]
    [-ExcludeExtendedInfo]
    [-Context <IStorageContext>]
    [-ServerTimeoutPerRequest <Int32>]
    [-ClientTimeoutPerRequest <Int32>]
    [-DefaultProfile <IAzureContextContainer>]
    [-ConcurrentTaskCount <Int32>]
    [<CommonParameters>]

Directory

Get-AzStorageFile
    [-ShareDirectoryClient] <ShareDirectoryClient>
    [[-Path] <String>]
    [-ExcludeExtendedInfo]
    [-Context <IStorageContext>]
    [-ServerTimeoutPerRequest <Int32>]
    [-ClientTimeoutPerRequest <Int32>]
    [-DefaultProfile <IAzureContextContainer>]
    [-ConcurrentTaskCount <Int32>]
    [<CommonParameters>]

Description

The Get-AzStorageFile cmdlet lists directories and files for the share or directory that you specify. Specify the Path parameter to get an instance of a directory or file in the specified path. This cmdlet returns AzureStorageFile and AzureStorageDirectory objects. You can use the IsDirectory property to distinguish between folders and files.

Examples

Example 1: List directories in a share

Get-AzStorageFile -ShareName "ContosoShare06" | Where-Object {$_.GetType().Name -eq "AzureStorageFileDirectory"}

This command lists only the directories in the share ContosoShare06. It first retrieves both files and directories, passes them to the where operator by using the pipeline operator, then discards any objects whose type is not "AzureStorageFileDirectory".

Example 2: List a File Directory

Get-AzStorageFile -ShareName "ContosoShare06" -Path "ContosoWorkingFolder" | Get-AzStorageFile

This command lists the files and folders in the directory ContosoWorkingFolder under the share ContosoShare06. It first gets the directory instance, and then pipelines it to the Get-AzStorageFile cmdlet to list the directory.

Example 3: List files and directories in a share, and exclude extended info

Get-AzStorageFile -ShareName "ContosoShare06" -ExcludeExtendedInfo

This command lists the files and folders in under the share ContosoShare06, and exclude extended file info like timestamps, ETag, attributes, permissionKey in list file and Directory. Currently, -ExcludeExtendedInfo will be needed to list files and directories from NFS file share or from a directory in NFS file share.

Parameters

-ClientTimeoutPerRequest

Specifies the client side time-out interval, in seconds, for one service request. If the previous call fails within the specified interval, this cmdlet retries the request. If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error.

Parameter properties

Type:	Nullable<T>[Int32]
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	ClientTimeoutPerRequestInSeconds

Parameter sets

(All)

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

-ConcurrentTaskCount

Specifies the maximum concurrent network calls. You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. The specified value is an absolute count and is not multiplied by the core count. This parameter can help mitigate network connection problems in low bandwidth environments, such as 100 kilobits per second. The default value is 10.

Parameter properties

Type:	Nullable<T>[Int32]
Default value:	None
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

-Context

Specifies an Azure Storage context. To obtain a Storage context, use the New-AzStorageContext cmdlet.

Parameter properties

Type:	IStorageContext
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

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

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Parameter properties

Type:	IAzureContextContainer
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	AzureRmContext, AzureCredential

Parameter sets

(All)

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

-DisAllowTrailingDot

Disallow trailing dot (.) to suffix directory and file names.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ShareName

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

-ExcludeExtendedInfo

Not include extended file info like timestamps, ETag, attributes, permissionKey in list file and Directory.

Parameter properties

Type:	SwitchParameter
Default value:	None
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

-Path

Specifies the path of a folder. If you omit the Path parameter, Get-AzStorageFile lists the directories and files in the specified file share or directory. If you include the Path parameter, Get-AzStorageFile returns an instance of a directory or file in the specified path.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

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

-ServerTimeoutPerRequest

Specifies the service-side timeout interval, in seconds, for a request. If the specified interval elapses before the service processes the request, the Storage service returns an error.

Parameter properties

Type:	Nullable<T>[Int32]
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	ServerTimeoutPerRequestInSeconds

Parameter sets

(All)

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

-ShareClient

ShareClient object indicated the share where the files/directories would be listed.

Parameter properties

Type:	ShareClient
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

Share

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

-ShareDirectoryClient

ShareDirectoryClient object indicated the base folder where the files/directories would be listed.

Parameter properties

Type:	ShareDirectoryClient
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

Directory

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

-ShareName

Specifies the name of the file share. This cmdlet gets a file or directory from the file share that this parameter specifies.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ShareName

Position:	0
Mandatory:	True
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

ShareClient

ShareDirectoryClient

IStorageContext

Outputs

AzureStorageFile

Related Links

• Get-AzStorageFileContent
• New-AzStorageDirectory
• Remove-AzStorageDirectory
• Remove-AzStorageFile
• Set-AzStorageFileContent