Edit

Share via

Get-OutboundConnector

Module:
Exchange PowerShell

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

Use the Get-OutboundConnector cmdlet to view the configuration information for an Outbound connector in your cloud-based organization.

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

Syntax

Default (Default) 

Get-OutboundConnector
    [[-Identity] <OutboundConnectorIdParameter>]
    [-IncludeTestModeConnectors <Boolean>]
    [-IsTransportRuleScoped <Boolean>]
    [-ResultSize <Unlimited>]
    [<CommonParameters>]

Description

Outbound connectors send email messages to remote domains that require specific configuration options.

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-OutboundConnector "Contoso Outbound Connector" | Format-List

This example displays detailed information about the Outbound connector named Contoso Outbound Connector.

Parameters

-Identity

Applicable: Exchange Online, Exchange Online Protection

The Identity parameter specifies the Outbound connector that you want to view. You can use any value that uniquely identifies the connector. For example:

  • Name
  • Distinguished name (DN)
  • GUID

Parameter properties

Type:OutboundConnectorIdParameter
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

-IncludeTestModeConnectors

Applicable: Exchange Online, Exchange Online Protection

The IncludeTestModeConnectors parameter filters the results by Outbound connectors that are in test mode. Valid values are:

  • $true: Only Outbound connectors that are in test mode are returned in the results.
  • $false: All Outbound connectors that aren't in test mode are returned in the results. This value is the default.

You configure an Outbound connector in test mode by using the TestMode parameter on the New-OutboundConnector or Set-OutboundConnector cmdlets.

Parameter properties

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

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-IsTransportRuleScoped

Applicable: Exchange Online, Exchange Online Protection

The IsTransportRuleScoped parameter filters the results by Outbound connectors that are scoped to transport rules (also known as mail flow rules). Valid values are:

  • $true: Only Outbound connectors that are scoped to transport rules are returned in the results.
  • $false: All Outbound connectors that aren't scoped to transport rules are returned in the results. This value is the default.

You scope a transport rule to a specific Outbound connector by using the RouteMessageOutboundConnector parameter on the New-TransportRule or Set-TransportRule cmdlets.

Parameter properties

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

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResultSize

Applicable: Exchange Online, Exchange Online Protection

The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000.

Parameter properties

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

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
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.