Set-RASTenantBrokerSettings.md

NAME

Set-RASTenantBrokerSettings

SYNOPSIS

Updates the default Tenant Broker Settings.

SYNTAX

**Set-RASTenantBrokerSettings [AllowRegistrationWithSecretKey (bool)] [BrokerAddress (string)] [HideBillingInfo (bool)] [OverrideAddress (bool)] [SiteId (uint)] [TenantDomain (string)] [(CommonParameters)]

DESCRIPTION

Updates the default Tenant Broker Settings.

PARAMETERS

SiteId (uint)

Site ID for which to modify the Tenant Broker settings.

        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

BrokerAddress (string)

IP Address to be used when registering a tenant, when the OverrideAddress is set.

        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 Tenants joined with secret keys.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

OverrideAddress (bool)

Override Tenant Broker address in tenant invitations and secret keys.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

TenantDomain (string)

Public domain address used to register the tenants. If you want to register tenants as subdomains, specify the domain part of the host name. For example, to use "subdomain.domain.com" as a tenant hosts name, specify "domain.com".

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

AllowRegistrationWithSecretKey (bool)

Allow RAS Sites to register in Tenant Broker using a secret key.

        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-RASTenantBrokerSettings -OverrideAddress $true

Updates the Tenant Broker Settings to use the global broker address.

RELATED LINKS

• Get-RASTenantBrokerSettings

• Invoke-RASTenantBrokerSettings