Skip to content

Commit 793a56d

Browse files
authored
Merge pull request MicrosoftDocs#6500 from jackry6350/master
Add docs for new cmdlet Get/Set-CsApplicationMeetingConfiguration
2 parents fd764f3 + f8213e3 commit 793a56d

File tree

2 files changed

+283
-0
lines changed

2 files changed

+283
-0
lines changed
Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
---
2+
external help file: Microsoft.Rtc.Management.dll-help.xml
3+
online version: https://docs.microsoft.com/powershell/module/skype/get-CsApplicationMeetingConfiguration
4+
applicable: Teams
5+
title: Get-CsApplicationMeetingConfiguration
6+
schema: 2.0.0
7+
manager: zhengni
8+
author: jackry6350
9+
ms.author: yoren
10+
ms.reviewer:
11+
---
12+
13+
# Get-CsApplicationMeetingConfiguration
14+
15+
## SYNOPSIS
16+
17+
Retrieves information about the application meeting configuration settings configured for the tenant.
18+
19+
## SYNTAX
20+
21+
### Identity
22+
23+
```
24+
Get-CsApplicationMeetingConfiguration [-Identity <XdsIdentity>]
25+
```
26+
27+
## DESCRIPTION
28+
29+
This cmdlet retrieves information about the application meeting configuration settings configured for the tenant.
30+
31+
## EXAMPLES
32+
33+
### Retrieve application meeting configuration settings for the tenant.
34+
35+
```
36+
PS C:\> Get-CsApplicationMeetingConfiguration
37+
```
38+
39+
The command shown above returns application meeting configuration settings that have been configured for the tenant.
40+
41+
42+
## PARAMETERS
43+
44+
### -Identity
45+
46+
Unique identifier of the application meeting configuration settings to be returned.
47+
Because you can only have a single, global instance of these settings, you do not have to include the Identity when calling the Get-CsApplicationMeetingConfiguration cmdlet.
48+
However, you can use the following syntax to retrieve the global settings: -Identity global.
49+
50+
```yaml
51+
Type: XdsIdentity
52+
Parameter Sets: (All)
53+
Aliases:
54+
55+
Required: True
56+
Position: 1
57+
Default value: None
58+
Accept pipeline input: False
59+
Accept wildcard characters: False
60+
```
61+
62+
### -Filter
63+
Enables you to use wildcards when specifying the application meeting configuration settings to be returned.
64+
Because you can only have a single, global instance of these settings there is little reason to use the Filter parameter.
65+
However, if you prefer, you can use syntax similar to this to retrieve the global settings: -Identity "g*".
66+
67+
```yaml
68+
Type: String
69+
Parameter Sets: Filter
70+
Aliases:
71+
Applicable: Teams
72+
73+
Required: False
74+
Position: Named
75+
Default value: None
76+
Accept pipeline input: False
77+
Accept wildcard characters: False
78+
```
79+
80+
### -LocalStore
81+
Retrieves the application meeting configuration data from the local replica of the Central Management store rather than from the Central Management store itself.
82+
83+
```yaml
84+
Type: SwitchParameter
85+
Parameter Sets: (All)
86+
Aliases:
87+
Applicable: Teams
88+
89+
Required: False
90+
Position: Named
91+
Default value: None
92+
Accept pipeline input: False
93+
Accept wildcard characters: False
94+
```
95+
96+
### CommonParameters
97+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).
98+
99+
## INPUTS
100+
101+
### None
102+
103+
## OUTPUTS
104+
105+
### Microsoft.Rtc.Management.WritableConfig.Settings.PlatformApplications.ApplicationMeetingConfiguration
106+
107+
## NOTES
108+
109+
## RELATED LINKS
110+
111+
[Set-CsApplicationMeetingConfiguration](Set-CsApplicationMeetingConfiguration.md)
Lines changed: 172 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,172 @@
1+
---
2+
external help file: Microsoft.Rtc.Management.dll-help.xml
3+
online version: https://docs.microsoft.com/powershell/module/skype/set-CsApplicationMeetingConfiguration
4+
applicable: Teams
5+
title: Set-CsApplicationMeetingConfiguration
6+
schema: 2.0.0
7+
manager: zhengni
8+
author: jackry6350
9+
ms.author: yoren
10+
ms.reviewer:
11+
---
12+
13+
# Set-CsApplicationMeetingConfiguration
14+
15+
## SYNOPSIS
16+
17+
Modifies an existing application meeting configuration for the tenant.
18+
19+
## SYNTAX
20+
21+
### Identity
22+
23+
```
24+
Set-CsApplicationMeetingConfiguration [-Identity <XdsIdentity>] [-AllowRemoveParticipantAppIds <PSListModifier>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
25+
```
26+
27+
### Instance
28+
```
29+
Set-CsApplicationMeetingConfiguration [-Instance <PSObject>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
30+
```
31+
32+
## DESCRIPTION
33+
34+
This cmdlet modifies an existing application meeting configuration for the tenant.
35+
36+
## EXAMPLES
37+
38+
### Add new app ID to the configuration to allow remove participant for the tenant
39+
40+
```
41+
PS C:\> Set-CsApplicationMeetingConfiguration -AllowRemoveParticipantAppIds @{Add="5817674c-81d9-4adb-bfb2-8f6a442e4622"}
42+
```
43+
44+
The command shown above adds a new app ID "5817674c-81d9-4adb-bfb2-8f6a442e4622" to the application meeting configuration settings for the tenant to allow it to remove participant.
45+
46+
### Remove app IDs from the configuration to allow remove participant for the tenant
47+
48+
```
49+
PS C:\> Set-CsApplicationMeetingConfiguration -AllowRemoveParticipantAppIds @{Remove="5817674c-81d9-4adb-bfb2-8f6a442e4622"}
50+
```
51+
52+
The command shown above removes the app ID "5817674c-81d9-4adb-bfb2-8f6a442e4622" from the application meeting configuration settings for the tenant to disallow it to remove participant.
53+
54+
## PARAMETERS
55+
56+
### -Identity
57+
58+
Unique identifier of the application meeting configuration settings to be returned.
59+
Because you can only have a single, global instance of these settings, you do not have to include the Identity when calling the Set-CsApplicationMeetingConfiguration cmdlet.
60+
However, you can use the following syntax to retrieve the global settings: -Identity global.
61+
62+
```yaml
63+
Type: XdsIdentity
64+
Parameter Sets: (All)
65+
Aliases:
66+
67+
Required: True
68+
Position: 1
69+
Default value: None
70+
Accept pipeline input: False
71+
Accept wildcard characters: False
72+
```
73+
74+
### -Instance
75+
Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values.
76+
77+
```yaml
78+
Type: PSObject
79+
Parameter Sets: Instance
80+
Aliases:
81+
Applicable: Teams
82+
83+
Required: False
84+
Position: Named
85+
Default value: None
86+
Accept pipeline input: True (ByValue)
87+
Accept wildcard characters: False
88+
```
89+
90+
### -AllowRemoveParticipantAppIds
91+
92+
A list of application (client) IDs. For details of application (client) ID, refer to: [Get tenant and app ID values for signing in](https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal#get-tenant-and-app-id-values-for-signing-in).
93+
94+
```yaml
95+
Type: PSListModifier
96+
Parameter Sets: (All)
97+
Aliases:
98+
99+
Required: False
100+
Position: Named
101+
Default value: None
102+
Accept pipeline input: False
103+
Accept wildcard characters: False
104+
```
105+
106+
### -Force
107+
Suppresses the display of any non-fatal error message that might occur when running the command.
108+
109+
```yaml
110+
Type: SwitchParameter
111+
Parameter Sets: (All)
112+
Aliases:
113+
Applicable: Teams
114+
115+
Required: False
116+
Position: Named
117+
Default value: None
118+
Accept pipeline input: False
119+
Accept wildcard characters: False
120+
```
121+
122+
### -WhatIf
123+
Describes what would happen if you executed the command without actually executing the command.
124+
125+
```yaml
126+
Type: SwitchParameter
127+
Parameter Sets: (All)
128+
Aliases: wi
129+
Applicable: Teams
130+
131+
Required: False
132+
Position: Named
133+
Default value: None
134+
Accept pipeline input: False
135+
Accept wildcard characters: False
136+
```
137+
138+
### -Confirm
139+
Prompts you for confirmation before executing the command.
140+
141+
```yaml
142+
Type: SwitchParameter
143+
Parameter Sets: (All)
144+
Aliases: cf
145+
Applicable: Teams
146+
147+
Required: False
148+
Position: Named
149+
Default value: None
150+
Accept pipeline input: False
151+
Accept wildcard characters: False
152+
```
153+
154+
### CommonParameters
155+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).
156+
157+
## INPUTS
158+
159+
###
160+
None.
161+
The `Set-CsApplicationMeetingConfiguration` cmdlet does not accept pipelined input.
162+
163+
## OUTPUTS
164+
165+
###
166+
The `Set-CsApplicationMeetingConfiguration` cmdlet does not return any objects or values.
167+
168+
## NOTES
169+
170+
## RELATED LINKS
171+
172+
[Get-CsApplicationMeetingConfiguration](Get-CsApplicationMeetingConfiguration.md)

0 commit comments

Comments
 (0)