Remove-AdfsWebApiApplication
Removes a Web API application role from an application in AD FS.
Syntax
Remove-AdfsWebApiApplication
[-TargetIdentifier] <String>
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Remove-AdfsWebApiApplication
[-TargetName] <String>
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>] 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).
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 |
-TargetApplication
Specifies the Web API application to remove.
| Type: | WebApiApplication |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-TargetIdentifier
Specifies the ID of the Web API application to remove.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-TargetName
Specifies the name of the Web API application to remove.
| Type: | String |
| 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
WebApiApplication objects are received by the 'TargetApplication' parameter.
String objects are received by the TargetIdentifier and TargetName parameters.
Outputs
Returns the removed WebApiApplication object when the PassThru parameter is specified. By default, this cmdlet does not generate any output.