Users - List By Lab

Service:: Lab Services

Version d'API:: 2023-06-07

Obtenez tous les utilisateurs d’un laboratoire.
Retourne la liste de tous les utilisateurs d’un laboratoire.

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

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
labName	path	True	string minLength: 1 maxLength: 100	Nom du labo qui l’identifie de manière unique dans le plan de laboratoire contenant. Utilisé dans les URI de ressource.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string minLength: 1	ID de l’abonnement cible.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.
$filter	query		string	Filtre à appliquer à l’opération.

Réponses

Nom	Type	Description
200 OK	PagedUsers	La demande a réussi ; la réponse contient tous les utilisateurs du labo donné.
Other Status Codes	ErrorResponse	Réponse d’erreur par défaut.

Exemples

listUser

Exemple de requête

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

Exemple de réponse

Code d’état:: 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"
      }
    }
  ]
}

Définitions

Nom	Description
createdByType	Type d’identité qui a créé la ressource.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
InvitationState	État de l’invitation de l’utilisateur du labo.
PagedUsers	Liste paginée des utilisateurs.
ProvisioningState	État d’approvisionnement actuel de la ressource utilisateur.
RegistrationState	État d’inscription du labo de l’utilisateur.
ResourceOperationError	Détails de l’erreur de la dernière défaillance de l’opération sur cette ressource
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
User	Utilisateur d’un labo qui peut s’inscrire et utiliser des machines virtuelles dans le labo.

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Object

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

InvitationState

Énumération

État de l’invitation de l’utilisateur du labo.

Valeur	Description
NotSent	L’invitation n’a pas été envoyée.
Sending	En cours d’envoi de l’invitation.
Sent	L’invitation a été envoyée avec succès.
Failed	Une erreur s’est produite lors de l’envoi de l’invitation.

PagedUsers

Object

Liste paginée des utilisateurs.

Nom	Type	Description
nextLink	string	Lien pour obtenir la page suivante des résultats de l’image.
value	User[]	Page de tableau des résultats de l’utilisateur.

ProvisioningState

Énumération

État d’approvisionnement actuel de la ressource utilisateur.

Valeur	Description
Creating	La ressource est en cours de création.
Updating	Les nouvelles valeurs de propriété sont appliquées à la ressource.
Deleting	La ressource est en cours de suppression.
Succeeded	La ressource est en état sain après la création ou l’opération de mise à jour.
Failed	L’opération précédente sur la ressource a échoué en laissant la ressource dans un état non sain.
Locked	La ressource est verrouillée et les modifications sont actuellement bloquées. Cela peut être dû à la maintenance ou à une opération planifiée. L’état revient à réussir une fois l’opération de verrouillage terminée.

RegistrationState

Énumération

État d’inscription du labo de l’utilisateur.

Valeur	Description
NotRegistered	L’utilisateur s’est inscrit auprès du labo.
Registered	L’utilisateur n’a pas encore inscrit auprès du labo.

ResourceOperationError

Object

Détails de l’erreur de la dernière défaillance de l’opération sur cette ressource

Nom	Type	Description
action	string	Action d’opération ayant échoué
code	string	Code qui correspond au type d’échec de l’opération
message	string	Message d’échec de l’opération
timestamp	string (date-time)	Date et heure de la survenue de l’erreur

systemData

Object

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.

User

Object

Utilisateur d’un labo qui peut s’inscrire et utiliser des machines virtuelles dans le labo.

Nom	Type	Description
id	string	ID de ressource complet pour la ressource. ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nom de la ressource
properties.additionalUsageQuota	string (duration)	Durée du quota d’utilisation que l’utilisateur obtient en plus du quota d’utilisation du labo.
properties.displayName	string	Nom complet de l’utilisateur, par exemple le nom complet de l’utilisateur.
properties.email	string minLength: 6 maxLength: 254	Email’adresse de l’utilisateur.
properties.invitationSent	string (date-time)	Date et heure à laquelle le message d’invitation a été envoyé à l’utilisateur.
properties.invitationState	InvitationState	État du message d’invitation pour l’utilisateur.
properties.provisioningState	ProvisioningState	État d’approvisionnement actuel de la ressource utilisateur.
properties.registrationState	RegistrationState	État de l’inscription de l’utilisateur dans le labo.
properties.resourceOperationError	ResourceOperationError	Détails de la dernière opération effectuée sur le plan lab.
properties.totalUsage	string (duration)	Durée pendant laquelle l’utilisateur a utilisé ses machines virtuelles dans ce labo.
systemData	systemData	Métadonnées relatives à la création et à la dernière modification de la ressource utilisateur.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

Partager via

Users - List By Lab

Paramètres URI

Réponses

Exemples

listUser

Exemple de requête

Exemple de réponse

Définitions

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

InvitationState

PagedUsers

ProvisioningState

RegistrationState

ResourceOperationError

systemData

User