Update-MgAdminPeopleProfileCardProperty
Update the properties of a profileCardProperty object, identified by its directoryPropertyName property.
Note
To view the beta release of this cmdlet, view Update-MgBetaAdminPeopleProfileCardProperty
Syntax
Update-MgAdminPeopleProfileCardProperty
-ProfileCardPropertyId <String>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-Annotations <IMicrosoftGraphProfileCardAnnotation[]>]
[-DirectoryPropertyName <String>]
[-Id <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-MgAdminPeopleProfileCardProperty
-ProfileCardPropertyId <String>
-BodyParameter <IMicrosoftGraphProfileCardProperty>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-MgAdminPeopleProfileCardProperty
-InputObject <IIdentityDirectoryManagementIdentity>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-Annotations <IMicrosoftGraphProfileCardAnnotation[]>]
[-DirectoryPropertyName <String>]
[-Id <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-MgAdminPeopleProfileCardProperty
-InputObject <IIdentityDirectoryManagementIdentity>
-BodyParameter <IMicrosoftGraphProfileCardProperty>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Update the properties of a profileCardProperty object, identified by its directoryPropertyName property.
Permissions
Permission type | Least privileged permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | PeopleSettings.ReadWrite.All | Not available. |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | Not supported. | Not supported. |
Examples
Example 1: Code snippet
Import-Module Microsoft.Graph.Identity.DirectoryManagement
$params = @{
annotations = @(
@{
displayName = "Cost Center"
localizations = @(
@{
languageTag = "no"
displayName = "Kostnadssenter"
}
)
}
)
}
Update-MgAdminPeopleProfileCardProperty -ProfileCardPropertyId $profileCardPropertyId -BodyParameter $params
This example shows how to use the Update-MgAdminPeopleProfileCardProperty Cmdlet.
Parameters
-AdditionalProperties
Additional Parameters
Type: | Hashtable |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Annotations
Allows an administrator to set a custom display label for the directory property and localize it for the users in their tenant. To construct, see NOTES section for ANNOTATIONS properties and create a hash table.
Type: | IMicrosoftGraphProfileCardAnnotation[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-BodyParameter
profileCardProperty To construct, see NOTES section for BODYPARAMETER properties and create a hash table.
Type: | IMicrosoftGraphProfileCardProperty |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DirectoryPropertyName
Identifies a profileCardProperty resource in Get, Update, or Delete operations. Allows an administrator to surface hidden Microsoft Entra ID properties on the Microsoft 365 profile card within their tenant. When present, the Microsoft Entra ID field referenced in this property is visible to all users in your tenant on the contact pane of the profile card. Allowed values for this field are: UserPrincipalName, Fax, StreetAddress, PostalCode, StateOrProvince, Alias, CustomAttribute1, CustomAttribute2, CustomAttribute3, CustomAttribute4, CustomAttribute5, CustomAttribute6, CustomAttribute7, CustomAttribute8, CustomAttribute9, CustomAttribute10, CustomAttribute11, CustomAttribute12, CustomAttribute13, CustomAttribute14, CustomAttribute15.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Headers
Optional headers that will be added to the request.
Type: | IDictionary |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Id
The unique identifier for an entity. Read-only.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
Type: | IIdentityDirectoryManagementIdentity |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ProfileCardPropertyId
The unique identifier of profileCardProperty
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ProgressAction
{{ Fill ProgressAction Description }}
Type: | ActionPreference |
Aliases: | proga |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResponseHeadersVariable
Optional Response Headers Variable.
Type: | String |
Aliases: | RHV |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
Microsoft.Graph.PowerShell.Models.IIdentityDirectoryManagementIdentity
Microsoft.Graph.PowerShell.Models.IMicrosoftGraphProfileCardProperty
System.Collections.IDictionary
Outputs
Microsoft.Graph.PowerShell.Models.IMicrosoftGraphProfileCardProperty
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.
ANNOTATIONS <IMicrosoftGraphProfileCardAnnotation- []
>: Allows an administrator to set a custom display label for the directory property and localize it for the users in their tenant.
[DisplayName <String>]
: If present, the value of this field is used by the profile card as the default property label in the experience (for example, 'Cost Center').[Localizations <IMicrosoftGraphDisplayNameLocalization-
[]>]
: Each resource in this collection represents the localized value of the attribute name for a given language, used as the default label for that locale. For example, a user with a nb-NO client gets 'Kostnadssenter' as the attribute label, rather than 'Cost Center.'[DisplayName <String>]
: If present, the value of this field contains the displayName string that has been set for the language present in the languageTag field.[LanguageTag <String>]
: Provides the language culture-code and friendly name of the language that the displayName field has been provided in.
BODYPARAMETER <IMicrosoftGraphProfileCardProperty>
: profileCardProperty
[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Annotations <IMicrosoftGraphProfileCardAnnotation-
[]>]
: Allows an administrator to set a custom display label for the directory property and localize it for the users in their tenant.[DisplayName <String>]
: If present, the value of this field is used by the profile card as the default property label in the experience (for example, 'Cost Center').[Localizations <IMicrosoftGraphDisplayNameLocalization-
[]>]
: Each resource in this collection represents the localized value of the attribute name for a given language, used as the default label for that locale. For example, a user with a nb-NO client gets 'Kostnadssenter' as the attribute label, rather than 'Cost Center.'[DisplayName <String>]
: If present, the value of this field contains the displayName string that has been set for the language present in the languageTag field.[LanguageTag <String>]
: Provides the language culture-code and friendly name of the language that the displayName field has been provided in.
[DirectoryPropertyName <String>]
: Identifies a profileCardProperty resource in Get, Update, or Delete operations. Allows an administrator to surface hidden Microsoft Entra ID properties on the Microsoft 365 profile card within their tenant. When present, the Microsoft Entra ID field referenced in this property is visible to all users in your tenant on the contact pane of the profile card. Allowed values for this field are: UserPrincipalName, Fax, StreetAddress, PostalCode, StateOrProvince, Alias, CustomAttribute1, CustomAttribute2, CustomAttribute3, CustomAttribute4, CustomAttribute5, CustomAttribute6, CustomAttribute7, CustomAttribute8, CustomAttribute9, CustomAttribute10, CustomAttribute11, CustomAttribute12, CustomAttribute13, CustomAttribute14, CustomAttribute15.
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[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[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[UserId <String>]
: The unique identifier of user