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

Local Users - Create Or Update

创建或更新与存储帐户关联的本地用户的属性。 NFSv3 启用和扩展组的属性不能与其他属性一起设置。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/localUsers/{username}?api-version=2025-06-01

URI 参数

名称 必需 类型 说明
accountName
path True

string

minLength: 3
maxLength: 24
pattern: ^[a-z0-9]+$

指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符,并且只能使用数字和小写字母。

resourceGroupName
path True

string

minLength: 1
maxLength: 90
pattern: ^[-\w\._\(\)]+$

用户订阅中的资源组的名称。 此名称不区分大小写。

subscriptionId
path True

string

minLength: 1

目标订阅的 ID。

username
path True

string

minLength: 3
maxLength: 64

本地用户的名称。 用户名必须仅包含小写字母和数字。 它必须仅在存储帐户中是唯一的。

api-version
query True

string

minLength: 1

要用于此操作的 API 版本。

请求正文

名称 类型 说明
properties.allowAclAuthorization

boolean

指示是否允许此用户的 ACL 授权。 将其设置为 false 以禁止使用 ACL 授权。

properties.extendedGroups

integer[] (int32)

补充组成员身份。 仅适用于启用 NFSv3 访问的本地用户。

properties.groupId

integer (int32)

用于关联用户组的标识符。

properties.hasSharedKey

boolean

指示是否存在共享密钥。 将其设置为 false 以删除现有的共享密钥。

properties.hasSshKey

boolean

指示 ssh 密钥是否存在。 将其设置为 false 以删除现有的 SSH 密钥。

properties.hasSshPassword

boolean

指示是否存在 ssh 密码。 将其设置为 false 以删除现有的 SSH 密码。

properties.homeDirectory

string

可选,本地用户主目录。

properties.isNFSv3Enabled

boolean

指示是否启用了本地用户以使用 NFSv3 协议进行访问。

properties.permissionScopes

PermissionScope[]

本地用户的权限范围。

properties.sshAuthorizedKeys

SshPublicKey[]

SFTP 的可选本地用户 SSH 授权密钥。

响应

名称 类型 说明
200 OK

LocalUser

确定 -- 成功放置本地用户。

Other Status Codes

ErrorResponse

描述操作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

CreateLocalUser
CreateNFSv3EnabledLocalUser
UpdateLocalUser

CreateLocalUser

示例请求

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res6977/providers/Microsoft.Storage/storageAccounts/sto2527/localUsers/user1?api-version=2025-06-01

{
  "properties": {
    "permissionScopes": [
      {
        "permissions": "rwd",
        "service": "file",
        "resourceName": "share1"
      },
      {
        "permissions": "rw",
        "service": "file",
        "resourceName": "share2"
      }
    ],
    "homeDirectory": "homedirectory",
    "hasSshPassword": true,
    "sshAuthorizedKeys": [
      {
        "description": "key name",
        "key": "ssh-rsa keykeykeykeykey="
      }
    ],
    "groupId": 2000,
    "allowAclAuthorization": true
  }
}

示例响应

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/res6977/providers/Microsoft.Storage/storageAccounts/sto2527/loalUsers/user1",
  "name": "user1",
  "type": "Microsoft.Storage/storageAccounts/localUsers",
  "properties": {
    "permissionScopes": [
      {
        "permissions": "rwd",
        "service": "file",
        "resourceName": "share1"
      },
      {
        "permissions": "rw",
        "service": "file",
        "resourceName": "share2"
      }
    ],
    "homeDirectory": "homedirectory",
    "sshAuthorizedKeys": [
      {
        "description": "key name",
        "key": "ssh-rsa keykeykeykeykey="
      }
    ],
    "sid": "S-1-2-0-125132-153423-36235-1000",
    "userId": 1000,
    "groupId": 2000,
    "allowAclAuthorization": true
  }
}

CreateNFSv3EnabledLocalUser

示例请求

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res6977/providers/Microsoft.Storage/storageAccounts/sto2527/localUsers/user1?api-version=2025-06-01

{
  "properties": {
    "extendedGroups": [
      1001,
      1005,
      2005
    ],
    "isNFSv3Enabled": true
  }
}

示例响应

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/res6977/providers/Microsoft.Storage/storageAccounts/sto2527/loalUsers/user1",
  "name": "user1",
  "type": "Microsoft.Storage/storageAccounts/localUsers",
  "properties": {
    "permissionScopes": [
      {
        "permissions": "rwd",
        "service": "file",
        "resourceName": "share1"
      },
      {
        "permissions": "rw",
        "service": "file",
        "resourceName": "share2"
      }
    ],
    "homeDirectory": "homedirectory",
    "sshAuthorizedKeys": [
      {
        "description": "key name",
        "key": "ssh-rsa keykeykeykeykey="
      }
    ],
    "sid": "S-1-2-0-125132-153423-36235-1000",
    "userId": 1000,
    "groupId": 2000,
    "allowAclAuthorization": true,
    "extendedGroups": [
      1001,
      1005,
      2005
    ],
    "isNFSv3Enabled": true
  }
}

UpdateLocalUser

示例请求

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res6977/providers/Microsoft.Storage/storageAccounts/sto2527/localUsers/user1?api-version=2025-06-01

{
  "properties": {
    "homeDirectory": "homedirectory2",
    "hasSharedKey": false,
    "hasSshPassword": false,
    "hasSshKey": false,
    "groupId": 3000,
    "allowAclAuthorization": false,
    "extendedGroups": [
      1001,
      1005,
      2005
    ],
    "isNFSv3Enabled": true
  }
}

示例响应

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/res6977/providers/Microsoft.Storage/storageAccounts/sto2527/loalUsers/user1",
  "name": "user1",
  "type": "Microsoft.Storage/storageAccounts/localUsers",
  "properties": {
    "homeDirectory": "homedirectory2",
    "sid": "S-1-2-0-3528686663-1788730862-2791910117-1000",
    "hasSharedKey": false,
    "hasSshPassword": false,
    "hasSshKey": false,
    "userId": 1000,
    "groupId": 3000,
    "allowAclAuthorization": false,
    "extendedGroups": [
      1001,
      1005,
      2005
    ],
    "isNFSv3Enabled": true
  }
}

定义

名称 说明
createdByType

创建资源的标识的类型。

ErrorResponse

存储资源提供程序的错误响应。

ErrorResponseBody

错误响应正文协定。

LocalUser

与存储帐户关联的本地用户。

PermissionScope
SshPublicKey
systemData

与创建和上次修改资源相关的元数据。

createdByType

创建资源的标识的类型。

说明
User
Application
ManagedIdentity
Key

ErrorResponse

存储资源提供程序的错误响应。

名称 类型 说明
error

ErrorResponseBody

Azure 存储资源提供程序错误响应正文。

ErrorResponseBody

错误响应正文协定。

名称 类型 说明
code

string

错误的标识符。 代码是固定的,旨在以编程方式使用。

message

string

描述错误的消息,旨在适合在用户界面中显示。

LocalUser

与存储帐户关联的本地用户。

名称 类型 说明
id

string

资源的完全限定资源 ID。 示例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

资源的名称

properties.allowAclAuthorization

boolean

指示是否允许此用户的 ACL 授权。 将其设置为 false 以禁止使用 ACL 授权。

properties.extendedGroups

integer[] (int32)

补充组成员身份。 仅适用于启用 NFSv3 访问的本地用户。

properties.groupId

integer (int32)

用于关联用户组的标识符。

properties.hasSharedKey

boolean

指示是否存在共享密钥。 将其设置为 false 以删除现有的共享密钥。

properties.hasSshKey

boolean

指示 ssh 密钥是否存在。 将其设置为 false 以删除现有的 SSH 密钥。

properties.hasSshPassword

boolean

指示是否存在 ssh 密码。 将其设置为 false 以删除现有的 SSH 密码。

properties.homeDirectory

string

可选,本地用户主目录。

properties.isNFSv3Enabled

boolean

指示是否启用了本地用户以使用 NFSv3 协议进行访问。

properties.permissionScopes

PermissionScope[]

本地用户的权限范围。

properties.sid

string

由服务器生成的唯一安全标识符。

properties.sshAuthorizedKeys

SshPublicKey[]

SFTP 的可选本地用户 SSH 授权密钥。

properties.userId

integer (int32)

由服务器生成的唯一标识符。

systemData

systemData

与创建和上次修改资源相关的元数据。

type

string

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

PermissionScope

名称 类型 说明
permissions

string

本地用户的权限。 可能的值包括:读取(r)、写入(w)、删除(d)、列表(l)、创建(c)、修改所有权(o)和修改权限(p)。

resourceName

string

资源的名称,通常是本地用户使用的容器名称或文件共享名称。

service

string

本地用户使用的服务,例如 blob 文件。

SshPublicKey

名称 类型 说明
description

string

可选。 它用于存储密钥的函数/用法

key

string

Ssh 公钥 base64 编码。 格式应为:“<keyType><keyData>”,例如 ssh-rsa AAAABBBB

systemData

与创建和上次修改资源相关的元数据。

名称 类型 说明
createdAt

string (date-time)

资源创建时间戳(UTC)。

createdBy

string

创建资源的标识。

createdByType

createdByType

创建资源的标识的类型。

lastModifiedAt

string (date-time)

上次修改的资源时间戳(UTC)

lastModifiedBy

string

上次修改资源的标识。

lastModifiedByType

createdByType

上次修改资源的标识的类型。