Set-ADFSClaimDescription
Sets the properties of an existing claim description.
Set-ADFSClaimDescription [-TargetClaimDescription] <ClaimDescription> [-ClaimType <Uri>] [-IsAccepted <Boolean>] [-IsOffered <Boolean>] [-IsRequired <Boolean>] [-Name <string>] [-Notes <string>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>]
TargetClaimDescription
ClaimType
IsAccepted
IsOffered
IsRequired
Name
Notes
PassThru
Confirm
WhatIf
Set-ADFSClaimDescription [-TargetClaimType] <Uri[]> [-ClaimType ] [-IsAccepted ] [-IsOffered ] [-IsRequired ] [-Name ] [-Notes ] [-PassThru] [-Confirm] [-WhatIf] []
TargetClaimType
ClaimType
IsAccepted
IsOffered
IsRequired
Name
Notes
PassThru
Confirm
WhatIf
Set-ADFSClaimDescription [-TargetName] <string[]> [-ClaimType ] [-IsAccepted ] [-IsOffered ] [-IsRequired ] [-Name ] [-Notes ] [-PassThru] [-Confirm] [-WhatIf] []
TargetName
ClaimType
IsAccepted
IsOffered
IsRequired
Name
Notes
PassThru
Confirm
WhatIf
The Set-ADFSClaimDescription cmdlet sets properties on an existing AD FS claim description.
Specifies the claim type URI of the claim.
Default Value: **
Data Type: Uri
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? |
true |
required |
Variable Length? |
false |
variableLength |
Specifies that the claim should be published in federation metadata as a claim that is accepted by the federation service.
Default Value: **
Data Type: Boolean
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? |
true |
required |
Variable Length? |
false |
variableLength |
Specifies that the claim should be published in federation metadata as a claim that is offered by the federation service.
Default Value: **
Data Type: Boolean
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? |
true |
required |
Variable Length? |
false |
variableLength |
Specifies that the claim should be published in federation metadata as a claim that is required by the federation service.
Default Value: **
Data Type: Boolean
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? |
true |
required |
Variable Length? |
false |
variableLength |
Specifies the friendly name of this claim.
Default Value: **
Data Type: string
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? |
true |
required |
Variable Length? |
false |
variableLength |
Specifies any notes for this claim description.
Default Value: **
Data Type: string
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? |
true |
required |
Variable Length? |
false |
variableLength |
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 |
Specifies the claim description that will be modified by the cmdlet. This value is typically taken from the pipeline.
Default Value: **
Data Type: ClaimDescription
Attributes
Name | Value | PSMAML Attribute |
---|---|---|
Required? |
true |
required |
Variable Length? |
false |
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? |
false |
variableLength |
Specifies the claim type of the claim description that will be modified by the cmdlet.
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 |
Specifies the friendly name of the claim description that will be modified by the cmdlet.
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 |
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 |
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 |
A class structure for representing a claim description object for the Federation Service.
- All Set-* cmdlets have a positional parameter (at position 0) with a name that starts with Target*. This parameter defines the search criteria (and the parameter set). For example, Set-ADFSRelyingParty has the parameters TargetName, TargetIdentifierUri, and TargetRelyingParty. You can use only one of these Target* parameters to identify which RelyingParty will be modified. Because these parameters are positional, their name does not have be specified. Therefore, the following commands are identical in effect.
Changes the RelyingParty object whose name is RP1, setting its name to RP2 Set-ADFSRelyingParty -TargetName RP1Name -Name RP2Name OR Set-ADFSRelyingParty RP1Name -Name RP2Name
Command Prompt: C:\PS>
Set-ADFSClaimDescription -TargetName "Role" -Name "New Role Claim Name"
Description
-----------
Sets a new name for the "Role" claim description.
Add-ADFSClaimDescription
Get-ADFSClaimDescription
Remove-ADFSClaimDescription