Skip to content

Commit 472b128

Browse files
committed
Fix platyps schema violations
1 parent 0266b49 commit 472b128

File tree

2 files changed

+105
-53
lines changed

2 files changed

+105
-53
lines changed

docset/winserver2022-ps/adfs/Set-AdfsWebConfig.md

Lines changed: 56 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -17,30 +17,38 @@ Modifies web customization configuration settings.
1717

1818
```
1919
Set-AdfsWebConfig [-ActiveThemeName <String>] [-CDCCookieReader <Uri>] [-CDCCookieWriter <Uri>]
20-
[-HRDCookieLifetime <Int32>] [-HRDCookieEnabled <Boolean>] [-ContextCookieEnabled <Boolean>] [-PassThru]
21-
[-WhatIf] [-Confirm] [<CommonParameters>]
20+
[-HRDCookieLifetime <Int32>] [-HRDCookieEnabled <Boolean>] [-ContextCookieEnabled <Boolean>]
21+
[-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]
2222
```
2323

2424
## DESCRIPTION
25-
The **Set-AdfsWebConfig** cmdlet modifies web customization configuration settings.
26-
These settings impact any protocol that Active Directory Federation Services (AD FS) supports where a web browser facilitates token requests for home realm discovery (HRD) and authentication.
25+
26+
The `Set-AdfsWebConfig` cmdlet modifies web customization configuration settings. These settings
27+
impact any protocol that Active Directory Federation Services (AD FS) supports where a web browser
28+
facilitates token requests for home realm discovery (HRD) and authentication.
2729

2830
## EXAMPLES
2931

3032
### Example 1: Set customization configuration properties
33+
34+
```powershell
35+
$pSSetAdfsWebConfigSplat = @{
36+
ActiveThemeName = "Default"
37+
CDCCookieReader = 'https://www.Contoso.com/reader.aspx'
38+
CDCCookieWriter = 'https://www.Contoso.com/writer.aspx'
39+
ContextCookieEnabled = $True
40+
HRDCookieEnabled = $True
41+
HRDCookieLifetime = 30
42+
}
43+
PSSet-AdfsWebConfig @pSSetAdfsWebConfigSplat
3144
```
32-
PS C:\> Set-AdfsWebConfig -ActiveThemeName "Default" -CDCCookieReader https://www.Contoso.com/reader.aspx -CDCCookieWriter https://www.Contoso.com/writer.aspx -ContextCookieEnabled $True -HRDCookieEnabled $True -HRDCookieLifetime 30
3345

46+
```Output
3447
ActiveThemeName : Default
35-
3648
CDCCookieReader :
37-
3849
CDCCookieWriter :
39-
4050
HRDCookieLifetime : 30
41-
4251
HRDCookieEnabled : True
43-
4452
ContextCookieEnabled : True
4553
```
4654

@@ -49,13 +57,14 @@ This command sets properties in the web customization configuration settings.
4957
## PARAMETERS
5058

5159
### -ActiveThemeName
52-
Specifies the name of a web theme to be set as the active web theme in the web customization configuration.
53-
To create a web theme, use the **New-AdfsWebTheme** cmdlet.
60+
61+
Specifies the name of a web theme to be set as the active web theme in the web customization
62+
configuration. To create a web theme, use the `New-AdfsWebTheme` cmdlet.
5463

5564
```yaml
5665
Type: String
5766
Parameter Sets: (All)
58-
Aliases:
67+
Aliases:
5968

6069
Required: False
6170
Position: Named
@@ -65,12 +74,13 @@ Accept wildcard characters: False
6574
```
6675
6776
### -CDCCookieReader
77+
6878
Specifies the Uniform Resource Identifier (URI) of the Common Domain Cookie (CDC) reader.
6979
7080
```yaml
7181
Type: Uri
7282
Parameter Sets: (All)
73-
Aliases:
83+
Aliases:
7484

7585
Required: False
7686
Position: Named
@@ -80,12 +90,13 @@ Accept wildcard characters: False
8090
```
8191
8292
### -CDCCookieWriter
93+
8394
Specifies the URI of the CDC writer.
8495
8596
```yaml
8697
Type: Uri
8798
Parameter Sets: (All)
88-
Aliases:
99+
Aliases:
89100

90101
Required: False
91102
Position: Named
@@ -95,12 +106,13 @@ Accept wildcard characters: False
95106
```
96107
97108
### -ContextCookieEnabled
109+
98110
Indicates whether to enable the context cookie.
99111
100112
```yaml
101113
Type: Boolean
102114
Parameter Sets: (All)
103-
Aliases:
115+
Aliases:
104116

105117
Required: False
106118
Position: Named
@@ -110,13 +122,15 @@ Accept wildcard characters: False
110122
```
111123
112124
### -HRDCookieEnabled
113-
Indicates whether to enable the HRD cookie.
114-
If you specify a value of $False, when AD FS has more than one claims provider trust enabled, end users must select the home realm in every application request.
125+
126+
Indicates whether to enable the HRD cookie. If you specify a value of `$false`, when AD FS has more
127+
than one claims provider trust enabled, end users must select the home realm in every application
128+
request.
115129

116130
```yaml
117131
Type: Boolean
118132
Parameter Sets: (All)
119-
Aliases:
133+
Aliases:
120134
121135
Required: False
122136
Position: Named
@@ -126,12 +140,13 @@ Accept wildcard characters: False
126140
```
127141

128142
### -HRDCookieLifetime
143+
129144
Specifies the lifetime, in days, of an HRD cookie.
130145

131146
```yaml
132147
Type: Int32
133148
Parameter Sets: (All)
134-
Aliases:
149+
Aliases:
135150
136151
Required: False
137152
Position: Named
@@ -141,13 +156,14 @@ Accept wildcard characters: False
141156
```
142157

143158
### -PassThru
144-
Returns an object representing the item with which you are working.
145-
By default, this cmdlet does not generate any output.
159+
160+
Returns an object representing the item with which you are working. By default, this cmdlet does not
161+
generate any output.
146162

147163
```yaml
148164
Type: SwitchParameter
149165
Parameter Sets: (All)
150-
Aliases:
166+
Aliases:
151167
152168
Required: False
153169
Position: Named
@@ -157,6 +173,7 @@ Accept wildcard characters: False
157173
```
158174

159175
### -Confirm
176+
160177
Prompts you for confirmation before running the cmdlet.
161178

162179
```yaml
@@ -172,8 +189,8 @@ Accept wildcard characters: False
172189
```
173190

174191
### -WhatIf
175-
Shows what would happen if the cmdlet runs.
176-
The cmdlet is not run.
192+
193+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
177194

178195
```yaml
179196
Type: SwitchParameter
@@ -188,16 +205,26 @@ Accept wildcard characters: False
188205
```
189206

190207
### CommonParameters
191-
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).
208+
209+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
210+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
211+
-WarningAction, and -WarningVariable. For more information, see
212+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
192213

193214
## INPUTS
194215

195-
### System.String;System.String[];System.Uri;System.Int32;System.Boolean
216+
### None
196217

197218
## OUTPUTS
198219

199-
###
200-
This cmdlet generates string for a theme to save as the active theme.
220+
### None
221+
222+
By default, this cmdlet doesn't return any output.
223+
224+
### AdfsWebConfig
225+
226+
When you use the **PassThru** parameter, this cmdlet returns an **AdfsWebConfig** object that
227+
represents the modified configuration settings.
201228

202229
## NOTES
203230

@@ -206,4 +233,3 @@ This cmdlet generates string for a theme to save as the active theme.
206233
[Get-AdfsWebConfig](./Get-AdfsWebConfig.md)
207234

208235
[New-AdfsWebTheme](./New-AdfsWebTheme.md)
209-

docset/winserver2025-ps/adfs/Set-AdfsWebConfig.md

Lines changed: 49 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -17,30 +17,38 @@ Modifies web customization configuration settings.
1717

1818
```
1919
Set-AdfsWebConfig [-ActiveThemeName <String>] [-CDCCookieReader <Uri>] [-CDCCookieWriter <Uri>]
20-
[-HRDCookieLifetime <Int32>] [-HRDCookieEnabled <Boolean>] [-ContextCookieEnabled <Boolean>] [-PassThru]
21-
[-WhatIf] [-Confirm] [<CommonParameters>]
20+
[-HRDCookieLifetime <Int32>] [-HRDCookieEnabled <Boolean>] [-ContextCookieEnabled <Boolean>]
21+
[-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]
2222
```
2323

2424
## DESCRIPTION
25-
The **Set-AdfsWebConfig** cmdlet modifies web customization configuration settings.
26-
These settings impact any protocol that Active Directory Federation Services (AD FS) supports where a web browser facilitates token requests for home realm discovery (HRD) and authentication.
25+
26+
The `Set-AdfsWebConfig` cmdlet modifies web customization configuration settings. These settings
27+
impact any protocol that Active Directory Federation Services (AD FS) supports where a web browser
28+
facilitates token requests for home realm discovery (HRD) and authentication.
2729

2830
## EXAMPLES
2931

3032
### Example 1: Set customization configuration properties
33+
34+
```powershell
35+
$pSSetAdfsWebConfigSplat = @{
36+
ActiveThemeName = "Default"
37+
CDCCookieReader = 'https://www.Contoso.com/reader.aspx'
38+
CDCCookieWriter = 'https://www.Contoso.com/writer.aspx'
39+
ContextCookieEnabled = $True
40+
HRDCookieEnabled = $True
41+
HRDCookieLifetime = 30
42+
}
43+
PSSet-AdfsWebConfig @pSSetAdfsWebConfigSplat
3144
```
32-
PS C:\> Set-AdfsWebConfig -ActiveThemeName "Default" -CDCCookieReader https://www.Contoso.com/reader.aspx -CDCCookieWriter https://www.Contoso.com/writer.aspx -ContextCookieEnabled $True -HRDCookieEnabled $True -HRDCookieLifetime 30
3345

46+
```Output
3447
ActiveThemeName : Default
35-
3648
CDCCookieReader :
37-
3849
CDCCookieWriter :
39-
4050
HRDCookieLifetime : 30
41-
4251
HRDCookieEnabled : True
43-
4452
ContextCookieEnabled : True
4553
```
4654

@@ -49,8 +57,9 @@ This command sets properties in the web customization configuration settings.
4957
## PARAMETERS
5058

5159
### -ActiveThemeName
52-
Specifies the name of a web theme to be set as the active web theme in the web customization configuration.
53-
To create a web theme, use the **New-AdfsWebTheme** cmdlet.
60+
61+
Specifies the name of a web theme to be set as the active web theme in the web customization
62+
configuration. To create a web theme, use the `New-AdfsWebTheme` cmdlet.
5463

5564
```yaml
5665
Type: String
@@ -65,6 +74,7 @@ Accept wildcard characters: False
6574
```
6675
6776
### -CDCCookieReader
77+
6878
Specifies the Uniform Resource Identifier (URI) of the Common Domain Cookie (CDC) reader.
6979
7080
```yaml
@@ -80,6 +90,7 @@ Accept wildcard characters: False
8090
```
8191
8292
### -CDCCookieWriter
93+
8394
Specifies the URI of the CDC writer.
8495
8596
```yaml
@@ -95,6 +106,7 @@ Accept wildcard characters: False
95106
```
96107
97108
### -ContextCookieEnabled
109+
98110
Indicates whether to enable the context cookie.
99111
100112
```yaml
@@ -110,8 +122,10 @@ Accept wildcard characters: False
110122
```
111123
112124
### -HRDCookieEnabled
113-
Indicates whether to enable the HRD cookie.
114-
If you specify a value of $False, when AD FS has more than one claims provider trust enabled, end users must select the home realm in every application request.
125+
126+
Indicates whether to enable the HRD cookie. If you specify a value of `$false`, when AD FS has more
127+
than one claims provider trust enabled, end users must select the home realm in every application
128+
request.
115129

116130
```yaml
117131
Type: Boolean
@@ -126,6 +140,7 @@ Accept wildcard characters: False
126140
```
127141

128142
### -HRDCookieLifetime
143+
129144
Specifies the lifetime, in days, of an HRD cookie.
130145

131146
```yaml
@@ -141,8 +156,9 @@ Accept wildcard characters: False
141156
```
142157

143158
### -PassThru
144-
Returns an object representing the item with which you are working.
145-
By default, this cmdlet does not generate any output.
159+
160+
Returns an object representing the item with which you are working. By default, this cmdlet does not
161+
generate any output.
146162

147163
```yaml
148164
Type: SwitchParameter
@@ -157,6 +173,7 @@ Accept wildcard characters: False
157173
```
158174

159175
### -Confirm
176+
160177
Prompts you for confirmation before running the cmdlet.
161178

162179
```yaml
@@ -172,8 +189,8 @@ Accept wildcard characters: False
172189
```
173190

174191
### -WhatIf
175-
Shows what would happen if the cmdlet runs.
176-
The cmdlet is not run.
192+
193+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
177194

178195
```yaml
179196
Type: SwitchParameter
@@ -188,16 +205,26 @@ Accept wildcard characters: False
188205
```
189206

190207
### CommonParameters
191-
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).
208+
209+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
210+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
211+
-WarningAction, and -WarningVariable. For more information, see
212+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
192213

193214
## INPUTS
194215

195-
### System.String;System.String[];System.Uri;System.Int32;System.Boolean
216+
### None
196217

197218
## OUTPUTS
198219

199-
###
200-
This cmdlet generates string for a theme to save as the active theme.
220+
### None
221+
222+
By default, this cmdlet doesn't return any output.
223+
224+
### AdfsWebConfig
225+
226+
When you use the **PassThru** parameter, this cmdlet returns an **AdfsWebConfig** object that
227+
represents the modified configuration settings.
201228

202229
## NOTES
203230

@@ -206,4 +233,3 @@ This cmdlet generates string for a theme to save as the active theme.
206233
[Get-AdfsWebConfig](./Get-AdfsWebConfig.md)
207234

208235
[New-AdfsWebTheme](./New-AdfsWebTheme.md)
209-

0 commit comments

Comments
 (0)