Commands › Microsoft Teams

Set-CsTeamsIPPhonePolicy

Microsoft Teams MicrosoftTeams Set-*

Set-CsTeamsIPPhonePolicy enables you to modify the properties of an existing Teams phone policy settings.

Quick start script

# Set-CsTeamsIPPhonePolicy — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-MicrosoftTeams -CertificateThumbprint $thumb -ApplicationId $appId -TenantId $tenantId

# 2. Capture the current state first — you cannot roll back what you never recorded
$before = Get-CsTeamsIPPhonePolicy
$before | Format-List

# 3. Make the change (dry run first)
Set-CsTeamsIPPhonePolicy  -WhatIf
Set-CsTeamsIPPhonePolicy

# 4. Verify and diff
$after = Get-CsTeamsIPPhonePolicy
Compare-Object ($before | Out-String) ($after | Out-String)

Syntax

Set-CsTeamsIPPhonePolicy [[-Identity] <XdsIdentity>]
 [-AllowBetterTogether <String>]
 [-AllowHomeScreen <String>]
 [-AllowHotDesking <Boolean>]
 [-Confirm]
 [-Description <String>]
 [-Force]
 [-HotDeskingIdleTimeoutInMinutes <Int>]
 [-Instance <Object>]
 [-SearchOnCommonAreaPhoneMode <String>]
 [-SignInMode <String>]
 [-Tenant <Guid>]
 [-WhatIf]
 [<CommonParameters>]

Parameters (12)

ParameterTypeRequiredWhat it controls
-AllowBetterTogether String Determines whether Better Together mode is enabled, phones can lock and unlock in an integrated fashion when connected to their Windows PC running a 64-bit Teams desktop client. Possible values this parameter can take:
-AllowHomeScreen String Determines whether the Home Screen feature of the Teams IP Phones is enabled. Possible values this parameter can take:
-AllowHotDesking Boolean Determines if the hot desking feature is enabled or not. Set this to TRUE to enable. Set this to FALSE to disable hot desking mode.
-Confirm SwitchParameter Prompts you for confirmation before running the cmdlet.
-Description String Free form text that can be used by administrators as desired.
-Force SwitchParameter Suppresses any confirmation prompts that would otherwise be displayed before making changes and suppresses the display of any non-fatal error message that might arise when running the command.
-HotDeskingIdleTimeoutInMinutes Int Determines the idle timeout value in minutes for the signed in user account. When the timeout is reached, the account is logged out.
-Identity XdsIdentity The identity of the policy. To specify the global policy for the organization, use "global". To specify any other policy provide the name of that policy.
-SearchOnCommonAreaPhoneMode String Determines whether a user can look up contacts from the tenant's global address book when the phone is signed into the Common Area Phone Mode. Set this to ENABLED to enable the feature. Set this to DISABLED to...
-SignInMode String Determines the sign in mode for the device when signing in to Teams. Possible Values: - 'UserSignIn: Enables the individual user's Teams experience on the phone' - 'CommonAreaPhoneSignIn: Enables a Common Area Phone...
-Tenant Guid Internal Microsoft use only.
-WhatIf SwitchParameter Shows what would happen if the cmdlet runs. The cmdlet is not run.

Reference facts derived from Microsoft documentation, © Microsoft, licensed CC BY 4.0; restructured with original guidance by serv365.ai.