Applies to: Exchange Server 2013
Topic Last Modified: 2012-07-06
Use the Update-HybridConfiguration cmdlet to define the credentials used for updating the hybrid configuration object.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Update-HybridConfiguration -OnPremisesCredentials
<PSCredential> -TenantCredentials <PSCredential>
[-Confirm [<SwitchParameter>]] [-DomainController
<Fqdn>] [-ForceUpgrade <SwitchParameter>] [-WhatIf
[<SwitchParameter>]]
|
Examples
EXAMPLE 1
This example defines the credentials used when updating the hybrid configuration object and connecting to the Microsoft Office 365 for enterprises tenant.
Use this command to specify your on-premises credentials. For example, run this command and then enter <domain>\admin@contoso.com and the associated account password in the credentials dialog box when prompted.
 Copy Code |
|
|---|---|
$OnPremisesCreds = Get-Credential |
|
Use this command to specify your Office 365 for enterprises tenant credentials. For example, run this command and then enter admin@contoso.onmicrosoft.com and the associated account password in the credentials dialog box when prompted.
| Copy Code |
|
|---|---|
$TenantCreds = Get-Credential |
|
Use this command to define the specified credentials that will be used when updating the hybrid configuration object and connecting to the Office 365 for enterprises tenant.
| Copy Code |
|
|---|---|
Update-HybridConfiguration -OnPremisesCredentials $OnPremisesCreds -TenantCredentials $TenantCreds |
|
Detailed Description
You can use the Update-HybridConfiguration cmdlet to designate the accounts and credentials that will be used when updating the hybrid configuration Active Directory object and connecting to the Microsoft Office 365 for enterprises 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 and Shell Infrastructure Permissions topic.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
OnPremisesCredentials |
Required |
System.Management.Automation.PSCredential |
The OnPremisesCredentials parameter specifies the on-premises Active Directory account and credentials that will be used to configure hybrid configuration features. This account must have the Organization Management management role group assigned. |
|
TenantCredentials |
Required |
System.Management.Automation.PSCredential |
The TenantCredentials parameter identifies the Office 365 for enterprises tenant organization account and credentials that will be used to configure hybrid configuration features. This is often the administrator account assigned when the Office 365 tenant was created. This account must have the Organization Management management role group assigned. |
|
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch. |
|
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory. |
|
ForceUpgrade |
Optional |
System.Management.Automation.SwitchParameter |
The ForceUpgrade parameter suppresses the prompt to confirm an upgrade of the HybridConfiguration Active Directory object. This confirmation prompt is only displayed when using the Update-HybridConfiguration cmdlet on a server running Microsoft Exchange Server 2013 and when the existing HybridConfiguration Active Directory object version is Exchange 2010. |
|
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.