Export (0) Print
Expand All

Set-ADFSClaimDescription

Set-ADFSClaimDescription

Sets the properties of an existing claim description.

Syntax

Parameter Set: Identifier
Set-ADFSClaimDescription [-TargetClaimType] <String> [-ClaimType <String> ] [-IsAccepted <Boolean> ] [-IsOffered <Boolean> ] [-IsRequired <Boolean> ] [-Name <String> ] [-Notes <String> ] [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: InputObject
Set-ADFSClaimDescription [-TargetClaimDescription] <ClaimDescription> [-ClaimType <String> ] [-IsAccepted <Boolean> ] [-IsOffered <Boolean> ] [-IsRequired <Boolean> ] [-Name <String> ] [-Notes <String> ] [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: Name
Set-ADFSClaimDescription [-TargetName] <String> [-ClaimType <String> ] [-IsAccepted <Boolean> ] [-IsOffered <Boolean> ] [-IsRequired <Boolean> ] [-Name <String> ] [-Notes <String> ] [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Set-ADFSClaimDescription cmdlet sets properties on an existing AD FS claim description.

Parameters

-ClaimType<String>

Specifies the claim type URI of the claim.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-IsAccepted<Boolean>

Specifies that the claim should be published in federation metadata as a claim that is accepted by the federation service.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-IsOffered<Boolean>

Specifies that the claim should be published in federation metadata as a claim that is offered by the federation service.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-IsRequired<Boolean>

Specifies that the claim should be published in federation metadata as a claim that is required by the federation service.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Name<String>

Specifies the friendly name of this claim.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Notes<String>

Specifies any notes for this claim description.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PassThru

Passes an object to the pipeline. By default, this cmdlet does not generate any output.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-TargetClaimDescription<ClaimDescription>

Specifies the claim description that will be modified by the cmdlet. This value is typically taken from the pipeline.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-TargetClaimType<String>

Specifies the claim type of the claim description that will be modified by the cmdlet.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-TargetName<String>

Specifies the friendly name of the claim description that will be modified by the cmdlet.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


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.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • Microsoft.IdentityServer.PowerShell.Resources.ClaimDescription



    A class structure for representing a claim description object for the Federation Service.



Outputs

The output type is the type of the objects that the cmdlet emits.

  • None

Notes

  • 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


Examples

-------------------------- EXAMPLE 1 --------------------------

Description

-----------

Sets a new name for the "Role" claim description.


C:\PS>Set-ADFSClaimDescription -TargetName "Role" -Name "New Role Claim Name"

Related topics


Add-ADFSClaimDescription

Get-ADFSClaimDescription

Remove-ADFSClaimDescription

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft