Partager via


Local Users - Regenerate Password

Regenerate the local user SSH password.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/localUsers/{username}/regeneratePassword?api-version=2023-05-01

URI Parameters

Name In Required Type Description
accountName
path True

string

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.

Regex pattern: ^[a-z0-9]+$

resourceGroupName
path True

string

The name of the resource group within the user's subscription. The name is case insensitive.

Regex pattern: ^[-\w\._\(\)]+$

subscriptionId
path True

string

The ID of the target subscription.

username
path True

string

The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account.

api-version
query True

string

The API version to use for this operation.

Responses

Name Type Description
200 OK

LocalUserRegeneratePasswordResult

OK -- Regenerate local user password successfully.

Other Status Codes

ErrorResponse

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

RegenerateLocalUserPassword

Sample request

POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res6977/providers/Microsoft.Storage/storageAccounts/sto2527/localUsers/user1/regeneratePassword?api-version=2023-05-01

Sample response

{
  "sshPassword": "<REDACTED>"
}

Definitions

Name Description
ErrorResponse

An error response from the storage resource provider.

ErrorResponseBody

Error response body contract.

LocalUserRegeneratePasswordResult

The secrets of Storage Account Local User.

ErrorResponse

An error response from the storage resource provider.

Name Type Description
error

ErrorResponseBody

Azure Storage Resource Provider error response body.

ErrorResponseBody

Error response body contract.

Name Type Description
code

string

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

message

string

A message describing the error, intended to be suitable for display in a user interface.

LocalUserRegeneratePasswordResult

The secrets of Storage Account Local User.

Name Type Description
sshPassword

string

Auto generated password by the server for SSH authentication if hasSshPassword is set to true on the creation of local user.