Get-CsExternalAccessPolicy

Syntax

Get-CsExternalAccessPolicy
   [-Tenant <Guid>]
   [-Include <PolicyFilter>]
   [-ApplicableTo <UserIdParameter>]
   [[-Identity] <XdsIdentity>]
   [-LocalStore]
   [<CommonParameters>]

Get-CsExternalAccessPolicy
   [-Tenant <Guid>]
   [-Include <PolicyFilter>]
   [-ApplicableTo <UserIdParameter>]
   [-Filter <String>]
   [-LocalStore]
   [<CommonParameters>]

Description

When you first configure Skype for Business Online your users are only allowed to exchange instant messages and presence information among themselves: by default, they can only communicate with other people who have SIP accounts in your Online organization or in your Active Directory Domain Services for on-premises deployments.

For on-premises deployments, users are not allowed to access Skype for Business Server over the Internet; instead, they must be logged on to your internal network before they will be able to log on to Skype for Business Server.

That might be sufficient to meet your communication needs. If it doesn't meet your needs, you can use external access policies to extend the ability of your users to communicate and collaborate. External access policies can grant (or revoke) the ability of your users to do any or all of the following:

1. Communicate with people who have SIP accounts with a federated organization. Note that enabling federation alone will not provide users with this capability. Instead, you must enable federation and then assign users an external access policy that gives them the right to communicate with federated users.

2. (Microsoft Teams only) Communicate with users who are using custom applications built with Azure Communication Services (ACS). This policy setting only applies if ACS federation has been enabled at the tenant level using the cmdlet Set-CsTeamsAcsFederationConfiguration.

3. Access Skype for Business Server over the Internet, without having to first log on to your internal network. This enables your users to use Skype for Business and log on to Skype for Business Server from an Internet café or other remote location.

4. Communicate with people who have SIP accounts with a public instant messaging service such as Skype.

The Get-CsExternalAccessPolicy cmdlet provides a way for you to return information about all of the external access policies that have been configured for use in your organization.

Examples

-------------------------- EXAMPLE 1 --------------------------

Get-CsExternalAccessPolicy

Example 1 returns a collection of all the external access policies configured for use in your organization. Calling the Get-CsExternalAccessPolicy cmdlet without any additional parameters always returns the complete collection of external access policies.

-------------------------- EXAMPLE 2 -------------------------- (Skype for Business Online)

Get-CsExternalAccessPolicy -Identity "tag:RedmondExternalAccessPolicy"

Example 2 uses the Identity parameter to return the external access policy that has the Identity tag:RedmondExternalAccessPolicy. Because access policy Identities must be unique, this command will never return more than one item.

-------------------------- EXAMPLE 2 -------------------------- (Skype for Business Server 2015)

Get-CsExternalAccessPolicy -Identity site:Redmond

Example 2 uses the Identity parameter to return the external access policy that has the Identity site:Redmond. Because access policy Identities must be unique, this command will never return more than one item.

-------------------------- Example 3 --------------------------

Get-CsExternalAccessPolicy -Filter tag:*

The command shown in Example 3 uses the Filter parameter to return all of the external access policies that have been configured at the per-user scope; the parameter value "tag:*" limits returned data to those policies that have an Identity that begins with the string value "tag:". By definition, any policy that has an Identity beginning with "tag:" is a policy that has been configured at the per-user scope.

-------------------------- Example 4 --------------------------

Get-CsExternalAccessPolicy | Where-Object {$_.EnableFederationAccess -eq $True}

In Example 4, the Get-CsExternalAccessPolicy cmdlet and the Where-Object cmdlet are used to return all the external access policies that grant users federation access. To do this, the Get-CsExternalAccessPolicy cmdlet is first used to return a collection of all the external access policies currently in use in the organization. This collection is then piped to the Where-Object cmdlet, which selects only those policies where the EnableFederationAccess property is equal to True.

-------------------------- Example 5 --------------------------

Get-CsExternalAccessPolicy | Where-Object {$_.EnableFederationAccess -eq $True -and $_.EnablePublicCloudAccess -eq $True}

The command shown in Example 5 returns the external access policies that meet two criteria: both federation access and public cloud access are allowed. In order to perform this task, the command first uses the Get-CsExternalAccessPolicy cmdlet to return a collection of all the access policies in use in the organization. That collection is then piped to the Where-Object cmdlet, which picks out only those policies that meet two criteria: the EnableFederationAccess property must be equal to True and the EnablePublicCloudAccess property must also be equal to True. Only policies in which both EnableFederationAccess and EnablePublicCloudAccess are True will be returned and displayed on the screen.

-------------------------- EXAMPLE 6 --------------------------

Get-CsExternalAccessPolicy -ApplicableTo "[email protected]"

In Example 6, the ApplicableTo parameter is used to return only the policies that can be assigned to the user "[email protected]".

NOTE: The ApplicableTo parameter can only be used with Skype for Business Online; that's because, with Skype for Business Online, there might be policies that cannot be assigned to certain users due to licensing and/or country/region restrictions.

NOTE: This command requires the Office 365 UsageLocation property to be configured for the user's Active Directory user account.

Parameters

-ApplicableTo

-Filter

-Identity

-Include

-LocalStore

-Tenant

Inputs

None

Outputs

Microsoft.Rtc.Management.WritableConfig.Policy.ExternalAccess.ExternalAccessPolicy

Related Links

• Grant-CsExternalAccessPolicy
• New-CsExternalAccessPolicy
• Remove-CsExternalAccessPolicy
• Set-CsExternalAccessPolicy