Edit

Share via

Get-EntraCustomSecurityAttributeDefinitionAllowedValue

  • Reference
Module:
Microsoft.Graph.Entra

Gets the predefined value for a custom security attribute definition.

Syntax

Get-EntraCustomSecurityAttributeDefinitionAllowedValue
   -CustomSecurityAttributeDefinitionId <String>
   [-Filter <String>]
   [<CommonParameters>]
Get-EntraCustomSecurityAttributeDefinitionAllowedValue
   -CustomSecurityAttributeDefinitionId <String>
   -Id <String>
   [<CommonParameters>]

Description

The Get-EntraCustomSecurityAttributeDefinitionAllowedValue cmdley gets the predefined value for a Microsoft Entra ID custom security attribute definition. Specify CustomSecurityAttributeDefinitionId parameter to get the predefined value custom security attribute definition.

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

  • Attribute Definition Reader
  • Attribute Definition Administrator

Examples

Example 1: Get all predefined values

Connect-Entra -Scopes 'CustomSecAttributeDefinition.ReadWrite.All'
$CustomSecurityAttributeDefinition  = Get-EntraCustomSecurityAttributeDefinition -Id '<attributename_attributedefinition>'
Get-EntraCustomSecurityAttributeDefinitionAllowedValue -CustomSecurityAttributeDefinitionId $CustomSecurityAttributeDefinition.Id

Id    IsActive
--    --------
Apline True

This example retrieves an all predefined values.

  • -CustomSecurityAttributeDefinitionId parameter specifies the custom security attribute definition ID. You can use Get-EntraBetaCustomSecurityAttributeDefinition to get this value.

Example 2: Get predefined value with ID parameter

Connect-Entra -Scopes 'CustomSecAttributeDefinition.ReadWrite.All'
$CustomSecurityAttributeDefinition  = Get-EntraCustomSecurityAttributeDefinition -Id '<attributename_attributedefinition>'
$params = @{
    CustomSecurityAttributeDefinitionId = $CustomSecurityAttributeDefinition.Id
    Id = 'Alpine'
}
Get-EntraCustomSecurityAttributeDefinitionAllowedValue @params

id      isActive
--      --------
Apline      True

This example retrieves a specific predefined value.

  • -CustomSecurityAttributeDefinitionId parameter specifies the custom security attribute definition ID. You can use Get-EntraBetaCustomSecurityAttributeDefinition to get this value.
  • -Id parameter specifies the ID of Microsoft Entra ID Object.

Example 3: Get predefined value with Filter parameter

Connect-Entra -Scopes 'CustomSecAttributeDefinition.ReadWrite.All'
$CustomSecurityAttributeDefinition  = Get-EntraCustomSecurityAttributeDefinition -Id '<attributename_attributedefinition>'
$params = @{
    CustomSecurityAttributeDefinitionId = $CustomSecurityAttributeDefinition.Id
    Filter = "Id eq 'Apline'"
}
Get-EntraCustomSecurityAttributeDefinitionAllowedValue @params

id      isActive
--      --------
Apline      True

This example Get a predefined value with Filter.

  • -CustomSecurityAttributeDefinitionId parameter specifies the custom security attribute definition ID. You can use Get-EntraBetaCustomSecurityAttributeDefinition to get this value.

Parameters

-CustomSecurityAttributeDefinitionId

The unique identifier of a custom security attribute definition in Microsoft Entra ID.

Type:System.String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Filter

Filter items by property values.

Type:System.String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Id

The unique identifier for the predefined value, which can be up to 64 characters long and include Unicode characters. Spaces are allowed, but some special characters are not. This identifier is case sensitive, cannot be changed later, and is required.

Type:System.String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Inputs

System.String

Outputs

System.Object