UNPKG

@pulumi/azuread

Version:

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

94 lines 4.31 kB
"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.AdministrativeUnit = void 0; const pulumi = require("@pulumi/pulumi"); const utilities = require("./utilities"); /** * Manages 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` 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 = new azuread.AdministrativeUnit("example", { * displayName: "Example-AU", * description: "Just an example", * hiddenMembershipEnabled: false, * }); * ``` * * ## Import * * Administrative units can be imported using their object ID, e.g. * * ```sh * $ pulumi import azuread:index/administrativeUnit:AdministrativeUnit example /directory/administrativeUnits/00000000-0000-0000-0000-000000000000 * ``` */ class AdministrativeUnit extends pulumi.CustomResource { /** * Get an existing AdministrativeUnit 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 AdministrativeUnit(name, state, Object.assign(Object.assign({}, opts), { id: id })); } /** * Returns true if the given object is an instance of AdministrativeUnit. 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'] === AdministrativeUnit.__pulumiType; } constructor(name, argsOrState, opts) { let resourceInputs = {}; opts = opts || {}; if (opts.id) { const state = argsOrState; resourceInputs["description"] = state ? state.description : undefined; resourceInputs["displayName"] = state ? state.displayName : undefined; resourceInputs["hiddenMembershipEnabled"] = state ? state.hiddenMembershipEnabled : undefined; resourceInputs["members"] = state ? state.members : undefined; resourceInputs["objectId"] = state ? state.objectId : undefined; resourceInputs["preventDuplicateNames"] = state ? state.preventDuplicateNames : undefined; } else { const args = argsOrState; if ((!args || args.displayName === undefined) && !opts.urn) { throw new Error("Missing required property 'displayName'"); } resourceInputs["description"] = args ? args.description : undefined; resourceInputs["displayName"] = args ? args.displayName : undefined; resourceInputs["hiddenMembershipEnabled"] = args ? args.hiddenMembershipEnabled : undefined; resourceInputs["members"] = args ? args.members : undefined; resourceInputs["preventDuplicateNames"] = args ? args.preventDuplicateNames : undefined; resourceInputs["objectId"] = undefined /*out*/; } opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts); super(AdministrativeUnit.__pulumiType, name, resourceInputs, opts); } } exports.AdministrativeUnit = AdministrativeUnit; /** @internal */ AdministrativeUnit.__pulumiType = 'azuread:index/administrativeUnit:AdministrativeUnit'; //# sourceMappingURL=administrativeUnit.js.map