Documentation ¶
Index ¶
- type GetUsersArgs
- type GetUsersFeatures
- type GetUsersFeaturesArgs
- func (GetUsersFeaturesArgs) ElementType() reflect.Type
- func (i GetUsersFeaturesArgs) ToGetUsersFeaturesOutput() GetUsersFeaturesOutput
- func (i GetUsersFeaturesArgs) ToGetUsersFeaturesOutputWithContext(ctx context.Context) GetUsersFeaturesOutput
- func (i GetUsersFeaturesArgs) ToGetUsersFeaturesPtrOutput() GetUsersFeaturesPtrOutput
- func (i GetUsersFeaturesArgs) ToGetUsersFeaturesPtrOutputWithContext(ctx context.Context) GetUsersFeaturesPtrOutput
- type GetUsersFeaturesInput
- type GetUsersFeaturesOutput
- func (o GetUsersFeaturesOutput) ConcurrentWorkers() pulumi.IntPtrOutput
- func (GetUsersFeaturesOutput) ElementType() reflect.Type
- func (o GetUsersFeaturesOutput) ToGetUsersFeaturesOutput() GetUsersFeaturesOutput
- func (o GetUsersFeaturesOutput) ToGetUsersFeaturesOutputWithContext(ctx context.Context) GetUsersFeaturesOutput
- func (o GetUsersFeaturesOutput) ToGetUsersFeaturesPtrOutput() GetUsersFeaturesPtrOutput
- func (o GetUsersFeaturesOutput) ToGetUsersFeaturesPtrOutputWithContext(ctx context.Context) GetUsersFeaturesPtrOutput
- type GetUsersFeaturesPtrInput
- type GetUsersFeaturesPtrOutput
- func (o GetUsersFeaturesPtrOutput) ConcurrentWorkers() pulumi.IntPtrOutput
- func (o GetUsersFeaturesPtrOutput) Elem() GetUsersFeaturesOutput
- func (GetUsersFeaturesPtrOutput) ElementType() reflect.Type
- func (o GetUsersFeaturesPtrOutput) ToGetUsersFeaturesPtrOutput() GetUsersFeaturesPtrOutput
- func (o GetUsersFeaturesPtrOutput) ToGetUsersFeaturesPtrOutputWithContext(ctx context.Context) GetUsersFeaturesPtrOutput
- type GetUsersOutputArgs
- type GetUsersResult
- type GetUsersResultOutput
- func (GetUsersResultOutput) ElementType() reflect.Type
- func (o GetUsersResultOutput) Features() GetUsersFeaturesPtrOutput
- func (o GetUsersResultOutput) Id() pulumi.StringOutput
- func (o GetUsersResultOutput) Origin() pulumi.StringPtrOutput
- func (o GetUsersResultOutput) OriginId() pulumi.StringPtrOutput
- func (o GetUsersResultOutput) PrincipalName() pulumi.StringPtrOutput
- func (o GetUsersResultOutput) SubjectTypes() pulumi.StringArrayOutput
- func (o GetUsersResultOutput) ToGetUsersResultOutput() GetUsersResultOutput
- func (o GetUsersResultOutput) ToGetUsersResultOutputWithContext(ctx context.Context) GetUsersResultOutput
- func (o GetUsersResultOutput) Users() GetUsersUserArrayOutput
- type GetUsersUser
- type GetUsersUserArgs
- type GetUsersUserArray
- type GetUsersUserArrayInput
- type GetUsersUserArrayOutput
- func (GetUsersUserArrayOutput) ElementType() reflect.Type
- func (o GetUsersUserArrayOutput) Index(i pulumi.IntInput) GetUsersUserOutput
- func (o GetUsersUserArrayOutput) ToGetUsersUserArrayOutput() GetUsersUserArrayOutput
- func (o GetUsersUserArrayOutput) ToGetUsersUserArrayOutputWithContext(ctx context.Context) GetUsersUserArrayOutput
- type GetUsersUserInput
- type GetUsersUserOutput
- func (o GetUsersUserOutput) Descriptor() pulumi.StringOutput
- func (o GetUsersUserOutput) DisplayName() pulumi.StringOutput
- func (GetUsersUserOutput) ElementType() reflect.Type
- func (o GetUsersUserOutput) Id() pulumi.StringOutput
- func (o GetUsersUserOutput) MailAddress() pulumi.StringOutput
- func (o GetUsersUserOutput) Origin() pulumi.StringOutput
- func (o GetUsersUserOutput) OriginId() pulumi.StringPtrOutput
- func (o GetUsersUserOutput) PrincipalName() pulumi.StringOutput
- func (o GetUsersUserOutput) ToGetUsersUserOutput() GetUsersUserOutput
- func (o GetUsersUserOutput) ToGetUsersUserOutputWithContext(ctx context.Context) GetUsersUserOutput
- type Groupdeprecated
- type GroupArgs
- type GroupArray
- type GroupArrayInput
- type GroupArrayOutput
- type GroupInput
- type GroupMap
- type GroupMapInput
- type GroupMapOutput
- type GroupMembershipdeprecated
- type GroupMembershipArgs
- type GroupMembershipArray
- type GroupMembershipArrayInput
- type GroupMembershipArrayOutput
- func (GroupMembershipArrayOutput) ElementType() reflect.Type
- func (o GroupMembershipArrayOutput) Index(i pulumi.IntInput) GroupMembershipOutput
- func (o GroupMembershipArrayOutput) ToGroupMembershipArrayOutput() GroupMembershipArrayOutput
- func (o GroupMembershipArrayOutput) ToGroupMembershipArrayOutputWithContext(ctx context.Context) GroupMembershipArrayOutput
- type GroupMembershipInput
- type GroupMembershipMap
- type GroupMembershipMapInput
- type GroupMembershipMapOutput
- func (GroupMembershipMapOutput) ElementType() reflect.Type
- func (o GroupMembershipMapOutput) MapIndex(k pulumi.StringInput) GroupMembershipOutput
- func (o GroupMembershipMapOutput) ToGroupMembershipMapOutput() GroupMembershipMapOutput
- func (o GroupMembershipMapOutput) ToGroupMembershipMapOutputWithContext(ctx context.Context) GroupMembershipMapOutput
- type GroupMembershipOutput
- func (GroupMembershipOutput) ElementType() reflect.Type
- func (o GroupMembershipOutput) Group() pulumi.StringOutput
- func (o GroupMembershipOutput) Members() pulumi.StringArrayOutput
- func (o GroupMembershipOutput) Mode() pulumi.StringPtrOutput
- func (o GroupMembershipOutput) ToGroupMembershipOutput() GroupMembershipOutput
- func (o GroupMembershipOutput) ToGroupMembershipOutputWithContext(ctx context.Context) GroupMembershipOutput
- type GroupMembershipState
- type GroupOutput
- func (o GroupOutput) Description() pulumi.StringPtrOutput
- func (o GroupOutput) Descriptor() pulumi.StringOutput
- func (o GroupOutput) DisplayName() pulumi.StringOutput
- func (o GroupOutput) Domain() pulumi.StringOutput
- func (GroupOutput) ElementType() reflect.Type
- func (o GroupOutput) Mail() pulumi.StringOutput
- func (o GroupOutput) Members() pulumi.StringArrayOutput
- func (o GroupOutput) Origin() pulumi.StringOutput
- func (o GroupOutput) OriginId() pulumi.StringOutput
- func (o GroupOutput) PrincipalName() pulumi.StringOutput
- func (o GroupOutput) Scope() pulumi.StringPtrOutput
- func (o GroupOutput) SubjectKind() pulumi.StringOutput
- func (o GroupOutput) ToGroupOutput() GroupOutput
- func (o GroupOutput) ToGroupOutputWithContext(ctx context.Context) GroupOutput
- func (o GroupOutput) Url() pulumi.StringOutput
- type GroupState
- type LookupGroupArgs
- type LookupGroupOutputArgs
- type LookupGroupResult
- type LookupGroupResultOutput
- func (o LookupGroupResultOutput) Descriptor() pulumi.StringOutput
- func (LookupGroupResultOutput) ElementType() reflect.Type
- func (o LookupGroupResultOutput) Id() pulumi.StringOutput
- func (o LookupGroupResultOutput) Name() pulumi.StringOutput
- func (o LookupGroupResultOutput) Origin() pulumi.StringOutput
- func (o LookupGroupResultOutput) OriginId() pulumi.StringOutput
- func (o LookupGroupResultOutput) ProjectId() pulumi.StringPtrOutput
- func (o LookupGroupResultOutput) ToLookupGroupResultOutput() LookupGroupResultOutput
- func (o LookupGroupResultOutput) ToLookupGroupResultOutputWithContext(ctx context.Context) LookupGroupResultOutput
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type GetUsersArgs ¶
type GetUsersArgs struct { // A `features` block as defined below. // // DataSource without specifying any arguments will return all users inside an organization. // // List of possible subject types // // <!--Start PulumiCodeChooser --> // “`go // package main // // import ( // "github.com/pulumi/pulumi/sdk/v3/go/pulumi" // ) // // func main() { // pulumi.Run(func(ctx *pulumi.Context) error { // return nil // }) // } // “` // <!--End PulumiCodeChooser --> // // List of possible origins // // <!--Start PulumiCodeChooser --> // “`go // package main // // import ( // "github.com/pulumi/pulumi/sdk/v3/go/pulumi" // ) // // func main() { // pulumi.Run(func(ctx *pulumi.Context) error { // return nil // }) // } // “` // <!--End PulumiCodeChooser --> Features *GetUsersFeatures `pulumi:"features"` // The type of source provider for the `originId` parameter (ex:AD, AAD, MSA) The supported origins are listed below. Origin *string `pulumi:"origin"` // The unique identifier from the system of origin. OriginId *string `pulumi:"originId"` // The PrincipalName of this graph member from the source provider. PrincipalName *string `pulumi:"principalName"` // A list of user subject subtypes to reduce the retrieved results, e.g. `msa`, `aad`, `svc` (service identity), `imp` (imported identity), etc. The supported subject types are listed below. SubjectTypes []string `pulumi:"subjectTypes"` }
A collection of arguments for invoking getUsers.
type GetUsersFeatures ¶ added in v2.15.0
type GetUsersFeatures struct { // Number of workers to process user data concurrently. // // > **Note** Setting `concurrentWorkers` to a value greater than 1 can greatly decrease the time it takes to read the data source. ConcurrentWorkers *int `pulumi:"concurrentWorkers"` }
type GetUsersFeaturesArgs ¶ added in v2.15.0
type GetUsersFeaturesArgs struct { // Number of workers to process user data concurrently. // // > **Note** Setting `concurrentWorkers` to a value greater than 1 can greatly decrease the time it takes to read the data source. ConcurrentWorkers pulumi.IntPtrInput `pulumi:"concurrentWorkers"` }
func (GetUsersFeaturesArgs) ElementType ¶ added in v2.15.0
func (GetUsersFeaturesArgs) ElementType() reflect.Type
func (GetUsersFeaturesArgs) ToGetUsersFeaturesOutput ¶ added in v2.15.0
func (i GetUsersFeaturesArgs) ToGetUsersFeaturesOutput() GetUsersFeaturesOutput
func (GetUsersFeaturesArgs) ToGetUsersFeaturesOutputWithContext ¶ added in v2.15.0
func (i GetUsersFeaturesArgs) ToGetUsersFeaturesOutputWithContext(ctx context.Context) GetUsersFeaturesOutput
func (GetUsersFeaturesArgs) ToGetUsersFeaturesPtrOutput ¶ added in v2.15.0
func (i GetUsersFeaturesArgs) ToGetUsersFeaturesPtrOutput() GetUsersFeaturesPtrOutput
func (GetUsersFeaturesArgs) ToGetUsersFeaturesPtrOutputWithContext ¶ added in v2.15.0
func (i GetUsersFeaturesArgs) ToGetUsersFeaturesPtrOutputWithContext(ctx context.Context) GetUsersFeaturesPtrOutput
type GetUsersFeaturesInput ¶ added in v2.15.0
type GetUsersFeaturesInput interface { pulumi.Input ToGetUsersFeaturesOutput() GetUsersFeaturesOutput ToGetUsersFeaturesOutputWithContext(context.Context) GetUsersFeaturesOutput }
GetUsersFeaturesInput is an input type that accepts GetUsersFeaturesArgs and GetUsersFeaturesOutput values. You can construct a concrete instance of `GetUsersFeaturesInput` via:
GetUsersFeaturesArgs{...}
type GetUsersFeaturesOutput ¶ added in v2.15.0
type GetUsersFeaturesOutput struct{ *pulumi.OutputState }
func (GetUsersFeaturesOutput) ConcurrentWorkers ¶ added in v2.15.0
func (o GetUsersFeaturesOutput) ConcurrentWorkers() pulumi.IntPtrOutput
Number of workers to process user data concurrently.
> **Note** Setting `concurrentWorkers` to a value greater than 1 can greatly decrease the time it takes to read the data source.
func (GetUsersFeaturesOutput) ElementType ¶ added in v2.15.0
func (GetUsersFeaturesOutput) ElementType() reflect.Type
func (GetUsersFeaturesOutput) ToGetUsersFeaturesOutput ¶ added in v2.15.0
func (o GetUsersFeaturesOutput) ToGetUsersFeaturesOutput() GetUsersFeaturesOutput
func (GetUsersFeaturesOutput) ToGetUsersFeaturesOutputWithContext ¶ added in v2.15.0
func (o GetUsersFeaturesOutput) ToGetUsersFeaturesOutputWithContext(ctx context.Context) GetUsersFeaturesOutput
func (GetUsersFeaturesOutput) ToGetUsersFeaturesPtrOutput ¶ added in v2.15.0
func (o GetUsersFeaturesOutput) ToGetUsersFeaturesPtrOutput() GetUsersFeaturesPtrOutput
func (GetUsersFeaturesOutput) ToGetUsersFeaturesPtrOutputWithContext ¶ added in v2.15.0
func (o GetUsersFeaturesOutput) ToGetUsersFeaturesPtrOutputWithContext(ctx context.Context) GetUsersFeaturesPtrOutput
type GetUsersFeaturesPtrInput ¶ added in v2.15.0
type GetUsersFeaturesPtrInput interface { pulumi.Input ToGetUsersFeaturesPtrOutput() GetUsersFeaturesPtrOutput ToGetUsersFeaturesPtrOutputWithContext(context.Context) GetUsersFeaturesPtrOutput }
GetUsersFeaturesPtrInput is an input type that accepts GetUsersFeaturesArgs, GetUsersFeaturesPtr and GetUsersFeaturesPtrOutput values. You can construct a concrete instance of `GetUsersFeaturesPtrInput` via:
GetUsersFeaturesArgs{...} or: nil
func GetUsersFeaturesPtr ¶ added in v2.15.0
func GetUsersFeaturesPtr(v *GetUsersFeaturesArgs) GetUsersFeaturesPtrInput
type GetUsersFeaturesPtrOutput ¶ added in v2.15.0
type GetUsersFeaturesPtrOutput struct{ *pulumi.OutputState }
func (GetUsersFeaturesPtrOutput) ConcurrentWorkers ¶ added in v2.15.0
func (o GetUsersFeaturesPtrOutput) ConcurrentWorkers() pulumi.IntPtrOutput
Number of workers to process user data concurrently.
> **Note** Setting `concurrentWorkers` to a value greater than 1 can greatly decrease the time it takes to read the data source.
func (GetUsersFeaturesPtrOutput) Elem ¶ added in v2.15.0
func (o GetUsersFeaturesPtrOutput) Elem() GetUsersFeaturesOutput
func (GetUsersFeaturesPtrOutput) ElementType ¶ added in v2.15.0
func (GetUsersFeaturesPtrOutput) ElementType() reflect.Type
func (GetUsersFeaturesPtrOutput) ToGetUsersFeaturesPtrOutput ¶ added in v2.15.0
func (o GetUsersFeaturesPtrOutput) ToGetUsersFeaturesPtrOutput() GetUsersFeaturesPtrOutput
func (GetUsersFeaturesPtrOutput) ToGetUsersFeaturesPtrOutputWithContext ¶ added in v2.15.0
func (o GetUsersFeaturesPtrOutput) ToGetUsersFeaturesPtrOutputWithContext(ctx context.Context) GetUsersFeaturesPtrOutput
type GetUsersOutputArgs ¶ added in v2.3.0
type GetUsersOutputArgs struct { // A `features` block as defined below. // // DataSource without specifying any arguments will return all users inside an organization. // // List of possible subject types // // <!--Start PulumiCodeChooser --> // “`go // package main // // import ( // "github.com/pulumi/pulumi/sdk/v3/go/pulumi" // ) // // func main() { // pulumi.Run(func(ctx *pulumi.Context) error { // return nil // }) // } // “` // <!--End PulumiCodeChooser --> // // List of possible origins // // <!--Start PulumiCodeChooser --> // “`go // package main // // import ( // "github.com/pulumi/pulumi/sdk/v3/go/pulumi" // ) // // func main() { // pulumi.Run(func(ctx *pulumi.Context) error { // return nil // }) // } // “` // <!--End PulumiCodeChooser --> Features GetUsersFeaturesPtrInput `pulumi:"features"` // The type of source provider for the `originId` parameter (ex:AD, AAD, MSA) The supported origins are listed below. Origin pulumi.StringPtrInput `pulumi:"origin"` // The unique identifier from the system of origin. OriginId pulumi.StringPtrInput `pulumi:"originId"` // The PrincipalName of this graph member from the source provider. PrincipalName pulumi.StringPtrInput `pulumi:"principalName"` // A list of user subject subtypes to reduce the retrieved results, e.g. `msa`, `aad`, `svc` (service identity), `imp` (imported identity), etc. The supported subject types are listed below. SubjectTypes pulumi.StringArrayInput `pulumi:"subjectTypes"` }
A collection of arguments for invoking getUsers.
func (GetUsersOutputArgs) ElementType ¶ added in v2.3.0
func (GetUsersOutputArgs) ElementType() reflect.Type
type GetUsersResult ¶
type GetUsersResult struct { Features *GetUsersFeatures `pulumi:"features"` // The provider-assigned unique ID for this managed resource. Id string `pulumi:"id"` // The type of source provider for the origin identifier (ex:AD, AAD, MSA) Origin *string `pulumi:"origin"` // The unique identifier from the system of origin. Typically a sid, object id or Guid. Linking and unlinking operations can cause this value to change for a user because the user is not backed by a different provider and has a different unique id in the new provider. OriginId *string `pulumi:"originId"` // This is the PrincipalName of this graph member from the source provider. The source provider may change this field over time and it is not guaranteed to be immutable for the life of the graph member by VSTS. PrincipalName *string `pulumi:"principalName"` SubjectTypes []string `pulumi:"subjectTypes"` // A set of existing users in your Azure DevOps Organization with details about every single user which includes: Users []GetUsersUser `pulumi:"users"` }
A collection of values returned by getUsers.
func GetUsers
deprecated
func GetUsers(ctx *pulumi.Context, args *GetUsersArgs, opts ...pulumi.InvokeOption) (*GetUsersResult, error)
Use this data source to access information about an existing users within Azure DevOps.
## Example Usage
<!--Start PulumiCodeChooser --> ```go package main
import (
"github.com/pulumi/pulumi-azuredevops/sdk/v2/go/azuredevops" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := azuredevops.GetUsers(ctx, &azuredevops.GetUsersArgs{ PrincipalName: pulumi.StringRef("contoso-user@contoso.onmicrosoft.com"), }, nil) if err != nil { return err } _, err = azuredevops.GetUsers(ctx, &azuredevops.GetUsersArgs{ Features: azuredevops.GetUsersFeatures{ ConcurrentWorkers: pulumi.IntRef(10), }, }, nil) if err != nil { return err } _, err = azuredevops.GetUsers(ctx, &azuredevops.GetUsersArgs{ Origin: pulumi.StringRef("aad"), }, nil) if err != nil { return err } _, err = azuredevops.GetUsers(ctx, &azuredevops.GetUsersArgs{ SubjectTypes: []string{ "aad", "msa", }, }, nil) if err != nil { return err } _, err = azuredevops.GetUsers(ctx, &azuredevops.GetUsersArgs{ Origin: pulumi.StringRef("aad"), OriginId: pulumi.StringRef("00000000-0000-0000-0000-000000000000"), }, nil) if err != nil { return err } return nil }) }
``` <!--End PulumiCodeChooser -->
## Relevant Links
- [Azure DevOps Service REST API 7.0 - Graph Users API](https://docs.microsoft.com/en-us/rest/api/azure/devops/graph/users?view=azure-devops-rest-7.0)
Deprecated: azuredevops.identities.getUsers has been deprecated in favor of azuredevops.getUsers
type GetUsersResultOutput ¶ added in v2.3.0
type GetUsersResultOutput struct{ *pulumi.OutputState }
A collection of values returned by getUsers.
func GetUsersOutput ¶ added in v2.3.0
func GetUsersOutput(ctx *pulumi.Context, args GetUsersOutputArgs, opts ...pulumi.InvokeOption) GetUsersResultOutput
func (GetUsersResultOutput) ElementType ¶ added in v2.3.0
func (GetUsersResultOutput) ElementType() reflect.Type
func (GetUsersResultOutput) Features ¶ added in v2.15.0
func (o GetUsersResultOutput) Features() GetUsersFeaturesPtrOutput
func (GetUsersResultOutput) Id ¶ added in v2.3.0
func (o GetUsersResultOutput) Id() pulumi.StringOutput
The provider-assigned unique ID for this managed resource.
func (GetUsersResultOutput) Origin ¶ added in v2.3.0
func (o GetUsersResultOutput) Origin() pulumi.StringPtrOutput
The type of source provider for the origin identifier (ex:AD, AAD, MSA)
func (GetUsersResultOutput) OriginId ¶ added in v2.3.0
func (o GetUsersResultOutput) OriginId() pulumi.StringPtrOutput
The unique identifier from the system of origin. Typically a sid, object id or Guid. Linking and unlinking operations can cause this value to change for a user because the user is not backed by a different provider and has a different unique id in the new provider.
func (GetUsersResultOutput) PrincipalName ¶ added in v2.3.0
func (o GetUsersResultOutput) PrincipalName() pulumi.StringPtrOutput
This is the PrincipalName of this graph member from the source provider. The source provider may change this field over time and it is not guaranteed to be immutable for the life of the graph member by VSTS.
func (GetUsersResultOutput) SubjectTypes ¶ added in v2.3.0
func (o GetUsersResultOutput) SubjectTypes() pulumi.StringArrayOutput
func (GetUsersResultOutput) ToGetUsersResultOutput ¶ added in v2.3.0
func (o GetUsersResultOutput) ToGetUsersResultOutput() GetUsersResultOutput
func (GetUsersResultOutput) ToGetUsersResultOutputWithContext ¶ added in v2.3.0
func (o GetUsersResultOutput) ToGetUsersResultOutputWithContext(ctx context.Context) GetUsersResultOutput
func (GetUsersResultOutput) Users ¶ added in v2.3.0
func (o GetUsersResultOutput) Users() GetUsersUserArrayOutput
A set of existing users in your Azure DevOps Organization with details about every single user which includes:
type GetUsersUser ¶
type GetUsersUser struct { // The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. Descriptor string `pulumi:"descriptor"` // This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider. DisplayName string `pulumi:"displayName"` // The user ID. Id string `pulumi:"id"` // The email address of record for a given graph member. This may be different than the principal name. MailAddress string `pulumi:"mailAddress"` // The type of source provider for the `originId` parameter (ex:AD, AAD, MSA) The supported origins are listed below. Origin string `pulumi:"origin"` // The unique identifier from the system of origin. OriginId *string `pulumi:"originId"` // The PrincipalName of this graph member from the source provider. PrincipalName string `pulumi:"principalName"` }
type GetUsersUserArgs ¶
type GetUsersUserArgs struct { // The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. Descriptor pulumi.StringInput `pulumi:"descriptor"` // This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider. DisplayName pulumi.StringInput `pulumi:"displayName"` // The user ID. Id pulumi.StringInput `pulumi:"id"` // The email address of record for a given graph member. This may be different than the principal name. MailAddress pulumi.StringInput `pulumi:"mailAddress"` // The type of source provider for the `originId` parameter (ex:AD, AAD, MSA) The supported origins are listed below. Origin pulumi.StringInput `pulumi:"origin"` // The unique identifier from the system of origin. OriginId pulumi.StringPtrInput `pulumi:"originId"` // The PrincipalName of this graph member from the source provider. PrincipalName pulumi.StringInput `pulumi:"principalName"` }
func (GetUsersUserArgs) ElementType ¶
func (GetUsersUserArgs) ElementType() reflect.Type
func (GetUsersUserArgs) ToGetUsersUserOutput ¶
func (i GetUsersUserArgs) ToGetUsersUserOutput() GetUsersUserOutput
func (GetUsersUserArgs) ToGetUsersUserOutputWithContext ¶
func (i GetUsersUserArgs) ToGetUsersUserOutputWithContext(ctx context.Context) GetUsersUserOutput
type GetUsersUserArray ¶
type GetUsersUserArray []GetUsersUserInput
func (GetUsersUserArray) ElementType ¶
func (GetUsersUserArray) ElementType() reflect.Type
func (GetUsersUserArray) ToGetUsersUserArrayOutput ¶
func (i GetUsersUserArray) ToGetUsersUserArrayOutput() GetUsersUserArrayOutput
func (GetUsersUserArray) ToGetUsersUserArrayOutputWithContext ¶
func (i GetUsersUserArray) ToGetUsersUserArrayOutputWithContext(ctx context.Context) GetUsersUserArrayOutput
type GetUsersUserArrayInput ¶
type GetUsersUserArrayInput interface { pulumi.Input ToGetUsersUserArrayOutput() GetUsersUserArrayOutput ToGetUsersUserArrayOutputWithContext(context.Context) GetUsersUserArrayOutput }
GetUsersUserArrayInput is an input type that accepts GetUsersUserArray and GetUsersUserArrayOutput values. You can construct a concrete instance of `GetUsersUserArrayInput` via:
GetUsersUserArray{ GetUsersUserArgs{...} }
type GetUsersUserArrayOutput ¶
type GetUsersUserArrayOutput struct{ *pulumi.OutputState }
func (GetUsersUserArrayOutput) ElementType ¶
func (GetUsersUserArrayOutput) ElementType() reflect.Type
func (GetUsersUserArrayOutput) Index ¶
func (o GetUsersUserArrayOutput) Index(i pulumi.IntInput) GetUsersUserOutput
func (GetUsersUserArrayOutput) ToGetUsersUserArrayOutput ¶
func (o GetUsersUserArrayOutput) ToGetUsersUserArrayOutput() GetUsersUserArrayOutput
func (GetUsersUserArrayOutput) ToGetUsersUserArrayOutputWithContext ¶
func (o GetUsersUserArrayOutput) ToGetUsersUserArrayOutputWithContext(ctx context.Context) GetUsersUserArrayOutput
type GetUsersUserInput ¶
type GetUsersUserInput interface { pulumi.Input ToGetUsersUserOutput() GetUsersUserOutput ToGetUsersUserOutputWithContext(context.Context) GetUsersUserOutput }
GetUsersUserInput is an input type that accepts GetUsersUserArgs and GetUsersUserOutput values. You can construct a concrete instance of `GetUsersUserInput` via:
GetUsersUserArgs{...}
type GetUsersUserOutput ¶
type GetUsersUserOutput struct{ *pulumi.OutputState }
func (GetUsersUserOutput) Descriptor ¶
func (o GetUsersUserOutput) Descriptor() pulumi.StringOutput
The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.
func (GetUsersUserOutput) DisplayName ¶
func (o GetUsersUserOutput) DisplayName() pulumi.StringOutput
This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.
func (GetUsersUserOutput) ElementType ¶
func (GetUsersUserOutput) ElementType() reflect.Type
func (GetUsersUserOutput) Id ¶ added in v2.3.1
func (o GetUsersUserOutput) Id() pulumi.StringOutput
The user ID.
func (GetUsersUserOutput) MailAddress ¶
func (o GetUsersUserOutput) MailAddress() pulumi.StringOutput
The email address of record for a given graph member. This may be different than the principal name.
func (GetUsersUserOutput) Origin ¶
func (o GetUsersUserOutput) Origin() pulumi.StringOutput
The type of source provider for the `originId` parameter (ex:AD, AAD, MSA) The supported origins are listed below.
func (GetUsersUserOutput) OriginId ¶
func (o GetUsersUserOutput) OriginId() pulumi.StringPtrOutput
The unique identifier from the system of origin.
func (GetUsersUserOutput) PrincipalName ¶
func (o GetUsersUserOutput) PrincipalName() pulumi.StringOutput
The PrincipalName of this graph member from the source provider.
func (GetUsersUserOutput) ToGetUsersUserOutput ¶
func (o GetUsersUserOutput) ToGetUsersUserOutput() GetUsersUserOutput
func (GetUsersUserOutput) ToGetUsersUserOutputWithContext ¶
func (o GetUsersUserOutput) ToGetUsersUserOutputWithContext(ctx context.Context) GetUsersUserOutput
type Group
deprecated
type Group struct { pulumi.CustomResourceState // The Description of the Project. Description pulumi.StringPtrOutput `pulumi:"description"` // The identity (subject) descriptor of the Group. Descriptor pulumi.StringOutput `pulumi:"descriptor"` // The name of a new Azure DevOps group that is not backed by an external provider. The `originId` and `mail` arguments cannot be used simultaneously with `displayName`. DisplayName pulumi.StringOutput `pulumi:"displayName"` // This represents the name of the container of origin for a graph member. Domain pulumi.StringOutput `pulumi:"domain"` // The mail address as a reference to an existing group from an external AD or AAD backed provider. The `scope`, `originId` and `displayName` arguments cannot be used simultaneously with `mail`. Mail pulumi.StringOutput `pulumi:"mail"` // > NOTE: It's possible to define group members both within the `Group` resource via the members block and by using the `GroupMembership` resource. However it's not possible to use both methods to manage group members, since there'll be conflicts. Members pulumi.StringArrayOutput `pulumi:"members"` // The type of source provider for the origin identifier (ex:AD, AAD, MSA) Origin pulumi.StringOutput `pulumi:"origin"` // The OriginID as a reference to a group from an external AD or AAD backed provider. The `scope`, `mail` and `displayName` arguments cannot be used simultaneously with `originId`. OriginId pulumi.StringOutput `pulumi:"originId"` // This is the PrincipalName of this graph member from the source provider. PrincipalName pulumi.StringOutput `pulumi:"principalName"` // The scope of the group. A descriptor referencing the scope (collection, project) in which the group should be created. If omitted, will be created in the scope of the enclosing account or organization.x Scope pulumi.StringPtrOutput `pulumi:"scope"` // This field identifies the type of the graph subject (ex: Group, Scope, User). SubjectKind pulumi.StringOutput `pulumi:"subjectKind"` // This url is the full route to the source resource of this graph subject. Url pulumi.StringOutput `pulumi:"url"` }
Manages a group within Azure DevOps.
## Example Usage
<!--Start PulumiCodeChooser --> ```go package main
import (
"github.com/pulumi/pulumi-azuredevops/sdk/v2/go/azuredevops" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { exampleProject, err := azuredevops.NewProject(ctx, "exampleProject", nil) if err != nil { return err } example_readers := azuredevops.LookupGroupOutput(ctx, azuredevops.GetGroupOutputArgs{ ProjectId: exampleProject.ID(), Name: pulumi.String("Readers"), }, nil) example_contributors := azuredevops.LookupGroupOutput(ctx, azuredevops.GetGroupOutputArgs{ ProjectId: exampleProject.ID(), Name: pulumi.String("Contributors"), }, nil) _, err = azuredevops.NewGroup(ctx, "exampleGroup", &azuredevops.GroupArgs{ Scope: exampleProject.ID(), DisplayName: pulumi.String("Example group"), Description: pulumi.String("Example description"), Members: pulumi.StringArray{ example_readers.ApplyT(func(example_readers azuredevops.GetGroupResult) (*string, error) { return &example_readers.Descriptor, nil }).(pulumi.StringPtrOutput), example_contributors.ApplyT(func(example_contributors azuredevops.GetGroupResult) (*string, error) { return &example_contributors.Descriptor, nil }).(pulumi.StringPtrOutput), }, }) if err != nil { return err } return nil }) }
``` <!--End PulumiCodeChooser -->
## Relevant Links
- [Azure DevOps Service REST API 7.0 - Groups](https://docs.microsoft.com/en-us/rest/api/azure/devops/graph/groups?view=azure-devops-rest-7.0)
## PAT Permissions Required
- **Project & Team**: Read, Write, & Manage
## Import
Azure DevOps groups can be imported using the group identity descriptor, e.g.
```sh $ pulumi import azuredevops:Identities/group:Group example aadgp.Uy0xLTktMTU1MTM3NDI0NS0xMjA0NDAwOTY5LTI0MDI5ODY0MTMtMjE3OTQwODYxNi0zLTIxNjc2NjQyNTMtMzI1Nzg0NDI4OS0yMjU4MjcwOTc0LTI2MDYxODY2NDU ```
Deprecated: azuredevops.identities.Group has been deprecated in favor of azuredevops.Group
func GetGroup ¶
func GetGroup(ctx *pulumi.Context, name string, id pulumi.IDInput, state *GroupState, opts ...pulumi.ResourceOption) (*Group, error)
GetGroup gets an existing Group resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewGroup ¶
func NewGroup(ctx *pulumi.Context, name string, args *GroupArgs, opts ...pulumi.ResourceOption) (*Group, error)
NewGroup registers a new resource with the given unique name, arguments, and options.
func (*Group) ElementType ¶
func (*Group) ToGroupOutput ¶
func (i *Group) ToGroupOutput() GroupOutput
func (*Group) ToGroupOutputWithContext ¶
func (i *Group) ToGroupOutputWithContext(ctx context.Context) GroupOutput
type GroupArgs ¶
type GroupArgs struct { // The Description of the Project. Description pulumi.StringPtrInput // The name of a new Azure DevOps group that is not backed by an external provider. The `originId` and `mail` arguments cannot be used simultaneously with `displayName`. DisplayName pulumi.StringPtrInput // The mail address as a reference to an existing group from an external AD or AAD backed provider. The `scope`, `originId` and `displayName` arguments cannot be used simultaneously with `mail`. Mail pulumi.StringPtrInput // > NOTE: It's possible to define group members both within the `Group` resource via the members block and by using the `GroupMembership` resource. However it's not possible to use both methods to manage group members, since there'll be conflicts. Members pulumi.StringArrayInput // The OriginID as a reference to a group from an external AD or AAD backed provider. The `scope`, `mail` and `displayName` arguments cannot be used simultaneously with `originId`. OriginId pulumi.StringPtrInput // The scope of the group. A descriptor referencing the scope (collection, project) in which the group should be created. If omitted, will be created in the scope of the enclosing account or organization.x Scope pulumi.StringPtrInput }
The set of arguments for constructing a Group resource.
func (GroupArgs) ElementType ¶
type GroupArray ¶
type GroupArray []GroupInput
func (GroupArray) ElementType ¶
func (GroupArray) ElementType() reflect.Type
func (GroupArray) ToGroupArrayOutput ¶
func (i GroupArray) ToGroupArrayOutput() GroupArrayOutput
func (GroupArray) ToGroupArrayOutputWithContext ¶
func (i GroupArray) ToGroupArrayOutputWithContext(ctx context.Context) GroupArrayOutput
type GroupArrayInput ¶
type GroupArrayInput interface { pulumi.Input ToGroupArrayOutput() GroupArrayOutput ToGroupArrayOutputWithContext(context.Context) GroupArrayOutput }
GroupArrayInput is an input type that accepts GroupArray and GroupArrayOutput values. You can construct a concrete instance of `GroupArrayInput` via:
GroupArray{ GroupArgs{...} }
type GroupArrayOutput ¶
type GroupArrayOutput struct{ *pulumi.OutputState }
func (GroupArrayOutput) ElementType ¶
func (GroupArrayOutput) ElementType() reflect.Type
func (GroupArrayOutput) Index ¶
func (o GroupArrayOutput) Index(i pulumi.IntInput) GroupOutput
func (GroupArrayOutput) ToGroupArrayOutput ¶
func (o GroupArrayOutput) ToGroupArrayOutput() GroupArrayOutput
func (GroupArrayOutput) ToGroupArrayOutputWithContext ¶
func (o GroupArrayOutput) ToGroupArrayOutputWithContext(ctx context.Context) GroupArrayOutput
type GroupInput ¶
type GroupInput interface { pulumi.Input ToGroupOutput() GroupOutput ToGroupOutputWithContext(ctx context.Context) GroupOutput }
type GroupMap ¶
type GroupMap map[string]GroupInput
func (GroupMap) ElementType ¶
func (GroupMap) ToGroupMapOutput ¶
func (i GroupMap) ToGroupMapOutput() GroupMapOutput
func (GroupMap) ToGroupMapOutputWithContext ¶
func (i GroupMap) ToGroupMapOutputWithContext(ctx context.Context) GroupMapOutput
type GroupMapInput ¶
type GroupMapInput interface { pulumi.Input ToGroupMapOutput() GroupMapOutput ToGroupMapOutputWithContext(context.Context) GroupMapOutput }
GroupMapInput is an input type that accepts GroupMap and GroupMapOutput values. You can construct a concrete instance of `GroupMapInput` via:
GroupMap{ "key": GroupArgs{...} }
type GroupMapOutput ¶
type GroupMapOutput struct{ *pulumi.OutputState }
func (GroupMapOutput) ElementType ¶
func (GroupMapOutput) ElementType() reflect.Type
func (GroupMapOutput) MapIndex ¶
func (o GroupMapOutput) MapIndex(k pulumi.StringInput) GroupOutput
func (GroupMapOutput) ToGroupMapOutput ¶
func (o GroupMapOutput) ToGroupMapOutput() GroupMapOutput
func (GroupMapOutput) ToGroupMapOutputWithContext ¶
func (o GroupMapOutput) ToGroupMapOutputWithContext(ctx context.Context) GroupMapOutput
type GroupMembership
deprecated
type GroupMembership struct { pulumi.CustomResourceState // The descriptor of the group being managed. Group pulumi.StringOutput `pulumi:"group"` // A list of user or group descriptors that will become members of the group. // > NOTE: It's possible to define group members both within the `GroupMembership resource` via the members block and by using the `Group` resource. However it's not possible to use both methods to manage group members, since there'll be conflicts. Members pulumi.StringArrayOutput `pulumi:"members"` // The mode how the resource manages group members. // - `mode == add`: the resource will ensure that all specified members will be part of the referenced group // - `mode == overwrite`: the resource will replace all existing members with the members specified within the `members` block // > NOTE: To clear all members from a group, specify an empty list of descriptors in the `members` attribute and set the `mode` member to `overwrite`. Mode pulumi.StringPtrOutput `pulumi:"mode"` }
Manages group membership within Azure DevOps.
## Example Usage
<!--Start PulumiCodeChooser --> ```go package main
import (
"github.com/pulumi/pulumi-azuredevops/sdk/v2/go/azuredevops" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { exampleProject, err := azuredevops.NewProject(ctx, "exampleProject", nil) if err != nil { return err } exampleUser, err := azuredevops.NewUser(ctx, "exampleUser", &azuredevops.UserArgs{ PrincipalName: pulumi.String("foo@contoso.com"), }) if err != nil { return err } exampleGroup := azuredevops.LookupGroupOutput(ctx, azuredevops.GetGroupOutputArgs{ ProjectId: exampleProject.ID(), Name: pulumi.String("Build Administrators"), }, nil) _, err = azuredevops.NewGroupMembership(ctx, "exampleGroupMembership", &azuredevops.GroupMembershipArgs{ Group: exampleGroup.ApplyT(func(exampleGroup azuredevops.GetGroupResult) (*string, error) { return &exampleGroup.Descriptor, nil }).(pulumi.StringPtrOutput), Members: pulumi.StringArray{ exampleUser.Descriptor, }, }) if err != nil { return err } return nil }) }
``` <!--End PulumiCodeChooser -->
## Relevant Links
- [Azure DevOps Service REST API 7.0 - Memberships](https://docs.microsoft.com/en-us/rest/api/azure/devops/graph/memberships?view=azure-devops-rest-7.0)
## PAT Permissions Required
- **Deployment Groups**: Read & Manage
## Import
Not supported.
Deprecated: azuredevops.identities.GroupMembership has been deprecated in favor of azuredevops.GroupMembership
func GetGroupMembership ¶
func GetGroupMembership(ctx *pulumi.Context, name string, id pulumi.IDInput, state *GroupMembershipState, opts ...pulumi.ResourceOption) (*GroupMembership, error)
GetGroupMembership gets an existing GroupMembership resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewGroupMembership ¶
func NewGroupMembership(ctx *pulumi.Context, name string, args *GroupMembershipArgs, opts ...pulumi.ResourceOption) (*GroupMembership, error)
NewGroupMembership registers a new resource with the given unique name, arguments, and options.
func (*GroupMembership) ElementType ¶
func (*GroupMembership) ElementType() reflect.Type
func (*GroupMembership) ToGroupMembershipOutput ¶
func (i *GroupMembership) ToGroupMembershipOutput() GroupMembershipOutput
func (*GroupMembership) ToGroupMembershipOutputWithContext ¶
func (i *GroupMembership) ToGroupMembershipOutputWithContext(ctx context.Context) GroupMembershipOutput
type GroupMembershipArgs ¶
type GroupMembershipArgs struct { // The descriptor of the group being managed. Group pulumi.StringInput // A list of user or group descriptors that will become members of the group. // > NOTE: It's possible to define group members both within the `GroupMembership resource` via the members block and by using the `Group` resource. However it's not possible to use both methods to manage group members, since there'll be conflicts. Members pulumi.StringArrayInput // The mode how the resource manages group members. // - `mode == add`: the resource will ensure that all specified members will be part of the referenced group // - `mode == overwrite`: the resource will replace all existing members with the members specified within the `members` block // > NOTE: To clear all members from a group, specify an empty list of descriptors in the `members` attribute and set the `mode` member to `overwrite`. Mode pulumi.StringPtrInput }
The set of arguments for constructing a GroupMembership resource.
func (GroupMembershipArgs) ElementType ¶
func (GroupMembershipArgs) ElementType() reflect.Type
type GroupMembershipArray ¶
type GroupMembershipArray []GroupMembershipInput
func (GroupMembershipArray) ElementType ¶
func (GroupMembershipArray) ElementType() reflect.Type
func (GroupMembershipArray) ToGroupMembershipArrayOutput ¶
func (i GroupMembershipArray) ToGroupMembershipArrayOutput() GroupMembershipArrayOutput
func (GroupMembershipArray) ToGroupMembershipArrayOutputWithContext ¶
func (i GroupMembershipArray) ToGroupMembershipArrayOutputWithContext(ctx context.Context) GroupMembershipArrayOutput
type GroupMembershipArrayInput ¶
type GroupMembershipArrayInput interface { pulumi.Input ToGroupMembershipArrayOutput() GroupMembershipArrayOutput ToGroupMembershipArrayOutputWithContext(context.Context) GroupMembershipArrayOutput }
GroupMembershipArrayInput is an input type that accepts GroupMembershipArray and GroupMembershipArrayOutput values. You can construct a concrete instance of `GroupMembershipArrayInput` via:
GroupMembershipArray{ GroupMembershipArgs{...} }
type GroupMembershipArrayOutput ¶
type GroupMembershipArrayOutput struct{ *pulumi.OutputState }
func (GroupMembershipArrayOutput) ElementType ¶
func (GroupMembershipArrayOutput) ElementType() reflect.Type
func (GroupMembershipArrayOutput) Index ¶
func (o GroupMembershipArrayOutput) Index(i pulumi.IntInput) GroupMembershipOutput
func (GroupMembershipArrayOutput) ToGroupMembershipArrayOutput ¶
func (o GroupMembershipArrayOutput) ToGroupMembershipArrayOutput() GroupMembershipArrayOutput
func (GroupMembershipArrayOutput) ToGroupMembershipArrayOutputWithContext ¶
func (o GroupMembershipArrayOutput) ToGroupMembershipArrayOutputWithContext(ctx context.Context) GroupMembershipArrayOutput
type GroupMembershipInput ¶
type GroupMembershipInput interface { pulumi.Input ToGroupMembershipOutput() GroupMembershipOutput ToGroupMembershipOutputWithContext(ctx context.Context) GroupMembershipOutput }
type GroupMembershipMap ¶
type GroupMembershipMap map[string]GroupMembershipInput
func (GroupMembershipMap) ElementType ¶
func (GroupMembershipMap) ElementType() reflect.Type
func (GroupMembershipMap) ToGroupMembershipMapOutput ¶
func (i GroupMembershipMap) ToGroupMembershipMapOutput() GroupMembershipMapOutput
func (GroupMembershipMap) ToGroupMembershipMapOutputWithContext ¶
func (i GroupMembershipMap) ToGroupMembershipMapOutputWithContext(ctx context.Context) GroupMembershipMapOutput
type GroupMembershipMapInput ¶
type GroupMembershipMapInput interface { pulumi.Input ToGroupMembershipMapOutput() GroupMembershipMapOutput ToGroupMembershipMapOutputWithContext(context.Context) GroupMembershipMapOutput }
GroupMembershipMapInput is an input type that accepts GroupMembershipMap and GroupMembershipMapOutput values. You can construct a concrete instance of `GroupMembershipMapInput` via:
GroupMembershipMap{ "key": GroupMembershipArgs{...} }
type GroupMembershipMapOutput ¶
type GroupMembershipMapOutput struct{ *pulumi.OutputState }
func (GroupMembershipMapOutput) ElementType ¶
func (GroupMembershipMapOutput) ElementType() reflect.Type
func (GroupMembershipMapOutput) MapIndex ¶
func (o GroupMembershipMapOutput) MapIndex(k pulumi.StringInput) GroupMembershipOutput
func (GroupMembershipMapOutput) ToGroupMembershipMapOutput ¶
func (o GroupMembershipMapOutput) ToGroupMembershipMapOutput() GroupMembershipMapOutput
func (GroupMembershipMapOutput) ToGroupMembershipMapOutputWithContext ¶
func (o GroupMembershipMapOutput) ToGroupMembershipMapOutputWithContext(ctx context.Context) GroupMembershipMapOutput
type GroupMembershipOutput ¶
type GroupMembershipOutput struct{ *pulumi.OutputState }
func (GroupMembershipOutput) ElementType ¶
func (GroupMembershipOutput) ElementType() reflect.Type
func (GroupMembershipOutput) Group ¶ added in v2.5.0
func (o GroupMembershipOutput) Group() pulumi.StringOutput
The descriptor of the group being managed.
func (GroupMembershipOutput) Members ¶ added in v2.5.0
func (o GroupMembershipOutput) Members() pulumi.StringArrayOutput
A list of user or group descriptors that will become members of the group. > NOTE: It's possible to define group members both within the `GroupMembership resource` via the members block and by using the `Group` resource. However it's not possible to use both methods to manage group members, since there'll be conflicts.
func (GroupMembershipOutput) Mode ¶ added in v2.5.0
func (o GroupMembershipOutput) Mode() pulumi.StringPtrOutput
The mode how the resource manages group members. - `mode == add`: the resource will ensure that all specified members will be part of the referenced group - `mode == overwrite`: the resource will replace all existing members with the members specified within the `members` block > NOTE: To clear all members from a group, specify an empty list of descriptors in the `members` attribute and set the `mode` member to `overwrite`.
func (GroupMembershipOutput) ToGroupMembershipOutput ¶
func (o GroupMembershipOutput) ToGroupMembershipOutput() GroupMembershipOutput
func (GroupMembershipOutput) ToGroupMembershipOutputWithContext ¶
func (o GroupMembershipOutput) ToGroupMembershipOutputWithContext(ctx context.Context) GroupMembershipOutput
type GroupMembershipState ¶
type GroupMembershipState struct { // The descriptor of the group being managed. Group pulumi.StringPtrInput // A list of user or group descriptors that will become members of the group. // > NOTE: It's possible to define group members both within the `GroupMembership resource` via the members block and by using the `Group` resource. However it's not possible to use both methods to manage group members, since there'll be conflicts. Members pulumi.StringArrayInput // The mode how the resource manages group members. // - `mode == add`: the resource will ensure that all specified members will be part of the referenced group // - `mode == overwrite`: the resource will replace all existing members with the members specified within the `members` block // > NOTE: To clear all members from a group, specify an empty list of descriptors in the `members` attribute and set the `mode` member to `overwrite`. Mode pulumi.StringPtrInput }
func (GroupMembershipState) ElementType ¶
func (GroupMembershipState) ElementType() reflect.Type
type GroupOutput ¶
type GroupOutput struct{ *pulumi.OutputState }
func (GroupOutput) Description ¶ added in v2.5.0
func (o GroupOutput) Description() pulumi.StringPtrOutput
The Description of the Project.
func (GroupOutput) Descriptor ¶ added in v2.5.0
func (o GroupOutput) Descriptor() pulumi.StringOutput
The identity (subject) descriptor of the Group.
func (GroupOutput) DisplayName ¶ added in v2.5.0
func (o GroupOutput) DisplayName() pulumi.StringOutput
The name of a new Azure DevOps group that is not backed by an external provider. The `originId` and `mail` arguments cannot be used simultaneously with `displayName`.
func (GroupOutput) Domain ¶ added in v2.5.0
func (o GroupOutput) Domain() pulumi.StringOutput
This represents the name of the container of origin for a graph member.
func (GroupOutput) ElementType ¶
func (GroupOutput) ElementType() reflect.Type
func (GroupOutput) Mail ¶ added in v2.5.0
func (o GroupOutput) Mail() pulumi.StringOutput
The mail address as a reference to an existing group from an external AD or AAD backed provider. The `scope`, `originId` and `displayName` arguments cannot be used simultaneously with `mail`.
func (GroupOutput) Members ¶ added in v2.5.0
func (o GroupOutput) Members() pulumi.StringArrayOutput
> NOTE: It's possible to define group members both within the `Group` resource via the members block and by using the `GroupMembership` resource. However it's not possible to use both methods to manage group members, since there'll be conflicts.
func (GroupOutput) Origin ¶ added in v2.5.0
func (o GroupOutput) Origin() pulumi.StringOutput
The type of source provider for the origin identifier (ex:AD, AAD, MSA)
func (GroupOutput) OriginId ¶ added in v2.5.0
func (o GroupOutput) OriginId() pulumi.StringOutput
The OriginID as a reference to a group from an external AD or AAD backed provider. The `scope`, `mail` and `displayName` arguments cannot be used simultaneously with `originId`.
func (GroupOutput) PrincipalName ¶ added in v2.5.0
func (o GroupOutput) PrincipalName() pulumi.StringOutput
This is the PrincipalName of this graph member from the source provider.
func (GroupOutput) Scope ¶ added in v2.5.0
func (o GroupOutput) Scope() pulumi.StringPtrOutput
The scope of the group. A descriptor referencing the scope (collection, project) in which the group should be created. If omitted, will be created in the scope of the enclosing account or organization.x
func (GroupOutput) SubjectKind ¶ added in v2.5.0
func (o GroupOutput) SubjectKind() pulumi.StringOutput
This field identifies the type of the graph subject (ex: Group, Scope, User).
func (GroupOutput) ToGroupOutput ¶
func (o GroupOutput) ToGroupOutput() GroupOutput
func (GroupOutput) ToGroupOutputWithContext ¶
func (o GroupOutput) ToGroupOutputWithContext(ctx context.Context) GroupOutput
func (GroupOutput) Url ¶ added in v2.5.0
func (o GroupOutput) Url() pulumi.StringOutput
This url is the full route to the source resource of this graph subject.
type GroupState ¶
type GroupState struct { // The Description of the Project. Description pulumi.StringPtrInput // The identity (subject) descriptor of the Group. Descriptor pulumi.StringPtrInput // The name of a new Azure DevOps group that is not backed by an external provider. The `originId` and `mail` arguments cannot be used simultaneously with `displayName`. DisplayName pulumi.StringPtrInput // This represents the name of the container of origin for a graph member. Domain pulumi.StringPtrInput // The mail address as a reference to an existing group from an external AD or AAD backed provider. The `scope`, `originId` and `displayName` arguments cannot be used simultaneously with `mail`. Mail pulumi.StringPtrInput // > NOTE: It's possible to define group members both within the `Group` resource via the members block and by using the `GroupMembership` resource. However it's not possible to use both methods to manage group members, since there'll be conflicts. Members pulumi.StringArrayInput // The type of source provider for the origin identifier (ex:AD, AAD, MSA) Origin pulumi.StringPtrInput // The OriginID as a reference to a group from an external AD or AAD backed provider. The `scope`, `mail` and `displayName` arguments cannot be used simultaneously with `originId`. OriginId pulumi.StringPtrInput // This is the PrincipalName of this graph member from the source provider. PrincipalName pulumi.StringPtrInput // The scope of the group. A descriptor referencing the scope (collection, project) in which the group should be created. If omitted, will be created in the scope of the enclosing account or organization.x Scope pulumi.StringPtrInput // This field identifies the type of the graph subject (ex: Group, Scope, User). SubjectKind pulumi.StringPtrInput // This url is the full route to the source resource of this graph subject. Url pulumi.StringPtrInput }
func (GroupState) ElementType ¶
func (GroupState) ElementType() reflect.Type
type LookupGroupArgs ¶
type LookupGroupArgs struct { // The Group Name. Name string `pulumi:"name"` // The Project ID. If no project ID is specified the project collection groups will be searched. ProjectId *string `pulumi:"projectId"` }
A collection of arguments for invoking getGroup.
type LookupGroupOutputArgs ¶ added in v2.3.0
type LookupGroupOutputArgs struct { // The Group Name. Name pulumi.StringInput `pulumi:"name"` // The Project ID. If no project ID is specified the project collection groups will be searched. ProjectId pulumi.StringPtrInput `pulumi:"projectId"` }
A collection of arguments for invoking getGroup.
func (LookupGroupOutputArgs) ElementType ¶ added in v2.3.0
func (LookupGroupOutputArgs) ElementType() reflect.Type
type LookupGroupResult ¶
type LookupGroupResult struct { // The Descriptor is the primary way to reference the graph subject. This field will uniquely identify the same graph subject across both Accounts and Organizations. Descriptor string `pulumi:"descriptor"` // The provider-assigned unique ID for this managed resource. Id string `pulumi:"id"` Name string `pulumi:"name"` // The type of source provider for the origin identifier (ex:AD, AAD, MSA) Origin string `pulumi:"origin"` // The unique identifier from the system of origin. Typically a sid, object id or Guid. Linking and unlinking operations can cause this value to change for a user because the user is not backed by a different provider and has a different unique id in the new provider. OriginId string `pulumi:"originId"` ProjectId *string `pulumi:"projectId"` }
A collection of values returned by getGroup.
func LookupGroup
deprecated
func LookupGroup(ctx *pulumi.Context, args *LookupGroupArgs, opts ...pulumi.InvokeOption) (*LookupGroupResult, error)
Use this data source to access information about an existing Group within Azure DevOps
## Example Usage
<!--Start PulumiCodeChooser --> ```go package main
import (
"github.com/pulumi/pulumi-azuredevops/sdk/v2/go/azuredevops" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { exampleProject, err := azuredevops.LookupProject(ctx, &azuredevops.LookupProjectArgs{ Name: pulumi.StringRef("Example Project"), }, nil) if err != nil { return err } exampleGroup, err := azuredevops.LookupGroup(ctx, &azuredevops.LookupGroupArgs{ ProjectId: pulumi.StringRef(exampleProject.Id), Name: "Example Group", }, nil) if err != nil { return err } ctx.Export("groupId", exampleGroup.Id) ctx.Export("groupDescriptor", exampleGroup.Descriptor) _, err = azuredevops.LookupGroup(ctx, &azuredevops.LookupGroupArgs{ Name: "Project Collection Administrators", }, nil) if err != nil { return err } ctx.Export("collectionGroupId", exampleGroup.Id) ctx.Export("collectionGroupDescriptor", exampleGroup.Descriptor) return nil }) }
``` <!--End PulumiCodeChooser -->
## Relevant Links
- [Azure DevOps Service REST API 7.0 - Groups - Get](https://docs.microsoft.com/en-us/rest/api/azure/devops/graph/groups/get?view=azure-devops-rest-7.0)
Deprecated: azuredevops.identities.getGroup has been deprecated in favor of azuredevops.getGroup
type LookupGroupResultOutput ¶ added in v2.3.0
type LookupGroupResultOutput struct{ *pulumi.OutputState }
A collection of values returned by getGroup.
func LookupGroupOutput ¶ added in v2.3.0
func LookupGroupOutput(ctx *pulumi.Context, args LookupGroupOutputArgs, opts ...pulumi.InvokeOption) LookupGroupResultOutput
func (LookupGroupResultOutput) Descriptor ¶ added in v2.3.0
func (o LookupGroupResultOutput) Descriptor() pulumi.StringOutput
The Descriptor is the primary way to reference the graph subject. This field will uniquely identify the same graph subject across both Accounts and Organizations.
func (LookupGroupResultOutput) ElementType ¶ added in v2.3.0
func (LookupGroupResultOutput) ElementType() reflect.Type
func (LookupGroupResultOutput) Id ¶ added in v2.3.0
func (o LookupGroupResultOutput) Id() pulumi.StringOutput
The provider-assigned unique ID for this managed resource.
func (LookupGroupResultOutput) Name ¶ added in v2.3.0
func (o LookupGroupResultOutput) Name() pulumi.StringOutput
func (LookupGroupResultOutput) Origin ¶ added in v2.3.0
func (o LookupGroupResultOutput) Origin() pulumi.StringOutput
The type of source provider for the origin identifier (ex:AD, AAD, MSA)
func (LookupGroupResultOutput) OriginId ¶ added in v2.3.0
func (o LookupGroupResultOutput) OriginId() pulumi.StringOutput
The unique identifier from the system of origin. Typically a sid, object id or Guid. Linking and unlinking operations can cause this value to change for a user because the user is not backed by a different provider and has a different unique id in the new provider.
func (LookupGroupResultOutput) ProjectId ¶ added in v2.3.0
func (o LookupGroupResultOutput) ProjectId() pulumi.StringPtrOutput
func (LookupGroupResultOutput) ToLookupGroupResultOutput ¶ added in v2.3.0
func (o LookupGroupResultOutput) ToLookupGroupResultOutput() LookupGroupResultOutput
func (LookupGroupResultOutput) ToLookupGroupResultOutputWithContext ¶ added in v2.3.0
func (o LookupGroupResultOutput) ToLookupGroupResultOutputWithContext(ctx context.Context) LookupGroupResultOutput