Get-OnPremisesOrganization

Module:: Exchange PowerShell

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

Use the Get-OnPremisesOrganization cmdlet to retrieve settings for the OnPremisesOrganization object that is created for a hybrid deployment.

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

Syntax

Default (Default)

Get-OnPremisesOrganization
    [[-Identity] <OnPremisesOrganizationIdParameter>]
    [<CommonParameters>]

Description

The OnPremisesOrganization object represents an on-premises Exchange organization configured for hybrid deployment with a Microsoft 365 organization. It's used with the Hybrid Configuration wizard and is typically created automatically when the hybrid deployment is initially configured by the wizard. You can use the Get-OnPremisesOrganization cmdlet to view the properties of the OnPremisesOrganization object in the Microsoft 365 organization.

Manual modification of this object might result in hybrid deployment misconfiguration. We strongly recommend that you use the Hybrid Configuration wizard to modify this object in the Microsoft 365 organization.

You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't 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.

Examples

Example 1

Get-OnPremisesOrganization -Identity ExchangeMail | Format-List

This example retrieves the on-premises organization settings for ExchangeMail using the Identity parameter.

Example 2

Get-OnPremisesOrganization -DomainController 'mail.contoso.com' | Format-List

This example retrieves the on-premises organization settings by using the FQDN of the domain controller.

Parameters

-Identity

Applicable: Exchange Online, Exchange Online Protection

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

Canonical name
GUID
Name

Parameter properties

Type:	OnPremisesOrganizationIdParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	1
Mandatory:	False
Value from pipeline:	True
Value from pipeline by property name:	True
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

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.

Outputs

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