LocalUsersOperationsClient Interface

Package:

com.azure.resourcemanager.storage.fluent

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-storage:2.45.0

public interface LocalUsersOperationsClient

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

Method Summary

Modifier and Type	Method and Description
abstract LocalUserInner	createOrUpdate(String resourceGroupName, String accountName, String username, LocalUserInner properties) Create or update the properties of a local user associated with the storage account.
abstract 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.
abstract Response<LocalUserInner>	createOrUpdateWithResponse(String resourceGroupName, String accountName, String username, LocalUserInner properties, Context context) Create or update the properties of a local user associated with the storage account.
abstract Mono<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.
abstract void	delete(String resourceGroupName, String accountName, String username) Deletes the local user associated with the specified storage account.
abstract Mono<Void>	deleteAsync(String resourceGroupName, String accountName, String username) Deletes the local user associated with the specified storage account.
abstract Response<Void>	deleteWithResponse(String resourceGroupName, String accountName, String username, Context context) Deletes the local user associated with the specified storage account.
abstract Mono<Response<Void>>	deleteWithResponseAsync(String resourceGroupName, String accountName, String username) Deletes the local user associated with the specified storage account.
abstract LocalUserInner	get(String resourceGroupName, String accountName, String username) Get the local user of the storage account by username.
abstract Mono<LocalUserInner>	getAsync(String resourceGroupName, String accountName, String username) Get the local user of the storage account by username.
abstract Response<LocalUserInner>	getWithResponse(String resourceGroupName, String accountName, String username, Context context) Get the local user of the storage account by username.
abstract Mono<Response<LocalUserInner>>	getWithResponseAsync(String resourceGroupName, String accountName, String username) Get the local user of the storage account by username.
abstract PagedIterable<LocalUserInner>	list(String resourceGroupName, String accountName) List the local users associated with the storage account.
abstract PagedIterable<LocalUserInner>	list(String resourceGroupName, String accountName, Integer maxpagesize, String filter, ListLocalUserIncludeParam include, Context context) List the local users associated with the storage account.
abstract PagedFlux<LocalUserInner>	listAsync(String resourceGroupName, String accountName) List the local users associated with the storage account.
abstract PagedFlux<LocalUserInner>	listAsync(String resourceGroupName, String accountName, Integer maxpagesize, String filter, ListLocalUserIncludeParam include) List the local users associated with the storage account.
abstract LocalUserKeysInner	listKeys(String resourceGroupName, String accountName, String username) List SSH authorized keys and shared key of the local user.
abstract Mono<LocalUserKeysInner>	listKeysAsync(String resourceGroupName, String accountName, String username) List SSH authorized keys and shared key of the local user.
abstract Response<LocalUserKeysInner>	listKeysWithResponse(String resourceGroupName, String accountName, String username, Context context) List SSH authorized keys and shared key of the local user.
abstract Mono<Response<LocalUserKeysInner>>	listKeysWithResponseAsync(String resourceGroupName, String accountName, String username) List SSH authorized keys and shared key of the local user.
abstract LocalUserRegeneratePasswordResultInner	regeneratePassword(String resourceGroupName, String accountName, String username) Regenerate the local user SSH password.
abstract Mono<LocalUserRegeneratePasswordResultInner>	regeneratePasswordAsync(String resourceGroupName, String accountName, String username) Regenerate the local user SSH password.
abstract Response<LocalUserRegeneratePasswordResultInner>	regeneratePasswordWithResponse(String resourceGroupName, String accountName, String username, Context context) Regenerate the local user SSH password.
abstract Mono<Response<LocalUserRegeneratePasswordResultInner>>	regeneratePasswordWithResponseAsync(String resourceGroupName, String accountName, String username) Regenerate the local user SSH password.

Method Details

createOrUpdate

public abstract 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.

createOrUpdateAsync

public abstract Mono 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.

createOrUpdateWithResponse

public abstract Response createOrUpdateWithResponse(String resourceGroupName, String accountName, String username, LocalUserInner properties, 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<T>.

createOrUpdateWithResponseAsync

public abstract Mono> 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<T> on successful completion of Mono.

delete

public abstract 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.

deleteAsync

public abstract Mono 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.

deleteWithResponse

public abstract Response deleteWithResponse(String resourceGroupName, String accountName, String username, 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<T>.

deleteWithResponseAsync

public abstract Mono> 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<T> on successful completion of Mono.

get

public abstract 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.

getAsync

public abstract Mono 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.

getWithResponse

public abstract Response getWithResponse(String resourceGroupName, String accountName, String username, 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<T>.

getWithResponseAsync

public abstract Mono> 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<T> on successful completion of Mono.

list

public abstract PagedIterable 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<T>.

list

public abstract PagedIterable list(String resourceGroupName, String accountName, Integer maxpagesize, String filter, ListLocalUserIncludeParam include, 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<T>.

listAsync

public abstract PagedFlux 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<T>.

listAsync

public abstract PagedFlux 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<T>.

listKeys

public abstract 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.

listKeysAsync

public abstract Mono 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.

listKeysWithResponse

public abstract Response listKeysWithResponse(String resourceGroupName, String accountName, String username, 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<T>.

listKeysWithResponseAsync

public abstract Mono> 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<T> on successful completion of Mono.

regeneratePassword

public abstract 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.

regeneratePasswordAsync

public abstract Mono 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.

regeneratePasswordWithResponse

public abstract Response regeneratePasswordWithResponse(String resourceGroupName, String accountName, String username, 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<T>.

regeneratePasswordWithResponseAsync

public abstract Mono> 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<T> on successful completion of Mono.