@pulumi/azuread
Version:
A Pulumi package for creating and managing Azure Active Directory (Azure AD) cloud resources.
123 lines • 5.88 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.AdministrativeUnitRoleMember = void 0;
const pulumi = __importStar(require("@pulumi/pulumi"));
const utilities = __importStar(require("./utilities"));
/**
* Manages a single directory role assignment scoped to an administrative unit within Azure Active Directory.
*
* ## API Permissions
*
* The following API permissions are required in order to use this resource.
*
* When authenticated with a service principal, this resource requires one of the following application roles: `AdministrativeUnit.ReadWrite.All` and `RoleManagement.ReadWrite.Directory`, or `Directory.ReadWrite.All`
*
* When authenticated with a user principal, this resource requires one of the following directory roles: `Privileged Role Administrator` or `Global Administrator`
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as azuread from "@pulumi/azuread";
*
* const example = azuread.getUser({
* userPrincipalName: "jdoe@example.com",
* });
* const exampleAdministrativeUnit = new azuread.AdministrativeUnit("example", {displayName: "Example-AU"});
* const exampleDirectoryRole = new azuread.DirectoryRole("example", {displayName: "Security administrator"});
* const exampleAdministrativeUnitRoleMember = new azuread.AdministrativeUnitRoleMember("example", {
* roleObjectId: exampleDirectoryRole.objectId,
* administrativeUnitObjectId: exampleAdministrativeUnit.objectId,
* memberObjectId: example.then(example => example.objectId),
* });
* ```
*
* ## Import
*
* Administrative unit role members can be imported using the object ID of the administrative unit and the unique ID of the role assignment, e.g.
*
* ```sh
* terraform import azuread_administrative_unit_role_member.example
* /directory/administrativeUnits/00000000-0000-0000-0000-000000000000/scopedRoleMembers/zX37MRLyF0uvE-xf2WH4B7x-6CPLfudNnxFGj800htpBXqkxW7bITqGb6Rj4kuTuS
* ```
*/
class AdministrativeUnitRoleMember extends pulumi.CustomResource {
/**
* Get an existing AdministrativeUnitRoleMember resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name, id, state, opts) {
return new AdministrativeUnitRoleMember(name, state, { ...opts, id: id });
}
/** @internal */
static __pulumiType = 'azuread:index/administrativeUnitRoleMember:AdministrativeUnitRoleMember';
/**
* Returns true if the given object is an instance of AdministrativeUnitRoleMember. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === AdministrativeUnitRoleMember.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["administrativeUnitObjectId"] = state?.administrativeUnitObjectId;
resourceInputs["memberObjectId"] = state?.memberObjectId;
resourceInputs["roleObjectId"] = state?.roleObjectId;
}
else {
const args = argsOrState;
if (args?.administrativeUnitObjectId === undefined && !opts.urn) {
throw new Error("Missing required property 'administrativeUnitObjectId'");
}
if (args?.memberObjectId === undefined && !opts.urn) {
throw new Error("Missing required property 'memberObjectId'");
}
if (args?.roleObjectId === undefined && !opts.urn) {
throw new Error("Missing required property 'roleObjectId'");
}
resourceInputs["administrativeUnitObjectId"] = args?.administrativeUnitObjectId;
resourceInputs["memberObjectId"] = args?.memberObjectId;
resourceInputs["roleObjectId"] = args?.roleObjectId;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(AdministrativeUnitRoleMember.__pulumiType, name, resourceInputs, opts);
}
}
exports.AdministrativeUnitRoleMember = AdministrativeUnitRoleMember;
//# sourceMappingURL=administrativeUnitRoleMember.js.map