LocalUsersOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

StorageManagementClient's

<xref:local_users> attribute.

Inheritance

builtins.object

LocalUsersOperations

Constructor

LocalUsersOperations(*args, **kwargs)

Methods

create_or_update	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	Deletes the local user associated with the specified storage account.
get	Get the local user of the storage account by username.
list	List the local users associated with the storage account.
list_keys	List SSH authorized keys and shared key of the local user.
regenerate_password	Regenerate the local user SSH password.

create_or_update

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.

async create_or_update(resource_group_name: str, account_name: str, username: str, properties: _models.LocalUser, *, content_type: str = 'application/json', **kwargs: Any) -> _models.LocalUser

Parameters

Name	Description
resource_group_name Required	str The name of the resource group within the user's subscription. The name is case insensitive. Required.
account_name Required	str 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. Required.
username Required	str The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account. Required.
properties Required	LocalUser or IO[bytes] The local user associated with a storage account. Is either a LocalUser type or a IO[bytes] type. Required.

Returns

Type	Description
LocalUser	LocalUser or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

delete

Deletes the local user associated with the specified storage account.

async delete(resource_group_name: str, account_name: str, username: str, **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str The name of the resource group within the user's subscription. The name is case insensitive. Required.
account_name Required	str 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. Required.
username Required	str The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account. Required.

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Get the local user of the storage account by username.

async get(resource_group_name: str, account_name: str, username: str, **kwargs: Any) -> LocalUser

Parameters

Name	Description
resource_group_name Required	str The name of the resource group within the user's subscription. The name is case insensitive. Required.
account_name Required	str 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. Required.
username Required	str The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account. Required.

Returns

Type	Description
LocalUser	LocalUser or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list

List the local users associated with the storage account.

list(resource_group_name: str, account_name: str, maxpagesize: int | None = None, filter: str | None = None, include: str | ListLocalUserIncludeParam | None = None, **kwargs: Any) -> AsyncIterable[LocalUser]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group within the user's subscription. The name is case insensitive. Required.
account_name Required	str 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. Required.
maxpagesize Required	int Optional, specifies the maximum number of local users that will be included in the list response. Default value is None.
filter Required	str Optional. When specified, only local user names starting with the filter will be listed. Default value is None.
include Required	str or ListLocalUserIncludeParam Optional, when specified, will list local users enabled for the specific protocol. Lists all users by default. "nfsv3" Default value is None.

Returns

Type	Description
AsyncItemPaged[LocalUser]	An iterator like instance of either LocalUser or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_keys

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

async list_keys(resource_group_name: str, account_name: str, username: str, **kwargs: Any) -> LocalUserKeys

Parameters

Name	Description
resource_group_name Required	str The name of the resource group within the user's subscription. The name is case insensitive. Required.
account_name Required	str 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. Required.
username Required	str The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account. Required.

Returns

Type	Description
LocalUserKeys	LocalUserKeys or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

regenerate_password

Regenerate the local user SSH password.

async regenerate_password(resource_group_name: str, account_name: str, username: str, **kwargs: Any) -> LocalUserRegeneratePasswordResult

Parameters

Name	Description
resource_group_name Required	str The name of the resource group within the user's subscription. The name is case insensitive. Required.
account_name Required	str 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. Required.
username Required	str The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account. Required.

Returns

Type	Description
LocalUserRegeneratePasswordResult	LocalUserRegeneratePasswordResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.storage.v2023_05_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\storage\\v2023_05_01\\models\\__init__.py'>