Package com.azure.resourcemanager.storage.fluent

Interface LocalUsersOperationsClient

public interface LocalUsersOperationsClient
An instance of this class provides access to all the operations defined in LocalUsersOperationsClient.

  • Method Details

    • listAsync

      com.azure.core.http.rest.PagedFlux<LocalUserInner> listAsync(String resourceGroupName, String accountName, Integer maxpagesize, String filter, ListLocalUserIncludeParam include)
      List the local users associated with the storage account.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - 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.
      maxpagesize - Optional, specifies the maximum number of local users that will be included in the list response.
      filter - Optional. When specified, only local user names starting with the filter will be listed.
      include - Optional, when specified, will list local users enabled for the specific protocol. Lists all users by default.
      Returns:
      list of local users requested, and if paging is required, a URL to the next page of local users as paginated response with PagedFlux.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listAsync

      com.azure.core.http.rest.PagedFlux<LocalUserInner> listAsync(String resourceGroupName, String accountName)
      List the local users associated with the storage account.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - 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.
      Returns:
      list of local users requested, and if paging is required, a URL to the next page of local users as paginated response with PagedFlux.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • list

      com.azure.core.http.rest.PagedIterable<LocalUserInner> list(String resourceGroupName, String accountName)
      List the local users associated with the storage account.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - 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.
      Returns:
      list of local users requested, and if paging is required, a URL to the next page of local users as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • list

      com.azure.core.http.rest.PagedIterable<LocalUserInner> list(String resourceGroupName, String accountName, Integer maxpagesize, String filter, ListLocalUserIncludeParam include, com.azure.core.util.Context context)
      List the local users associated with the storage account.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - 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.
      maxpagesize - Optional, specifies the maximum number of local users that will be included in the list response.
      filter - Optional. When specified, only local user names starting with the filter will be listed.
      include - Optional, when specified, will list local users enabled for the specific protocol. Lists all users by default.
      context - The context to associate with this operation.
      Returns:
      list of local users requested, and if paging is required, a URL to the next page of local users as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getWithResponseAsync

      Mono<com.azure.core.http.rest.Response<LocalUserInner>> getWithResponseAsync(String resourceGroupName, String accountName, String username)
      Get the local user of the storage account by username.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - 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 - The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account.
      Returns:
      the local user of the storage account by username along with Response on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getAsync

      Mono<LocalUserInner> getAsync(String resourceGroupName, String accountName, String username)
      Get the local user of the storage account by username.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - 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 - The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account.
      Returns:
      the local user of the storage account by username on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getWithResponse

      com.azure.core.http.rest.Response<LocalUserInner> getWithResponse(String resourceGroupName, String accountName, String username, com.azure.core.util.Context context)
      Get the local user of the storage account by username.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - 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 - The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account.
      context - The context to associate with this operation.
      Returns:
      the local user of the storage account by username along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • get

      LocalUserInner get(String resourceGroupName, String accountName, String username)
      Get the local user of the storage account by username.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - 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 - The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account.
      Returns:
      the local user of the storage account by username.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • createOrUpdateWithResponseAsync

      Mono<com.azure.core.http.rest.Response<LocalUserInner>> createOrUpdateWithResponseAsync(String resourceGroupName, String accountName, String username, LocalUserInner properties)
      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 - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - 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 - The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account.
      properties - The local user associated with a storage account.
      Returns:
      the local user associated with the storage accounts along with Response on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • createOrUpdateAsync

      Mono<LocalUserInner> createOrUpdateAsync(String resourceGroupName, String accountName, String username, LocalUserInner properties)
      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 - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - 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 - The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account.
      properties - The local user associated with a storage account.
      Returns:
      the local user associated with the storage accounts on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • createOrUpdateWithResponse

      com.azure.core.http.rest.Response<LocalUserInner> createOrUpdateWithResponse(String resourceGroupName, String accountName, String username, LocalUserInner properties, com.azure.core.util.Context context)
      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 - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - 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 - The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account.
      properties - The local user associated with a storage account.
      context - The context to associate with this operation.
      Returns:
      the local user associated with the storage accounts along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • createOrUpdate

      LocalUserInner createOrUpdate(String resourceGroupName, String accountName, String username, LocalUserInner properties)
      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 - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - 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 - The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account.
      properties - The local user associated with a storage account.
      Returns:
      the local user associated with the storage accounts.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteWithResponseAsync

      Mono<com.azure.core.http.rest.Response<Void>> deleteWithResponseAsync(String resourceGroupName, String accountName, String username)
      Deletes the local user associated with the specified storage account.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - 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 - The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account.
      Returns:
      the Response on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteAsync

      Mono<Void> deleteAsync(String resourceGroupName, String accountName, String username)
      Deletes the local user associated with the specified storage account.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - 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 - The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteWithResponse

      com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName, String accountName, String username, com.azure.core.util.Context context)
      Deletes the local user associated with the specified storage account.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - 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 - The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account.
      context - The context to associate with this operation.
      Returns:
      the Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • delete

      void delete(String resourceGroupName, String accountName, String username)
      Deletes the local user associated with the specified storage account.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - 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 - The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listKeysWithResponseAsync

      Mono<com.azure.core.http.rest.Response<LocalUserKeysInner>> listKeysWithResponseAsync(String resourceGroupName, String accountName, String username)
      List SSH authorized keys and shared key of the local user.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - 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 - The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account.
      Returns:
      the Storage Account Local User keys along with Response on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listKeysAsync

      Mono<LocalUserKeysInner> listKeysAsync(String resourceGroupName, String accountName, String username)
      List SSH authorized keys and shared key of the local user.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - 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 - The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account.
      Returns:
      the Storage Account Local User keys on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listKeysWithResponse

      com.azure.core.http.rest.Response<LocalUserKeysInner> listKeysWithResponse(String resourceGroupName, String accountName, String username, com.azure.core.util.Context context)
      List SSH authorized keys and shared key of the local user.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - 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 - The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account.
      context - The context to associate with this operation.
      Returns:
      the Storage Account Local User keys along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listKeys

      LocalUserKeysInner listKeys(String resourceGroupName, String accountName, String username)
      List SSH authorized keys and shared key of the local user.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - 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 - The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account.
      Returns:
      the Storage Account Local User keys.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • regeneratePasswordWithResponseAsync

      Mono<com.azure.core.http.rest.Response<LocalUserRegeneratePasswordResultInner>> regeneratePasswordWithResponseAsync(String resourceGroupName, String accountName, String username)
      Regenerate the local user SSH password.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - 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 - The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account.
      Returns:
      the secrets of Storage Account Local User along with Response on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • regeneratePasswordAsync

      Mono<LocalUserRegeneratePasswordResultInner> regeneratePasswordAsync(String resourceGroupName, String accountName, String username)
      Regenerate the local user SSH password.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - 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 - The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account.
      Returns:
      the secrets of Storage Account Local User on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • regeneratePasswordWithResponse

      com.azure.core.http.rest.Response<LocalUserRegeneratePasswordResultInner> regeneratePasswordWithResponse(String resourceGroupName, String accountName, String username, com.azure.core.util.Context context)
      Regenerate the local user SSH password.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - 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 - The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account.
      context - The context to associate with this operation.
      Returns:
      the secrets of Storage Account Local User along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • regeneratePassword

      LocalUserRegeneratePasswordResultInner regeneratePassword(String resourceGroupName, String accountName, String username)
      Regenerate the local user SSH password.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - 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 - The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account.
      Returns:
      the secrets of Storage Account Local User.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.