Skip to content

Set-EntraBetaUserLicense.md

Latest commit

 

History

History
213 lines (168 loc) · 6.5 KB

Set-EntraBetaUserLicense.md

File metadata and controls

213 lines (168 loc) · 6.5 KB
Raw
title Set-EntraBetaUserLicense
description This article provides details on the Set-EntraBetaUserLicense command.
ms.topic reference
ms.date 07/26/2024
ms.author eunicewaweru
ms.reviewer stevemutungi
manager CelesteDG
author msewaweru
external help file Microsoft.Graph.Entra.Beta-Help.xml
Module Name Microsoft.Graph.Entra.Beta
online version https://learn.microsoft.com/powershell/module/Microsoft.Graph.Entra.Beta/Set-EntraBetaUserLicense
schema 2.0.0

Set-EntraBetaUserLicense

Synopsis

Adds or removes licenses for a Microsoft online service to the list of assigned licenses for a user.

Syntax

Set-EntraBetaUserLicense
 -UserId <String>
 -AssignedLicenses <AssignedLicenses>
 [<CommonParameters>]

Description

The Set-EntraBetaUserLicense adds or removes licenses for a Microsoft online service to the list of assigned licenses for a user.

For delegated scenarios, the calling user needs at least one of the following Microsoft Entra roles.

  • Directory Writers
  • License Administrator
  • User Administrator

Note: Before assigning a license, assign a usage location to the user using: Set-EntraUser -ObjectId user@contoso.com -UsageLocation '<two-letter-country-code e.g. GB/US>'.

Examples

Example 1: Add a license to a user based on a template user

Connect-Entra -Scopes 'User.ReadWrite.All'
$LicensedUser = Get-EntraBetaUser -UserId 'TemplateUser@contoso.com' 
$License = New-Object -TypeName Microsoft.Open.AzureAD.Model.AssignedLicense 
$License.SkuId = $LicensedUser.AssignedLicenses.SkuId 
$Licenses = New-Object -TypeName Microsoft.Open.AzureAD.Model.AssignedLicenses 
$Licenses.AddLicenses = $License 
$Params = @{
    UserId = 'SawyerM@contoso.com' 
    AssignedLicenses = $Licenses
}
Set-EntraBetaUserLicense @Params
Name                           Value
----                           -----
externalUserStateChangeDateTi…
businessPhones                 {8976546787}
postalCode                     444601
createdDateTime                06-11-2023 04:48:19
surname                        KTETSs
jobTitle                       Manager
employeeType
otherMails                     {SawyerM@contoso.com}
isResourceAccount
usageLocation                  DE
legalAgeGroupClassification    Adult
id                             cccccccc-2222-3333-4444-dddddddddddd
isLicenseReconciliationNeeded  False

This example demonstrates how to assign a license to a user based on a template user.

  • -UserId parameter specifies the Id of a user(as a UserPrincipalName or UserId).
  • -AssignedLicenses parameter specifies a list of licenses to assign or remove.

Example 2: Add a license to a user by copying license from another user

Connect-Entra -Scopes 'User.ReadWrite.All'
$LicensedUser = Get-EntraBetaUser -UserId 'AdeleV@contoso.com'
$User = Get-EntraBetaUser -UserId 'SawyerM@contoso.com' 
$License1 = New-Object -TypeName Microsoft.Open.AzureAD.Model.AssignedLicense 
$License1.SkuId = $LicensedUser.AssignedLicenses.SkuId[0] 
$License2 = New-Object -TypeName Microsoft.Open.AzureAD.Model.AssignedLicense
$License2.SkuId = $LicensedUser.AssignedLicenses.SkuId[1]
$addLicensesArray = @()
$addLicensesArray += $License1
$addLicensesArray += $License2
$Licenses = New-Object -TypeName Microsoft.Open.AzureAD.Model.AssignedLicenses 
$Licenses.AddLicenses = $addLicensesArray
$Params = @{
    UserId = $User.UserId 
    AssignedLicenses = $Licenses
}
Set-EntraBetaUserLicense @Params
Name                           Value
----                           -----
externalUserStateChangeDateTi…
businessPhones                 {8976546787}
postalCode                     444601
createdDateTime                06-11-2023 04:48:19
surname                        KTETSs
jobTitle                       Manager
employeeType
otherMails                     {SawyerM@contoso.com}
isResourceAccount
usageLocation                  DE
legalAgeGroupClassification    Adult
id                             cccccccc-2222-3333-4444-dddddddddddd
isLicenseReconciliationNeeded  False

This example demonstrates how to assign a license to a user by copying license from another user.

  • -UserId parameter specifies the Id of a user(as a UserPrincipalName or UserId).
  • -AssignedLicenses parameter specifies a list of licenses to assign or remove.

Example 3: Remove an assigned User's License

Connect-Entra -Scopes 'User.ReadWrite.All'
$UserPrincipalName = 'SawyerM@contoso.com'
$User = Get-EntraBetaUser -UserId $UserPrincipalName
$SkuId = (Get-EntraBetaUserLicenseDetail -UserId $UserPrincipalName).SkuId
$Licenses = New-Object -TypeName Microsoft.Open.AzureAD.Model.AssignedLicenses 
$Licenses.RemoveLicenses = $SkuId 
Set-EntraBetaUserLicense -UserId $User.UserId -AssignedLicenses $Licenses
Name                           Value
----                           -----
displayName                    SawyerM
id                             cccccccc-2222-3333-4444-dddddddddddd
jobTitle
surname                        M
mail
userPrincipalName              SawyerM@contoso.com
mobilePhone
preferredLanguage
@odata.context                 https://graph.microsoft.com/v1.0/$metadata#users/$entity
businessPhones                 {}
officeLocation
givenName                      Sawyer

This example demonstrates how to remove a user's license by retrieving the user details.

  • -UserId parameter specifies the Id of a user(as a UserPrincipalName or UserId).
  • -AssignedLicenses parameter specifies a list of licenses to assign or remove.

Parameters

-AssignedLicenses

Specifies a list of licenses to assign or remove.

Type: AssignedLicenses
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-UserId

Specifies the ID of a user (as a UserPrincipalName or UserId) in Microsoft Entra ID.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Outputs

Notes

Related Links

Get-EntraBetaUser