Editar

Partilhar via

Disable-AdfsEndpoint

Module:
ADFS Module

Disables an endpoint of AD FS.

Syntax

Address 

Disable-AdfsEndpoint
    [[-TargetAddressPath] <String>]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

TargetObject 

Disable-AdfsEndpoint
    [-TargetEndpoint] <Endpoint>
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

FullUrl 

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.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PassThru

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Address
Position:0
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-TargetEndpoint

Specifies the endpoint to disable. This value is typically taken from the pipeline.

Parameter properties

Type:Endpoint
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

TargetObject
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-TargetFullUrl

Specifies the full URL of the endpoint to disable.

Parameter properties

Type:Uri
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

FullUrl
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

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.