@pulumi/azuread/accessPackageCatalogRoleAssignment.d.ts

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

import * as pulumi from "@pulumi/pulumi";
/**
 * Manages a single catalog role assignment within 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 one of the following application roles: `EntitlementManagement.ReadWrite.All` or `Directory.ReadWrite.All`
 *
 * When authenticated with a user principal, this resource requires one of the following directory roles: `Identity Governance administrator` or `Global Administrator`
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as azuread from "@pulumi/azuread";
 *
 * const example = azuread.getUser({
 *     userPrincipalName: "jdoe@example.com",
 * });
 * const exampleGetAccessPackageCatalogRole = azuread.getAccessPackageCatalogRole({
 *     displayName: "Catalog owner",
 * });
 * const exampleAccessPackageCatalog = new azuread.AccessPackageCatalog("example", {
 *     displayName: "example-access-package-catalog",
 *     description: "Example access package catalog",
 * });
 * const exampleAccessPackageCatalogRoleAssignment = new azuread.AccessPackageCatalogRoleAssignment("example", {
 *     roleId: exampleGetAccessPackageCatalogRole.then(exampleGetAccessPackageCatalogRole => exampleGetAccessPackageCatalogRole.objectId),
 *     principalObjectId: example.then(example => example.objectId),
 *     catalogId: exampleAccessPackageCatalog.id,
 * });
 * ```
 *
 * ## Import
 *
 * Catalog role assignments can be imported using the ID of the assignment, e.g.
 *
 * ```sh
 * $ pulumi import azuread:index/accessPackageCatalogRoleAssignment:AccessPackageCatalogRoleAssignment example 00000000-0000-0000-0000-000000000000
 * ```
 */
export declare class AccessPackageCatalogRoleAssignment extends pulumi.CustomResource {
    /**
     * Get an existing AccessPackageCatalogRoleAssignment 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?: AccessPackageCatalogRoleAssignmentState, opts?: pulumi.CustomResourceOptions): AccessPackageCatalogRoleAssignment;
    /**
     * Returns true if the given object is an instance of AccessPackageCatalogRoleAssignment.  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 AccessPackageCatalogRoleAssignment;
    /**
     * The ID of the Catalog this role assignment will be scoped to. Changing this forces a new resource to be created.
     */
    readonly catalogId: pulumi.Output<string>;
    /**
     * The object ID of the principal for you want to create a role assignment. Supported object types are Users, Groups or Service Principals. Changing this forces a new resource to be created.
     */
    readonly principalObjectId: pulumi.Output<string>;
    /**
     * The object ID of the catalog role you want to assign. Changing this forces a new resource to be created.
     */
    readonly roleId: pulumi.Output<string>;
    /**
     * Create a AccessPackageCatalogRoleAssignment 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: AccessPackageCatalogRoleAssignmentArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering AccessPackageCatalogRoleAssignment resources.
 */
export interface AccessPackageCatalogRoleAssignmentState {
    /**
     * The ID of the Catalog this role assignment will be scoped to. Changing this forces a new resource to be created.
     */
    catalogId?: pulumi.Input<string>;
    /**
     * The object ID of the principal for you want to create a role assignment. Supported object types are Users, Groups or Service Principals. Changing this forces a new resource to be created.
     */
    principalObjectId?: pulumi.Input<string>;
    /**
     * The object ID of the catalog role you want to assign. Changing this forces a new resource to be created.
     */
    roleId?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a AccessPackageCatalogRoleAssignment resource.
 */
export interface AccessPackageCatalogRoleAssignmentArgs {
    /**
     * The ID of the Catalog this role assignment will be scoped to. Changing this forces a new resource to be created.
     */
    catalogId: pulumi.Input<string>;
    /**
     * The object ID of the principal for you want to create a role assignment. Supported object types are Users, Groups or Service Principals. Changing this forces a new resource to be created.
     */
    principalObjectId: pulumi.Input<string>;
    /**
     * The object ID of the catalog role you want to assign. Changing this forces a new resource to be created.
     */
    roleId: pulumi.Input<string>;
}