Any suggestions? Export (0) Print
Expand All

Set-FederatedOrganizationIdentifier

 

Applies to: Exchange Online, Exchange Server 2016

This cmdlet is available in on-premises Exchange Server 2016 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-FederatedOrganizationIdentifier cmdlet to configure the federated organization identifier for the Exchange organization.

For more details, see Federation.

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

Set-FederatedOrganizationIdentifier [-Identity <OrganizationIdParameter>] [-AccountNamespace <SmtpDomain>] [-Confirm [<SwitchParameter>]] [-DefaultDomain <SmtpDomain>] [-DelegationFederationTrust <FederationTrustIdParameter>] [-DomainController <Fqdn>] [-Enabled <$true | $false>] [-OrganizationContact <SmtpAddress>] [-WhatIf [<SwitchParameter>]]

This example configures a federated organization identifier for the Exchange organization.

Set-FederatedOrganizationIdentifier -DelegationFederationTrust "Microsoft Federation Gateway" -AccountNamespace "Contoso.com" -Enabled $true

This example temporarily disables federation for the Exchange organization.

Set-FederatedOrganizationIdentifier -Enabled $false

This example enables the organization identifier. This enables federation for the Exchange organization.

Set-FederatedOrganizationIdentifier -Enabled $true

You must configure a federated organization identifier to create an account namespace for your Exchange organization with the Microsoft Federation Gateway and enable federation for the purpose of sharing calendars or contacts, accessing free/busy information across Exchange organizations, and securing cross-premises email delivery using federated delivery. When you create a federation trust, a value for the AccountNamespace parameter is automatically created with the Microsoft Federation Gateway. The AccountNamespace parameter is a combination of a pre-defined string and the domain specified. For example, if you specify the federated domain contoso.com as the domain, "FYDIBOHF25SPDLT.contoso.com" is automatically created as the value for the AccountNamespace parameter. You can add and remove Additional domain names later by using the Add-FederatedDomain and Remove-FederatedDomain cmdlets.

You can temporarily disable federation by disabling the organization identifier.

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 infrastructure and PowerShell permissions topic.

 

Parameter Required Type Description

AccountNamespace

Optional

Microsoft.Exchange.Data.SmtpDomain

The AccountNamespace parameter specifies the federated domain to be used to establish the organization identifier with the Microsoft Federation Gateway.

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.

DefaultDomain

Optional

Microsoft.Exchange.Data.SmtpDomain

The DefaultDomain parameter specifies the federated domain used for delegation tokens issued by the Microsoft Federation Gateway for user accounts in the Exchange organization. If the DefaultDomain parameter isn't set, the primary SMTP domain for each user account is used in delegation tokens issued by the Microsoft Federation Gateway. Only a single domain or subdomain for the Exchange organization should be configured, and it applies to all delegation tokens issued for the Exchange organization, for example, contoso.com.

DelegationFederationTrust

Optional

Microsoft.Exchange.Configuration.Tasks.FederationTrustIdParameter

The DelegationFederationTrust parameter specifies the identity of the federation trust to be used by the organization identifier.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter is available only in on-premises Exchange 2016.

The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.

Enabled

Optional

System.Boolean

The Enabled parameter specifies whether the organization identifier is enabled. Valid values include $true or $false.

Setting the parameter to $false disables federation.

Identity

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter

The Identity parameter specifies the federated organization identifier.

OrganizationContact

Optional

Microsoft.Exchange.Data.SmtpAddress

The OrganizationContact parameter specifies the SMTP address of the federation contact.

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:
© 2016 Microsoft