LocalUsersOperations Class
LocalUsersOperations operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Inheritance
-
builtins.objectLocalUsersOperations
Constructor
LocalUsersOperations(client, config, serializer, deserializer)Parameters
- client
Client for service requests.
- config
Configuration of service client.
- serializer
An object model serializer.
- deserializer
An object model deserializer.
Variables
- models
Alias to model classes used in this operation group.
Methods
| create_or_update |
Create or update the properties of a local user associated with the storage account. |
| 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.
create_or_update(resource_group_name: str, account_name: str, username: str, properties: azure.mgmt.storage.v2021_08_01.models._models_py3.LocalUser, **kwargs: Any) -> azure.mgmt.storage.v2021_08_01.models._models_py3.LocalUserParameters
- resource_group_name
- str
The name of the resource group within the user's subscription. The name is case insensitive.
- account_name
- 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.
- username
- str
The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
LocalUser, or the result of cls(response)
Return type
Exceptions
delete
Deletes the local user associated with the specified storage account.
delete(resource_group_name: str, account_name: str, username: str, **kwargs: Any) -> NoneParameters
- resource_group_name
- str
The name of the resource group within the user's subscription. The name is case insensitive.
- account_name
- 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.
- username
- str
The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
None, or the result of cls(response)
Return type
Exceptions
get
Get the local user of the storage account by username.
get(resource_group_name: str, account_name: str, username: str, **kwargs: Any) -> azure.mgmt.storage.v2021_08_01.models._models_py3.LocalUserParameters
- resource_group_name
- str
The name of the resource group within the user's subscription. The name is case insensitive.
- account_name
- 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.
- username
- str
The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
LocalUser, or the result of cls(response)
Return type
Exceptions
list
List the local users associated with the storage account.
list(resource_group_name: str, account_name: str, **kwargs: Any) -> Iterable[azure.mgmt.storage.v2021_08_01.models._models_py3.LocalUsers]Parameters
- resource_group_name
- str
The name of the resource group within the user's subscription. The name is case insensitive.
- account_name
- 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.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either LocalUsers or the result of cls(response)
Return type
Exceptions
list_keys
List SSH authorized keys and shared key of the local user.
list_keys(resource_group_name: str, account_name: str, username: str, **kwargs: Any) -> azure.mgmt.storage.v2021_08_01.models._models_py3.LocalUserKeysParameters
- resource_group_name
- str
The name of the resource group within the user's subscription. The name is case insensitive.
- account_name
- 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.
- username
- str
The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
LocalUserKeys, or the result of cls(response)
Return type
Exceptions
regenerate_password
Regenerate the local user SSH password.
regenerate_password(resource_group_name: str, account_name: str, username: str, **kwargs: Any) -> azure.mgmt.storage.v2021_08_01.models._models_py3.LocalUserRegeneratePasswordResultParameters
- resource_group_name
- str
The name of the resource group within the user's subscription. The name is case insensitive.
- account_name
- 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.
- username
- str
The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
LocalUserRegeneratePasswordResult, or the result of cls(response)
Return type
Exceptions
Attributes
models
models = <module 'azure.mgmt.storage.v2021_08_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\storage\\v2021_08_01\\models\\__init__.py'>Feedback
Submit and view feedback for