Package version:

Interface LocalUsersOperations

Interface representing a LocalUsersOperations.

interface LocalUsersOperations {
    createOrUpdate(resourceGroupName: string, accountName: string, username: string, properties: LocalUser, options?: LocalUsersCreateOrUpdateOptionalParams): Promise<LocalUser>;
    delete(resourceGroupName: string, accountName: string, username: string, options?: LocalUsersDeleteOptionalParams): Promise<void>;
    get(resourceGroupName: string, accountName: string, username: string, options?: LocalUsersGetOptionalParams): Promise<LocalUser>;
    list(resourceGroupName: string, accountName: string, options?: LocalUsersListOptionalParams): PagedAsyncIterableIterator<LocalUser>;
    listKeys(resourceGroupName: string, accountName: string, username: string, options?: LocalUsersListKeysOptionalParams): Promise<LocalUserKeys>;
    regeneratePassword(resourceGroupName: string, accountName: string, username: string, options?: LocalUsersRegeneratePasswordOptionalParams): Promise<LocalUserRegeneratePasswordResult>;
}

Methods

createOrUpdate delete get list listKeys regeneratePassword

Methods

createOrUpdate

  • createOrUpdate(resourceGroupName, accountName, username, properties, options?): Promise<LocalUser>

  • 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.

    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.

    • Optionaloptions: LocalUsersCreateOrUpdateOptionalParams

      The options parameters.

    Returns Promise<LocalUser>

delete

  • delete(resourceGroupName, accountName, username, options?): Promise<void>

  • Deletes the local user associated with the specified storage account.

    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.

    • Optionaloptions: LocalUsersDeleteOptionalParams

      The options parameters.

    Returns Promise<void>

get

  • get(resourceGroupName, accountName, username, options?): Promise<LocalUser>

  • Get the local user of the storage account by username.

    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.

    • Optionaloptions: LocalUsersGetOptionalParams

      The options parameters.

    Returns Promise<LocalUser>

list

  • list(resourceGroupName, accountName, options?): PagedAsyncIterableIterator<LocalUser>

  • List the local users associated with the storage account.

    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.

    • Optionaloptions: LocalUsersListOptionalParams

      The options parameters.

    Returns PagedAsyncIterableIterator<LocalUser>

listKeys

  • listKeys(resourceGroupName, accountName, username, options?): Promise<LocalUserKeys>

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

    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.

    • Optionaloptions: LocalUsersListKeysOptionalParams

      The options parameters.

    Returns Promise<LocalUserKeys>

regeneratePassword

  • regeneratePassword(resourceGroupName, accountName, username, options?): Promise<LocalUserRegeneratePasswordResult>

  • Regenerate the local user SSH password.

    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.

    • Optionaloptions: LocalUsersRegeneratePasswordOptionalParams

      The options parameters.

    Returns Promise<LocalUserRegeneratePasswordResult>

Settings

Member Visibility