Remove-AdfsWebApiApplication.md

description	external help file	Module Name	ms.date	online version	schema	title
Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.	Microsoft.IdentityServer.Management.dll-Help.xml	ADFS	12/20/2016	https://learn.microsoft.com/powershell/module/adfs/remove-adfswebapiapplication?view=windowsserver2022-ps&wt.mc_id=ps-gethelp	2.0.0	Remove-AdfsWebApiApplication

Remove-AdfsWebApiApplication

SYNOPSIS

Removes a Web API application role from an application in AD FS.

SYNTAX

Identifier (Default)

Remove-AdfsWebApiApplication [-TargetIdentifier] <String> [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]

Name

Remove-AdfsWebApiApplication [-TargetName] <String> [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]

ApplicationObject

Remove-AdfsWebApiApplication [-TargetApplication] <WebApiApplication> [-PassThru] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

The Remove-AdfsWebApiApplication cmdlet removes a Web API application role from an application in Active Directory Federation Services (AD FS).

EXAMPLES

PARAMETERS

-PassThru

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TargetApplication

Specifies the Web API application to remove.

Type: WebApiApplication
Parameter Sets: ApplicationObject
Aliases: 

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-TargetIdentifier

Specifies the ID of the Web API application to remove.

Type: String
Parameter Sets: Identifier
Aliases: 

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-TargetName

Specifies the name of the Web API application to remove.

Type: String
Parameter Sets: Name
Aliases: 

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: False
Accept pipeline input: False
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.

INPUTS

Microsoft.IdentityServer.Management.Resources.WebApiApplication

WebApiApplication objects are received by the 'TargetApplication' parameter.

System.String

String objects are received by the TargetIdentifier and TargetName parameters.

OUTPUTS

Microsoft.IdentityServer.Management.Resources.WebApiApplication

Returns the removed WebApiApplication object when the PassThru parameter is specified. By default, this cmdlet does not generate any output.

NOTES

RELATED LINKS

Add-AdfsWebApiApplication

Get-AdfsWebApiApplication

Set-AdfsWebApiApplication