Users - List By Lab

Referencia

Servicio:: Lab Services

Versión de la API:: 2023-06-07

Obtenga todos los usuarios de un laboratorio.
Devuelve una lista de todos los usuarios de un laboratorio.

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

Con parámetros opcionales:

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

Nombre	En	Requerido	Tipo	Description
labName	path	True	string	Nombre del laboratorio que lo identifica de forma única dentro del plan de laboratorio que lo contiene. Se usa en los URI de recursos.
resourceGroupName	path	True	string	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
subscriptionId	path	True	string	Identificador de la suscripción de destino.
api-version	query	True	string	Versión de API que se usará para la operación.
$filter	query		string	Filtro que se va a aplicar a la operación.

Respuestas

Nombre	Tipo	Description
200 OK	PagedUsers	La solicitud se realizó correctamente; la respuesta contiene todos los usuarios para el laboratorio determinado.
Other Status Codes	ErrorResponse	Respuesta de error predeterminada.

Ejemplos

listUser

Solicitud de ejemplo

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

Respuesta de muestra

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

Definiciones

Nombre	Description
createdByType	Tipo de identidad que creó el recurso.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
InvitationState	Estado de invitación del usuario del laboratorio.
PagedUsers	Lista paginada de usuarios.
ProvisioningState	Estado de aprovisionamiento actual del recurso de usuario.
RegistrationState	Estado de registro del laboratorio de usuario.
ResourceOperationError	Detalles del error de la operación más reciente en este recurso
systemData	Metadatos relacionados con la creación y la última modificación del recurso.
User	Usuario de un laboratorio que puede registrarse y usar máquinas virtuales dentro del laboratorio.

createdByType

Tipo de identidad que creó el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

InvitationState

Estado de invitación del usuario del laboratorio.

Nombre	Tipo	Description
Failed	string	Error al enviar la invitación.
NotSent	string	No se ha enviado la invitación.
Sending	string	Actualmente, envía la invitación.
Sent	string	La invitación se ha enviado correctamente.

PagedUsers

Lista paginada de usuarios.

Nombre	Tipo	Description
nextLink	string	Vínculo para obtener la página siguiente de los resultados de la imagen.
value	User[]	Página de matriz de resultados del usuario.

ProvisioningState

Estado de aprovisionamiento actual del recurso de usuario.

Nombre	Tipo	Description
Creating	string	El recurso está en proceso de creación.
Deleting	string	El recurso está en proceso de eliminación.
Failed	string	La operación anterior en el recurso no ha podido dejar el recurso en estado incorrecto.
Locked	string	El recurso está bloqueado y los cambios están bloqueados actualmente. Esto puede deberse al mantenimiento o a una operación programada. El estado volverá a realizarse correctamente una vez finalizada la operación de bloqueo.
Succeeded	string	El recurso está en buen estado después de la creación o la operación de actualización.
Updating	string	Se aplican nuevos valores de propiedad al recurso.

RegistrationState

Estado de registro del laboratorio de usuario.

Nombre	Tipo	Description
NotRegistered	string	El usuario se ha registrado en el laboratorio.
Registered	string	El usuario aún no se ha registrado en el laboratorio.

ResourceOperationError

Detalles del error de la operación más reciente en este recurso

Nombre	Tipo	Description
action	string	La acción de operación que produjo un error
code	string	Código que corresponde al tipo de error de operación.
message	string	Mensaje de error de operación
timestamp	string	Fecha y hora de cuando se produjo el error

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre	Tipo	Description
createdAt	string	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

User

Usuario de un laboratorio que puede registrarse y usar máquinas virtuales dentro del laboratorio.

Nombre	Tipo	Description
id	string	Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nombre del recurso.
properties.additionalUsageQuota	string	Cantidad de tiempo de cuota de uso que obtiene el usuario además de la cuota de uso del laboratorio.
properties.displayName	string	Nombre para mostrar del usuario, por ejemplo, el nombre completo del usuario.
properties.email	string	Dirección de correo electrónico del usuario.
properties.invitationSent	string	Fecha y hora en que se envió el mensaje de invitación al usuario.
properties.invitationState	InvitationState	Estado del mensaje de invitación para el usuario.
properties.provisioningState	ProvisioningState	Estado de aprovisionamiento actual del recurso de usuario.
properties.registrationState	RegistrationState	Estado del registro del usuario en el laboratorio.
properties.resourceOperationError	ResourceOperationError	Detalles del error de la última operación realizada en el plan de laboratorio.
properties.totalUsage	string	Cuánto tiempo ha usado el usuario sus máquinas virtuales en este laboratorio.
systemData	systemData	Metadatos relacionados con la creación y la última modificación del recurso de usuario.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

Compartir a través de