azure.mgmt.storage.v2023_01_01.operations.LocalUsersOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.storage.v2023_01_01.operations.LocalUsersOperations
name: LocalUsersOperations
fullName: azure.mgmt.storage.v2023_01_01.operations.LocalUsersOperations
module: azure.mgmt.storage.v2023_01_01.operations
inheritances:
- builtins.object
summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
  \ you should access the following operations through\n>\n> <xref:azure.mgmt.storage.v2023_01_01.StorageManagementClient>'s\n\
  >\n> <xref:local_users> attribute.\n>"
constructor:
  syntax: LocalUsersOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.storage.v2023_01_01.operations.LocalUsersOperations.create_or_update
  name: create_or_update
  summary: Create or update the properties of a local user associated with the storage
    account.
  signature: '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: resource_group_name
    description: 'The name of the resource group within the user''s subscription.
      The

      name is case insensitive. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: '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.'
    isRequired: true
    types:
    - <xref:str>
  - name: username
    description: 'The name of local user. The username must contain lowercase letters
      and

      numbers only. It must be unique only within the storage account. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: properties
    description: 'The local user associated with a storage account. Is either a LocalUser
      type

      or a IO[bytes] type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.storage.v2023_01_01.models.LocalUser>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: LocalUser or the result of cls(response)
    types:
    - <xref:azure.mgmt.storage.v2023_01_01.models.LocalUser>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.storage.v2023_01_01.operations.LocalUsersOperations.delete
  name: delete
  summary: Deletes the local user associated with the specified storage account.
  signature: 'delete(resource_group_name: str, account_name: str, username: str, **kwargs:
    Any) -> None'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group within the user''s subscription.
      The

      name is case insensitive. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: '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.'
    isRequired: true
    types:
    - <xref:str>
  - name: username
    description: 'The name of local user. The username must contain lowercase letters
      and

      numbers only. It must be unique only within the storage account. Required.'
    isRequired: true
    types:
    - <xref:str>
  return:
    description: None or the result of cls(response)
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.storage.v2023_01_01.operations.LocalUsersOperations.get
  name: get
  summary: Get the local user of the storage account by username.
  signature: 'get(resource_group_name: str, account_name: str, username: str, **kwargs:
    Any) -> LocalUser'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group within the user''s subscription.
      The

      name is case insensitive. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: '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.'
    isRequired: true
    types:
    - <xref:str>
  - name: username
    description: 'The name of local user. The username must contain lowercase letters
      and

      numbers only. It must be unique only within the storage account. Required.'
    isRequired: true
    types:
    - <xref:str>
  return:
    description: LocalUser or the result of cls(response)
    types:
    - <xref:azure.mgmt.storage.v2023_01_01.models.LocalUser>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.storage.v2023_01_01.operations.LocalUsersOperations.list
  name: list
  summary: List the local users associated with the storage account.
  signature: 'list(resource_group_name: str, account_name: str, **kwargs: Any) ->
    Iterable[LocalUser]'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group within the user''s subscription.
      The

      name is case insensitive. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: '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.'
    isRequired: true
    types:
    - <xref:str>
  return:
    description: An iterator like instance of either LocalUser or the result of cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.storage.v2023_01_01.models.LocalUser>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.storage.v2023_01_01.operations.LocalUsersOperations.list_keys
  name: list_keys
  summary: List SSH authorized keys and shared key of the local user.
  signature: 'list_keys(resource_group_name: str, account_name: str, username: str,
    **kwargs: Any) -> LocalUserKeys'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group within the user''s subscription.
      The

      name is case insensitive. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: '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.'
    isRequired: true
    types:
    - <xref:str>
  - name: username
    description: 'The name of local user. The username must contain lowercase letters
      and

      numbers only. It must be unique only within the storage account. Required.'
    isRequired: true
    types:
    - <xref:str>
  return:
    description: LocalUserKeys or the result of cls(response)
    types:
    - <xref:azure.mgmt.storage.v2023_01_01.models.LocalUserKeys>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.storage.v2023_01_01.operations.LocalUsersOperations.regenerate_password
  name: regenerate_password
  summary: Regenerate the local user SSH password.
  signature: 'regenerate_password(resource_group_name: str, account_name: str, username:
    str, **kwargs: Any) -> LocalUserRegeneratePasswordResult'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group within the user''s subscription.
      The

      name is case insensitive. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: '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.'
    isRequired: true
    types:
    - <xref:str>
  - name: username
    description: 'The name of local user. The username must contain lowercase letters
      and

      numbers only. It must be unique only within the storage account. Required.'
    isRequired: true
    types:
    - <xref:str>
  return:
    description: LocalUserRegeneratePasswordResult or the result of cls(response)
    types:
    - <xref:azure.mgmt.storage.v2023_01_01.models.LocalUserRegeneratePasswordResult>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.storage.v2023_01_01.operations.LocalUsersOperations.models
  name: models
  signature: models = <module 'azure.mgmt.storage.v2023_01_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\storage\\v2023_01_01\\models\\__init__.py'>