Set-MgBetaUserLicense

Reference

Module:: Microsoft.Graph.Beta.Users.Actions

Add or remove licenses for the user to enable or disable their use of Microsoft cloud offerings that the company has licenses to. For example, an organization can have a Microsoft 365 Enterprise E3 subscription with 100 licenses, and this request assigns one of those licenses to a specific user. You can also enable and disable specific plans associated with a subscription. Direct user licensing is an alternative to group-based licensing. To get the subscriptions available in the directory, perform a GET subscribedSkus request.

Note

To view the v1.0 release of this cmdlet, view Set-MgUserLicense

Syntax

Set-MgBetaUserLicense
   -UserId <String>
   [-ResponseHeadersVariable <String>]
   [-AddLicenses <IMicrosoftGraphAssignedLicense[]>]
   [-AdditionalProperties <Hashtable>]
   [-RemoveLicenses <String[]>]
   [-Headers <IDictionary>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-MgBetaUserLicense
   -UserId <String>
   -BodyParameter <IComponents103UmuuRequestbodiesAssignlicenserequestbodyContentApplicationJsonSchema>
   [-ResponseHeadersVariable <String>]
   [-Headers <IDictionary>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-MgBetaUserLicense
   -InputObject <IUsersActionsIdentity>
   [-ResponseHeadersVariable <String>]
   [-AddLicenses <IMicrosoftGraphAssignedLicense[]>]
   [-AdditionalProperties <Hashtable>]
   [-RemoveLicenses <String[]>]
   [-Headers <IDictionary>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-MgBetaUserLicense
   -InputObject <IUsersActionsIdentity>
   -BodyParameter <IComponents103UmuuRequestbodiesAssignlicenserequestbodyContentApplicationJsonSchema>
   [-ResponseHeadersVariable <String>]
   [-Headers <IDictionary>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Permissions

Permission type	Least privileged permissions	Higher privileged permissions
Delegated (work or school account)	LicenseAssignment.ReadWrite.All	Directory.ReadWrite.All, User.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	LicenseAssignment.ReadWrite.All	Directory.ReadWrite.All, User.ReadWrite.All

Examples

Example 1: Assign a license to a user

Connect-Graph -Scopes User.ReadWrite.All, Organization.Read.All

$EmsSku = Get-MgBetaSubscribedSku -All | Where SkuPartNumber -eq 'EMSPREMIUM'

Set-MgBetaUserLicense -UserId '38955658-c844-4f59-9430-6519430ac89b' -AddLicenses @{SkuId = $EmsSku.SkuId} -RemoveLicenses @()

Id                                   DisplayName   Mail UserPrincipalName                     UserType
--                                   -----------   ---- -----------------                     --------
38955658-c844-4f59-9430-6519430ac89b Bianca Pisani      BiancaP@contoso.onmicrosoft.com       Member

This example assigns a license from the EMSPREMIUM (ENTERPRISE MOBILITY + SECURITY E5) licensing plan to the unlicensed user 38955658-c844-4f59-9430-6519430ac89b. For more information, see assign licenses to users accounts with PowerShell.

Example 2: Assign more than one licenses to a user

Connect-Graph -Scopes User.ReadWrite.All, Organization.Read.All

$EmsSku = Get-MgBetaSubscribedSku -All | Where SkuPartNumber -eq 'EMSPREMIUM'
$FlowSku = Get-MgBetaSubscribedSku -All | Where SkuPartNumber -eq 'FLOW_FREE'
$addLicenses = @(
  @{SkuId = $EmsSku.SkuId},
  @{SkuId = $FlowSku.SkuId}
  )

Set-MgBetaUserLicense -UserId '38955658-c844-4f59-9430-6519430ac89b' -AddLicenses $addLicenses -RemoveLicenses @()

Id                                   DisplayName   Mail UserPrincipalName                     UserType
--                                   -----------   ---- -----------------                     --------
38955658-c844-4f59-9430-6519430ac89b Bianca Pisani      BiancaP@contoso.onmicrosoft.com       Member

This example assigns EMSPREMIUM and FLOW_FREE licenses to the user 38955658-c844-4f59-9430-6519430ac89b.

Example 3: Assign a license to a user with some disabled plans

Connect-Graph -Scopes User.ReadWrite.All, Organization.Read.All

$EmsSku = Get-MgBetaSubscribedSku -All | Where SkuPartNumber -eq 'EMSPREMIUM'
$disabledPlans = $EmsSku.ServicePlans | where ServicePlanName -in ("MFA_PREMIUM", "INTUNE_A") | Select -ExpandProperty ServicePlanId
$addLicenses = @(
  @{SkuId = $EmsSku.SkuId
  DisabledPlans = $disabledPlans
  }
  )

Set-MgBetaUserLicense -UserId '38955658-c844-4f59-9430-6519430ac89b' -AddLicenses $addLicenses -RemoveLicenses @()

Id                                   DisplayName   Mail UserPrincipalName                     UserType
--                                   -----------   ---- -----------------                     --------
38955658-c844-4f59-9430-6519430ac89b Bianca Pisani      BiancaP@contoso.onmicrosoft.com       Member

This example assigns EMSPREMIUM license with the MFA_PREMIUM and INTUNE_A services turned off.

Example 4: Update a license assigned to a user to add more disabled plans leaving the user's existing disabled plans in their current state

Connect-Graph -Scopes User.ReadWrite.All, Organization.Read.All

$EmsSku = Get-MgBetaSubscribedSku -All | Where SkuPartNumber -eq 'EMSPREMIUM'
$userLicense = Get-MgBetaUserLicenseDetail -UserId "38955658-c844-4f59-9430-6519430ac89b"

$userDisabledPlans = $userLicense.ServicePlans |
  Where ProvisioningStatus -eq "Disabled" |
  Select -ExpandProperty ServicePlanId

$newDisabledPlans = $EmsSku.ServicePlans |
  Where ServicePlanName -in ("AAD_PREMIUM_P2", "AAD_PREMIUM") |
  Select -ExpandProperty ServicePlanId

$disabledPlans = $userDisabledPlans + $newDisabledPlans | Select -Unique

$addLicenses = @(
  @{SkuId = $EmsSku.SkuId
  DisabledPlans = $disabledPlans
  }
  )

Set-MgBetaUserLicense -UserId '38955658-c844-4f59-9430-6519430ac89b' -AddLicenses $addLicenses -RemoveLicenses @()

Id                                   DisplayName   Mail UserPrincipalName                     UserType
--                                   -----------   ---- -----------------                     --------
38955658-c844-4f59-9430-6519430ac89b Bianca Pisani      BiancaP@contoso.onmicrosoft.com       Member

This example updates the EMSPREMIUM license assigned to the user to add AAD_PREMIUM_P2 and AAD_PREMIUM to the disabled services.

Example 5: Assign licenses to a user by copying the license assignment from another user

Connect-Graph -Scopes User.ReadWrite.All, Organization.Read.All

Select-MgBetaProfile -Name Beta
$mgUser = Get-MgBetaUser -UserId '38955658-c844-4f59-9430-6519430ac89b'

Set-MgBetaUserLicense -UserId "82f51c98-7221-442f-8329-3faf9fe022f1" -AddLicenses $mgUser.AssignedLicenses -RemoveLicenses @()


Id                                   DisplayName    Mail UserPrincipalName                      UserType
--                                   -----------    ---- -----------------                      --------
82f51c98-7221-442f-8329-3faf9fe022f1 Mallory Cortez      MalloryC@contoso.onmicrosoft.com       Member

This examples copies the license assignment of user 38955658-c844-4f59-9430-6519430ac89b and assigns it to user 82f51c98-7221-442f-8329-3faf9fe022f1.

Example 6: Remove a license assigned to a user

Connect-Graph -Scopes User.ReadWrite.All, Organization.Read.All

$EmsSku = Get-MgBetaSubscribedSku -All | Where SkuPartNumber -eq 'EMSPREMIUM'

Set-MgBetaUserLicense -UserId "38955658-c844-4f59-9430-6519430ac89b" -AddLicenses @() -RemoveLicenses @($EmsSku.SkuId)

Id                                   DisplayName   Mail UserPrincipalName                     UserType
--                                   -----------   ---- -----------------                     --------
38955658-c844-4f59-9430-6519430ac89b Bianca Pisani      BiancaP@contoso.onmicrosoft.com       Member

This example removes the EMSPREMIUM license assignment from the user.

Parameters

-AdditionalProperties

Additional Parameters

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

-AddLicenses

. To construct, see NOTES section for ADDLICENSES properties and create a hash table.

Type:	IMicrosoftGraphAssignedLicense[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-BodyParameter

. To construct, see NOTES section for BODYPARAMETER properties and create a hash table.

Type:	IComponents103UmuuRequestbodiesAssignlicenserequestbodyContentApplicationJsonSchema
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

-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

-InputObject

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

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

-ProgressAction

Type:	ActionPreference
Aliases:	proga
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RemoveLicenses

Type:	String[]
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

-UserId

The unique identifier of user

Type:	String
Position:	Named
Default value:	None
Required:	True
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.Beta.PowerShell.Models.IComponents103UmuuRequestbodiesAssignlicenserequestbodyContentApplicationJsonSchema

Microsoft.Graph.Beta.PowerShell.Models.IUsersActionsIdentity

System.Collections.IDictionary

Outputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphUser

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.

ADDLICENSES <IMicrosoftGraphAssignedLicense- []>: .

[DisabledPlans <String- []>]: A collection of the unique identifiers for plans that have been disabled. IDs are available in servicePlans > servicePlanId in the tenant's subscribedSkus or serviceStatus > servicePlanId in the tenant's companySubscription.
[SkuId <String>]: The unique identifier for the SKU. Corresponds to the skuId from subscribedSkus or companySubscription.

BODYPARAMETER <IComponents103UmuuRequestbodiesAssignlicenserequestbodyContentApplicationJsonSchema>: .

[(Any) <Object>]: This indicates any property can be added to this object.
[AddLicenses <IMicrosoftGraphAssignedLicense- []>]:
- [DisabledPlans <String- []>]: A collection of the unique identifiers for plans that have been disabled. IDs are available in servicePlans > servicePlanId in the tenant's subscribedSkus or serviceStatus > servicePlanId in the tenant's companySubscription.
- [SkuId <String>]: The unique identifier for the SKU. Corresponds to the skuId from subscribedSkus or companySubscription.
[RemoveLicenses <String- []>]:

INPUTOBJECT <IUsersActionsIdentity>: Identity Parameter

[AccessReviewInstanceId <String>]: The unique identifier of accessReviewInstance
[AccessReviewStageId <String>]: The unique identifier of accessReviewStage
[AppLogCollectionRequestId <String>]: The unique identifier of appLogCollectionRequest
[AuthenticationMethodId <String>]: The unique identifier of authenticationMethod
[CalendarId <String>]: The unique identifier of calendar
[ChatId <String>]: The unique identifier of chat
[ChatMessageId <String>]: The unique identifier of chatMessage
[ChatMessageId1 <String>]: The unique identifier of chatMessage
[CloudPcId <String>]: The unique identifier of cloudPC
[ContactFolderId <String>]: The unique identifier of contactFolder
[ContactFolderId1 <String>]: The unique identifier of contactFolder
[ContactId <String>]: The unique identifier of contact
[ContentTypeId <String>]: The unique identifier of contentType
[DeviceEnrollmentConfigurationId <String>]: The unique identifier of deviceEnrollmentConfiguration
[DeviceLogCollectionResponseId <String>]: The unique identifier of deviceLogCollectionResponse
[DocumentSetVersionId <String>]: The unique identifier of documentSetVersion
[DriveId <String>]: The unique identifier of drive
[DriveItemId <String>]: The unique identifier of driveItem
[DriveItemVersionId <String>]: The unique identifier of driveItemVersion
[EventId <String>]: The unique identifier of event
[EventId1 <String>]: The unique identifier of event
[JoinWebUrl <String>]: Alternate key of onlineMeeting
[ListItemId <String>]: The unique identifier of listItem
[ListItemVersionId <String>]: The unique identifier of listItemVersion
[MailFolderId <String>]: The unique identifier of mailFolder
[MailFolderId1 <String>]: The unique identifier of mailFolder
[ManagedDeviceId <String>]: The unique identifier of managedDevice
[MessageId <String>]: The unique identifier of message
[MobileAppTroubleshootingEventId <String>]: The unique identifier of mobileAppTroubleshootingEvent
[NotebookId <String>]: The unique identifier of notebook
[OnenotePageId <String>]: The unique identifier of onenotePage
[OnenoteSectionId <String>]: The unique identifier of onenoteSection
[OnlineMeetingId <String>]: The unique identifier of onlineMeeting
[OutlookTaskFolderId <String>]: The unique identifier of outlookTaskFolder
[OutlookTaskGroupId <String>]: The unique identifier of outlookTaskGroup
[OutlookTaskId <String>]: The unique identifier of outlookTask
[PermissionId <String>]: The unique identifier of permission
[PlannerPlanId <String>]: The unique identifier of plannerPlan
[SensitivityLabelId <String>]: The unique identifier of sensitivityLabel
[SubscriptionId <String>]: The unique identifier of subscription
[TeamsAppInstallationId <String>]: The unique identifier of teamsAppInstallation
[TodoTaskId <String>]: The unique identifier of todoTask
[TodoTaskListId <String>]: The unique identifier of todoTaskList
[UserId <String>]: The unique identifier of user

Freigeben über

Set-MgBetaUserLicense

Syntax

Description

Examples

Example 1: Assign a license to a user

Example 2: Assign more than one licenses to a user

Example 3: Assign a license to a user with some disabled plans

Example 4: Update a license assigned to a user to add more disabled plans leaving the user's existing disabled plans in their current state

Example 5: Assign licenses to a user by copying the license assignment from another user

Example 6: Remove a license assigned to a user

Parameters

-AdditionalProperties

-AddLicenses

-BodyParameter

-Confirm

-Headers

-InputObject

-ProgressAction

-RemoveLicenses

-ResponseHeadersVariable

-UserId

-WhatIf

Inputs

Outputs

Notes

Zusätzliche Ressourcen

Freigeben über

Set-MgBetaUserLicense

Syntax

Description

Examples

Example 1: Assign a license to a user

Example 2: Assign more than one licenses to a user

Example 3: Assign a license to a user with some disabled plans

Example 4: Update a license assigned to a user to add more disabled plans leaving the user's existing disabled plans in their current state

Example 5: Assign licenses to a user by copying the license assignment from another user

Example 6: Remove a license assigned to a user

Parameters

-AdditionalProperties

-AddLicenses

-BodyParameter

-Confirm

-Headers

-InputObject

-ProgressAction

-RemoveLicenses

-ResponseHeadersVariable

-UserId

-WhatIf

Inputs

Outputs

Notes

Related Links

Zusätzliche Ressourcen