Users - Invite

Service:

Lab Services

API Version:

2023-06-07

Operation to invite a user to a lab.

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

URI Parameters

Name	In	Required	Type	Description
labName	path	True	string	The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string	The ID of the target subscription.
userName	path	True	string	The name of the user that uniquely identifies it within containing lab. Used in resource URIs. Regex pattern: ^[-\w\\._\\(\\)]+$
api-version	query	True	string	The API version to use for this operation.

Request Body

Name	Type	Description
text	string	Custom text for the invite email.

Responses

Name	Type	Description
200 OK		The request was successful.
202 Accepted		The request was accepted.
Other Status Codes	ErrorResponse	The default error response.

Examples

inviteUser

Sample Request

HTTP

POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.LabServices/labs/testlab/users/testuser/invite?api-version=2023-06-07

{
  "text": "Invitation to lab testlab"
}

Sample Response

Status code:

200

Status code:

202

Location: https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.LabServices/operationresults/a64149d8-84cb-4566-ab8e-b4ee1a074174

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
InviteBody	Body for a user invite request

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	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

InviteBody

Body for a user invite request

Name	Type	Description
text	string	Custom text for the invite email.