The storageAccounts/localUsers resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.Storage/storageAccounts/localUsers resource, add the following JSON to your template.
{
"type": "Microsoft.Storage/storageAccounts/localUsers",
"apiVersion": "2023-01-01",
"name": "string",
"properties": {
"hasSharedKey": "bool",
"hasSshKey": "bool",
"hasSshPassword": "bool",
"homeDirectory": "string",
"permissionScopes": [
{
"permissions": "string",
"resourceName": "string",
"service": "string"
}
],
"sshAuthorizedKeys": [
{
"description": "string",
"key": "string"
}
]
}
}
Name | Description | Value |
---|---|---|
type | The resource type | 'Microsoft.Storage/storageAccounts/localUsers' |
apiVersion | The resource api version | '2023-01-01' |
name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) |
properties | Storage account local user properties. | LocalUserProperties |
Name | Description | Value |
---|---|---|
hasSharedKey | Indicates whether shared key exists. Set it to false to remove existing shared key. | bool |
hasSshKey | Indicates whether ssh key exists. Set it to false to remove existing SSH key. | bool |
hasSshPassword | Indicates whether ssh password exists. Set it to false to remove existing SSH password. | bool |
homeDirectory | Optional, local user home directory. | string |
permissionScopes | The permission scopes of the local user. | PermissionScope[] |
sshAuthorizedKeys | Optional, local user ssh authorized keys for SFTP. | SshPublicKey[] |
Name | Description | Value |
---|---|---|
permissions | The permissions for the local user. Possible values include: Read (r), Write (w), Delete (d), List (l), and Create (c). | string (required) |
resourceName | The name of resource, normally the container name or the file share name, used by the local user. | string (required) |
service | The service used by the local user, e.g. blob, file. | string (required) |
Name | Description | Value |
---|---|---|
description | Optional. It is used to store the function/usage of the key | string |
key | Ssh public key base64 encoded. The format should be: '{keyType} {keyData}', e.g. ssh-rsa AAAABBBB | string |
The following quickstart templates deploy this resource type.
Template | Description |
---|---|
Create Storage Account with SFTP enabled |
Creates an Azure Storage account and a blob container that can be accessed using SFTP protocol. Access can be password or public-key based. |