Condividi tramite


Disable-ADFSEndpoint

Disable-ADFSEndpoint

Disables an endpoint of the Federation Service.

Syntax

Parameter Set: Address
Disable-ADFSEndpoint [[-TargetAddressPath] <String> ] [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: FullUrl
Disable-ADFSEndpoint [-TargetFullUrl] <Uri> [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: TargetObject
Disable-ADFSEndpoint [-TargetEndpoint] <Endpoint> [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Disable-ADFSEndpoint cmdlet disables an endpoint of the Federation Service.

Parameters

-PassThru

Passes an object to the pipeline. By default, this cmdlet does not generate any output.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-TargetAddressPath<String>

Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-TargetEndpoint<Endpoint>

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

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-TargetFullUrl<Uri>

Specifies the full URL of the endpoint to disable.

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

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

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • Microsoft.IdentityServer.PowerShell.Resources.Endpoint

    A class that represents an endpoint for the Federation Service.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • None

Notes

  • Endpoints provide access to the federation server functionality of Active Directory Federation Services (AD FS) 2.0, such as token issuance, Information Card 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 AD FS 2.0 proxies.

Examples

-------------------------- EXAMPLE 1 --------------------------

Description

-----------

Disables the WS-Trust 1.3 endpoint on the current federation server.

C:\PS>Disable-ADFSEndpoint -TargetAddress /adfs/services/trust/13/Windows

Enable-ADFSEndpoint

Get-ADFSEndpoint

Set-ADFSEndpoint