1. Packages
  2. Azure DevOps Provider
  3. API Docs
  4. ServicePrincipalEntitlement
Azure DevOps v3.9.0 published on Tuesday, Apr 22, 2025 by Pulumi

azuredevops.ServicePrincipalEntitlement

Explore with Pulumi AI

Manages a Service Principal Entitlement.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azuredevops from "@pulumi/azuredevops";

const example = new azuredevops.ServicePrincipalEntitlement("example", {originId: "00000000-0000-0000-0000-000000000000"});
Copy
import pulumi
import pulumi_azuredevops as azuredevops

example = azuredevops.ServicePrincipalEntitlement("example", origin_id="00000000-0000-0000-0000-000000000000")
Copy
package main

import (
	"github.com/pulumi/pulumi-azuredevops/sdk/v3/go/azuredevops"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := azuredevops.NewServicePrincipalEntitlement(ctx, "example", &azuredevops.ServicePrincipalEntitlementArgs{
			OriginId: pulumi.String("00000000-0000-0000-0000-000000000000"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureDevOps = Pulumi.AzureDevOps;

return await Deployment.RunAsync(() => 
{
    var example = new AzureDevOps.ServicePrincipalEntitlement("example", new()
    {
        OriginId = "00000000-0000-0000-0000-000000000000",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azuredevops.ServicePrincipalEntitlement;
import com.pulumi.azuredevops.ServicePrincipalEntitlementArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ServicePrincipalEntitlement("example", ServicePrincipalEntitlementArgs.builder()
            .originId("00000000-0000-0000-0000-000000000000")
            .build());

    }
}
Copy
resources:
  example:
    type: azuredevops:ServicePrincipalEntitlement
    properties:
      originId: 00000000-0000-0000-0000-000000000000
Copy

Create ServicePrincipalEntitlement Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ServicePrincipalEntitlement(name: string, args: ServicePrincipalEntitlementArgs, opts?: CustomResourceOptions);
@overload
def ServicePrincipalEntitlement(resource_name: str,
                                args: ServicePrincipalEntitlementArgs,
                                opts: Optional[ResourceOptions] = None)

@overload
def ServicePrincipalEntitlement(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                origin_id: Optional[str] = None,
                                account_license_type: Optional[str] = None,
                                licensing_source: Optional[str] = None,
                                origin: Optional[str] = None)
func NewServicePrincipalEntitlement(ctx *Context, name string, args ServicePrincipalEntitlementArgs, opts ...ResourceOption) (*ServicePrincipalEntitlement, error)
public ServicePrincipalEntitlement(string name, ServicePrincipalEntitlementArgs args, CustomResourceOptions? opts = null)
public ServicePrincipalEntitlement(String name, ServicePrincipalEntitlementArgs args)
public ServicePrincipalEntitlement(String name, ServicePrincipalEntitlementArgs args, CustomResourceOptions options)
type: azuredevops:ServicePrincipalEntitlement
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ServicePrincipalEntitlementArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ServicePrincipalEntitlementArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ServicePrincipalEntitlementArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ServicePrincipalEntitlementArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ServicePrincipalEntitlementArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var servicePrincipalEntitlementResource = new AzureDevOps.ServicePrincipalEntitlement("servicePrincipalEntitlementResource", new()
{
    OriginId = "string",
    AccountLicenseType = "string",
    LicensingSource = "string",
    Origin = "string",
});
Copy
example, err := azuredevops.NewServicePrincipalEntitlement(ctx, "servicePrincipalEntitlementResource", &azuredevops.ServicePrincipalEntitlementArgs{
	OriginId:           pulumi.String("string"),
	AccountLicenseType: pulumi.String("string"),
	LicensingSource:    pulumi.String("string"),
	Origin:             pulumi.String("string"),
})
Copy
var servicePrincipalEntitlementResource = new ServicePrincipalEntitlement("servicePrincipalEntitlementResource", ServicePrincipalEntitlementArgs.builder()
    .originId("string")
    .accountLicenseType("string")
    .licensingSource("string")
    .origin("string")
    .build());
Copy
service_principal_entitlement_resource = azuredevops.ServicePrincipalEntitlement("servicePrincipalEntitlementResource",
    origin_id="string",
    account_license_type="string",
    licensing_source="string",
    origin="string")
Copy
const servicePrincipalEntitlementResource = new azuredevops.ServicePrincipalEntitlement("servicePrincipalEntitlementResource", {
    originId: "string",
    accountLicenseType: "string",
    licensingSource: "string",
    origin: "string",
});
Copy
type: azuredevops:ServicePrincipalEntitlement
properties:
    accountLicenseType: string
    licensingSource: string
    origin: string
    originId: string
Copy

ServicePrincipalEntitlement Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ServicePrincipalEntitlement resource accepts the following input properties:

OriginId
This property is required.
Changes to this property will trigger replacement.
string
The Object ID of the service principal in Entra ID. Changing this forces a new Service Principal Entitlement to be created.
AccountLicenseType string
Type of Account License. Possible values are: advanced, earlyAdopter, express, none, professional, or stakeholder. Defaults to express. In addition the value basic is allowed which is an alias for express and reflects the name of the express license used in the Azure DevOps web interface.
LicensingSource string
The source of the licensing (e.g. Account. MSDN etc.) Possible values are: account (Default), auto, msdn, none, profile, trial
Origin Changes to this property will trigger replacement. string
The type of source provider for the origin identifier.
OriginId
This property is required.
Changes to this property will trigger replacement.
string
The Object ID of the service principal in Entra ID. Changing this forces a new Service Principal Entitlement to be created.
AccountLicenseType string
Type of Account License. Possible values are: advanced, earlyAdopter, express, none, professional, or stakeholder. Defaults to express. In addition the value basic is allowed which is an alias for express and reflects the name of the express license used in the Azure DevOps web interface.
LicensingSource string
The source of the licensing (e.g. Account. MSDN etc.) Possible values are: account (Default), auto, msdn, none, profile, trial
Origin Changes to this property will trigger replacement. string
The type of source provider for the origin identifier.
originId
This property is required.
Changes to this property will trigger replacement.
String
The Object ID of the service principal in Entra ID. Changing this forces a new Service Principal Entitlement to be created.
accountLicenseType String
Type of Account License. Possible values are: advanced, earlyAdopter, express, none, professional, or stakeholder. Defaults to express. In addition the value basic is allowed which is an alias for express and reflects the name of the express license used in the Azure DevOps web interface.
licensingSource String
The source of the licensing (e.g. Account. MSDN etc.) Possible values are: account (Default), auto, msdn, none, profile, trial
origin Changes to this property will trigger replacement. String
The type of source provider for the origin identifier.
originId
This property is required.
Changes to this property will trigger replacement.
string
The Object ID of the service principal in Entra ID. Changing this forces a new Service Principal Entitlement to be created.
accountLicenseType string
Type of Account License. Possible values are: advanced, earlyAdopter, express, none, professional, or stakeholder. Defaults to express. In addition the value basic is allowed which is an alias for express and reflects the name of the express license used in the Azure DevOps web interface.
licensingSource string
The source of the licensing (e.g. Account. MSDN etc.) Possible values are: account (Default), auto, msdn, none, profile, trial
origin Changes to this property will trigger replacement. string
The type of source provider for the origin identifier.
origin_id
This property is required.
Changes to this property will trigger replacement.
str
The Object ID of the service principal in Entra ID. Changing this forces a new Service Principal Entitlement to be created.
account_license_type str
Type of Account License. Possible values are: advanced, earlyAdopter, express, none, professional, or stakeholder. Defaults to express. In addition the value basic is allowed which is an alias for express and reflects the name of the express license used in the Azure DevOps web interface.
licensing_source str
The source of the licensing (e.g. Account. MSDN etc.) Possible values are: account (Default), auto, msdn, none, profile, trial
origin Changes to this property will trigger replacement. str
The type of source provider for the origin identifier.
originId
This property is required.
Changes to this property will trigger replacement.
String
The Object ID of the service principal in Entra ID. Changing this forces a new Service Principal Entitlement to be created.
accountLicenseType String
Type of Account License. Possible values are: advanced, earlyAdopter, express, none, professional, or stakeholder. Defaults to express. In addition the value basic is allowed which is an alias for express and reflects the name of the express license used in the Azure DevOps web interface.
licensingSource String
The source of the licensing (e.g. Account. MSDN etc.) Possible values are: account (Default), auto, msdn, none, profile, trial
origin Changes to this property will trigger replacement. String
The type of source provider for the origin identifier.

Outputs

All input properties are implicitly available as output properties. Additionally, the ServicePrincipalEntitlement resource produces the following output properties:

Descriptor string
The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the user graph subject.
DisplayName string
The display name of service principal.
Id string
The provider-assigned unique ID for this managed resource.
Descriptor string
The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the user graph subject.
DisplayName string
The display name of service principal.
Id string
The provider-assigned unique ID for this managed resource.
descriptor String
The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the user graph subject.
displayName String
The display name of service principal.
id String
The provider-assigned unique ID for this managed resource.
descriptor string
The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the user graph subject.
displayName string
The display name of service principal.
id string
The provider-assigned unique ID for this managed resource.
descriptor str
The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the user graph subject.
display_name str
The display name of service principal.
id str
The provider-assigned unique ID for this managed resource.
descriptor String
The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the user graph subject.
displayName String
The display name of service principal.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing ServicePrincipalEntitlement Resource

Get an existing ServicePrincipalEntitlement resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ServicePrincipalEntitlementState, opts?: CustomResourceOptions): ServicePrincipalEntitlement
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_license_type: Optional[str] = None,
        descriptor: Optional[str] = None,
        display_name: Optional[str] = None,
        licensing_source: Optional[str] = None,
        origin: Optional[str] = None,
        origin_id: Optional[str] = None) -> ServicePrincipalEntitlement
func GetServicePrincipalEntitlement(ctx *Context, name string, id IDInput, state *ServicePrincipalEntitlementState, opts ...ResourceOption) (*ServicePrincipalEntitlement, error)
public static ServicePrincipalEntitlement Get(string name, Input<string> id, ServicePrincipalEntitlementState? state, CustomResourceOptions? opts = null)
public static ServicePrincipalEntitlement get(String name, Output<String> id, ServicePrincipalEntitlementState state, CustomResourceOptions options)
resources:  _:    type: azuredevops:ServicePrincipalEntitlement    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AccountLicenseType string
Type of Account License. Possible values are: advanced, earlyAdopter, express, none, professional, or stakeholder. Defaults to express. In addition the value basic is allowed which is an alias for express and reflects the name of the express license used in the Azure DevOps web interface.
Descriptor string
The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the user graph subject.
DisplayName string
The display name of service principal.
LicensingSource string
The source of the licensing (e.g. Account. MSDN etc.) Possible values are: account (Default), auto, msdn, none, profile, trial
Origin Changes to this property will trigger replacement. string
The type of source provider for the origin identifier.
OriginId Changes to this property will trigger replacement. string
The Object ID of the service principal in Entra ID. Changing this forces a new Service Principal Entitlement to be created.
AccountLicenseType string
Type of Account License. Possible values are: advanced, earlyAdopter, express, none, professional, or stakeholder. Defaults to express. In addition the value basic is allowed which is an alias for express and reflects the name of the express license used in the Azure DevOps web interface.
Descriptor string
The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the user graph subject.
DisplayName string
The display name of service principal.
LicensingSource string
The source of the licensing (e.g. Account. MSDN etc.) Possible values are: account (Default), auto, msdn, none, profile, trial
Origin Changes to this property will trigger replacement. string
The type of source provider for the origin identifier.
OriginId Changes to this property will trigger replacement. string
The Object ID of the service principal in Entra ID. Changing this forces a new Service Principal Entitlement to be created.
accountLicenseType String
Type of Account License. Possible values are: advanced, earlyAdopter, express, none, professional, or stakeholder. Defaults to express. In addition the value basic is allowed which is an alias for express and reflects the name of the express license used in the Azure DevOps web interface.
descriptor String
The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the user graph subject.
displayName String
The display name of service principal.
licensingSource String
The source of the licensing (e.g. Account. MSDN etc.) Possible values are: account (Default), auto, msdn, none, profile, trial
origin Changes to this property will trigger replacement. String
The type of source provider for the origin identifier.
originId Changes to this property will trigger replacement. String
The Object ID of the service principal in Entra ID. Changing this forces a new Service Principal Entitlement to be created.
accountLicenseType string
Type of Account License. Possible values are: advanced, earlyAdopter, express, none, professional, or stakeholder. Defaults to express. In addition the value basic is allowed which is an alias for express and reflects the name of the express license used in the Azure DevOps web interface.
descriptor string
The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the user graph subject.
displayName string
The display name of service principal.
licensingSource string
The source of the licensing (e.g. Account. MSDN etc.) Possible values are: account (Default), auto, msdn, none, profile, trial
origin Changes to this property will trigger replacement. string
The type of source provider for the origin identifier.
originId Changes to this property will trigger replacement. string
The Object ID of the service principal in Entra ID. Changing this forces a new Service Principal Entitlement to be created.
account_license_type str
Type of Account License. Possible values are: advanced, earlyAdopter, express, none, professional, or stakeholder. Defaults to express. In addition the value basic is allowed which is an alias for express and reflects the name of the express license used in the Azure DevOps web interface.
descriptor str
The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the user graph subject.
display_name str
The display name of service principal.
licensing_source str
The source of the licensing (e.g. Account. MSDN etc.) Possible values are: account (Default), auto, msdn, none, profile, trial
origin Changes to this property will trigger replacement. str
The type of source provider for the origin identifier.
origin_id Changes to this property will trigger replacement. str
The Object ID of the service principal in Entra ID. Changing this forces a new Service Principal Entitlement to be created.
accountLicenseType String
Type of Account License. Possible values are: advanced, earlyAdopter, express, none, professional, or stakeholder. Defaults to express. In addition the value basic is allowed which is an alias for express and reflects the name of the express license used in the Azure DevOps web interface.
descriptor String
The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the user graph subject.
displayName String
The display name of service principal.
licensingSource String
The source of the licensing (e.g. Account. MSDN etc.) Possible values are: account (Default), auto, msdn, none, profile, trial
origin Changes to this property will trigger replacement. String
The type of source provider for the origin identifier.
originId Changes to this property will trigger replacement. String
The Object ID of the service principal in Entra ID. Changing this forces a new Service Principal Entitlement to be created.

Import

Service Principal Entitlements can be imported using the resource id.

The resource id can be found using DEV Tools in the Users section of the ADO organization.

$ pulumi import azuredevops:index/servicePrincipalEntitlement:ServicePrincipalEntitlement example 8480c6eb-ce60-47e9-88df-eca3c801638b
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure DevOps pulumi/pulumi-azuredevops
License
Apache-2.0
Notes
This Pulumi package is based on the azuredevops Terraform Provider.