UNPKG

@pulumi/azuread

Version:

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

116 lines (115 loc) 4.38 kB
import * as pulumi from "@pulumi/pulumi"; /** * Manages an access package catalog 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`, `Catalog creator` 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-access-package-catalog", * description: "Example access package catalog", * }); * ``` * * ## Import * * An Access Package Catalog can be imported using the `id`, e.g. * * ```sh * $ pulumi import azuread:index/accessPackageCatalog:AccessPackageCatalog example 00000000-0000-0000-0000-000000000000 * ``` */ export declare class AccessPackageCatalog extends pulumi.CustomResource { /** * Get an existing AccessPackageCatalog 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?: AccessPackageCatalogState, opts?: pulumi.CustomResourceOptions): AccessPackageCatalog; /** * Returns true if the given object is an instance of AccessPackageCatalog. 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 AccessPackageCatalog; /** * The description of the access package catalog. */ readonly description: pulumi.Output<string>; /** * The display name of the access package catalog. */ readonly displayName: pulumi.Output<string>; /** * Whether the access packages in this catalog can be requested by users outside the tenant. */ readonly externallyVisible: pulumi.Output<boolean | undefined>; /** * Whether the access packages in this catalog are available for management. */ readonly published: pulumi.Output<boolean | undefined>; /** * Create a AccessPackageCatalog 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: AccessPackageCatalogArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering AccessPackageCatalog resources. */ export interface AccessPackageCatalogState { /** * The description of the access package catalog. */ description?: pulumi.Input<string>; /** * The display name of the access package catalog. */ displayName?: pulumi.Input<string>; /** * Whether the access packages in this catalog can be requested by users outside the tenant. */ externallyVisible?: pulumi.Input<boolean>; /** * Whether the access packages in this catalog are available for management. */ published?: pulumi.Input<boolean>; } /** * The set of arguments for constructing a AccessPackageCatalog resource. */ export interface AccessPackageCatalogArgs { /** * The description of the access package catalog. */ description: pulumi.Input<string>; /** * The display name of the access package catalog. */ displayName: pulumi.Input<string>; /** * Whether the access packages in this catalog can be requested by users outside the tenant. */ externallyVisible?: pulumi.Input<boolean>; /** * Whether the access packages in this catalog are available for management. */ published?: pulumi.Input<boolean>; }