Users - List By Lab

Referencia

Service:: Lab Services

API Version:: 2023-06-07

A tesztkörnyezet összes felhasználójának lekérése.
A tesztkörnyezet összes felhasználójának listáját adja vissza.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/users?api-version=2023-06-07

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/users?api-version=2023-06-07&$filter={$filter}

URI-paraméterek

Name	In	Kötelező	Típus	Description
labName	path	True	string	Annak a tesztkörnyezetnek a neve, amely egyedileg azonosítja azt a tesztkörnyezettervben. Erőforrás-URI-kban használatos.
resourceGroupName	path	True	string	Az erőforráscsoport neve. A név megkülönbözteti a kis- és nagybetűket.
subscriptionId	path	True	string	A cél-előfizetés azonosítója.
api-version	query	True	string	A művelethez használandó API-verzió.
$filter	query		string	A műveletre alkalmazandó szűrő.

Válaszok

Name	Típus	Description
200 OK	PagedUsers	A kérés sikeres volt; A válasz az adott tesztkörnyezet összes felhasználója.
Other Status Codes	ErrorResponse	Az alapértelmezett hibaválasz.

Példák

listUser

Sample Request

HTTP

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.LabServices/labs/testlab/users?api-version=2023-06-07

Sample Response

Status code:: 200

{
  "nextLink": null,
  "value": [
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.LabServices/labs/testlab/users/testuser",
      "name": "default",
      "type": "Microsoft.LabServices/User",
      "systemData": {
        "createdBy": "identity123",
        "createdByType": "User",
        "createdAt": "2020-05-01T10:00:00Z",
        "lastModifiedBy": "identity123",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2020-06-01T09:12:28Z"
      },
      "properties": {
        "provisioningState": "Succeeded",
        "displayName": "Test User",
        "email": "testuser@contoso.com",
        "registrationState": "Registered",
        "invitationState": "Sent",
        "totalUsage": "PT10H",
        "additionalUsageQuota": "PT10H"
      }
    }
  ]
}

Definíciók

Name	Description
createdByType	Az erőforrást létrehozó identitás típusa.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
InvitationState	A tesztkörnyezet felhasználómeghívójának állapota.
PagedUsers	A felhasználók lapozott listája.
ProvisioningState	A felhasználói erőforrás aktuális kiépítési állapota.
RegistrationState	A felhasználói tesztkörnyezet regisztrációs állapota.
ResourceOperationError	Az erőforrás legutóbbi művelethibájának hibaadatai
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
User	Egy tesztkörnyezet felhasználója, amely regisztrálhat és használhat virtuális gépeket a tesztkörnyezetben.

createdByType

Az erőforrást létrehozó identitás típusa.

Name	Típus	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

InvitationState

A tesztkörnyezet felhasználómeghívójának állapota.

Name	Típus	Description
Failed	string	Hiba történt a meghívó elküldése közben.
NotSent	string	A meghívó nem lett elküldve.
Sending	string	Jelenleg a meghívó elküldése folyamatban van.
Sent	string	A meghívó elküldése sikerült.

PagedUsers

A felhasználók lapozott listája.

Name	Típus	Description
nextLink	string	A képeredmények következő oldalának lekérésére szolgáló hivatkozás.
value	User[]	A felhasználói eredmények tömboldala.

ProvisioningState

A felhasználói erőforrás aktuális kiépítési állapota.

Name	Típus	Description
Creating	string	Az erőforrás létrehozása folyamatban van.
Deleting	string	Az erőforrás törlése folyamatban van.
Failed	string	Az erőforrás előző művelete sikertelen volt, és nem kifogástalan állapotban hagyta az erőforrást.
Locked	string	Az erőforrás zárolva van, és a módosítások jelenleg le vannak tiltva. Ennek oka lehet karbantartás vagy ütemezett művelet. Az állapot a zárolási művelet befejeződése után ismét sikeres lesz.
Succeeded	string	Az erőforrás kifogástalan állapotban van a létrehozási vagy frissítési művelet után.
Updating	string	Új tulajdonságértékek lesznek alkalmazva az erőforrásra.

RegistrationState

A felhasználói tesztkörnyezet regisztrációs állapota.

Name	Típus	Description
NotRegistered	string	A felhasználó regisztrálva van a tesztkörnyezetben.
Registered	string	A felhasználó még nem regisztrált a tesztkörnyezetben.

ResourceOperationError

Az erőforrás legutóbbi művelethibájának hibaadatai

Name	Típus	Description
action	string	A sikertelen művelet
code	string	A művelethiba típusának megfelelő kód
message	string	A művelet sikertelen üzenete
timestamp	string	A hiba bekövetkezésének dátuma

systemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az az identitás, amely legutóbb módosította az erőforrást.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.

User

Egy tesztkörnyezet felhasználója, amely regisztrálhat és használhat virtuális gépeket a tesztkörnyezetben.

Name	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Az erőforrás neve
properties.additionalUsageQuota	string	A felhasználó által a tesztkörnyezet használati kvótáján felüli használati kvóta mennyisége.
properties.displayName	string	A felhasználó megjelenítendő neve, például a felhasználó teljes neve.
properties.email	string	A felhasználó e-mail címe.
properties.invitationSent	string	A meghívóüzenet felhasználónak való elküldésének dátuma és időpontja.
properties.invitationState	InvitationState	A felhasználó meghívási üzenetének állapota.
properties.provisioningState	ProvisioningState	A felhasználói erőforrás aktuális kiépítési állapota.
properties.registrationState	RegistrationState	A felhasználó regisztrációjának állapota a tesztkörnyezetben.
properties.resourceOperationError	ResourceOperationError	A tesztkörnyezeti terv legutóbbi műveletének hibaadatai.
properties.totalUsage	string	Mennyi ideig használta a felhasználó a virtuális gépeit ebben a tesztkörnyezetben.
systemData	systemData	A felhasználói erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
type	string	Az erőforrás típusa. Például "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"