1. Docs
  2. Reference
  3. API
  4. Azure AD
  5. Group

Group

Create a Group Resource

new Group(name: string, args?: GroupArgs, opts?: CustomResourceOptions);
def Group(resource_name, opts=None, description=None, members=None, name=None, owners=None, __props__=None);
func NewGroup(ctx *Context, name string, args *GroupArgs, opts ...ResourceOption) (*Group, error)
public Group(string name, GroupArgs? args = null, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args GroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args GroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args GroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

Group Resource Properties

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

Inputs

The Group resource accepts the following input properties:

Description string

The description for the Group. Changing this forces a new resource to be created.

Members List<string>

A set of members who should be present in this Group. Supported Object types are Users, Groups or Service Principals.

Name string

The display name for the Group. Changing this forces a new resource to be created.

Owners List<string>

A set of owners who own this Group. Supported Object types are Users or Service Principals.

Description string

The description for the Group. Changing this forces a new resource to be created.

Members []string

A set of members who should be present in this Group. Supported Object types are Users, Groups or Service Principals.

Name string

The display name for the Group. Changing this forces a new resource to be created.

Owners []string

A set of owners who own this Group. Supported Object types are Users or Service Principals.

description string

The description for the Group. Changing this forces a new resource to be created.

members string[]

A set of members who should be present in this Group. Supported Object types are Users, Groups or Service Principals.

name string

The display name for the Group. Changing this forces a new resource to be created.

owners string[]

A set of owners who own this Group. Supported Object types are Users or Service Principals.

description str

The description for the Group. Changing this forces a new resource to be created.

members List[str]

A set of members who should be present in this Group. Supported Object types are Users, Groups or Service Principals.

name str

The display name for the Group. Changing this forces a new resource to be created.

owners List[str]

A set of owners who own this Group. Supported Object types are Users or Service Principals.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
ObjectId string
Id string
The provider-assigned unique ID for this managed resource.
ObjectId string
id string
The provider-assigned unique ID for this managed resource.
objectId string
id str
The provider-assigned unique ID for this managed resource.
object_id str

Look up an Existing Group Resource

Get an existing Group 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?: GroupState, opts?: CustomResourceOptions): Group
static get(resource_name, id, opts=None, description=None, members=None, name=None, object_id=None, owners=None, __props__=None);
func GetGroup(ctx *Context, name string, id IDInput, state *GroupState, opts ...ResourceOption) (*Group, error)
public static Group Get(string name, Input<string> id, GroupState? state, CustomResourceOptions? opts = null)
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.

The following state arguments are supported:

Description string

The description for the Group. Changing this forces a new resource to be created.

Members List<string>

A set of members who should be present in this Group. Supported Object types are Users, Groups or Service Principals.

Name string

The display name for the Group. Changing this forces a new resource to be created.

ObjectId string
Owners List<string>

A set of owners who own this Group. Supported Object types are Users or Service Principals.

Description string

The description for the Group. Changing this forces a new resource to be created.

Members []string

A set of members who should be present in this Group. Supported Object types are Users, Groups or Service Principals.

Name string

The display name for the Group. Changing this forces a new resource to be created.

ObjectId string
Owners []string

A set of owners who own this Group. Supported Object types are Users or Service Principals.

description string

The description for the Group. Changing this forces a new resource to be created.

members string[]

A set of members who should be present in this Group. Supported Object types are Users, Groups or Service Principals.

name string

The display name for the Group. Changing this forces a new resource to be created.

objectId string
owners string[]

A set of owners who own this Group. Supported Object types are Users or Service Principals.

description str

The description for the Group. Changing this forces a new resource to be created.

members List[str]

A set of members who should be present in this Group. Supported Object types are Users, Groups or Service Principals.

name str

The display name for the Group. Changing this forces a new resource to be created.

object_id str
owners List[str]

A set of owners who own this Group. Supported Object types are Users or Service Principals.

Package Details

Repository
https://github.com/pulumi/pulumi-azuread
License
Apache-2.0
Notes
This Pulumi package is based on the azuread Terraform Provider.