Skip to content

Commit 7bca9f8

Browse files
AmareshB1MicrosoftAmareshB1Microsoft
committed
Initial update to include documentation for remaining cmdlets
1 parent 27146cc commit 7bca9f8

File tree

73 files changed

+11140
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

73 files changed

+11140
-0
lines changed

‎teams/teams-ps/teams/Disable-CsMeetingRoom.md‎

Lines changed: 187 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,187 @@
1+
---
2+
external help file: MicrosoftTeams-help.xml
3+
Module Name: MicrosoftTeams
4+
applicable: Skype for Business Online
5+
online version: https://learn.microsoft.com/powershell/module/skype/disable-csmeetingroom
6+
schema: 2.0.0
7+
---
8+
9+
# Disable-CsMeetingRoom
10+
11+
## SYNOPSIS
12+
Disables a Skype for Business Server meeting room.
13+
A meeting room is a conferencing device designed to address video conferencing and collaboration scenarios in small conference rooms.
14+
When you disable a meeting room object you remove all the Skype for Business Server-specific Active Directory attributes assigned to the user account that represents the meeting room.
15+
However, the Active Directory user account itself is not deleted.
16+
This cmdlet was introduced in Lync Server 2013.
17+
Note : This cmdlet is not supported for managing Microsoft Teams Rooms.
18+
You must use the methods described in the Microsoft Teams Rooms (/microsoftteams/rooms)documentation to manage Microsoft Teams Rooms.
19+
20+
## SYNTAX
21+
22+
```
23+
Disable-CsMeetingRoom [-Identity] <String> [-PassThru] [-MsftInternalProcessingMode <String>]
24+
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
25+
```
26+
27+
## DESCRIPTION
28+
In Skype for Business Server 2015, meeting rooms are self-contained computer appliances that are installed in conference rooms and supply advanced meeting capabilities such as:
29+
30+
- One touch meeting join experience
31+
- Multi-view video gallery
32+
- Touch-enabled white-boarding on the front of room screen
33+
- Calendar integration to provide access to scheduled meetings
34+
- Content sharing and switching
35+
36+
In order to manage these new endpoint devices you must, among other things, create and enable an Exchange resource mailbox account for the device, then enable that resource account for Skype for Business Server 2015.
37+
Note that, for Skype for Business Server 2015, there are no cmdlets for creating or removing meeting rooms.
38+
Instead, you use the Enable-CsMeetingRoom cmdlet to enable meeting rooms and the Disable-CsMeetingRoom cmdlet to disable meeting rooms.
39+
The resource account must already exist in order for you to enable the meeting room, and disabling a meeting room only removes that room from your collection of meeting rooms; it does not delete the resource mailbox account.
40+
41+
To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Windows PowerShell prompt:
42+
43+
\`Get-CsAdminRole | Where-Object {$_.Cmdlets -match "Disable-CsMeetingRoom"}\`
44+
45+
The functions carried out by the Disable-CsMeetingRoom cmdlet are not available in the Skype for Business Server Control Panel.
46+
47+
## EXAMPLES
48+
49+
### Example 1
50+
```
51+
Disable-CsMeetingRoom -Identity "sip:[email protected]"
52+
```
53+
54+
The command shown in Example 1 disables the meeting room sip:RedmondMeetingRoom@litwareinc.com.
55+
56+
### Example 2
57+
```
58+
Get-CsMeetingRoom | Disable-CsMeetingRoom
59+
```
60+
61+
In Example 2, all the meeting rooms currently in use in the organization are disabled.
62+
To do this, the Get-CsMeetingRoom cmdlet is first used to retrieve a collection of all the meeting rooms.
63+
That collection is then piped to the Disable-CsMeetingRoom cmdlet, which disables each meeting room in the collection.
64+
65+
## PARAMETERS
66+
67+
### -Identity
68+
Indicates the Identity of the user account to be configured as a meeting room.
69+
Identities are typically specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer).
70+
71+
You can also reference a user account by using the user's Active Directory distinguished name.
72+
73+
You can use the asterisk (*) wildcard character when using the Display Name as the user Identity.
74+
For example, the Identity "* Smith" returns all the user who have a display name that ends with the string value " Smith".
75+
76+
```yaml
77+
Type: String
78+
Parameter Sets: (All)
79+
Aliases:
80+
81+
Required: True
82+
Position: 1
83+
Default value: None
84+
Accept pipeline input: True (ByPropertyName, ByValue)
85+
Accept wildcard characters: False
86+
```
87+
88+
### -Confirm
89+
Prompts you for confirmation before running the cmdlet.
90+
91+
```yaml
92+
Type: SwitchParameter
93+
Parameter Sets: (All)
94+
Aliases: cf
95+
96+
Required: False
97+
Position: Named
98+
Default value: False
99+
Accept pipeline input: False
100+
Accept wildcard characters: False
101+
```
102+
103+
### -PassThru
104+
Enables you to pass a meeting room object through the pipeline that represents the meeting room being disabled.
105+
By default, the Disable-CsMeetingRoom cmdlet does not pass objects through the pipeline.
106+
107+
```yaml
108+
Type: SwitchParameter
109+
Parameter Sets: (All)
110+
Aliases:
111+
112+
Required: False
113+
Position: Named
114+
Default value: False
115+
Accept pipeline input: False
116+
Accept wildcard characters: False
117+
```
118+
119+
### -WhatIf
120+
Describes what would happen if you executed the command without actually executing the command.
121+
122+
```yaml
123+
Type: SwitchParameter
124+
Parameter Sets: (All)
125+
Aliases: wi
126+
127+
Required: False
128+
Position: Named
129+
Default value: False
130+
Accept pipeline input: False
131+
Accept wildcard characters: False
132+
```
133+
134+
### -MsftInternalProcessingMode
135+
{{ Fill MsftInternalProcessingMode Description }}
136+
137+
```yaml
138+
Type: String
139+
Parameter Sets: (All)
140+
Aliases:
141+
142+
Required: False
143+
Position: Named
144+
Default value: None
145+
Accept pipeline input: False
146+
Accept wildcard characters: False
147+
```
148+
149+
### -ProgressAction
150+
{{ Fill ProgressAction Description }}
151+
152+
```yaml
153+
Type: ActionPreference
154+
Parameter Sets: (All)
155+
Aliases: proga
156+
157+
Required: False
158+
Position: Named
159+
Default value: None
160+
Accept pipeline input: False
161+
Accept wildcard characters: False
162+
```
163+
164+
### CommonParameters
165+
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).
166+
167+
## INPUTS
168+
169+
### Microsoft.Rtc.Management.ADConnect.Schema.OCSADMeetingRoom
170+
### Microsoft.Rtc.Management.AD.UserIdParameter
171+
## OUTPUTS
172+
173+
### None
174+
Instead, Disable-CsMeetingRoom deletes instance of the Microsoft.Rtc.Management.ADConnect.Schema.OCSADMeetingRoom object.
175+
176+
## NOTES
177+
178+
## RELATED LINKS
179+
180+
[Enable-CsMeetingRoom]()
181+
182+
[Get-CsMeetingRoom]()
183+
184+
[Move-CsMeetingRoom]()
185+
186+
[Set-CsMeetingRoom]()
187+

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

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
---
2+
external help file: MicrosoftTeams-help.xml
3+
online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineaudioconferencingroutingpolicy
4+
Module Name: MicrosoftTeams
5+
applicable: Microsoft Teams
6+
title: Get-CsOnlineAudioConferencingRoutingPolicy
7+
schema: 2.0.0
8+
manager: bulenteg
9+
author: tomkau
10+
ms.author: tomkau
11+
ms.reviewer: williamlooney
12+
---
13+
14+
# Get-CsOnlineAudioConferencingRoutingPolicy
15+
16+
## SYNOPSIS
17+
Gets the audio conferencing routing policy settings in your organization. Make sure you are following the guidance here to set up properly: [Manage On-network Conferencing for Audio Conferencing](https://learn.microsoft.com/en-us/microsoftteams/audio-conferencing-on-network).
18+
19+
## SYNTAX
20+
21+
### Identity (Default)
22+
```
23+
Get-CsOnlineAudioConferencingRoutingPolicy [[-Identity] <String>] [<CommonParameters>]
24+
```
25+
26+
### Filter
27+
```
28+
Get-CsOnlineAudioConferencingRoutingPolicy [-Filter <String>] [<CommonParameters>]
29+
```
30+
31+
## DESCRIPTION
32+
Gets the audio conferencing routing policy settings in your organization.
33+
34+
## EXAMPLES
35+
36+
37+
### -------------------------- Example 1 --------------------------
38+
```powershell
39+
Get-CsOnlineAudioConferencingRoutingPolicy
40+
```
41+
42+
In Example 1, Get-CsOnlineAudioConferencingRoutingPolicy is called without any additional parameters; this returns a collection of all the audio conferencing routing policies configured for use in your organization.
43+
44+
45+
### -------------------------- Example 2 --------------------------
46+
```powershell
47+
Get-CsOnlineAudioConferencingRoutingPolicy -Identity SalesPolicy
48+
```
49+
50+
In Example 2, Get-CsOnlineAudioConferencingRoutingPolicy is used to return the per-user meeting policy that has an Identity SalesPolicy.
51+
Because identities are unique, this command will never return more than one item.
52+
53+
54+
## PARAMETERS
55+
56+
### -Filter
57+
Enables you to use wildcard characters when indicating the policy (or policies) to be returned.
58+
59+
```yaml
60+
Type: String
61+
Parameter Sets: (All)
62+
Aliases:
63+
64+
Required: False
65+
Position: Named
66+
Default value: None
67+
Accept pipeline input: False
68+
Accept wildcard characters: False
69+
```
70+
71+
### -Identity
72+
Unique identifier of the policy to be returned. To refer to the global policy, use this syntax: -Identity global. To refer to a per-user policy, use syntax similar to this: -Identity SalesDepartmentPolicy.
73+
If this parameter is omitted, then all the meeting policies configured for use in your organization will be returned.
74+
75+
```yaml
76+
Type: XdsIdentity
77+
Parameter Sets: (All)
78+
Aliases:
79+
80+
Required: False
81+
Position: 1
82+
Default value: None
83+
Accept pipeline input: False
84+
Accept wildcard characters: False
85+
```
86+
87+
### CommonParameters
88+
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).
89+
90+
## INPUTS
91+
92+
### None
93+
94+
## OUTPUTS
95+
96+
### System.Object
97+
## NOTES
98+
99+
## RELATED LINKS

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

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
external help file: MicrosoftTeams-help.xml
3+
Module Name: MicrosoftTeams
4+
applicable: Skype for Business Online
5+
online version:
6+
schema: 2.0.0
7+
---
8+
9+
# Get-CsOnlinePowerShellEndpoint
10+
11+
## SYNOPSIS
12+
This cmdlet is no longer supported after Skype for Business Online Deprecation.
13+
14+
## SYNTAX
15+
16+
17+
## DESCRIPTION
18+
This cmdlet is no longer supported after Skype for Business Online Deprecation.
19+
20+
## EXAMPLES
21+
22+
23+
### CommonParameters
24+
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).
25+
26+
## INPUTS
27+
28+
### None
29+
30+
## OUTPUTS
31+
32+
### System.Object
33+
## NOTES
34+
35+
## RELATED LINKS

0 commit comments

Comments
 (0)