Skip to content

Commit 5f20aad

Browse files
authored
Merge pull request MicrosoftDocs#8301 from JensTrier/OnlineAudioFile
Updated OnlineAudioFile PS cmdlet description
2 parents 4468c4d + 2d8710b commit 5f20aad

File tree

3 files changed

+225
-9
lines changed

3 files changed

+225
-9
lines changed
Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
---
2+
external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml
3+
online version: https://docs.microsoft.com/powershell/module/skype/get-csonlineaudiofile
4+
applicable: Microsoft Teams
5+
author: jenstrier
6+
ms.author: jenstr
7+
ms.reviewer:
8+
manager:
9+
schema: 2.0.0
10+
---
11+
12+
# Get-CsOnlineAudioFile
13+
14+
## SYNOPSIS
15+
Returns information about a specific or all uploaded audio files of a given application type.
16+
17+
> [!NOTE]
18+
> **Preview** The use of this cmdlet is in Public Preview.
19+
20+
## SYNTAX
21+
22+
```powershell
23+
Get-CsOnlineAudioFile [[-Identity] <string>] [-ApplicationId <OrgAutoAttendant | HuntGroup | TenantGlobal>] [<CommonParameters>]
24+
```
25+
26+
## DESCRIPTION
27+
This cmdlet returns information on a specific or all uploaded audio files of a given application type. If you are not specifying any parameters you will get information of all uploaded audio files with ApplicationId = TenantGlobal.
28+
29+
## EXAMPLES
30+
31+
### Example 1
32+
```powershell
33+
Get-CsOnlineAudioFile
34+
35+
```
36+
```Output
37+
Id : 85364afb59a143fc9466979e0f34f749
38+
FileName : CustomMoH.mp3
39+
ApplicationId : TenantGlobal
40+
MarkedForDeletion : False
41+
```
42+
This returns information about all uploaded audio files with ApplicationId = TenantGlobal.
43+
44+
### Example 2
45+
```powershell
46+
Get-CsOnlineAudioFile -ApplicationId HuntGroup -Identity dcfcc31daa9246f29d94d0a715ef877e
47+
48+
```
49+
```Output
50+
Id : dcfcc31daa9246f29d94d0a715ef877e
51+
FileName : SupportCQ.mp3
52+
ApplicationId : HuntGroup
53+
MarkedForDeletion : False
54+
```
55+
This cmdlet returns information about the audio file with Id dcfcc31daa9246f29d94d0a715ef877e and with ApplicationId = HuntGroup.
56+
57+
### Example 3
58+
```powershell
59+
Get-CsOnlineAudioFile -ApplicationId OrgAutoAttendant
60+
61+
```
62+
```Output
63+
Id : 58083ae8bc9e4a66a6b2810b2e1f4e4e
64+
FileName : MainAAAnnouncement.mp3
65+
ApplicationId : OrgAutoAttendant
66+
MarkedForDeletion : False
67+
```
68+
This cmdlet returns information about all uploaded audio files with ApplicationId = OrgAutoAttendant.
69+
70+
## PARAMETERS
71+
72+
### -ApplicationId
73+
The ApplicationId parameter specifies the identifier for the application that was specified when audio file was uploaded. For example, if the audio file is used with an auto attendant, then it should specified as "OrgAutoAttendant".
74+
If the audio file is used with a hunt group (call queue), then it needs to be specified as "HuntGroup". If the audio file is used for music on hold, the it needs to specified as "TenantGlobal".
75+
76+
If you are not specifying an ApplicationId it is assumed to be TenantGlobal.
77+
78+
Supported values:
79+
80+
- OrgAutoAttendant
81+
- HuntGroup
82+
- TenantGlobal
83+
84+
```yaml
85+
Type: System.string
86+
Parameter Sets: (All)
87+
Aliases:
88+
89+
Required: False
90+
Position: Named
91+
Default value: TenantGlobal
92+
Accept pipeline input: False
93+
Accept wildcard characters: False
94+
```
95+
96+
### -Identity
97+
The Id of the specific audio file that you would like to see information about. If you are only specifying -Identity, the -ApplicationId it is assumed to be TenantGlobal.
98+
99+
If you need to see the information of a specific audio file with ApplicationId of OrgAutoAttendant or HuntGroup, you need to specify -ApplicationId with the corresponding value and -Identity with the Id of the audio file.
100+
101+
102+
```yaml
103+
Type: System.String
104+
Parameter Sets: (All)
105+
Aliases:
106+
107+
Required: False
108+
Default value: None
109+
Accept pipeline input: False
110+
Accept wildcard characters: False
111+
```
112+
113+
114+
## INPUTS
115+
116+
### None
117+
118+
## OUTPUTS
119+
120+
### System.Object
121+
122+
## NOTES
123+
The cmdlet is available in Teams PS module 2.4.0-preview or later.
124+
125+
If you call the cmdlet without having uploaded any audio files, with a non-existing Identity or with an illegal ApplicationId, you will receive a generic error message. In addition, the ApplicationId is case sensitive.
126+
127+
## RELATED LINKS
128+
- [Import-CsOnlineAudioFile](Import-CsOnlineAudioFile.md)
129+
- [Remove-CsOnlineAudioFile](Remove-CsOnlineAudioFile.md)

skype/skype-ps/skype/Import-CsOnlineAudioFile.md

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml
33
online version: https://docs.microsoft.com/powershell/module/skype/import-csonlineaudiofile
4-
applicable: Skype for Business Online
4+
applicable: Microsoft Teams
55
title: Import-CsOnlineAudioFile
66
schema: 2.0.0
77
manager: bulenteg
8-
author: tomkau
9-
ms.author: tomkau
8+
author: jenstrier
9+
ms.author: jenstr
1010
ms.reviewer:
1111
---
1212

@@ -18,11 +18,13 @@ Use the Import-CsOnlineAudioFile cmdlet to upload a new audio file.
1818
## SYNTAX
1919

2020
```powershell
21-
Import-CsOnlineAudioFile -ApplicationId <OrgAutoAttendant | HuntGroup> -FileName <string> -Content <byte[]>
21+
Import-CsOnlineAudioFile -ApplicationId <OrgAutoAttendant | HuntGroup | TenantGlobal> -FileName <string> -Content <byte[]>
2222
```
2323

2424
## DESCRIPTION
25-
The Import-CsOnlineAudioFile cmdlet uploads a new audio file for use with the Auto Attendant (AA) or Call Queue (CQ) service.
25+
The Import-CsOnlineAudioFile cmdlet uploads a new audio file for use with the Auto Attendant (AA), Call Queue (CQ) service or Music on Hold for Microsoft Teams.
26+
27+
Please note that you can't export the audio file after import, you can only remove it.
2628

2729
## EXAMPLES
2830

@@ -42,22 +44,31 @@ $audioFile = Import-CsOnlineAudioFile -ApplicationId "HuntGroup" -FileName "MOH.
4244

4345
This example creates a new audio file using the WAV content that has a filename of MOH.wav to be used as a Music On Hold file with a Call Queue. The stored variable, $audioFile, will be used with [Set-CsCallQueue] (https://docs.microsoft.com/powershell/module/skype/set-cscallqueue) to provide the audio file id.
4446

47+
### -------------------------- Example 3 --------------------------
48+
```powershell
49+
$content = Get-Content "C:\Media\MOH.wav" -Encoding byte -ReadCount 0
50+
$audioFile = Import-CsOnlineAudioFile -ApplicationId TenantGlobal -FileName "MOH.wav" -Content $content
51+
```
52+
53+
This example creates a new audio file using the WAV content that has a filename of MOH.wav to be used as Music On Hold for Microsoft Teams. The stored variable, $audioFile, will be used with [New-CsTeamsCallHoldPolicy] (https://docs.microsoft.com/powershell/module/skype/new-csteamscallholdpolicy) to provide the audio file id.
54+
4555

4656
## PARAMETERS
4757

4858
### -ApplicationId
49-
The ApplicationId parameter is the identifier for the application which will use this audio file. For example, if the audio file will be used with an organizational auto attendant, then it needs to be set to "OrgAutoAttendant". If the audio file will be used with a hunt group (call queue), then it needs to be set to "HuntGroup".
59+
The ApplicationId parameter is the identifier for the application which will use this audio file. For example, if the audio file will be used with an organizational auto attendant, then it needs to be set to "OrgAutoAttendant". If the audio file will be used with a hunt group (call queue), then it needs to be set to "HuntGroup". If the audio file will be used with Microsoft Teams, then it needs to be set to "TenantGlobal"
5060

5161
Supported values:
5262

5363
- OrgAutoAttendant
5464
- HuntGroup
65+
- TenantGlobal
5566

5667
```yaml
5768
Type: System.string
5869
Parameter Sets: (All)
5970
Aliases:
60-
Applicable: Skype for Business Online
71+
Applicable: Microsoft Teams
6172

6273
Required: True
6374
Position: Named
@@ -73,7 +84,7 @@ The FileName parameter is the name of the audio file. For example, the file name
7384
Type: System.string
7485
Parameter Sets: (All)
7586
Aliases:
76-
Applicable: Skype for Business Online
87+
Applicable: Microsoft Teams
7788

7889
Required: True
7990
Position: Named
@@ -89,7 +100,7 @@ The Content parameter represents the content of the audio file. Supported format
89100
Type: System.Byte[]
90101
Parameter Sets: (All)
91102
Aliases:
92-
Applicable: Skype for Business Online
103+
Applicable: Microsoft Teams
93104

94105
Required: True
95106
Position: Named
@@ -110,5 +121,8 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl
110121
### Microsoft.Rtc.Management.Hosted.Online.Models.AudioFile
111122

112123
## NOTES
124+
You are responsible for independently clearing and securing all necessary rights and permissions to use any music or audio file with your Microsoft Teams service, which may include intellectual property and other rights in any music, sound effects, audio, brands, names, and other content in the audio file from all relevant rights holders, which may include artists, actors, performers, musicians, songwriters, composers, record labels, music publishers, unions, guilds, rights societies, collective management organizations and any other parties who own, control or license the music copyrights, sound effects, audio and other intellectual property rights.
113125

114126
## RELATED LINKS
127+
[Get-CsOnlineAudioFile](Get-CsOnlineAudioFile.md)
128+
[Remove-CsOnlineAudioFile](Remove-CsOnlineAudioFile.md)
Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
---
2+
external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml
3+
online version: https://docs.microsoft.com/powershell/module/skype/remove-csonlineaudiofile
4+
applicable: Microsoft Teams
5+
author: jenstrier
6+
ms.author: jenstr
7+
ms.reviewer:
8+
manager:
9+
schema: 2.0.0
10+
---
11+
12+
# Remove-CsOnlineAudioFile
13+
14+
## SYNOPSIS
15+
Marks an audio file of application type TenantGlobal for deletion and later removal (within 24 hours).
16+
17+
> [!NOTE]
18+
> **Preview** The use of this cmdlet is in Public Preview.
19+
20+
21+
## SYNTAX
22+
23+
```powershell
24+
Remove-CsOnlineAudioFile -Identity <string> [<CommonParameters>]
25+
26+
```
27+
28+
## DESCRIPTION
29+
This cmdlet marks an audio file of application type TenantGlobal for deletion and later removal.
30+
31+
## EXAMPLES
32+
33+
### Example 1
34+
```powershell
35+
Remove-CsOnlineAudioFile -Identity dcfcc31daa9246f29d94d0a715ef877e
36+
```
37+
This cmdlet marks the audio file with Id dcfcc31daa9246f29d94d0a715ef877e for deletion and later removal.
38+
39+
## PARAMETERS
40+
41+
### -Identity
42+
The Id of the specific audio file that you would like to mark for deletion.
43+
44+
```yaml
45+
Type: System.String
46+
Parameter Sets: (All)
47+
Aliases:
48+
49+
Required: True
50+
Default value: None
51+
Accept pipeline input: False
52+
Accept wildcard characters: False
53+
```
54+
55+
56+
## INPUTS
57+
58+
### None
59+
60+
## OUTPUTS
61+
62+
### System.Object
63+
64+
## NOTES
65+
Please note that using this cmdlet on other application types like OrgAutoAttendant and HuntGroup does not mark the audio file for deletion. These kinds of audio files will automatically be deleted, when
66+
67+
the corresponding Auto Attendant or Call Queue is deleted.
68+
69+
The cmdlet is available in Teams PS module 2.4.0-preview or later.
70+
71+
## RELATED LINKS
72+
- [Import-CsOnlineAudioFile](Import-CsOnlineAudioFile.md)
73+
- [Get-CsOnlineAudioFile](Get-CsOnlineAudioFile.md)

0 commit comments

Comments
 (0)