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

Rename-AzStorageFile

模块:: Az.Storage Module

重命名文件。

语法

ShareName (默认值)

Rename-AzStorageFile
    [-ShareName] <String>
    [-SourcePath] <String>
    [[-DestinationPath] <String>]
    [-ContentType <String>]
    [-Permission <String>]
    [-DisAllowSourceTrailingDot]
    [-DisAllowDestTrailingDot]
    [-Force]
    [-AsJob]
    [-Context <IStorageContext>]
    [-DefaultProfile <IAzureContextContainer>]
    [-IgnoreReadonly]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

FileObject

Rename-AzStorageFile
    [-ShareFileClient] <ShareFileClient>
    [[-DestinationPath] <String>]
    [-ContentType <String>]
    [-Permission <String>]
    [-Force]
    [-AsJob]
    [-Context <IStorageContext>]
    [-DefaultProfile <IAzureContextContainer>]
    [-IgnoreReadonly]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ShareObject

Rename-AzStorageFile
    [-ShareClient] <ShareClient>
    [-SourcePath] <String>
    [[-DestinationPath] <String>]
    [-ContentType <String>]
    [-Permission <String>]
    [-Force]
    [-AsJob]
    [-Context <IStorageContext>]
    [-DefaultProfile <IAzureContextContainer>]
    [-IgnoreReadonly]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

DirecotryObject

Rename-AzStorageFile
    [-ShareDirectoryClient] <ShareDirectoryClient>
    [-SourcePath] <String>
    [[-DestinationPath] <String>]
    [-ContentType <String>]
    [-Permission <String>]
    [-Force]
    [-AsJob]
    [-Context <IStorageContext>]
    [-DefaultProfile <IAzureContextContainer>]
    [-IgnoreReadonly]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

说明

Rename-AzStorageFile cmdlet 从文件共享重命名目录。

示例

示例 1：从文件共享重命名文件

Rename-AzStorageFile -SourcePath testfile1 -DestinationPath testfile2 -ShareName myshare

AccountName: myaccount, ShareName: myshare

Type                Length Name
----                ------ ----
File                   512 testfile2

此命令将 testfile1 中的文件重命名为文件共享 myshare 下的 testfile2。

示例 2：使用管道从文件共享重命名文件

Get-AzStorageFile -ShareName myshare -Path testfile1 | Rename-AzStorageFile -DestinationPath testfile2

AccountName: myaccount, ShareName: myshare

Type                Length Name
----                ------ ----
File                   512 testfile2

此命令首先获取文件客户端对象，并使用管道将文件从 testfile1 重命名为 testfile2。

参数

-AsJob

在后台运行 cmdlet

参数属性

类型:	SwitchParameter
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-Confirm

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

参数属性

类型:	SwitchParameter
默认值:	None
支持通配符:	False
不显示:	False
别名:	cf

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-ContentType

设置文件的 MIME 内容类型。默认类型为“application/octet-stream”。

参数属性

类型:	String
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-Context

Azure 存储上下文对象

参数属性

类型:	IStorageContext
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	True
来自管道的值（按属性名称）:	True
来自剩余参数的值:	False

-DefaultProfile

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

参数属性

类型:	IAzureContextContainer
默认值:	None
支持通配符:	False
不显示:	False
别名:	AzureRmContext, AzureCredential

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-DestinationPath

要重命名文件的目标路径。

参数属性

类型:	String
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	1
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-DisAllowDestTrailingDot

禁止尾随点（.）后缀目标目录和目标文件名。

参数属性

类型:	SwitchParameter
默认值:	None
支持通配符:	False
不显示:	False

参数集

ShareName

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-DisAllowSourceTrailingDot

禁止尾随点（.）以后缀源目录和源文件名称。

参数属性

类型:	SwitchParameter
默认值:	None
支持通配符:	False
不显示:	False

参数集

ShareName

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-Force

强制覆盖现有文件。

参数属性

类型:	SwitchParameter
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-IgnoreReadonly

可选。指定是否应尊重预先存在的目标文件上的 ReadOnly 属性。如果为 true，则重命名将成功，否则，目标上一个具有 ReadOnly 属性集的文件将导致重命名失败。

参数属性

类型:	SwitchParameter
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-Permission

如果指定了权限（安全描述符），则应为目录/文件设置权限。默认值：继承。如果将 SDDL 指定为输入，则它必须具有所有者、组和 dacl。

参数属性

类型:	String
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-ShareClient

ShareClient 指示将列出文件的共享。

参数属性

类型:	ShareClient
默认值:	None
支持通配符:	False
不显示:	False

参数集

ShareObject

Position:	0
必需:	True
来自管道的值:	True
来自管道的值（按属性名称）:	True
来自剩余参数的值:	False

-ShareDirectoryClient

ShareDirectoryClient 指示要列出文件的共享。

参数属性

类型:	ShareDirectoryClient
默认值:	None
支持通配符:	False
不显示:	False

参数集

DirecotryObject

Position:	0
必需:	True
来自管道的值:	True
来自管道的值（按属性名称）:	True
来自剩余参数的值:	False

-ShareFileClient

源文件实例

参数属性

类型:	ShareFileClient
默认值:	None
支持通配符:	False
不显示:	False

参数集

FileObject

Position:	0
必需:	True
来自管道的值:	True
来自管道的值（按属性名称）:	True
来自剩余参数的值:	False

-ShareName

要在其中列出文件的文件共享的名称。

参数属性

类型:	String
默认值:	None
支持通配符:	False
不显示:	False

参数集

ShareName

Position:	0
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-SourcePath

现有文件的路径。

参数属性

类型:	String
默认值:	None
支持通配符:	False
不显示:	False

参数集

ShareName

Position:	1
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

ShareObject

Position:	1
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

DirecotryObject

Position:	1
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-WhatIf

显示 cmdlet 运行时会发生什么情况。命令脚本未运行。

参数属性

类型:	SwitchParameter
默认值:	None
支持通配符:	False
不显示:	False
别名:	无线

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

CommonParameters

此 cmdlet 支持通用参数：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。有关详细信息，请参阅 about_CommonParameters。

通过

Rename-AzStorageFile

语法

ShareName (默认值)

FileObject

ShareObject

DirecotryObject

说明

示例

示例 1：从文件共享重命名文件

示例 2：使用管道从文件共享重命名文件

参数

-AsJob

参数属性

参数集

-Confirm

参数属性

参数集

-ContentType

参数属性

参数集

-Context

参数属性

参数集

-DefaultProfile

参数属性

参数集

-DestinationPath

参数属性

参数集

-DisAllowDestTrailingDot

参数属性

参数集

-DisAllowSourceTrailingDot

参数属性

参数集

-Force

参数属性

参数集

-IgnoreReadonly

参数属性

参数集

-Permission

参数属性

参数集

-ShareClient

参数属性

参数集

-ShareDirectoryClient

参数属性

参数集

-ShareFileClient

参数属性

参数集

-ShareName

参数属性

参数集

-SourcePath

参数属性

参数集

-WhatIf

参数属性

参数集

CommonParameters

输入

ShareFileClient

ShareClient

ShareDirectoryClient

IStorageContext

输出

AzureStorageFile

反馈