Disable-AdfsEndpoint
Disables an endpoint of AD FS.
Syntax
Disable-AdfsEndpoint
[[-TargetAddressPath] <String>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Disable-AdfsEndpoint
[-TargetEndpoint] <Endpoint>
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Disable-AdfsEndpoint
[-TargetFullUrl] <Uri>
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Disable-AdfsEndpoint cmdlet disables an endpoint of Active Directory Federation Services (AD FS).
Examples
Example 1: Disable an endpoint
PS C:\> Disable-AdfsEndpoint -TargetAddressPath "/adfs/services/trust/13/Windows"
This command disables the WS-Trust 1.3 endpoint on the current federation server.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
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.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-TargetAddressPath
Specifies the address path of the endpoint. The cmdlet disables the endpoint that you specify. An example of such a path is /adfs/portal/updatepassword.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-TargetEndpoint
Specifies the endpoint to disable. This value is typically taken from the pipeline.
Type: | Endpoint |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-TargetFullUrl
Specifies the full URL of the endpoint to disable.
Type: | Uri |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
Microsoft.IdentityServer.PowerShell.Resources.Endpoint
A class that represents an endpoint for the Federation Service.
Outputs
None
Notes
- Endpoints provide access to the federation server functionality of AD FS, such as token issuance and the publishing of federation metadata. Depending on the type of endpoint, you can enable or disable the endpoint or control whether the endpoint is published to Web Application Proxy.