Local Users - List

Referencia

Service:: Storage Resource Provider

API Version:: 2023-01-01

Enumere los usuarios locales asociados a la cuenta de almacenamiento.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
accountName	path	True	string	Nombre de la cuenta de almacenamiento dentro del grupo de recursos especificado. Los nombres de cuentas de almacenamiento deben tener entre 3 y 24 caracteres, y usar solo números y letras minúsculas. Regex pattern: `^[a-z0-9]+$`
resourceGroupName	path	True	string	Nombre del grupo de recursos dentro de la suscripción del usuario. El nombre distingue mayúsculas de minúsculas. Regex pattern: `^[-\w\._]+$`
subscriptionId	path	True	string	Identificador de la suscripción de destino.
api-version	query	True	string	Versión de API que se usará para la operación.

Respuestas

Nombre	Tipo	Description
200 OK	LocalUsers	Aceptar: enumere correctamente los usuarios locales.
Other Status Codes	ErrorResponse	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

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

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

ListLocalUsers

Sample Request

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


/** Samples for LocalUsersOperation List. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-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",
            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-01-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/0baf811c3c76c87b3c127d098519bd97141222dd/specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/LocalUsersList.json
func ExampleLocalUsersClient_NewListPager() {
	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", 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{
		// 				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"),
		// 			},
		// 		},
		// 		{
		// 			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{
		// 				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"),
		// 			},
		// 	}},
		// }
	}
}

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-01-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

Sample Response

Status code:: 200

{
  "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
      }
    },
    {
      "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
      }
    }
  ]
}

Definiciones

Nombre	Description
createdByType	Tipo de identidad que creó el recurso.
ErrorResponse	Respuesta de error del proveedor de recursos de almacenamiento.
ErrorResponseBody	Contrato de cuerpo de respuesta de error.
LocalUser	Usuario local asociado a las cuentas de almacenamiento.
LocalUsers	Enumera los usuarios locales de la cuenta de almacenamiento.
PermissionScope
SshPublicKey
systemData	Metadatos relacionados con la creación y la última modificación del recurso.

createdByType

Tipo de identidad que creó el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorResponse

Respuesta de error del proveedor de recursos de almacenamiento.

Nombre	Tipo	Description
error	ErrorResponseBody	Cuerpo de respuesta de error del proveedor de recursos de Azure Storage.

ErrorResponseBody

Contrato de cuerpo de respuesta de error.

Nombre	Tipo	Description
code	string	Identificador del error. Los códigos son invariables y están diseñados para consumirse mediante programación.
message	string	Mensaje que describe el error, diseñado para ser adecuado para su presentación en una interfaz de usuario.

LocalUser

Usuario local asociado a las cuentas de almacenamiento.

Nombre	Tipo	Description
id	string	Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nombre del recurso.
properties.hasSharedKey	boolean	Indica si existe una clave compartida. Establézcalo en false para quitar la clave compartida existente.
properties.hasSshKey	boolean	Indica si existe una clave ssh. Establézcalo en false para quitar la clave SSH existente.
properties.hasSshPassword	boolean	Indica si existe una contraseña ssh. Establézcalo en false para quitar la contraseña SSH existente.
properties.homeDirectory	string	Opcional, directorio principal del usuario local.
properties.permissionScopes	PermissionScope[]	Ámbitos de permiso del usuario local.
properties.sid	string	Identificador de seguridad único generado por el servidor.
properties.sshAuthorizedKeys	SshPublicKey[]	Opcional, las claves autorizadas ssh de usuario local para SFTP.
systemData	systemData	Metadatos relacionados con la creación y la última modificación del recurso.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

LocalUsers

Enumera los usuarios locales de la cuenta de almacenamiento.

Nombre	Tipo	Description
value	LocalUser[]	Los usuarios locales asociados a la cuenta de almacenamiento.

PermissionScope

Nombre	Tipo	Description
permissions	string	Permisos para el usuario local. Entre los valores posibles se incluyen: Read (r), Write (w), Delete (d), List (l) y Create (c).
resourceName	string	Nombre del recurso, normalmente el nombre del contenedor o el nombre del recurso compartido de archivos, usado por el usuario local.
service	string	El servicio utilizado por el usuario local, por ejemplo, blob, archivo.

SshPublicKey

Nombre	Tipo	Description
description	string	Opcional. Se usa para almacenar la función o el uso de la clave.
key	string	Clave pública ssh codificada en base64. El formato debe ser : " , por ejemplo, ssh-rsa AAAABBBBBB

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre	Tipo	Description
createdAt	string	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

Share via

Local Users - List

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Scopes

Ejemplos

ListLocalUsers

Sample Request

Sample Response

Definiciones

createdByType

ErrorResponse

ErrorResponseBody

LocalUser

LocalUsers

PermissionScope

SshPublicKey

systemData

Recursos adicionales