en-US/about_AzDoUserEntitlement.help.txt
|
.NAME
AzDoUserEntitlement .SYNOPSIS DSC resource for managing Azure DevOps user entitlements (organization membership + access level). .DESCRIPTION The AzDoUserEntitlement resource adds and removes users from an Azure DevOps organization and manages their access level (account license type) via the Member Entitlement Management API. It inherits Test()/Set() from the AzDevOpsDscResourceBase class. .PARAMETER UserPrincipalName Key - System.String The user's principal name (email / UPN). .PARAMETER AccountLicenseType Required - System.String Allowed values: stakeholder, express, advanced, professional, earlyAdopter, none The account license type to assign. Valid values are 'stakeholder', 'express' (Basic), 'advanced' (Basic + Test Plans), 'professional', 'earlyAdopter' and 'none'. .EXAMPLE 1 This example adds a user to the organization with a Basic access level. Adding a user consumes a license. For licensing at scale, prefer AzDoGroupEntitlement, which applies an access level to every member of a group. Configuration Example { Import-DscResource -ModuleName 'AzureDevOpsDscNative' node localhost { AzDoUserEntitlement 'JaneBasic' { Ensure = 'Present' UserPrincipalName = 'jane@contoso.com' AccountLicenseType = 'express' } } } .EXAMPLE 2 This example removes a user from the organization, releasing their license. A user also covered by a group licensing rule may retain access through that rule. Configuration Example { Import-DscResource -ModuleName 'AzureDevOpsDscNative' node localhost { AzDoUserEntitlement 'RemoveJane' { Ensure = 'Absent' UserPrincipalName = 'jane@contoso.com' } } } |