Users - Update
Operation to update a lab user.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/users/{userName}?api-version=2023-06-07
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
lab
|
path | True |
string |
The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs. |
resource
|
path | True |
string |
The name of the resource group. The name is case insensitive. |
subscription
|
path | True |
string |
The ID of the target subscription. |
user
|
path | True |
string |
The name of the user that uniquely identifies it within containing lab. Used in resource URIs. Regex pattern: |
api-version
|
query | True |
string |
The API version to use for this operation. |
Request Body
Name | Type | Description |
---|---|---|
properties.additionalUsageQuota |
string |
The amount of usage quota time the user gets in addition to the lab usage quota. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
The user was updated successfully; response contains the lab user. |
|
202 Accepted |
The user was updated successfully and has a long running operation; response contains the lab user. |
|
Other Status Codes |
The default error response. |
Examples
patchUser
Sample Request
PATCH https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.LabServices/labs/testlab/users/testuser?api-version=2023-06-07
{
"properties": {
"additionalUsageQuota": "PT10H"
}
}
Sample Response
{
"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"
}
}
Location: https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.LabServices/operationresults/a64149d8-84cb-4566-ab8e-b4ee1a074174
{
"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": "Updating",
"displayName": "Test User",
"email": "testuser@contoso.com",
"registrationState": "Registered",
"invitationState": "Sent",
"totalUsage": "PT10H",
"additionalUsageQuota": "PT10H"
}
}
Definitions
Name | Description |
---|---|
created |
The type of identity that created the resource. |
Error |
The resource management error additional info. |
Error |
The error detail. |
Error |
Error response |
Invitation |
The lab user invitation state. |
Provisioning |
Current provisioning state of the user resource. |
Registration |
The user lab registration state. |
Resource |
Error details of the latest operation failure on this resource |
system |
Metadata pertaining to creation and last modification of the resource. |
User |
User of a lab that can register for and use virtual machines within the lab. |
User |
User of a lab that can register for and use virtual machines within the lab. Used for updates. |
createdByType
The type of identity that created the resource.
Name | Type | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
ErrorAdditionalInfo
The resource management error additional info.
Name | Type | Description |
---|---|---|
info |
object |
The additional info. |
type |
string |
The additional info type. |
ErrorDetail
The error detail.
Name | Type | Description |
---|---|---|
additionalInfo |
The error additional info. |
|
code |
string |
The error code. |
details |
The error details. |
|
message |
string |
The error message. |
target |
string |
The error target. |
ErrorResponse
Error response
Name | Type | Description |
---|---|---|
error |
The error object. |
InvitationState
The lab user invitation state.
Name | Type | Description |
---|---|---|
Failed |
string |
There was an error while sending the invitation. |
NotSent |
string |
The invitation has not been sent. |
Sending |
string |
Currently sending the invitation. |
Sent |
string |
The invitation has been successfully sent. |
ProvisioningState
Current provisioning state of the user resource.
Name | Type | Description |
---|---|---|
Creating |
string |
Resource is in the process of being created. |
Deleting |
string |
Resource is in the process of being deleted. |
Failed |
string |
Previous operation on the resource has failed leaving resource in unhealthy state. |
Locked |
string |
The resource is locked and changes are currently blocked. This could be due to maintenance or a scheduled operation. The state will go back to succeeded once the locking operation has finished. |
Succeeded |
string |
Resource is in healthy state after creation or update operation. |
Updating |
string |
New property values are being applied to the resource. |
RegistrationState
The user lab registration state.
Name | Type | Description |
---|---|---|
NotRegistered |
string |
User has registered with the lab. |
Registered |
string |
User has not yet registered with the lab. |
ResourceOperationError
Error details of the latest operation failure on this resource
Name | Type | Description |
---|---|---|
action |
string |
The operation action that failed |
code |
string |
The code that corresponds to the type of operation failure |
message |
string |
The operation failure message |
timestamp |
string |
The datetime of when the error occured |
systemData
Metadata pertaining to creation and last modification of the resource.
Name | Type | Description |
---|---|---|
createdAt |
string |
The timestamp of resource creation (UTC). |
createdBy |
string |
The identity that created the resource. |
createdByType |
The type of identity that created the resource. |
|
lastModifiedAt |
string |
The timestamp of resource last modification (UTC) |
lastModifiedBy |
string |
The identity that last modified the resource. |
lastModifiedByType |
The type of identity that last modified the resource. |
User
User of a lab that can register for and use virtual machines within the lab.
Name | Type | Description |
---|---|---|
id |
string |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
The name of the resource |
properties.additionalUsageQuota |
string |
The amount of usage quota time the user gets in addition to the lab usage quota. |
properties.displayName |
string |
Display name of the user, for example user's full name. |
properties.email |
string |
Email address of the user. |
properties.invitationSent |
string |
Date and time when the invitation message was sent to the user. |
properties.invitationState |
State of the invitation message for the user. |
|
properties.provisioningState |
Current provisioning state of the user resource. |
|
properties.registrationState |
State of the user's registration within the lab. |
|
properties.resourceOperationError |
Error details of last operation done on lab plan. |
|
properties.totalUsage |
string |
How long the user has used their virtual machines in this lab. |
systemData |
Metadata pertaining to creation and last modification of the user resource. |
|
type |
string |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
UserUpdate
User of a lab that can register for and use virtual machines within the lab. Used for updates.
Name | Type | Description |
---|---|---|
properties.additionalUsageQuota |
string |
The amount of usage quota time the user gets in addition to the lab usage quota. |