Set-RASTenant

NAME

Set-RASTenant

SYNOPSIS

Updates a Tenant.

SYNTAX

Set-RASTenant [-Id] <uint> [-ConnectByServerIP <bool>] [-Description <string>] [-Enabled <bool>] [-HideBillingInfo <bool>] [-NewName <string>] [-PublicAddresses <string>] [<CommonParameters>]

Set-RASTenant [[-Name] <string>] [-ConnectByServerIP <bool>] [-Description <string>] [-Enabled <bool>] [-HideBillingInfo <bool>] [-NewName <string>] [-PublicAddresses <string>] [<CommonParameters>]

DESCRIPTION

Updates a Tenant.

PARAMETERS

-Name <string> The Tenant name.

        Required?                    false

        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

-NewName <string> The new name of the Tenant (must be unique).

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Enabled <bool> Enable or disable the Tenant object in the Tenant Broker.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-PublicAddresses <string> The IP or DNS addresses of the Tenant Broker to join in a semicolon separated list.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ConnectByServerIP <bool> Clients in gateway mode connect to published tenant resources by server IP.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-HideBillingInfo <bool> When set, billing information is not provided in the Licensing category of the Tenant.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Description <string> An optional Tenant description.

        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 ----------

Set-RASTenant -Id 5 -NewName "Tenant 2"

Modifies the name of Tenant with Id 5 to "Tenant 2".

RELATED LINKS

• New-RASTenant

• Get-RASTenant

• Remove-RASTenant