en-US/about_AzDoGroupEntitlement.help.txt
|
.NAME
AzDoGroupEntitlement .SYNOPSIS DSC resource for managing Azure DevOps group licensing rules. .DESCRIPTION Manages the group entitlement (licensing rule) that assigns an access level to every member of a group. This is how licensing is administered at scale; AzDoUserEntitlement covers a single user at a time, which does not scale to an organization. .PARAMETER GroupDisplayName Key - System.String The display name or principal name of the group the rule applies to. .PARAMETER AccountLicenseType Write - System.String The access level the rule assigns, for example 'express' (Basic), 'stakeholder' or 'advanced'. .PARAMETER GroupOrigin Write - System.String Allowed values: aad, vsts The identity origin: 'aad' for a Microsoft Entra group, 'vsts' for an Azure DevOps group. Defaults to 'aad'. .PARAMETER GroupOriginId Write - System.String The Entra object id of the group. Supplying it makes creation unambiguous when several groups share a display name. .EXAMPLE 1 This example licenses every member of a group with a Basic access level. Group licensing rules are how access levels are managed at scale - AzDoUserEntitlement covers one user at a time. Configuration Example { Import-DscResource -ModuleName 'AzureDevOpsDscNative' node localhost { AzDoGroupEntitlement 'LicenseDevelopers' { Ensure = 'Present' GroupDisplayName = 'Contoso Developers' AccountLicenseType = 'express' } } } .EXAMPLE 2 This example removes a group licensing rule. Removing the rule does not remove anyone from the organization. Members keep any license held directly or granted by another rule. Configuration Example { Import-DscResource -ModuleName 'AzureDevOpsDscNative' node localhost { AzDoGroupEntitlement 'RemoveDeveloperLicensing' { Ensure = 'Absent' GroupDisplayName = 'Contoso Developers' } } } |