List the local users associated with the storage account.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/localUsers?api-version=2023-05-01
With optional parameters:
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/localUsers?api-version=2023-05-01&$maxpagesize={$maxpagesize}&$filter={$filter}&$include=nfsv3
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.
|
api-version
|
query |
True
|
string
|
The API version to use for this operation.
|
$filter
|
query |
|
string
|
Optional. When specified, only local user names starting with the filter will be listed.
|
$include
|
query |
|
ListLocalUserIncludeParam
|
Optional, when specified, will list local users enabled for the specific protocol. Lists all users by default.
|
$maxpagesize
|
query |
|
integer
int32
|
Optional, specifies the maximum number of local users that will be included in the list response.
|
Responses
Name |
Type |
Description |
200 OK
|
LocalUsers
|
OK -- List local users 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
ListLocalUsers
Sample request
GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res6977/providers/Microsoft.Storage/storageAccounts/sto2527/localUsers?api-version=2023-05-01&$include=nfsv3
/**
* Samples for LocalUsersOperation List.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/examples/LocalUsersList.json
*/
/**
* Sample code: ListLocalUsers.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void listLocalUsers(com.azure.resourcemanager.AzureResourceManager azure) {
azure.storageAccounts().manager().serviceClient().getLocalUsersOperations().list("res6977", "sto2527", null,
null, null, com.azure.core.util.Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.storage import StorageManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-storage
# USAGE
python local_users_list.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = StorageManagementClient(
credential=DefaultAzureCredential(),
subscription_id="{subscription-id}",
)
response = client.local_users.list(
resource_group_name="res6977",
account_name="sto2527",
)
for item in response:
print(item)
# x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/examples/LocalUsersList.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armstorage_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storage/armstorage"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/220ad9c6554fc7d6d10a89bdb441c1e3b36e3285/specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/examples/LocalUsersList.json
func ExampleLocalUsersClient_NewListPager_listLocalUsers() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armstorage.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewLocalUsersClient().NewListPager("res6977", "sto2527", &armstorage.LocalUsersClientListOptions{Maxpagesize: nil,
Filter: nil,
Include: nil,
})
for pager.More() {
page, err := pager.NextPage(ctx)
if err != nil {
log.Fatalf("failed to advance page: %v", err)
}
for _, v := range page.Value {
// You could use page here. We use blank identifier for just demo purposes.
_ = v
}
// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// page.LocalUsers = armstorage.LocalUsers{
// Value: []*armstorage.LocalUser{
// {
// Name: to.Ptr("user1"),
// Type: to.Ptr("Microsoft.Storage/storageAccounts/localUsers"),
// ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/res6977/providers/Microsoft.Storage/storageAccounts/sto2527/loalUsers/user1"),
// Properties: &armstorage.LocalUserProperties{
// AllowACLAuthorization: to.Ptr(true),
// GroupID: to.Ptr[int32](2000),
// HasSharedKey: to.Ptr(true),
// HasSSHKey: to.Ptr(true),
// HasSSHPassword: to.Ptr(true),
// HomeDirectory: to.Ptr("homedirectory"),
// PermissionScopes: []*armstorage.PermissionScope{
// {
// Permissions: to.Ptr("rwd"),
// ResourceName: to.Ptr("share1"),
// Service: to.Ptr("file"),
// },
// {
// Permissions: to.Ptr("rw"),
// ResourceName: to.Ptr("share2"),
// Service: to.Ptr("file"),
// }},
// Sid: to.Ptr("S-1-2-0-125132-153423-36235-1000"),
// UserID: to.Ptr[int32](1000),
// },
// },
// {
// Name: to.Ptr("user2"),
// Type: to.Ptr("Microsoft.Storage/storageAccounts/localUsers"),
// ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto1590/loalUsers/user2"),
// Properties: &armstorage.LocalUserProperties{
// AllowACLAuthorization: to.Ptr(true),
// GroupID: to.Ptr[int32](2000),
// HasSharedKey: to.Ptr(true),
// HasSSHKey: to.Ptr(false),
// HasSSHPassword: to.Ptr(true),
// PermissionScopes: []*armstorage.PermissionScope{
// {
// Permissions: to.Ptr("rw"),
// ResourceName: to.Ptr("resourcename"),
// Service: to.Ptr("blob"),
// }},
// Sid: to.Ptr("S-1-2-0-533672-235636-66334-1001"),
// UserID: to.Ptr[int32](1001),
// },
// }},
// }
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { StorageManagementClient } = require("@azure/arm-storage");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to List the local users associated with the storage account.
*
* @summary List the local users associated with the storage account.
* x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/examples/LocalUsersList.json
*/
async function listLocalUsers() {
const subscriptionId = process.env["STORAGE_SUBSCRIPTION_ID"] || "{subscription-id}";
const resourceGroupName = process.env["STORAGE_RESOURCE_GROUP"] || "res6977";
const accountName = "sto2527";
const credential = new DefaultAzureCredential();
const client = new StorageManagementClient(credential, subscriptionId);
const resArray = new Array();
for await (let item of client.localUsersOperations.list(resourceGroupName, accountName)) {
resArray.push(item);
}
console.log(resArray);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Storage.Models;
using Azure.ResourceManager.Storage;
// Generated from example definition: specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/examples/LocalUsersList.json
// this example is just showing the usage of "LocalUsers_List" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://video2.skills-academy.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this StorageAccountResource created on azure
// for more information of creating StorageAccountResource, please refer to the document of StorageAccountResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "res6977";
string accountName = "sto2527";
ResourceIdentifier storageAccountResourceId = StorageAccountResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName);
StorageAccountResource storageAccount = client.GetStorageAccountResource(storageAccountResourceId);
// get the collection of this StorageAccountLocalUserResource
StorageAccountLocalUserCollection collection = storageAccount.GetStorageAccountLocalUsers();
// invoke the operation and iterate over the result
await foreach (StorageAccountLocalUserResource item in collection.GetAllAsync())
{
// the variable item is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
StorageAccountLocalUserData resourceData = item.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}
Console.WriteLine($"Succeeded");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Sample response
{
"value": [
{
"id": "/subscriptions/{subscription-id}/resourceGroups/res6977/providers/Microsoft.Storage/storageAccounts/sto2527/loalUsers/user1",
"name": "user1",
"type": "Microsoft.Storage/storageAccounts/localUsers",
"properties": {
"permissionScopes": [
{
"permissions": "rwd",
"service": "file",
"resourceName": "share1"
},
{
"permissions": "rw",
"service": "file",
"resourceName": "share2"
}
],
"homeDirectory": "homedirectory",
"sid": "S-1-2-0-125132-153423-36235-1000",
"hasSharedKey": true,
"hasSshKey": true,
"hasSshPassword": true,
"userId": 1000,
"groupId": 2000,
"allowAclAuthorization": true
}
},
{
"id": "/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto1590/loalUsers/user2",
"name": "user2",
"type": "Microsoft.Storage/storageAccounts/localUsers",
"properties": {
"permissionScopes": [
{
"permissions": "rw",
"service": "blob",
"resourceName": "resourcename"
}
],
"sid": "S-1-2-0-533672-235636-66334-1001",
"hasSharedKey": true,
"hasSshKey": false,
"hasSshPassword": true,
"userId": 1001,
"groupId": 2000,
"allowAclAuthorization": true
}
}
],
"nextLink": null
}
ListNFSv3EnabledLocalUsers
Sample request
GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res6977/providers/Microsoft.Storage/storageAccounts/sto2527/localUsers?api-version=2023-05-01&$include=nfsv3
import com.azure.resourcemanager.storage.models.ListLocalUserIncludeParam;
/**
* Samples for LocalUsersOperation List.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/examples/LocalUsersListNFSv3Enabled.
* json
*/
/**
* Sample code: ListNFSv3EnabledLocalUsers.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void listNFSv3EnabledLocalUsers(com.azure.resourcemanager.AzureResourceManager azure) {
azure.storageAccounts().manager().serviceClient().getLocalUsersOperations().list("res6977", "sto2527", null,
null, ListLocalUserIncludeParam.NFSV3, com.azure.core.util.Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.storage import StorageManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-storage
# USAGE
python local_users_list_nf_sv3_enabled.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = StorageManagementClient(
credential=DefaultAzureCredential(),
subscription_id="{subscription-id}",
)
response = client.local_users.list(
resource_group_name="res6977",
account_name="sto2527",
)
for item in response:
print(item)
# x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/examples/LocalUsersListNFSv3Enabled.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armstorage_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storage/armstorage"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/220ad9c6554fc7d6d10a89bdb441c1e3b36e3285/specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/examples/LocalUsersListNFSv3Enabled.json
func ExampleLocalUsersClient_NewListPager_listNfSv3EnabledLocalUsers() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armstorage.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewLocalUsersClient().NewListPager("res6977", "sto2527", &armstorage.LocalUsersClientListOptions{Maxpagesize: nil,
Filter: nil,
Include: to.Ptr(armstorage.ListLocalUserIncludeParamNfsv3),
})
for pager.More() {
page, err := pager.NextPage(ctx)
if err != nil {
log.Fatalf("failed to advance page: %v", err)
}
for _, v := range page.Value {
// You could use page here. We use blank identifier for just demo purposes.
_ = v
}
// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// page.LocalUsers = armstorage.LocalUsers{
// Value: []*armstorage.LocalUser{
// {
// Name: to.Ptr("user1"),
// Type: to.Ptr("Microsoft.Storage/storageAccounts/localUsers"),
// ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/res6977/providers/Microsoft.Storage/storageAccounts/sto2527/loalUsers/user1"),
// Properties: &armstorage.LocalUserProperties{
// AllowACLAuthorization: to.Ptr(true),
// ExtendedGroups: []*int32{
// to.Ptr[int32](1001),
// to.Ptr[int32](1005),
// to.Ptr[int32](2005)},
// GroupID: to.Ptr[int32](2000),
// HasSharedKey: to.Ptr(true),
// HasSSHKey: to.Ptr(true),
// HasSSHPassword: to.Ptr(true),
// HomeDirectory: to.Ptr("homedirectory"),
// IsNFSv3Enabled: to.Ptr(true),
// PermissionScopes: []*armstorage.PermissionScope{
// {
// Permissions: to.Ptr("rwd"),
// ResourceName: to.Ptr("share1"),
// Service: to.Ptr("file"),
// },
// {
// Permissions: to.Ptr("rw"),
// ResourceName: to.Ptr("share2"),
// Service: to.Ptr("file"),
// }},
// Sid: to.Ptr("S-1-2-0-125132-153423-36235-1000"),
// UserID: to.Ptr[int32](1000),
// },
// },
// {
// Name: to.Ptr("user2"),
// Type: to.Ptr("Microsoft.Storage/storageAccounts/localUsers"),
// ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto1590/loalUsers/user2"),
// Properties: &armstorage.LocalUserProperties{
// AllowACLAuthorization: to.Ptr(true),
// ExtendedGroups: []*int32{
// to.Ptr[int32](1001),
// to.Ptr[int32](1005),
// to.Ptr[int32](2005)},
// GroupID: to.Ptr[int32](2000),
// HasSharedKey: to.Ptr(true),
// HasSSHKey: to.Ptr(false),
// HasSSHPassword: to.Ptr(true),
// IsNFSv3Enabled: to.Ptr(true),
// PermissionScopes: []*armstorage.PermissionScope{
// {
// Permissions: to.Ptr("rw"),
// ResourceName: to.Ptr("resourcename"),
// Service: to.Ptr("blob"),
// }},
// Sid: to.Ptr("S-1-2-0-533672-235636-66334-1001"),
// UserID: to.Ptr[int32](1001),
// },
// }},
// }
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { StorageManagementClient } = require("@azure/arm-storage");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to List the local users associated with the storage account.
*
* @summary List the local users associated with the storage account.
* x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/examples/LocalUsersListNFSv3Enabled.json
*/
async function listNfSv3EnabledLocalUsers() {
const subscriptionId = process.env["STORAGE_SUBSCRIPTION_ID"] || "{subscription-id}";
const resourceGroupName = process.env["STORAGE_RESOURCE_GROUP"] || "res6977";
const accountName = "sto2527";
const include = "nfsv3";
const options = { include };
const credential = new DefaultAzureCredential();
const client = new StorageManagementClient(credential, subscriptionId);
const resArray = new Array();
for await (let item of client.localUsersOperations.list(
resourceGroupName,
accountName,
options,
)) {
resArray.push(item);
}
console.log(resArray);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Storage.Models;
using Azure.ResourceManager.Storage;
// Generated from example definition: specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/examples/LocalUsersListNFSv3Enabled.json
// this example is just showing the usage of "LocalUsers_List" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://video2.skills-academy.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this StorageAccountResource created on azure
// for more information of creating StorageAccountResource, please refer to the document of StorageAccountResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "res6977";
string accountName = "sto2527";
ResourceIdentifier storageAccountResourceId = StorageAccountResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName);
StorageAccountResource storageAccount = client.GetStorageAccountResource(storageAccountResourceId);
// get the collection of this StorageAccountLocalUserResource
StorageAccountLocalUserCollection collection = storageAccount.GetStorageAccountLocalUsers();
// invoke the operation and iterate over the result
ListLocalUserIncludeParam? include = ListLocalUserIncludeParam.Nfsv3;
await foreach (StorageAccountLocalUserResource item in collection.GetAllAsync(include: include))
{
// the variable item is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
StorageAccountLocalUserData resourceData = item.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}
Console.WriteLine($"Succeeded");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Sample response
{
"value": [
{
"id": "/subscriptions/{subscription-id}/resourceGroups/res6977/providers/Microsoft.Storage/storageAccounts/sto2527/loalUsers/user1",
"name": "user1",
"type": "Microsoft.Storage/storageAccounts/localUsers",
"properties": {
"permissionScopes": [
{
"permissions": "rwd",
"service": "file",
"resourceName": "share1"
},
{
"permissions": "rw",
"service": "file",
"resourceName": "share2"
}
],
"homeDirectory": "homedirectory",
"sid": "S-1-2-0-125132-153423-36235-1000",
"hasSharedKey": true,
"hasSshKey": true,
"hasSshPassword": true,
"userId": 1000,
"groupId": 2000,
"allowAclAuthorization": true,
"extendedGroups": [
1001,
1005,
2005
],
"isNFSv3Enabled": true
}
},
{
"id": "/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto1590/loalUsers/user2",
"name": "user2",
"type": "Microsoft.Storage/storageAccounts/localUsers",
"properties": {
"permissionScopes": [
{
"permissions": "rw",
"service": "blob",
"resourceName": "resourcename"
}
],
"sid": "S-1-2-0-533672-235636-66334-1001",
"hasSharedKey": true,
"hasSshKey": false,
"hasSshPassword": true,
"userId": 1001,
"groupId": 2000,
"allowAclAuthorization": true,
"extendedGroups": [
1001,
1005,
2005
],
"isNFSv3Enabled": true
}
}
]
}
Definitions
createdByType
The type of identity that created the resource.
Name |
Type |
Description |
Application
|
string
|
|
Key
|
string
|
|
ManagedIdentity
|
string
|
|
User
|
string
|
|
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.
|
ListLocalUserIncludeParam
Optional, when specified, will list local users enabled for the specific protocol. Lists all users by default.
Name |
Type |
Description |
nfsv3
|
string
|
|
LocalUser
The local user associated with the storage accounts.
Name |
Type |
Description |
id
|
string
|
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
|
name
|
string
|
The name of the resource
|
properties.allowAclAuthorization
|
boolean
|
Indicates whether ACL authorization is allowed for this user. Set it to false to disallow using ACL authorization.
|
properties.extendedGroups
|
integer[]
|
Supplementary group membership. Only applicable for local users enabled for NFSv3 access.
|
properties.groupId
|
integer
|
An identifier for associating a group of users.
|
properties.hasSharedKey
|
boolean
|
Indicates whether shared key exists. Set it to false to remove existing shared key.
|
properties.hasSshKey
|
boolean
|
Indicates whether ssh key exists. Set it to false to remove existing SSH key.
|
properties.hasSshPassword
|
boolean
|
Indicates whether ssh password exists. Set it to false to remove existing SSH password.
|
properties.homeDirectory
|
string
|
Optional, local user home directory.
|
properties.isNFSv3Enabled
|
boolean
|
Indicates if the local user is enabled for access with NFSv3 protocol.
|
properties.permissionScopes
|
PermissionScope[]
|
The permission scopes of the local user.
|
properties.sid
|
string
|
A unique Security Identifier that is generated by the server.
|
properties.sshAuthorizedKeys
|
SshPublicKey[]
|
Optional, local user ssh authorized keys for SFTP.
|
properties.userId
|
integer
|
A unique Identifier that is generated by the server.
|
systemData
|
systemData
|
Metadata pertaining to creation and last modification of the resource.
|
type
|
string
|
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
|
LocalUsers
List of local users requested, and if paging is required, a URL to the next page of local users.
Name |
Type |
Description |
nextLink
|
string
|
Request URL that can be used to query next page of local users. Returned when total number of requested local users exceeds the maximum page size.
|
value
|
LocalUser[]
|
The list of local users associated with the storage account.
|
PermissionScope
Name |
Type |
Description |
permissions
|
string
|
The permissions for the local user. Possible values include: Read (r), Write (w), Delete (d), List (l), Create (c), Modify Ownership (o), and Modify Permissions (p).
|
resourceName
|
string
|
The name of resource, normally the container name or the file share name, used by the local user.
|
service
|
string
|
The service used by the local user, e.g. blob, file.
|
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
|
systemData
Metadata pertaining to creation and last modification of the resource.
Name |
Type |
Description |
createdAt
|
string
|
The timestamp of resource creation (UTC).
|
createdBy
|
string
|
The identity that created the resource.
|
createdByType
|
createdByType
|
The type of identity that created the resource.
|
lastModifiedAt
|
string
|
The timestamp of resource last modification (UTC)
|
lastModifiedBy
|
string
|
The identity that last modified the resource.
|
lastModifiedByType
|
createdByType
|
The type of identity that last modified the resource.
|