@@ -17,30 +17,38 @@ Modifies web customization configuration settings.
17
17
18
18
```
19
19
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>]
22
22
```
23
23
24
24
## 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.
27
29
28
30
## EXAMPLES
29
31
30
32
### 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
31
44
```
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
33
45
46
+ ``` Output
34
47
ActiveThemeName : Default
35
-
36
48
CDCCookieReader :
37
-
38
49
CDCCookieWriter :
39
-
40
50
HRDCookieLifetime : 30
41
-
42
51
HRDCookieEnabled : True
43
-
44
52
ContextCookieEnabled : True
45
53
```
46
54
@@ -49,13 +57,14 @@ This command sets properties in the web customization configuration settings.
49
57
## PARAMETERS
50
58
51
59
### -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.
54
63
55
64
``` yaml
56
65
Type : String
57
66
Parameter Sets : (All)
58
- Aliases :
67
+ Aliases :
59
68
60
69
Required : False
61
70
Position : Named
@@ -65,12 +74,13 @@ Accept wildcard characters: False
65
74
` ` `
66
75
67
76
### -CDCCookieReader
77
+
68
78
Specifies the Uniform Resource Identifier (URI) of the Common Domain Cookie (CDC) reader.
69
79
70
80
` ` ` yaml
71
81
Type : Uri
72
82
Parameter Sets : (All)
73
- Aliases :
83
+ Aliases :
74
84
75
85
Required : False
76
86
Position : Named
@@ -80,12 +90,13 @@ Accept wildcard characters: False
80
90
` ` `
81
91
82
92
### -CDCCookieWriter
93
+
83
94
Specifies the URI of the CDC writer.
84
95
85
96
` ` ` yaml
86
97
Type : Uri
87
98
Parameter Sets : (All)
88
- Aliases :
99
+ Aliases :
89
100
90
101
Required : False
91
102
Position : Named
@@ -95,12 +106,13 @@ Accept wildcard characters: False
95
106
` ` `
96
107
97
108
### -ContextCookieEnabled
109
+
98
110
Indicates whether to enable the context cookie.
99
111
100
112
` ` ` yaml
101
113
Type : Boolean
102
114
Parameter Sets : (All)
103
- Aliases :
115
+ Aliases :
104
116
105
117
Required : False
106
118
Position : Named
@@ -110,13 +122,15 @@ Accept wildcard characters: False
110
122
` ` `
111
123
112
124
### -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.
115
129
116
130
` ` ` yaml
117
131
Type: Boolean
118
132
Parameter Sets: (All)
119
- Aliases :
133
+ Aliases:
120
134
121
135
Required: False
122
136
Position: Named
@@ -126,12 +140,13 @@ Accept wildcard characters: False
126
140
` ` `
127
141
128
142
# ## -HRDCookieLifetime
143
+
129
144
Specifies the lifetime, in days, of an HRD cookie.
130
145
131
146
` ` ` yaml
132
147
Type: Int32
133
148
Parameter Sets: (All)
134
- Aliases :
149
+ Aliases:
135
150
136
151
Required: False
137
152
Position: Named
@@ -141,13 +156,14 @@ Accept wildcard characters: False
141
156
` ` `
142
157
143
158
# ## -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.
146
162
147
163
` ` ` yaml
148
164
Type: SwitchParameter
149
165
Parameter Sets: (All)
150
- Aliases :
166
+ Aliases:
151
167
152
168
Required: False
153
169
Position: Named
@@ -157,6 +173,7 @@ Accept wildcard characters: False
157
173
` ` `
158
174
159
175
# ## -Confirm
176
+
160
177
Prompts you for confirmation before running the cmdlet.
161
178
162
179
` ` ` yaml
@@ -172,8 +189,8 @@ Accept wildcard characters: False
172
189
` ` `
173
190
174
191
# ## -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.
177
194
178
195
` ` ` yaml
179
196
Type: SwitchParameter
@@ -188,16 +205,26 @@ Accept wildcard characters: False
188
205
` ` `
189
206
190
207
# ## 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).
192
213
193
214
# # INPUTS
194
215
195
- ### System.String;System.String[];System.Uri;System.Int32;System.Boolean
216
+ # ## None
196
217
197
218
# # OUTPUTS
198
219
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.
201
228
202
229
# # NOTES
203
230
@@ -206,4 +233,3 @@ This cmdlet generates string for a theme to save as the active theme.
206
233
[Get-AdfsWebConfig](./Get-AdfsWebConfig.md)
207
234
208
235
[New-AdfsWebTheme](./New-AdfsWebTheme.md)
209
-
0 commit comments