Skip to content

Commit bef3211

Browse files
sfrancis206sfrancis206
authored
Merge pull request #12693 from pavellatif/main
Creating new cmdlets for telephone number tagging feature
2 parents fda3d0c + d99425b commit bef3211

File tree

4 files changed

+304
-0
lines changed

4 files changed

+304
-0
lines changed

‎teams/teams-ps/teams/Get-CsPhoneNumberTag.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml
3+
Module Name: Microsoft.Teams.ConfigAPI.Cmdlets
4+
online version: https://learn.microsoft.com/powershell/module/teams/get-csphonenumbertag
5+
applicable: Microsoft Teams
6+
title: Get-CsPhoneNumberTag
7+
author: pavellatif
8+
ms.author: pavellatif
9+
ms.reviewer: pavellatif
10+
manager: roykuntz
11+
schema: 2.0.0
12+
---
13+
14+
# Get-CsPhoneNumberTag
15+
16+
## SYNOPSIS
17+
This cmdlet allows the admin to get a list of existing tags for telephone numbers.
18+
19+
## SYNTAX
20+
21+
```
22+
Get-CsPhoneNumberTag [<CommonParameters>]
23+
```
24+
25+
## DESCRIPTION
26+
This cmdlet will get a list of all existing tags that are assigned to phone numbers in the tenant.
27+
28+
## EXAMPLES
29+
30+
### Example 1
31+
```powershell
32+
PS C:\> Get-CsPhoneNumberTag
33+
```
34+
```output
35+
TagValue
36+
HR
37+
Redmond HQ
38+
Executives
39+
```
40+
41+
This example shows how to get a list of existing tags for telephone numbers
42+
43+
## PARAMETERS
44+
45+
### CommonParameters
46+
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).
47+
48+
## INPUTS
49+
50+
### None
51+
52+
## OUTPUTS
53+
54+
### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ISkypeTelephoneNumberMgmtCmdletTenantTagRecord
55+
56+
## NOTES
57+
58+
## RELATED LINKS

‎teams/teams-ps/teams/Remove-CsPhoneNumberTag.md

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
---
2+
external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml
3+
Module Name: Microsoft.Teams.ConfigAPI.Cmdlets
4+
online version: https://learn.microsoft.com/powershell/module/teams/remove-csphonenumbertag
5+
applicable: Microsoft Teams
6+
title: Remove-CsPhoneNumberTag
7+
author: pavellatif
8+
ms.author: pavellatif
9+
ms.reviewer: pavellatif
10+
manager: roykuntz
11+
schema: 2.0.0
12+
---
13+
14+
# Remove-CsPhoneNumberTag
15+
16+
## SYNOPSIS
17+
This cmdlet allows admin to remove a tag from phone number.
18+
19+
## SYNTAX
20+
21+
```
22+
Remove-CsPhoneNumberTag -Tag <String> [-PhoneNumber <String>] [<CommonParameters>]
23+
```
24+
25+
## DESCRIPTION
26+
This cmdlet allows telephone number administrators to remove existing tags from any telephone numbers. This method does not delete the tag from the system if the tag is assigned to other telephone numbers.
27+
28+
## EXAMPLES
29+
30+
### Example 1
31+
```powershell
32+
PS C:\> Remove-CsPhoneNumberTag -PhoneNumber +123456789 -Tag "HR"
33+
```
34+
35+
This example shows how to remove the tag "HR" from telephone number +123456789.
36+
37+
## PARAMETERS
38+
39+
### -PhoneNumber
40+
Indicates the phone number for the the tag to be removed from
41+
42+
```yaml
43+
Type: String
44+
Parameter Sets: (All)
45+
Aliases:
46+
47+
Required: False
48+
Position: Named
49+
Default value: None
50+
Accept pipeline input: False
51+
Accept wildcard characters: False
52+
```
53+
54+
### -Tag
55+
Indicates the tag to be removed.
56+
57+
```yaml
58+
Type: String
59+
Parameter Sets: (All)
60+
Aliases:
61+
62+
Required: True
63+
Position: Named
64+
Default value: None
65+
Accept pipeline input: False
66+
Accept wildcard characters: False
67+
```
68+
69+
### CommonParameters
70+
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).
71+
72+
## INPUTS
73+
74+
### None
75+
76+
## OUTPUTS
77+
78+
### System.Boolean
79+
80+
## NOTES
81+
82+
## RELATED LINKS

‎teams/teams-ps/teams/Set-CsPhoneNumberTag.md

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
---
2+
external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml
3+
Module Name: Microsoft.Teams.ConfigAPI.Cmdlets
4+
online version: https://learn.microsoft.com/powershell/module/teams/set-csphonenumbertag
5+
applicable: Microsoft Teams
6+
title: Set-CsPhoneNumberTag
7+
author: pavellatif
8+
ms.author: pavellatif
9+
ms.reviewer: pavellatif
10+
manager: roykuntz
11+
schema: 2.0.0
12+
---
13+
14+
# Set-CsPhoneNumberTag
15+
16+
## SYNOPSIS
17+
This cmdlet allows the admin to create and assign a tag to a phone number.
18+
19+
## SYNTAX
20+
21+
```
22+
Set-CsPhoneNumberTag -PhoneNumber <String> -Tag <String> [<CommonParameters>]
23+
```
24+
25+
## DESCRIPTION
26+
This cmdlet allows telephone number administrators to create and assign tags to phone numbers. Tags can be up to 50 characters long, including spaces, and can contain multiple words. They are not case-sensitive. Each phone number can have up to 50 tags assigned. To improve readability, it is recommended to avoid assigning too many tags to a single phone number. If the desired tag already exist, the telephone number will get assigned the existing tag. If the tag is not already available, a new tag will be created. [Get-CsPhoneNumberTag](https://learn.microsoft.com/powershell/module/teams/get-csphonenumbertag) can be used to check a list of already existing tags. The tags can be used as a filter for [Get-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/get-csphonenumberassignment) to filter on certain list.
27+
28+
## EXAMPLES
29+
30+
### Example 1
31+
```powershell
32+
PS C:\> Set-CsPhoneNumberTag -PhoneNumber +123456789 -Tag "HR"
33+
```
34+
Above example shows how to set a "HR" tag to +123456789 number.
35+
36+
## PARAMETERS
37+
38+
### -PhoneNumber
39+
Indicates the phone number for the the tag to be assigned
40+
41+
```yaml
42+
Type: String
43+
Parameter Sets: (All)
44+
Aliases:
45+
46+
Required: True
47+
Position: Named
48+
Default value: None
49+
Accept pipeline input: False
50+
Accept wildcard characters: False
51+
```
52+
53+
### -Tag
54+
Indicates the tag to be assigned or created.
55+
56+
```yaml
57+
Type: String
58+
Parameter Sets: (All)
59+
Aliases:
60+
61+
Required: True
62+
Position: Named
63+
Default value: None
64+
Accept pipeline input: False
65+
Accept wildcard characters: False
66+
```
67+
68+
69+
### CommonParameters
70+
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).
71+
72+
## INPUTS
73+
74+
### None
75+
76+
## OUTPUTS
77+
78+
### System.Boolean
79+
80+
## NOTES
81+
82+
## RELATED LINKS

‎teams/teams-ps/teams/Update-CsPhoneNumberTag.md

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
---
2+
external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml
3+
Module Name: Microsoft.Teams.ConfigAPI.Cmdlets
4+
online version: https://learn.microsoft.com/powershell/module/teams/update-csphonenumbertag
5+
applicable: Microsoft Teams
6+
title: Update-CsPhoneNumberTag
7+
author: pavellatif
8+
ms.author: pavellatif
9+
ms.reviewer: pavellatif
10+
manager: roykuntz
11+
schema: 2.0.0
12+
---
13+
14+
# Update-CsPhoneNumberTag
15+
16+
## SYNOPSIS
17+
This cmdlet allows admin to update existing telephone number tags.
18+
19+
## SYNTAX
20+
21+
```
22+
Update-CsPhoneNumberTag -NewTag <String> -Tag <String> [<CommonParameters>]
23+
```
24+
25+
## DESCRIPTION
26+
This cmdlet can be used to update existing tags for telephone numbers. Tags can be up to 50 characters long, including spaces, and can contain multiple words. They are not case-sensitive. An admin can get a list of all existing tags using [Get-CsPhoneNumberTag](https://learn.microsoft.com/powershell/module/teams/get-csphonenumbertag).
27+
28+
## EXAMPLES
29+
30+
### Example 1
31+
```powershell
32+
PS C:\> Update-CsPhoneNumberTag -Tag "Redmond" -NewTag "Redmond HQ"
33+
```
34+
35+
This example shows how to update an existing tag "Redmond" to "Redmond HQ"
36+
37+
## PARAMETERS
38+
39+
### -NewTag
40+
This is the new tag. A tag can be maximum 50 characters long.
41+
42+
```yaml
43+
Type: String
44+
Parameter Sets: (All)
45+
Aliases:
46+
47+
Required: True
48+
Position: Named
49+
Default value: None
50+
Accept pipeline input: False
51+
Accept wildcard characters: False
52+
```
53+
54+
### -Tag
55+
This is the old tag which the admin wants to update.
56+
57+
```yaml
58+
Type: String
59+
Parameter Sets: (All)
60+
Aliases:
61+
62+
Required: True
63+
Position: Named
64+
Default value: None
65+
Accept pipeline input: False
66+
Accept wildcard characters: False
67+
```
68+
69+
### CommonParameters
70+
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).
71+
72+
## INPUTS
73+
74+
### None
75+
76+
## OUTPUTS
77+
78+
### System.Boolean
79+
80+
## NOTES
81+
82+
## RELATED LINKS

0 commit comments

Comments
 (0)