Users - List By Lab

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 de URI

Nome	Em	Obrigató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. Usado em URIs de recurso.
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

Nome	Tipo	Description
200 OK	PagedUsers	A solicitação foi bem-sucedida; A resposta contém todos os usuários para o laboratório especificado.
Other Status Codes	ErrorResponse	A resposta de erro padrão.

Exemplos

listUser

Solicitação de exemplo

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 de exemplo

Código de status:: 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

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

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

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

ErrorDetail

Objeto

O detalhe do erro.

Nome	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

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

InvitationState

Enumeração

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

Valor	Description
NotSent	O convite não foi enviado.
Sending	No momento, envie o convite.
Sent	O convite foi enviado com êxito.
Failed	Erro ao enviar o convite.

PagedUsers

Objeto

Lista de usuários paginado.

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

ProvisioningState

Enumeração

Estado de provisionamento atual do recurso de usuário.

Valor	Description
Creating	O recurso está em processo de criação.
Updating	Novos valores de propriedade estão sendo aplicados ao recurso.
Deleting	O recurso está em processo de exclusão.
Succeeded	O recurso está em estado íntegro após a operação de criação ou atualização.
Failed	A operação anterior no recurso falhou ao deixar o recurso em estado não íntegro.
Locked	O recurso está bloqueado e as alterações estão bloqueadas no momento. Isso pode ser devido à manutenção ou a uma operação agendada. O estado voltará a ser bem-sucedido após a conclusão da operação de bloqueio.

RegistrationState

Enumeração

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

Valor	Description
NotRegistered	O usuário se registrou no laboratório.
Registered	O usuário ainda não se registrou no laboratório.

ResourceOperationError

Objeto

Detalhes do erro da falha de operação mais recente neste recurso

Nome	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)	O datetime de quando o erro ocorreu

systemData

Objeto

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

Nome	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

Objeto

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

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

Compartilhar via

Users - List By Lab

Parâmetros de URI

Respostas

Exemplos

listUser

Solicitação de exemplo

Resposta de exemplo

Definições

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

InvitationState

PagedUsers

ProvisioningState

RegistrationState

ResourceOperationError

systemData

User