@pulumi/azuread
Version:
A Pulumi package for creating and managing Azure Active Directory (Azure AD) cloud resources.
197 lines • 6.17 kB
JavaScript
;
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.getGroupsOutput = exports.getGroups = void 0;
const pulumi = __importStar(require("@pulumi/pulumi"));
const utilities = __importStar(require("./utilities"));
/**
* Gets Object IDs or Display Names for multiple Azure Active Directory groups.
*
* ## 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
*
* *Look up by group name*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as azuread from "@pulumi/azuread";
*
* const example = azuread.getGroups({
* displayNames: [
* "group-a",
* "group-b",
* ],
* });
* ```
*
* *Look up by display name prefix*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as azuread from "@pulumi/azuread";
*
* const sales = azuread.getGroups({
* displayNamePrefix: "sales-",
* });
* ```
*
* *Look up all groups*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as azuread from "@pulumi/azuread";
*
* const all = azuread.getGroups({
* returnAll: true,
* });
* ```
*
* *Look up all mail-enabled groups*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as azuread from "@pulumi/azuread";
*
* const mailEnabled = azuread.getGroups({
* mailEnabled: true,
* returnAll: true,
* });
* ```
*
* *Look up all security-enabled groups that are not mail-enabled*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as azuread from "@pulumi/azuread";
*
* const securityOnly = azuread.getGroups({
* mailEnabled: false,
* returnAll: true,
* securityEnabled: true,
* });
* ```
*/
function getGroups(args, opts) {
args = args || {};
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
return pulumi.runtime.invoke("azuread:index/getGroups:getGroups", {
"displayNamePrefix": args.displayNamePrefix,
"displayNames": args.displayNames,
"ignoreMissing": args.ignoreMissing,
"mailEnabled": args.mailEnabled,
"objectIds": args.objectIds,
"returnAll": args.returnAll,
"securityEnabled": args.securityEnabled,
}, opts);
}
exports.getGroups = getGroups;
/**
* Gets Object IDs or Display Names for multiple Azure Active Directory groups.
*
* ## 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
*
* *Look up by group name*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as azuread from "@pulumi/azuread";
*
* const example = azuread.getGroups({
* displayNames: [
* "group-a",
* "group-b",
* ],
* });
* ```
*
* *Look up by display name prefix*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as azuread from "@pulumi/azuread";
*
* const sales = azuread.getGroups({
* displayNamePrefix: "sales-",
* });
* ```
*
* *Look up all groups*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as azuread from "@pulumi/azuread";
*
* const all = azuread.getGroups({
* returnAll: true,
* });
* ```
*
* *Look up all mail-enabled groups*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as azuread from "@pulumi/azuread";
*
* const mailEnabled = azuread.getGroups({
* mailEnabled: true,
* returnAll: true,
* });
* ```
*
* *Look up all security-enabled groups that are not mail-enabled*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as azuread from "@pulumi/azuread";
*
* const securityOnly = azuread.getGroups({
* mailEnabled: false,
* returnAll: true,
* securityEnabled: true,
* });
* ```
*/
function getGroupsOutput(args, opts) {
args = args || {};
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
return pulumi.runtime.invokeOutput("azuread:index/getGroups:getGroups", {
"displayNamePrefix": args.displayNamePrefix,
"displayNames": args.displayNames,
"ignoreMissing": args.ignoreMissing,
"mailEnabled": args.mailEnabled,
"objectIds": args.objectIds,
"returnAll": args.returnAll,
"securityEnabled": args.securityEnabled,
}, opts);
}
exports.getGroupsOutput = getGroupsOutput;
//# sourceMappingURL=getGroups.js.map