Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2

Topic Last Modified: 2012-11-19

Use the New-FederationTrust cmdlet to set up a federation trust between your Microsoft Exchange Server 2010 organization and the Microsoft Federation Gateway.

Syntax

New-FederationTrust -Name <String> -Thumbprint <String> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-MetadataUrl <Uri>] [-SuppressDnsWarning <SwitchParameter>] [-UseLegacyProvisioningService <SwitchParameter>] [-WhatIf [<SwitchParameter>]]
New-FederationTrust -Name <String> -ApplicationUri <String> -SkipNamespaceProviderProvisioning <SwitchParameter> -Thumbprint <String> [-AdministratorProvisioningId <String>] [-ApplicationIdentifier <String>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-MetadataUrl <Uri>] [-WhatIf [<SwitchParameter>]]

Detailed Description

Federation trusts are trusts created between a Microsoft Exchange 2010 organization and the Microsoft Federation Gateway. A federation trust is required to configure a federated organization identifier for federated delegation.

For more information, see Understanding Federation.

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 "Federation trusts" entry in the Exchange and Shell Infrastructure Permissions topic.

Parameters

Parameter Required Type Description

Name

Required

System.String

The Name parameter specifies a friendly name for the federation trust.

ApplicationUri

Required

System.String

The ApplicationUri parameter specifies the primary domain used for the federated organization identifier.

If you specify the ApplicationUri parameter, you must use the SkipNamespaceProviderProvisioning switch and also specify the AdministratorProvisioningId and ApplicationIdentifier parameters.

SkipNamespaceProviderProvisioning

Required

System.Management.Automation.SwitchParameter

The SkipNamespaceProviderProvisioning switch specifies that the trust and federated organization identifier are provisioned externally without using federation functionality in Exchange 2010.

If you use this switch, you must specify the ApplicationIdentifier, ApplicationUri, and AdministratorProvisioningId parameters.

Thumbprint

Required

System.String

The Thumbprint parameter specifies the thumbprint of a certificate issued by a public certification authority (CA) trusted by the Microsoft Federation Gateway. For more details, see Understanding Federation.

AdministratorProvisioningId

Optional

System.String

The AdministratorProvisioningId parameter specifies the provisioning key returned by the Microsoft Federation Gateway when an organization has already registered a SiteID or ApplicationID.

If you specify the AdministratorProvisioningId parameter, you must use the SkipNamespaceProviderProvisioning switch and also specify the ApplicationIdentifier and ApplicationUri parameters.

ApplicationIdentifier

Optional

System.String

The ApplicationIdentifier parameter specifies the SiteID or ApplicationID when an organization has already registered a SiteID or ApplicationID.

If you specify the ApplicationIdentifier parameter, you must use the SkipNamespaceProviderProvisioning switch and also specify the AdministratorProvisioningId and ApplicationUri parameters.

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.

MetadataUrl

Optional

System.Uri

The MetadataUrl parameter specifies the URL where WS-FederationMetadata is published by the Microsoft Federation Gateway.

SuppressDnsWarning

Optional

System.Management.Automation.SwitchParameter

The SuppressDNSWarning parameter specifies whether to display the DNS warning message for creating TXT records in your public DNS when running the New-FederationTrust cmdlet. Valid values are $true or $false. The default value is $false. However, this parameter is automatically set to $true when used by the Hybrid Configuration wizard. It’s not recommended that you use this parameter when using the New-FederationTrust cmdlet.

UseLegacyProvisioningService

Optional

System.Management.Automation.SwitchParameter

The UseLegacyProvisioningService parameter specifies if the legacy interface on the Microsoft Federation Gateway will be used for managing the federation trust, including federated domains, certificates, and federation metadata. Valid input for this parameter is $true or $false. The default value is $false. When using a self-signed certificate for configuring a federation trust with the Microsoft Federation Gateway, the trust needs to be created with the parameter set to $true. After the federation trust is created, this behavior can't be changed and requires the deletion and re-creation of the federation trust. We recommend you always use the default value of $false.

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.

Examples

EXAMPLE1

This example creates the federation trust Microsoft Federation Gateway with a certificate with the thumbprint AC00F35CBA8359953F4126E0984B5CCAFA2F4F17.

Copy Code
New-FederationTrust -Name "Microsoft Federation Gateway" -Thumbprint AC00F35CBA8359953F4126E0984B5CCAFA2F4F17