Edit

Share via

Set-EntraCustomSecurityAttributeDefinitionAllowedValue

Module:
Microsoft.Entra Module v1.1

Updates an existing custom security attribute definition predefined value.

Syntax

Default (Default) 

Set-EntraCustomSecurityAttributeDefinitionAllowedValue

    [-IsActive <Boolean>]
    -CustomSecurityAttributeDefinitionId <String>
    -Id <String>
    [<CommonParameters>]

Description

The Set-EntraCustomSecurityAttributeDefinitionAllowedValue cmdlet update a Microsoft Entra ID custom security attribute definition predefined value object identified by ID. Specify CustomSecurityAttributeDefinitionId and Id parameter to update a Microsoft Entra ID custom security attribute definition predefined value.

The signed-in user must be assigned one of the following directory roles:

  • Attribute Definition Administrator

Examples

Example 1: Update a custom security attribute definition predefined value

Connect-Entra -Scopes 'CustomSecAttributeDefinition.ReadWrite.All'
$attributeDefinition = Get-EntraCustomSecurityAttributeDefinition | Where-Object { $_.Name -eq 'Engineering' }
Set-EntraCustomSecurityAttributeDefinitionAllowedValue -CustomSecurityAttributeDefinitionId $attributeDefinition.Id -Id 'Alpine' -IsActive $true

This example update a custom security attribute definition predefined value.

  • -CustomSecurityAttributeDefinitionId parameter specifies the custom security attribute definition ID.
  • -Id parameter specifies the ID of Microsoft Entra ID Object.
  • -IsActive parameter specifies the predefined value is active or deactivated.

Parameters

-CustomSecurityAttributeDefinitionId

The unique identifier of customSecurityAttributeDefinition.

Parameter properties

Type:System.String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-Id

Indicates whether the predefined value is active or deactivated. If set to false, this predefined value cannot be assigned to any additional supported directory objects. This field is optional.

Parameter properties

Type:System.String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-IsActive

Indicates whether the predefined value is active or deactivated. If set to false, this predefined value can't be assigned to any other supported directory objects.

Parameter properties

Type:System.Boolean
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

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

System.String

Outputs

System.Object