Labs - Get

Service:: Education

Version d'API:: 2021-12-01-preview

Obtenez les détails d’un laboratoire spécifique associé au nom du compte de facturation fourni, au nom du profil de facturation et au nom de la section facture.

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default?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?includeBudget={includeBudget}&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
includeBudget	query		boolean	Peut être utilisé pour inclure des informations budgétaires.

Réponses

Nom	Type	Description
200 OK	LabDetails	Détails du labo.
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

Lab

LabIncludeBudget

Lab

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 200

{
  "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default",
  "name": "default",
  "type": "Microsoft.Education/Labs",
  "properties": {
    "displayName": "example lab",
    "budgetPerStudent": {
      "currency": "USD",
      "value": 100
    },
    "description": "example lab description",
    "expirationDate": "2021-12-09T21:25:56.838Z",
    "effectiveDate": "2021-11-09T21:25:56.838Z",
    "status": "Active",
    "maxStudentCount": 0,
    "invitationCode": ""
  }
}

LabIncludeBudget

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 200

{
  "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default",
  "name": "default",
  "type": "Microsoft.Education/Labs",
  "properties": {
    "displayName": "example lab",
    "budgetPerStudent": {
      "currency": "USD",
      "value": 100
    },
    "description": "example lab description",
    "expirationDate": "2021-12-09T21:25:56.838Z",
    "effectiveDate": "2021-11-09T21:25:56.838Z",
    "status": "Active",
    "totalBudget": {
      "currency": "USD",
      "value": 500
    },
    "totalAllocatedBudget": {
      "currency": "USD",
      "value": 500
    },
    "maxStudentCount": 0,
    "invitationCode": ""
  }
}

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.
LabDetails	Détails du labo.
LabStatus	État de ce labo
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.

LabDetails

Object

Détails du 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.budgetPerStudent	Amount	Limite monétaire par défaut pour chaque étudiant dans ce labo
properties.description	string	Description détaillée de ce labo
properties.displayName	string	Nom complet du laboratoire
properties.effectiveDate	string (date-time)	Date de création du labo
properties.expirationDate	string (date-time)	Date d’expiration par défaut pour chaque étudiant dans ce labo
properties.invitationCode	string	code d’invitation pour le labo utilisable
properties.maxStudentCount	number	le nombre total d’étudiants qui peuvent être acceptés dans le laboratoire.
properties.status	LabStatus	État de ce labo
properties.totalAllocatedBudget.currency	string	Type de devise utilisé pour la valeur.
properties.totalAllocatedBudget.value	number	Valeur de la quantité.
properties.totalBudget.currency	string	Type de devise utilisé pour la valeur.
properties.totalBudget.value	number	Valeur de la quantité.
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 »

LabStatus

Énumération

État de ce labo

Valeur	Description
Active
Deleted
Pending

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.

Partager via

Labs - Get

Paramètres URI

Réponses

Sécurité

azure_auth

Étendues

Exemples

Lab

Exemple de requête

Exemple de réponse

LabIncludeBudget

Exemple de requête

Exemple de réponse

Définitions

Amount

createdByType

ErrorResponse

ErrorResponseBody

LabDetails

LabStatus

systemData