Invoke-RASTenant
NAME
Invoke-RASTenant
SYNOPSIS
The cmdlet invokes a command on an object of type Tenant. Available commands: SendInvitation, GenerateHash
SYNTAX
Invoke-RASTenant [Id] (uint)** -Command {GenerateHash | SendInvitation} [EmailBody (string)] [EmailRecipients (string)] [(CommonParameters)]
Invoke-RASTenant [Name]** (string) -Command {GenerateHash | SendInvitation} [EmailBody (string)] [EmailRecipients (string)] [(CommonParameters)]
DESCRIPTION
The cmdlet invoke a command on an object of type Tenant. Available commands: SendInvitation, GenerateHash
PARAMETERS
Name (string)
Tenant name.
Id (uint)
Tenant ID.
Command (TenantCommand)
Tenant command.
Possible values: GenerateHash, SendInvitation
EmailRecipients (string)
Email recipients in a semicolon separated list, exclusive to the SendViaEmail command.
EmailBody (string)
The contents of the email, exclusive to the SendViaEmail command. Required variable: %INVITATIONHASH% Possible variables: %TENANTBROKER%
(CommonParameters)
INPUTS
-none-
OUTPUTS
-none-
EXAMPLES
---------- EXAMPLE 1 ----------
Invoke-RASTenant -Id 1 -Command SendInvitation -Email [email protected]
Sends the specified tenant's hash key within an tenant invitation email to the specified email address. ---------- EXAMPLE 2 ----------
Invoke-RASTenant -Id 1 -Command GenerateHash
Updates the specified tenant with a new tenant hash key.
RELATED LINKS
Last updated