[This topic is in progress.]

Applies to: Exchange Server 2010 SP2

Topic Last Modified: 2012-01-16

Use the New-Organization cmdlet to create a tenant organization.

Syntax

New-Organization -Name <String> -DomainName <SmtpDomain> -Location <String> -OfferId <String> -ProgramId <String> [-Administrator <WindowsLiveId>] [-AdministratorNetID <NetID>] [-AdministratorPassword <SecureString>] [-AuthenticationType <Managed | Federated>] [-Confirm [<SwitchParameter>]] [-CreateSharedConfiguration <SwitchParameter>] [-EnableFileLogging <SwitchParameter>] [-ExternalDirectoryOrganizationId <Guid>] [-HotmailMigration <SwitchParameter>] [-IsDatacenter <SwitchParameter>] [-IsDirSyncRunning <$true | $false>] [-IsPartnerHosted <SwitchParameter>] [-LiveIdInstanceType <Consumer | Business>] [-PartnerObjectId <Guid>] [-WhatIf [<SwitchParameter>]]

Detailed Description

You can create a tenant organization with or without a default tenant administrator.

To create a tenant administrator at the same time that you create a tenant organization, you need to use the AdministratorPassword parameter. If you specify this parameter, a default administrator will be created for the tenant organization. For example, if you're creating a tenant organization with the domain name humongousinsurance.com, an administrator will be created with the SMTP address administrator@humongousinsurance.com and with the password you specified.

This cmdlet is available only for multi-tenant deployments.

Parameters

Parameter Required Type Description

DomainName

Required

Microsoft.Exchange.Data.SmtpDomain

The DomainName parameter specifies the primary SMTP domain of the tenant organization, for example, Contoso.com.

Location

Required

System.String

The Location parameter specifies the location of the organization, such as Country.

Name

Required

System.String

The Name parameter specifies the name of the tenant organization.

OfferId

Required

System.String

The OfferId parameter specifies the OfferId that you provided in the ServicePlanHostingRemap.csv file.

ProgramId

Required

System.String

The ProgramId parameter specifies the ProgramId that you provided in the ServicePlanHostingRemap.csv file.

Administrator

Optional

Microsoft.Exchange.Data.WindowsLiveId

This parameter is reserved for internal Microsoft use.

AdministratorNetID

Optional

Microsoft.Exchange.Data.NetID

This parameter is reserved for internal Microsoft use.

AdministratorPassword

Optional

System.Security.SecureString

The AdministratorPassword parameter specifies the initial password that will be created for the tenant administrator.

AuthenticationType

Optional

Microsoft.Exchange.Data.Directory.AuthenticationType

This parameter is reserved for internal Microsoft use.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch can be used to suppress the confirmation prompt that appears by default when this cmdlet is run. To suppress the confirmation prompt, use the syntax -Confirm:$False. You must include a colon ( : ) in the syntax.

CreateSharedConfiguration

Optional

System.Management.Automation.SwitchParameter

This parameter is reserved for internal Microsoft use.

EnableFileLogging

Optional

System.Management.Automation.SwitchParameter

The EnableFileLogging parameter specifies that file logging is enabled when this command is run.

ExternalDirectoryOrganizationId

Optional

System.Guid

This parameter is reserved for internal Microsoft use.

HotmailMigration

Optional

System.Management.Automation.SwitchParameter

This parameter is reserved for internal Microsoft use.

IsDatacenter

Optional

System.Management.Automation.SwitchParameter

This parameter is reserved for internal Microsoft use.

IsDirSyncRunning

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

IsPartnerHosted

Optional

System.Management.Automation.SwitchParameter

This parameter is reserved for internal Microsoft use.

LiveIdInstanceType

Optional

Microsoft.Exchange.Data.Directory.LiveIdInstanceType

This parameter is reserved for internal Microsoft use.

PartnerObjectId

Optional

System.Guid

This parameter is reserved for internal Microsoft use.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch.

Input Types

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

Return Types

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.

Errors

Error Description

 

Examples

EXAMPLE 1

This example creates the tenant organization Contoso at Contoso.com.

Copy Code
New-Organization -Name "Contoso" -DomainName "Contoso.com" -Location "en-us" -ProgramId "Business" -OfferId "SmallOrg" 

EXAMPLE 2

This example creates the tenant organization Humongous Insurance at HumongousInsurance.com and creates an administrator with the password Pa$$word1. The AdministratorPassword parameter needs to be passed to the command as a secure string. Perform the following steps:

  1. Create the administrator password as a secure string and save it in the variable $Password.

    Copy Code
    $Password = Read-Host "Enter Password" -AsSecureString
    
  2. Type the password that you want the administrator to use, for example, Pa$$w0rd1, and then press Enter.

  3. Run the New-Organization command and pass the $Password variable via the AdmnistratorPassword parameter.

    Copy Code
    New-Organization -Name "Humongous Insurance" -DomainName "HumongousInsurance.com" -Location "en-us" -ProgramId "Business" -OfferId "LargeOrg" -AdministratorPassword $Password
    
    The tenant organization will be created with the default administrator, which will be administrator@HumongousInsurance.com.