Local Users - List Keys
List SSH authorized keys and shared key of the local user.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/localUsers/{username}/listKeys?api-version=2023-05-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
account
|
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: |
resource
|
path | True |
string |
The name of the resource group within the user's subscription. The name is case insensitive. Regex pattern: |
subscription
|
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 |
OK -- Get the local user keys successfully. |
|
Other Status Codes |
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
ListLocalUserKeys
Sample request
Sample response
{
"sshAuthorizedKeys": [
{
"description": "key name",
"key": "ssh-rsa keykeykeykeykew="
}
],
"sharedKey": "<REDACTED>"
}
Definitions
Name | Description |
---|---|
Error |
An error response from the storage resource provider. |
Error |
Error response body contract. |
Local |
The Storage Account Local User keys. |
Ssh |
ErrorResponse
An error response from the storage resource provider.
Name | Type | Description |
---|---|---|
error |
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. |
LocalUserKeys
The Storage Account Local User keys.
Name | Type | Description |
---|---|---|
sharedKey |
string |
Auto generated by the server for SMB authentication. |
sshAuthorizedKeys |
Optional, local user ssh authorized keys for SFTP. |
SshPublicKey
Name | Type | Description |
---|---|---|
description |
string |
Optional. It is used to store the function/usage of the key |
key |
string |
Ssh public key base64 encoded. The format should be: ' ', e.g. ssh-rsa AAAABBBB |