Users - List By Lab

Referência

Service:: Lab Services

API Version:: 2023-06-07

Obtenha todos os utilizadores para um laboratório.
Devolve uma lista de todos os utilizadores de um laboratório.

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

With optional parameters:

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	O nome do laboratório que o identifica exclusivamente no plano de laboratório. Utilizado em URIs de recursos.
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
subscriptionId	path	True	string	O ID da subscrição de destino.
api-version	query	True	string	A versão da API a utilizar para esta operação.
$filter	query		string	O filtro a aplicar à operação.

Respostas

Name	Tipo	Description
200 OK	PagedUsers	O pedido foi bem-sucedido; A resposta contém todos os utilizadores para o laboratório especificado.
Other Status Codes	ErrorResponse	A resposta de erro predefinida.

Exemplos

listUser

Sample Request

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

Sample Response

Status code:: 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	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta a erros
InvitationState	O estado de convite do utilizador do laboratório.
PagedUsers	Lista paginada de utilizadores.
ProvisioningState	Estado de aprovisionamento atual do recurso do utilizador.
RegistrationState	O estado de registo do laboratório do utilizador.
ResourceOperationError	Detalhes do erro da falha da operação mais recente neste recurso
systemData	Metadados relativos à criação e última modificação do recurso.
User	Utilizador de um laboratório que pode registar-se e utilizar máquinas virtuais no laboratório.

createdByType

O tipo de identidade que criou o recurso.

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

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

ErrorDetail

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
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

Resposta a erros

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

InvitationState

O estado de convite do utilizador do laboratório.

Name	Tipo	Description
Failed	string	Ocorreu um erro ao enviar o convite.
NotSent	string	O convite não foi enviado.
Sending	string	Atualmente a enviar o convite.
Sent	string	O convite foi enviado com êxito.

PagedUsers

Lista paginada de utilizadores.

Name	Tipo	Description
nextLink	string	A ligação para obter a página seguinte dos resultados da imagem.
value	User[]	A página de matriz dos resultados do utilizador.

ProvisioningState

Estado de aprovisionamento atual do recurso do utilizador.

Name	Tipo	Description
Creating	string	O recurso está a ser criado.
Deleting	string	O recurso está a ser eliminado.
Failed	string	A operação anterior no recurso falhou ao deixar o recurso em mau estado de funcionamento.
Locked	string	O recurso está bloqueado e as alterações estão atualmente bloqueadas. Tal pode dever-se à manutenção ou a uma operação agendada. O estado voltará a ser bem-sucedido assim que a operação de bloqueio estiver concluída.
Succeeded	string	O recurso está em bom estado de funcionamento após a criação ou operação de atualização.
Updating	string	Estão a ser aplicados novos valores de propriedade ao recurso.

RegistrationState

O estado de registo do laboratório do utilizador.

Name	Tipo	Description
NotRegistered	string	O utilizador registou-se no laboratório.
Registered	string	O utilizador ainda não se registou no laboratório.

ResourceOperationError

Detalhes do erro da falha da operação mais recente 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	O datetime de quando ocorreu o erro

systemData

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

Name	Tipo	Description
createdAt	string	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	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

Utilizador de um laboratório que pode registar-se e utilizar máquinas virtuais no laboratório.

Name	Tipo	Description
id	string	ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties.additionalUsageQuota	string	A quantidade de tempo de quota de utilização que o utilizador obtém para além da quota de utilização do laboratório.
properties.displayName	string	Nome a apresentar do utilizador, por exemplo, o nome completo do utilizador.
properties.email	string	Endereço de e-mail do utilizador.
properties.invitationSent	string	Data e hora em que a mensagem de convite foi enviada ao utilizador.
properties.invitationState	InvitationState	Estado da mensagem de convite para o utilizador.
properties.provisioningState	ProvisioningState	Estado de aprovisionamento atual do recurso do utilizador.
properties.registrationState	RegistrationState	Estado do registo do utilizador no laboratório.
properties.resourceOperationError	ResourceOperationError	Detalhes do erro da última operação efetuada no plano de laboratório.
properties.totalUsage	string	Durante quanto tempo o utilizador utilizou as respetivas máquinas virtuais neste laboratório.
systemData	systemData	Metadados relativos à criação e última modificação do recurso de utilizador.
type	string	O tipo de recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"