Skip to content

Latest commit

 

History

History
3257 lines (2067 loc) · 131 KB

group.python.md

File metadata and controls

3257 lines (2067 loc) · 131 KB
Raw

group Submodule

Constructs

Group

Represents a {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group azuread_group}.

Initializers 

from cdktf_cdktf_provider_azuread import group

group.Group(
  scope: Construct,
  id: str,
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  display_name: str,
  administrative_unit_ids: typing.List[str] = None,
  assignable_to_role: typing.Union[bool, IResolvable] = None,
  auto_subscribe_new_members: typing.Union[bool, IResolvable] = None,
  behaviors: typing.List[str] = None,
  description: str = None,
  dynamic_membership: GroupDynamicMembership = None,
  external_senders_allowed: typing.Union[bool, IResolvable] = None,
  hide_from_address_lists: typing.Union[bool, IResolvable] = None,
  hide_from_outlook_clients: typing.Union[bool, IResolvable] = None,
  id: str = None,
  mail_enabled: typing.Union[bool, IResolvable] = None,
  mail_nickname: str = None,
  members: typing.List[str] = None,
  onpremises_group_type: str = None,
  owners: typing.List[str] = None,
  prevent_duplicate_names: typing.Union[bool, IResolvable] = None,
  provisioning_options: typing.List[str] = None,
  security_enabled: typing.Union[bool, IResolvable] = None,
  theme: str = None,
  timeouts: GroupTimeouts = None,
  types: typing.List[str] = None,
  visibility: str = None,
  writeback_enabled: typing.Union[bool, IResolvable] = None
)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id str The scoped construct ID.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
display_name str The display name for the group.
administrative_unit_ids typing.List[str] The administrative unit IDs in which the group should be.
assignable_to_role typing.Union[bool, cdktf.IResolvable] Indicates whether this group can be assigned to an Azure Active Directory role.
auto_subscribe_new_members typing.Union[bool, cdktf.IResolvable] Indicates whether new members added to the group will be auto-subscribed to receive email notifications.
behaviors typing.List[str] The group behaviours for a Microsoft 365 group.
description str The description for the group.
dynamic_membership GroupDynamicMembership dynamic_membership block.
external_senders_allowed typing.Union[bool, cdktf.IResolvable] Indicates whether people external to the organization can send messages to the group.
hide_from_address_lists typing.Union[bool, cdktf.IResolvable] Indicates whether the group is displayed in certain parts of the Outlook user interface: in the Address Book, in address lists for selecting message recipients, and in the Browse Groups dialog for searching groups.
hide_from_outlook_clients typing.Union[bool, cdktf.IResolvable] Indicates whether the group is displayed in Outlook clients, such as Outlook for Windows and Outlook on the web.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#id Group#id}.
mail_enabled typing.Union[bool, cdktf.IResolvable] Whether the group is a mail enabled, with a shared group mailbox.
mail_nickname str The mail alias for the group, unique in the organisation.
members typing.List[str] A set of members who should be present in this group.
onpremises_group_type str Indicates the target on-premise group type the group will be written back as.
owners typing.List[str] A set of owners who own this group. Supported object types are Users or Service Principals.
prevent_duplicate_names typing.Union[bool, cdktf.IResolvable] If true, will return an error if an existing group is found with the same name.
provisioning_options typing.List[str] The group provisioning options for a Microsoft 365 group.
security_enabled typing.Union[bool, cdktf.IResolvable] Whether the group is a security group for controlling access to in-app resources.
theme str The colour theme for a Microsoft 365 group.
timeouts GroupTimeouts timeouts block.
types typing.List[str] A set of group types to configure for the group.
visibility str Specifies the group join policy and group content visibility.
writeback_enabled typing.Union[bool, cdktf.IResolvable] Whether this group should be synced from Azure AD to the on-premises directory when Azure AD Connect is used.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional
  • Type: cdktf.ITerraformIterator
lifecycleOptional
  • Type: cdktf.TerraformResourceLifecycle
providerOptional
  • Type: cdktf.TerraformProvider
provisionersOptional
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
display_nameRequired
  • Type: str

The display name for the group.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#display_name Group#display_name}

administrative_unit_idsOptional
  • Type: typing.List[str]

The administrative unit IDs in which the group should be.

If empty, the group will be created at the tenant level.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#administrative_unit_ids Group#administrative_unit_ids}

assignable_to_roleOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Indicates whether this group can be assigned to an Azure Active Directory role.

This property can only be true for security-enabled groups.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#assignable_to_role Group#assignable_to_role}

auto_subscribe_new_membersOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Indicates whether new members added to the group will be auto-subscribed to receive email notifications.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#auto_subscribe_new_members Group#auto_subscribe_new_members}

behaviorsOptional
  • Type: typing.List[str]

The group behaviours for a Microsoft 365 group.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#behaviors Group#behaviors}

descriptionOptional
  • Type: str

The description for the group.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#description Group#description}

dynamic_membershipOptional

dynamic_membership block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#dynamic_membership Group#dynamic_membership}

external_senders_allowedOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Indicates whether people external to the organization can send messages to the group.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#external_senders_allowed Group#external_senders_allowed}

hide_from_address_listsOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Indicates whether the group is displayed in certain parts of the Outlook user interface: in the Address Book, in address lists for selecting message recipients, and in the Browse Groups dialog for searching groups.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#hide_from_address_lists Group#hide_from_address_lists}

hide_from_outlook_clientsOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Indicates whether the group is displayed in Outlook clients, such as Outlook for Windows and Outlook on the web.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#hide_from_outlook_clients Group#hide_from_outlook_clients}

idOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#id Group#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

mail_enabledOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Whether the group is a mail enabled, with a shared group mailbox.

At least one of mail_enabled or security_enabled must be specified. A group can be mail enabled and security enabled

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#mail_enabled Group#mail_enabled}

mail_nicknameOptional
  • Type: str

The mail alias for the group, unique in the organisation.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#mail_nickname Group#mail_nickname}

membersOptional
  • Type: typing.List[str]

A set of members who should be present in this group.

Supported object types are Users, Groups or Service Principals

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#members Group#members}

onpremises_group_typeOptional
  • Type: str

Indicates the target on-premise group type the group will be written back as.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#onpremises_group_type Group#onpremises_group_type}

ownersOptional
  • Type: typing.List[str]

A set of owners who own this group. Supported object types are Users or Service Principals.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#owners Group#owners}

prevent_duplicate_namesOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

If true, will return an error if an existing group is found with the same name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#prevent_duplicate_names Group#prevent_duplicate_names}

provisioning_optionsOptional
  • Type: typing.List[str]

The group provisioning options for a Microsoft 365 group.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#provisioning_options Group#provisioning_options}

security_enabledOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Whether the group is a security group for controlling access to in-app resources.

At least one of security_enabled or mail_enabled must be specified. A group can be security enabled and mail enabled

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#security_enabled Group#security_enabled}

themeOptional
  • Type: str

The colour theme for a Microsoft 365 group.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#theme Group#theme}

timeoutsOptional

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#timeouts Group#timeouts}

typesOptional
  • Type: typing.List[str]

A set of group types to configure for the group.

Unified specifies a Microsoft 365 group. Required when mail_enabled is true

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#types Group#types}

visibilityOptional
  • Type: str

Specifies the group join policy and group content visibility.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#visibility Group#visibility}

writeback_enabledOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Whether this group should be synced from Azure AD to the on-premises directory when Azure AD Connect is used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#writeback_enabled Group#writeback_enabled}

Methods

Name Description
to_string Returns a string representation of this construct.
add_override No description.
override_logical_id Overrides the auto-generated logical ID with a specific ID.
reset_override_logical_id Resets a previously passed logical Id to use the auto-generated logical id again.
to_hcl_terraform No description.
to_metadata No description.
to_terraform Adds this resource to the terraform JSON output.
add_move_target Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
has_resource_move No description.
import_from No description.
interpolation_for_attribute No description.
move_from_id Move the resource corresponding to "id" to this resource.
move_to Moves this resource to the target resource given by moveTarget.
move_to_id Moves this resource to the resource corresponding to "id".
put_dynamic_membership No description.
put_timeouts No description.
reset_administrative_unit_ids No description.
reset_assignable_to_role No description.
reset_auto_subscribe_new_members No description.
reset_behaviors No description.
reset_description No description.
reset_dynamic_membership No description.
reset_external_senders_allowed No description.
reset_hide_from_address_lists No description.
reset_hide_from_outlook_clients No description.
reset_id No description.
reset_mail_enabled No description.
reset_mail_nickname No description.
reset_members No description.
reset_onpremises_group_type No description.
reset_owners No description.
reset_prevent_duplicate_names No description.
reset_provisioning_options No description.
reset_security_enabled No description.
reset_theme No description.
reset_timeouts No description.
reset_types No description.
reset_visibility No description.
reset_writeback_enabled No description.
to_string 
def to_string() -> str

Returns a string representation of this construct.

add_override 
def add_override(
  path: str,
  value: typing.Any
) -> None
pathRequired
  • Type: str
valueRequired
  • Type: typing.Any
override_logical_id 
def override_logical_id(
  new_logical_id: str
) -> None

Overrides the auto-generated logical ID with a specific ID.

new_logical_idRequired
  • Type: str

The new logical ID to use for this stack element.

reset_override_logical_id 
def reset_override_logical_id() -> None

Resets a previously passed logical Id to use the auto-generated logical id again.

to_hcl_terraform 
def to_hcl_terraform() -> typing.Any
to_metadata 
def to_metadata() -> typing.Any
to_terraform 
def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

add_move_target 
def add_move_target(
  move_target: str
) -> None

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

move_targetRequired
  • Type: str

The string move target that will correspond to this resource.

get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
has_resource_move 
def has_resource_move() -> typing.Union[TerraformResourceMoveByTarget, TerraformResourceMoveById]
import_from 
def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None
idRequired
  • Type: str
providerOptional
  • Type: cdktf.TerraformProvider
interpolation_for_attribute 
def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
move_from_id 
def move_from_id(
  id: str
) -> None

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: str

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

move_to 
def move_to(
  move_target: str,
  index: typing.Union[str, typing.Union[int, float]] = None
) -> None

Moves this resource to the target resource given by moveTarget.

move_targetRequired
  • Type: str

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

indexOptional
  • Type: typing.Union[str, typing.Union[int, float]]

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

move_to_id 
def move_to_id(
  id: str
) -> None

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: str

Full id of resource to move to, e.g. "aws_s3_bucket.example".

put_dynamic_membership 
def put_dynamic_membership(
  enabled: typing.Union[bool, IResolvable],
  rule: str
) -> None
enabledRequired
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#enabled Group#enabled}.

ruleRequired
  • Type: str

Rule to determine members for a dynamic group. Required when group_types contains 'DynamicMembership'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#rule Group#rule}

put_timeouts 
def put_timeouts(
  create: str = None,
  delete: str = None,
  read: str = None,
  update: str = None
) -> None
createOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#create Group#create}.

deleteOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#delete Group#delete}.

readOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#read Group#read}.

updateOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#update Group#update}.

reset_administrative_unit_ids 
def reset_administrative_unit_ids() -> None
reset_assignable_to_role 
def reset_assignable_to_role() -> None
reset_auto_subscribe_new_members 
def reset_auto_subscribe_new_members() -> None
reset_behaviors 
def reset_behaviors() -> None
reset_description 
def reset_description() -> None
reset_dynamic_membership 
def reset_dynamic_membership() -> None
reset_external_senders_allowed 
def reset_external_senders_allowed() -> None
reset_hide_from_address_lists 
def reset_hide_from_address_lists() -> None
reset_hide_from_outlook_clients 
def reset_hide_from_outlook_clients() -> None
reset_id 
def reset_id() -> None
reset_mail_enabled 
def reset_mail_enabled() -> None
reset_mail_nickname 
def reset_mail_nickname() -> None
reset_members 
def reset_members() -> None
reset_onpremises_group_type 
def reset_onpremises_group_type() -> None
reset_owners 
def reset_owners() -> None
reset_prevent_duplicate_names 
def reset_prevent_duplicate_names() -> None
reset_provisioning_options 
def reset_provisioning_options() -> None
reset_security_enabled 
def reset_security_enabled() -> None
reset_theme 
def reset_theme() -> None
reset_timeouts 
def reset_timeouts() -> None
reset_types 
def reset_types() -> None
reset_visibility 
def reset_visibility() -> None
reset_writeback_enabled 
def reset_writeback_enabled() -> None

Static Functions

Name Description
is_construct Checks if x is a construct.
is_terraform_element No description.
is_terraform_resource No description.
generate_config_for_import Generates CDKTF code for importing a Group resource upon running "cdktf plan ".
is_construct 
from cdktf_cdktf_provider_azuread import group

group.Group.is_construct(
  x: typing.Any
)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: typing.Any

Any object.

is_terraform_element 
from cdktf_cdktf_provider_azuread import group

group.Group.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_resource 
from cdktf_cdktf_provider_azuread import group

group.Group.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktf_cdktf_provider_azuread import group

group.Group.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

Generates CDKTF code for importing a Group resource upon running "cdktf plan ".

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

import_to_idRequired
  • Type: str

The construct id used in the generated config for the Group to import.

import_from_idRequired
  • Type: str

The id of the existing Group that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: cdktf.TerraformProvider

? Optional instance of the provider where the Group to import is found.

Properties

Name Type Description
node constructs.Node The tree node.
cdktf_stack cdktf.TerraformStack No description.
fqn str No description.
friendly_unique_id str No description.
terraform_meta_arguments typing.Mapping[typing.Any] No description.
terraform_resource_type str No description.
terraform_generator_metadata cdktf.TerraformProviderGeneratorMetadata No description.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[str] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
dynamic_membership GroupDynamicMembershipOutputReference No description.
mail str No description.
object_id str No description.
onpremises_domain_name str No description.
onpremises_netbios_name str No description.
onpremises_sam_account_name str No description.
onpremises_security_identifier str No description.
onpremises_sync_enabled cdktf.IResolvable No description.
preferred_language str No description.
proxy_addresses typing.List[str] No description.
timeouts GroupTimeoutsOutputReference No description.
administrative_unit_ids_input typing.List[str] No description.
assignable_to_role_input typing.Union[bool, cdktf.IResolvable] No description.
auto_subscribe_new_members_input typing.Union[bool, cdktf.IResolvable] No description.
behaviors_input typing.List[str] No description.
description_input str No description.
display_name_input str No description.
dynamic_membership_input GroupDynamicMembership No description.
external_senders_allowed_input typing.Union[bool, cdktf.IResolvable] No description.
hide_from_address_lists_input typing.Union[bool, cdktf.IResolvable] No description.
hide_from_outlook_clients_input typing.Union[bool, cdktf.IResolvable] No description.
id_input str No description.
mail_enabled_input typing.Union[bool, cdktf.IResolvable] No description.
mail_nickname_input str No description.
members_input typing.List[str] No description.
onpremises_group_type_input str No description.
owners_input typing.List[str] No description.
prevent_duplicate_names_input typing.Union[bool, cdktf.IResolvable] No description.
provisioning_options_input typing.List[str] No description.
security_enabled_input typing.Union[bool, cdktf.IResolvable] No description.
theme_input str No description.
timeouts_input typing.Union[cdktf.IResolvable, GroupTimeouts] No description.
types_input typing.List[str] No description.
visibility_input str No description.
writeback_enabled_input typing.Union[bool, cdktf.IResolvable] No description.
administrative_unit_ids typing.List[str] No description.
assignable_to_role typing.Union[bool, cdktf.IResolvable] No description.
auto_subscribe_new_members typing.Union[bool, cdktf.IResolvable] No description.
behaviors typing.List[str] No description.
description str No description.
display_name str No description.
external_senders_allowed typing.Union[bool, cdktf.IResolvable] No description.
hide_from_address_lists typing.Union[bool, cdktf.IResolvable] No description.
hide_from_outlook_clients typing.Union[bool, cdktf.IResolvable] No description.
id str No description.
mail_enabled typing.Union[bool, cdktf.IResolvable] No description.
mail_nickname str No description.
members typing.List[str] No description.
onpremises_group_type str No description.
owners typing.List[str] No description.
prevent_duplicate_names typing.Union[bool, cdktf.IResolvable] No description.
provisioning_options typing.List[str] No description.
security_enabled typing.Union[bool, cdktf.IResolvable] No description.
theme str No description.
types typing.List[str] No description.
visibility str No description.
writeback_enabled typing.Union[bool, cdktf.IResolvable] No description.
nodeRequired 
node: Node
  • Type: constructs.Node

The tree node.

cdktf_stackRequired 
cdktf_stack: TerraformStack
  • Type: cdktf.TerraformStack
fqnRequired 
fqn: str
  • Type: str
friendly_unique_idRequired 
friendly_unique_id: str
  • Type: str
terraform_meta_argumentsRequired 
terraform_meta_arguments: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]
terraform_resource_typeRequired 
terraform_resource_type: str
  • Type: str
terraform_generator_metadataOptional 
terraform_generator_metadata: TerraformProviderGeneratorMetadata
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[str]
  • Type: typing.List[str]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
dynamic_membershipRequired 
dynamic_membership: GroupDynamicMembershipOutputReference
mailRequired 
mail: str
  • Type: str
object_idRequired 
object_id: str
  • Type: str
onpremises_domain_nameRequired 
onpremises_domain_name: str
  • Type: str
onpremises_netbios_nameRequired 
onpremises_netbios_name: str
  • Type: str
onpremises_sam_account_nameRequired 
onpremises_sam_account_name: str
  • Type: str
onpremises_security_identifierRequired 
onpremises_security_identifier: str
  • Type: str
onpremises_sync_enabledRequired 
onpremises_sync_enabled: IResolvable
  • Type: cdktf.IResolvable
preferred_languageRequired 
preferred_language: str
  • Type: str
proxy_addressesRequired 
proxy_addresses: typing.List[str]
  • Type: typing.List[str]
timeoutsRequired 
timeouts: GroupTimeoutsOutputReference
administrative_unit_ids_inputOptional 
administrative_unit_ids_input: typing.List[str]
  • Type: typing.List[str]
assignable_to_role_inputOptional 
assignable_to_role_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
auto_subscribe_new_members_inputOptional 
auto_subscribe_new_members_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
behaviors_inputOptional 
behaviors_input: typing.List[str]
  • Type: typing.List[str]
description_inputOptional 
description_input: str
  • Type: str
display_name_inputOptional 
display_name_input: str
  • Type: str
dynamic_membership_inputOptional 
dynamic_membership_input: GroupDynamicMembership
external_senders_allowed_inputOptional 
external_senders_allowed_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
hide_from_address_lists_inputOptional 
hide_from_address_lists_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
hide_from_outlook_clients_inputOptional 
hide_from_outlook_clients_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
id_inputOptional 
id_input: str
  • Type: str
mail_enabled_inputOptional 
mail_enabled_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
mail_nickname_inputOptional 
mail_nickname_input: str
  • Type: str
members_inputOptional 
members_input: typing.List[str]
  • Type: typing.List[str]
onpremises_group_type_inputOptional 
onpremises_group_type_input: str
  • Type: str
owners_inputOptional 
owners_input: typing.List[str]
  • Type: typing.List[str]
prevent_duplicate_names_inputOptional 
prevent_duplicate_names_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
provisioning_options_inputOptional 
provisioning_options_input: typing.List[str]
  • Type: typing.List[str]
security_enabled_inputOptional 
security_enabled_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
theme_inputOptional 
theme_input: str
  • Type: str
timeouts_inputOptional 
timeouts_input: typing.Union[IResolvable, GroupTimeouts]
types_inputOptional 
types_input: typing.List[str]
  • Type: typing.List[str]
visibility_inputOptional 
visibility_input: str
  • Type: str
writeback_enabled_inputOptional 
writeback_enabled_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
administrative_unit_idsRequired 
administrative_unit_ids: typing.List[str]
  • Type: typing.List[str]
assignable_to_roleRequired 
assignable_to_role: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
auto_subscribe_new_membersRequired 
auto_subscribe_new_members: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
behaviorsRequired 
behaviors: typing.List[str]
  • Type: typing.List[str]
descriptionRequired 
description: str
  • Type: str
display_nameRequired 
display_name: str
  • Type: str
external_senders_allowedRequired 
external_senders_allowed: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
hide_from_address_listsRequired 
hide_from_address_lists: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
hide_from_outlook_clientsRequired 
hide_from_outlook_clients: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
idRequired 
id: str
  • Type: str
mail_enabledRequired 
mail_enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
mail_nicknameRequired 
mail_nickname: str
  • Type: str
membersRequired 
members: typing.List[str]
  • Type: typing.List[str]
onpremises_group_typeRequired 
onpremises_group_type: str
  • Type: str
ownersRequired 
owners: typing.List[str]
  • Type: typing.List[str]
prevent_duplicate_namesRequired 
prevent_duplicate_names: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
provisioning_optionsRequired 
provisioning_options: typing.List[str]
  • Type: typing.List[str]
security_enabledRequired 
security_enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
themeRequired 
theme: str
  • Type: str
typesRequired 
types: typing.List[str]
  • Type: typing.List[str]
visibilityRequired 
visibility: str
  • Type: str
writeback_enabledRequired 
writeback_enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Constants

Name Type Description
tfResourceType str No description.
tfResourceTypeRequired 
tfResourceType: str
  • Type: str

Structs

GroupConfig

Initializer 

from cdktf_cdktf_provider_azuread import group

group.GroupConfig(
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  display_name: str,
  administrative_unit_ids: typing.List[str] = None,
  assignable_to_role: typing.Union[bool, IResolvable] = None,
  auto_subscribe_new_members: typing.Union[bool, IResolvable] = None,
  behaviors: typing.List[str] = None,
  description: str = None,
  dynamic_membership: GroupDynamicMembership = None,
  external_senders_allowed: typing.Union[bool, IResolvable] = None,
  hide_from_address_lists: typing.Union[bool, IResolvable] = None,
  hide_from_outlook_clients: typing.Union[bool, IResolvable] = None,
  id: str = None,
  mail_enabled: typing.Union[bool, IResolvable] = None,
  mail_nickname: str = None,
  members: typing.List[str] = None,
  onpremises_group_type: str = None,
  owners: typing.List[str] = None,
  prevent_duplicate_names: typing.Union[bool, IResolvable] = None,
  provisioning_options: typing.List[str] = None,
  security_enabled: typing.Union[bool, IResolvable] = None,
  theme: str = None,
  timeouts: GroupTimeouts = None,
  types: typing.List[str] = None,
  visibility: str = None,
  writeback_enabled: typing.Union[bool, IResolvable] = None
)

Properties

Name Type Description
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
display_name str The display name for the group.
administrative_unit_ids typing.List[str] The administrative unit IDs in which the group should be.
assignable_to_role typing.Union[bool, cdktf.IResolvable] Indicates whether this group can be assigned to an Azure Active Directory role.
auto_subscribe_new_members typing.Union[bool, cdktf.IResolvable] Indicates whether new members added to the group will be auto-subscribed to receive email notifications.
behaviors typing.List[str] The group behaviours for a Microsoft 365 group.
description str The description for the group.
dynamic_membership GroupDynamicMembership dynamic_membership block.
external_senders_allowed typing.Union[bool, cdktf.IResolvable] Indicates whether people external to the organization can send messages to the group.
hide_from_address_lists typing.Union[bool, cdktf.IResolvable] Indicates whether the group is displayed in certain parts of the Outlook user interface: in the Address Book, in address lists for selecting message recipients, and in the Browse Groups dialog for searching groups.
hide_from_outlook_clients typing.Union[bool, cdktf.IResolvable] Indicates whether the group is displayed in Outlook clients, such as Outlook for Windows and Outlook on the web.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#id Group#id}.
mail_enabled typing.Union[bool, cdktf.IResolvable] Whether the group is a mail enabled, with a shared group mailbox.
mail_nickname str The mail alias for the group, unique in the organisation.
members typing.List[str] A set of members who should be present in this group.
onpremises_group_type str Indicates the target on-premise group type the group will be written back as.
owners typing.List[str] A set of owners who own this group. Supported object types are Users or Service Principals.
prevent_duplicate_names typing.Union[bool, cdktf.IResolvable] If true, will return an error if an existing group is found with the same name.
provisioning_options typing.List[str] The group provisioning options for a Microsoft 365 group.
security_enabled typing.Union[bool, cdktf.IResolvable] Whether the group is a security group for controlling access to in-app resources.
theme str The colour theme for a Microsoft 365 group.
timeouts GroupTimeouts timeouts block.
types typing.List[str] A set of group types to configure for the group.
visibility str Specifies the group join policy and group content visibility.
writeback_enabled typing.Union[bool, cdktf.IResolvable] Whether this group should be synced from Azure AD to the on-premises directory when Azure AD Connect is used.
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[ITerraformDependable]
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
display_nameRequired 
display_name: str
  • Type: str

The display name for the group.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#display_name Group#display_name}

administrative_unit_idsOptional 
administrative_unit_ids: typing.List[str]
  • Type: typing.List[str]

The administrative unit IDs in which the group should be.

If empty, the group will be created at the tenant level.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#administrative_unit_ids Group#administrative_unit_ids}

assignable_to_roleOptional 
assignable_to_role: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Indicates whether this group can be assigned to an Azure Active Directory role.

This property can only be true for security-enabled groups.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#assignable_to_role Group#assignable_to_role}

auto_subscribe_new_membersOptional 
auto_subscribe_new_members: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Indicates whether new members added to the group will be auto-subscribed to receive email notifications.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#auto_subscribe_new_members Group#auto_subscribe_new_members}

behaviorsOptional 
behaviors: typing.List[str]
  • Type: typing.List[str]

The group behaviours for a Microsoft 365 group.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#behaviors Group#behaviors}

descriptionOptional 
description: str
  • Type: str

The description for the group.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#description Group#description}

dynamic_membershipOptional 
dynamic_membership: GroupDynamicMembership

dynamic_membership block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#dynamic_membership Group#dynamic_membership}

external_senders_allowedOptional 
external_senders_allowed: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Indicates whether people external to the organization can send messages to the group.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#external_senders_allowed Group#external_senders_allowed}

hide_from_address_listsOptional 
hide_from_address_lists: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Indicates whether the group is displayed in certain parts of the Outlook user interface: in the Address Book, in address lists for selecting message recipients, and in the Browse Groups dialog for searching groups.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#hide_from_address_lists Group#hide_from_address_lists}

hide_from_outlook_clientsOptional 
hide_from_outlook_clients: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Indicates whether the group is displayed in Outlook clients, such as Outlook for Windows and Outlook on the web.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#hide_from_outlook_clients Group#hide_from_outlook_clients}

idOptional 
id: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#id Group#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

mail_enabledOptional 
mail_enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Whether the group is a mail enabled, with a shared group mailbox.

At least one of mail_enabled or security_enabled must be specified. A group can be mail enabled and security enabled

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#mail_enabled Group#mail_enabled}

mail_nicknameOptional 
mail_nickname: str
  • Type: str

The mail alias for the group, unique in the organisation.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#mail_nickname Group#mail_nickname}

membersOptional 
members: typing.List[str]
  • Type: typing.List[str]

A set of members who should be present in this group.

Supported object types are Users, Groups or Service Principals

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#members Group#members}

onpremises_group_typeOptional 
onpremises_group_type: str
  • Type: str

Indicates the target on-premise group type the group will be written back as.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#onpremises_group_type Group#onpremises_group_type}

ownersOptional 
owners: typing.List[str]
  • Type: typing.List[str]

A set of owners who own this group. Supported object types are Users or Service Principals.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#owners Group#owners}

prevent_duplicate_namesOptional 
prevent_duplicate_names: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

If true, will return an error if an existing group is found with the same name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#prevent_duplicate_names Group#prevent_duplicate_names}

provisioning_optionsOptional 
provisioning_options: typing.List[str]
  • Type: typing.List[str]

The group provisioning options for a Microsoft 365 group.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#provisioning_options Group#provisioning_options}

security_enabledOptional 
security_enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Whether the group is a security group for controlling access to in-app resources.

At least one of security_enabled or mail_enabled must be specified. A group can be security enabled and mail enabled

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#security_enabled Group#security_enabled}

themeOptional 
theme: str
  • Type: str

The colour theme for a Microsoft 365 group.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#theme Group#theme}

timeoutsOptional 
timeouts: GroupTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#timeouts Group#timeouts}

typesOptional 
types: typing.List[str]
  • Type: typing.List[str]

A set of group types to configure for the group.

Unified specifies a Microsoft 365 group. Required when mail_enabled is true

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#types Group#types}

visibilityOptional 
visibility: str
  • Type: str

Specifies the group join policy and group content visibility.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#visibility Group#visibility}

writeback_enabledOptional 
writeback_enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Whether this group should be synced from Azure AD to the on-premises directory when Azure AD Connect is used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#writeback_enabled Group#writeback_enabled}

GroupDynamicMembership

Initializer 

from cdktf_cdktf_provider_azuread import group

group.GroupDynamicMembership(
  enabled: typing.Union[bool, IResolvable],
  rule: str
)

Properties

Name Type Description
enabled typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#enabled Group#enabled}.
rule str Rule to determine members for a dynamic group. Required when group_types contains 'DynamicMembership'.
enabledRequired 
enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#enabled Group#enabled}.

ruleRequired 
rule: str
  • Type: str

Rule to determine members for a dynamic group. Required when group_types contains 'DynamicMembership'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#rule Group#rule}

GroupTimeouts

Initializer 

from cdktf_cdktf_provider_azuread import group

group.GroupTimeouts(
  create: str = None,
  delete: str = None,
  read: str = None,
  update: str = None
)

Properties

Name Type Description
create str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#create Group#create}.
delete str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#delete Group#delete}.
read str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#read Group#read}.
update str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#update Group#update}.
createOptional 
create: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#create Group#create}.

deleteOptional 
delete: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#delete Group#delete}.

readOptional 
read: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#read Group#read}.

updateOptional 
update: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/group#update Group#update}.

Classes

GroupDynamicMembershipOutputReference

Initializers 

from cdktf_cdktf_provider_azuread import group

group.GroupDynamicMembershipOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
compute_fqn 
def compute_fqn() -> str
get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
enabled_input typing.Union[bool, cdktf.IResolvable] No description.
rule_input str No description.
enabled typing.Union[bool, cdktf.IResolvable] No description.
rule str No description.
internal_value GroupDynamicMembership No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str
enabled_inputOptional 
enabled_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
rule_inputOptional 
rule_input: str
  • Type: str
enabledRequired 
enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
ruleRequired 
rule: str
  • Type: str
internal_valueOptional 
internal_value: GroupDynamicMembership

GroupTimeoutsOutputReference

Initializers 

from cdktf_cdktf_provider_azuread import group

group.GroupTimeoutsOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
reset_create No description.
reset_delete No description.
reset_read No description.
reset_update No description.
compute_fqn 
def compute_fqn() -> str
get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_create 
def reset_create() -> None
reset_delete 
def reset_delete() -> None
reset_read 
def reset_read() -> None
reset_update 
def reset_update() -> None

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
create_input str No description.
delete_input str No description.
read_input str No description.
update_input str No description.
create str No description.
delete str No description.
read str No description.
update str No description.
internal_value typing.Union[cdktf.IResolvable, GroupTimeouts] No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str
create_inputOptional 
create_input: str
  • Type: str
delete_inputOptional 
delete_input: str
  • Type: str
read_inputOptional 
read_input: str
  • Type: str
update_inputOptional 
update_input: str
  • Type: str
createRequired 
create: str
  • Type: str
deleteRequired 
delete: str
  • Type: str
readRequired 
read: str
  • Type: str
updateRequired 
update: str
  • Type: str
internal_valueOptional 
internal_value: typing.Union[IResolvable, GroupTimeouts]