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

GetGroups

Gets Object IDs or Display Names for multiple Azure Active Directory groups.

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

using Pulumi;
using AzureAD = Pulumi.AzureAD;

class MyStack : Stack
{
    public MyStack()
    {
        var groups = Output.Create(AzureAD.GetGroups.InvokeAsync(new AzureAD.GetGroupsArgs
        {
            Names = 
            {
                "group-a",
                "group-b",
            },
        }));
    }

}

Coming soon!

import pulumi
import pulumi_azuread as azuread

groups = azuread.get_groups(names=[
    "group-a",
    "group-b",
])
import * as pulumi from "@pulumi/pulumi";
import * as azuread from "@pulumi/azuread";

const groups = pulumi.output(azuread.getGroups({
    names: [
        "group-a",
        "group-b",
    ],
}, { async: true }));

Using GetGroups

function getGroups(args: GetGroupsArgs, opts?: InvokeOptions): Promise<GetGroupsResult>
function  get_groups(names=None, object_ids=None, opts=None)
func GetGroups(ctx *Context, args *GetGroupsArgs, opts ...InvokeOption) (*GetGroupsResult, error)
public static class GetGroups {
    public static Task<GetGroupsResult> InvokeAsync(GetGroupsArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Names List<string>

The Display Names of the Azure AD Groups.

ObjectIds List<string>

The Object IDs of the Azure AD Groups.

Names []string

The Display Names of the Azure AD Groups.

ObjectIds []string

The Object IDs of the Azure AD Groups.

names string[]

The Display Names of the Azure AD Groups.

objectIds string[]

The Object IDs of the Azure AD Groups.

names List[str]

The Display Names of the Azure AD Groups.

object_ids List[str]

The Object IDs of the Azure AD Groups.

GetGroups Result

The following output properties are available:

Id string

The provider-assigned unique ID for this managed resource.

Names List<string>

The Display Names of the Azure AD Groups.

ObjectIds List<string>

The Object IDs of the Azure AD Groups.

Id string

The provider-assigned unique ID for this managed resource.

Names []string

The Display Names of the Azure AD Groups.

ObjectIds []string

The Object IDs of the Azure AD Groups.

id string

The provider-assigned unique ID for this managed resource.

names string[]

The Display Names of the Azure AD Groups.

objectIds string[]

The Object IDs of the Azure AD Groups.

id str

The provider-assigned unique ID for this managed resource.

names List[str]

The Display Names of the Azure AD Groups.

object_ids List[str]

The Object IDs of the Azure AD Groups.

Package Details

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