Edit

Share via


Get-CsExternalUserCommunicationPolicy

Returns information about one or more external user communication policies configured for your organization.

Syntax

Default (Default)

Get-CsExternalUserCommunicationPolicy
    [[-Identity] <XdsIdentity>]
    [-Filter <String>]
    [-LocalStore]
    [-Tenant <Guid>]
    [<CommonParameters>]

Description

This cmdlet retrieves external user communication policy information. External user communication policies are used to block P2P file transfer with Federated partners.

Examples

Example 1

PS C:\> Get-CsExternalUserCommunicationPolicy

This example displays all the external user communication policies that have been defined for an organization along with the settings for each.

Example 2

PS C:\> Get-CsExternalUserCommunicationPolicy -Identity BlockExternalP2PFileTransfer

This example uses the Identity parameter to retrieve the external user communication policy settings for the policy named BlockExternalP2PFileTransfer.

Example 3

PS C:\> Get-CsExternalUserCommunicationPolicy -Filter tag*

This example uses the Filter parameter to retrieve all the external user communication policies along with the settings for each. All per-user external user communication policies have an Identity in the format tag:<ExternalUserCommunicationPolicy>.

Example 4

PS C:\> Get-CsExternalUserCommunicationPolicy -Filter Block*

This example uses the Filter parameter to retrieve all the external user communication policies which their name begins with the string "Block" along with the configuration for each one.

Parameters

-Filter

Applicable: Skype for Business Online

This parameter accepts a wildcard string and returns all external user communication policies with identities matching that string. For example, a Filter value of tag:* will return all external user communication policies excluding Global policy.

Parameter properties

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

-Identity

Applicable: Skype for Business Online

Unique identifier for the external user communication policy to be created.

Parameter properties

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

Parameter sets

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

-LocalStore

Applicable: Skype for Business Online

This parameter is reserved for internal Microsoft use.

Parameter properties

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

-Tenant

Applicable: Skype for Business Online

Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example:

-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"

You can return your tenant ID by running this command:

Get-CsTenant | Select-Object DisplayName, TenantID

If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment.

Parameter properties

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

None

Outputs

System.Object