Students - List

Serviço:

Education

Versão da API:

2021-12-01-preview

Obtenha uma lista de detalhes sobre os alunos associados ao laboratório especificado.

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

Com parâmetros opcionais:

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
billingAccountName	path	True	string	O ID que identifica exclusivamente uma conta de cobrança.
billingProfileName	path	True	string	O ID que identifica exclusivamente um perfil de faturamento.
invoiceSectionName	path	True	string	O ID que identifica exclusivamente uma seção de fatura.
api-version	query	True	string	Versão da API a ser usada com a solicitação do cliente. A versão atual é 2021-12-01-preview
includeDeleted	query		boolean	Pode ser usado para mostrar itens excluídos.

Respostas

Name	Tipo	Description
200 OK	StudentListResult	Detalhes do aluno.
Other Status Codes	ErrorResponseBody	Descreve o erro se a operação não for bem-sucedida.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

StudentList

Pedido de amostra

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

Resposta da amostra

Código de estado:

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"
      }
    }
  ]
}

Definições

Name	Description
Amount	O montante.
createdByType	O tipo de identidade que criou o recurso.
ErrorResponse	Descreve o formato de Resposta de erro.
ErrorResponseBody	A resposta de erro indica que o serviço não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro.
Student Lab Status	Status do Laboratório do Aluno
Student role	Papel do aluno
StudentDetails	Detalhes do aluno.
StudentListResult	Lista de alunos.
systemData	Metadados referentes à criação e última modificação do recurso.

Amount

Object

O montante.

Name	Tipo	Description
currency	string	O tipo de moeda que está sendo usada para o valor.
value	number	Valor do montante.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorResponse

Object

Descreve o formato de Resposta de erro.

Name	Tipo	Description
code	string	Código de erro
message	string	Mensagem de erro indicando por que a operação falhou.

ErrorResponseBody

Object

A resposta de erro indica que o serviço não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro.

Name	Tipo	Description
error	ErrorResponse	Os detalhes do erro.

Student Lab Status

Enumeração

Status do Laboratório do Aluno

Valor	Description
Active
Disabled
Expired
Pending
Deleted

Student role

Enumeração

Papel do aluno

Valor	Description
Student
Admin

StudentDetails

Object

Detalhes do aluno.

Name	Tipo	Description
id	string	ID de recurso totalmente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties.budget	Amount	Orçamento Estudantil
properties.effectiveDate	string (date-time)	Data em que o aluno foi adicionado ao laboratório
properties.email	string	E-mail do aluno
properties.expirationDate	string (date-time)	Data em que este aluno está definido para expirar do laboratório.
properties.firstName	string	Nome Próprio
properties.lastName	string	Apelido
properties.role	Student role	Papel do aluno
properties.status	Student Lab Status	Status do Laboratório do Aluno
properties.subscriptionAlias	string	Alias de subscrição
properties.subscriptionId	string	ID da Subscrição
properties.subscriptionInviteLastSentDate	string (date-time)	data do último envio do convite de subscrição
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

StudentListResult

Object

Lista de alunos.

Name	Tipo	Description
nextLink	string	O link (url) para a próxima página de resultados.
value	StudentDetails[]	A lista de alunos.

systemData

Object

Metadados referentes à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.