Users - List By Lab

Référence

Service:: Lab Services

Version d'API:: 2023-06-07

Obtenir tous les utilisateurs d’un labo.
Retourne la liste de tous les utilisateurs d’un labo.

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	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	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string	ID de l’abonnement cible.
api-version	query	True	string	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 ; response contient tous les utilisateurs pour le 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 d’invitation de l’utilisateur lab.
PagedUsers	Liste paginée des utilisateurs.
ProvisioningState	État d’approvisionnement actuel de la ressource utilisateur.
RegistrationState	État d’inscription de l’utilisateur au labo.
ResourceOperationError	Détails de l’erreur de l’échec de la dernière 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

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

Nom	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

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

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

ErrorDetail

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

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet error.

InvitationState

État d’invitation de l’utilisateur lab.

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

PagedUsers

Liste paginée des utilisateurs.

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

ProvisioningState

État d’approvisionnement actuel de la ressource utilisateur.

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

RegistrationState

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

Nom	Type	Description
NotRegistered	string	L’utilisateur s’est inscrit auprès du laboratoire.
Registered	string	L’utilisateur ne s’est pas encore inscrit auprès du laboratoire.

ResourceOperationError

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

Nom	Type	Description
action	string	Action d’opération qui a échoué
code	string	Code qui correspond au type d’échec d’opération
message	string	Message d’échec de l’opération
timestamp	string	Dateheure de l’heure à laquelle l’erreur s’est produite

systemData

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

Nom	Type	Description
createdAt	string	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	Horodatage de la dernière modification de la 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

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	Durée du quota d’utilisation que l’utilisateur obtient en plus du quota d’utilisation du labo.
properties.displayName	string	Nom d’affichage de l’utilisateur, par exemple le nom complet de l’utilisateur.
properties.email	string	Adresse e-mail de l’utilisateur.
properties.invitationSent	string	Date et heure auxquelles 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 l’erreur de la dernière opération effectuée sur le plan lab.
properties.totalUsage	string	Durée pendant laquelle l’utilisateur utilise 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