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

Microsoft.Storage storageAccounts/localUsers 2021-08-01

Bicep 资源定义

storageAccounts/localUsers 资源类型可以通过针对以下操作进行部署:

有关每个 API 版本中更改的属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.Storage/storageAccounts/localUsers 资源,请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.Storage/storageAccounts/localUsers@2021-08-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    hasSharedKey: bool
    hasSshKey: bool
    hasSshPassword: bool
    homeDirectory: 'string'
    permissionScopes: [
      {
        permissions: 'string'
        resourceName: 'string'
        service: 'string'
      }
    ]
    sshAuthorizedKeys: [
      {
        description: 'string'
        key: 'string'
      }
    ]
  }
}

属性值

storageAccounts/localUsers

名称 说明
name 资源名称

了解如何在 Bicep 中为子资源设置名称和类型。
字符串 (必需)
父级 (parent) 在 Bicep 中,可以为子资源指定父资源。 仅当子资源在父资源外部声明时,才需要添加此属性。

有关详细信息,请参阅 父资源之外的子资源
类型为资源的符号名称: storageAccounts
properties 存储帐户本地用户属性。 LocalUserProperties

LocalUserProperties

名称 说明
hasSharedKey 指示是否存在共享密钥。 将其设置为 false 可删除现有的共享密钥。 bool
hasSshKey 指示是否存在 ssh 密钥。 将其设置为 false 可删除现有的 SSH 密钥。 bool
hasSshPassword 指示是否存在 ssh 密码。 将其设置为 false 可删除现有的 SSH 密码。 bool
homeDirectory 可选的本地用户主目录。 字符串
permissionScopes 本地用户的权限范围。 PermissionScope[]
sshAuthorizedKeys SFTP 的可选本地用户 ssh 授权密钥。 SshPublicKey[]

PermissionScope

名称 说明
权限 本地用户的权限。 可能的值包括:Read (r) 、Write (w) 、Delete (d) 、List (l) 和 Create (c) 。 字符串 (必需)
resourceName 本地用户使用的资源名称(通常是容器名称或文件共享名称)。 字符串 (必需)
服务 本地用户使用的服务,例如 blob、文件。 字符串 (必需)

SshPublicKey

名称 说明
description 可选。 它用于存储密钥的函数/用法 string
key Ssh 公钥 base64 编码。 格式应为:“{keyType} {keyData}”,例如 ssh-rsa AAAABBBB 字符串

快速入门模板

以下快速入门模板部署此资源类型。

模板 说明
创建启用了 SFTP 的存储帐户

部署到 Azure
创建可以使用 SFTP 协议访问的 Azure 存储帐户和 Blob 容器。 访问权限可以基于密码或公钥。

ARM 模板资源定义

storageAccounts/localUsers 资源类型可以通过针对以下操作进行部署:

有关每个 API 版本中更改的属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.Storage/storageAccounts/localUsers 资源,请将以下 JSON 添加到模板。

{
  "type": "Microsoft.Storage/storageAccounts/localUsers",
  "apiVersion": "2021-08-01",
  "name": "string",
  "properties": {
    "hasSharedKey": "bool",
    "hasSshKey": "bool",
    "hasSshPassword": "bool",
    "homeDirectory": "string",
    "permissionScopes": [
      {
        "permissions": "string",
        "resourceName": "string",
        "service": "string"
      }
    ],
    "sshAuthorizedKeys": [
      {
        "description": "string",
        "key": "string"
      }
    ]
  }
}

属性值

storageAccounts/localUsers

名称 说明 Value
type 资源类型 “Microsoft.Storage/storageAccounts/localUsers”
apiVersion 资源 API 版本 '2021-08-01'
name 资源名称

了解如何在 JSON ARM 模板中设置子资源的名称和类型。
字符串 (必需)
properties 存储帐户本地用户属性。 LocalUserProperties

LocalUserProperties

名称 说明
hasSharedKey 指示是否存在共享密钥。 将其设置为 false 可删除现有的共享密钥。 bool
hasSshKey 指示 ssh 密钥是否存在。 将其设置为 false 可删除现有的 SSH 密钥。 bool
hasSshPassword 指示是否存在 ssh 密码。 将其设置为 false 可删除现有的 SSH 密码。 bool
homeDirectory 可选,本地用户主目录。 字符串
permissionScopes 本地用户的权限范围。 PermissionScope[]
sshAuthorizedKeys SFTP 的可选本地用户 ssh 授权密钥。 SshPublicKey[]

PermissionScope

名称 说明
权限 本地用户的权限。 可能的值包括:Read (r) 、Write (w) 、Delete (d) 、List (l) 和 Create (c) 。 字符串 (必需)
resourceName 资源的名称,通常是本地用户使用的容器名称或文件共享名称。 字符串 (必需)
服务 本地用户使用的服务,例如 blob、文件。 字符串 (必需)

SshPublicKey

名称 说明
description 可选。 它用于存储密钥的功能/用法 string
key Ssh 公钥 base64 编码。 格式应为:“{keyType} {keyData}”,例如 ssh-rsa AAAABBBB 字符串

快速入门模板

以下快速入门模板部署此资源类型。

模板 说明
创建启用了 SFTP 的存储帐户

部署到 Azure
创建可以使用 SFTP 协议访问的 Azure 存储帐户和 Blob 容器。 访问可以基于密码或公钥。

Terraform (AzAPI 提供程序) 资源定义

可以使用面向以下操作部署 storageAccounts/localUsers 资源类型:

  • 资源组

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.Storage/storageAccounts/localUsers 资源,请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Storage/storageAccounts/localUsers@2021-08-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      hasSharedKey = bool
      hasSshKey = bool
      hasSshPassword = bool
      homeDirectory = "string"
      permissionScopes = [
        {
          permissions = "string"
          resourceName = "string"
          service = "string"
        }
      ]
      sshAuthorizedKeys = [
        {
          description = "string"
          key = "string"
        }
      ]
    }
  })
}

属性值

storageAccounts/localUsers

名称 说明 Value
type 资源类型 “Microsoft.Storage/storageAccounts/localUsers@2021-08-01”
name 资源名称 字符串 (必需)
parent_id 此资源的父资源的 ID。 类型为:storageAccounts 的资源的 ID
properties 存储帐户本地用户属性。 LocalUserProperties

LocalUserProperties

名称 说明
hasSharedKey 指示是否存在共享密钥。 将其设置为 false 可删除现有的共享密钥。 bool
hasSshKey 指示是否存在 ssh 密钥。 将其设置为 false 可删除现有的 SSH 密钥。 bool
hasSshPassword 指示是否存在 ssh 密码。 将其设置为 false 可删除现有的 SSH 密码。 bool
homeDirectory 可选的本地用户主目录。 字符串
permissionScopes 本地用户的权限范围。 PermissionScope[]
sshAuthorizedKeys SFTP 的可选本地用户 ssh 授权密钥。 SshPublicKey[]

PermissionScope

名称 说明
权限 本地用户的权限。 可能的值包括:Read (r) 、Write (w) 、Delete (d) 、List (l) 和 Create (c) 。 字符串 (必需)
resourceName 本地用户使用的资源名称(通常是容器名称或文件共享名称)。 字符串 (必需)
服务 本地用户使用的服务,例如 blob、文件。 字符串 (必需)

SshPublicKey

名称 说明
description 可选。 它用于存储密钥的函数/用法 string
key Ssh 公钥 base64 编码。 格式应为:“{keyType} {keyData}”,例如 ssh-rsa AAAABBBB 字符串