Remove-ADFSClaimDescription
Remove-ADFSClaimDescription
Removes a claim description from the Federation Service.
Syntax
Remove-ADFSClaimDescription [-TargetClaimType] <Uri[]> [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>]
TargetClaimType
PassThru
Confirm
WhatIf
Remove-ADFSClaimDescription [-TargetClaimDescription] <ClaimDescription[]> [-PassThru] [-Confirm] [-WhatIf] []
TargetClaimDescription
PassThru
Confirm
WhatIf
Remove-ADFSClaimDescription [-TargetName] <string[]> [-PassThru] [-Confirm] [-WhatIf] []
TargetName
PassThru
Confirm
WhatIf
Detailed Description
The Remove-ADFSClaimDescription cmdlet removes a claim description from the Federation Service.
Parameters
PassThru
Passes an object to the pipeline. By default, this cmdlet does not generate any output.
Default Value: **
Data Type: SwitchParameter
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
false |
variableLength |
Accept wildcard characters? |
false |
globbing |
Accept Pipeline Input? |
false |
pipelineInput |
Position? |
named |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
false |
variableLength |
TargetClaimDescription
Specifies the claim description to remove. This value is typically taken from the pipeline.
Default Value: **
Data Type: ClaimDescription[]
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
required |
Variable Length? |
true |
variableLength |
Accept wildcard characters? |
false |
globbing |
Accept Pipeline Input? |
true (ByValue) |
pipelineInput |
Position? |
1 |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
required |
Variable Length? |
true |
variableLength |
TargetClaimType
Specifies the claim type of the claim description to remove.
Default Value: **
Data Type: Uri[]
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
required |
Variable Length? |
true |
variableLength |
Accept wildcard characters? |
false |
globbing |
Accept Pipeline Input? |
true (ByValue) |
pipelineInput |
Position? |
1 |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
required |
Variable Length? |
true |
variableLength |
TargetName
Specifies the name of the claim description to remove.
Default Value: **
Data Type: string[]
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
required |
Variable Length? |
true |
variableLength |
Accept wildcard characters? |
false |
globbing |
Accept Pipeline Input? |
true (ByValue) |
pipelineInput |
Position? |
1 |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
required |
Variable Length? |
true |
variableLength |
Confirm
Prompts you for confirmation before executing the command.
Default Value: **
Data Type: SwitchParameter
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
true |
variableLength |
Accept wildcard characters? |
false |
globbing |
Accept Pipeline Input? |
false |
pipelineInput |
Position? |
named |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
false |
variableLength |
WhatIf
Describes what would happen if you executed the command without actually executing the command.
Default Value: **
Data Type: SwitchParameter
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
true |
variableLength |
Accept wildcard characters? |
false |
globbing |
Accept Pipeline Input? |
false |
pipelineInput |
Position? |
named |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
false |
variableLength |
Input Type
Microsoft.IdentityServer.PowerShell.Resources.ClaimDescription
A class structure that represents a claim description object for the Federation Service.
Return Type
None
Notes
- Claim descriptions are used to configure the list of claims that are available to be offered or accepted by the Federation Service.
Examples
-------------------------- EXAMPLE 1 --------------------------
Command Prompt: C:\PS>
Remove-ADFSClaimDescription -TargetName "Role"
Description
-----------
Removes the "Role" claim description.
See Also
Reference
Add-ADFSClaimDescription
Get-ADFSClaimDescription
Set-ADFSClaimDescription