Students - List

Service:

Education

Version d'API:

2021-12-01-preview

Obtenez une liste de détails sur les étudiants associés au labo spécifié.

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default/students?api-version=2021-12-01-preview

Avec des paramètres facultatifs:

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default/students?includeDeleted={includeDeleted}&api-version=2021-12-01-preview

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
billingAccountName	path	True	string	ID qui identifie de façon unique un compte de facturation.
billingProfileName	path	True	string	ID qui identifie de façon unique un profil de facturation.
invoiceSectionName	path	True	string	ID qui identifie de façon unique une section de facture.
api-version	query	True	string	Version de l’API à utiliser avec la demande cliente. La version actuelle est 2021-12-01-preview
includeDeleted	query		boolean	Peut être utilisé pour afficher les éléments supprimés.

Réponses

Nom	Type	Description
200 OK	StudentListResult	Détails de l’étudiant.
Other Status Codes	ErrorResponseBody	Décrit l’erreur si l’opération n’a pas réussi.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

StudentList

Exemple de requête

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default/students?api-version=2021-12-01-preview

Exemple de réponse

Code d’état:

200

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default/students/{studentAlias}",
      "name": "{studentAlias}",
      "type": "Microsoft.Education/Students",
      "properties": {
        "firstName": "test",
        "lastName": "user",
        "email": "test@contoso.com",
        "role": "Student",
        "budget": {
          "currency": "USD",
          "value": 100
        },
        "subscriptionId": "000000000-0000-0000-0000-00000000000000",
        "expirationDate": "2022-11-09T21:43:54.161Z",
        "status": "Active",
        "effectiveDate": "2021-11-09T21:43:54.161Z",
        "subscriptionAlias": "000000000-0000-0000-0000-00000000000000",
        "subscriptionInviteLastSentDate": "2021-11-09T21:43:54.161Z"
      }
    }
  ]
}

Définitions

Nom	Description
Amount	Montant.
createdByType	Type d’identité qui a créé la ressource.
ErrorResponse	Décrit le format de la réponse d’erreur.
ErrorResponseBody	La réponse d’erreur indique que le service n’est pas en mesure de traiter la requête entrante. La raison est fournie dans le message d’erreur.
Student Lab Status	État du laboratoire étudiant
Student role	Rôle étudiant
StudentDetails	Détails de l’étudiant.
StudentListResult	Liste des étudiants.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

Amount

Object

Montant.

Nom	Type	Description
currency	string	Type de devise utilisé pour la valeur.
value	number	Valeur de la quantité.

createdByType

Énumération

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

Valeur	Description
User
Application
ManagedIdentity
Key

ErrorResponse

Object

Décrit le format de la réponse d’erreur.

Nom	Type	Description
code	string	Code d’erreur
message	string	Message d’erreur indiquant pourquoi l’opération a échoué.

ErrorResponseBody

Object

La réponse d’erreur indique que le service n’est pas en mesure de traiter la requête entrante. La raison est fournie dans le message d’erreur.

Nom	Type	Description
error	ErrorResponse	Détails de l’erreur.

Student Lab Status

Énumération

État du laboratoire étudiant

Valeur	Description
Active
Disabled
Expired
Pending
Deleted

Student role

Énumération

Rôle étudiant

Valeur	Description
Student
Admin

StudentDetails

Object

Détails de l’étudiant.

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.budget	Amount	Budget étudiant
properties.effectiveDate	string (date-time)	Date à laquelle l’étudiant a été ajouté au labo
properties.email	string	E-mail étudiant
properties.expirationDate	string (date-time)	Date à laquelle cet étudiant est défini pour expirer à partir du labo.
properties.firstName	string	Prénom
properties.lastName	string	Nom
properties.role	Student role	Rôle étudiant
properties.status	Student Lab Status	État du laboratoire étudiant
properties.subscriptionAlias	string	Alias d’abonnement
properties.subscriptionId	string	ID d’abonnement
properties.subscriptionInviteLastSentDate	string (date-time)	date de la dernière envoi de l’invitation d’abonnement
systemData	systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

StudentListResult

Object

Liste des étudiants.

Nom	Type	Description
nextLink	string	Lien (URL) vers la page suivante des résultats.
value	StudentDetails[]	Liste des étudiants.

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.