Skip to content

Commit 25abbbd

Browse files
KateyanneKateyanne
authored
Merge pull request MicrosoftDocs#7043 from levdavid/templates
add teams templates documentation
2 parents 70f6570 + fd86a6d commit 25abbbd

File tree

5 files changed

+2259
-0
lines changed

5 files changed

+2259
-0
lines changed

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

Lines changed: 241 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,241 @@
1+
---
2+
external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml
3+
Module Name: Microsoft.Teams.ConfigAPI.Cmdlets
4+
online version: https://docs.microsoft.com/powershell/module/teams/get-csteamtemplate
5+
title: Get-CsTeamTemplate
6+
author: levdavid
7+
ms.author: legorbun
8+
ms.reviewer:
9+
manager: farahf
10+
schema: 2.0.0
11+
---
12+
13+
# Get-CsTeamTemplate
14+
15+
## SYNOPSIS
16+
17+
This cmdlet supports retrieving details of a team template available to your tenant given the team template uri.
18+
19+
## SYNTAX
20+
21+
### Get (Default)
22+
23+
```powershell
24+
Get-CsTeamTemplate -OdataId <String> [-Break] [-HttpPipelineAppend <SendAsyncStep[]>]
25+
[-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] [-ProxyCredential <PSCredential>]
26+
[-ProxyUseDefaultCredentials] [<CommonParameters>]
27+
```
28+
29+
### GetViaIdentity
30+
31+
```powershell
32+
Get-CsTeamTemplate -InputObject <IConfigApiBasedCmdletsIdentity> [-Break]
33+
[-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>]
34+
[-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [<CommonParameters>]
35+
```
36+
37+
## DESCRIPTION
38+
39+
This cmdlet supports retrieving details of a team template available to your tenant given the team template uri.
40+
41+
## EXAMPLES
42+
43+
### EXAMPLE 1
44+
45+
```powershell
46+
PS C:> (Get-CsTeamTemplateList -PublicTemplateLocale en-US) | where Name -like 'test' | ForEach-Object {Get-CsTeamTemplate -OdataId $_.OdataId}
47+
```
48+
49+
Within the universe of templates the admin’s tenant has access to, returns a template definition object (displayed as a JSON by default) for every custom and every Microsoft en-US template which names include ‘test’.
50+
51+
### EXAMPLE 2
52+
53+
```powershell
54+
PS C:> Get-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/cefcf333-91a9-43d0-919f-bbca5b7d2b24/Tenant/en-US' > 'config.json'
55+
```
56+
57+
Saves the template with specified template ID as a JSON file.
58+
59+
## PARAMETERS
60+
61+
### -OdataId
62+
63+
A composite URI of a template.
64+
65+
```yaml
66+
Type: String
67+
Parameter Sets: Get
68+
Aliases:
69+
70+
Required: True
71+
Position: Named
72+
Default value: None
73+
Accept pipeline input: False
74+
Accept wildcard characters: False
75+
```
76+
77+
### -InputObject
78+
79+
Identity Parameter
80+
To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
81+
82+
```yaml
83+
Type: IConfigApiBasedCmdletsIdentity
84+
Parameter Sets: GetViaIdentity
85+
Aliases:
86+
87+
Required: True
88+
Position: Named
89+
Default value: None
90+
Accept pipeline input: True (ByValue)
91+
Accept wildcard characters: False
92+
```
93+
94+
### -Break
95+
96+
Wait for .NET debugger to attach
97+
98+
```yaml
99+
Type: SwitchParameter
100+
Parameter Sets: (All)
101+
Aliases:
102+
103+
Required: False
104+
Position: Named
105+
Default value: False
106+
Accept pipeline input: False
107+
Accept wildcard characters: False
108+
```
109+
110+
### -HttpPipelineAppend
111+
112+
SendAsync Pipeline Steps to be appended to the front of the pipeline
113+
114+
```yaml
115+
Type: SendAsyncStep[]
116+
Parameter Sets: (All)
117+
Aliases:
118+
119+
Required: False
120+
Position: Named
121+
Default value: None
122+
Accept pipeline input: False
123+
Accept wildcard characters: False
124+
```
125+
126+
### -HttpPipelinePrepend
127+
128+
SendAsync Pipeline Steps to be prepended to the front of the pipeline
129+
130+
```yaml
131+
Type: SendAsyncStep[]
132+
Parameter Sets: (All)
133+
Aliases:
134+
135+
Required: False
136+
Position: Named
137+
Default value: None
138+
Accept pipeline input: False
139+
Accept wildcard characters: False
140+
```
141+
142+
### -Proxy
143+
144+
The URI for the proxy server to use
145+
146+
```yaml
147+
Type: Uri
148+
Parameter Sets: (All)
149+
Aliases:
150+
151+
Required: False
152+
Position: Named
153+
Default value: None
154+
Accept pipeline input: False
155+
Accept wildcard characters: False
156+
```
157+
158+
### -ProxyCredential
159+
160+
Credentials for a proxy server to use for the remote call
161+
162+
```yaml
163+
Type: PSCredential
164+
Parameter Sets: (All)
165+
Aliases:
166+
167+
Required: False
168+
Position: Named
169+
Default value: None
170+
Accept pipeline input: False
171+
Accept wildcard characters: False
172+
```
173+
174+
### -ProxyUseDefaultCredentials
175+
176+
Use the default credentials for the proxy
177+
178+
```yaml
179+
Type: SwitchParameter
180+
Parameter Sets: (All)
181+
Aliases:
182+
183+
Required: False
184+
Position: Named
185+
Default value: False
186+
Accept pipeline input: False
187+
Accept wildcard characters: False
188+
```
189+
190+
### CommonParameters
191+
192+
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).
193+
194+
## INPUTS
195+
196+
### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity
197+
198+
## OUTPUTS
199+
200+
### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorObject
201+
202+
### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate
203+
204+
## NOTES
205+
206+
COMPLEX PARAMETER PROPERTIES
207+
208+
To create the parameters described below, construct a hash table containing the appropriate properties.
209+
For information on hash tables, run Get-Help about_Hash_Tables.
210+
211+
INPUTOBJECT \<IConfigApiBasedCmdletsIdentity\>: Identity Parameter\
212+
\[Bssid \<String\>\]: \
213+
\[ChassisId \<String\>\]: \
214+
\[CivicAddressId \<String\>\]: Civic address id.\
215+
\[Country \<String\>\]: \
216+
\[GroupId \<String\>\]: The ID of a group whose policy assignments will be returned.\
217+
\[Id \<String\>\]: \
218+
\[Identity \<String\>\]: \
219+
\[Locale \<String\>\]: The language and country code of templates localization.\
220+
\[LocationId \<String\>\]: Location id.\
221+
\[OdataId \<String\>\]: A composite URI of a template.\
222+
\[OperationId \<String\>\]: The ID of a batch policy assignment operation.\
223+
\[OrderId \<String\>\]: \
224+
\[PackageName \<String\>\]: The name of a specific policy package\
225+
\[PolicyType \<String\>\]: The policy type for which group policy assignments will be returned.\
226+
\[Port \<String\>\]: \
227+
\[PortInOrderId \<String\>\]: \
228+
\[SubnetId \<String\>\]: \
229+
\[TenantId \<String\>\]: \
230+
\[UserId \<String\>\]: UserId.
231+
232+
Supports Guid.
233+
Eventually UPN and SIP.
234+
235+
## RELATED LINKS
236+
237+
- [Get-CsTeamTemplateList](https://docs.microsoft.com/powershell/module/teams/get-csteamtemplatelist)
238+
- [Get-CsTeamTemplate](https://docs.microsoft.com/powershell/module/teams/get-csteamtemplate)
239+
- [New-CsTeamTemplate](https://docs.microsoft.com/powershell/module/teams/new-csteamtemplate)
240+
- [Update-CsTeamTemplate](https://docs.microsoft.com/powershell/module/teams/update-csteamtemplate)
241+
- [Remove-CsTeamTemplate](https://docs.microsoft.com/powershell/module/teams/remove-csteamtemplate)

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

Lines changed: 143 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,143 @@
1+
---
2+
external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml
3+
Module Name: Microsoft.Teams.ConfigAPI.Cmdlets
4+
online version: https://docs.microsoft.com/powershell/module/teams/get-csteamtemplatelist
5+
title: Get-CsTeamTemplateList
6+
author: levdavid
7+
ms.author: legorbun
8+
ms.reviewer:
9+
manager: farahf
10+
schema: 2.0.0
11+
---
12+
13+
# Get-CsTeamTemplateList
14+
15+
## SYNOPSIS
16+
17+
This cmdlet supports retrieving information of all team templates available to your tenant, including both first party Microsoft team templates as well as custom templates. The templates information retrieved includes includes OData Id, template name, short description, count of channels and count of applications.
18+
Note: All custom templates will be retrieved, regardless of the locale specification. If you have hidden templates in the admin center, you will still be able to see the hidden templates here.
19+
20+
## SYNTAX
21+
22+
### Get (Default)
23+
24+
```powershell
25+
Get-CsTeamTemplateList [[-PublicTemplateLocale] <String>] [<CommonParameters>]
26+
```
27+
28+
### GetViaIdentity
29+
30+
```powershell
31+
Get-CsTeamTemplateList -InputObject <IConfigApiBasedCmdletsIdentity> [<CommonParameters>]
32+
```
33+
34+
## DESCRIPTION
35+
36+
Get a list of available team templates
37+
38+
## EXAMPLES
39+
40+
### EXAMPLE 1
41+
42+
```powershell
43+
PS C:> Get-CsTeamTemplateList
44+
```
45+
46+
Returns all en-US templates within the universe of templates the admin’s tenant has access to.
47+
48+
Note: All 1P Microsoft templates will always be returned in the specified locale. If the locale is not specified, en-US will be used.
49+
50+
### EXAMPLE 2
51+
52+
```powershell
53+
PS C:> (Get-CsTeamTemplateList -PublicTemplateLocale en-US) | where ChannelCount -GT 3
54+
```
55+
56+
Returns all en-US templates that have 3 channels within the universe of templates the admin’s tenant has access to.
57+
58+
## PARAMETERS
59+
60+
### -PublicTemplateLocale
61+
62+
The language and country code of templates localization for Microsoft team templates. This will not be applied to your tenant custom team templates. Defaults to en-US.
63+
64+
```yaml
65+
Type: String
66+
Parameter Sets: Get
67+
Aliases:
68+
69+
Required: False
70+
Position: 1
71+
Default value: 'en-US'
72+
Accept pipeline input: False
73+
Accept wildcard characters: False
74+
```
75+
76+
### -InputObject
77+
78+
Identity Parameter
79+
To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
80+
81+
```yaml
82+
Type: IConfigApiBasedCmdletsIdentity
83+
Parameter Sets: GetViaIdentity
84+
Aliases:
85+
86+
Required: True
87+
Position: Named
88+
Default value: None
89+
Accept pipeline input: True (ByValue)
90+
Accept wildcard characters: False
91+
```
92+
93+
### CommonParameters
94+
95+
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).
96+
97+
## INPUTS
98+
99+
### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity
100+
101+
## OUTPUTS
102+
103+
### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorObject
104+
105+
### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplateSummary
106+
107+
## NOTES
108+
109+
COMPLEX PARAMETER PROPERTIES
110+
111+
To create the parameters described below, construct a hash table containing the appropriate properties.\
112+
For information on hash tables, run Get-Help about_Hash_Tables.\
113+
\
114+
INPUTOBJECT \<IConfigApiBasedCmdletsIdentity\>: Identity Parameter\
115+
\[Bssid \<String\>\]:\
116+
\[ChassisId \<String\>\]:\
117+
\[CivicAddressId \<String\>\]: Civic address id.\
118+
\[Country \<String\>\]:\
119+
\[GroupId \<String\>\]: The ID of a group whose policy assignments will be returned.\
120+
\[Id \<String\>\]:\
121+
\[Identity \<String\>\]:\
122+
\[Locale \<String\>\]: The language and country code of templates localization.\
123+
\[LocationId \<String\>\]: Location id.\
124+
\[OdataId \<String\>\]: A composite URI of a template.\
125+
\[OperationId \<String\>\]: The ID of a batch policy assignment operation.\
126+
\[OrderId \<String\>\]:\
127+
\[PackageName \<String\>\]: The name of a specific policy package\
128+
\[PolicyType \<String\>\]: The policy type for which group policy assignments will be returned.\
129+
\[Port \<String\>\]:\
130+
\[PortInOrderId \<String\>\]:\
131+
\[SubnetId \<String\>\]:\
132+
\[TenantId \<String\>\]:\
133+
\[UserId \<String\>\]: UserId.\
134+
Supports Guid.\
135+
Eventually UPN and SIP.
136+
137+
## RELATED LINKS
138+
139+
- [Get-CsTeamTemplateList](https://docs.microsoft.com/powershell/module/teams/get-csteamtemplatelist)
140+
- [Get-CsTeamTemplate](https://docs.microsoft.com/powershell/module/teams/get-csteamtemplate)
141+
- [New-CsTeamTemplate](https://docs.microsoft.com/powershell/module/teams/new-csteamtemplate)
142+
- [Update-CsTeamTemplate](https://docs.microsoft.com/powershell/module/teams/update-csteamtemplate)
143+
- [Remove-CsTeamTemplate](https://docs.microsoft.com/powershell/module/teams/remove-csteamtemplate)

0 commit comments

Comments
 (0)