Set-AdfsClaimDescription

Set-AdfsClaimDescription

Modifies the properties of a claim description.

Sintaxis

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>]

Descripción detallada

The Set-AdfsClaimDescription cmdlet modifies properties on a Servicios de federación de Active Directory (AD FS) claim description.

Parámetros

-ClaimType<String>

Specifies the claim type URI of the claim.

-IsAccepted<Boolean>

Indicates whether the claim is published in federation metadata as a claim that is accepted by the federation service.

-IsOffered<Boolean>

Indicates whether the claim is published in federation metadata as a claim that is offered by the federation service.

-IsRequired<Boolean>

Indicates whether the claim is published in federation metadata as a claim that is required by the federation service.

-Name<String>

Specifies the friendly name of the claim to modify.

-Notes<String>

Specifies text that describes the purpose of the claim description. The cmdlet adds the notes to the claim description.

-PassThru

Devuelve un objeto que representa el elemento con el que está trabajando. De forma predeterminada, este cmdlet no genera ningún resultado.

-TargetClaimDescription<ClaimDescription>

Specifies a ClaimDescription object. The cmdlet modifies the ClaimDescription object that you specify. To obtain a claim description, use the Get-AdfsClaimDescription cmdlet.

-TargetClaimType<String>

Specifies the claim type of the claim description to modify.

-TargetName<String>

Specifies the friendly name of the claim description to modify.

-Confirm

Solicita confirmación antes de ejecutar el cmdlet.

-WhatIf

Muestra lo que sucedería si se ejecutara el cmdlet. El cmdlet no se ejecuta.

<CommonParameters>

Este cmdlet admite los siguientes parámetros comunes: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer y -OutVariable. Para obtener más información, consulte about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Entradas

El tipo de entrada es el tipo de los objetos que se pueden canalizar al cmdlet.

• Microsoft.IdentityServer.PowerShell.Resources.ClaimDescription

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

Salidas

El tipo de resultado es el tipo de objetos que emite el cmdlet.

• None

Notas

• 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 to modify. Because these parameters are positional, you do not have to specify their name. Therefore, the following commands are identical in effect. The commands change the RelyingParty object named RP1 to RP2

  Set-ADFSRelyingParty -TargetName RP1Name -Name RP2Name
  Set-ADFSRelyingParty RP1Name -Name RP2Name

Ejemplos

Example 1: Change the name of a claim description

This command changes the name of the claim description named Role to RoleDesc.

PS C:\> Set-AdfsClaimDescription -TargetName "Role" -Name "RoleDesc"

Temas relacionados

Add-AdfsClaimDescription

Get-AdfsClaimDescription

Remove-AdfsClaimDescription