UNPKG

@pulumi/azuread

Version:

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

117 lines 5.93 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.ApplicationPermissionScope = void 0; const pulumi = require("@pulumi/pulumi"); const utilities = require("./utilities"); /** * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as azuread from "@pulumi/azuread"; * import * as random from "@pulumi/random"; * * const example = new azuread.ApplicationRegistration("example", {displayName: "example"}); * const exampleAdminister = new random.RandomUuid("example_administer", {}); * const exampleApplicationPermissionScope = new azuread.ApplicationPermissionScope("example", { * applicationId: test.id, * scopeId: exampleAdminister.id, * value: "administer", * adminConsentDescription: "Administer the application", * adminConsentDisplayName: "Administer", * }); * ``` * * > **Tip** For managing more permissions scopes, create additional instances of this resource * * *Usage with azuread.Application resource* * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as azuread from "@pulumi/azuread"; * * const example = new azuread.Application("example", {displayName: "example"}); * const exampleApplicationPermissionScope = new azuread.ApplicationPermissionScope("example", {applicationId: example.id}); * ``` * * ## Import * * Application App Roles can be imported using the object ID of the application and the ID of the permission scope, in the following format. * * ```sh * $ pulumi import azuread:index/applicationPermissionScope:ApplicationPermissionScope example /applications/00000000-0000-0000-0000-000000000000/permissionScopes/11111111-1111-1111-1111-111111111111 * ``` */ class ApplicationPermissionScope extends pulumi.CustomResource { /** * Get an existing ApplicationPermissionScope 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 ApplicationPermissionScope(name, state, Object.assign(Object.assign({}, opts), { id: id })); } /** * Returns true if the given object is an instance of ApplicationPermissionScope. 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'] === ApplicationPermissionScope.__pulumiType; } constructor(name, argsOrState, opts) { let resourceInputs = {}; opts = opts || {}; if (opts.id) { const state = argsOrState; resourceInputs["adminConsentDescription"] = state ? state.adminConsentDescription : undefined; resourceInputs["adminConsentDisplayName"] = state ? state.adminConsentDisplayName : undefined; resourceInputs["applicationId"] = state ? state.applicationId : undefined; resourceInputs["scopeId"] = state ? state.scopeId : undefined; resourceInputs["type"] = state ? state.type : undefined; resourceInputs["userConsentDescription"] = state ? state.userConsentDescription : undefined; resourceInputs["userConsentDisplayName"] = state ? state.userConsentDisplayName : undefined; resourceInputs["value"] = state ? state.value : undefined; } else { const args = argsOrState; if ((!args || args.adminConsentDescription === undefined) && !opts.urn) { throw new Error("Missing required property 'adminConsentDescription'"); } if ((!args || args.adminConsentDisplayName === undefined) && !opts.urn) { throw new Error("Missing required property 'adminConsentDisplayName'"); } if ((!args || args.applicationId === undefined) && !opts.urn) { throw new Error("Missing required property 'applicationId'"); } if ((!args || args.scopeId === undefined) && !opts.urn) { throw new Error("Missing required property 'scopeId'"); } if ((!args || args.value === undefined) && !opts.urn) { throw new Error("Missing required property 'value'"); } resourceInputs["adminConsentDescription"] = args ? args.adminConsentDescription : undefined; resourceInputs["adminConsentDisplayName"] = args ? args.adminConsentDisplayName : undefined; resourceInputs["applicationId"] = args ? args.applicationId : undefined; resourceInputs["scopeId"] = args ? args.scopeId : undefined; resourceInputs["type"] = args ? args.type : undefined; resourceInputs["userConsentDescription"] = args ? args.userConsentDescription : undefined; resourceInputs["userConsentDisplayName"] = args ? args.userConsentDisplayName : undefined; resourceInputs["value"] = args ? args.value : undefined; } opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts); super(ApplicationPermissionScope.__pulumiType, name, resourceInputs, opts); } } exports.ApplicationPermissionScope = ApplicationPermissionScope; /** @internal */ ApplicationPermissionScope.__pulumiType = 'azuread:index/applicationPermissionScope:ApplicationPermissionScope'; //# sourceMappingURL=applicationPermissionScope.js.map