@pulumi/azuread/getGroup.js

A Pulumi package for creating and managing Azure Active Directory (Azure AD) cloud resources.

"use strict";
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.getGroupOutput = exports.getGroup = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("./utilities");
/**
 * 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)
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as azuread from "@pulumi/azuread";
 *
 * const example = azuread.getGroup({
 *     displayName: "MyGroupName",
 *     securityEnabled: true,
 * });
 * ```
 */
function getGroup(args, opts) {
    args = args || {};
    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
    return pulumi.runtime.invoke("azuread:index/getGroup:getGroup", {
        "displayName": args.displayName,
        "includeTransitiveMembers": args.includeTransitiveMembers,
        "mailEnabled": args.mailEnabled,
        "mailNickname": args.mailNickname,
        "objectId": args.objectId,
        "securityEnabled": args.securityEnabled,
    }, opts);
}
exports.getGroup = 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)
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as azuread from "@pulumi/azuread";
 *
 * const example = azuread.getGroup({
 *     displayName: "MyGroupName",
 *     securityEnabled: true,
 * });
 * ```
 */
function getGroupOutput(args, opts) {
    args = args || {};
    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
    return pulumi.runtime.invokeOutput("azuread:index/getGroup:getGroup", {
        "displayName": args.displayName,
        "includeTransitiveMembers": args.includeTransitiveMembers,
        "mailEnabled": args.mailEnabled,
        "mailNickname": args.mailNickname,
        "objectId": args.objectId,
        "securityEnabled": args.securityEnabled,
    }, opts);
}
exports.getGroupOutput = getGroupOutput;
//# sourceMappingURL=getGroup.js.map