Skip to content

Commit 2e50297

Browse files
authored
Merge pull request #13253 from pavellatif/main
adding new cmdlets for Tenant Default Configuration on Telephone Numbers
2 parents 5953070 + b296d91 commit 2e50297

File tree

4 files changed

+396
-0
lines changed

4 files changed

+396
-0
lines changed
Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
---
2+
applicable: Microsoft Teams
3+
author: pavellatif
4+
external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml
5+
Locale: en-US
6+
manager: roykuntz
7+
Module Name: MicrosoftTeams
8+
ms.author: pavellatif
9+
ms.reviewer: pavellatif
10+
online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csphonenumbertenantconfiguration
11+
schema: 2.0.0
12+
title: Get-CsPhoneNumberTenantConfiguration
13+
---
14+
15+
# Get-CsPhoneNumberTenantConfiguration
16+
17+
## SYNOPSIS
18+
This cmdlet displays existing tenant level telephone number default configurations.
19+
20+
## SYNTAX
21+
22+
```
23+
Get-CsPhoneNumberTenantConfiguration [<CommonParameters>]
24+
```
25+
26+
## DESCRIPTION
27+
28+
This cmdlet displays existing tenant level telephone number default configurations.
29+
30+
## EXAMPLES
31+
32+
### Example 1
33+
```powershell
34+
PS C:\> Get-CsPhoneNumberTenantConfiguration
35+
```
36+
```output
37+
AssignmentEmailEnabled : True
38+
UnassignmentEmailEnabled : True
39+
AssignmentBlockedForever :
40+
AssignmentBlockedDays :
41+
AllowOnPremToOnlineMigration :
42+
TenantId : 407c17ae-8c41-431e-894a-38787c682f68
43+
```
44+
45+
This example that email notifications are enabled for any telephone number assignment and unassignment operations. End users will receive an email about the change unless configuration is overridden during assignment or unassignment operations.
46+
47+
### Example 2
48+
```powershell
49+
PS C:\> Get-CsPhoneNumberTenantConfiguration
50+
```
51+
```output
52+
AssignmentEmailEnabled : False
53+
UnassignmentEmailEnabled : False
54+
AssignmentBlockedForever : True
55+
AssignmentBlockedDays :
56+
AllowOnPremToOnlineMigration :
57+
TenantId : 407c17ae-8c41-431e-894a-38787c682f68
58+
```
59+
60+
This example displays that both email notifications and AssignmentBlockedForever is set by default. If a telephone number is unassigned, an email is sent to end user and the number is blocked from new assignment until the [block is manually removed](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csphonenumberassignmentblock?view=teams-ps).
61+
62+
63+
## PARAMETERS
64+
65+
### CommonParameters
66+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
67+
68+
## INPUTS
69+
70+
### None
71+
72+
## OUTPUTS
73+
74+
### AssignmentEmailEnabled
75+
76+
Boolean stating if email notifications would be sent for telephone number assignment operations.
77+
78+
### UnassignmentEmailEnabled
79+
80+
Boolean stating if email notifications would be sent for telephone number unassignment operations.
81+
82+
### AssignmentBlockedForever
83+
84+
Boolean stating if assignment is blocked indefinitely.
85+
86+
### AssignmentBlockedDays
87+
88+
The number of days that assignment is blocked.
89+
90+
### AllowOnPremToOnlineMigration
91+
92+
Boolean stating if migrating Direct Routing numbers from OnPremises to Online is supported.
93+
94+
## NOTES
95+
96+
## RELATED LINKS
97+
98+
- [Remove-CsPhoneNumberTenantConfiguration](Remove-CsPhoneNumberTenantConfiguration.md)
99+
- [Set-CsPhoneNumberTenantConfiguration](Set-CsPhoneNumberTenantConfiguration.md)

teams/teams-ps/MicrosoftTeams/MicrosoftTeams.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -263,6 +263,9 @@ This cmdlet retrieves policy assignments associated with a specific telephone nu
263263
### [Get-CsPhoneNumberTag](Get-CsPhoneNumberTag.md)
264264
This cmdlet allows the admin to get a list of existing tags for telephone numbers.
265265

266+
### [Get-CsPhoneNumberTenantConfiguration](Get-CsPhoneNumberTenantConfiguration.md)
267+
This cmdlet displays existing tenant level telephone number default configurations.
268+
266269
### [Get-CsPolicyPackage](Get-CsPolicyPackage.md)
267270
This cmdlet supports retrieving all the policy packages available on a tenant.
268271

@@ -1199,6 +1202,9 @@ This cmdlet allows the admin to remove an assignment block on a telephone number
11991202
### [Remove-CsPhoneNumberTag](Remove-CsPhoneNumberTag.md)
12001203
This cmdlet allows admin to remove a tag from phone number.
12011204

1205+
### [Remove-CsPhoneNumberTenantConfiguration](Remove-CsPhoneNumberTenantConfiguration.md)
1206+
This cmdlet allows the admins to remove a tenant default configuration that applies to all telephone numbers within the tenant.
1207+
12021208
### [Remove-CsTeamsRemoteLogCollectionDevice](Remove-CsTeamsRemoteLogCollectionDevice.md)
12031209
This cmdlet will remove/delete a device from the remote log collection configuration.
12041210

@@ -1514,6 +1520,9 @@ This cmdlet assigns a policy to a specific telephone number in Microsoft Teams.
15141520
### [Set-CsPhoneNumberTag](Set-CsPhoneNumberTag.md)
15151521
This cmdlet allows the admin to create and assign a tag to a phone number.
15161522

1523+
### [Set-CsPhoneNumberTenantConfiguration](Set-CsPhoneNumberTenantConfiguration.md)
1524+
This cmdlet allows the admins to set a tenant default configuration that applies to all telephone numbers within the tenant.
1525+
15171526
### [Set-CsTeamsRemoteLogCollectionDevice](Set-CsTeamsRemoteLogCollectionDevice.md)
15181527
This cmdlet allows the admin to create and edit a device requested for remote log collection.
15191528

Lines changed: 141 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
1+
---
2+
applicable: Microsoft Teams
3+
author: pavellatif
4+
external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml
5+
Locale: en-US
6+
manager: roykuntz
7+
Module Name: MicrosoftTeams
8+
ms.author: pavellatif
9+
ms.reviewer: pavellatif
10+
online version: https://learn.microsoft.com/powershell/module/microsoftteams/remove-csphonenumbertenantconfiguration
11+
schema: 2.0.0
12+
title: Remove-CsPhoneNumberTenantConfiguration
13+
---
14+
15+
# Remove-CsPhoneNumberTenantConfiguration
16+
17+
## SYNOPSIS
18+
This cmdlet allows the admins to remove a tenant default configuration that applies to all telephone numbers within the tenant.
19+
20+
## SYNTAX
21+
22+
```
23+
Remove-CsPhoneNumberTenantConfiguration [-AssignmentEmailEnabled] [-UnassignmentEmailEnabled] [-AssignmentBlockedForever] [-AssignmentBlockedDays] [-AllowOnPremToOnlineMigration]
24+
[<CommonParameters>]
25+
```
26+
27+
## DESCRIPTION
28+
29+
This cmdlet allows the teams phone administrators to remove a tenant default configuration that applies to all the telephone numbers within the tenant.
30+
31+
## EXAMPLES
32+
33+
### Example 1
34+
```powershell
35+
PS C:\> Remove-CsPhoneNumberTenantConfiguration -AssignmentEmailEnabled -UnassignmentEmailEnabled
36+
```
37+
38+
The above example shows how to remove email notification configuration setting for all the telephone number assignment and unassignment operations within the tenant.
39+
40+
### Example 2
41+
```powershell
42+
PS C:\> Remove-CsPhoneNumberTenantConfiguration -AssignmentBlockedForever
43+
```
44+
45+
The above example shows how to remove the indefinite assignment block configuration for all the telephone numbers within the tenant.
46+
47+
48+
## PARAMETERS
49+
50+
### -AssignmentEmailEnabled
51+
Indicates the assignment email notification configuration will be removed.
52+
53+
```yaml
54+
Type: System.Management.Automation.SwitchParameter
55+
Parameter Sets: (All)
56+
Aliases:
57+
58+
Required: False
59+
Position: Named
60+
Default value: None
61+
Accept pipeline input: False
62+
Accept wildcard characters: False
63+
```
64+
65+
### -UnassignmentEmailEnabled
66+
Indicates the unassignment email notification configuration will be removed.
67+
68+
```yaml
69+
Type: System.Management.Automation.SwitchParameter
70+
Parameter Sets: (All)
71+
Aliases:
72+
73+
Required: False
74+
Position: Named
75+
Default value: None
76+
Accept pipeline input: False
77+
Accept wildcard characters: False
78+
```
79+
80+
### -AssignmentBlockedForever
81+
Indicates the assignment blocked forever configuration will be removed.
82+
83+
```yaml
84+
Type: System.Management.Automation.SwitchParameter
85+
Parameter Sets: (All)
86+
Aliases:
87+
88+
Required: False
89+
Position: Named
90+
Default value: None
91+
Accept pipeline input: False
92+
Accept wildcard characters: False
93+
```
94+
95+
### -AssignmentBlockedDays
96+
Indicates the assignment blocked days configuration will be removed.
97+
98+
```yaml
99+
Type: System.Management.Automation.SwitchParameter
100+
Parameter Sets: (All)
101+
Aliases:
102+
103+
Required: False
104+
Position: Named
105+
Default value: None
106+
Accept pipeline input: False
107+
Accept wildcard characters: False
108+
```
109+
110+
### -AllowOnPremToOnlineMigration
111+
Indicates the configuration will be removed for allowing OnPremises direct routing numbers to be automatically migrated to online direct routing numbers if an online operation is performed.
112+
113+
```yaml
114+
Type: System.Management.Automation.SwitchParameter
115+
Parameter Sets: (All)
116+
Aliases:
117+
118+
Required: False
119+
Position: Named
120+
Default value: None
121+
Accept pipeline input: False
122+
Accept wildcard characters: False
123+
```
124+
125+
### CommonParameters
126+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
127+
128+
## INPUTS
129+
130+
### None
131+
132+
## OUTPUTS
133+
134+
### None
135+
136+
## NOTES
137+
138+
## RELATED LINKS
139+
140+
- [Set-CsPhoneNumberTenantConfiguration](Set-CsPhoneNumberTenantConfiguration.md)
141+
- [Get-CsPhoneNumberTenantConfiguration](Get-CsPhoneNumberTenantConfiguration.md)

0 commit comments

Comments
 (0)