New-OnPremisesOrganization

 

Applies to: Exchange Online

This cmdlet is available only in the cloud-based service.

Use the New-OnPremisesOrganization cmdlet to create an OnPremisesOrganization object in a Microsoft Office 365 tenant.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-OnPremisesOrganization -HybridDomains <MultiValuedProperty> -InboundConnector <InboundConnectorIdParameter> -Name <String> -OrganizationGuid <Guid> -OutboundConnector <OutboundConnectorIdParameter> [-Confirm [<SwitchParameter>]] [-OrganizationName <String>] [-OrganizationRelationship <OrganizationRelationshipIdParameter>] [-WhatIf [<SwitchParameter>]]

This example creates the OnPremisesOrganization object ExchangeMail in an Office 365 tenant for the hybrid domains contoso.com and sales.contoso.com.

New-OnPremisesOrganization -Name "ExchangeMail" -OrganizationGuid "a1bc23cb-3456-bcde-abcd-feb363cacc88" -HybridDomains contoso.com, sales.contoso.com -InboundConnector "Inbound to ExchangeMail" -OutboundConnector "Outbound to ExchangeMail"

The OnPremisesOrganization object represents an on-premises Microsoft Exchange organization configured for hybrid deployment with an Office 365 tenant organization. It's used with the Hybrid Configuration wizard and is typically created automatically when the hybrid deployment is initially configured by the wizard. Manual modification of this object may result in hybrid deployment misconfiguration; therefore, we strongly recommend that you use the Hybrid Configuration wizard to update this object in the Office 365 tenant.

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Hybrid deployment configuration" entry in the Exchange infrastructure and PowerShell permissions topic.

 

Parameter Required Type Description

HybridDomains

Required

Microsoft.Exchange.Data.MultiValuedProperty

The HybridDomains parameter specifies the domains that are configured in the hybrid deployment between an Office 365 tenant and an on-premises Exchange organization. The domains specified in this parameter must match the domains listed in the HybridConfiguration object for the on-premises Exchange organization configured by the Hybrid Configuration wizard. Multiple domains may be listed and must be separated by a comma, for example, "contoso.com, sales.contoso.com".

InboundConnector

Required

Microsoft.Exchange.Configuration.Tasks.InboundConnectorIdParameter

The InboundConnector parameter specifies the name of the inbound connector configured on the Microsoft Exchange Online Protection (EOP) service for a hybrid deployment configured with an on-premises Exchange organization.

Name

Required

System.String

The Name parameter specifies a friendly name for the on-premises Exchange organization object in the Office 365 tenant.

OrganizationGuid

Required

System.Guid

The OrganizationGuid parameter specifies the globally unique identifier (GUID) of the on-premises Exchange organization object in the Office 365 tenant.

OutboundConnector

Required

Microsoft.Exchange.Configuration.Tasks.OutboundConnectorIdParameter

The OutboundConnector parameter specifies the name of the outbound connector configured on the EOP service for a hybrid deployment configured with an on-premises Exchange organization.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.

  • Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false.

  • Most other cmdlets (for example, New-* and Set-* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.

OrganizationName

Optional

System.String

The OrganizationName parameter specifies the Active Directory object name of the on-premises Exchange organization.

OrganizationRelationship

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationRelationshipIdParameter

The OrganizationRelationship parameter specifies the organization relationship configured by the Hybrid Configuration wizard on the Office 365 tenant as part of a hybrid deployment with an on-premises Exchange organization. This organization relationship defines the federated sharing features enabled on the Office 365 tenant.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.

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.

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.

 
Show: