New-VcsUserInvitation
This cmdlet creates ? new user invitation on the VMware Cloud Services Platform. If no pending invitation is created, the user might be registered. You can check if the user is added successfully by using the Get-VcsUser cmdlet.
Syntax
-Email
<String[]>
-OrganizationRole <IVcsOrganizationRole[]>
[-Server <IVcsServer[]>]
[-ServiceRole <IVcsServiceRole[]>]
[CommonParameters]
-OrganizationRole <IVcsOrganizationRole[]>
[-Server <IVcsServer[]>]
[-ServiceRole <IVcsServiceRole[]>]
[CommonParameters]
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required |
|
String[] | named |
|
Specifies the emails of the users you want to invite. | required |
|
IVcsOrganizationRole[] | named |
|
Specifies the organization roles which you want to apply for the user. | optional |
|
IVcsServer[] | named |
|
Specifies the VMware Cloud Services Platform servers on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-Vcs cmdlet. | optional |
|
IVcsServiceRole[] | named |
|
Specifies the service roles that you want to apply for the user. |
Output
VMware.CloudServices.Types.V1.CmdletOutput.IVcsUserInvitation
Examples
Example 1
New-VcsUserInvitation -Email "email@mail.com" -OrganizationRole $organizationRoles -ServiceRole $serviceRoles
Creates a new user invitation for the user with an email "email@mail.com". Users organization roles are $organizationRoles. Users service roles are $serviceRoles.
Related Commands
VcsUser
This cmdlet retrieves users from the VMware Cloud Services Platform.
This cmdlet removes a user from the VMware Cloud Services Platform.
VcsUserInvitation
This cmdlet retrieves user invitations from the VMware Cloud Services Platform.
This cmdlet revokes a user invitation from the VMware Cloud Services Platform.
This cmdlet creates ? new user invitation on the VMware Cloud Services Platform.
