Set-OnPremisesOrganization

This cmdlet is available only in the cloud-based service. Use the Set-OnPremisesOrganization cmdlet to modify the parameters of the OnPremisesOrganization object on the Microsoft Office 365 tenant. For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx).

Syntax

Set-OnPremisesOrganization
   [-Identity] <OnPremisesOrganizationIdParameter>
   [-Comment <String>]
   [-Confirm]
   [-HybridDomains <MultiValuedProperty>]
   [-InboundConnector <InboundConnectorIdParameter>]
   [-OrganizationName <String>]
   [-OrganizationRelationship <OrganizationRelationshipIdParameter>]
   [-OutboundConnector <OutboundConnectorIdParameter>]
   [-WhatIf]
   [<CommonParameters>]

Description

The OnPremisesOrganization object represents an on-premises Exchange organization configured for hybrid deployment with an Office 365 tenant organization. It's used in conjunction with the Hybrid Configuration wizard and is typically only modified and updated 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 this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx).

Examples

-------------------------- Example 1 --------------------------

Set-OnPremisesOrganization -Identity "ExchangeMail" -HybridDomains contoso.com, sales.contoso.com, legal.contoso.com

This example adds a third domain legal.contoso.com to the ExchangeMail OnPremisesOrganization object on the Office 365 tenant, which already has the contoso.com and sales.contoso.com domains.

Required Parameters

-Identity

The Identity parameter specifies the identity of the on-premises organization object. You can use the following values:

  • Canonical name

  • GUID

  • Name

Type:OnPremisesOrganizationIdParameter
Position:1
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

Optional Parameters

-Comment

The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note".

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

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.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-HybridDomains

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 Active Directory 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".

Type:MultiValuedProperty
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InboundConnector

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.

Type:InboundConnectorIdParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-OrganizationName

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

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-OrganizationRelationship

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.

Type:OrganizationRelationshipIdParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-OutboundConnector

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.

Type:OutboundConnectorIdParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

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.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Inputs

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data.

Outputs

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data.