@pulumi/azuread/getDirectoryRoles.d.ts

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

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "./types/output";
/**
 * Use this data source to access information about activated directory roles 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: `RoleManagement.Read.Directory` or `Directory.Read.All`
 *
 * When authenticated with a user principal, this data source does not require any additional roles.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as azuread from "@pulumi/azuread";
 *
 * const current = azuread.getDirectoryRoles({});
 * export const roles = current.then(current => current.objectIds);
 * ```
 */
export declare function getDirectoryRoles(opts?: pulumi.InvokeOptions): Promise<GetDirectoryRolesResult>;
/**
 * A collection of values returned by getDirectoryRoles.
 */
export interface GetDirectoryRolesResult {
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    /**
     * The object IDs of the roles.
     */
    readonly objectIds: string[];
    /**
     * A list of users. Each `role` object provides the attributes documented below.
     */
    readonly roles: outputs.GetDirectoryRolesRole[];
    /**
     * The template IDs of the roles.
     */
    readonly templateIds: string[];
}
/**
 * Use this data source to access information about activated directory roles 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: `RoleManagement.Read.Directory` or `Directory.Read.All`
 *
 * When authenticated with a user principal, this data source does not require any additional roles.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as azuread from "@pulumi/azuread";
 *
 * const current = azuread.getDirectoryRoles({});
 * export const roles = current.then(current => current.objectIds);
 * ```
 */
export declare function getDirectoryRolesOutput(opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetDirectoryRolesResult>;