Users - List By Lab

Referência

Serviço:: Lab Services

Versão da API:: 2023-06-07

Obtenha todos os usuários para um laboratório.
Retorna uma lista de todos os usuários de um laboratório.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/users?api-version=2023-06-07

Com parâmetros opcionais:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/users?api-version=2023-06-07&$filter={$filter}

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
labName	path	True	string minLength: 1 maxLength: 100	O nome do laboratório que o identifica exclusivamente dentro do plano de laboratório que contém. Usado em URIs de recursos.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	A ID da assinatura de destino.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.
$filter	query		string	O filtro a ser aplicado à operação.

Respostas

Name	Tipo	Description
200 OK	PagedUsers	O pedido foi bem-sucedido; Contém todos os usuários para o laboratório fornecido.
Other Status Codes	ErrorResponse	A resposta de erro padrão.

Exemplos

listUser

Pedido de amostra

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

Resposta da amostra

Código de estado:: 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"
      }
    }
  ]
}

Definições

Name	Description
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
InvitationState	O estado de convite do usuário do laboratório.
PagedUsers	Lista paginada de usuários.
ProvisioningState	Estado de provisionamento atual do recurso do usuário.
RegistrationState	O estado de registro do laboratório do usuário.
ResourceOperationError	Detalhes de erro da última falha de operação neste recurso
systemData	Metadados referentes à criação e última modificação do recurso.
User	Usuário de um laboratório que pode se registrar e usar máquinas virtuais dentro do laboratório.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

InvitationState

Enumeração

O estado de convite do usuário do laboratório.

Valor	Description
Failed	Ocorreu um erro ao enviar o convite.
NotSent	O convite não foi enviado.
Sending	Atualmente enviando o convite.
Sent	O convite foi enviado com sucesso.

PagedUsers

Object

Lista paginada de usuários.

Name	Tipo	Description
nextLink	string	O link para obter a próxima página de resultados de imagem.
value	User[]	A página de matriz de resultados do usuário.

ProvisioningState

Enumeração

Estado de provisionamento atual do recurso do usuário.

Valor	Description
Creating	O recurso está em processo de criação.
Deleting	O recurso está em processo de exclusão.
Failed	A operação anterior no recurso falhou, deixando o recurso em estado não íntegro.
Locked	O recurso está bloqueado e as alterações estão bloqueadas no momento. Isto pode dever-se a uma manutenção ou a uma operação programada. O Estado voltará a ter sucesso assim que a operação de bloqueio terminar.
Succeeded	O recurso está em estado íntegro após a operação de criação ou atualização.
Updating	Novos valores de propriedade estão sendo aplicados ao recurso.

RegistrationState

Enumeração

O estado de registro do laboratório do usuário.

Valor	Description
NotRegistered	O utilizador registou-se no laboratório.
Registered	O usuário ainda não se cadastrou no laboratório.

ResourceOperationError

Object

Detalhes de erro da última falha de operação neste recurso

Name	Tipo	Description
action	string	A ação de operação que falhou
code	string	O código que corresponde ao tipo de falha de operação
message	string	A mensagem de falha da operação
timestamp	string (date-time)	A data/hora de quando o erro ocorreu

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.

User

Object

Usuário de um laboratório que pode se registrar e usar máquinas virtuais dentro do laboratório.

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.additionalUsageQuota	string (duration)	A quantidade de tempo de cota de uso que o usuário recebe, além da cota de uso do laboratório.
properties.displayName	string	Nome de exibição do usuário, por exemplo, o nome completo do usuário.
properties.email	string minLength: 6 maxLength: 254	Endereço de e-mail do usuário.
properties.invitationSent	string (date-time)	Data e hora em que a mensagem de convite foi enviada ao utilizador.
properties.invitationState	InvitationState	Estado da mensagem de convite para o usuário.
properties.provisioningState	ProvisioningState	Estado de provisionamento atual do recurso do usuário.
properties.registrationState	RegistrationState	Estado de registo do utilizador no laboratório.
properties.resourceOperationError	ResourceOperationError	Detalhes do erro da última operação feita no plano de laboratório.
properties.totalUsage	string (duration)	Há quanto tempo o usuário usa suas máquinas virtuais neste laboratório.
systemData	systemData	Metadados referentes à criação e última modificação do recurso do usuário.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

Partilhar via

Users - List By Lab

Parâmetros do URI

Respostas

Exemplos

listUser

Pedido de amostra

Resposta da amostra

Definições

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

InvitationState

PagedUsers

ProvisioningState

RegistrationState

ResourceOperationError

systemData

User

Recursos adicionais