LocalUser interface

The local user associated with the storage accounts.

Extends

Properties

allowAclAuthorization

Indicates whether ACL authorization is allowed for this user. Set it to false to disallow using ACL authorization.

extendedGroups

Supplementary group membership. Only applicable for local users enabled for NFSv3 access.

groupId

An identifier for associating a group of users.

hasSharedKey

Indicates whether shared key exists. Set it to false to remove existing shared key.

hasSshKey

Indicates whether ssh key exists. Set it to false to remove existing SSH key.

hasSshPassword

Indicates whether ssh password exists. Set it to false to remove existing SSH password.

homeDirectory

Optional, local user home directory.

isNFSv3Enabled

Indicates if the local user is enabled for access with NFSv3 protocol.

permissionScopes

The permission scopes of the local user.

sid

A unique Security Identifier that is generated by the server. NOTE: This property will not be serialized. It can only be populated by the server.

sshAuthorizedKeys

Optional, local user ssh authorized keys for SFTP.

systemData

Metadata pertaining to creation and last modification of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

userId

A unique Identifier that is generated by the server. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

allowAclAuthorization

Indicates whether ACL authorization is allowed for this user. Set it to false to disallow using ACL authorization.

allowAclAuthorization?: boolean

Property Value

boolean

extendedGroups

Supplementary group membership. Only applicable for local users enabled for NFSv3 access.

extendedGroups?: number[]

Property Value

number[]

groupId

An identifier for associating a group of users.

groupId?: number

Property Value

number

hasSharedKey

Indicates whether shared key exists. Set it to false to remove existing shared key.

hasSharedKey?: boolean

Property Value

boolean

hasSshKey

Indicates whether ssh key exists. Set it to false to remove existing SSH key.

hasSshKey?: boolean

Property Value

boolean

hasSshPassword

Indicates whether ssh password exists. Set it to false to remove existing SSH password.

hasSshPassword?: boolean

Property Value

boolean

homeDirectory

Optional, local user home directory.

homeDirectory?: string

Property Value

string

isNFSv3Enabled

Indicates if the local user is enabled for access with NFSv3 protocol.

isNFSv3Enabled?: boolean

Property Value

boolean

permissionScopes

The permission scopes of the local user.

permissionScopes?: PermissionScope[]

Property Value

sid

A unique Security Identifier that is generated by the server. NOTE: This property will not be serialized. It can only be populated by the server.

sid?: string

Property Value

string

sshAuthorizedKeys

Optional, local user ssh authorized keys for SFTP.

sshAuthorizedKeys?: SshPublicKey[]

Property Value

systemData

Metadata pertaining to creation and last modification of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

userId

A unique Identifier that is generated by the server. NOTE: This property will not be serialized. It can only be populated by the server.

userId?: number

Property Value

number

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From Resource.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From Resource.name

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From Resource.type