Edit

Share via

New-AzureADMSCustomSecurityAttributeDefinition

  • Reference
Module:
AzureADPreview

Adds a new custom security attribute definition.

Syntax

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

Description

Adds a new Azure Active Directory (Azure AD) custom security attribute definition object.

Examples

Example

New-AzureADMSCustomSecurityAttributeDefinition -AttributeSet "Engineering" -Name "ProjectDate" -Description "Target completion date" -Type "String" -Status "Available" -IsCollection $false -IsSearchable $true -UsePreDefinedValuesOnly $true

Add a custom security attribute definition.

  • Attribute set: Engineering
  • Attribute: ProjectDate
  • Attribute data type: String

Parameters

-AttributeSet

Name of the attribute set in Azure AD.

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

-Description

Description for the custom security attribute definition.

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

-IsCollection

Indicates whether multiple values can be assigned to the custom security attribute.

Type:Boolean
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-IsSearchable

Indicates whether custom security attribute values will be indexed for searching on objects that are assigned attribute values.

Type:Boolean
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Name

Name of the custom security attribute. Must be unique within an attribute set.

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

-Status

Specifies whether the custom security attribute is active or deactivated. Acceptable values are 'Available' and 'Deprecated'.

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

-Type

Specifies the data type of the attribute.

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

-UsePreDefinedValuesOnly

Indicates whether only predefined values can be assigned to the custom security attribute. If set to false, free-form values are allowed.

Type:Boolean
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

Outputs

Object