# 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](#Id)] _\<uint>_ -[Command](#Command) {GenerateHash | SendInvitation} \[-[EmailBody](#EmailBody) _\<string>_] \[-[EmailRecipients](#EmailRecipients) _\<string>_] \[_<_[_CommonParameters_](#CommonParameters)_>_]

**Invoke-RASTenant** \[-[Name](#Name)] _\<string>_ -[Command](#Command) {GenerateHash | SendInvitation} \[-[EmailBody](#EmailBody) _\<string>_] \[-[EmailRecipients](#EmailRecipients) _\<string>_] \[_<_[_CommonParameters_](#CommonParameters)_>_]

## DESCRIPTION

The cmdlet invoke a command on an object of type Tenant. Available commands: SendInvitation, GenerateHash

## PARAMETERS

-**Name \<string>**\
Tenant name.

```
        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
```

-**Id \<uint>**\
Tenant ID.

```
        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
```

-**Command <**[**TenantCommand**](../classes-and-enumerations/tenantcommand)**>**\
Tenant command.

Possible values: GenerateHash, SendInvitation

```
        Required?                    true

        Position?                    named

        Default value                GenerateHash

        Accept pipeline input?       false

        Accept wildcard characters?  false
```

-**EmailRecipients \<string>**\
Email recipients in a semicolon separated list, exclusive to the SendViaEmail command.

```
        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
```

-**EmailBody \<string>**\
The contents of the email, exclusive to the SendViaEmail command. Required variable: %INVITATIONHASH% Possible variables: %TENANTBROKER%

```
        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
```

\<CommonParameters>

```
        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see 

        about_CommonParameters documentation. 
```

## INPUTS

-none-

## OUTPUTS

-none-

## EXAMPLES

**---------- EXAMPLE 1 ----------**

Invoke-RASTenant -Id 1 -Command SendInvitation -Email username@email.com

Sends the specified tenant's hash key within an tenant invitation email to the specified email address.\
&#xNAN;**---------- EXAMPLE 2 ----------**

Invoke-RASTenant -Id 1 -Command GenerateHash

Updates the specified tenant with a new tenant hash key.

## RELATED LINKS

* [New-RASTenant](new-rastenant)
* [Get-RASTenant](get-rastenant)
* [Set-RASTenant](set-rastenant)
* [Remove-RASTenant](remove-rastenant)
