@pulumi/azuread/accessPackage.d.ts

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

import * as pulumi from "@pulumi/pulumi";
/**
 * Manages an Access Package within Identity Governance in Azure Active Directory.
 *
 * ## API Permissions
 *
 * The following API permissions are required in order to use this resource.
 *
 * When authenticated with a service principal, this resource requires the following application role: `EntitlementManagement.ReadWrite.All`.
 *
 * When authenticated with a user principal, this resource requires one of the following directory roles: `Catalog owner`, `Access package manager` or `Global Administrator`
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as azuread from "@pulumi/azuread";
 *
 * const example = new azuread.AccessPackageCatalog("example", {
 *     displayName: "example-catalog",
 *     description: "Example catalog",
 * });
 * const exampleAccessPackage = new azuread.AccessPackage("example", {
 *     catalogId: example.id,
 *     displayName: "access-package",
 *     description: "Access Package",
 * });
 * ```
 *
 * ## Import
 *
 * Access Packages can be imported using the `id`, e.g.
 *
 * ```sh
 * $ pulumi import azuread:index/accessPackage:AccessPackage example_package 00000000-0000-0000-0000-000000000000
 * ```
 */
export declare class AccessPackage extends pulumi.CustomResource {
    /**
     * Get an existing AccessPackage 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: string, id: pulumi.Input<pulumi.ID>, state?: AccessPackageState, opts?: pulumi.CustomResourceOptions): AccessPackage;
    /**
     * Returns true if the given object is an instance of AccessPackage.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is AccessPackage;
    /**
     * The ID of the Catalog this access package will be created in.
     */
    readonly catalogId: pulumi.Output<string>;
    /**
     * The description of the access package.
     */
    readonly description: pulumi.Output<string>;
    /**
     * The display name of the access package.
     */
    readonly displayName: pulumi.Output<string>;
    /**
     * Whether the access package is hidden from the requestor.
     */
    readonly hidden: pulumi.Output<boolean | undefined>;
    /**
     * Create a AccessPackage resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args: AccessPackageArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering AccessPackage resources.
 */
export interface AccessPackageState {
    /**
     * The ID of the Catalog this access package will be created in.
     */
    catalogId?: pulumi.Input<string>;
    /**
     * The description of the access package.
     */
    description?: pulumi.Input<string>;
    /**
     * The display name of the access package.
     */
    displayName?: pulumi.Input<string>;
    /**
     * Whether the access package is hidden from the requestor.
     */
    hidden?: pulumi.Input<boolean>;
}
/**
 * The set of arguments for constructing a AccessPackage resource.
 */
export interface AccessPackageArgs {
    /**
     * The ID of the Catalog this access package will be created in.
     */
    catalogId: pulumi.Input<string>;
    /**
     * The description of the access package.
     */
    description: pulumi.Input<string>;
    /**
     * The display name of the access package.
     */
    displayName: pulumi.Input<string>;
    /**
     * Whether the access package is hidden from the requestor.
     */
    hidden?: pulumi.Input<boolean>;
}