@pulumi/azuread/getAccessPackage.d.ts

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

import * as pulumi from "@pulumi/pulumi";
/**
 * 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",
 * });
 * ```
 */
export declare function getAccessPackage(args?: GetAccessPackageArgs, opts?: pulumi.InvokeOptions): Promise<GetAccessPackageResult>;
/**
 * A collection of arguments for invoking getAccessPackage.
 */
export interface GetAccessPackageArgs {
    /**
     * The ID of the Catalog this access package is in.
     */
    catalogId?: string;
    /**
     * The display name of the access package.
     */
    displayName?: string;
    /**
     * The ID of this access package.
     *
     * > Either `objectId`, or both `catalogId` and `displayName`, must be specified.
     */
    objectId?: string;
}
/**
 * A collection of values returned by getAccessPackage.
 */
export interface GetAccessPackageResult {
    readonly catalogId?: string;
    /**
     * The description of the access package.
     */
    readonly description: string;
    readonly displayName: string;
    /**
     * Whether the access package is hidden from the requestor.
     */
    readonly hidden: boolean;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    readonly objectId: string;
}
/**
 * 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",
 * });
 * ```
 */
export declare function getAccessPackageOutput(args?: GetAccessPackageOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetAccessPackageResult>;
/**
 * A collection of arguments for invoking getAccessPackage.
 */
export interface GetAccessPackageOutputArgs {
    /**
     * The ID of the Catalog this access package is in.
     */
    catalogId?: pulumi.Input<string>;
    /**
     * The display name of the access package.
     */
    displayName?: pulumi.Input<string>;
    /**
     * The ID of this access package.
     *
     * > Either `objectId`, or both `catalogId` and `displayName`, must be specified.
     */
    objectId?: pulumi.Input<string>;
}