Labs - List

Служба:: Education

Версия API:: 2021-12-01-preview

Получите сведения о конкретной лаборатории, связанной с указанным именем учетной записи выставления счетов, именем профиля выставления счетов и именем раздела счета.

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

С использованием необязательных параметров:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
billingAccountName	path	True	string	Идентификатор, который однозначно идентифицирует учетную запись выставления счетов.
billingProfileName	path	True	string	Идентификатор, который однозначно идентифицирует профиль выставления счетов.
invoiceSectionName	path	True	string	Идентификатор, который однозначно идентифицирует раздел счета.
api-version	query	True	string	Версия API для использования с клиентским запросом. Текущая версия : 2021-12-01-preview
includeBudget	query		boolean	Может использоваться для включения сведений о бюджете.

Ответы

Имя	Тип	Описание
200 OK	LabListResult	Сведения о лаборатории.
Other Status Codes	ErrorResponseBody	Описывает ошибку, если операция не выполнена успешно.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

LabListWithInvoiceSectionName

LabListWithInvoiceSectionNameIncludeBudget

LabListWithInvoiceSectionName

Образец запроса

HTTP

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

Пример ответа

Код состояния:: 200

{
  "value": [
    {
      "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
        }
      }
    }
  ]
}

LabListWithInvoiceSectionNameIncludeBudget

Образец запроса

HTTP

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

Пример ответа

Код состояния:: 200

{
  "value": [
    {
      "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
        }
      }
    }
  ]
}

Определения

Имя	Описание
Amount	Сумма.
createdByType	Тип удостоверения, создавшего ресурс.
ErrorResponse	Описывает формат ответа на ошибку.
ErrorResponseBody	Ответ на ошибку указывает, что служба не может обработать входящий запрос. Причина указана в сообщении об ошибке.
LabDetails	Сведения о лаборатории.
LabListResult	Список лабораторий.
LabStatus	Состояние этой лаборатории
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.

Amount

Object

Сумма.

Имя	Тип	Описание
currency	string	Тип валюты, используемой для значения.
value	number	Значение суммы.

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

ErrorResponse

Object

Описывает формат ответа на ошибку.

Имя	Тип	Описание
code	string	Код ошибки
message	string	Сообщение об ошибке, указывающее, почему операция завершилась ошибкой.

ErrorResponseBody

Object

Ответ на ошибку указывает, что служба не может обработать входящий запрос. Причина указана в сообщении об ошибке.

Имя	Тип	Описание
error	ErrorResponse	Сведения об ошибке.

LabDetails

Object

Сведения о лаборатории.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса для ресурса. Пример - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Имя ресурса
properties.budgetPerStudent	Amount	Денежное ограничение по умолчанию для каждого учащегося в этой лаборатории
properties.description	string	Подробное описание этой лаборатории
properties.displayName	string	Отображаемое имя лаборатории
properties.effectiveDate	string (date-time)	Дата создания лаборатории
properties.expirationDate	string (date-time)	Дата окончания срока действия по умолчанию для каждого учащегося в этой лаборатории
properties.invitationCode	string	код приглашения для активации лаборатории
properties.maxStudentCount	number	общее количество студентов, которые могут быть приняты в лабораторию.
properties.status	LabStatus	Состояние этой лаборатории
properties.totalAllocatedBudget.currency	string	Тип валюты, используемой для значения.
properties.totalAllocatedBudget.value	number	Значение суммы.
properties.totalBudget.currency	string	Тип валюты, используемой для значения.
properties.totalBudget.value	number	Значение суммы.
systemData	systemData	Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

LabListResult

Object

Список лабораторий.

Имя	Тип	Описание
nextLink	string	Ссылка (URL-адрес) на следующую страницу результатов.
value	LabDetails[]	Список лабораторий.

LabStatus

Перечисление

Состояние этой лаборатории

Значение	Описание
Active
Deleted
Pending

systemData

Object

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

Поделиться через

Labs - List

Параметры URI

Ответы

Безопасность

azure_auth

Области

Примеры

LabListWithInvoiceSectionName

Образец запроса

Пример ответа

LabListWithInvoiceSectionNameIncludeBudget

Образец запроса

Пример ответа

Определения

Amount

createdByType

ErrorResponse

ErrorResponseBody

LabDetails

LabListResult

LabStatus

systemData