Get-CsPinPolicy

Syntax

Get-CsPinPolicy
   [[-Identity] <XdsIdentity>]
   [-LocalStore]
   [-Tenant <Guid>]
   [<CommonParameters>]

Get-CsPinPolicy
   [-Filter <String>]
   [-LocalStore]
   [-Tenant <Guid>]
   [<CommonParameters>]

Description

Skype for Business Server enables users to connect to the system, or to join public switched telephone network (PSTN) conferences via telephone. Typically, logging on to the system or joining a conference requires the user to enter a user name or password; unfortunately, entering a user name and password can be a problem if you are using a phone that does not have an alphanumeric keypad. Because of that, Skype for Business Server enables you to supply users with numeric-only PINs; when prompted, users can then log on to the system or join a conference by entering the PIN instead of a user name and password.

Skype for Business Server uses PIN policies to manage PIN authentication properties; for example, you can specify the minimum length for a PIN and determine whether you will allow PINs that use "common patterns" such as consecutive digits (for example, a PIN like 123456). You can use the Get-CsPinPolicy cmdlet to retrieve information about the PIN policies currently configured for use in your organization.

Examples

-------------------------- Example 1 --------------------------

Get-CsPinPolicy

The command shown in Example 1 returns a collection of all the PIN policies configured for use in the organization. Calling the Get-CsPinPolicy cmdlet without any parameters always returns the complete set of PIN policies.

-------------------------- Example 2 --------------------------

Get-CsPinPolicy -Identity "site:Redmond"

Example 2 returns a single PIN policy: the policy with the Identity site:Redmond.

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

Get-CsPinPolicy -Filter "tag:*"

The command shown in Example 3 uses the Filter parameter to return all the policies that have been configured at the per-user scope. This is done by using the filter value "tag:*"; this value instructs the Get-CsPinPolicy cmdlet to return only those policies that have an Identity that begins with the characters "tag:".

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

Get-CsPinPolicy | Where-Object {$_.AllowCommonPatterns -eq $True}

Example 4 returns all the PIN policies where the AllowCommonPatterns property is True. In this example, the Get-CsPinPolicy cmdlet is first called without any additional parameters; that returns a collection of all the PIN policies configured for use in the organization. That collection is then passed to the Where-Object cmdlet, which picks out only those policies where the AllowCommonPatterns property is equal to True.

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

Get-CsPinPolicy | Where-Object {$_.PinLifetime -gt 30}

Like Example 4, the command shown in Example 5 uses the Where-Object cmdlet to return a subset of the existing PIN policies. In this case, the Where-Object cmdlet retrieves only those policies where the PinLifetime property is greater than 30. That means only policies that have PIN expiration times of more than 30 days will be returned.

Parameters

-Filter

-Identity

-LocalStore

-Tenant

Inputs

None

Outputs

Microsoft.Rtc.Management.WritableConfig.Policy.UserPin.UserPinPolicy

Related Links

• Grant-CsPinPolicy
• New-CsPinPolicy
• Remove-CsPinPolicy
• Set-CsPinPolicy