pulumi-azuread 5.48.0a1706744699__py3-none-any.whl → 6.8.0a1766208344__py3-none-any.whl

pulumi_azuread/get_group.py

@@ -1,12 +1,17 @@
 # coding=utf-8
-# *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
+# *** WARNING: this file was generated by pulumi-language-python. ***
 # *** Do not edit by hand unless you're certain you know what you are doing! ***
 
-import copy
+import builtins as _builtins
 import warnings
+import sys
 import pulumi
 import pulumi.runtime
 from typing import Any, Mapping, Optional, Sequence, Union, overload
+if sys.version_info >= (3, 11):
+    from typing import NotRequired, TypedDict, TypeAlias
+else:
+    from typing_extensions import NotRequired, TypedDict, TypeAlias
 from . import _utilities
 from . import outputs
 
@@ -22,7 +27,7 @@ class GetGroupResult:
     """
     A collection of values returned by getGroup.
     """
-    def __init__(__self__, assignable_to_role=None, auto_subscribe_new_members=None, behaviors=None, description=None, display_name=None, dynamic_memberships=None, external_senders_allowed=None, hide_from_address_lists=None, hide_from_outlook_clients=None, id=None, mail=None, mail_enabled=None, mail_nickname=None, members=None, object_id=None, onpremises_domain_name=None, onpremises_group_type=None, onpremises_netbios_name=None, onpremises_sam_account_name=None, onpremises_security_identifier=None, onpremises_sync_enabled=None, owners=None, preferred_language=None, provisioning_options=None, proxy_addresses=None, security_enabled=None, theme=None, types=None, visibility=None, writeback_enabled=None):
+    def __init__(__self__, assignable_to_role=None, auto_subscribe_new_members=None, behaviors=None, description=None, display_name=None, dynamic_memberships=None, external_senders_allowed=None, hide_from_address_lists=None, hide_from_outlook_clients=None, id=None, include_transitive_members=None, mail=None, mail_enabled=None, mail_nickname=None, members=None, object_id=None, onpremises_domain_name=None, onpremises_group_type=None, onpremises_netbios_name=None, onpremises_sam_account_name=None, onpremises_security_identifier=None, onpremises_sync_enabled=None, owners=None, preferred_language=None, provisioning_options=None, proxy_addresses=None, security_enabled=None, theme=None, types=None, visibility=None, writeback_enabled=None):
         if assignable_to_role and not isinstance(assignable_to_role, bool):
             raise TypeError("Expected argument 'assignable_to_role' to be a bool")
         pulumi.set(__self__, "assignable_to_role", assignable_to_role)
@@ -53,6 +58,9 @@ class GetGroupResult:
         if id and not isinstance(id, str):
             raise TypeError("Expected argument 'id' to be a str")
         pulumi.set(__self__, "id", id)
+        if include_transitive_members and not isinstance(include_transitive_members, bool):
+            raise TypeError("Expected argument 'include_transitive_members' to be a bool")
+        pulumi.set(__self__, "include_transitive_members", include_transitive_members)
         if mail and not isinstance(mail, str):
             raise TypeError("Expected argument 'mail' to be a str")
         pulumi.set(__self__, "mail", mail)
@@ -114,47 +122,47 @@ class GetGroupResult:
             raise TypeError("Expected argument 'writeback_enabled' to be a bool")
         pulumi.set(__self__, "writeback_enabled", writeback_enabled)
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="assignableToRole")
-    def assignable_to_role(self) -> bool:
+    def assignable_to_role(self) -> _builtins.bool:
         """
         Indicates whether this group can be assigned to an Azure Active Directory role.
         """
         return pulumi.get(self, "assignable_to_role")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="autoSubscribeNewMembers")
-    def auto_subscribe_new_members(self) -> bool:
+    def auto_subscribe_new_members(self) -> _builtins.bool:
         """
         Indicates whether new members added to the group will be auto-subscribed to receive email notifications. Only set for Unified groups.
         """
         return pulumi.get(self, "auto_subscribe_new_members")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def behaviors(self) -> Sequence[str]:
+    def behaviors(self) -> Sequence[_builtins.str]:
         """
         A list of behaviors for a Microsoft 365 group, such as `AllowOnlyMembersToPost`, `HideGroupInOutlook`, `SubscribeNewGroupMembers` and `WelcomeEmailDisabled`. See [official documentation](https://docs.microsoft.com/en-us/graph/group-set-options) for more details.
         """
         return pulumi.get(self, "behaviors")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def description(self) -> str:
+    def description(self) -> _builtins.str:
         """
         The optional description of the group.
         """
         return pulumi.get(self, "description")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="displayName")
-    def display_name(self) -> str:
+    def display_name(self) -> _builtins.str:
         """
         The display name for the group.
         """
         return pulumi.get(self, "display_name")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="dynamicMemberships")
     def dynamic_memberships(self) -> Sequence['outputs.GetGroupDynamicMembershipResult']:
         """
@@ -162,193 +170,198 @@ class GetGroupResult:
         """
         return pulumi.get(self, "dynamic_memberships")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="externalSendersAllowed")
-    def external_senders_allowed(self) -> bool:
+    def external_senders_allowed(self) -> _builtins.bool:
         """
         Indicates whether people external to the organization can send messages to the group. Only set for Unified groups.
         """
         return pulumi.get(self, "external_senders_allowed")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="hideFromAddressLists")
-    def hide_from_address_lists(self) -> bool:
+    def hide_from_address_lists(self) -> _builtins.bool:
         """
         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. Only set for Unified groups.
         """
         return pulumi.get(self, "hide_from_address_lists")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="hideFromOutlookClients")
-    def hide_from_outlook_clients(self) -> bool:
+    def hide_from_outlook_clients(self) -> _builtins.bool:
         """
         Indicates whether the group is displayed in Outlook clients, such as Outlook for Windows and Outlook on the web. Only set for Unified groups.
         """
         return pulumi.get(self, "hide_from_outlook_clients")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def id(self) -> str:
+    def id(self) -> _builtins.str:
         """
         The provider-assigned unique ID for this managed resource.
         """
         return pulumi.get(self, "id")
 
-    @property
+    @_builtins.property
+    @pulumi.getter(name="includeTransitiveMembers")
+    def include_transitive_members(self) -> Optional[_builtins.bool]:
+        return pulumi.get(self, "include_transitive_members")
+
+    @_builtins.property
     @pulumi.getter
-    def mail(self) -> str:
+    def mail(self) -> _builtins.str:
         """
         The SMTP address for the group.
         """
         return pulumi.get(self, "mail")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="mailEnabled")
-    def mail_enabled(self) -> bool:
+    def mail_enabled(self) -> _builtins.bool:
         """
         Whether the group is mail-enabled.
         """
         return pulumi.get(self, "mail_enabled")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="mailNickname")
-    def mail_nickname(self) -> str:
+    def mail_nickname(self) -> _builtins.str:
         """
         The mail alias for the group, unique in the organisation.
         """
         return pulumi.get(self, "mail_nickname")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def members(self) -> Sequence[str]:
+    def members(self) -> Sequence[_builtins.str]:
         """
-        List of object IDs of the group members.
+        List of object IDs of the group members. When `include_transitive_members` is `true`, contains a list of object IDs of all transitive group members.
         """
         return pulumi.get(self, "members")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="objectId")
-    def object_id(self) -> str:
+    def object_id(self) -> _builtins.str:
         """
         The object ID of the group.
         """
         return pulumi.get(self, "object_id")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="onpremisesDomainName")
-    def onpremises_domain_name(self) -> str:
+    def onpremises_domain_name(self) -> _builtins.str:
         """
         The on-premises FQDN, also called dnsDomainName, synchronised from the on-premises directory when Azure AD Connect is used.
         """
         return pulumi.get(self, "onpremises_domain_name")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="onpremisesGroupType")
-    def onpremises_group_type(self) -> str:
+    def onpremises_group_type(self) -> _builtins.str:
         """
         The on-premises group type that the AAD group will be written as, when writeback is enabled. Possible values are `UniversalDistributionGroup`, `UniversalMailEnabledSecurityGroup`, or `UniversalSecurityGroup`.
         """
         return pulumi.get(self, "onpremises_group_type")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="onpremisesNetbiosName")
-    def onpremises_netbios_name(self) -> str:
+    def onpremises_netbios_name(self) -> _builtins.str:
         """
         The on-premises NetBIOS name, synchronised from the on-premises directory when Azure AD Connect is used.
         """
         return pulumi.get(self, "onpremises_netbios_name")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="onpremisesSamAccountName")
-    def onpremises_sam_account_name(self) -> str:
+    def onpremises_sam_account_name(self) -> _builtins.str:
         """
         The on-premises SAM account name, synchronised from the on-premises directory when Azure AD Connect is used.
         """
         return pulumi.get(self, "onpremises_sam_account_name")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="onpremisesSecurityIdentifier")
-    def onpremises_security_identifier(self) -> str:
+    def onpremises_security_identifier(self) -> _builtins.str:
         """
         The on-premises security identifier (SID), synchronised from the on-premises directory when Azure AD Connect is used.
         """
         return pulumi.get(self, "onpremises_security_identifier")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="onpremisesSyncEnabled")
-    def onpremises_sync_enabled(self) -> bool:
+    def onpremises_sync_enabled(self) -> _builtins.bool:
         """
         Whether this group is synchronised from an on-premises directory (`true`), no longer synchronised (`false`), or has never been synchronised (`null`).
         """
         return pulumi.get(self, "onpremises_sync_enabled")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def owners(self) -> Sequence[str]:
+    def owners(self) -> Sequence[_builtins.str]:
         """
         List of object IDs of the group owners.
         """
         return pulumi.get(self, "owners")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="preferredLanguage")
-    def preferred_language(self) -> str:
+    def preferred_language(self) -> _builtins.str:
         """
         The preferred language for a Microsoft 365 group, in ISO 639-1 notation.
         """
         return pulumi.get(self, "preferred_language")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="provisioningOptions")
-    def provisioning_options(self) -> Sequence[str]:
+    def provisioning_options(self) -> Sequence[_builtins.str]:
         """
         A list of provisioning options for a Microsoft 365 group, such as `Team`. See [official documentation](https://docs.microsoft.com/en-us/graph/group-set-options) for details.
         """
         return pulumi.get(self, "provisioning_options")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="proxyAddresses")
-    def proxy_addresses(self) -> Sequence[str]:
+    def proxy_addresses(self) -> Sequence[_builtins.str]:
         """
         List of email addresses for the group that direct to the same group mailbox.
         """
         return pulumi.get(self, "proxy_addresses")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="securityEnabled")
-    def security_enabled(self) -> bool:
+    def security_enabled(self) -> _builtins.bool:
         """
         Whether the group is a security group.
         """
         return pulumi.get(self, "security_enabled")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def theme(self) -> str:
+    def theme(self) -> _builtins.str:
         """
         The colour theme for a Microsoft 365 group. Possible values are `Blue`, `Green`, `Orange`, `Pink`, `Purple`, `Red` or `Teal`. When no theme is set, the value is `null`.
         """
         return pulumi.get(self, "theme")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def types(self) -> Sequence[str]:
+    def types(self) -> Sequence[_builtins.str]:
         """
         A list of group types configured for the group. Supported values are `DynamicMembership`, which denotes a group with dynamic membership, and `Unified`, which specifies a Microsoft 365 group.
         """
         return pulumi.get(self, "types")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def visibility(self) -> str:
+    def visibility(self) -> _builtins.str:
         """
         The group join policy and group content visibility. Possible values are `Private`, `Public`, or `Hiddenmembership`. Only Microsoft 365 groups can have `Hiddenmembership` visibility.
         """
         return pulumi.get(self, "visibility")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="writebackEnabled")
-    def writeback_enabled(self) -> bool:
+    def writeback_enabled(self) -> _builtins.bool:
         """
         Whether the group will be written back to the configured on-premises Active Directory when Azure AD Connect is used.
         """
@@ -371,6 +384,7 @@ class AwaitableGetGroupResult(GetGroupResult):
             hide_from_address_lists=self.hide_from_address_lists,
             hide_from_outlook_clients=self.hide_from_outlook_clients,
             id=self.id,
+            include_transitive_members=self.include_transitive_members,
             mail=self.mail,
             mail_enabled=self.mail_enabled,
             mail_nickname=self.mail_nickname,
@@ -393,11 +407,12 @@ class AwaitableGetGroupResult(GetGroupResult):
             writeback_enabled=self.writeback_enabled)
 
 
-def get_group(display_name: Optional[str] = None,
-              mail_enabled: Optional[bool] = None,
-              mail_nickname: Optional[str] = None,
-              object_id: Optional[str] = None,
-              security_enabled: Optional[bool] = None,
+def get_group(display_name: Optional[_builtins.str] = None,
+              include_transitive_members: Optional[_builtins.bool] = None,
+              mail_enabled: Optional[_builtins.bool] = None,
+              mail_nickname: Optional[_builtins.str] = None,
+              object_id: Optional[_builtins.str] = None,
+              security_enabled: Optional[_builtins.bool] = None,
               opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetGroupResult:
     """
     Gets information about an Azure Active Directory group.
@@ -411,6 +426,7 @@ def get_group(display_name: Optional[str] = None,
     When authenticated with a user principal, this data source does not require any additional roles.
 
     ## Example Usage
+
     ### By Group Display Name)
 
     ```python
@@ -422,16 +438,18 @@ def get_group(display_name: Optional[str] = None,
     ```
 
 
-    :param str display_name: The display name for the group.
-    :param bool mail_enabled: Whether the group is mail-enabled.
-    :param str mail_nickname: The mail alias for the group, unique in the organisation.
-    :param str object_id: Specifies the object ID of the group.
-    :param bool security_enabled: Whether the group is a security group.
+    :param _builtins.str display_name: The display name for the group.
+    :param _builtins.bool include_transitive_members: Whether to include transitive members (a flat list of all nested members). Defaults to `false`.
+    :param _builtins.bool mail_enabled: Whether the group is mail-enabled.
+    :param _builtins.str mail_nickname: The mail alias for the group, unique in the organisation.
+    :param _builtins.str object_id: Specifies the object ID of the group.
+    :param _builtins.bool security_enabled: Whether the group is a security group.
            
            > One of `display_name`, `object_id` or `mail_nickname` must be specified.
     """
     __args__ = dict()
     __args__['displayName'] = display_name
+    __args__['includeTransitiveMembers'] = include_transitive_members
     __args__['mailEnabled'] = mail_enabled
     __args__['mailNickname'] = mail_nickname
     __args__['objectId'] = object_id
@@ -450,6 +468,7 @@ def get_group(display_name: Optional[str] = None,
         hide_from_address_lists=pulumi.get(__ret__, 'hide_from_address_lists'),
         hide_from_outlook_clients=pulumi.get(__ret__, 'hide_from_outlook_clients'),
         id=pulumi.get(__ret__, 'id'),
+        include_transitive_members=pulumi.get(__ret__, 'include_transitive_members'),
         mail=pulumi.get(__ret__, 'mail'),
         mail_enabled=pulumi.get(__ret__, 'mail_enabled'),
         mail_nickname=pulumi.get(__ret__, 'mail_nickname'),
@@ -470,15 +489,13 @@ def get_group(display_name: Optional[str] = None,
         types=pulumi.get(__ret__, 'types'),
         visibility=pulumi.get(__ret__, 'visibility'),
         writeback_enabled=pulumi.get(__ret__, 'writeback_enabled'))
-
-
-@_utilities.lift_output_func(get_group)
-def get_group_output(display_name: Optional[pulumi.Input[Optional[str]]] = None,
-                     mail_enabled: Optional[pulumi.Input[Optional[bool]]] = None,
-                     mail_nickname: Optional[pulumi.Input[Optional[str]]] = None,
-                     object_id: Optional[pulumi.Input[Optional[str]]] = None,
-                     security_enabled: Optional[pulumi.Input[Optional[bool]]] = None,
-                     opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetGroupResult]:
+def get_group_output(display_name: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                     include_transitive_members: Optional[pulumi.Input[Optional[_builtins.bool]]] = None,
+                     mail_enabled: Optional[pulumi.Input[Optional[_builtins.bool]]] = None,
+                     mail_nickname: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                     object_id: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                     security_enabled: Optional[pulumi.Input[Optional[_builtins.bool]]] = None,
+                     opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetGroupResult]:
     """
     Gets information about an Azure Active Directory group.
 
@@ -491,6 +508,7 @@ def get_group_output(display_name: Optional[pulumi.Input[Optional[str]]] = None,
     When authenticated with a user principal, this data source does not require any additional roles.
 
     ## Example Usage
+
     ### By Group Display Name)
 
     ```python
@@ -502,12 +520,53 @@ def get_group_output(display_name: Optional[pulumi.Input[Optional[str]]] = None,
     ```
 
 
-    :param str display_name: The display name for the group.
-    :param bool mail_enabled: Whether the group is mail-enabled.
-    :param str mail_nickname: The mail alias for the group, unique in the organisation.
-    :param str object_id: Specifies the object ID of the group.
-    :param bool security_enabled: Whether the group is a security group.
+    :param _builtins.str display_name: The display name for the group.
+    :param _builtins.bool include_transitive_members: Whether to include transitive members (a flat list of all nested members). Defaults to `false`.
+    :param _builtins.bool mail_enabled: Whether the group is mail-enabled.
+    :param _builtins.str mail_nickname: The mail alias for the group, unique in the organisation.
+    :param _builtins.str object_id: Specifies the object ID of the group.
+    :param _builtins.bool security_enabled: Whether the group is a security group.
            
            > One of `display_name`, `object_id` or `mail_nickname` must be specified.
     """
-    ...
+    __args__ = dict()
+    __args__['displayName'] = display_name
+    __args__['includeTransitiveMembers'] = include_transitive_members
+    __args__['mailEnabled'] = mail_enabled
+    __args__['mailNickname'] = mail_nickname
+    __args__['objectId'] = object_id
+    __args__['securityEnabled'] = security_enabled
+    opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke_output('azuread:index/getGroup:getGroup', __args__, opts=opts, typ=GetGroupResult)
+    return __ret__.apply(lambda __response__: GetGroupResult(
+        assignable_to_role=pulumi.get(__response__, 'assignable_to_role'),
+        auto_subscribe_new_members=pulumi.get(__response__, 'auto_subscribe_new_members'),
+        behaviors=pulumi.get(__response__, 'behaviors'),
+        description=pulumi.get(__response__, 'description'),
+        display_name=pulumi.get(__response__, 'display_name'),
+        dynamic_memberships=pulumi.get(__response__, 'dynamic_memberships'),
+        external_senders_allowed=pulumi.get(__response__, 'external_senders_allowed'),
+        hide_from_address_lists=pulumi.get(__response__, 'hide_from_address_lists'),
+        hide_from_outlook_clients=pulumi.get(__response__, 'hide_from_outlook_clients'),
+        id=pulumi.get(__response__, 'id'),
+        include_transitive_members=pulumi.get(__response__, 'include_transitive_members'),
+        mail=pulumi.get(__response__, 'mail'),
+        mail_enabled=pulumi.get(__response__, 'mail_enabled'),
+        mail_nickname=pulumi.get(__response__, 'mail_nickname'),
+        members=pulumi.get(__response__, 'members'),
+        object_id=pulumi.get(__response__, 'object_id'),
+        onpremises_domain_name=pulumi.get(__response__, 'onpremises_domain_name'),
+        onpremises_group_type=pulumi.get(__response__, 'onpremises_group_type'),
+        onpremises_netbios_name=pulumi.get(__response__, 'onpremises_netbios_name'),
+        onpremises_sam_account_name=pulumi.get(__response__, 'onpremises_sam_account_name'),
+        onpremises_security_identifier=pulumi.get(__response__, 'onpremises_security_identifier'),
+        onpremises_sync_enabled=pulumi.get(__response__, 'onpremises_sync_enabled'),
+        owners=pulumi.get(__response__, 'owners'),
+        preferred_language=pulumi.get(__response__, 'preferred_language'),
+        provisioning_options=pulumi.get(__response__, 'provisioning_options'),
+        proxy_addresses=pulumi.get(__response__, 'proxy_addresses'),
+        security_enabled=pulumi.get(__response__, 'security_enabled'),
+        theme=pulumi.get(__response__, 'theme'),
+        types=pulumi.get(__response__, 'types'),
+        visibility=pulumi.get(__response__, 'visibility'),
+        writeback_enabled=pulumi.get(__response__, 'writeback_enabled')))