你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Get-AzStorageFileContent

下载文件的内容。

语法

Get-AzStorageFileContent
   [-ShareName] <String>
   [-Path] <String>
   [[-Destination] <String>]
   [-CheckMd5]
   [-PassThru]
   [-Force]
   [-AsJob]
   [-DisAllowTrailingDot]
   [-Context <IStorageContext>]
   [-ServerTimeoutPerRequest <Int32>]
   [-ClientTimeoutPerRequest <Int32>]
   [-DefaultProfile <IAzureContextContainer>]
   [-ConcurrentTaskCount <Int32>]
   [-WhatIf]
   [-Confirm]
   [-PreserveSMBAttribute]
   [<CommonParameters>]
Get-AzStorageFileContent
   [-Share] <CloudFileShare>
   [-ShareClient <ShareClient>]
   [-Path] <String>
   [[-Destination] <String>]
   [-CheckMd5]
   [-PassThru]
   [-Force]
   [-AsJob]
   [-Context <IStorageContext>]
   [-ServerTimeoutPerRequest <Int32>]
   [-ClientTimeoutPerRequest <Int32>]
   [-DefaultProfile <IAzureContextContainer>]
   [-ConcurrentTaskCount <Int32>]
   [-WhatIf]
   [-Confirm]
   [-PreserveSMBAttribute]
   [<CommonParameters>]
Get-AzStorageFileContent
   [-Directory] <CloudFileDirectory>
   [-ShareDirectoryClient <ShareDirectoryClient>]
   [-Path] <String>
   [[-Destination] <String>]
   [-CheckMd5]
   [-PassThru]
   [-Force]
   [-AsJob]
   [-Context <IStorageContext>]
   [-ServerTimeoutPerRequest <Int32>]
   [-ClientTimeoutPerRequest <Int32>]
   [-DefaultProfile <IAzureContextContainer>]
   [-ConcurrentTaskCount <Int32>]
   [-WhatIf]
   [-Confirm]
   [-PreserveSMBAttribute]
   [<CommonParameters>]
Get-AzStorageFileContent
   [-File] <CloudFile>
   [-ShareFileClient <ShareFileClient>]
   [[-Destination] <String>]
   [-CheckMd5]
   [-PassThru]
   [-Force]
   [-AsJob]
   [-Context <IStorageContext>]
   [-ServerTimeoutPerRequest <Int32>]
   [-ClientTimeoutPerRequest <Int32>]
   [-DefaultProfile <IAzureContextContainer>]
   [-ConcurrentTaskCount <Int32>]
   [-WhatIf]
   [-Confirm]
   [-PreserveSMBAttribute]
   [<CommonParameters>]

说明

Get-Az存储FileContent cmdlet 下载文件的内容,然后将其保存到指定的目标。 此 cmdlet 不返回文件的内容。

示例

示例 1:从文件夹下载文件

Get-AzStorageFileContent -ShareName "ContosoShare06" -Path "ContosoWorkingFolder/CurrentDataFile"

此命令将 ContosoWorkingFolder 文件夹中名为 CurrentDataFile 的文件从文件共享 ContosoShare06 下载到当前文件夹。

示例 2:下载示例文件共享下的文件

Get-AzStorageFile -ShareName sample | Where-Object {$_.GetType().Name -eq "CloudFile"} | Get-AzStorageFileContent

此示例下载示例文件共享下的文件

示例 3:将 Azure 文件下载到本地文件,并在本地文件中保留 Azure 文件 SMB 属性(文件创建时间、文件创建时间、文件上次写入时间)。

Get-AzStorageFileContent -ShareName sample -Path "dir1/file1" -Destination $localFilePath -PreserveSMBAttribute

此示例将 Azure 文件下载到本地文件,并在本地文件中保留 Azure 文件 SMB 属性(文件创建时间、文件上次写入时间、文件上次写入时间)。

参数

-AsJob

在后台运行 cmdlet。

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

-CheckMd5

指定是否检查已下载文件的 Md5 总和。

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

-ClientTimeoutPerRequest

指定一个服务请求的客户端超时间隔(以秒为单位)。 如果上一次调用在指定的时间间隔内失败,则此 cmdlet 将重试请求。 如果此 cmdlet 在间隔过前未收到成功的响应,则此 cmdlet 将返回错误。

Type:Nullable<T>[Int32]
Aliases:ClientTimeoutPerRequestInSeconds
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ConcurrentTaskCount

指定最大并发网络调用数。 可以使用此参数通过指定并发网络调用的最大数目来限制本地 CPU 和带宽使用量的并发性。 指定的值是绝对计数,不乘以核心计数。 此参数可帮助减少低带宽环境中的网络连接问题,例如每秒 100 千比特。 默认值为 10。

Type:Nullable<T>[Int32]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

提示你在运行 cmdlet 之前进行确认。

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Context

指定Azure 存储上下文。 若要获取上下文,请使用 New-Az存储Context cmdlet。

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

-DefaultProfile

用于与 Azure 通信的凭据、帐户、租户和订阅。

Type:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Destination

指定目标路径。 此 cmdlet 会将文件内容下载到此参数指定的位置。 如果指定不存在的文件的路径,此 cmdlet 将创建该文件,并将内容保存在新文件中。 如果指定已存在且指定 Force 参数的文件的路径,则 cmdlet 将覆盖该文件。 如果指定现有文件的路径且未指定 Force,则 cmdlet 会在继续之前提示你。 如果指定文件夹的路径,此 cmdlet 将尝试创建一个名称为 Azure 存储文件的文件。

Type:String
Position:2
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Directory

将文件夹指定为 CloudFileDirectory 对象。 此 cmdlet 获取此参数指定的文件夹中文件的内容。 若要获取目录,请使用 New-Az存储Directory cmdlet。 还可以使用 Get-Az存储File cmdlet 获取目录。

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

-DisAllowTrailingDot

禁止尾随点 (.) 后缀目录和文件名。

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

-File

将文件指定为 CloudFile 对象。 此 cmdlet 获取此参数指定的文件。 若要获取 CloudFile 对象,请使用 Get-Az存储File cmdlet。

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

-Force

如果指定不存在的文件的路径,此 cmdlet 将创建该文件,并将内容保存在新文件中。 如果指定已存在且指定 Force 参数的文件的路径,则 cmdlet 将覆盖该文件。 如果指定现有文件的路径且未指定 Force,则 cmdlet 会在继续之前提示你。 如果指定文件夹的路径,此 cmdlet 将尝试创建一个名称为 Azure 存储文件的文件。

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

-PassThru

指示此 cmdlet 返回它下载的 Azure存储File 对象。

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

-Path

指定文件路径。 此 cmdlet 获取此参数指定的文件的内容。 如果文件不存在,则此 cmdlet 将返回错误。

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

-PreserveSMBAttribute

在目标文件中保留源文件 SMB 属性(文件创建时间、文件创建时间、文件上次写入时间)。 此参数仅在 Windows 上可用。

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

-ServerTimeoutPerRequest

指定请求的服务端超时间隔(以秒为单位)。 如果服务处理请求之前指定的间隔已过,则存储服务将返回错误。

Type:Nullable<T>[Int32]
Aliases:ServerTimeoutPerRequestInSeconds
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Share

指定 CloudFileShare 对象。 此 cmdlet 下载共享中文件的内容,此参数指定。 若要获取 CloudFileShare 对象,请使用 Get-Az存储Share cmdlet。 此对象包含存储上下文。 如果指定此参数,请不要指定 Context 参数。

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

-ShareClient

CloudFileShare 对象指示将下载文件的共享。

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

-ShareDirectoryClient

ShareDirectoryClient 对象指示将下载文件的云目录。

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

-ShareFileClient

ShareFileClient 对象指示要下载的云文件。

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

-ShareName

指定文件共享的名称。 此 cmdlet 下载共享中文件的内容,此参数指定。

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

-WhatIf

显示运行该 cmdlet 时会发生什么情况。 cmdlet 未运行。

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

输入

CloudFileShare

CloudFileDirectory

CloudFile

IStorageContext

输出

AzureStorageFile