< Back
Get-AzureStorageFile
Post
NAME Get-AzureStorageFile
SYNOPSIS
Lists directories and files for a path.
SYNTAX
Get-AzureStorageFile [-ShareName] <String> [[-Path] <String>] [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>] [-Context
<IStorageContext>] [-ServerTimeoutPerRequest <Int32>] [<CommonParameters>]
Get-AzureStorageFile [-Directory] <CloudFileDirectory> [[-Path] <String>] [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>]
[-ServerTimeoutPerRequest <Int32>] [<CommonParameters>]
Get-AzureStorageFile [-Share] <CloudFileShare> [[-Path] <String>] [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>]
[-ServerTimeoutPerRequest <Int32>] [<CommonParameters>]
DESCRIPTION
The Get-AzureStorageFile 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.
PARAMETERS
-ClientTimeoutPerRequest <Int32>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ConcurrentTaskCount <Int32>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Context <IStorageContext>
Specifies an Azure Storage context. To obtain a Storage context, use the New-AzureStorageContext cmdlet.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-Directory <CloudFileDirectory>
Specifies a folder as a CloudFileDirectory object. This cmdlet gets the folder that this parameter specifies. To obtain a directory, use the
New-AzureStorageDirectory cmdlet. You can also use the Get-AzureStorageFile cmdlet to obtain a directory.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Path <String>
Specifies the path of a folder.
If you omit the Path parameter, Get-AzureStorageFile lists the directories and files in the specified file share or directory. If you include
the Path parameter, Get-AzureStorageFile returns an instance of a directory or file in the specified path.
Required? false
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ServerTimeoutPerRequest <Int32>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Share <CloudFileShare>
Specifies a CloudFileShare object. This cmdlet gets a file or directory from the file share that this parameter specifies. To obtain a
CloudFileShare object, use the Get-AzureStorageShare cmdlet. This object contains the Storage context. If you specify this parameter, do not
specify the Context parameter.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-ShareName <String>
Specifies the name of the file share. This cmdlet gets a file or directory from the file share that this parameter specifies.
Required? true
Position? 0
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
IStorageContext
Parameter 'Context' accepts value of type 'IStorageContext' from the pipeline
CloudFileDirectory
Parameter 'Directory' accepts value of type 'CloudFileDirectory' from the pipeline
CloudFileShare
Parameter 'Share' accepts value of type 'CloudFileShare' from the pipeline
OUTPUTS
NOTES
Example 1: List directories in a share
PS C:\\>Get-AzureStorageFile -ShareName "ContosoShare06" | where {$_.GetType().Name -eq "CloudFileDirectory"}
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 "CloudFileDirectory".
Example 2: List a File Directory
PS C:\\> Get-AzureStorageFile -ShareName "ContosoShare06" -Path "ContosoWorkingFolder" | Get-AzureStorageFile
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-AzureStorageFile cmdlet to list the directory.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... toragefile
Get-AzureStorageFileContent
New-AzureStorageDirectory
Remove-AzureStorageDirectory
Remove-AzureStorageFile
Set-AzureStorageFileContent
SYNOPSIS
Lists directories and files for a path.
SYNTAX
Get-AzureStorageFile [-ShareName] <String> [[-Path] <String>] [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>] [-Context
<IStorageContext>] [-ServerTimeoutPerRequest <Int32>] [<CommonParameters>]
Get-AzureStorageFile [-Directory] <CloudFileDirectory> [[-Path] <String>] [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>]
[-ServerTimeoutPerRequest <Int32>] [<CommonParameters>]
Get-AzureStorageFile [-Share] <CloudFileShare> [[-Path] <String>] [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>]
[-ServerTimeoutPerRequest <Int32>] [<CommonParameters>]
DESCRIPTION
The Get-AzureStorageFile 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.
PARAMETERS
-ClientTimeoutPerRequest <Int32>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ConcurrentTaskCount <Int32>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Context <IStorageContext>
Specifies an Azure Storage context. To obtain a Storage context, use the New-AzureStorageContext cmdlet.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-Directory <CloudFileDirectory>
Specifies a folder as a CloudFileDirectory object. This cmdlet gets the folder that this parameter specifies. To obtain a directory, use the
New-AzureStorageDirectory cmdlet. You can also use the Get-AzureStorageFile cmdlet to obtain a directory.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Path <String>
Specifies the path of a folder.
If you omit the Path parameter, Get-AzureStorageFile lists the directories and files in the specified file share or directory. If you include
the Path parameter, Get-AzureStorageFile returns an instance of a directory or file in the specified path.
Required? false
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ServerTimeoutPerRequest <Int32>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Share <CloudFileShare>
Specifies a CloudFileShare object. This cmdlet gets a file or directory from the file share that this parameter specifies. To obtain a
CloudFileShare object, use the Get-AzureStorageShare cmdlet. This object contains the Storage context. If you specify this parameter, do not
specify the Context parameter.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-ShareName <String>
Specifies the name of the file share. This cmdlet gets a file or directory from the file share that this parameter specifies.
Required? true
Position? 0
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
IStorageContext
Parameter 'Context' accepts value of type 'IStorageContext' from the pipeline
CloudFileDirectory
Parameter 'Directory' accepts value of type 'CloudFileDirectory' from the pipeline
CloudFileShare
Parameter 'Share' accepts value of type 'CloudFileShare' from the pipeline
OUTPUTS
NOTES
Example 1: List directories in a share
PS C:\\>Get-AzureStorageFile -ShareName "ContosoShare06" | where {$_.GetType().Name -eq "CloudFileDirectory"}
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 "CloudFileDirectory".
Example 2: List a File Directory
PS C:\\> Get-AzureStorageFile -ShareName "ContosoShare06" -Path "ContosoWorkingFolder" | Get-AzureStorageFile
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-AzureStorageFile cmdlet to list the directory.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... toragefile
Get-AzureStorageFileContent
New-AzureStorageDirectory
Remove-AzureStorageDirectory
Remove-AzureStorageFile
Set-AzureStorageFileContent