Users - Get

Odwołanie

Service:: Dev Test Labs

API Version:: 2018-09-15

Pobierz profil użytkownika.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{name}?api-version=2018-09-15

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{name}?$expand={$expand}&api-version=2018-09-15

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
labName	path	True	string	Nazwa laboratorium.
name	path	True	string	Nazwa profilu użytkownika.
resourceGroupName	path	True	string	Nazwa grupy zasobów.
subscriptionId	path	True	string	Identyfikator subskrypcji.
api-version	query	True	string	Wersja interfejsu API klienta.
$expand	query		string	Określ zapytanie $expand. Przykład: "properties($select=identity)"

Odpowiedzi

Nazwa	Typ	Opis
200 OK	User	OK
Other Status Codes	CloudError	BadRequest

Zabezpieczenia

azure_auth

Udzielanie niejawne OAuth2

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

Scopes

Nazwa	Opis
user_impersonation	Uzyskiwanie dostępu do platformy Microsoft Azure

Przykłady

Users_Get

Sample Request

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{devtestlabName}/users/{userName}?api-version=2018-09-15

/** Samples for Users Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Users_Get.json
     */
    /**
     * Sample code: Users_Get.
     *
     * @param manager Entry point to DevTestLabsManager.
     */
    public static void usersGet(com.azure.resourcemanager.devtestlabs.DevTestLabsManager manager) {
        manager
            .users()
            .getWithResponse(
                "resourceGroupName", "{devtestlabName}", "{userName}", 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.devtestlabs import DevTestLabsClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-devtestlabs
# USAGE
    python users_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 = DevTestLabsClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscriptionId}",
    )

    response = client.users.get(
        resource_group_name="resourceGroupName",
        lab_name="{devtestlabName}",
        name="{userName}",
    )
    print(response)


# x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Users_Get.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 armdevtestlabs_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/devtestlabs/armdevtestlabs"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Users_Get.json
func ExampleUsersClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdevtestlabs.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewUsersClient().Get(ctx, "resourceGroupName", "{devtestlabName}", "{userName}", &armdevtestlabs.UsersClientGetOptions{Expand: 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.User = armdevtestlabs.User{
	// 	Name: to.Ptr("{userName}"),
	// 	Type: to.Ptr("Microsoft.DevTestLab/labs/users"),
	// 	ID: to.Ptr("/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}"),
	// 	Location: to.Ptr("{location}"),
	// 	Tags: map[string]*string{
	// 		"tagName1": to.Ptr("tagValue1"),
	// 	},
	// 	Properties: &armdevtestlabs.UserProperties{
	// 		CreatedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-10-02T01:40:48.173Z"); return t}()),
	// 		Identity: &armdevtestlabs.UserIdentity{
	// 			AppID: to.Ptr("{appId}"),
	// 			ObjectID: to.Ptr("{objectId}"),
	// 			PrincipalID: to.Ptr("{principalId}"),
	// 			PrincipalName: to.Ptr("{principalName}"),
	// 			TenantID: to.Ptr("{tenantId}"),
	// 		},
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		SecretStore: &armdevtestlabs.UserSecretStore{
	// 			KeyVaultID: to.Ptr("{keyVaultId}"),
	// 			KeyVaultURI: to.Ptr("{keyVaultUri}"),
	// 		},
	// 		UniqueIdentifier: to.Ptr("{uniqueIdentifier}"),
	// 	},
	// }
}

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

const { DevTestLabsClient } = require("@azure/arm-devtestlabs");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get user profile.
 *
 * @summary Get user profile.
 * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Users_Get.json
 */
async function usersGet() {
  const subscriptionId = "{subscriptionId}";
  const resourceGroupName = "resourceGroupName";
  const labName = "{devtestlabName}";
  const name = "{userName}";
  const credential = new DefaultAzureCredential();
  const client = new DevTestLabsClient(credential, subscriptionId);
  const result = await client.users.get(resourceGroupName, labName, name);
  console.log(result);
}

usersGet().catch(console.error);

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

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.DevTestLabs;
using Azure.ResourceManager.DevTestLabs.Models;

// Generated from example definition: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Users_Get.json
// this example is just showing the usage of "Users_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 DevTestLabUserResource created on azure
// for more information of creating DevTestLabUserResource, please refer to the document of DevTestLabUserResource
string subscriptionId = "{subscriptionId}";
string resourceGroupName = "resourceGroupName";
string labName = "{devtestlabName}";
string name = "{userName}";
ResourceIdentifier devTestLabUserResourceId = DevTestLabUserResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, labName, name);
DevTestLabUserResource devTestLabUser = client.GetDevTestLabUserResource(devTestLabUserResourceId);

// invoke the operation
DevTestLabUserResource result = await devTestLabUser.GetAsync();

// 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
DevTestLabUserData 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

Sample Response

Status code:: 200

{
  "properties": {
    "identity": {
      "principalName": "{principalName}",
      "principalId": "{principalId}",
      "tenantId": "{tenantId}",
      "objectId": "{objectId}",
      "appId": "{appId}"
    },
    "secretStore": {
      "keyVaultUri": "{keyVaultUri}",
      "keyVaultId": "{keyVaultId}"
    },
    "createdDate": "2018-10-01T18:40:48.1739018-07:00",
    "provisioningState": "Succeeded",
    "uniqueIdentifier": "{uniqueIdentifier}"
  },
  "id": "/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}",
  "name": "{userName}",
  "type": "Microsoft.DevTestLab/labs/users",
  "location": "{location}",
  "tags": {
    "tagName1": "tagValue1"
  }
}

Definicje

Nazwa	Opis
CloudError	Błąd żądania REST.
CloudErrorBody	Treść błędu z żądania REST.
User	Profil użytkownika laboratorium.
UserIdentity	Atrybuty tożsamości użytkownika laboratorium.
UserSecretStore	Właściwości magazynu wpisów tajnych użytkownika.

CloudError

Błąd żądania REST.

Nazwa	Typ	Opis
error	CloudErrorBody	Błąd chmury, który wystąpił

CloudErrorBody

Treść błędu z żądania REST.

Nazwa	Typ	Opis
code	string	Kod błędu.
details	CloudErrorBody[]	Błędy wewnętrzne.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

User

Profil użytkownika laboratorium.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
location	string	Lokalizacja zasobu.
name	string	Nazwa zasobu.
properties.createdDate	string	Data utworzenia profilu użytkownika.
properties.identity	UserIdentity	Tożsamość użytkownika.
properties.provisioningState	string	Stan aprowizacji zasobu.
properties.secretStore	UserSecretStore	Magazyn wpisów tajnych użytkownika.
properties.uniqueIdentifier	string	Unikatowy niezmienny identyfikator zasobu (Guid).
tags	object	Tagi zasobu.
type	string	Typ zasobu.

UserIdentity

Atrybuty tożsamości użytkownika laboratorium.

Nazwa	Typ	Opis
appId	string	Ustaw wartość identyfikatora aplikacji klienta JWT wysyłającego żądanie.
objectId	string	Ustaw wartość na identyfikator obiektu klienta JWT wysyłającego żądanie. Nie wszyscy użytkownicy mają identyfikator obiektu. Na przykład w scenariuszach dostawcy CSP (reseller) identyfikator obiektu jest niedostępny.
principalId	string	Ustaw wartość identyfikatora głównego klienta JWT wysyłającego żądanie. Jednostka usługi nie będzie miała identyfikatora podmiotu zabezpieczeń.
principalName	string	Ustaw nazwę główną /nazwę UPN klienta JWT wysyłającego żądanie.
tenantId	string	Ustaw wartość identyfikatora dzierżawy klienta JWT wysyłającego żądanie.

UserSecretStore

Właściwości magazynu wpisów tajnych użytkownika.

Nazwa	Typ	Opis
keyVaultId	string	Identyfikator magazynu kluczy użytkownika.
keyVaultUri	string	Identyfikator URI magazynu kluczy użytkownika.