@pulumi/azuread
Version:
A Pulumi package for creating and managing Azure Active Directory (Azure AD) cloud resources.
86 lines • 3.01 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! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.getUsersOutput = exports.getUsers = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("./utilities");
/**
* Gets basic information for multiple Azure Active Directory users.
*
* ## 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: `User.ReadBasic.All`, `User.Read.All` or `Directory.Read.All`
*
* When authenticated with a user principal, this data source does not require any additional roles.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as azuread from "@pulumi/azuread";
*
* const users = azuread.getUsers({
* userPrincipalNames: [
* "kat@example.com",
* "byte@example.com",
* ],
* });
* ```
*/
function getUsers(args, opts) {
args = args || {};
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
return pulumi.runtime.invoke("azuread:index/getUsers:getUsers", {
"employeeIds": args.employeeIds,
"ignoreMissing": args.ignoreMissing,
"mailNicknames": args.mailNicknames,
"mails": args.mails,
"objectIds": args.objectIds,
"returnAll": args.returnAll,
"userPrincipalNames": args.userPrincipalNames,
}, opts);
}
exports.getUsers = getUsers;
/**
* Gets basic information for multiple Azure Active Directory users.
*
* ## 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: `User.ReadBasic.All`, `User.Read.All` or `Directory.Read.All`
*
* When authenticated with a user principal, this data source does not require any additional roles.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as azuread from "@pulumi/azuread";
*
* const users = azuread.getUsers({
* userPrincipalNames: [
* "kat@example.com",
* "byte@example.com",
* ],
* });
* ```
*/
function getUsersOutput(args, opts) {
args = args || {};
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
return pulumi.runtime.invokeOutput("azuread:index/getUsers:getUsers", {
"employeeIds": args.employeeIds,
"ignoreMissing": args.ignoreMissing,
"mailNicknames": args.mailNicknames,
"mails": args.mails,
"objectIds": args.objectIds,
"returnAll": args.returnAll,
"userPrincipalNames": args.userPrincipalNames,
}, opts);
}
exports.getUsersOutput = getUsersOutput;
//# sourceMappingURL=getUsers.js.map