@pulumi/azuread/getAccessPackage.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! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.getAccessPackageOutput = exports.getAccessPackage = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("./utilities");
/**
 * Use this data source to retrieve information for an existing access package within Identity Governance 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: `EntitlementManagement.Read.All`, or `EntitlementManagement.ReadWrite.All`.
 *
 * When authenticated with a user principal, this data source requires one of the following directory roles: `Catalog owner`, `Catalog reader`, `Access package manager`, `Global Reader`, or `Global Administrator`.
 *
 * ## Example Usage
 *
 * *Look up by ID*
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as azuread from "@pulumi/azuread";
 *
 * const example = azuread.getAccessPackage({
 *     objectId: "00000000-0000-0000-0000-000000000000",
 * });
 * ```
 *
 * *Look up by DisplayName*
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as azuread from "@pulumi/azuread";
 *
 * const example = azuread.getAccessPackage({
 *     catalogId: "00000000-0000-0000-0000-000000000000",
 *     displayName: "My access package Catalog",
 * });
 * ```
 */
function getAccessPackage(args, opts) {
    args = args || {};
    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
    return pulumi.runtime.invoke("azuread:index/getAccessPackage:getAccessPackage", {
        "catalogId": args.catalogId,
        "displayName": args.displayName,
        "objectId": args.objectId,
    }, opts);
}
exports.getAccessPackage = getAccessPackage;
/**
 * Use this data source to retrieve information for an existing access package within Identity Governance 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: `EntitlementManagement.Read.All`, or `EntitlementManagement.ReadWrite.All`.
 *
 * When authenticated with a user principal, this data source requires one of the following directory roles: `Catalog owner`, `Catalog reader`, `Access package manager`, `Global Reader`, or `Global Administrator`.
 *
 * ## Example Usage
 *
 * *Look up by ID*
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as azuread from "@pulumi/azuread";
 *
 * const example = azuread.getAccessPackage({
 *     objectId: "00000000-0000-0000-0000-000000000000",
 * });
 * ```
 *
 * *Look up by DisplayName*
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as azuread from "@pulumi/azuread";
 *
 * const example = azuread.getAccessPackage({
 *     catalogId: "00000000-0000-0000-0000-000000000000",
 *     displayName: "My access package Catalog",
 * });
 * ```
 */
function getAccessPackageOutput(args, opts) {
    args = args || {};
    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
    return pulumi.runtime.invokeOutput("azuread:index/getAccessPackage:getAccessPackage", {
        "catalogId": args.catalogId,
        "displayName": args.displayName,
        "objectId": args.objectId,
    }, opts);
}
exports.getAccessPackageOutput = getAccessPackageOutput;
//# sourceMappingURL=getAccessPackage.js.map