Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Update-MgDirectoryCustomSecurityAttributeDefinition
Update the properties of a customSecurityAttributeDefinition object.
Note
To view the beta release of this cmdlet, view Update-MgBetaDirectoryCustomSecurityAttributeDefinition
Syntax
UpdateExpanded (Default)
Update-MgDirectoryCustomSecurityAttributeDefinition
-CustomSecurityAttributeDefinitionId <string>
[-ResponseHeadersVariable <string>]
[-AdditionalProperties <hashtable>]
[-AllowedValues <IMicrosoftGraphAllowedValue[]>]
[-AttributeSet <string>]
[-Description <string>]
[-Id <string>]
[-IsCollection]
[-IsSearchable]
[-Name <string>]
[-Status <string>]
[-Type <string>]
[-UsePreDefinedValuesOnly]
[-Break]
[-Headers <IDictionary>]
[-HttpPipelineAppend <SendAsyncStep[]>]
[-HttpPipelinePrepend <SendAsyncStep[]>]
[-Proxy <uri>]
[-ProxyCredential <pscredential>]
[-ProxyUseDefaultCredentials]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update
Update-MgDirectoryCustomSecurityAttributeDefinition
-CustomSecurityAttributeDefinitionId <string>
-BodyParameter <IMicrosoftGraphCustomSecurityAttributeDefinition>
[-ResponseHeadersVariable <string>]
[-Break]
[-Headers <IDictionary>]
[-HttpPipelineAppend <SendAsyncStep[]>]
[-HttpPipelinePrepend <SendAsyncStep[]>]
[-Proxy <uri>]
[-ProxyCredential <pscredential>]
[-ProxyUseDefaultCredentials]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaIdentityExpanded
Update-MgDirectoryCustomSecurityAttributeDefinition
-InputObject <IIdentityDirectoryManagementIdentity>
[-ResponseHeadersVariable <string>]
[-AdditionalProperties <hashtable>]
[-AllowedValues <IMicrosoftGraphAllowedValue[]>]
[-AttributeSet <string>]
[-Description <string>]
[-Id <string>]
[-IsCollection]
[-IsSearchable]
[-Name <string>]
[-Status <string>]
[-Type <string>]
[-UsePreDefinedValuesOnly]
[-Break]
[-Headers <IDictionary>]
[-HttpPipelineAppend <SendAsyncStep[]>]
[-HttpPipelinePrepend <SendAsyncStep[]>]
[-Proxy <uri>]
[-ProxyCredential <pscredential>]
[-ProxyUseDefaultCredentials]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaIdentity
Update-MgDirectoryCustomSecurityAttributeDefinition
-InputObject <IIdentityDirectoryManagementIdentity>
-BodyParameter <IMicrosoftGraphCustomSecurityAttributeDefinition>
[-ResponseHeadersVariable <string>]
[-Break]
[-Headers <IDictionary>]
[-HttpPipelineAppend <SendAsyncStep[]>]
[-HttpPipelinePrepend <SendAsyncStep[]>]
[-Proxy <uri>]
[-ProxyCredential <pscredential>]
[-ProxyUseDefaultCredentials]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Update the properties of a customSecurityAttributeDefinition object.
Permissions
| Permission type | Permissions (from least to most privileged) |
|---|---|
| Delegated (work or school account) | CustomSecAttributeDefinition.ReadWrite.All, |
| Delegated (personal Microsoft account) | Not supported |
| Application | CustomSecAttributeDefinition.ReadWrite.All, |
Examples
Example 1: Update a custom security attribute
Import-Module Microsoft.Graph.Identity.DirectoryManagement
$params = @{
description = "Target completion date (YYYY/MM/DD)"
}
Update-MgDirectoryCustomSecurityAttributeDefinition -CustomSecurityAttributeDefinitionId $customSecurityAttributeDefinitionId -BodyParameter $params
This example will update a custom security attribute
Example 2: Update the predefined values for a custom security attribute
Import-Module Microsoft.Graph.Identity.DirectoryManagement
$params = @{
"allowedValues@delta" = @(
@{
id = "Baker"
isActive = $false
}
@{
id = "Skagit"
isActive = $true
}
)
}
Update-MgDirectoryCustomSecurityAttributeDefinition -CustomSecurityAttributeDefinitionId $customSecurityAttributeDefinitionId -BodyParameter $params
This example will update the predefined values for a custom security attribute
Example 3: Deactivate a custom security attribute
Import-Module Microsoft.Graph.Identity.DirectoryManagement
$params = @{
status = "Deprecated"
}
Update-MgDirectoryCustomSecurityAttributeDefinition -CustomSecurityAttributeDefinitionId $customSecurityAttributeDefinitionId -BodyParameter $params
This example will deactivate a custom security attribute
Parameters
-AdditionalProperties
Additional Parameters
Parameter properties
| Type: | System.Collections.Hashtable |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-AllowedValues
Values that are predefined for this custom security attribute. This navigation property is not returned by default and must be specified in an $expand query. For example, /directory/customSecurityAttributeDefinitions$expand=allowedValues. To construct, see NOTES section for ALLOWEDVALUES properties and create a hash table.
Parameter properties
| Type: | Microsoft.Graph.PowerShell.Models.IMicrosoftGraphAllowedValue[] |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-AttributeSet
Name of the attribute set. Case insensitive.
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-BodyParameter
customSecurityAttributeDefinition To construct, see NOTES section for BODYPARAMETER properties and create a hash table.
Parameter properties
| Type: | Microsoft.Graph.PowerShell.Models.IMicrosoftGraphCustomSecurityAttributeDefinition |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Break
Wait for .NET debugger to attach
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
-CustomSecurityAttributeDefinitionId
The unique identifier of customSecurityAttributeDefinition
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Description
Description of the custom security attribute. Can be up to 128 characters long and include Unicode characters. Can be changed later.
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Headers
Optional headers that will be added to the request.
Parameter properties
| Type: | System.Collections.IDictionary |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-HttpPipelineAppend
SendAsync Pipeline Steps to be appended to the front of the pipeline
Parameter properties
| Type: | Microsoft.Graph.PowerShell.Runtime.SendAsyncStep[] |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-HttpPipelinePrepend
SendAsync Pipeline Steps to be prepended to the front of the pipeline
Parameter properties
| Type: | Microsoft.Graph.PowerShell.Runtime.SendAsyncStep[] |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Id
The unique identifier for an entity. Read-only.
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
Parameter properties
| Type: | Microsoft.Graph.PowerShell.Models.IIdentityDirectoryManagementIdentity |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-IsCollection
Indicates whether multiple values can be assigned to the custom security attribute. Cannot be changed later. If type is set to Boolean, isCollection cannot be set to true.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-IsSearchable
Indicates whether custom security attribute values are indexed for searching on objects that are assigned attribute values. Cannot be changed later.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Name
Name of the custom security attribute. Must be unique within an attribute set. Can be up to 32 characters long and include Unicode characters. Cannot contain spaces or special characters. Cannot be changed later. Case insensitive.
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Proxy
The URI for the proxy server to use
Parameter properties
| Type: | System.Uri |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ProxyCredential
Credentials for a proxy server to use for the remote call
Parameter properties
| Type: | System.Management.Automation.PSCredential |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ProxyUseDefaultCredentials
Use the default credentials for the proxy
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ResponseHeadersVariable
Optional Response Headers Variable.
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | RHV |
Parameter sets
-Status
Specifies whether the custom security attribute is active or deactivated. Acceptable values are: Available and Deprecated. Can be changed later.
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Type
Data type for the custom security attribute values. Supported types are: Boolean, Integer, and String. Cannot be changed later.
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-UsePreDefinedValuesOnly
Indicates whether only predefined values can be assigned to the custom security attribute. If set to false, free-form values are allowed. Can later be changed from true to false, but cannot be changed from false to true. If type is set to Boolean, usePreDefinedValuesOnly cannot be set to true.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-WhatIf
Runs the command in a mode that only reports what would happen without performing the actions.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
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
Microsoft.Graph.PowerShell.Models.IIdentityDirectoryManagementIdentity
{{ Fill in the Description }}
Microsoft.Graph.PowerShell.Models.IMicrosoftGraphCustomSecurityAttributeDefinition
{{ Fill in the Description }}
System.Collections.IDictionary
{{ Fill in the Description }}
Outputs
Microsoft.Graph.PowerShell.Models.IMicrosoftGraphCustomSecurityAttributeDefinition
{{ Fill in the Description }}
Notes
COMPLEX PARAMETER PROPERTIES
To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.
ALLOWEDVALUES <IMicrosoftGraphAllowedValue[]>: Values that are predefined for this custom security attribute. This navigation property is not returned by default and must be specified in an $expand query. For example, /directory/customSecurityAttributeDefinitions$expand=allowedValues. [Id <String>]: The unique identifier for an entity. Read-only. [IsActive <Boolean?>]: 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.
BODYPARAMETER <IMicrosoftGraphCustomSecurityAttributeDefinition>: customSecurityAttributeDefinition
[(Any) <Object>]: This indicates any property can be added to this object.
[Id <String>]: The unique identifier for an entity.
Read-only.
[AllowedValues <IMicrosoftGraphAllowedValue[]>]: Values that are predefined for this custom security attribute.
This navigation property is not returned by default and must be specified in an $expand query.
For example, /directory/customSecurityAttributeDefinitions?$expand=allowedValues.
[Id <String>]: The unique identifier for an entity.
Read-only.
[IsActive <Boolean?>]: 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.
[AttributeSet <String>]: Name of the attribute set.
Case insensitive.
[Description <String>]: Description of the custom security attribute.
Can be up to 128 characters long and include Unicode characters.
Can be changed later.
[IsCollection <Boolean?>]: Indicates whether multiple values can be assigned to the custom security attribute.
Cannot be changed later.
If type is set to Boolean, isCollection cannot be set to true.
[IsSearchable <Boolean?>]: Indicates whether custom security attribute values are indexed for searching on objects that are assigned attribute values.
Cannot be changed later.
[Name <String>]: Name of the custom security attribute.
Must be unique within an attribute set.
Can be up to 32 characters long and include Unicode characters.
Cannot contain spaces or special characters.
Cannot be changed later.
Case insensitive.
[Status <String>]: Specifies whether the custom security attribute is active or deactivated.
Acceptable values are: Available and Deprecated.
Can be changed later.
[Type <String>]: Data type for the custom security attribute values.
Supported types are: Boolean, Integer, and String.
Cannot be changed later.
[UsePreDefinedValuesOnly <Boolean?>]: Indicates whether only predefined values can be assigned to the custom security attribute.
If set to false, free-form values are allowed.
Can later be changed from true to false, but cannot be changed from false to true.
If type is set to Boolean, usePreDefinedValuesOnly cannot be set to true.
INPUTOBJECT <IIdentityDirectoryManagementIdentity>: Identity Parameter
[AdministrativeUnitId <String>]: The unique identifier of administrativeUnit
[AllowedValueId <String>]: The unique identifier of allowedValue
[AttributeSetId <String>]: The unique identifier of attributeSet
[CertificateAuthorityDetailId <String>]: The unique identifier of certificateAuthorityDetail
[CertificateBasedAuthPkiId <String>]: The unique identifier of certificateBasedAuthPki
[CommerceSubscriptionId <String>]: Alternate key of companySubscription
[CompanySubscriptionId <String>]: The unique identifier of companySubscription
[ContractId <String>]: The unique identifier of contract
[CustomSecurityAttributeDefinitionId <String>]: The unique identifier of customSecurityAttributeDefinition
[DeviceId <String>]: The unique identifier of device
[DeviceLocalCredentialInfoId <String>]: The unique identifier of deviceLocalCredentialInfo
[DirectoryObjectId <String>]: The unique identifier of directoryObject
[DirectoryRoleId <String>]: The unique identifier of directoryRole
[DirectoryRoleTemplateId <String>]: The unique identifier of directoryRoleTemplate
[DomainDnsRecordId <String>]: The unique identifier of domainDnsRecord
[DomainId <String>]: The unique identifier of domain
[DomainName <String>]: Usage: domainName='{domainName}'
[ExtensionId <String>]: The unique identifier of extension
[IdentityProviderBaseId <String>]: The unique identifier of identityProviderBase
[InternalDomainFederationId <String>]: The unique identifier of internalDomainFederation
[OnPremisesDirectorySynchronizationId <String>]: The unique identifier of onPremisesDirectorySynchronization
[OrgContactId <String>]: The unique identifier of orgContact
[OrganizationId <String>]: The unique identifier of organization
[OrganizationalBrandingLocalizationId <String>]: The unique identifier of organizationalBrandingLocalization
[ProfileCardPropertyId <String>]: The unique identifier of profileCardProperty
[RoleTemplateId <String>]: Alternate key of directoryRole
[ScopedRoleMembershipId <String>]: The unique identifier of scopedRoleMembership
[SubscribedSkuId <String>]: The unique identifier of subscribedSku
[TenantId <String>]: Usage: tenantId='{tenantId}'
[UserId <String>]: The unique identifier of user
