Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update config for Windows Server 2025 #3738

Merged
merged 12 commits into from
Feb 8, 2024
16 changes: 16 additions & 0 deletions docset/docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@
"content": [
{ "files": [ "toc.yml" ], "src": "bread", "dest": "windows/bread" },

{ "files": [ "**/*.md" ], "src": "docs-conceptual/winserver2025-ps", "version": "WindowsServer2025-ps", "dest": "windows" },
{ "files": [ "toc.yml" ], "src": "docs-conceptual/winserver2025-ps", "version": "WindowsServer2025-ps", "dest": "winserver2025-ps" },
{ "files": [ "**/*.yml" ], "exclude": [ "toc.yml" ], "src": "winserver2025-ps", "version": "WindowsServer2025-ps", "dest": "module" },
{ "files": [ "toc.yml" ], "src": "winserver2025-ps", "version": "WindowsServer2025-ps", "dest": "module/WindowsServer2025-ps" },

{ "files": [ "**/*.md" ], "src": "docs-conceptual/winserver2022-ps", "version": "WindowsServer2022-ps", "dest": "windows" },
{ "files": [ "toc.yml" ], "src": "docs-conceptual/winserver2022-ps", "version": "WindowsServer2022-ps", "dest": "winserver2022-ps" },
{ "files": [ "**/*.yml" ], "exclude": [ "toc.yml" ], "src": "winserver2022-ps", "version": "WindowsServer2022-ps", "dest": "module" },
Expand Down Expand Up @@ -39,6 +44,9 @@
{ "files": [ "**/*.png", "**/*.jpg" ], "exclude": [ "**/obj/**", "**/includes/**" ] }
],
"versions": {
"WindowsServer2025-ps": {
"dest": "winserver2025-ps"
},
"WindowsServer2022-ps": {
"dest": "winserver2022-ps"
},
Expand Down Expand Up @@ -105,6 +113,14 @@
"https://authoring-docs-microsoft.poolparty.biz/devrel/56936876-97d9-45cc-ad1b-9d63320447c8",
"https://authoring-docs-microsoft.poolparty.biz/devrel/211bc889-ad71-4c77-b1cd-8ea0d02263f9"
],
"winserver2025-ps/**/*.md": [
"https://authoring-docs-microsoft.poolparty.biz/devrel/56936876-97d9-45cc-ad1b-9d63320447c8",
"https://authoring-docs-microsoft.poolparty.biz/devrel/56754133-c3c3-4a9f-af19-71bdbe19fccf"
],
"winserver2025-ps/**/*.yml": [
"https://authoring-docs-microsoft.poolparty.biz/devrel/56936876-97d9-45cc-ad1b-9d63320447c8",
"https://authoring-docs-microsoft.poolparty.biz/devrel/56754133-c3c3-4a9f-af19-71bdbe19fccf"
],
"winserver2022-ps/**/*.md": [
"https://authoring-docs-microsoft.poolparty.biz/devrel/56936876-97d9-45cc-ad1b-9d63320447c8",
"https://authoring-docs-microsoft.poolparty.biz/devrel/56754133-c3c3-4a9f-af19-71bdbe19fccf"
Expand Down
6 changes: 6 additions & 0 deletions docset/mapping/monikerMapping.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
{
"WindowsServer2025-ps": {
"conceptualToc": "docs-conceptual/winserver2025-ps/toc.yml",
"conceptualTocUrl": "/powershell/winserver2025-ps/toc.json",
"referenceTocUrl": "/powershell/module/WindowsServer2025-ps/toc.json",
"packageRoot": "winserver2025-ps"
},
"WindowsServer2022-ps": {
"conceptualToc": "docs-conceptual/winserver2022-ps/toc.yml",
"conceptualTocUrl": "/powershell/winserver2022-ps/toc.json",
Expand Down
86 changes: 56 additions & 30 deletions docset/winserver2022-ps/adfs/Set-AdfsWebConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,30 +17,38 @@ Modifies web customization configuration settings.

```
Set-AdfsWebConfig [-ActiveThemeName <String>] [-CDCCookieReader <Uri>] [-CDCCookieWriter <Uri>]
[-HRDCookieLifetime <Int32>] [-HRDCookieEnabled <Boolean>] [-ContextCookieEnabled <Boolean>] [-PassThru]
[-WhatIf] [-Confirm] [<CommonParameters>]
[-HRDCookieLifetime <Int32>] [-HRDCookieEnabled <Boolean>] [-ContextCookieEnabled <Boolean>]
[-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]
```

## DESCRIPTION
The **Set-AdfsWebConfig** cmdlet modifies web customization configuration settings.
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.

The `Set-AdfsWebConfig` cmdlet modifies web customization configuration settings. 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.

## EXAMPLES

### Example 1: Set customization configuration properties

```powershell
$pSSetAdfsWebConfigSplat = @{
ActiveThemeName = "Default"
CDCCookieReader = 'https://www.Contoso.com/reader.aspx'
CDCCookieWriter = 'https://www.Contoso.com/writer.aspx'
ContextCookieEnabled = $True
HRDCookieEnabled = $True
HRDCookieLifetime = 30
}
PSSet-AdfsWebConfig @pSSetAdfsWebConfigSplat
```
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

```Output
ActiveThemeName : Default

CDCCookieReader :

CDCCookieWriter :

HRDCookieLifetime : 30

HRDCookieEnabled : True

ContextCookieEnabled : True
```

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

### -ActiveThemeName
Specifies the name of a web theme to be set as the active web theme in the web customization configuration.
To create a web theme, use the **New-AdfsWebTheme** cmdlet.

Specifies the name of a web theme to be set as the active web theme in the web customization
configuration. To create a web theme, use the `New-AdfsWebTheme` cmdlet.

```yaml
Type: String
Parameter Sets: (All)
Aliases:
Aliases:

Required: False
Position: Named
Expand All @@ -65,12 +74,13 @@ Accept wildcard characters: False
```

### -CDCCookieReader

Specifies the Uniform Resource Identifier (URI) of the Common Domain Cookie (CDC) reader.

```yaml
Type: Uri
Parameter Sets: (All)
Aliases:
Aliases:

Required: False
Position: Named
Expand All @@ -80,12 +90,13 @@ Accept wildcard characters: False
```

### -CDCCookieWriter

Specifies the URI of the CDC writer.

```yaml
Type: Uri
Parameter Sets: (All)
Aliases:
Aliases:

Required: False
Position: Named
Expand All @@ -95,12 +106,13 @@ Accept wildcard characters: False
```

### -ContextCookieEnabled

Indicates whether to enable the context cookie.

```yaml
Type: Boolean
Parameter Sets: (All)
Aliases:
Aliases:

Required: False
Position: Named
Expand All @@ -110,13 +122,15 @@ Accept wildcard characters: False
```

### -HRDCookieEnabled
Indicates whether to enable the HRD cookie.
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.

Indicates whether to enable the HRD cookie. 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.

```yaml
Type: Boolean
Parameter Sets: (All)
Aliases:
Aliases:

Required: False
Position: Named
Expand All @@ -126,12 +140,13 @@ Accept wildcard characters: False
```

### -HRDCookieLifetime

Specifies the lifetime, in days, of an HRD cookie.

```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Aliases:

Required: False
Position: Named
Expand All @@ -141,13 +156,14 @@ Accept wildcard characters: False
```

### -PassThru
Returns an object representing the item with which you are working.
By default, this cmdlet does not generate any output.

Returns an object representing the item with which you are working. By default, this cmdlet does not
generate any output.

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Aliases:

Required: False
Position: Named
Expand All @@ -157,6 +173,7 @@ Accept wildcard characters: False
```

### -Confirm

Prompts you for confirmation before running the cmdlet.

```yaml
Expand All @@ -172,8 +189,8 @@ Accept wildcard characters: False
```

### -WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.

Shows what would happen if the cmdlet runs. The cmdlet is not run.

```yaml
Type: SwitchParameter
Expand All @@ -188,16 +205,26 @@ Accept wildcard characters: False
```

### CommonParameters
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).

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).

## INPUTS

### System.String;System.String[];System.Uri;System.Int32;System.Boolean
### None

## OUTPUTS

###
This cmdlet generates string for a theme to save as the active theme.
### None

By default, this cmdlet doesn't return any output.

### AdfsWebConfig

When you use the **PassThru** parameter, this cmdlet returns an **AdfsWebConfig** object that
represents the modified configuration settings.

## NOTES

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

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

Loading