en-US/about_AzDoServicePrincipalEntitlement.help.txt
|
.NAME
AzDoServicePrincipalEntitlement .SYNOPSIS DSC resource for managing Azure DevOps service principal entitlements. .DESCRIPTION Manages a service principal or managed identity as a member of the organization, with an access level. Service principals are organization members in their own right and are not covered by AzDoUserEntitlement, which handles users only. The module can already authenticate as a service principal, a certificate-backed service principal, or a federated workload identity - this closes the matching gap on the managed side. .PARAMETER OriginId Key - System.String The Microsoft Entra object id of the service principal. .PARAMETER DisplayName Write - System.String A display name recorded with the entitlement. Informational; matching uses OriginId. .PARAMETER AccountLicenseType Write - System.String The access level to assign, for example 'express' (Basic) or 'stakeholder'. .EXAMPLE 1 This example adds a service principal to the organization with a Basic access level. The service principal is identified by its Microsoft Entra object id, which is stable across renames. Configuration Example { Import-DscResource -ModuleName 'AzureDevOpsDscNative' node localhost { AzDoServicePrincipalEntitlement 'AddDeploymentIdentity' { Ensure = 'Present' OriginId = '00000000-0000-0000-0000-000000000000' DisplayName = 'contoso-deployment-sp' AccountLicenseType = 'express' } } } |