azuread.getGroup
Gets information about an Azure Active Directory group.
API Permissions
The following API permissions are required in order to use this data source.
When authenticated with a service principal, this data source requires one of the following application roles: Group.Read.All
or Directory.Read.All
When authenticated with a user principal, this data source does not require any additional roles.
Example Usage
By Group Display Name)
using System.Collections.Generic;
using Pulumi;
using AzureAD = Pulumi.AzureAD;
return await Deployment.RunAsync(() =>
{
var example = AzureAD.GetGroup.Invoke(new()
{
DisplayName = "MyGroupName",
SecurityEnabled = true,
});
});
package main
import (
"github.com/pulumi/pulumi-azuread/sdk/v5/go/azuread"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := azuread.LookupGroup(ctx, &azuread.LookupGroupArgs{
DisplayName: pulumi.StringRef("MyGroupName"),
SecurityEnabled: pulumi.BoolRef(true),
}, nil)
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azuread.AzureadFunctions;
import com.pulumi.azuread.inputs.GetGroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var example = AzureadFunctions.getGroup(GetGroupArgs.builder()
.displayName("MyGroupName")
.securityEnabled(true)
.build());
}
}
import pulumi
import pulumi_azuread as azuread
example = azuread.get_group(display_name="MyGroupName",
security_enabled=True)
import * as pulumi from "@pulumi/pulumi";
import * as azuread from "@pulumi/azuread";
const example = azuread.getGroup({
displayName: "MyGroupName",
securityEnabled: true,
});
variables:
example:
fn::invoke:
Function: azuread:getGroup
Arguments:
displayName: MyGroupName
securityEnabled: true
Using getGroup
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getGroup(args: GetGroupArgs, opts?: InvokeOptions): Promise<GetGroupResult>
function getGroupOutput(args: GetGroupOutputArgs, opts?: InvokeOptions): Output<GetGroupResult>
def get_group(display_name: Optional[str] = None,
mail_enabled: Optional[bool] = None,
object_id: Optional[str] = None,
security_enabled: Optional[bool] = None,
opts: Optional[InvokeOptions] = None) -> GetGroupResult
def get_group_output(display_name: Optional[pulumi.Input[str]] = None,
mail_enabled: Optional[pulumi.Input[bool]] = None,
object_id: Optional[pulumi.Input[str]] = None,
security_enabled: Optional[pulumi.Input[bool]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetGroupResult]
func LookupGroup(ctx *Context, args *LookupGroupArgs, opts ...InvokeOption) (*LookupGroupResult, error)
func LookupGroupOutput(ctx *Context, args *LookupGroupOutputArgs, opts ...InvokeOption) LookupGroupResultOutput
> Note: This function is named LookupGroup
in the Go SDK.
public static class GetGroup
{
public static Task<GetGroupResult> InvokeAsync(GetGroupArgs args, InvokeOptions? opts = null)
public static Output<GetGroupResult> Invoke(GetGroupInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetGroupResult> getGroup(GetGroupArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azuread:index/getGroup:getGroup
arguments:
# arguments dictionary
The following arguments are supported:
- Display
Name string The display name for the group.
- Mail
Enabled bool Whether the group is mail-enabled.
- Object
Id string Specifies the object ID of the group.
- Security
Enabled bool Whether the group is a security group.
- Display
Name string The display name for the group.
- Mail
Enabled bool Whether the group is mail-enabled.
- Object
Id string Specifies the object ID of the group.
- Security
Enabled bool Whether the group is a security group.
- display
Name String The display name for the group.
- mail
Enabled Boolean Whether the group is mail-enabled.
- object
Id String Specifies the object ID of the group.
- security
Enabled Boolean Whether the group is a security group.
- display
Name string The display name for the group.
- mail
Enabled boolean Whether the group is mail-enabled.
- object
Id string Specifies the object ID of the group.
- security
Enabled boolean Whether the group is a security group.
- display_
name str The display name for the group.
- mail_
enabled bool Whether the group is mail-enabled.
- object_
id str Specifies the object ID of the group.
- security_
enabled bool Whether the group is a security group.
- display
Name String The display name for the group.
- mail
Enabled Boolean Whether the group is mail-enabled.
- object
Id String Specifies the object ID of the group.
- security
Enabled Boolean Whether the group is a security group.
getGroup Result
The following output properties are available:
- Assignable
To boolRole Indicates whether this group can be assigned to an Azure Active Directory role.
- Auto
Subscribe boolNew Members Indicates whether new members added to the group will be auto-subscribed to receive email notifications. Only set for Unified groups.
- Behaviors List<string>
A list of behaviors for a Microsoft 365 group, such as
AllowOnlyMembersToPost
,HideGroupInOutlook
,SubscribeNewGroupMembers
andWelcomeEmailDisabled
. See official documentation for more details.- Description string
The optional description of the group.
- Display
Name string The display name for the group.
- Dynamic
Memberships List<Pulumi.Azure AD. Outputs. Get Group Dynamic Membership> A
dynamic_membership
block as documented below.- External
Senders boolAllowed Indicates whether people external to the organization can send messages to the group. Only set for Unified groups.
- Hide
From boolAddress Lists 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.
- Hide
From boolOutlook Clients Indicates whether the group is displayed in Outlook clients, such as Outlook for Windows and Outlook on the web. Only set for Unified groups.
- Id string
The provider-assigned unique ID for this managed resource.
- Mail string
The SMTP address for the group.
- Mail
Enabled bool Whether the group is mail-enabled.
- Mail
Nickname string The mail alias for the group, unique in the organisation.
- Members List<string>
List of object IDs of the group members.
- Object
Id string The object ID of the group.
- Onpremises
Domain stringName The on-premises FQDN, also called dnsDomainName, synchronised from the on-premises directory when Azure AD Connect is used.
- Onpremises
Netbios stringName The on-premises NetBIOS name, synchronised from the on-premises directory when Azure AD Connect is used.
- Onpremises
Sam stringAccount Name The on-premises SAM account name, synchronised from the on-premises directory when Azure AD Connect is used.
- Onpremises
Security stringIdentifier The on-premises security identifier (SID), synchronised from the on-premises directory when Azure AD Connect is used.
- Onpremises
Sync boolEnabled Whether this group is synchronised from an on-premises directory (
true
), no longer synchronised (false
), or has never been synchronised (null
).- Owners List<string>
List of object IDs of the group owners.
- Preferred
Language string The preferred language for a Microsoft 365 group, in ISO 639-1 notation.
- Provisioning
Options List<string> A list of provisioning options for a Microsoft 365 group, such as
Team
. See official documentation for details.- Proxy
Addresses List<string> List of email addresses for the group that direct to the same group mailbox.
- Security
Enabled bool Whether the group is a security group.
- Theme string
The colour theme for a Microsoft 365 group. Possible values are
Blue
,Green
,Orange
,Pink
,Purple
,Red
orTeal
. When no theme is set, the value isnull
.- Types List<string>
A list of group types configured for the group. Supported values are
DynamicMembership
, which denotes a group with dynamic membership, andUnified
, which specifies a Microsoft 365 group.- Visibility string
The group join policy and group content visibility. Possible values are
Private
,Public
, orHiddenmembership
. Only Microsoft 365 groups can haveHiddenmembership
visibility.
- Assignable
To boolRole Indicates whether this group can be assigned to an Azure Active Directory role.
- Auto
Subscribe boolNew Members Indicates whether new members added to the group will be auto-subscribed to receive email notifications. Only set for Unified groups.
- Behaviors []string
A list of behaviors for a Microsoft 365 group, such as
AllowOnlyMembersToPost
,HideGroupInOutlook
,SubscribeNewGroupMembers
andWelcomeEmailDisabled
. See official documentation for more details.- Description string
The optional description of the group.
- Display
Name string The display name for the group.
- Dynamic
Memberships []GetGroup Dynamic Membership A
dynamic_membership
block as documented below.- External
Senders boolAllowed Indicates whether people external to the organization can send messages to the group. Only set for Unified groups.
- Hide
From boolAddress Lists 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.
- Hide
From boolOutlook Clients Indicates whether the group is displayed in Outlook clients, such as Outlook for Windows and Outlook on the web. Only set for Unified groups.
- Id string
The provider-assigned unique ID for this managed resource.
- Mail string
The SMTP address for the group.
- Mail
Enabled bool Whether the group is mail-enabled.
- Mail
Nickname string The mail alias for the group, unique in the organisation.
- Members []string
List of object IDs of the group members.
- Object
Id string The object ID of the group.
- Onpremises
Domain stringName The on-premises FQDN, also called dnsDomainName, synchronised from the on-premises directory when Azure AD Connect is used.
- Onpremises
Netbios stringName The on-premises NetBIOS name, synchronised from the on-premises directory when Azure AD Connect is used.
- Onpremises
Sam stringAccount Name The on-premises SAM account name, synchronised from the on-premises directory when Azure AD Connect is used.
- Onpremises
Security stringIdentifier The on-premises security identifier (SID), synchronised from the on-premises directory when Azure AD Connect is used.
- Onpremises
Sync boolEnabled Whether this group is synchronised from an on-premises directory (
true
), no longer synchronised (false
), or has never been synchronised (null
).- Owners []string
List of object IDs of the group owners.
- Preferred
Language string The preferred language for a Microsoft 365 group, in ISO 639-1 notation.
- Provisioning
Options []string A list of provisioning options for a Microsoft 365 group, such as
Team
. See official documentation for details.- Proxy
Addresses []string List of email addresses for the group that direct to the same group mailbox.
- Security
Enabled bool Whether the group is a security group.
- Theme string
The colour theme for a Microsoft 365 group. Possible values are
Blue
,Green
,Orange
,Pink
,Purple
,Red
orTeal
. When no theme is set, the value isnull
.- Types []string
A list of group types configured for the group. Supported values are
DynamicMembership
, which denotes a group with dynamic membership, andUnified
, which specifies a Microsoft 365 group.- Visibility string
The group join policy and group content visibility. Possible values are
Private
,Public
, orHiddenmembership
. Only Microsoft 365 groups can haveHiddenmembership
visibility.
- assignable
To BooleanRole Indicates whether this group can be assigned to an Azure Active Directory role.
- auto
Subscribe BooleanNew Members Indicates whether new members added to the group will be auto-subscribed to receive email notifications. Only set for Unified groups.
- behaviors List<String>
A list of behaviors for a Microsoft 365 group, such as
AllowOnlyMembersToPost
,HideGroupInOutlook
,SubscribeNewGroupMembers
andWelcomeEmailDisabled
. See official documentation for more details.- description String
The optional description of the group.
- display
Name String The display name for the group.
- dynamic
Memberships List<GetGroup Dynamic Membership> A
dynamic_membership
block as documented below.- external
Senders BooleanAllowed Indicates whether people external to the organization can send messages to the group. Only set for Unified groups.
- hide
From BooleanAddress Lists 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.
- hide
From BooleanOutlook Clients Indicates whether the group is displayed in Outlook clients, such as Outlook for Windows and Outlook on the web. Only set for Unified groups.
- id String
The provider-assigned unique ID for this managed resource.
- mail String
The SMTP address for the group.
- mail
Enabled Boolean Whether the group is mail-enabled.
- mail
Nickname String The mail alias for the group, unique in the organisation.
- members List<String>
List of object IDs of the group members.
- object
Id String The object ID of the group.
- onpremises
Domain StringName The on-premises FQDN, also called dnsDomainName, synchronised from the on-premises directory when Azure AD Connect is used.
- onpremises
Netbios StringName The on-premises NetBIOS name, synchronised from the on-premises directory when Azure AD Connect is used.
- onpremises
Sam StringAccount Name The on-premises SAM account name, synchronised from the on-premises directory when Azure AD Connect is used.
- onpremises
Security StringIdentifier The on-premises security identifier (SID), synchronised from the on-premises directory when Azure AD Connect is used.
- onpremises
Sync BooleanEnabled Whether this group is synchronised from an on-premises directory (
true
), no longer synchronised (false
), or has never been synchronised (null
).- owners List<String>
List of object IDs of the group owners.
- preferred
Language String The preferred language for a Microsoft 365 group, in ISO 639-1 notation.
- provisioning
Options List<String> A list of provisioning options for a Microsoft 365 group, such as
Team
. See official documentation for details.- proxy
Addresses List<String> List of email addresses for the group that direct to the same group mailbox.
- security
Enabled Boolean Whether the group is a security group.
- theme String
The colour theme for a Microsoft 365 group. Possible values are
Blue
,Green
,Orange
,Pink
,Purple
,Red
orTeal
. When no theme is set, the value isnull
.- types List<String>
A list of group types configured for the group. Supported values are
DynamicMembership
, which denotes a group with dynamic membership, andUnified
, which specifies a Microsoft 365 group.- visibility String
The group join policy and group content visibility. Possible values are
Private
,Public
, orHiddenmembership
. Only Microsoft 365 groups can haveHiddenmembership
visibility.
- assignable
To booleanRole Indicates whether this group can be assigned to an Azure Active Directory role.
- auto
Subscribe booleanNew Members Indicates whether new members added to the group will be auto-subscribed to receive email notifications. Only set for Unified groups.
- behaviors string[]
A list of behaviors for a Microsoft 365 group, such as
AllowOnlyMembersToPost
,HideGroupInOutlook
,SubscribeNewGroupMembers
andWelcomeEmailDisabled
. See official documentation for more details.- description string
The optional description of the group.
- display
Name string The display name for the group.
- dynamic
Memberships GetGroup Dynamic Membership[] A
dynamic_membership
block as documented below.- external
Senders booleanAllowed Indicates whether people external to the organization can send messages to the group. Only set for Unified groups.
- hide
From booleanAddress Lists 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.
- hide
From booleanOutlook Clients Indicates whether the group is displayed in Outlook clients, such as Outlook for Windows and Outlook on the web. Only set for Unified groups.
- id string
The provider-assigned unique ID for this managed resource.
- mail string
The SMTP address for the group.
- mail
Enabled boolean Whether the group is mail-enabled.
- mail
Nickname string The mail alias for the group, unique in the organisation.
- members string[]
List of object IDs of the group members.
- object
Id string The object ID of the group.
- onpremises
Domain stringName The on-premises FQDN, also called dnsDomainName, synchronised from the on-premises directory when Azure AD Connect is used.
- onpremises
Netbios stringName The on-premises NetBIOS name, synchronised from the on-premises directory when Azure AD Connect is used.
- onpremises
Sam stringAccount Name The on-premises SAM account name, synchronised from the on-premises directory when Azure AD Connect is used.
- onpremises
Security stringIdentifier The on-premises security identifier (SID), synchronised from the on-premises directory when Azure AD Connect is used.
- onpremises
Sync booleanEnabled Whether this group is synchronised from an on-premises directory (
true
), no longer synchronised (false
), or has never been synchronised (null
).- owners string[]
List of object IDs of the group owners.
- preferred
Language string The preferred language for a Microsoft 365 group, in ISO 639-1 notation.
- provisioning
Options string[] A list of provisioning options for a Microsoft 365 group, such as
Team
. See official documentation for details.- proxy
Addresses string[] List of email addresses for the group that direct to the same group mailbox.
- security
Enabled boolean Whether the group is a security group.
- theme string
The colour theme for a Microsoft 365 group. Possible values are
Blue
,Green
,Orange
,Pink
,Purple
,Red
orTeal
. When no theme is set, the value isnull
.- types string[]
A list of group types configured for the group. Supported values are
DynamicMembership
, which denotes a group with dynamic membership, andUnified
, which specifies a Microsoft 365 group.- visibility string
The group join policy and group content visibility. Possible values are
Private
,Public
, orHiddenmembership
. Only Microsoft 365 groups can haveHiddenmembership
visibility.
- assignable_
to_ boolrole Indicates whether this group can be assigned to an Azure Active Directory role.
- auto_
subscribe_ boolnew_ members Indicates whether new members added to the group will be auto-subscribed to receive email notifications. Only set for Unified groups.
- behaviors Sequence[str]
A list of behaviors for a Microsoft 365 group, such as
AllowOnlyMembersToPost
,HideGroupInOutlook
,SubscribeNewGroupMembers
andWelcomeEmailDisabled
. See official documentation for more details.- description str
The optional description of the group.
- display_
name str The display name for the group.
- dynamic_
memberships Sequence[GetGroup Dynamic Membership] A
dynamic_membership
block as documented below.- external_
senders_ boolallowed Indicates whether people external to the organization can send messages to the group. Only set for Unified groups.
- hide_
from_ booladdress_ lists 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.
- hide_
from_ booloutlook_ clients Indicates whether the group is displayed in Outlook clients, such as Outlook for Windows and Outlook on the web. Only set for Unified groups.
- id str
The provider-assigned unique ID for this managed resource.
- mail str
The SMTP address for the group.
- mail_
enabled bool Whether the group is mail-enabled.
- mail_
nickname str The mail alias for the group, unique in the organisation.
- members Sequence[str]
List of object IDs of the group members.
- object_
id str The object ID of the group.
- onpremises_
domain_ strname The on-premises FQDN, also called dnsDomainName, synchronised from the on-premises directory when Azure AD Connect is used.
- onpremises_
netbios_ strname The on-premises NetBIOS name, synchronised from the on-premises directory when Azure AD Connect is used.
- onpremises_
sam_ straccount_ name The on-premises SAM account name, synchronised from the on-premises directory when Azure AD Connect is used.
- onpremises_
security_ stridentifier The on-premises security identifier (SID), synchronised from the on-premises directory when Azure AD Connect is used.
- onpremises_
sync_ boolenabled Whether this group is synchronised from an on-premises directory (
true
), no longer synchronised (false
), or has never been synchronised (null
).- owners Sequence[str]
List of object IDs of the group owners.
- preferred_
language str The preferred language for a Microsoft 365 group, in ISO 639-1 notation.
- provisioning_
options Sequence[str] A list of provisioning options for a Microsoft 365 group, such as
Team
. See official documentation for details.- proxy_
addresses Sequence[str] List of email addresses for the group that direct to the same group mailbox.
- security_
enabled bool Whether the group is a security group.
- theme str
The colour theme for a Microsoft 365 group. Possible values are
Blue
,Green
,Orange
,Pink
,Purple
,Red
orTeal
. When no theme is set, the value isnull
.- types Sequence[str]
A list of group types configured for the group. Supported values are
DynamicMembership
, which denotes a group with dynamic membership, andUnified
, which specifies a Microsoft 365 group.- visibility str
The group join policy and group content visibility. Possible values are
Private
,Public
, orHiddenmembership
. Only Microsoft 365 groups can haveHiddenmembership
visibility.
- assignable
To BooleanRole Indicates whether this group can be assigned to an Azure Active Directory role.
- auto
Subscribe BooleanNew Members Indicates whether new members added to the group will be auto-subscribed to receive email notifications. Only set for Unified groups.
- behaviors List<String>
A list of behaviors for a Microsoft 365 group, such as
AllowOnlyMembersToPost
,HideGroupInOutlook
,SubscribeNewGroupMembers
andWelcomeEmailDisabled
. See official documentation for more details.- description String
The optional description of the group.
- display
Name String The display name for the group.
- dynamic
Memberships List<Property Map> A
dynamic_membership
block as documented below.- external
Senders BooleanAllowed Indicates whether people external to the organization can send messages to the group. Only set for Unified groups.
- hide
From BooleanAddress Lists 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.
- hide
From BooleanOutlook Clients Indicates whether the group is displayed in Outlook clients, such as Outlook for Windows and Outlook on the web. Only set for Unified groups.
- id String
The provider-assigned unique ID for this managed resource.
- mail String
The SMTP address for the group.
- mail
Enabled Boolean Whether the group is mail-enabled.
- mail
Nickname String The mail alias for the group, unique in the organisation.
- members List<String>
List of object IDs of the group members.
- object
Id String The object ID of the group.
- onpremises
Domain StringName The on-premises FQDN, also called dnsDomainName, synchronised from the on-premises directory when Azure AD Connect is used.
- onpremises
Netbios StringName The on-premises NetBIOS name, synchronised from the on-premises directory when Azure AD Connect is used.
- onpremises
Sam StringAccount Name The on-premises SAM account name, synchronised from the on-premises directory when Azure AD Connect is used.
- onpremises
Security StringIdentifier The on-premises security identifier (SID), synchronised from the on-premises directory when Azure AD Connect is used.
- onpremises
Sync BooleanEnabled Whether this group is synchronised from an on-premises directory (
true
), no longer synchronised (false
), or has never been synchronised (null
).- owners List<String>
List of object IDs of the group owners.
- preferred
Language String The preferred language for a Microsoft 365 group, in ISO 639-1 notation.
- provisioning
Options List<String> A list of provisioning options for a Microsoft 365 group, such as
Team
. See official documentation for details.- proxy
Addresses List<String> List of email addresses for the group that direct to the same group mailbox.
- security
Enabled Boolean Whether the group is a security group.
- theme String
The colour theme for a Microsoft 365 group. Possible values are
Blue
,Green
,Orange
,Pink
,Purple
,Red
orTeal
. When no theme is set, the value isnull
.- types List<String>
A list of group types configured for the group. Supported values are
DynamicMembership
, which denotes a group with dynamic membership, andUnified
, which specifies a Microsoft 365 group.- visibility String
The group join policy and group content visibility. Possible values are
Private
,Public
, orHiddenmembership
. Only Microsoft 365 groups can haveHiddenmembership
visibility.
Supporting Types
GetGroupDynamicMembership
Package Details
- Repository
- Azure Active Directory (Azure AD) pulumi/pulumi-azuread
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
azuread
Terraform Provider.