你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
File Shares - Update
汇报共享请求正文中指定的属性。 不会更改请求中未提及的属性。 如果指定的共享尚不存在,更新将失败。
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}?api-version=2023-01-01
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
account
|
path | True |
string |
指定资源组中存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符,并且只能使用数字和小写字母。 Regex pattern: |
resource
|
path | True |
string |
用户订阅中资源组的名称。 此名称不区分大小写。 Regex pattern: |
share
|
path | True |
string |
指定存储帐户中文件共享的名称。 文件共享名称的长度必须介于 3 到 63 个字符之间,并且只能使用数字、小写字母和短划线 ( ) 。 每个短划线(-)字符的前后必须紧跟字母或数字。 |
subscription
|
path | True |
string |
目标订阅的 ID。 |
api-version
|
query | True |
string |
要用于此操作的 API 版本。 |
请求正文
名称 | 类型 | 说明 |
---|---|---|
properties.accessTier |
特定共享的访问层。 GpV2 帐户可以在 TransactionOptimized (默认) 、热和冷之间进行选择。 FileStorage 帐户可以选择“高级”。 |
|
properties.enabledProtocols |
用于文件共享的身份验证协议。 只能在创建共享时指定。 |
|
properties.metadata |
object |
作为元数据与共享关联的名称-值对。 |
properties.rootSquash |
属性仅适用于 NFS 共享。 默认值为 NoRootSquash。 |
|
properties.shareQuota |
integer |
共享的最大大小(以 GB 为单位)。 必须大于 0 且小于或等于 5 TB (5120)。 对于大型文件共享,最大大小为 102400。 |
properties.signedIdentifiers |
共享上指定的存储访问策略的列表。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
确定 -- 更新共享操作已成功完成。 |
|
Other Status Codes |
描述操作失败原因的错误响应。 |
安全性
azure_auth
Azure Active Directory OAuth2 流
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
示例
Update |
Update |
UpdateShareAcls
Sample Request
PATCH https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/fileServices/default/shares/share6185?api-version=2023-01-01
{
"properties": {
"signedIdentifiers": [
{
"id": "MTIzNDU2Nzg5MDEyMzQ1Njc4OTAxMjM0NTY3ODkwMTI",
"accessPolicy": {
"startTime": "2021-04-01T08:49:37.0000000Z",
"expiryTime": "2021-05-01T08:49:37.0000000Z",
"permission": "rwd"
}
}
]
}
}
Sample Response
{
"id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/fileServices/default/shares/share6185",
"name": "share6185",
"type": "Microsoft.Storage/storageAccounts/fileServices/shares",
"properties": {
"signedIdentifiers": [
{
"id": "MTIzNDU2Nzg5MDEyMzQ1Njc4OTAxMjM0NTY3ODkwMTI",
"accessPolicy": {
"startTime": "2021-04-01T08:49:37.0000000Z",
"expiryTime": "2021-05-01T08:49:37.0000000Z",
"permission": "rwd"
}
}
]
}
}
UpdateShares
Sample Request
PATCH https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/fileServices/default/shares/share6185?api-version=2023-01-01
{
"properties": {
"metadata": {
"type": "image"
}
}
}
Sample Response
{
"id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/fileServices/default/shares/share6185",
"name": "share6185",
"type": "Microsoft.Storage/storageAccounts/fileServices/shares",
"properties": {
"metadata": {
"type": "image"
}
}
}
定义
名称 | 说明 |
---|---|
Access |
|
Cloud |
存储服务的错误响应。 |
Cloud |
存储服务的错误响应。 |
Enabled |
用于文件共享的身份验证协议。 只能在创建共享时指定。 |
File |
文件共享的属性,包括 ID、资源名称、资源类型、Etag。 |
Lease |
指定共享上的租约是无限期还是固定持续时间,仅当共享被租用时。 |
Lease |
共享的租用状态。 |
Lease |
共享的租用状态。 |
Root |
属性仅适用于 NFS 共享。 默认值为 NoRootSquash。 |
Share |
特定共享的访问层。 GpV2 帐户可以在 TransactionOptimized (默认) 、热和冷之间进行选择。 FileStorage 帐户可以选择“高级”。 |
Signed |
AccessPolicy
名称 | 类型 | 说明 |
---|---|---|
expiryTime |
string |
访问策略的到期时间 |
permission |
string |
缩写权限的列表。 |
startTime |
string |
访问策略的开始时间 |
CloudError
存储服务的错误响应。
名称 | 类型 | 说明 |
---|---|---|
error |
存储服务的错误响应。 |
CloudErrorBody
存储服务的错误响应。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
错误的标识符。 代码是固定的,旨在以编程方式使用。 |
details |
有关错误的其他详细信息的列表。 |
|
message |
string |
描述错误的消息,该消息适用于在用户界面中显示。 |
target |
string |
特定错误的目标。 例如,属性的名称出错。 |
EnabledProtocols
用于文件共享的身份验证协议。 只能在创建共享时指定。
名称 | 类型 | 说明 |
---|---|---|
NFS |
string |
|
SMB |
string |
FileShare
文件共享的属性,包括 ID、资源名称、资源类型、Etag。
名称 | 类型 | 说明 |
---|---|---|
etag |
string |
资源 Etag。 |
id |
string |
资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
资源的名称 |
properties.accessTier |
特定共享的访问层。 GpV2 帐户可以在 TransactionOptimized (默认) 、热和冷之间进行选择。 FileStorage 帐户可以选择“高级”。 |
|
properties.accessTierChangeTime |
string |
指示共享访问层的上次修改时间。 |
properties.accessTierStatus |
string |
指示访问层是否存在挂起的转换。 |
properties.deleted |
boolean |
指示共享是否已被删除。 |
properties.deletedTime |
string |
如果共享已被删除,则为删除的时间。 |
properties.enabledProtocols |
用于文件共享的身份验证协议。 只能在创建共享时指定。 |
|
properties.lastModifiedTime |
string |
返回上次修改共享的日期和时间。 |
properties.leaseDuration |
指定共享上的租约是无限期还是固定持续时间,仅当共享被租用时。 |
|
properties.leaseState |
共享的租用状态。 |
|
properties.leaseStatus |
共享的租用状态。 |
|
properties.metadata |
object |
作为元数据与共享关联的名称-值对。 |
properties.remainingRetentionDays |
integer |
软删除的共享的剩余保留天数。 |
properties.rootSquash |
属性仅适用于 NFS 共享。 默认值为 NoRootSquash。 |
|
properties.shareQuota |
integer |
共享的最大大小(以 GB 为单位)。 必须大于 0 且小于或等于 5 TB (5120)。 对于大型文件共享,最大大小为 102400。 |
properties.shareUsageBytes |
integer |
存储在共享上的数据的大致大小。 请注意,此值可能不包括最近创建或最近调整大小的所有文件。 |
properties.signedIdentifiers |
共享上指定的存储访问策略的列表。 |
|
properties.snapshotTime |
string |
共享的创建时间快照包含展开参数“snapshots”的列表共享的响应中返回。 |
properties.version |
string |
共享的版本。 |
type |
string |
资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts” |
LeaseDuration
指定共享上的租约是无限期还是固定持续时间,仅当共享被租用时。
名称 | 类型 | 说明 |
---|---|---|
Fixed |
string |
|
Infinite |
string |
LeaseState
共享的租用状态。
名称 | 类型 | 说明 |
---|---|---|
Available |
string |
|
Breaking |
string |
|
Broken |
string |
|
Expired |
string |
|
Leased |
string |
LeaseStatus
共享的租用状态。
名称 | 类型 | 说明 |
---|---|---|
Locked |
string |
|
Unlocked |
string |
RootSquashType
属性仅适用于 NFS 共享。 默认值为 NoRootSquash。
名称 | 类型 | 说明 |
---|---|---|
AllSquash |
string |
|
NoRootSquash |
string |
|
RootSquash |
string |
ShareAccessTier
特定共享的访问层。 GpV2 帐户可以在 TransactionOptimized (默认) 、热和冷之间进行选择。 FileStorage 帐户可以选择“高级”。
名称 | 类型 | 说明 |
---|---|---|
Cool |
string |
|
Hot |
string |
|
Premium |
string |
|
TransactionOptimized |
string |
SignedIdentifier
名称 | 类型 | 说明 |
---|---|---|
accessPolicy |
访问策略 |
|
id |
string |
存储访问策略的唯一标识符。 |