Remove-AdfsWebApiApplication
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).
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 |
-TargetApplication
Specifies the Web API application to remove.
Parameter properties
| Type: | WebApiApplication |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ApplicationObject
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TargetIdentifier
Specifies the ID of the Web API application to remove.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Identifier
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-TargetName
Specifies the name of the Web API application to remove.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Name
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| 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
WebApiApplication
WebApiApplication objects are received by the 'TargetApplication' parameter.
String
String objects are received by the TargetIdentifier and TargetName parameters.
Outputs
WebApiApplication
Returns the removed WebApiApplication object when the PassThru parameter is specified. By default, this cmdlet does not generate any output.