Share via

Remove-MgBetaUserProfileAward

Module:
Microsoft.Graph.Beta.People Module

Deletes a personAward object from a user's profile.

Syntax

Delete (Default) 

Remove-MgBetaUserProfileAward
    -PersonAwardId <String>
    -UserId <String>
    [-IfMatch <String>]
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

DeleteViaIdentity 

Remove-MgBetaUserProfileAward
    -InputObject <IPeopleIdentity>
    [-IfMatch <String>]
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Deletes a personAward object from a user's profile.

Permissions

Permission type Permissions (from least to most privileged)
Delegated (work or school account) User.ReadWrite, User.ReadWrite.All,
Delegated (personal Microsoft account) User.ReadWrite,
Application User.ReadWrite.All,

Examples

Example 1: Code snippet


Import-Module Microsoft.Graph.Beta.People

Remove-MgBetaUserProfileAward -UserId $userId -PersonAwardId $personAwardId

This example shows how to use the Remove-MgBetaUserProfileAward Cmdlet.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Headers

Optional headers that will be added to the request.

Parameter properties

Type:IDictionary
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-IfMatch

ETag

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Parameter properties

Type:IPeopleIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

DeleteViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-PassThru

Returns true when the command succeeds

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PersonAwardId

The unique identifier of personAward

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Delete
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResponseHeadersVariable

Optional Response Headers Variable.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:RHV

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-UserId

The unique identifier of user

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Delete
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

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.Beta.PowerShell.Models.IPeopleIdentity

System.Collections.IDictionary

Outputs

System.Boolean

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.

INPUTOBJECT <IPeopleIdentity>: Identity Parameter

  • [ActivityStatisticsId <String>]: The unique identifier of activityStatistics
  • [EducationalActivityId <String>]: The unique identifier of educationalActivity
  • [ItemAddressId <String>]: The unique identifier of itemAddress
  • [ItemEmailId <String>]: The unique identifier of itemEmail
  • [ItemPatentId <String>]: The unique identifier of itemPatent
  • [ItemPhoneId <String>]: The unique identifier of itemPhone
  • [ItemPublicationId <String>]: The unique identifier of itemPublication
  • [LanguageProficiencyId <String>]: The unique identifier of languageProficiency
  • [PersonAnnotationId <String>]: The unique identifier of personAnnotation
  • [PersonAnnualEventId <String>]: The unique identifier of personAnnualEvent
  • [PersonAwardId <String>]: The unique identifier of personAward
  • [PersonCertificationId <String>]: The unique identifier of personCertification
  • [PersonId <String>]: The unique identifier of person
  • [PersonInterestId <String>]: The unique identifier of personInterest
  • [PersonNameId <String>]: The unique identifier of personName
  • [PersonWebsiteId <String>]: The unique identifier of personWebsite
  • [ProjectParticipationId <String>]: The unique identifier of projectParticipation
  • [SkillProficiencyId <String>]: The unique identifier of skillProficiency
  • [UserAccountInformationId <String>]: The unique identifier of userAccountInformation
  • [UserId <String>]: The unique identifier of user
  • [WebAccountId <String>]: The unique identifier of webAccount
  • [WorkPositionId <String>]: The unique identifier of workPosition