Skip to content

Latest commit

 

History

History
165 lines (126 loc) · 5.98 KB

Set-PendingFederatedDomain.md

File metadata and controls

165 lines (126 loc) · 5.98 KB
Raw
external help file online version applicable title schema author ms.author ms.reviewer
Microsoft.Exchange.CalendarsAndGroups-Help.xml
Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
Set-PendingFederatedDomain
2.0.0
chrisda
chrisda

Set-PendingFederatedDomain

SYNOPSIS

This cmdlet is available only in on-premises Exchange.

The Set-PendingFederatedDomain cmdlet is used by the Exchange admin center to configure pending domains with the federated organization identifier in the federation trust for the Exchange organization. You shouldn't use this cmdlet to attempt to manually configure a federation trust.

The domains being added to the federation trust must exist as accepted domains in the Exchange organization.

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

SYNTAX

Set-PendingFederatedDomain [[-Identity] <OrganizationIdParameter>]
 [-Confirm]
 [-DomainController <Fqdn>]
 [-PendingAccountNamespace <SmtpDomain>]
 [-PendingDomains <SmtpDomain[]>]
 [-WhatIf]
 [<CommonParameters>]

DESCRIPTION

This cmdlet allows the Exchange admin center to save domains selected as the FederatedOrganizationIdentifier or federated domains when proof of domain ownership hasn't been completed.

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.

EXAMPLES

Example 1

Set-PendingFederatedDomain -PendingDomains contoso.com,sales.contoso.com

This example adds the pending domains contoso.com and sales.contoso.com to the existing federation trust.

PARAMETERS

-Identity

This parameter is reserved for internal Microsoft use.

Type: OrganizationIdParameter
Parameter Sets: (All)
Aliases:
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

Required: False
Position: 1
Default value: None
Accept pipeline input: True
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
Parameter Sets: (All)
Aliases: cf
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DomainController

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.

Type: Fqdn
Parameter Sets: (All)
Aliases:
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PendingAccountNamespace

The PendingAccountNamespace parameter specifies the pending domain that's used as the account namespace for the federation trust.

Type: SmtpDomain
Parameter Sets: (All)
Aliases:
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PendingDomains

The PendingDomains parameter specifies the pending federated domains that are configured for the federation trust.

Type: SmtpDomain[]
Parameter Sets: (All)
Aliases:
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

Required: False
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
Parameter Sets: (All)
Aliases: wi
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -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.

NOTES

RELATED LINKS