Local Users - Get

Služba:

Storage Resource Provider

Verze rozhraní API:

2024-01-01

Získejte místního uživatele účtu úložiště podle uživatelského jména.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
accountName	path	True	string minLength: 3 maxLength: 24 pattern: ^[a-z0-9]+$	Název účtu úložiště v zadané skupině prostředků. Názvy účtů úložiště musí mít délku 3 až 24 znaků a musí obsahovat jenom číslice a malá písmena.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+$	Název skupiny prostředků v rámci předplatného uživatele. Název nerozlišuje malá a velká písmena.
subscriptionId	path	True	string minLength: 1	ID cílového předplatného.
username	path	True	string minLength: 3 maxLength: 64	Jméno místního uživatele. Uživatelské jméno musí obsahovat jenom malá písmena a číslice. Musí být jedinečný jenom v rámci účtu úložiště.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	LocalUser	OK –- Úspěšně získejte vlastnosti místního uživatele.
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

GetLocalUser

Ukázkový požadavek

HTTP

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

Java

/**
 * Samples for LocalUsersOperation Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/storage/resource-manager/Microsoft.Storage/stable/2024-01-01/examples/LocalUserGet.json
     */
    /**
     * Sample code: GetLocalUser.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getLocalUser(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.storageAccounts().manager().serviceClient().getLocalUsersOperations().getWithResponse("res6977",
            "sto2527", "user1", 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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.storage import StorageManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-storage
# USAGE
    python local_user_get.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.get(
        resource_group_name="res6977",
        account_name="sto2527",
        username="user1",
    )
    print(response)


# x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2024-01-01/examples/LocalUserGet.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

Go

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/86c6306649b02e542117adb46c61e8019dbd78e9/specification/storage/resource-manager/Microsoft.Storage/stable/2024-01-01/examples/LocalUserGet.json
func ExampleLocalUsersClient_Get() {
	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)
	}
	res, err := clientFactory.NewLocalUsersClient().Get(ctx, "res6977", "sto2527", "user1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.LocalUser = 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),
	// 		},
	// 	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { StorageManagementClient } = require("@azure/arm-storage");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Get the local user of the storage account by username.
 *
 * @summary Get the local user of the storage account by username.
 * x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2024-01-01/examples/LocalUserGet.json
 */
async function getLocalUser() {
  const subscriptionId = process.env["STORAGE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["STORAGE_RESOURCE_GROUP"] || "res6977";
  const accountName = "sto2527";
  const username = "user1";
  const credential = new DefaultAzureCredential();
  const client = new StorageManagementClient(credential, subscriptionId);
  const result = await client.localUsersOperations.get(resourceGroupName, accountName, username);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

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/2024-01-01/examples/LocalUserGet.json
// this example is just showing the usage of "LocalUsers_Get" 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://learn.microsoft.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
string username = "user1";
NullableResponse<StorageAccountLocalUserResource> response = await collection.GetIfExistsAsync(username);
StorageAccountLocalUserResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // the variable result 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 = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Ukázková odpověď

Stavový kód:

200

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

Definice

Name	Description
createdByType	Typ identity, která prostředek vytvořila.
ErrorResponse	Odpověď na chybu od poskytovatele prostředků úložiště
ErrorResponseBody	Kontrakt textu odpovědi na chybu
LocalUser	Místní uživatel přidružený k účtům úložiště.
PermissionScope
SshPublicKey
systemData	Metadata týkající se vytvoření a poslední změny prostředku.

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
User
Application
ManagedIdentity
Key

ErrorResponse

Objekt

Odpověď na chybu od poskytovatele prostředků úložiště

Name	Typ	Description
error	ErrorResponseBody	Text odpovědi na chybu poskytovatele prostředků služby Azure Storage

ErrorResponseBody

Objekt

Kontrakt textu odpovědi na chybu

Name	Typ	Description
code	string	Identifikátor chyby. Kódy jsou invariantní a mají být využity programově.
message	string	Zpráva popisující chybu, která má být vhodná pro zobrazení v uživatelském rozhraní.

LocalUser

Objekt

Místní uživatel přidružený k účtům úložiště.

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Název prostředku
properties.allowAclAuthorization	boolean	Určuje, jestli je pro tohoto uživatele povolená autorizace seznamu ACL. Nastavte ho na false, aby se nepovolily použití autorizace seznamu ACL.
properties.extendedGroups	integer[] (int32)	Doplňkové členství ve skupině. Platí jenom pro místní uživatele, kteří mají povolený přístup k NFSv3.
properties.groupId	integer (int32)	Identifikátor pro přidružení skupiny uživatelů.
properties.hasSharedKey	boolean	Určuje, jestli existuje sdílený klíč. Pokud chcete odebrat existující sdílený klíč, nastavte ho na false.
properties.hasSshKey	boolean	Určuje, jestli existuje klíč SSH. Pokud chcete odebrat existující klíč SSH, nastavte ho na false.
properties.hasSshPassword	boolean	Určuje, jestli existuje heslo SSH. Pokud chcete odebrat stávající heslo SSH, nastavte ho na false.
properties.homeDirectory	string	Volitelné, místní domovský adresář uživatele.
properties.isNFSv3Enabled	boolean	Označuje, jestli má místní uživatel povolený přístup pomocí protokolu NFSv3.
properties.permissionScopes	PermissionScope[]	Obory oprávnění místního uživatele.
properties.sid	string	Jedinečný identifikátor zabezpečení vygenerovaný serverem.
properties.sshAuthorizedKeys	SshPublicKey[]	Volitelné, místní uživatelské ssh autorizované klíče pro SFTP.
properties.userId	integer (int32)	Jedinečný identifikátor vygenerovaný serverem.
systemData	systemData	Metadata týkající se vytvoření a poslední změny prostředku.
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

PermissionScope

Objekt

Name	Typ	Description
permissions	string	Oprávnění místního uživatele. Mezi možné hodnoty patří: Read (r), Write (w), Delete (d), List (l), Create (c), Modify Ownership (o) and Modify Permissions (p).
resourceName	string	Název prostředku, obvykle název kontejneru nebo název sdílené složky, který používá místní uživatel.
service	string	Služba používaná místním uživatelem, např. soubor objektu blob.

SshPublicKey

Objekt

Name	Typ	Description
description	string	Volitelný. Slouží k uložení funkce nebo použití klíče.
key	string	Kódovaný veřejný klíč SSH base64 Formát by měl být: ', např. ssh-rsa AAAABBBB

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.