New-EntraBetaCustomSecurityAttributeDefinition

Module:

Microsoft.Entra.Beta.DirectoryManagement Module v1.3

Create a new customSecurityAttributeDefinition object.

New-EntraBetaCustomSecurityAttributeDefinition

 -IsSearchable <Boolean>
 -IsCollection <Boolean>
 -AttributeSet <String>
 -Type <String>
 -Name <String>
 -Status <String>
 -UsePreDefinedValuesOnly <Boolean>
 [-Description <String>]
 [<CommonParameters>]

The New-EntraBetaCustomSecurityAttributeDefinition cmdlet creates a new customSecurityAttributeDefinition object. Specify IsSearchable, IsCollection, AttributeSet, Type, Name, Status and UsePreDefinedValuesOnly parameters for create a new custom security attribute definition.

You can define up to 500 active objects in a tenant.

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

• Attribute Definition Administrator

Connect-Entra -Scopes 'CustomSecAttributeDefinition.Read.All', 'CustomSecAttributeDefinition.ReadWrite.All'
$attributeSet = Get-EntraAttributeSet -Id 'ContosoSet'
$params = @{
 Name = 'ProjectTest'
 Description = 'Target completion'
 Type = 'String'
 Status = 'Available'
 AttributeSet = $attributeSet.Id
 IsCollection = $False
 IsSearchable = $True
 UsePreDefinedValuesOnly = $True
}
New-EntraBetaCustomSecurityAttributeDefinition @params

Id AttributeSet Description IsCollection IsSearchable Name Status Type UsePreDefinedValuesOnly
-- ------------ ----------- ------------ ------------ ---- ------ ---- -----------------------
Test_ProjectTest Test Target completion False True ProjectTest Available String False

This example demonstrates how to add a custom security attribute.

• -Name parameter specifies the name of the custom security attribute.
• -Description parameter specifies the description of the custom security attribute.
• -Type parameter specifies the data type for the custom security attribute values.
• -Status parameter specifies the custom security attribute is active or deactivated.
• -AttributeSet parameter specifies the name of attribute set.
• -IsCollection parameter specifies the allows multiple values can be assigned to the custom security attribute.
• -IsSearchable parameter specifies the custom security attribute values are indexed for searching on objects.
• -UsePreDefinedValuesOnly parameter specifies the only predefined values can be assigned to the custom security attribute.

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.