UNPKG

@pulumi/azuread

Version:

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

96 lines 3.3 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.getAdministrativeUnitOutput = exports.getAdministrativeUnit = void 0; const pulumi = require("@pulumi/pulumi"); const utilities = require("./utilities"); /** * Gets information about an adminisrative unit in Azure Active Directory. * * ## 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: `AdministrativeUnit.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) * * *Look up by display name* * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as azuread from "@pulumi/azuread"; * * const example = azuread.getAdministrativeUnit({ * displayName: "Example-AU", * }); * ``` * * *Look up by object ID* * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as azuread from "@pulumi/azuread"; * * const example = azuread.getAdministrativeUnit({ * objectId: "00000000-0000-0000-0000-000000000000", * }); * ``` */ function getAdministrativeUnit(args, opts) { args = args || {}; opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {}); return pulumi.runtime.invoke("azuread:index/getAdministrativeUnit:getAdministrativeUnit", { "displayName": args.displayName, "objectId": args.objectId, }, opts); } exports.getAdministrativeUnit = getAdministrativeUnit; /** * Gets information about an adminisrative unit in Azure Active Directory. * * ## 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: `AdministrativeUnit.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) * * *Look up by display name* * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as azuread from "@pulumi/azuread"; * * const example = azuread.getAdministrativeUnit({ * displayName: "Example-AU", * }); * ``` * * *Look up by object ID* * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as azuread from "@pulumi/azuread"; * * const example = azuread.getAdministrativeUnit({ * objectId: "00000000-0000-0000-0000-000000000000", * }); * ``` */ function getAdministrativeUnitOutput(args, opts) { args = args || {}; opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {}); return pulumi.runtime.invokeOutput("azuread:index/getAdministrativeUnit:getAdministrativeUnit", { "displayName": args.displayName, "objectId": args.objectId, }, opts); } exports.getAdministrativeUnitOutput = getAdministrativeUnitOutput; //# sourceMappingURL=getAdministrativeUnit.js.map