@pulumi/azuread/applicationOptionalClaims.js

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

"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! ***
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.ApplicationOptionalClaims = void 0;
const pulumi = __importStar(require("@pulumi/pulumi"));
const utilities = __importStar(require("./utilities"));
/**
 * Manages optional claims for an application registration.
 *
 * This resource is analogous to the `optionalClaims` block in the `azuread.Application` resource. When using these resources together, you should use the `ignoreChanges` lifecycle meta-argument (see example below).
 *
 * ## 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: `Application.ReadWrite.OwnedBy` or `Application.ReadWrite.All`
 *
 * > When using the `Application.ReadWrite.OwnedBy` application role, the principal being used to run Terraform must be an owner of the application.
 *
 * When authenticated with a user principal, this resource may require one of the following directory roles: `Application Administrator` or `Global Administrator`
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as azuread from "@pulumi/azuread";
 *
 * const example = new azuread.ApplicationRegistration("example", {displayName: "example"});
 * const exampleApplicationOptionalClaims = new azuread.ApplicationOptionalClaims("example", {
 *     applicationId: example.id,
 *     accessTokens: [
 *         {
 *             name: "myclaim",
 *         },
 *         {
 *             name: "otherclaim",
 *         },
 *     ],
 *     idTokens: [{
 *         name: "userclaim",
 *         source: "user",
 *         essential: true,
 *         additionalProperties: ["emit_as_roles"],
 *     }],
 *     saml2Tokens: [{
 *         name: "samlexample",
 *     }],
 * });
 * ```
 *
 * ## Import
 *
 * Application Optional Claims can be imported using the object ID of the application, in the following format.
 *
 * ```sh
 * $ pulumi import azuread:index/applicationOptionalClaims:ApplicationOptionalClaims example /applications/00000000-0000-0000-0000-000000000000
 * ```
 */
class ApplicationOptionalClaims extends pulumi.CustomResource {
    /**
     * Get an existing ApplicationOptionalClaims 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 ApplicationOptionalClaims(name, state, { ...opts, id: id });
    }
    /** @internal */
    static __pulumiType = 'azuread:index/applicationOptionalClaims:ApplicationOptionalClaims';
    /**
     * Returns true if the given object is an instance of ApplicationOptionalClaims.  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'] === ApplicationOptionalClaims.__pulumiType;
    }
    constructor(name, argsOrState, opts) {
        let resourceInputs = {};
        opts = opts || {};
        if (opts.id) {
            const state = argsOrState;
            resourceInputs["accessTokens"] = state?.accessTokens;
            resourceInputs["applicationId"] = state?.applicationId;
            resourceInputs["idTokens"] = state?.idTokens;
            resourceInputs["saml2Tokens"] = state?.saml2Tokens;
        }
        else {
            const args = argsOrState;
            if (args?.applicationId === undefined && !opts.urn) {
                throw new Error("Missing required property 'applicationId'");
            }
            resourceInputs["accessTokens"] = args?.accessTokens;
            resourceInputs["applicationId"] = args?.applicationId;
            resourceInputs["idTokens"] = args?.idTokens;
            resourceInputs["saml2Tokens"] = args?.saml2Tokens;
        }
        opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
        super(ApplicationOptionalClaims.__pulumiType, name, resourceInputs, opts);
    }
}
exports.ApplicationOptionalClaims = ApplicationOptionalClaims;
//# sourceMappingURL=applicationOptionalClaims.js.map