Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azuredevops Provider
  3. API Docs
  4. GroupEntitlement
Azure DevOps v3.4.0 published on Wednesday, Oct 30, 2024 by Pulumi
pulumi/pulumi-azuredevops

azuredevops.GroupEntitlement

Explore with Pulumi AI

azuredevops logo
Azure DevOps v3.4.0 published on Wednesday, Oct 30, 2024 by Pulumi
pulumi/pulumi-azuredevops

    Manages a group entitlement within Azure DevOps.

    Example Usage

    With an Azure DevOps local group managed by this resource

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

const example = new azuredevops.GroupEntitlement("example", {displayName: "Group Name"});

    import pulumi
import pulumi_azuredevops as azuredevops

example = azuredevops.GroupEntitlement("example", display_name="Group Name")

    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.NewGroupEntitlement(ctx, "example", &azuredevops.GroupEntitlementArgs{
			DisplayName: pulumi.String("Group Name"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureDevOps = Pulumi.AzureDevOps;

return await Deployment.RunAsync(() => 
{
    var example = new AzureDevOps.GroupEntitlement("example", new()
    {
        DisplayName = "Group Name",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azuredevops.GroupEntitlement;
import com.pulumi.azuredevops.GroupEntitlementArgs;
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 GroupEntitlement("example", GroupEntitlementArgs.builder()
            .displayName("Group Name")
            .build());

    }
}

    resources:
  example:
    type: azuredevops:GroupEntitlement
    properties:
      displayName: Group Name

    With group origin ID

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

const example = new azuredevops.GroupEntitlement("example", {
    origin: "aad",
    originId: "00000000-0000-0000-0000-000000000000",
});

    import pulumi
import pulumi_azuredevops as azuredevops

example = azuredevops.GroupEntitlement("example",
    origin="aad",
    origin_id="00000000-0000-0000-0000-000000000000")

    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.NewGroupEntitlement(ctx, "example", &azuredevops.GroupEntitlementArgs{
			Origin:   pulumi.String("aad"),
			OriginId: pulumi.String("00000000-0000-0000-0000-000000000000"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureDevOps = Pulumi.AzureDevOps;

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

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azuredevops.GroupEntitlement;
import com.pulumi.azuredevops.GroupEntitlementArgs;
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 GroupEntitlement("example", GroupEntitlementArgs.builder()
            .origin("aad")
            .originId("00000000-0000-0000-0000-000000000000")
            .build());

    }
}

    resources:
  example:
    type: azuredevops:GroupEntitlement
    properties:
      origin: aad
      originId: 00000000-0000-0000-0000-000000000000

    PAT Permissions Required

    • Member Entitlement Management: Read & Write

    Create GroupEntitlement Resource

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

    Constructor syntax

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

@overload
def GroupEntitlement(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     account_license_type: Optional[str] = None,
                     display_name: Optional[str] = None,
                     licensing_source: Optional[str] = None,
                     origin: Optional[str] = None,
                     origin_id: Optional[str] = None)
    func NewGroupEntitlement(ctx *Context, name string, args *GroupEntitlementArgs, opts ...ResourceOption) (*GroupEntitlement, error)
    public GroupEntitlement(string name, GroupEntitlementArgs? args = null, CustomResourceOptions? opts = null)
    public GroupEntitlement(String name, GroupEntitlementArgs args)
public GroupEntitlement(String name, GroupEntitlementArgs args, CustomResourceOptions options)

    type: azuredevops:GroupEntitlement
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args GroupEntitlementArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args GroupEntitlementArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args GroupEntitlementArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GroupEntitlementArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GroupEntitlementArgs
    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 groupEntitlementResource = new AzureDevOps.GroupEntitlement("groupEntitlementResource", new()
{
    AccountLicenseType = "string",
    DisplayName = "string",
    LicensingSource = "string",
    Origin = "string",
    OriginId = "string",
});

    example, err := azuredevops.NewGroupEntitlement(ctx, "groupEntitlementResource", &azuredevops.GroupEntitlementArgs{
	AccountLicenseType: pulumi.String("string"),
	DisplayName:        pulumi.String("string"),
	LicensingSource:    pulumi.String("string"),
	Origin:             pulumi.String("string"),
	OriginId:           pulumi.String("string"),
})

    var groupEntitlementResource = new GroupEntitlement("groupEntitlementResource", GroupEntitlementArgs.builder()
    .accountLicenseType("string")
    .displayName("string")
    .licensingSource("string")
    .origin("string")
    .originId("string")
    .build());

    group_entitlement_resource = azuredevops.GroupEntitlement("groupEntitlementResource",
    account_license_type="string",
    display_name="string",
    licensing_source="string",
    origin="string",
    origin_id="string")

    const groupEntitlementResource = new azuredevops.GroupEntitlement("groupEntitlementResource", {
    accountLicenseType: "string",
    displayName: "string",
    licensingSource: "string",
    origin: "string",
    originId: "string",
});

    type: azuredevops:GroupEntitlement
properties:
    accountLicenseType: string
    displayName: string
    licensingSource: string
    origin: string
    originId: string

    GroupEntitlement 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 GroupEntitlement resource accepts the following input properties:

    AccountLicenseType string
    Type of Account License. Valid values: 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.
    DisplayName string
    The display name is the name used in Azure DevOps UI. Cannot be set together with origin_id and origin.
    LicensingSource string

    The source of the licensing (e.g. Account. MSDN etc.) Valid values: account (Default), auto, msdn, none, profile, trial

    NOTE: A existing group in Azure AD can only be referenced by the combination of origin_id and origin.

    Origin string
    The type of source provider for the origin identifier.
    OriginId string
    The unique identifier from the system of origin. Typically, a sid, object id or Guid. e.g. Used for member of other tenant on Azure Active Directory.
    AccountLicenseType string
    Type of Account License. Valid values: 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.
    DisplayName string
    The display name is the name used in Azure DevOps UI. Cannot be set together with origin_id and origin.
    LicensingSource string

    The source of the licensing (e.g. Account. MSDN etc.) Valid values: account (Default), auto, msdn, none, profile, trial

    NOTE: A existing group in Azure AD can only be referenced by the combination of origin_id and origin.

    Origin string
    The type of source provider for the origin identifier.
    OriginId string
    The unique identifier from the system of origin. Typically, a sid, object id or Guid. e.g. Used for member of other tenant on Azure Active Directory.
    accountLicenseType String
    Type of Account License. Valid values: 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.
    displayName String
    The display name is the name used in Azure DevOps UI. Cannot be set together with origin_id and origin.
    licensingSource String

    The source of the licensing (e.g. Account. MSDN etc.) Valid values: account (Default), auto, msdn, none, profile, trial

    NOTE: A existing group in Azure AD can only be referenced by the combination of origin_id and origin.

    origin String
    The type of source provider for the origin identifier.
    originId String
    The unique identifier from the system of origin. Typically, a sid, object id or Guid. e.g. Used for member of other tenant on Azure Active Directory.
    accountLicenseType string
    Type of Account License. Valid values: 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.
    displayName string
    The display name is the name used in Azure DevOps UI. Cannot be set together with origin_id and origin.
    licensingSource string

    The source of the licensing (e.g. Account. MSDN etc.) Valid values: account (Default), auto, msdn, none, profile, trial

    NOTE: A existing group in Azure AD can only be referenced by the combination of origin_id and origin.

    origin string
    The type of source provider for the origin identifier.
    originId string
    The unique identifier from the system of origin. Typically, a sid, object id or Guid. e.g. Used for member of other tenant on Azure Active Directory.
    account_license_type str
    Type of Account License. Valid values: 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.
    display_name str
    The display name is the name used in Azure DevOps UI. Cannot be set together with origin_id and origin.
    licensing_source str

    The source of the licensing (e.g. Account. MSDN etc.) Valid values: account (Default), auto, msdn, none, profile, trial

    NOTE: A existing group in Azure AD can only be referenced by the combination of origin_id and origin.

    origin str
    The type of source provider for the origin identifier.
    origin_id str
    The unique identifier from the system of origin. Typically, a sid, object id or Guid. e.g. Used for member of other tenant on Azure Active Directory.
    accountLicenseType String
    Type of Account License. Valid values: 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.
    displayName String
    The display name is the name used in Azure DevOps UI. Cannot be set together with origin_id and origin.
    licensingSource String

    The source of the licensing (e.g. Account. MSDN etc.) Valid values: account (Default), auto, msdn, none, profile, trial

    NOTE: A existing group in Azure AD can only be referenced by the combination of origin_id and origin.

    origin String
    The type of source provider for the origin identifier.
    originId String
    The unique identifier from the system of origin. Typically, a sid, object id or Guid. e.g. Used for member of other tenant on Azure Active Directory.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the GroupEntitlement 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 group graph subject.
    Id string
    The provider-assigned unique ID for this managed resource.
    PrincipalName string
    The principal name of a graph member on Azure DevOps
    Descriptor string
    The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the group graph subject.
    Id string
    The provider-assigned unique ID for this managed resource.
    PrincipalName string
    The principal name of a graph member on Azure DevOps
    descriptor String
    The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the group graph subject.
    id String
    The provider-assigned unique ID for this managed resource.
    principalName String
    The principal name of a graph member on Azure DevOps
    descriptor string
    The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the group graph subject.
    id string
    The provider-assigned unique ID for this managed resource.
    principalName string
    The principal name of a graph member on Azure DevOps
    descriptor str
    The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the group graph subject.
    id str
    The provider-assigned unique ID for this managed resource.
    principal_name str
    The principal name of a graph member on Azure DevOps
    descriptor String
    The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the group graph subject.
    id String
    The provider-assigned unique ID for this managed resource.
    principalName String
    The principal name of a graph member on Azure DevOps

    Look up Existing GroupEntitlement Resource

    Get an existing GroupEntitlement 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?: GroupEntitlementState, opts?: CustomResourceOptions): GroupEntitlement
    @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,
        principal_name: Optional[str] = None) -> GroupEntitlement
    func GetGroupEntitlement(ctx *Context, name string, id IDInput, state *GroupEntitlementState, opts ...ResourceOption) (*GroupEntitlement, error)
    public static GroupEntitlement Get(string name, Input<string> id, GroupEntitlementState? state, CustomResourceOptions? opts = null)
    public static GroupEntitlement get(String name, Output<String> id, GroupEntitlementState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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. Valid values: 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 group graph subject.
    DisplayName string
    The display name is the name used in Azure DevOps UI. Cannot be set together with origin_id and origin.
    LicensingSource string

    The source of the licensing (e.g. Account. MSDN etc.) Valid values: account (Default), auto, msdn, none, profile, trial

    NOTE: A existing group in Azure AD can only be referenced by the combination of origin_id and origin.

    Origin string
    The type of source provider for the origin identifier.
    OriginId string
    The unique identifier from the system of origin. Typically, a sid, object id or Guid. e.g. Used for member of other tenant on Azure Active Directory.
    PrincipalName string
    The principal name of a graph member on Azure DevOps
    AccountLicenseType string
    Type of Account License. Valid values: 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 group graph subject.
    DisplayName string
    The display name is the name used in Azure DevOps UI. Cannot be set together with origin_id and origin.
    LicensingSource string

    The source of the licensing (e.g. Account. MSDN etc.) Valid values: account (Default), auto, msdn, none, profile, trial

    NOTE: A existing group in Azure AD can only be referenced by the combination of origin_id and origin.

    Origin string
    The type of source provider for the origin identifier.
    OriginId string
    The unique identifier from the system of origin. Typically, a sid, object id or Guid. e.g. Used for member of other tenant on Azure Active Directory.
    PrincipalName string
    The principal name of a graph member on Azure DevOps
    accountLicenseType String
    Type of Account License. Valid values: 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 group graph subject.
    displayName String
    The display name is the name used in Azure DevOps UI. Cannot be set together with origin_id and origin.
    licensingSource String

    The source of the licensing (e.g. Account. MSDN etc.) Valid values: account (Default), auto, msdn, none, profile, trial

    NOTE: A existing group in Azure AD can only be referenced by the combination of origin_id and origin.

    origin String
    The type of source provider for the origin identifier.
    originId String
    The unique identifier from the system of origin. Typically, a sid, object id or Guid. e.g. Used for member of other tenant on Azure Active Directory.
    principalName String
    The principal name of a graph member on Azure DevOps
    accountLicenseType string
    Type of Account License. Valid values: 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 group graph subject.
    displayName string
    The display name is the name used in Azure DevOps UI. Cannot be set together with origin_id and origin.
    licensingSource string

    The source of the licensing (e.g. Account. MSDN etc.) Valid values: account (Default), auto, msdn, none, profile, trial

    NOTE: A existing group in Azure AD can only be referenced by the combination of origin_id and origin.

    origin string
    The type of source provider for the origin identifier.
    originId string
    The unique identifier from the system of origin. Typically, a sid, object id or Guid. e.g. Used for member of other tenant on Azure Active Directory.
    principalName string
    The principal name of a graph member on Azure DevOps
    account_license_type str
    Type of Account License. Valid values: 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 group graph subject.
    display_name str
    The display name is the name used in Azure DevOps UI. Cannot be set together with origin_id and origin.
    licensing_source str

    The source of the licensing (e.g. Account. MSDN etc.) Valid values: account (Default), auto, msdn, none, profile, trial

    NOTE: A existing group in Azure AD can only be referenced by the combination of origin_id and origin.

    origin str
    The type of source provider for the origin identifier.
    origin_id str
    The unique identifier from the system of origin. Typically, a sid, object id or Guid. e.g. Used for member of other tenant on Azure Active Directory.
    principal_name str
    The principal name of a graph member on Azure DevOps
    accountLicenseType String
    Type of Account License. Valid values: 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 group graph subject.
    displayName String
    The display name is the name used in Azure DevOps UI. Cannot be set together with origin_id and origin.
    licensingSource String

    The source of the licensing (e.g. Account. MSDN etc.) Valid values: account (Default), auto, msdn, none, profile, trial

    NOTE: A existing group in Azure AD can only be referenced by the combination of origin_id and origin.

    origin String
    The type of source provider for the origin identifier.
    originId String
    The unique identifier from the system of origin. Typically, a sid, object id or Guid. e.g. Used for member of other tenant on Azure Active Directory.
    principalName String
    The principal name of a graph member on Azure DevOps

    Import

    The resource allows the import via the ID of a group entitlement, which is a

    UUID.

    $ pulumi import azuredevops:index/groupEntitlement:GroupEntitlement example 00000000-0000-0000-0000-000000000000

    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.
    azuredevops logo
    Azure DevOps v3.4.0 published on Wednesday, Oct 30, 2024 by Pulumi
    pulumi/pulumi-azuredevops