@pulumi/azuread/getAccessPackageCatalog.d.ts

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

import * as pulumi from "@pulumi/pulumi";
/**
 * i
 * Use this resource to retrieve information for an existing access package catalog 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`, `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.getAccessPackageCatalog({
 *     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.getAccessPackageCatalog({
 *     displayName: "My access package Catalog",
 * });
 * ```
 */
export declare function getAccessPackageCatalog(args?: GetAccessPackageCatalogArgs, opts?: pulumi.InvokeOptions): Promise<GetAccessPackageCatalogResult>;
/**
 * A collection of arguments for invoking getAccessPackageCatalog.
 */
export interface GetAccessPackageCatalogArgs {
    /**
     * The display name of the access package catalog.
     */
    displayName?: string;
    /**
     * The ID of this access package catalog.
     *
     * > One of `displayName` or `objectId` must be specified.
     */
    objectId?: string;
}
/**
 * A collection of values returned by getAccessPackageCatalog.
 */
export interface GetAccessPackageCatalogResult {
    /**
     * The description of the access package catalog.
     */
    readonly description: string;
    readonly displayName: string;
    /**
     * Whether the access packages in this catalog can be requested by users outside the tenant.
     */
    readonly externallyVisible: boolean;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    readonly objectId: string;
    /**
     * Whether the access packages in this catalog are available for management.
     */
    readonly published: boolean;
}
/**
 * i
 * Use this resource to retrieve information for an existing access package catalog 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`, `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.getAccessPackageCatalog({
 *     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.getAccessPackageCatalog({
 *     displayName: "My access package Catalog",
 * });
 * ```
 */
export declare function getAccessPackageCatalogOutput(args?: GetAccessPackageCatalogOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetAccessPackageCatalogResult>;
/**
 * A collection of arguments for invoking getAccessPackageCatalog.
 */
export interface GetAccessPackageCatalogOutputArgs {
    /**
     * The display name of the access package catalog.
     */
    displayName?: pulumi.Input<string>;
    /**
     * The ID of this access package catalog.
     *
     * > One of `displayName` or `objectId` must be specified.
     */
    objectId?: pulumi.Input<string>;
}