LocalUsersOperations interface

Interface representing a LocalUsersOperations.

Methods

createOrUpdate(string, string, string, LocalUser, LocalUsersCreateOrUpdateOptionalParams)

Create or update the properties of a local user associated with the storage account. Properties for NFSv3 enablement and extended groups cannot be set with other properties.

delete(string, string, string, LocalUsersDeleteOptionalParams)

Deletes the local user associated with the specified storage account.

get(string, string, string, LocalUsersGetOptionalParams)

Get the local user of the storage account by username.

list(string, string, LocalUsersListOptionalParams)

List the local users associated with the storage account.

listKeys(string, string, string, LocalUsersListKeysOptionalParams)

List SSH authorized keys and shared key of the local user.

regeneratePassword(string, string, string, LocalUsersRegeneratePasswordOptionalParams)

Regenerate the local user SSH password.

Method Details

createOrUpdate(string, string, string, LocalUser, LocalUsersCreateOrUpdateOptionalParams)

Create or update the properties of a local user associated with the storage account. Properties for NFSv3 enablement and extended groups cannot be set with other properties.

function createOrUpdate(resourceGroupName: string, accountName: string, username: string, properties: LocalUser, options?: LocalUsersCreateOrUpdateOptionalParams): Promise<LocalUser>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

accountName

string

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.

username

string

The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account.

properties
LocalUser

The local user associated with a storage account.

options
LocalUsersCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<LocalUser>

delete(string, string, string, LocalUsersDeleteOptionalParams)

Deletes the local user associated with the specified storage account.

function delete(resourceGroupName: string, accountName: string, username: string, options?: LocalUsersDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

accountName

string

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.

username

string

The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account.

options
LocalUsersDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, LocalUsersGetOptionalParams)

Get the local user of the storage account by username.

function get(resourceGroupName: string, accountName: string, username: string, options?: LocalUsersGetOptionalParams): Promise<LocalUser>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

accountName

string

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.

username

string

The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account.

options
LocalUsersGetOptionalParams

The options parameters.

Returns

Promise<LocalUser>

list(string, string, LocalUsersListOptionalParams)

List the local users associated with the storage account.

function list(resourceGroupName: string, accountName: string, options?: LocalUsersListOptionalParams): PagedAsyncIterableIterator<LocalUser, LocalUser[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

accountName

string

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.

options
LocalUsersListOptionalParams

The options parameters.

Returns

listKeys(string, string, string, LocalUsersListKeysOptionalParams)

List SSH authorized keys and shared key of the local user.

function listKeys(resourceGroupName: string, accountName: string, username: string, options?: LocalUsersListKeysOptionalParams): Promise<LocalUserKeys>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

accountName

string

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.

username

string

The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account.

options
LocalUsersListKeysOptionalParams

The options parameters.

Returns

Promise<LocalUserKeys>

regeneratePassword(string, string, string, LocalUsersRegeneratePasswordOptionalParams)

Regenerate the local user SSH password.

function regeneratePassword(resourceGroupName: string, accountName: string, username: string, options?: LocalUsersRegeneratePasswordOptionalParams): Promise<LocalUserRegeneratePasswordResult>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

accountName

string

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.

username

string

The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account.

options
LocalUsersRegeneratePasswordOptionalParams

The options parameters.

Returns