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

GetGroup

Gets information about an Azure Active Directory group.

NOTE: If you’re authenticating using a Service Principal then it must have permissions to Read directory data within the Windows Azure Active Directory API.

Example Usage (by Group Display Name)

import * as pulumi from "@pulumi/pulumi";
import * as azuread from "@pulumi/azuread";

const example = pulumi.output(azuread.getGroup({
    name: "A-AD-Group",
}, { async: true }));
import pulumi
import pulumi_azuread as azuread

example = azuread.get_group(name="A-AD-Group")
using Pulumi;
using AzureAD = Pulumi.AzureAD;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(AzureAD.GetGroup.InvokeAsync(new AzureAD.GetGroupArgs
        {
            Name = "A-AD-Group",
        }));
    }

}

Using GetGroup

function getGroup(args: GetGroupArgs, opts?: InvokeOptions): Promise<GetGroupResult>
function  get_group(name=None, object_id=None, opts=None)
func LookupGroup(ctx *Context, args *LookupGroupArgs, opts ...InvokeOption) (*LookupGroupResult, error)

Note: This function is named LookupGroup in the Go SDK.

public static class GetGroup {
    public static Task<GetGroupResult> InvokeAsync(GetGroupArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Name string

The Name of the AD Group we want to lookup.

ObjectId string

Specifies the Object ID of the AD Group within Azure Active Directory.

Name string

The Name of the AD Group we want to lookup.

ObjectId string

Specifies the Object ID of the AD Group within Azure Active Directory.

name string

The Name of the AD Group we want to lookup.

objectId string

Specifies the Object ID of the AD Group within Azure Active Directory.

name str

The Name of the AD Group we want to lookup.

object_id str

Specifies the Object ID of the AD Group within Azure Active Directory.

GetGroup Result

The following output properties are available:

Description string

The description of the AD Group.

Id string

The provider-assigned unique ID for this managed resource.

Members List<string>

The Object IDs of the Azure AD Group members.

Name string

The name of the Azure AD Group.

ObjectId string
Owners List<string>

The Object IDs of the Azure AD Group owners.

Description string

The description of the AD Group.

Id string

The provider-assigned unique ID for this managed resource.

Members []string

The Object IDs of the Azure AD Group members.

Name string

The name of the Azure AD Group.

ObjectId string
Owners []string

The Object IDs of the Azure AD Group owners.

description string

The description of the AD Group.

id string

The provider-assigned unique ID for this managed resource.

members string[]

The Object IDs of the Azure AD Group members.

name string

The name of the Azure AD Group.

objectId string
owners string[]

The Object IDs of the Azure AD Group owners.

description str

The description of the AD Group.

id str

The provider-assigned unique ID for this managed resource.

members List[str]

The Object IDs of the Azure AD Group members.

name str

The name of the Azure AD Group.

object_id str
owners List[str]

The Object IDs of the Azure AD Group owners.

Package Details

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