Users - List By Lab

Reference

Služba:: Lab Services

Verze rozhraní API:: 2023-06-07

Získejte všechny uživatele pro testovací prostředí.
Vrátí seznam všech uživatelů pro testovací prostředí.

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

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
labName	path	True	string	Název testovacího prostředí, které ho jednoznačně identifikuje v rámci obsahujícího plán testovacího prostředí. Používá se v identifikátorech URI prostředků.
resourceGroupName	path	True	string	Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
subscriptionId	path	True	string	ID cílového předplatného.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.
$filter	query		string	Filtr, který se má použít na operaci.

Odpovědi

Name	Typ	Description
200 OK	PagedUsers	Požadavek byl úspěšný. Odpověď obsahuje všechny uživatele pro dané testovací prostředí.
Other Status Codes	ErrorResponse	Výchozí chybová odpověď.

Příklady

listUser

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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"
      }
    }
  ]
}

Definice

Name	Description
createdByType	Typ identity, která prostředek vytvořila.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě
ErrorResponse	Chybová odpověď
InvitationState	Stav pozvánky uživatele testovacího prostředí
PagedUsers	Stránkovaný seznam uživatelů.
ProvisioningState	Aktuální stav zřizování prostředku uživatele
RegistrationState	Stav registrace testovacího prostředí uživatele
ResourceOperationError	Podrobnosti o chybě posledního selhání operace u tohoto prostředku
systemData	Metadata týkající se vytvoření a poslední změny prostředku.
User	Uživatel testovacího prostředí, který se může zaregistrovat a používat virtuální počítače v rámci testovacího prostředí.

createdByType

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

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Typ další informace.

ErrorDetail

Podrobnosti o chybě

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva
target	string	Cíl chyby.

ErrorResponse

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

InvitationState

Stav pozvánky uživatele testovacího prostředí

Name	Typ	Description
Failed	string	Při odesílání pozvánky došlo k chybě.
NotSent	string	Pozvánka nebyla odeslána.
Sending	string	Aktuálně se odesílá pozvánka.
Sent	string	Pozvánka byla úspěšně odeslána.

PagedUsers

Stránkovaný seznam uživatelů.

Name	Typ	Description
nextLink	string	Odkaz pro získání další stránky výsledků obrázku
value	User[]	Stránka pole uživatelských výsledků.

ProvisioningState

Aktuální stav zřizování prostředku uživatele

Name	Typ	Description
Creating	string	Prostředek se právě vytváří.
Deleting	string	Prostředek se právě odstraňuje.
Failed	string	Předchozí operace s prostředkem selhala, takže prostředek není v pořádku.
Locked	string	Prostředek je uzamčený a změny jsou aktuálně blokované. Důvodem může být údržba nebo plánovaná operace. Jakmile se operace uzamčení dokončí, stav se vrátí zpět do úspěšného stavu.
Succeeded	string	Prostředek je po operaci vytvoření nebo aktualizace v pořádku.
Updating	string	Na prostředek se použijí nové hodnoty vlastností.

RegistrationState

Stav registrace testovacího prostředí uživatele

Name	Typ	Description
NotRegistered	string	Uživatel se zaregistroval v testovacím prostředí.
Registered	string	Uživatel se zatím do testovacího prostředí nezaregistroval.

ResourceOperationError

Podrobnosti o chybě posledního selhání operace u tohoto prostředku

Name	Typ	Description
action	string	Akce operace, která selhala
code	string	Kód odpovídající typu selhání operace
message	string	Zpráva o selhání operace
timestamp	string	Datum a čas, kdy došlo k chybě

systemData

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

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

User

Uživatel testovacího prostředí, který se může zaregistrovat a používat virtuální počítače v rámci testovacího prostředí.

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku Příklad : /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{resourceProviderNamespace}/{typ_prostředku}/{název_prostředku}
name	string	Název prostředku
properties.additionalUsageQuota	string	Doba kvóty využití, kterou uživatel získá kromě kvóty využití testovacího prostředí.
properties.displayName	string	Zobrazované jméno uživatele, například celé jméno uživatele.
properties.email	string	E-mailová adresa uživatele
properties.invitationSent	string	Datum a čas odeslání zprávy s pozvánkou uživateli
properties.invitationState	InvitationState	Stav zprávy pozvánky pro uživatele
properties.provisioningState	ProvisioningState	Aktuální stav zřizování prostředku uživatele
properties.registrationState	RegistrationState	Stav registrace uživatele v testovacím prostředí
properties.resourceOperationError	ResourceOperationError	Podrobnosti o chybě poslední operace provedené v plánu testovacího prostředí
properties.totalUsage	string	Jak dlouho uživatel v tomto cvičení používá své virtuální počítače.
systemData	systemData	Metadata týkající se vytvoření a poslední změny prostředku uživatele
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

Sdílet prostřednictvím